AddonSession

Kotlin |Java

@PublicApi
interface AddonSession

---

סשן של תוסף.

מכיל שיטות הנפוצות לכל הסשנים של תוסף. לקבלת גישה לצפייה משותפת ולצפייה משותפת, יש להתקשר למספר getCoWatching ול-getCoDoing, בהתאמה.

סיכום

סוגים מקוננים
@PublicApi interface AddonSession.Builder Builder של AddonSession.

תפקידים ציבוריים
ListenableFuture<Void!>!	endSession() כשמסיימים את הסשן עם התוסף ומתנתקים מאפליקציית Meet.
Unit	endSuspension() יציאה ממצב השעיה.
CoDoingClient!	getCoDoing() מחזירה את המופע CoDoingClient.
CoWatchingClient!	getCoWatching() מחזירה את המופע CoWatchingClient.
AddonMeetingInfo!	getMeetingInfo() מחזירה מידע על הפגישה המקושרת, כמו כתובת ה-URL של הפגישה.
Boolean	isSessionEnded() הפונקציה מחזירה את הערך true אם הסשן הסתיים.
Boolean	isSuspended() הערך מציין אם הסשן מושעה.
Unit	resetCollaborationStartingState() איפוס של מצב ההתחלה של התוסף.
Unit	suspend() משעה את הסשן של התוסף.
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) מעדכן את מצב ההתחלה של התוסף.
Unit	updateParticipantMetadata(metadata: ByteArray!) עדכון המטא-נתונים של המשתתף הזה.

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

endSession

fun endSession(): ListenableFuture<Void!>!

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

אם הסשן כבר הסתיים, לא מדובר בתפעול; זה לא יוביל לחריג.

החזרות
ListenableFuture<Void!>!	ListenableFuture שמעריך את הצלחתם או AddonException אם אירעה שגיאה בלתי צפויה

endSuspension

fun endSuspension(): Unit

יציאה ממצב השעיה. האפליקציה של התוסף יכולה שוב לשלוח ולקבל עדכונים.

אם העסק לא במצב של השעיה, לא יהיה צורך להפעיל אותו.

קליעות
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.

getCoDoing

fun getCoDoing(): CoDoingClient!

מחזירה את המופע CoDoingClient.

קליעות
java.lang.IllegalStateException	אם הסשן נוצר בלי להתקשר אל withCoDoing, או אם הסשן הסתיים

getCoWatching

fun getCoWatching(): CoWatchingClient!

מחזירה את המופע CoWatchingClient.

קליעות
java.lang.IllegalStateException	אם הסשן נוצר בלי להתקשר אל withCoWatching, או אם הסשן הסתיים

getMeetingInfo

fun getMeetingInfo(): AddonMeetingInfo!

מחזירה מידע על הפגישה המקושרת, כמו כתובת ה-URL של הפגישה.

קליעות
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.

isSessionEnded

fun isSessionEnded(): Boolean

הפונקציה מחזירה את הערך true אם הסשן הסתיים. יכול להיות שהסיבה לכך היא קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.

קליעות
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת אל endSession או סיבה חיצונית שתוצג דרך onSessionEnded

isSuspended

fun isSuspended(): Boolean

הערך מציין אם הסשן מושעה. פרטים נוספים זמינים בsuspend ובendSuspension.

קליעות
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.

resetCollaborationStartingState

fun resetCollaborationStartingState(): Unit

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

suspend

fun suspend(): Unit

משעה את הסשן של התוסף. הפעולה הזו לא מנתקת מאפליקציית Meet. המצב הזה גורם ל-SDK להימנע משליחת עדכונים אל CoDoingHandler ואל CoWatchingHandler, וכתוצאה מכך מערכת ה-SDK מתעלמת משיחות כדי להודיע על שיחות ומתעלמת משיחות כדי לעדכן את המצב הגלובלי.

אם הסשן כבר הושעה, לא ניתן להפעיל אותו.

לדוגמה, אפשר לבחור להתקשר אל suspend במקרה של הפרעה בהפעלת האפליקציה למשתמש, אבל לא לכל המשתמשים, כדי לצפות במודעה, כשמשתמש מפעיל את האפליקציה ברקע וכו'.

קליעות
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.

updateCollaborationStartingState

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

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

פרמטרים
startingState: CollaborationStartingState!	במצב ההתחלה של התוסף

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

עדכון המטא-נתונים של המשתתף הזה.

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

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

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

קליעות
java.lang.IllegalArgumentException	אם המטא-נתונים שסופקו חורגים מ-MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES בייטים
java.lang.IllegalStateException	אם הסשן הסתיים. יכול להיות שזו קריאה מפורשת ל-endSession או סיבה חיצונית שתוצג דרך onSessionEnded.