AddonSession.Builder

Kotlin |Java

@PublicApi
interface AddonSession.Builder

---

Un compilador para AddonSession. Consulta los newSessionBuilder.

Resumen

Funciones públicas
ListenableFuture<AddonSession!>!	begin(appContext: Context!) Inicia una sesión de complemento.
AddonSession.Builder!	@CanIgnoreReturnValue withCoDoing(coDoingHandler: CoDoingHandler!) Agrega la acción en conjunto a la sesión del complemento con el estado inicial.
AddonSession.Builder!	@CanIgnoreReturnValue withCoDoing(     coDoingHandler: CoDoingHandler!,     initiatorInitialState: Optional<CoDoingState!>! ) Agrega la acción en conjunto a la sesión del complemento.
AddonSession.Builder!	@CanIgnoreReturnValue withCoWatching(coWatchingHandler: CoWatchingHandler!) Agrega visualización en compañía a la sesión complementaria.
AddonSession.Builder!	@CanIgnoreReturnValue withCoWatching(     coWatchingHandler: CoWatchingHandler!,     initiatorInitialState: Optional<CoWatchingState!>! ) Agrega visualización en compañía a la sesión del complemento con el estado inicial.
AddonSession.Builder!	@CanIgnoreReturnValue withCollaborationStartingState(     collaborationStartingState: CollaborationStartingState! ) Establece el CollaborationStartingState para la sesión.
AddonSession.Builder!	@CanIgnoreReturnValue withParticipantMetadata(handler: ParticipantMetadataHandler!) Registra un objeto de escucha para las actualizaciones de metadatos de otros participantes.
AddonSession.Builder!	@CanIgnoreReturnValue withParticipantMetadata(     handler: ParticipantMetadataHandler!,     metadata: ByteArray! ) Establece los metadatos de este participante y registra un objeto de escucha para las actualizaciones de otros participantes.

Funciones públicas

begin

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

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
appContext: Context!	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

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

Agrega la acción en conjunto a la sesión del complemento con el estado inicial.

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

withCoDoing

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

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

Parámetros
coDoingHandler: CoDoingHandler!	devoluciones de llamada para tareas colaborativas
initiatorInitialState: Optional<CoDoingState!>!	el estado inicial del iniciador. Se ignorará si el usuario se une a una sesión existente.

Devuelve
AddonSession.Builder!	otra instancia de compilador para encadenar

Arroja
java.lang.NullPointerException	si coDoingHandler o initiatorInitialState son nulos

withCoWatching

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

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

withCoWatching

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

Agrega visualización en compañía a la sesión del complemento con el estado inicial.

Parámetros
coWatchingHandler: CoWatchingHandler!	devoluciones de llamada para visualización en compañía
initiatorInitialState: Optional<CoWatchingState!>!	el estado inicial del iniciador. Se ignorará si el usuario se une a una sesión existente.

Devuelve
AddonSession.Builder!	otra instancia de compilador para encadenar

Arroja
java.lang.NullPointerException	si coWatchingHandler o initiatorInitialState son nulos

withCollaborationStartingState

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

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

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

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
handler: ParticipantMetadataHandler!	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

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

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
handler: ParticipantMetadataHandler!	Un elemento ParticipantMetadataHandler para recibir el conjunto más reciente de metadatos de participantes cada vez que se actualiza
metadata: ByteArray!	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