AddonSession

Kotlin |Java

@PublicApi
interface AddonSession

---

Uma sessão complementar.

Contém métodos comuns a todas as sessões de complementos. Para acessar e assistir em grupo, chame getCoWatching e getCoDoing, respectivamente.

Resumo

Tipos aninhados
@PublicApi interface AddonSession.Builder Um builder para a classe AddonSession.

Funções públicas
ListenableFuture<Void!>!	endSession() Encerra a sessão do complemento e se desconecta do app Meet.
Unit	endSuspension() Sai do estado de suspensão.
CoDoingClient!	getCoDoing() Retorna a instância CoDoingClient.
CoWatchingClient!	getCoWatching() Retorna a instância CoWatchingClient.
AddonMeetingInfo!	getMeetingInfo() Retorna informações sobre a reunião conectada, como o URL dela.
Boolean	isSessionEnded() Retorna true se a sessão tiver terminado.
Boolean	isSuspended() Indica se a sessão está suspensa.
Unit	resetCollaborationStartingState() Redefine o estado inicial do complemento.
Unit	suspend() Suspende a sessão do complemento.
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) Atualiza o estado inicial do complemento.
Unit	updateParticipantMetadata(metadata: ByteArray!) Atualiza os metadados deste participante.

Funções públicas

endSession

fun endSession(): ListenableFuture<Void!>!

Encerra a sessão do complemento e desconecta o app Meet. Isso não força o Meet a encerrar a reunião nem faz com que o usuário saia dela.

Se a sessão já tiver terminado, é um ambiente autônomo e não vai gerar uma exceção.

Retorna
ListenableFuture<Void!>!	um ListenableFuture que é avaliado como sucesso ou um AddonException se houver um erro inesperado

endSuspension

fun endSuspension(): Unit

Sai do estado de suspensão. O aplicativo do complemento poderá enviar e receber atualizações novamente.

Se não estiver em estado suspenso, é um ambiente autônomo.

Gera
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que apareceria por onSessionEnded.

getCoDoing

fun getCoDoing(): CoDoingClient!

Retorna a instância CoDoingClient.

Gera
java.lang.IllegalStateException	se a sessão foi criada sem chamar withCoDoing ou se a sessão foi encerrada.

getCoWatching

fun getCoWatching(): CoWatchingClient!

Retorna a instância CoWatchingClient.

Gera
java.lang.IllegalStateException	se a sessão foi criada sem chamar withCoWatching ou se a sessão foi encerrada.

getMeetingInfo

fun getMeetingInfo(): AddonMeetingInfo!

Retorna informações sobre a reunião conectada, como o URL dela.

Gera
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que apareceria por onSessionEnded.

isSessionEnded

fun isSessionEnded(): Boolean

Retorna true se a sessão tiver terminado. Isso pode ser devido a uma chamada explícita para endSession ou a um motivo externo que aparece por onSessionEnded.

Gera
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que aparece por onSessionEnded.

isSuspended

fun isSuspended(): Boolean

Indica se a sessão está suspensa. Consulte suspend e endSuspension.

Gera
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que apareceria por onSessionEnded.

resetCollaborationStartingState

fun resetCollaborationStartingState(): Unit

Redefine o estado inicial do complemento. Isso limpará o estado inicial recebido anteriormente por outros participantes. O estado inicial só pode ser redefinido pelo iniciador.

suspend

fun suspend(): Unit

Suspende a sessão do complemento. Essa ação NÃO é desconectada do app Meet. Isso faz com que o SDK evite o envio de atualizações para CoDoingHandler e CoWatchingHandler, além de ignorar chamadas para notificar e ignorar chamadas para atualizar o estado global.

Se a sessão já estiver suspensa, trata-se de um ambiente autônomo.

Por exemplo, você pode optar por chamar suspend quando um usuário, mas não todos, tem a reprodução interrompida para visualizar um anúncio, quando um usuário coloca o aplicativo em segundo plano etc.

Gera
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que apareceria por onSessionEnded.

updateCollaborationStartingState

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

Atualiza o estado inicial do complemento. Os outros participantes recebem esta mensagem quando eles aceitam o convite para colaborar. O estado inicial só pode ser atualizado pelo iniciador.

Parâmetros
startingState: CollaborationStartingState!	o estado inicial do complemento

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

Atualiza os metadados deste participante.

Para receber metadados de outros participantes, um gerenciador precisa ser registrado chamando withParticipantMetadata durante a criação do AddonSession.

Os metadados codificados têm o limite de MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES bytes por participante.

Parâmetros
metadata: ByteArray!	um blob codificado de metadados que descreve metadados relevantes para o participante local

Gera
java.lang.IllegalArgumentException	se os metadados fornecidos excederem MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES bytes
java.lang.IllegalStateException	se a sessão tiver terminado. Pode ser uma chamada explícita para endSession ou um motivo externo que apareceria por onSessionEnded.