このページでは、
CollaborationStartingState
その目的と、Google Meet アドオン SDK で設定および取得する方法を説明します。
コラボレーションの開始状態の概要
アドオンを最初に開くと、サイドパネルの iframe はアドオン マニフェストで指定された URL を読み込みます。この初期状態は、ユーザーがコラボレーションの招待を使用して参加するときにアドオンが使用する開始状態とは異なる場合があります。CollaborationStartingState を使用すると、ユーザーがコラボレーションの招待を使用して参加するときに読み込まれる iframe URL を指定できます。また、アドオンは additional_data フィールドを使用して、初期化に必要なデータを格納できます。
コラボレーションの開始状態を設定、取得、クリアする
CollaborationStartingState は次の方法で管理できます。
MeetAddonClient.setCollaborationStartingState メソッドを使用して、CollaborationStartingState を設定します。アドオンは、コラボレーションの前または最中にいつでも CollaborationStartingState を設定できます。
MeetAddonClient.setCollaborationStartingState メソッドで指定する URL は、アドオン マニフェストで指定したオリジンと同じオリジンに属している必要があります。詳細については、アドオンのセキュリティをご覧ください。
CollaborationStartingState.sidePanelUrl、CollaborationStartingState.mainStageUrl、CollaborationStartingState.additionalData の文字の長さは、SDK リファレンス ドキュメントで公開されているそれぞれのサイズ制限に従う必要があります。
mainStageClient.setCollaborationStartingState({
sidePanelUrl: "https://app.example.com/sidepanel",
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
MeetAddonClient.getCollaborationStartingState メソッドを使用して、CollaborationStartingState を取得します。
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
MeetAddonClient.clearCollaborationStartingState メソッドを使用して、CollaborationStartingState をクリアします。
mainStageClient.clearCollaborationStartingState();