AddonSession.Builder

Kotlin |Java

@PublicApi
interface AddonSession.Builder

---

Builder של AddonSession. newSessionBuilder.

סיכום

תפקידים ציבוריים
ListenableFuture<AddonSession!>!	begin(appContext: Context!) מתחיל סשן של תוסף.
AddonSession.Builder!	@CanIgnoreReturnValue withCoDoing(coDoingHandler: CoDoingHandler!) מוסיפה עשייה משותפת בסשן של התוסף עם המצב הראשוני.
AddonSession.Builder!	@CanIgnoreReturnValue withCoDoing(     coDoingHandler: CoDoingHandler!,     initiatorInitialState: Optional<CoDoingState!>! ) מוסיפה יכולת פעולה משותפת בסשן של התוסף.
AddonSession.Builder!	@CanIgnoreReturnValue withCoWatching(coWatchingHandler: CoWatchingHandler!) מוסיפה צפייה משותפת לסשן של התוסף.
AddonSession.Builder!	@CanIgnoreReturnValue withCoWatching(     coWatchingHandler: CoWatchingHandler!,     initiatorInitialState: Optional<CoWatchingState!>! ) הוספה של צפייה משותפת בסשן של התוסף עם המצב הראשוני.
AddonSession.Builder!	@CanIgnoreReturnValue withCollaborationStartingState(     collaborationStartingState: CollaborationStartingState! ) מגדיר את CollaborationStartingState של הפעילות.
AddonSession.Builder!	@CanIgnoreReturnValue withParticipantMetadata(handler: ParticipantMetadataHandler!) רישום מעבד (listener) לעדכונים של מטא-נתונים של משתתפים אחרים.
AddonSession.Builder!	@CanIgnoreReturnValue withParticipantMetadata(     handler: ParticipantMetadataHandler!,     metadata: ByteArray! ) הגדרת המטא-נתונים של המשתתף הזה ורישום האזנה לקבלת עדכונים למשתתפים האחרים.

תפקידים ציבוריים

התחלה

fun begin(appContext: Context!): ListenableFuture<AddonSession!>!

מתחיל סשן של תוסף. יש להפעיל את התוסף רק אחרי שהמשתמש מאשר שהוא רוצה להשתתף בסשן של תוסף.

התחברות לפגישה על ידי יצירת פגישה או התחברות לפגישה פעילה. הערות:

• אם יוצרים פגישה, בשלב הראשון המשתמש הנוכחי יהיה המשתתף היחיד.
• אפשר לגשת לפרטי הפגישה דרך getMeetingInfo בסשן שהוחזר.
• כתובת ה-URL שהוחזרה מיועדת להיחשף למשתמש ולשתף אותה באופן ידני עם קבוצת הסשנים של התוסף המיועד.

ניתן לגשת למופעים של צפייה משותפת ופעולה משותפת דרך getCoWatching ו-getCoDoing בהתאמה.

לא מומלץ להתקשר אל cancel בעתיד הזה, אלא לאפשר את השלמת הפעולה.

פרמטרים
appContext: Context!	הערך getApplicationContext של האפליקציה שמשתמשת ב-SDK

החזרות
ListenableFuture<AddonSession!>!	ListenableFuture שמעריך את המופע של AddonSession מהסוג המתאים אם סשן של תוסף התחיל בהצלחה. אחרת, ההערכה היא IllegalStateException אם AddonSession אחר עדיין פועל (למשל, endSession לא הופעל) או ל-AddonException אם אירעה שגיאה לא צפויה.

withCoDoing

@CanIgnoreReturnValue
fun withCoDoing(coDoingHandler: CoDoingHandler!): AddonSession.Builder!

מוסיפה עשייה משותפת בסשן של התוסף עם המצב הראשוני.

פרמטרים
coDoingHandler: CoDoingHandler!	קריאות חוזרות לפעולה משותפת

החזרות
AddonSession.Builder!	עוד מכונה של Builder ליצירת שרשור

קליעות
java.lang.NullPointerException	אם coDoingHandler הוא null

withCoDoing

@CanIgnoreReturnValue
fun withCoDoing(
    coDoingHandler: CoDoingHandler!,
    initiatorInitialState: Optional<CoDoingState!>!
): AddonSession.Builder!

מוסיפה יכולת פעולה משותפת בסשן של התוסף.

