Esta página descreve a finalidade do
CollaborationStartingState
e como configurá-lo e recuperá-lo do SDK de complementos do Meet.
Visão geral do estado inicial da colaboração
Quando um complemento é aberto pela primeira vez, o iframe do painel lateral carrega o URL especificado no manifesto do complemento. Esse estado inicial pode ser diferente do estado inicial que o complemento quer usar quando os usuários estiverem participando usando o convite de colaboração. O CollaborationStartingState
pode ser usado para especificar os URLs de iframe que precisam ser carregados quando os usuários participam usando o convite para colaboração. Além disso, o campo additional_data
pode ser
usado pelo complemento para armazenar todos os dados necessários
para a inicialização.
Definir, receber e limpar o estado inicial da colaboração
É possível gerenciar CollaborationStartingState
com os métodos a seguir.
Defina o CollaborationStartingState
usando o método MeetAddonClient.setCollaborationStartingState
. O complemento pode definir a CollaborationStartingState
a qualquer momento antes
ou durante a colaboração.
Os URLs especificados no método MeetAddonClient.setCollaborationStartingState
precisam pertencer à mesma origem das
origens especificadas no manifesto do complemento. Para mais informações, consulte Segurança de complementos.
Os caracteres
CollaborationStartingState.sidePanelUrl
,
CollaborationStartingState.mainStageUrl
e
CollaborationStartingState.additionalData
precisam estar em conformidade com os respectivos limites de tamanho, conforme publicado nos
documentos de referência do SDK.
mainStageClient.setCollaborationStartingState({
sidePanelUrl: "https://app.example.com/sidepanel",
mainStageUrl: "https://app.example.com/mainstage",
additionalData: JSON.stringify({
// State to send to participants.
})
});
Acesse o CollaborationStartingState
com o método MeetAddonClient.getCollaborationStartingState
.
const startingState = mainStageClient.getCollaborationStartingState();
const additionalData = JSON.parse(startingState.additionalData);
Limpe o CollaborationStartingState
com o método MeetAddonClient.clearCollaborationStartingState
.
mainStageClient.clearCollaborationStartingState();