AddonSession.Builder

Kotlin |Java

@PublicApi
public interface AddonSession.Builder

---

---

Early Access-Programm:Dieses Feature ist nur als eingeschränkte Vorschau im Rahmen eines Early Access-Programms verfügbar.

Ein Builder für AddonSession. newSessionBuilder ansehen.

Zusammenfassung

Öffentliche Methoden
abstract ListenableFuture<AddonSession>	begin(Context appContext) Startet eine Add-on-Sitzung.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(CoDoingHandler coDoingHandler) Fügt der Add-on-Sitzung mit dem Anfangsstatus die Möglichkeit zum gemeinsamen Handeln hinzu.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoDoing(     CoDoingHandler coDoingHandler,     Optional<CoDoingState> initiatorInitialState ) Fügt der Add-on-Sitzung die Möglichkeit zum gemeinsamen Handeln hinzu.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(CoWatchingHandler coWatchingHandler) Fügt der Add-on-Sitzung das gemeinsame Ansehen hinzu.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCoWatching(     CoWatchingHandler coWatchingHandler,     Optional<CoWatchingState> initiatorInitialState ) Fügt der Add-on-Sitzung das Co-Viewing mit dem Anfangsstatus hinzu.
abstract AddonSession.Builder	@CanIgnoreReturnValue withCollaborationStartingState(     CollaborationStartingState collaborationStartingState ) Legt den CollaborationStartingState für die Sitzung fest.
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(ParticipantMetadataHandler handler) Registriert einen Listener für Aktualisierungen von Metadaten für andere Teilnehmer
abstract AddonSession.Builder	@CanIgnoreReturnValue withParticipantMetadata(     ParticipantMetadataHandler handler,     byte[] metadata ) Legt die Metadaten für diesen Teilnehmer fest und registriert einen Listener für Aktualisierungen anderer Teilnehmer.

Öffentliche Methoden

Anfang

abstract ListenableFuture<AddonSession> begin(Context appContext)

Startet eine Add-on-Sitzung. Sie sollte erst aufgerufen werden, wenn der Nutzer bestätigt hat, dass er an einer Add-on-Sitzung teilnehmen möchte.

Stellt eine Verbindung zu einer Videokonferenz her, indem entweder eine Videokonferenz erstellt oder eine Verbindung zu einer laufenden Videokonferenz hergestellt wird. Hinweise:

• Wenn eine Videokonferenz erstellt wird, ist anfangs der aktuelle Nutzer der einzige Teilnehmer.
• Die Besprechungsdetails können für die zurückgegebene Sitzung über getMeetingInfo aufgerufen werden.
• Die zurückgegebene URL ist für den Nutzer vorgesehen und wird manuell für die gewünschte Add-on-Sitzungsgruppe freigegeben.

Die Instanzen für das Co-Watching und das Co-Doing können über getCoWatching bzw. getCoDoing aufgerufen werden.

Es wird nicht empfohlen, für diese Zukunft cancel aufzurufen. Stattdessen sollte sie vollständig ausgeführt werden können.

Parameter
Context appContext	Den getApplicationContext-Wert der Anwendung, die das SDK verwendet

Returns
ListenableFuture<AddonSession>	ListenableFuture, das eine AddonSession-Instanz des entsprechenden Typs ergibt, wenn eine Add-on-Sitzung erfolgreich gestartet wurde. Wird andernfalls als IllegalStateException ausgewertet, wenn noch ein anderer AddonSession ausgeführt wird (z.B. endSession wurde nicht aufgerufen) oder als AddonException, wenn ein unerwarteter Fehler aufgetreten ist.

withCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

Fügt der Add-on-Sitzung mit dem Anfangsstatus die Möglichkeit zum gemeinsamen Handeln hinzu.

Parameter
CoDoingHandler coDoingHandler	Callbacks für gemeinsame Aktivitäten

Returns
AddonSession.Builder	eine weitere Builder-Instanz für Verkettung

Löst aus
java.lang.NullPointerException	wenn coDoingHandler null ist

withCoDoing

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

Fügt der Add-on-Sitzung die Möglichkeit zum gemeinsamen Handeln hinzu.

Parameter
CoDoingHandler coDoingHandler	Callbacks für gemeinsame Aktivitäten
Optional<CoDoingState> initiatorInitialState	ist der Ausgangszustand des Initiators. Er wird ignoriert, wenn der Nutzer einer vorhandenen Sitzung beitritt.

Returns
AddonSession.Builder	eine weitere Builder-Instanz für Verkettung

Löst aus
java.lang.NullPointerException	wenn coDoingHandler oder initiatorInitialState null ist

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

Fügt der Add-on-Sitzung das gemeinsame Ansehen hinzu.

Parameter
CoWatchingHandler coWatchingHandler	Callbacks für das gemeinsame Ansehen

Returns
AddonSession.Builder	eine weitere Builder-Instanz für Verkettung

Löst aus
java.lang.NullPointerException	wenn coWatchingHandler null ist

withCoWatching

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

Fügt der Add-on-Sitzung das Co-Viewing mit dem Anfangsstatus hinzu.

Parameter
CoWatchingHandler coWatchingHandler	Callbacks für das gemeinsame Ansehen
Optional<CoWatchingState> initiatorInitialState	ist der Ausgangszustand des Initiators. Er wird ignoriert, wenn der Nutzer einer vorhandenen Sitzung beitritt.

Returns
AddonSession.Builder	eine weitere Builder-Instanz für Verkettung

Löst aus
java.lang.NullPointerException	wenn coWatchingHandler oder initiatorInitialState null ist

withCollaborationStartingState

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Legt den CollaborationStartingState für die Sitzung fest.

Dies kann später durch Aufrufen von updateCollaborationStartingState oder resetCollaborationStartingState geändert werden.

Parameter
CollaborationStartingState collaborationStartingState	CollaborationStartingState an Daten

Löst aus
java.lang.NullPointerException	wenn collaborationStartingState null ist

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

Registriert einen Listener für Aktualisierungen von Metadaten für andere Teilnehmer

Die Metadaten des lokalen Teilnehmers werden anfangs auf einen leeren Wert gesetzt, können aber später durch Aufrufen von updateParticipantMetadata festgelegt werden. Rufen Sie stattdessen withParticipantMetadata auf, um den Anfangswert festzulegen.

Parameter
ParticipantMetadataHandler handler	ein ParticipantMetadataHandler, um bei jeder Aktualisierung den neuesten Satz von Teilnehmermetadaten zu erhalten

Löst aus
java.lang.NullPointerException	wenn handler null ist

withParticipantMetadata

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

Legt die Metadaten für diesen Teilnehmer fest und registriert einen Listener für Aktualisierungen anderer Teilnehmer.

Diese Metadaten können später durch Aufrufen von updateParticipantMetadata geändert werden.

Die codierten Metadaten sind auf MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES Byte pro Teilnehmer beschränkt.

Parameter
ParticipantMetadataHandler handler	ein ParticipantMetadataHandler, um bei jeder Aktualisierung den neuesten Satz von Teilnehmermetadaten zu erhalten
byte[] metadata	Ein codiertes Metadaten-Blob, das relevante Metadaten für den lokalen Teilnehmer beschreibt

Löst aus
java.lang.IllegalArgumentException	wenn die bereitgestellten Metadaten MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES Byte überschreiten.
java.lang.NullPointerException	wenn handler null ist