פרמטרים
coDoingHandler: CoDoingHandler!	קריאות חוזרות לפעולה משותפת
initiatorInitialState: Optional<CoDoingState!>!	במצב הראשוני של היוזם. המערכת תתעלם מזה אם המשתמש יצטרף לסשן קיים

החזרות
AddonSession.Builder!	עוד מכונה של Builder ליצירת שרשור

קליעות
java.lang.NullPointerException	אם coDoingHandler או initiatorInitialState ריקים

withCoWatching

@CanIgnoreReturnValue
fun withCoWatching(coWatchingHandler: CoWatchingHandler!): AddonSession.Builder!

מוסיפה צפייה משותפת לסשן של התוסף.

פרמטרים
coWatchingHandler: CoWatchingHandler!	קריאות חוזרות לצפייה משותפת

החזרות
AddonSession.Builder!	עוד מכונה של Builder ליצירת שרשור

קליעות
java.lang.NullPointerException	אם coWatchingHandler הוא null

withCoWatching

@CanIgnoreReturnValue
fun withCoWatching(
    coWatchingHandler: CoWatchingHandler!,
    initiatorInitialState: Optional<CoWatchingState!>!
): AddonSession.Builder!

הוספה של צפייה משותפת בסשן של התוסף עם המצב הראשוני.

פרמטרים
coWatchingHandler: CoWatchingHandler!	קריאות חוזרות לצפייה משותפת
initiatorInitialState: Optional<CoWatchingState!>!	במצב הראשוני של היוזם. המערכת תתעלם מזה אם המשתמש יצטרף לסשן קיים

החזרות
AddonSession.Builder!	עוד מכונה של Builder ליצירת שרשור

קליעות
java.lang.NullPointerException	אם coWatchingHandler או initiatorInitialState ריקים

withCollaborationStartingState

@CanIgnoreReturnValue
fun withCollaborationStartingState(
    collaborationStartingState: CollaborationStartingState!
): AddonSession.Builder!

מגדיר את CollaborationStartingState של הפעילות.

אפשר לשנות את זה מאוחר יותר על ידי שיחה למספר updateCollaborationStartingState או ל-resetCollaborationStartingState.

פרמטרים
collaborationStartingState: CollaborationStartingState!	נתונים בנפח CollaborationStartingState

קליעות
java.lang.NullPointerException	אם collaborationStartingState הוא null

withParticipantMetadata

@CanIgnoreReturnValue
fun withParticipantMetadata(handler: ParticipantMetadataHandler!): AddonSession.Builder!

רישום מעבד (listener) לעדכונים של מטא-נתונים של משתתפים אחרים.

המטא-נתונים של המשתתף המקומי יוגדרו בהתחלה לערך ריק, אבל אפשר יהיה להגדיר אותם מאוחר יותר על ידי קריאה ל-updateParticipantMetadata. כדי להגדיר ערך ראשוני, צריך לקרוא במקום זאת ב-withParticipantMetadata.

פרמטרים
handler: ParticipantMetadataHandler!	ParticipantMetadataHandler כדי לקבל את הקבוצה העדכנית ביותר של מטא-נתונים של משתתפים בכל פעם שהוא מתעדכן

קליעות
java.lang.NullPointerException	אם handler הוא null

withParticipantMetadata

@CanIgnoreReturnValue
fun withParticipantMetadata(
    handler: ParticipantMetadataHandler!,
    metadata: ByteArray!
): AddonSession.Builder!

הגדרת המטא-נתונים של המשתתף הזה ורישום האזנה לקבלת עדכונים למשתתפים האחרים.

אפשר לשנות את המטא-נתונים האלה מאוחר יותר באמצעות updateParticipantMetadata.

כמות המטא-נתונים המקודדים מוגבלת ל-MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES בייטים לכל משתתף.

פרמטרים
handler: ParticipantMetadataHandler!	ParticipantMetadataHandler כדי לקבל את הקבוצה העדכנית ביותר של מטא-נתונים של משתתפים בכל פעם שהוא מתעדכן
metadata: ByteArray!	blob מקודד של מטא-נתונים שמתאר מטא-נתונים רלוונטיים עבור המשתתף המקומי

קליעות
java.lang.IllegalArgumentException	אם המטא-נתונים שסופקו חורגים מ-MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES בייטים
java.lang.NullPointerException	אם handler הוא null