AddonClient

Kotlin |Java

@PublicApi
interface AddonClient

---

アドオン セッションを開始および停止するためのプライマリ インターフェース。

注: 一度にアクティブにできるセッションは 1 つのみです。それ以外のセッションでは、begin から返される ListenableFuture は で解決されます。セッションは自然に終了して（ユーザーが会議から退出したなど）、onSessionEnded を呼び出すか、endSession を呼び出してセッションを終了できます。

使用例:

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();
}

まとめ

ネストされた型
@PublicApi enum AddonClient.AddonFailureEventType アドオン セッションの前、最中、または後で発生したエラー イベントを表します。

パブリック関数
AddonSession.Builder!	newSessionBuilder(handler: AddonSessionHandler!) 新しいアドオン セッションのビルダーを返します。
Unit	notifyAddonFailureEvent(     appContext: Context!,     failureEventType: AddonClient.AddonFailureEventType! ) アドオンの障害イベントを Meet に通知します。
Unit	registerMeetingStatusListener(     appContext: Context!,     listener: MeetingStatusListener!,     handler: Optional<Handler!>! ) 会議とアドオン セッションのステータスの変更について通知するリスナーを登録します。
Unit	unregisterMeetingStatusListener(appContext: Context!) MeetingStatus の変更に対するアクティブなリスナーの登録を解除します。

パブリック関数

newSessionBuilder

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

新しいアドオン セッションのビルダーを返します。セッションは、begin が呼び出された場合にのみ開始されます。

セッションを開始するには、まず withCoWatching、withCoDoing、またはその両方をこのビルダーにチェーンします。

使用例:

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

参加者のメタデータ機能を利用するには、ビルダー チェーンで withparticipantMetadata を呼び出して初期状態を指定し、他の参加者のリスナーを登録します。次に例を示します。

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

セッションを開始する方法の詳細については、begin をご覧ください。

パラメータ
handler: AddonSessionHandler!	すべてのアドオン セッションに適用されるコールバック

戻り値
AddonSession.Builder!	新しい AddonSession インスタンスのビルダー

例外
java.lang.NullPointerException	指定された引数のいずれかが null の場合

notifyAddonFailureEvent

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

アドオンの障害イベントを Meet に通知します。

パラメータ
appContext: Context!	Meet アドオンの SDK を使用しているアプリケーションの getApplicationContext 値
failureEventType: AddonClient.AddonFailureEventType!	ライブ共有セッションの前、最中、または後で発生した障害イベントの種類

例外
java.lang.NullPointerException	指定された引数のいずれかが null の場合

registerMeetingStatusListener

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

会議とアドオン セッションのステータスの変更について通知するリスナーを登録します。

登録されたリスナーは、次のいずれかのステータスで通知されます。

• MEETING - Meet アプリに進行中の会議があります
• ADDON_SESSION - アクティブなアドオン セッションがあります。これを行えるのは、アクティブな会議がある場合に限られます。
• NO_MEETING - ミーティングまたはアドオン セッションなし

パラメータ
appContext: Context!	Meet アドオンの SDK を使用しているアプリケーションの getApplicationContext 値
listener: MeetingStatusListener!	ステータスの変更について通知を受け取る MeetingStatusListener
handler: Optional<Handler!>!	非同期実行の場合は Handler の Optional。指定しない場合、結果のロジックは UI スレッドで実行されます。

例外
java.lang.IllegalStateException	登録済みのリスナーに対して unregisterMeetingStatusListener を呼び出す前にこのメソッドが呼び出された場合

unregisterMeetingStatusListener

fun unregisterMeetingStatusListener(appContext: Context!): Unit

MeetingStatus の変更に対するアクティブなリスナーの登録を解除します。

パラメータ
appContext: Context!	Meet アドオンの SDK を使用しているアプリケーションの getApplicationContext 値

例外
java.lang.IllegalStateException	registerMeetingStatusListener を呼び出す前にこのメソッドが呼び出された場合。