AddonSession.Builder

Kotlin |Java

@PublicApi
public interface AddonSession.Builder

---

---

โปรแกรมทดลองใช้ก่อนเปิดตัว: ฟีเจอร์นี้มีให้บริการในตัวอย่างที่จำกัดผ่านโปรแกรมทดลองใช้ก่อนเปิดตัวเท่านั้น

เครื่องมือสร้างสำหรับ AddonSession ดู newSessionBuilder

สรุป

วิธีการสาธารณะ
abstract ListenableFuture<AddonSession>	begin(Context appContext) เริ่มเซสชันเสริม
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(CoDoingHandler coDoingHandler) เพิ่มการดำเนินการร่วมในเซสชันส่วนเสริมด้วยสถานะเริ่มต้น
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(     CoDoingHandler coDoingHandler,     Optional<CoDoingState> initiatorInitialState ) เพิ่มการทำร่วมกันในเซสชันส่วนเสริม
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(CoWatchingHandler coWatchingHandler) เพิ่มการดูร่วมกันในเซสชันส่วนเสริม
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(     CoWatchingHandler coWatchingHandler,     Optional<CoWatchingState> initiatorInitialState ) เพิ่มการดูร่วมกันในเซสชันส่วนเสริมด้วยสถานะเริ่มต้น
abstract AddonSession.Builder	@CanIgnoreReturnValue withCollaborationStartingState(     CollaborationStartingState collaborationStartingState ) ตั้งค่า CollaborationStartingState สำหรับเซสชัน
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(ParticipantMetadataHandler handler) ลงทะเบียน Listener เพื่อรับการอัปเดตข้อมูลเมตาสำหรับผู้เข้าร่วมคนอื่นๆ
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(     ParticipantMetadataHandler handler,     byte[] metadata ) ตั้งค่าข้อมูลเมตาสำหรับผู้เข้าร่วมรายนี้และลงทะเบียน Listener เพื่ออัปเดตให้กับผู้เข้าร่วมคนอื่นๆ

วิธีการสาธารณะ

เริ่มต้น

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	อินสแตนซ์ของเครื่องมือสร้างอื่นสำหรับการเชน

การขว้าง
java.lang.NullPointerException	หาก coDoingHandler เป็นค่าว่าง

withCoDoing

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

เพิ่มการทำร่วมกันในเซสชันส่วนเสริม

พารามิเตอร์
CoDoingHandler coDoingHandler	โค้ดเรียกกลับสำหรับการทำงานร่วมกัน
Optional<CoDoingState> initiatorInitialState	สถานะเริ่มต้นของตัวเริ่ม ระบบจะไม่สนใจตัวเลือกนี้หากผู้ใช้เข้าร่วมเซสชันที่มีอยู่

การคืนสินค้า
AddonSession.Builder	อินสแตนซ์ของเครื่องมือสร้างอื่นสำหรับการเชน

การขว้าง
java.lang.NullPointerException	หาก coDoingHandler หรือ initiatorInitialState เป็นค่าว่าง

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

เพิ่มการดูร่วมกันในเซสชันส่วนเสริม

พารามิเตอร์
CoWatchingHandler coWatchingHandler	โค้ดเรียกกลับสำหรับการดูร่วมกัน

การคืนสินค้า
AddonSession.Builder	อินสแตนซ์ของเครื่องมือสร้างอื่นสำหรับการเชน

การขว้าง
java.lang.NullPointerException	หาก coWatchingHandler เป็นค่าว่าง

withCoWatching

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

เพิ่มการดูร่วมกันในเซสชันส่วนเสริมด้วยสถานะเริ่มต้น

พารามิเตอร์
CoWatchingHandler coWatchingHandler	โค้ดเรียกกลับสำหรับการดูร่วมกัน
Optional<CoWatchingState> initiatorInitialState	สถานะเริ่มต้นของตัวเริ่ม ระบบจะไม่สนใจตัวเลือกนี้หากผู้ใช้เข้าร่วมเซสชันที่มีอยู่

การคืนสินค้า
AddonSession.Builder	อินสแตนซ์ของเครื่องมือสร้างอื่นสำหรับการเชน

การขว้าง
java.lang.NullPointerException	หาก coWatchingHandler หรือ initiatorInitialState เป็นค่าว่าง

withCollaborationStartingState

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

ตั้งค่า CollaborationStartingState สำหรับเซสชัน

คุณเปลี่ยนแปลงข้อมูลได้ในภายหลังด้วยการโทรไปที่ updateCollaborationStartingState หรือ resetCollaborationStartingState

พารามิเตอร์
CollaborationStartingState collaborationStartingState	อินเทอร์เน็ต CollaborationStartingState

การขว้าง
java.lang.NullPointerException	หาก collaborationStartingState เป็นค่าว่าง

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

ลงทะเบียน Listener เพื่อรับการอัปเดตข้อมูลเมตาสำหรับผู้เข้าร่วมคนอื่นๆ

ระบบจะตั้งค่าข้อมูลเมตาของผู้เข้าร่วมในเครื่องเป็นค่าว่างในตอนแรก แต่คุณสามารถตั้งค่าในภายหลังได้โดยเรียกใช้ updateParticipantMetadata หากต้องการกำหนดค่าเริ่มต้น โปรดเรียก withParticipantMetadata แทน

พารามิเตอร์
ParticipantMetadataHandler handler	ParticipantMetadataHandlerเพื่อรับชุดข้อมูลเมตาล่าสุดของผู้เข้าร่วมทุกครั้งที่มีการอัปเดต

การขว้าง
java.lang.NullPointerException	หาก handler เป็นค่าว่าง

withParticipantMetadata

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

ตั้งค่าข้อมูลเมตาสำหรับผู้เข้าร่วมรายนี้และลงทะเบียน Listener เพื่ออัปเดตให้กับผู้เข้าร่วมคนอื่นๆ

ข้อมูลเมตานี้สามารถเปลี่ยนแปลงได้ในภายหลังโดยการเรียกใช้ updateParticipantMetadata

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

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

การขว้าง
java.lang.IllegalArgumentException	หากข้อมูลเมตาที่ระบุเกิน MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES ไบต์
java.lang.NullPointerException	หาก handler เป็นค่าว่าง