AddonSession.Builder

Kotlin |Java

@PublicApi
public interface AddonSession.Builder

---

---

Programme en accès anticipé:cette fonctionnalité n'est disponible que dans la version preview limitée, via un programme en accès anticipé.

Compilateur pour AddonSession. Consultez les newSessionBuilder.

Résumé

Méthodes publiques
abstract ListenableFuture<AddonSession>	begin(Context appContext) Démarre une session complémentaire.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(CoDoingHandler coDoingHandler) Ajoute une action à plusieurs à la session complémentaire avec l'état initial.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(     CoDoingHandler coDoingHandler,     Optional<CoDoingState> initiatorInitialState ) Permet d'ajouter une action collaborative à la session complémentaire.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(CoWatchingHandler coWatchingHandler) Ajoute le visionnage à plusieurs à la session complémentaire.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(     CoWatchingHandler coWatchingHandler,     Optional<CoWatchingState> initiatorInitialState ) Ajoute le visionnage à plusieurs à la session complémentaire avec l'état initial.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCollaborationStartingState(     CollaborationStartingState collaborationStartingState ) Définit les CollaborationStartingState pour la session.
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(ParticipantMetadataHandler handler) Enregistre un écouteur pour les mises à jour des métadonnées pour les autres participants.
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(     ParticipantMetadataHandler handler,     byte[] metadata ) Définit les métadonnées pour ce participant et enregistre un écouteur pour les mises à jour des autres participants.

Méthodes publiques

begin

abstract ListenableFuture<AddonSession> begin(Context appContext)

Démarre une session complémentaire. Cette méthode ne doit être appelée qu'une fois que l'utilisateur a confirmé qu'il souhaite participer à une session complémentaire.

se connecte à une réunion en créant une réunion ou en se connectant à une réunion en cours ; Remarques :

• Si une réunion est créée, l'utilisateur actuel en sera le seul participant au départ.
• Les détails de la réunion sont accessibles via getMeetingInfo sur la session renvoyée.
• L'URL renvoyée est destinée à être exposée à l'utilisateur et à être partagée manuellement avec le groupe de sessions du module complémentaire concerné.

Les instances de visionnage à plusieurs et de visionnage à plusieurs sont accessibles via getCoWatching et getCoDoing, respectivement.

Il est déconseillé d'appeler cancel à l'avenir, mais plutôt d'autoriser l'exécution complète.

Paramètres
Context appContext	La valeur getApplicationContext de l'application qui utilise le SDK

Renvoie
ListenableFuture<AddonSession>	ListenableFuture qui renvoie une instance AddonSession du type approprié si une session complémentaire a bien été démarrée. Sinon, renvoie IllegalStateException si un autre AddonSession est toujours en cours d'exécution (par exemple, endSession n'a pas été appelé) ou AddonException si une erreur inattendue s'est produite.

withCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

Ajoute une action à plusieurs à la session complémentaire avec l'état initial.

Paramètres
CoDoingHandler coDoingHandler	Rappels pour les tâches à plusieurs

Renvoie
AddonSession.Builder	une autre instance de compilateur pour le chaînage

Génère
java.lang.NullPointerException	si coDoingHandler est nul

withCoDoing

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

Permet d'ajouter une action collaborative à la session complémentaire.

Paramètres
CoDoingHandler coDoingHandler	Rappels pour les tâches à plusieurs
Optional<CoDoingState> initiatorInitialState	l'état initial de l'initiateur. Ce paramètre sera ignoré si l'utilisateur rejoint une session existante

Renvoie
AddonSession.Builder	une autre instance de compilateur pour le chaînage

Génère
java.lang.NullPointerException	si coDoingHandler ou initiatorInitialState est nul

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

Ajoute le visionnage à plusieurs à la session complémentaire.

Paramètres
CoWatchingHandler coWatchingHandler	Rappels pour le visionnage à plusieurs

Renvoie
AddonSession.Builder	une autre instance de compilateur pour le chaînage

Génère
java.lang.NullPointerException	si coWatchingHandler est nul

withCoWatching

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

Ajoute le visionnage à plusieurs à la session complémentaire avec l'état initial.

Paramètres
CoWatchingHandler coWatchingHandler	Rappels pour le visionnage à plusieurs
Optional<CoWatchingState> initiatorInitialState	l'état initial de l'initiateur. Ce paramètre sera ignoré si l'utilisateur rejoint une session existante

Renvoie
AddonSession.Builder	une autre instance de compilateur pour le chaînage

Génère
java.lang.NullPointerException	si coWatchingHandler ou initiatorInitialState est nul

withCollaborationStartingState

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Définit les CollaborationStartingState pour la session.

Vous pouvez modifier cela ultérieurement en appelant updateCollaborationStartingState ou resetCollaborationStartingState.

Paramètres
CollaborationStartingState collaborationStartingState	CollaborationStartingState de données

Génère
java.lang.NullPointerException	si collaborationStartingState est nul

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

Enregistre un écouteur pour les mises à jour des métadonnées pour les autres participants.

Les métadonnées du participant local seront initialement définies sur une valeur vide, mais vous pourrez les définir ultérieurement en appelant updateParticipantMetadata. Pour définir la valeur initiale, appelez plutôt withParticipantMetadata.

Paramètres
ParticipantMetadataHandler handler	Un ParticipantMetadataHandler pour recevoir le dernier ensemble de métadonnées des participants chaque fois qu'il est mis à jour

Génère
java.lang.NullPointerException	si handler est nul

withParticipantMetadata

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

Définit les métadonnées pour ce participant et enregistre un écouteur pour les mises à jour des autres participants.

Vous pouvez modifier ces métadonnées ultérieurement en appelant updateParticipantMetadata.

Les métadonnées encodées sont limitées à MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES octets par participant.

Paramètres
ParticipantMetadataHandler handler	Un ParticipantMetadataHandler pour recevoir le dernier ensemble de métadonnées des participants chaque fois qu'il est mis à jour
byte[] metadata	blob de métadonnées encodé décrivant les métadonnées pertinentes pour le participant local

Génère
java.lang.IllegalArgumentException	si les métadonnées fournies dépassent MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES octets
java.lang.NullPointerException	si handler est nul