AddonSession

@PublicApi
public interface AddonSession

Sesja dodatkowa.

Zawiera metody wspólne dla wszystkich sesji dodatków. Aby uzyskać dostęp do wspólnego oglądania i wspólnego wykonywania zadań, zadzwoń pod numer getCoWatching i getCoDoing.

Podsumowanie

Typy zagnieżdżone

Kreator aplikacji AddonSession.

Metody publiczne
abstract ListenableFuture<Void>

Kończy sesję dodatku i odłącza się od aplikacji Meet.
abstract void

Wychodzi ze stanu zawieszenia.
abstract CoDoingClient

Zwraca instancję CoDoingClient.
abstract CoWatchingClient

Zwraca instancję CoWatchingClient.
abstract AddonMeetingInfo

Zwraca informacje o połączonym spotkaniu, np. jego adres URL.
abstract boolean

Zwraca wartość true, jeśli sesja się zakończyła.
abstract boolean

Wskazuje, czy sesja jest zawieszona.
abstract void

Resetuje stan początkowy dodatku.
abstract void

Zawiesza sesję dodatku.
abstract void

Aktualizuje stan początkowy dodatku.
abstract void
updateParticipantMetadata(byte[] metadata)

Aktualizuje metadane tego uczestnika.

Metody publiczne

endSession

abstract ListenableFuture<Void> endSession()

Kończy sesję dodatku i odłącza się od aplikacji Meet. Nie wymusza to zakończenia spotkania przez Meet ani nie powoduje opuszczenia spotkania przez użytkownika.

Jeśli sesja już się zakończyła, nie oznacza to błędu – nie spowoduje to zgłoszenia wyjątku.

Zwroty
ListenableFuture<Void>

ListenableFuture, który oznacza sukces, lub AddonException, jeśli wystąpił nieoczekiwany błąd

endSuspension

abstract void endSuspension()

Wychodzi ze stanu zawieszenia. Aplikacja dodatku będzie znów mogła wysyłać i odbierać aktualizacje.

Jeśli konto nie jest zawieszone, nie można nic robić.

Rzuty
java.lang.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane przez powód zewnętrzny, który zostanie podany za pomocą funkcji onSessionEnded.

getCoDoing

abstract CoDoingClient getCoDoing()

Zwraca instancję CoDoingClient.

Rzuty
java.lang.IllegalStateException

czy sesja została utworzona bez wywołania withCoDoing lub została zakończona.

getCoWatching

abstract CoWatchingClient getCoWatching()

Zwraca instancję CoWatchingClient.

Rzuty
java.lang.IllegalStateException

czy sesja została utworzona bez wywołania withCoWatching lub została zakończona.

getMeetingInfo

abstract AddonMeetingInfo getMeetingInfo()

Zwraca informacje o połączonym spotkaniu, np. jego adres URL.

Rzuty
java.lang.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane przez powód zewnętrzny, który zostanie podany za pomocą funkcji onSessionEnded.

isSessionEnded

abstract boolean isSessionEnded()

Zwraca wartość true, jeśli sesja się zakończyła. Może to być jawne wywołanie funkcji endSession lub być spowodowane czymś zewnętrznym, który zostanie podany za pomocą funkcji onSessionEnded.

Rzuty
java.lang.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane czymś zewnętrznym, który zostanie podany za pomocą funkcji onSessionEnded.

isSuspended

abstract boolean isSuspended()

Wskazuje, czy sesja jest zawieszona. Zobacz suspend i endSuspension.

Rzuty
java.lang.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane przez powód zewnętrzny, który zostanie podany za pomocą funkcji onSessionEnded.

resetCollaborationStartingState

abstract void resetCollaborationStartingState()

Resetuje stan początkowy dodatku. Spowoduje to usunięcie stanu początkowego ustawionego wcześniej przez innych uczestników. Stan początkowy może zresetować tylko inicjator.

suspend

abstract void suspend()

Zawiesza sesję dodatku. NIE spowoduje to rozłączania się z aplikacją Meet. Przez to pakiet SDK nie będzie wysyłać aktualizacji do aplikacji CoDoingHandler i CoWatchingHandler, a także będzie ignorować wywołania w celu powiadamiania połączeń i aktualizowania stanu globalnego.

Jeśli sesja jest już zawieszona, nie można tego zrobić.

Możesz na przykład wywołać suspend, gdy użytkownik (ale nie każdy użytkownik) ma przerwę odtwarzanie w celu wyświetlenia reklamy, gdy użytkownik przechodzi w tle aplikacji itd.

Rzuty
java.lang.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane przez powód zewnętrzny, który zostanie podany za pomocą funkcji onSessionEnded.

updateCollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

Aktualizuje stan początkowy dodatku. Otrzymają go inni uczestnicy, gdy zaakceptują zaproszenie do współpracy. Stan początkowy może zaktualizować tylko inicjator.

Parametry
CollaborationStartingState startingState

początkowy stan dodatku

updateParticipantMetadata

abstract void updateParticipantMetadata(byte[] metadata)

Aktualizuje metadane tego uczestnika.

Aby otrzymywać metadane od innych uczestników, moduł obsługi musi być zarejestrowany, wywołując parametr UczestnikUserMetadata podczas tworzenia obiektu AddonSession.

Zakodowane metadane są ograniczone do MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES B na uczestnika.

Parametry
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.IllegalStateException

o zakończeniu sesji. Może to być bezpośrednie wywołanie funkcji endSession lub być spowodowane przez powód zewnętrzny, który zostanie podany za pomocą funkcji onSessionEnded.