Cette page explique comment gérer les objets client dont un module complémentaire a besoin pour communiquer avec Google Meet.
Tout d'abord, le module complémentaire doit établir une session:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER",
});
Remplacez CLOUD_PROJECT_NUMBER par le numéro de projet de votre projet Google Cloud.
À partir de la session, deux objets client peuvent être créés:
MeetMainStageClient
pour un module complémentaire exécuté dans l'étape principale, récupérable à l'aide deawait session.createMainStageClient()
.MeetSidePanelClient
pour un module complémentaire exécuté dans le panneau latéral, récupérable à l'aide deawait session.createSidePanelClient()
.
Il est important de récupérer l'objet client approprié pour l'espace de création principal ou le panneau latéral. Si le mauvais client est récupéré, le SDK des modules complémentaires Google Meet génère une exception. Pour vérifier dans quel iFrame (étape principale ou panneau latéral) le module complémentaire s'exécute, utilisez la méthode getFrameType()
.
L'exemple de code suivant montre comment instancier l'objet client de la scène principale:
const session = await window.meet.addon.createAddonSession({
cloudProjectNumber: "CLOUD_PROJECT_NUMBER"
});
const mainStageClient = await session.createMainStageClient();
Remplacez CLOUD_PROJECT_NUMBER par le numéro de votre projet Cloud.
Fonctionnalités partagées
Certaines fonctionnalités sont disponibles à la fois dans l'objet MeetMainStageClient
et dans l'objet MeetSidePanelClient
, tandis que d'autres sont spécifiques à un client donné.
Par exemple, voici quelques fonctionnalités disponibles dans les deux clients:
- Méthode
getActivityStartingState()
qui obtient des informations sur l'état initial du module complémentaire lorsque le participant accepte l'invitation à rejoindre l'activité. - Méthode
getMeetingInfo()
qui récupère des informations sur la réunion dans laquelle le module complémentaire s'exécute. - La méthode
setActivityStartingState()
qui définit l'état initial du module complémentaire lorsque le participant accepte l'invitation à rejoindre l'activité. - Pour obtenir la liste complète des fonctionnalités des deux clients, consultez l'objet
MeetAddonClient
.
Fonctionnalités spécifiques au client
Fonctionnalités disponibles uniquement dans l'objet MeetMainStageClient
:
La méthode
notifySidePanel()
envoie un message au panneau latéral. Le message peut être reçu en s'abonnant au appel de rappelframeToFrameMessage
dans le panneau latéral.La méthode
loadSidePanel()
ouvre l'iFrame du panneau latéral. La source de l'iFrame est définie sur l'URL du panneau latéral dans le fichier manifeste.La méthode
unloadSidePanel()
ferme l'iframe du panneau latéral. L'état du module complémentaire n'est pas conservé dans Meet lorsque la méthode est appelée. C'est au module complémentaire de conserver l'état du module complémentaire avant l'appel de cette méthode.
Fonctionnalités disponibles uniquement dans l'objet MeetSidePanelClient
:
- La méthode
notifyMainStage()
envoie un message à la mainStage. Le message peut être reçu en s'abonnant à la propriété de rappelframeToFrameMessage
dans la scène principale.