Esta página foi traduzida pela API Cloud Translation.

AddonSession.Builder

Kotlin |Java

@PublicApi
interface AddonSession.Builder

Um builder para a classe AddonSession. Consulte os newSessionBuilder.

Resumo

Funções públicas
`ListenableFuture<AddonSession!>!`	`begin(appContext: Context!)` Inicia uma sessão complementar.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withCoDoing(coDoingHandler: CoDoingHandler!)` Adiciona a ação colaborativa à sessão do complemento com o estado inicial.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withCoDoing( coDoingHandler: CoDoingHandler!, initiatorInitialState: Optional<CoDoingState!>! )` Adiciona a ação colaborativa à sessão de complementos.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withCoWatching(coWatchingHandler: CoWatchingHandler!)` Adiciona a opção de assistir em grupo à sessão complementar.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withCoWatching( coWatchingHandler: CoWatchingHandler!, initiatorInitialState: Optional<CoWatchingState!>! )` Adiciona a covisualização à sessão do complemento com o estado inicial.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withCollaborationStartingState( collaborationStartingState: CollaborationStartingState! )` Define o `CollaborationStartingState` da sessão.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withParticipantMetadata(handler: ParticipantMetadataHandler!)` Registra um listener para atualizações de metadados de outros participantes.
`AddonSession.Builder!`	`@CanIgnoreReturnValue withParticipantMetadata( handler: ParticipantMetadataHandler!, metadata: ByteArray! )` Define os metadados deste participante e registra um listener para atualizações de outros participantes.

Funções públicas

begin

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

Inicia uma sessão complementar. Ele só deve ser chamado quando o usuário confirmar que quer participar de uma sessão complementar.

criar ou se conectar a uma reunião em andamento. Observações:

Se uma reunião for criada, o usuário atual vai ser o único participante inicialmente.
Acesse os detalhes da reunião em getMeetingInfo na sessão retornada.
A finalidade do URL retornado é ser exposto ao usuário e compartilhado manualmente com o grupo de sessões do complemento pretendido.

As instâncias de co-watching e co-Doing podem ser acessadas usando getCoWatching e getCoDoing, respectivamente.

Não é recomendado chamar cancel neste futuro, mas permitir que ele seja executado até a conclusão.

Parâmetros
`appContext: Context!`	o valor `getApplicationContext` do aplicativo que está usando o SDK.

Retorna
`ListenableFuture<AddonSession!>!`	Um `ListenableFuture` que é avaliado como uma instância `AddonSession` do tipo apropriado se uma sessão de complemento foi iniciada. Caso contrário, será avaliado como `IllegalStateException` se outro `AddonSession` ainda estiver em execução (por exemplo, `endSession` não foi chamado) ou como `AddonException` se houver um erro inesperado.

withCoDoing

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

Adiciona a ação colaborativa à sessão do complemento com o estado inicial.

Parâmetros
`coDoingHandler: CoDoingHandler!`	callbacks para fazer em conjunto

Retorna
`AddonSession.Builder!`	outra instância do builder para encadeamento

Gera
`java.lang.NullPointerException`	se `coDoingHandler` for nulo

withCoDoing

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

Adiciona a ação colaborativa à sessão de complementos.

Parâmetros
`coDoingHandler: CoDoingHandler!`	callbacks para fazer em conjunto
`initiatorInitialState: Optional<CoDoingState!>!`	o estado inicial do iniciador. Isso será ignorado se o usuário estiver participando de uma sessão existente.

Retorna
`AddonSession.Builder!`	outra instância do builder para encadeamento

Gera
`java.lang.NullPointerException`	se `coDoingHandler` ou `initiatorInitialState` for nulo

withCoWatching

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

Adiciona a opção de assistir em grupo à sessão complementar.

Parâmetros
`coWatchingHandler: CoWatchingHandler!`	callbacks para assistir em grupo

Retorna
`AddonSession.Builder!`	outra instância do builder para encadeamento

Gera
`java.lang.NullPointerException`	se `coWatchingHandler` for nulo

withCoWatching

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

Adiciona a covisualização à sessão do complemento com o estado inicial.

Parâmetros
`coWatchingHandler: CoWatchingHandler!`	callbacks para assistir em grupo
`initiatorInitialState: Optional<CoWatchingState!>!`	o estado inicial do iniciador. Isso será ignorado se o usuário estiver participando de uma sessão existente.

Retorna
`AddonSession.Builder!`	outra instância do builder para encadeamento

Gera
`java.lang.NullPointerException`	se `coWatchingHandler` ou `initiatorInitialState` for nulo

withCollaborationStartingState

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

Define o CollaborationStartingState da sessão.

Isso pode ser mudado mais tarde chamando updateCollaborationStartingState ou resetCollaborationStartingState.

Parâmetros
`collaborationStartingState: CollaborationStartingState!`	`CollaborationStartingState` de dados

Gera
`java.lang.NullPointerException`	se `collaborationStartingState` for nulo

withParticipantMetadata

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

Registra um listener para atualizações de metadados de outros participantes.

Os metadados do participante local vão ser definidos inicialmente como um valor vazio, mas podem ser definidos mais tarde chamando updateParticipantMetadata. Para definir o valor inicial, chame withParticipantMetadata.

Parâmetros
`handler: ParticipantMetadataHandler!`	um `ParticipantMetadataHandler` para receber o conjunto mais recente de metadados do participante sempre que ele for atualizado.

Gera
`java.lang.NullPointerException`	se `handler` for nulo

withParticipantMetadata

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

Define os metadados deste participante e registra um listener para atualizações de outros participantes.

Esses metadados podem ser alterados posteriormente chamando updateParticipantMetadata.

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

Parâmetros
`handler: ParticipantMetadataHandler!`	um `ParticipantMetadataHandler` para receber o conjunto mais recente de metadados do participante sempre que ele for atualizado.
`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.NullPointerException`	se `handler` for nulo