AddonSession.Builder

@PublicApi
interface AddonSession.Builder


Kreator aplikacji AddonSession. Zobacz newSessionBuilder.

Podsumowanie

Funkcje publiczne

ListenableFuture<AddonSession!>!
begin(appContext: Context!)

Uruchamia sesję dodatku.

AddonSession.Builder!

Dodaje wspólne wykonywanie czynności do sesji dodatku w stanie początkowym.

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

Dodaje wspólne wykonywanie czynności do sesji dodatku.

AddonSession.Builder!

Dodaje wspólne oglądanie do sesji dodatku.

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

Dodaje wspólne oglądanie do sesji z dodatkiem w stanie początkowym.

AddonSession.Builder!

Ustawia CollaborationStartingState dla sesji.

AddonSession.Builder!

Rejestruje detektor aktualizacji metadanych innych uczestników.

AddonSession.Builder!

Ustawia metadane tego uczestnika i rejestruje słuchacza, aby otrzymywać aktualizacje dla innych uczestników.

Funkcje publiczne

początek

fun begin(appContext: Context!): ListenableFuture<AddonSession!>!

Uruchamia sesję dodatku. Funkcję tę należy wywołać dopiero wtedy, gdy użytkownik potwierdzi, że chce wziąć udział w sesji dodatkowej.

łączy się ze spotkaniem przez utworzenie spotkania lub połączenie się z trwającym spotkaniem; Uwagi:

  • Jeśli spotkanie zostanie utworzone, bieżący użytkownik będzie początkowo jego jedynym uczestnikiem.
  • Szczegóły spotkania są dostępne przez getMeetingInfo w zwróconej sesji.
  • Zwrócony adres URL powinien być widoczny dla użytkownika i ręcznie udostępniony odpowiedniej grupie sesji dodatku.
Dostęp do instancji wspólnego oglądania i współtworzenia można uzyskać odpowiednio za pomocą getCoWatching i getCoDoing.

Nie zalecamy wywoływania metody cancel w tej przyszłości, ale by umożliwić jej uruchomienie w całości.

Parametry
appContext: Context!

wartość getApplicationContext aplikacji, która korzysta z pakietu SDK

Zwroty
ListenableFuture<AddonSession!>!

ListenableFuture, który ocenia wystąpienie AddonSession odpowiedniego typu, jeśli sesja dodatku została uruchomiona. W przeciwnym razie zwraca wartość IllegalStateException, jeśli nadal działa inny AddonSession (np. endSession nie został wywołany) lub AddonException, jeśli wystąpił nieoczekiwany błąd.

withCoDoing

@CanIgnoreReturnValue
fun withCoDoing(coDoingHandler: CoDoingHandler!): AddonSession.Builder!

Dodaje wspólne wykonywanie czynności do sesji dodatku w stanie początkowym.

Parametry
coDoingHandler: CoDoingHandler!

wywołania zwrotne na potrzeby wspólnego wykonywania zadań

Zwroty
AddonSession.Builder!

inna instancja konstruktora na potrzeby łańcuchów

Rzuty
java.lang.NullPointerException

jeśli coDoingHandler ma wartość null

withCoDoing

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

Dodaje wspólne wykonywanie czynności do sesji dodatku.

Parametry
coDoingHandler: CoDoingHandler!

wywołania zwrotne na potrzeby wspólnego wykonywania zadań

initiatorInitialState: Optional<CoDoingState!>!

stan początkowy inicjatora. Zostanie zignorowana, jeśli użytkownik dołącza do istniejącej sesji.

Zwroty
AddonSession.Builder!

inna instancja konstruktora na potrzeby łańcuchów

Rzuty
java.lang.NullPointerException

jeśli coDoingHandler lub initiatorInitialState ma wartość null

withCoWatching

@CanIgnoreReturnValue
fun withCoWatching(coWatchingHandler: CoWatchingHandler!): AddonSession.Builder!

Dodaje wspólne oglądanie do sesji dodatku.

Parametry
coWatchingHandler: CoWatchingHandler!

wywołania zwrotne do wspólnego oglądania,

Zwroty
AddonSession.Builder!

inna instancja konstruktora na potrzeby łańcuchów

Rzuty
java.lang.NullPointerException

jeśli coWatchingHandler ma wartość null

withCoWatching

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

Dodaje wspólne oglądanie do sesji z dodatkiem w stanie początkowym.

Parametry
coWatchingHandler: CoWatchingHandler!

wywołania zwrotne do wspólnego oglądania,

initiatorInitialState: Optional<CoWatchingState!>!

stan początkowy inicjatora. Zostanie zignorowana, jeśli użytkownik dołącza do istniejącej sesji.

Zwroty
AddonSession.Builder!

inna instancja konstruktora na potrzeby łańcuchów

Rzuty
java.lang.NullPointerException

jeśli coWatchingHandler lub initiatorInitialState ma wartość null

withCollaborationStartingState

@CanIgnoreReturnValue
fun withCollaborationStartingState(
    collaborationStartingState: CollaborationStartingState!
): AddonSession.Builder!

Ustawia CollaborationStartingState dla sesji.

Możesz to zmienić później, dzwoniąc pod numer updateCollaborationStartingState lub resetCollaborationStartingState.

Parametry
collaborationStartingState: CollaborationStartingState!

Internet CollaborationStartingState

Rzuty
java.lang.NullPointerException

jeśli collaborationStartingState ma wartość null

withParticipantMetadata

@CanIgnoreReturnValue
fun withParticipantMetadata(handler: ParticipantMetadataHandler!): AddonSession.Builder!

Rejestruje detektor aktualizacji metadanych innych uczestników.

Lokalne metadane uczestnika początkowo będą ustawione na pustą wartość, ale można to zrobić później, wywołując funkcję updateParticipantMetadata. Aby ustawić wartość początkową, użyj wywołania withParticipantMetadata.

Parametry
handler: ParticipantMetadataHandler!

ParticipantMetadataHandler, aby otrzymywać najnowszy zestaw metadanych uczestników po każdej ich aktualizacji

Rzuty
java.lang.NullPointerException

jeśli handler ma wartość null

withParticipantMetadata

@CanIgnoreReturnValue
fun withParticipantMetadata(
    handler: ParticipantMetadataHandler!,
    metadata: ByteArray!
): AddonSession.Builder!

Ustawia metadane tego uczestnika i rejestruje słuchacza, aby otrzymywać aktualizacje dla innych uczestników.

Te metadane można zmienić później, wywołując updateParticipantMetadata.

Zakodowane metadane są ograniczone do MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES B na uczestnika.

Parametry
handler: ParticipantMetadataHandler!

ParticipantMetadataHandler, aby otrzymywać najnowszy zestaw metadanych uczestników po każdej ich aktualizacji

metadata: ByteArray!

zakodowany obiekt blob metadanych, który opisuje metadane uczestnika lokalnego

Rzuty
java.lang.IllegalArgumentException

jeśli podane metadane przekraczają MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES bajtów

java.lang.NullPointerException

jeśli handler ma wartość null