AddonSession.Builder

@PublicApi
public interface AddonSession.Builder



سازنده برای AddonSession . به newSessionBuilder مراجعه کنید.

خلاصه

روش های عمومی

abstract ListenableFuture < AddonSession >
begin ( Context appContext)

یک جلسه الحاقی را آغاز می کند.

abstract AddonSession.Builder

هم‌کاری را با حالت اولیه به جلسه افزونه اضافه می‌کند.

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

مشارکت را به جلسه افزونه اضافه می کند.

abstract AddonSession.Builder

تماشای مشترک را به جلسه افزودنی اضافه می کند.

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

تماشای مشترک را با حالت اولیه به جلسه افزودنی اضافه می کند.

abstract AddonSession.Builder

CollaborationStartingState برای جلسه تنظیم می کند.

abstract AddonSession.Builder

یک شنونده را برای به‌روزرسانی‌های فراداده برای سایر شرکت‌کنندگان ثبت می‌کند.

abstract AddonSession.Builder

فراداده را برای این شرکت‌کننده تنظیم می‌کند و شنونده‌ای را برای به‌روزرسانی‌های سایر شرکت‌کنندگان ثبت می‌کند.

روش های عمومی

شروع

abstract ListenableFuture<AddonSessionbegin(Context appContext)

یک جلسه الحاقی را آغاز می کند. این تنها زمانی باید فراخوانی شود که کاربر تأیید کرده باشد که می‌خواهد در یک جلسه افزودنی شرکت کند.

با ایجاد یک جلسه یا با اتصال به یک جلسه در حال انجام، به یک جلسه متصل می شود. یادداشت:

  • اگر جلسه ای ایجاد شود، کاربر فعلی در ابتدا تنها شرکت کننده خواهد بود.
  • جزئیات جلسه از طریق getMeetingInfo در جلسه برگشتی قابل دسترسی است.
  • URL برگشتی قرار است در معرض دید کاربر قرار گیرد و به صورت دستی با گروه جلسه افزودنی مورد نظر او به اشتراک گذاشته شود.
به ترتیب از طریق getCoWatching و getCoDoing می توان به نمونه های تماشای مشترک و همکار دسترسی داشت.

توصیه نمی شود در این آینده cancel فراخوانی کنید، اما در عوض اجازه دهید تا کامل شود.

مولفه های
Context appContext

مقدار getApplicationContext برنامه ای که از SDK استفاده می کند

برمی گرداند
ListenableFuture < AddonSession >

یک ListenableFuture که در صورت شروع موفقیت آمیز جلسه الحاقی، به یک نمونه AddonSession از نوع مناسب ارزیابی می شود. در غیر این صورت، اگر AddonSession دیگری هنوز در حال اجرا باشد (مثلا endSession فراخوانی نشده است) به یک IllegalStateException یا در صورت وجود خطای غیرمنتظره به 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 تهی باشد

با CoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

تماشای مشترک را به جلسه افزودنی اضافه می کند.

مولفه های
CoWatchingHandler coWatchingHandler

تماس برای تماشای مشترک

برمی گرداند
AddonSession.Builder

یک نمونه سازنده دیگر برای زنجیر کردن

پرتاب می کند
java.lang.NullPointerException

اگر coWatchingHandler پوچ باشد

با CoWatching

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

تماشای مشترک را با حالت اولیه به جلسه افزودنی اضافه می کند.

مولفه های
CoWatchingHandler coWatchingHandler

تماس برای تماشای مشترک

Optional < CoWatchingState > initiatorInitialState

حالت اولیه آغازگر اگر کاربر به یک جلسه موجود بپیوندد، این مورد نادیده گرفته می شود

برمی گرداند
AddonSession.Builder

یک نمونه سازنده دیگر برای زنجیر کردن

پرتاب می کند
java.lang.NullPointerException

اگر coWatchingHandler یا initiatorInitialState پوچ باشد

withColaborationStartingState

@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)

یک شنونده را برای به‌روزرسانی‌های فراداده برای سایر شرکت‌کنندگان ثبت می‌کند.

فراداده شرکت‌کننده محلی ابتدا روی یک مقدار خالی تنظیم می‌شود، اما می‌توان آن را بعداً با فراخوانی updateParticipantMetadata تنظیم کرد. برای تنظیم مقدار اولیه، به جای آن withParticipantMetadata تماس بگیرید.

مولفه های
ParticipantMetadataHandler handler

یک ParticipantMetadataHandler برای دریافت آخرین مجموعه فوق داده های شرکت کننده هر بار که به روز می شود

پرتاب می کند
java.lang.NullPointerException

اگر handler تهی باشد

withParticipantMetadata

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

فراداده را برای این شرکت‌کننده تنظیم می‌کند و شنونده‌ای را برای به‌روزرسانی‌های سایر شرکت‌کنندگان ثبت می‌کند.

این متادیتا را می‌توان بعداً با تماس با 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 تهی باشد