このページでは、CollaborationStartingState の目的と、Google Meet アドオン SDK を設定して取得する方法について説明します。
コラボレーションの開始状態の概要
アドオンを初めて開くと、アドオン マニフェストで指定された URL がサイドパネル iframe に読み込まれます。この初期状態は、ユーザーがコラボレーションの招待状を使用して参加するときにアドオンが使用する開始状態とは異なる場合があります。CollaborationStartingState を使用すると、ユーザーがコラボレーション招待状を使用して参加したときに読み込まれる iframe URL を指定できます。また、アドオンは additional_data フィールドを利用して、初期化に必要なデータを保存できます。
コラボレーションの開始状態を設定、取得、クリアする
CollaborationStartingState は次の方法で管理できます。
MeetAddonClient.setCollaborationStartingState メソッドを使用して、CollaborationStartingState を設定します。
MeetAddonClient.setCollaborationStartingState メソッドで指定する URL は、アドオン マニフェストで指定されたオリジンと同じオリジンに属している必要があります。詳細については、アドオンのセキュリティをご覧ください。
sidePanelUrl、mainStageUrl、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();