AddonSession.Builder

@PublicApi
public interface AddonSession.Builder

Builder של AddonSession. newSessionBuilder.

סיכום

שיטות ציבוריות
abstract ListenableFuture<AddonSession>
begin(Context appContext)

מתחיל סשן של תוסף.
abstract AddonSession.Builder

מוסיפה עשייה משותפת בסשן של התוסף עם המצב הראשוני.
abstract AddonSession.Builder
@CanIgnoreReturnValue
withCoDoing(
    CoDoingHandler coDoingHandler,
    Optional<CoDoingState> initiatorInitialState
)

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

מוסיפה צפייה משותפת לסשן של התוסף.
abstract AddonSession.Builder
@CanIgnoreReturnValue
withCoWatching(
    CoWatchingHandler coWatchingHandler,
    Optional<CoWatchingState> initiatorInitialState
)

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

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

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

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

שיטות ציבוריות

התחלה

abstract ListenableFuture<AddonSession> begin(Context appContext)

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

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

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

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

פרמטרים
Context appContext

הערך getApplicationContext של האפליקציה שמשתמשת ב-SDK
החזרות
ListenableFuture<AddonSession>

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

withCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

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

פרמטרים
CoDoingHandler coDoingHandler

קריאות חוזרות לפעולה משותפת
החזרות
AddonSession.Builder

עוד מכונה של Builder ליצירת שרשור
קליעות
java.lang.NullPointerException

אם coDoingHandler הוא null

withCoDoing

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

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

פרמטרים
CoDoingHandler coDoingHandler

קריאות חוזרות לפעולה משותפת
Optional<CoDoingState> initiatorInitialState

במצב הראשוני של היוזם. המערכת תתעלם מזה אם המשתמש יצטרף לסשן קיים
החזרות
AddonSession.Builder

עוד מכונה של Builder ליצירת שרשור
קליעות
java.lang.NullPointerException

אם coDoingHandler או initiatorInitialState ריקים

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

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

פרמטרים
CoWatchingHandler coWatchingHandler

קריאות חוזרות לצפייה משותפת
החזרות
AddonSession.Builder

עוד מכונה של Builder ליצירת שרשור
קליעות
java.lang.NullPointerException

אם coWatchingHandler הוא null

withCoWatching

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

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

פרמטרים
CoWatchingHandler coWatchingHandler

קריאות חוזרות לצפייה משותפת
Optional<CoWatchingState> initiatorInitialState

במצב הראשוני של היוזם. המערכת תתעלם מזה אם המשתמש יצטרף לסשן קיים
החזרות
AddonSession.Builder

עוד מכונה של Builder ליצירת שרשור
קליעות
java.lang.NullPointerException

אם coWatchingHandler או initiatorInitialState ריקים

withCollaborationStartingState

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

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

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

פרמטרים
CollaborationStartingState collaborationStartingState

נתונים בנפח CollaborationStartingState
קליעות
java.lang.NullPointerException

אם collaborationStartingState הוא null

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

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

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

פרמטרים
ParticipantMetadataHandler handler

ParticipantMetadataHandler כדי לקבל את הקבוצה העדכנית ביותר של מטא-נתונים של משתתפים בכל פעם שהוא מתעדכן
קליעות
java.lang.NullPointerException

אם handler הוא null

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(
    ParticipantMetadataHandler handler,
    byte[] metadata
)

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

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

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

פרמטרים
ParticipantMetadataHandler handler

ParticipantMetadataHandler כדי לקבל את הקבוצה העדכנית ביותר של מטא-נתונים של משתתפים בכל פעם שהוא מתעדכן
byte[] metadata

blob מקודד של מטא-נתונים שמתאר מטא-נתונים רלוונטיים עבור המשתתף המקומי
קליעות
java.lang.IllegalArgumentException

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

אם handler הוא null