AddonClient

Kotlin |Java

@PublicApi
interface AddonClient

---

Primäre Schnittstelle zum Starten und Beenden einer Add-on-Sitzung.

Hinweis: Es kann immer nur eine Sitzung aktiv sein. Andernfalls wird der von begin zurückgegebene ListenableFuture mit einem Fehler aufgelöst. Eine Sitzung kann von selbst enden, z. B. weil der Nutzer die Besprechung verlassen hat, und dann onSessionEnded aufrufen. Außerdem kann sie durch Aufrufen von endSession beendet werden.

Verwendungsbeispiel:

class AwesomeAddonSessionHandler implements AddonSessionHandler {}

class AwesomeCoWatchingHandler implements CoWatchingHandler {}

public void registerStatusListener() {
  AddonClient meetClient = AddonClientFactory.getClient();
  meetClient.registerMeetingStatusListener(
      appContext,
      meetingStatus -> {
        switch (meetingStatus.status()) {
          case NO_MEETING:
            // User is not in a meeting currently.
            break;
          case MEETING:
            // User is in a meeting, check if they want to start an add-on session.
            showStartAddonSessionDialog();
            break;
          case ADDON_SESSION:
            // User is in a meeting that already hosts an add-on session, check if they want
            // to join the ongoing session.
            showJoinAddonSessionDialog();
            break;
        }
      },
      Optional.empty());
}

public ListenableFuture<AddonClient> initialSetup() {
  AddonClient meetClient = AddonClientFactory.getClient();
  return meetClient
      .newSessionBuilder(appContext, new AwesomeAddonSessionHandler())
      .withCoWatching(new AwesomeCoWatchingHandler())
      .begin();
}

Zusammenfassung

Verschachtelte Typen
@PublicApi enum AddonClient.AddonFailureEventType Stellt ein Fehlerereignis vor, während oder nach einer Add-on-Sitzung dar.

Öffentliche Funktionen
AddonSession.Builder!	newSessionBuilder(handler: AddonSessionHandler!) Gibt einen Builder für eine neue Add-on-Sitzung zurück.
Unit	notifyAddonFailureEvent(     appContext: Context!,     failureEventType: AddonClient.AddonFailureEventType! ) Benachrichtigt Meet bei einem Add-on-Fehler.
Unit	registerMeetingStatusListener(     appContext: Context!,     listener: MeetingStatusListener!,     handler: Optional<Handler!>! ) Registriert einen Listener, der über Änderungen am Status von Videokonferenzen und Add-on-Sitzungen benachrichtigt wird.
Unit	unregisterMeetingStatusListener(appContext: Context!) Hebt die Registrierung eines aktiven Listeners für MeetingStatus-Änderungen auf

Öffentliche Funktionen

newSessionBuilder

fun newSessionBuilder(handler: AddonSessionHandler!): AddonSession.Builder!

Gibt einen Builder für eine neue Add-on-Sitzung zurück. Die Sitzung beginnt erst, wenn begin aufgerufen wird.

Um eine Sitzung zu starten, verketten Sie zuerst withCoWatching, withCoDoing oder beide mit diesem Builder.

Verwendungsbeispiel:

ListenableFuture<AddonSession> session = meetClient
    .newSessionBuilder(appContext, new AwesomeAddonSessionHandler())
    .withCoWatching(new AwesomeCoWatchingHandler())
    .withCoDoing(new AwesomeCoDoingHandler())
    .begin();

Wenn Sie die Funktion für Teilnehmermetadaten nutzen möchten, rufen Sie withParticipantMetadata in der Builder-Kette auf, um den Anfangszustand anzugeben und einen Listener für andere Teilnehmer zu registrieren. Beispiel:

ListenableFuture<AddonSession> session = meetClient
    .newSessionBuilder(new AwesomeAddonSessionHandler())
    .withCoWatching(new AwesomeCoWatchingHandler())
    .withParticipantMetadata(new AwesomeMetadataHandler(), myMetadataBytes)
    .begin(appContext);

Weitere Informationen zum Starten einer Sitzung finden Sie unter begin.

Parameter
handler: AddonSessionHandler!	Callbacks, die für alle Add-on-Sitzungen gelten

Returns
AddonSession.Builder!	Builder für eine neue AddonSession-Instanz

Löst aus
java.lang.NullPointerException	Eines der angegebenen Argumente ist null.

notifyAddonFailureEvent

fun notifyAddonFailureEvent(
    appContext: Context!,
    failureEventType: AddonClient.AddonFailureEventType!
): Unit

Benachrichtigt Meet bei einem Add-on-Fehler.

Parameter
appContext: Context!	Der Wert getApplicationContext der Anwendung, die das SDK des Meet-Add-ons verwendet
failureEventType: AddonClient.AddonFailureEventType!	Die Art des Fehlerereignisses, das vor, während oder nach einer Live-Freigabesitzung aufgetreten ist

Löst aus
java.lang.NullPointerException	Eines der angegebenen Argumente ist null.

registerMeetingStatusListener

fun registerMeetingStatusListener(
    appContext: Context!,
    listener: MeetingStatusListener!,
    handler: Optional<Handler!>!
): Unit

Registriert einen Listener, der über Änderungen am Status von Videokonferenzen und Add-on-Sitzungen benachrichtigt wird.

Der registrierte Listener wird aufgrund eines der folgenden Status benachrichtigt:

• MEETING – In der Meet App ist eine aktive Videokonferenz vorhanden
• ADDON_SESSION: Es gibt eine aktive Add-on-Sitzung. Dies ist nur möglich, wenn auch eine aktive Besprechung vorhanden ist.
• NO_MEETING: Keine Videokonferenz oder Add-on-Sitzung

Parameter
appContext: Context!	Der Wert getApplicationContext der Anwendung, die das SDK des Meet-Add-ons verwendet
listener: MeetingStatusListener!	MeetingStatusListener, um über Statusänderungen informiert zu werden
handler: Optional<Handler!>!	Ein Optional von Handler für eine asynchrone Ausführung. Wenn keine angegeben ist, kann die resultierende Logik im UI-Thread ausgeführt werden.

Löst aus
java.lang.IllegalStateException	Wenn diese Methode vor dem Aufruf von unregisterMeetingStatusListener für einen bereits registrierten Listener aufgerufen wird

unregisterMeetingStatusListener

fun unregisterMeetingStatusListener(appContext: Context!): Unit

Hebt die Registrierung eines aktiven Listeners für MeetingStatus-Änderungen auf

Parameter
appContext: Context!	Der Wert getApplicationContext der Anwendung, die das SDK des Meet-Add-ons verwendet

Löst aus
java.lang.IllegalStateException	Wenn diese Methode vor dem Aufruf von registerMeetingStatusListener aufgerufen wird.