AddonSession.Builder

@PublicApi
public interface AddonSession.Builder



Kreator aplikacji AddonSession. Zobacz newSessionBuilder.

Podsumowanie

Metody publiczne

abstract ListenableFuture<AddonSession>
begin(Context appContext)

Uruchamia sesję dodatku.

abstract AddonSession.Builder

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

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

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

abstract AddonSession.Builder

Dodaje wspólne oglądanie do sesji dodatku.

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

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

abstract AddonSession.Builder

Ustawia CollaborationStartingState dla sesji.

abstract AddonSession.Builder

Rejestruje detektor aktualizacji metadanych innych uczestników.

abstract AddonSession.Builder

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

Metody publiczne

początek

abstract ListenableFuture<AddonSessionbegin(Context appContext)

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
Context appContext

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
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

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
abstract AddonSession.Builder withCoDoing(
    CoDoingHandler coDoingHandler,
    Optional<CoDoingState> initiatorInitialState
)

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

Parametry
CoDoingHandler coDoingHandler

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

Optional<CoDoingState> initiatorInitialState

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
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

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
abstract AddonSession.Builder withCoWatching(
    CoWatchingHandler coWatchingHandler,
    Optional<CoWatchingState> initiatorInitialState
)

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

Parametry
CoWatchingHandler coWatchingHandler

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

Optional<CoWatchingState> initiatorInitialState

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
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

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
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

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
ParticipantMetadataHandler handler

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
abstract AddonSession.Builder withParticipantMetadata(
    ParticipantMetadataHandler handler,
    byte[] metadata
)

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
ParticipantMetadataHandler handler

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

byte[] metadata

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