AddonSession

Kotlin |Java

@PublicApi
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
@PublicApi interface AddonSession.Builder Kreator aplikacji AddonSession.

Funkcje publiczne
ListenableFuture<Void!>!	endSession() Kończy sesję dodatku i odłącza się od aplikacji Meet.
Unit	endSuspension() Wychodzi ze stanu zawieszenia.
CoDoingClient!	getCoDoing() Zwraca instancję CoDoingClient.
CoWatchingClient!	getCoWatching() Zwraca instancję CoWatchingClient.
AddonMeetingInfo!	getMeetingInfo() Zwraca informacje o połączonym spotkaniu, np. jego adres URL.
Boolean	isSessionEnded() Zwraca wartość true, jeśli sesja się zakończyła.
Boolean	isSuspended() Wskazuje, czy sesja jest zawieszona.
Unit	resetCollaborationStartingState() Resetuje stan początkowy dodatku.
Unit	suspend() Zawiesza sesję dodatku.
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) Aktualizuje stan początkowy dodatku.
Unit	updateParticipantMetadata(metadata: ByteArray!) Aktualizuje metadane tego uczestnika.

Funkcje publiczne

endSession

fun endSession(): ListenableFuture<Void!>!

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

fun endSuspension(): Unit

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

fun getCoDoing(): CoDoingClient!

Zwraca instancję CoDoingClient.

Rzuty
java.lang.IllegalStateException	czy sesja została utworzona bez wywołania withCoDoing lub została zakończona.

getCoWatching

fun getCoWatching(): CoWatchingClient!

Zwraca instancję CoWatchingClient.

Rzuty
java.lang.IllegalStateException	czy sesja została utworzona bez wywołania withCoWatching lub została zakończona.

getMeetingInfo

fun getMeetingInfo(): AddonMeetingInfo!

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

fun isSessionEnded(): Boolean

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

fun isSuspended(): Boolean

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

fun resetCollaborationStartingState(): Unit

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

fun suspend(): Unit

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

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

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

Parametry
startingState: CollaborationStartingState!	początkowy stan dodatku

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

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