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

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

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

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

المَعلمات
metadata: ByteArray!	كائن ثنائي مرمّز من بيانات التعريف يصف بيانات التعريف ذات الصلة بالمشارك المحلي

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