AddonSession

Kotlin |Java

@PublicApi
public interface AddonSession

---

---

תוכנית הגישה המוקדמת: התכונה הזו זמינה רק בתצוגה מקדימה מוגבלת, דרך תוכנית הגישה המוקדמת.

סשן של תוסף.

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

סיכום

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

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

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

endSession

abstract ListenableFuture<Void> endSession()

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

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

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

endSuspension

abstract void endSuspension()

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

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

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

getCoDoing

abstract CoDoingClient getCoDoing()

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

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

getCoWatching

abstract CoWatchingClient getCoWatching()

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

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

getMeetingInfo

abstract AddonMeetingInfo getMeetingInfo()

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

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

isSessionEnded

abstract boolean isSessionEnded()

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

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

isSuspended

abstract boolean isSuspended()

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

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

resetCollaborationStartingState

abstract void resetCollaborationStartingState()

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

suspend

abstract void suspend()

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

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

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

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

updateCollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

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

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

updateParticipantMetadata

abstract void updateParticipantMetadata(byte[] metadata)

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

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

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

פרמטרים
byte[] metadata	blob מקודד של מטא-נתונים שמתאר מטא-נתונים רלוונטיים עבור המשתתף המקומי

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