AddonSession

Kotlin |Java

@PublicApi
public interface AddonSession

---

---

برنامج استخدام المنتج قبل إطلاقه: لا تتوفّر هذه الميزة إلا في معاينة محدودة، من خلال برنامج استخدام المنتج قبل إطلاقه.

جلسة إضافية

يحتوي على الطُرق الشائعة لجميع جلسات الإضافة. للوصول إلى المشاهدة مع الآخرين، يُرجى الاتصال بـ "getCoWatching" و"getCoDoing" على التوالي.

ملخّص

الأنواع المتداخلة
@PublicApi public interface AddonSession.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)

يحدّث بيانات التعريف لهذا المشارك.

لتلقي البيانات الوصفية من مشاركين آخرين، يجب تسجيل المعالج عن طريق استدعاء البيانات الوصفية للمشارك أثناء إنشاء AddonSession.

الحد الأقصى للبيانات الوصفية المشفرة هو MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES بايت لكل مشارك.

المَعلمات
byte[] metadata	كائن ثنائي مرمّز من بيانات التعريف يصف بيانات التعريف ذات الصلة بالمشارك المحلي

الرميات
java.lang.IllegalArgumentException	إذا كانت البيانات الوصفية المقدَّمة تتجاوز MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES بايت
java.lang.IllegalStateException	إذا انتهت الجلسة. قد يكون هذا الطلب صريحًا مع الرقم endSession أو قد يرجع إلى سبب خارجي قد يظهر من خلال "onSessionEnded".