AddonSession

Kotlin |Java

@PublicApi
interface AddonSession

---

アドオン セッション。

すべてのアドオン セッションに共通するメソッドが含まれます。同時視聴と共同視聴にアクセスするには、それぞれ getCoWatching と getCoDoing を呼び出します。

まとめ

ネストされた型
@PublicApi interface AddonSession.Builder AddonSession のビルダー。

パブリック関数
ListenableFuture<Void!>!	endSession() アドオン セッションが終了し、Meet アプリとの接続が解除されます。
Unit	endSuspension() 一時停止状態を終了します。
CoDoingClient!	getCoDoing() CoDoingClient インスタンスを返します。
CoWatchingClient!	getCoWatching() CoWatchingClient インスタンスを返します。
AddonMeetingInfo!	getMeetingInfo() 接続された会議に関する情報（会議の URL など）を返します。
Boolean	isSessionEnded() セッションが終了した場合は true を返します。
Boolean	isSuspended() セッションが一時停止されているかどうかを示します。
Unit	resetCollaborationStartingState() アドオンの開始状態をリセットします。
Unit	suspend() アドオン セッションを一時停止します。
Unit	updateCollaborationStartingState(     startingState: CollaborationStartingState! ) アドオンの開始状態を更新します。
Unit	updateParticipantMetadata(metadata: ByteArray!) この参加者のメタデータを更新します。

パブリック関数

endSession

fun endSession(): ListenableFuture<Void!>!

アドオン セッションが終了し、Meet アプリとの接続が解除されます。これにより、Meet が強制的に終了されたり、ユーザーが会議から退出したりすることはありません。

セッションがすでに終了している場合、何も実行されません。例外はスローされません。

戻り値
ListenableFuture<Void!>!	成功を評価する ListenableFuture、予期しないエラーが発生した場合は AddonException

endSuspension

fun endSuspension(): Unit

一時停止状態を終了します。アドオンアプリで最新情報を送受信できるようになりました。

停止状態でない場合、これは何も起こりません。

例外
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession への明示的な呼び出しである可能性もありますが、onSessionEnded を介して表示される外部理由による可能性もあります。

getCoDoing

fun getCoDoing(): CoDoingClient!

CoDoingClient インスタンスを返します。

例外
java.lang.IllegalStateException	withCoDoing を呼び出さずにセッションが作成された場合、またはセッションが終了した場合

getCoWatching

fun getCoWatching(): CoWatchingClient!

CoWatchingClient インスタンスを返します。

例外
java.lang.IllegalStateException	withCoWatching を呼び出さずにセッションが作成された場合、またはセッションが終了した場合

getMeetingInfo

fun getMeetingInfo(): AddonMeetingInfo!

接続された会議に関する情報（会議の URL など）を返します。

例外
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession への明示的な呼び出しである可能性もありますが、onSessionEnded を介して表示される外部理由による可能性もあります。

isSessionEnded

fun isSessionEnded(): Boolean

セッションが終了した場合は true を返します。これは、endSession の明示的な呼び出しによるものか、onSessionEnded を介して表面化される外部理由によるもののいずれかである可能性があります。

例外
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession の明示的な呼び出しか、onSessionEnded を介して表示される外部理由のいずれかによるものです。

isSuspended

fun isSuspended(): Boolean

セッションが一時停止されているかどうかを示します。suspend と endSuspension をご覧ください。

例外
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession への明示的な呼び出しである可能性もありますが、onSessionEnded を介して表示される外部理由による可能性もあります。

resetCollaborationStartingState

fun resetCollaborationStartingState(): Unit

アドオンの開始状態をリセットします。これにより、他の参加者が受け取った開始状態がクリアされます。開始状態をリセットできるのは、イニシエータのみです。

suspend

fun suspend(): Unit

アドオン セッションを一時停止します。これにより、Meet アプリとの接続は解除されません。これにより、SDK は CoDoingHandler と CoWatchingHandler に更新を送信しなくなり、SDK は呼び出しを通知する呼び出しを無視し、グローバル状態を更新する呼び出しを無視します。

セッションがすでに停止されている場合、これは何も起こりません。

たとえば、すべてのユーザーではなく、ユーザーが広告を表示するために再生を中断した場合や、ユーザーがアプリをバックグラウンドに移動した場合などに、suspend を呼び出すように選択できます。

例外
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession への明示的な呼び出しである可能性もありますが、onSessionEnded を介して表示される外部理由による可能性もあります。

updateCollaborationStartingState

fun updateCollaborationStartingState(
    startingState: CollaborationStartingState!
): Unit

アドオンの開始状態を更新します。他の参加者が共同編集の招待を承諾すると、このメッセージが届きます。開始状態を更新できるのは、イニシエータのみです。

パラメータ
startingState: CollaborationStartingState!	アドオンの開始状態

updateParticipantMetadata

fun updateParticipantMetadata(metadata: ByteArray!): Unit

この参加者のメタデータを更新します。

他の参加者からメタデータを受信するには、AddonSession の作成時に withparticipantMetadata を呼び出してハンドラを登録する必要があります。

エンコードされたメタデータは、参加者 1 人あたり MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES バイトが上限です。

パラメータ
metadata: ByteArray!	ローカルの参加者に関連するメタデータを記述する、エンコードされたメタデータの blob

例外
java.lang.IllegalArgumentException	指定されたメタデータが MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES バイトを超える場合
java.lang.IllegalStateException	セッションが終了した場合に表示されますこれは、endSession への明示的な呼び出しである可能性もありますが、onSessionEnded を介して表示される外部理由による可能性もあります。