AddonSession.Builder

@PublicApi
public interface AddonSession.Builder



Un compilador para AddonSession. Consulta los newSessionBuilder.

Resumen

Métodos públicos

abstract ListenableFuture<AddonSession>
begin(Context appContext)

Inicia una sesión de complemento.

abstract AddonSession.Builder
withCoDoing(CoDoingHandler coDoingHandler)

Agrega la acción en conjunto a la sesión del complemento.

abstract AddonSession.Builder
withCoWatching(CoWatchingHandler coWatchingHandler)

Agrega visualización en compañía a la sesión complementaria.

abstract AddonSession.Builder
withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Establece el CollaborationStartingState para la sesión.

abstract AddonSession.Builder

Registra un objeto de escucha para las actualizaciones de metadatos de otros participantes.

abstract AddonSession.Builder
withParticipantMetadata(
    ParticipantMetadataHandler handler,
    byte[] metadata
)

Establece los metadatos de este participante y registra un objeto de escucha para las actualizaciones de otros participantes.

Métodos públicos

begin

abstract ListenableFuture<AddonSessionbegin(Context appContext)

Inicia una sesión de complemento. Solo se debe llamar a este método una vez que el usuario confirme que desea participar en una sesión complementaria.

Se conecta a una reunión, ya sea creando una reunión o conectándose a una en curso. Notas:

  • Si se crea una reunión, inicialmente el usuario actual será el único participante.
  • Se puede acceder a los detalles de la reunión a través de getMeetingInfo en la sesión que se muestra.
  • La URL que se muestra está diseñada para exponerse al usuario y compartirse de forma manual con el grupo de sesión del complemento deseado.
Se puede acceder a las instancias de visualización en compañía y de acción conjunta a través de getCoWatching y getCoDoing, respectivamente.

No se recomienda llamar a cancel en este futuro, sino permitir que se ejecute hasta su finalización.

Parámetros
Context appContext

El valor getApplicationContext de la aplicación que usa el SDK

Devuelve
ListenableFuture<AddonSession>

Una ListenableFuture que se evalúa como una instancia de AddonSession del tipo adecuado si se inició correctamente una sesión de complemento. De lo contrario, se evalúa como un IllegalStateException si aún se está ejecutando otro AddonSession (p.ej., no se llamó a endSession) o como un AddonException si se produjo un error inesperado.

withCoDoing

abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

Agrega la acción en conjunto a la sesión del complemento.

Parámetros
CoDoingHandler coDoingHandler

devoluciones de llamada para tareas colaborativas

Devuelve
AddonSession.Builder

otra instancia de compilador para encadenar

Arroja
java.lang.NullPointerException

si coDoingHandler es nulo

withCoWatching

abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

Agrega visualización en compañía a la sesión complementaria.

Parámetros
CoWatchingHandler coWatchingHandler

devoluciones de llamada para visualización en compañía

Devuelve
AddonSession.Builder

otra instancia de compilador para encadenar

Arroja
java.lang.NullPointerException

si coWatchingHandler es nulo

withCollaborationStartingState

abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Establece el CollaborationStartingState para la sesión.

Se puede cambiar más adelante llamando a updateCollaborationStartingState o resetCollaborationStartingState.

Parámetros
CollaborationStartingState collaborationStartingState

Datos de CollaborationStartingState

Arroja
java.lang.NullPointerException

si collaborationStartingState es nulo

withParticipantMetadata

abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

Registra un objeto de escucha para las actualizaciones de metadatos de otros participantes.

Inicialmente, se establecerán los metadatos del participante local en un valor vacío, pero se pueden configurar más adelante llamando a updateParticipantMetadata. Para establecer el valor inicial, llama a withParticipantMetadata en su lugar.

Parámetros
ParticipantMetadataHandler handler

Un elemento ParticipantMetadataHandler para recibir el conjunto más reciente de metadatos de participantes cada vez que se actualiza

Arroja
java.lang.NullPointerException

si handler es nulo

withParticipantMetadata

abstract AddonSession.Builder withParticipantMetadata(
    ParticipantMetadataHandler handler,
    byte[] metadata
)

Establece los metadatos de este participante y registra un objeto de escucha para las actualizaciones de otros participantes.

Estos metadatos se pueden cambiar más adelante llamando a updateParticipantMetadata.

Los metadatos codificados tienen un límite de MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES bytes por participante.

Parámetros
ParticipantMetadataHandler handler

Un elemento ParticipantMetadataHandler para recibir el conjunto más reciente de metadatos de participantes cada vez que se actualiza

byte[] metadata

un BLOB codificado de metadatos que describe los metadatos relevantes para el participante local

Arroja
java.lang.IllegalArgumentException

si los metadatos proporcionados superan los MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES bytes

java.lang.NullPointerException

si handler es nulo