AddonSession

Kotlin |Java

@PublicApi
interface AddonSession

---

เซสชันส่วนเสริม

ประกอบด้วยวิธีการที่ใช้บ่อยในเซสชันส่วนเสริมทั้งหมด หากต้องการเข้าถึงการดูร่วมกันและการทํางานร่วมกัน โปรดโทรหา getCoWatching และ getCoDoing ตามลำดับ

สรุป

ประเภทที่ซ้อนกัน
@PublicApi interface AddonSession.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

อัปเดตข้อมูลเมตาของผู้เข้าร่วมรายนี้

หากต้องการรับข้อมูลเมตาจากผู้เข้าร่วมคนอื่นๆ ต้องลงทะเบียนเครื่องจัดการโดยการเรียกด้วย engagementMetadata ขณะสร้าง AddonSession

ระบบจำกัดข้อมูลเมตาที่เข้ารหัสที่ MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES ไบต์ต่อผู้เข้าร่วม

พารามิเตอร์
metadata: ByteArray!	ชุดข้อมูลเมตาที่เข้ารหัสซึ่งอธิบายถึงข้อมูลเมตาที่เกี่ยวข้องของผู้เข้าร่วมในเครื่อง

การขว้าง
java.lang.IllegalArgumentException	หากข้อมูลเมตาที่ระบุเกิน MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES ไบต์
java.lang.IllegalStateException	หากเซสชันสิ้นสุดลงแล้ว ซึ่งอาจเป็นการโทรไปยัง endSession อย่างชัดเจน หรืออาจเกิดจากสาเหตุภายนอกที่จะแสดงผลผ่าน onSessionEnded