AddonSession

کاتلین | جاوا

@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) فراداده را برای این شرکت کننده به روز می کند.

روش های عمومی

پایان جلسه

abstract ListenableFuture<Void> endSession()

جلسه افزونه را پایان می‌دهد و از برنامه Meet قطع می‌شود. این نه Meet را مجبور به پایان جلسه می کند و نه باعث می شود کاربر جلسه را ترک کند.

اگر جلسه قبلاً به پایان رسیده باشد، این یک غیرفعال است. آن استثنا نخواهد کرد.

برمی گرداند
ListenableFuture < Void >	یک ListenableFuture که موفقیت را ارزیابی می کند یا در صورت وجود خطای غیرمنتظره، یک AddonException

پایان تعلیق

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 ظاهر می شود.

تعلیق شده است

abstract boolean isSuspended()

نشان می دهد که آیا جلسه به حالت تعلیق درآمده است یا خیر. به suspend و endSuspension مراجعه کنید.

پرتاب می کند
java.lang.IllegalStateException	اگر جلسه تمام شده باشد این ممکن است یک فراخوان صریح به endSession باشد یا ممکن است به دلیل یک دلیل خارجی باشد که از طریق onSessionEnded ظاهر می شود.

بازنشانی CollaborationStartingState

abstract void resetCollaborationStartingState()

وضعیت شروع افزونه را بازنشانی می کند. با این کار حالت شروعی که قبلاً توسط سایر شرکت‌کنندگان دریافت شده بود پاک می‌شود. حالت شروع فقط توسط آغازگر قابل تنظیم مجدد است.

تعلیق کند

abstract void suspend()

جلسه افزودنی را به حالت تعلیق در می آورد. این ارتباط با برنامه Meet قطع نمی شود. این باعث می‌شود SDK از ارسال به‌روزرسانی‌ها به CoDoingHandler و CoWatchingHandler خودداری کند و باعث می‌شود SDK تماس‌ها را برای اطلاع از تماس‌ها نادیده بگیرد و تماس‌ها را برای به‌روزرسانی وضعیت جهانی نادیده بگیرد.

اگر جلسه قبلاً به حالت تعلیق درآمده است، این یک غیرفعال است.

به عنوان مثال، ممکن است زمانی که یک کاربر، اما نه هر کاربر، برای مشاهده یک تبلیغ، زمانی که کاربر پس‌زمینه برنامه را پس‌زمینه می‌کند و غیره، پخش قطع می‌شود، suspend را انتخاب کنید.

پرتاب می کند
java.lang.IllegalStateException	اگر جلسه تمام شده باشد این ممکن است یک فراخوان صریح به endSession باشد یا ممکن است به دلیل یک دلیل خارجی باشد که از طریق onSessionEnded ظاهر می شود.

به روز رسانی CollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

وضعیت شروع افزونه را به روز می کند. هنگامی که سایر شرکت کنندگان دعوت به همکاری را می پذیرند، این مورد را دریافت می کنند. حالت شروع فقط توسط آغازگر می تواند به روز شود.

مولفه های
CollaborationStartingState startingState	وضعیت شروع افزونه

به روز رسانیParticipantMtadata

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 ظاهر می شود.