Tipo de recurso de chat
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Um chat é uma coleção de chatMessages entre um ou mais participantes. Os participantes podem ser usuários ou aplicativos.
Observação: se o chat estiver associado a uma instância onlineMeeting , alguns dos métodos listados afetarão transitivamente a reunião.
Métodos
Método | Tipo de retorno | Descrição |
---|---|---|
Gerenciamento de chat | ||
Listar chats | coleção de chat | Obtenha a lista de chats dos quais um usuário faz parte. |
Criar chat | chat | Crie um novo chat. |
Obter bate-papo | chat | Leia propriedades e relações do chat. |
Atualizar chat | chat | Atualize as propriedades do chat. |
Excluir chat | Nenhum | Excluir um chat. |
removeAllAccessForUser | Nenhum | Remova o acesso a um chat para um usuário. |
Listar membros do bate-papo | coleção conversationMember | Ver a lista de todos os usuários no bate-papo. |
Adicionar membro do bate-papo | Cabeçalho de local | Adicione um usuário ao chat. |
Obter membro do bate-papo | conversationMember | Obter um único usuário no bate-papo. |
Remover membro do bate-papo | Nenhum | Remova um usuário do chat. |
Obter chat entre o usuário e o aplicativo | chat | Obtenha um chat individual entre o usuário e o aplicativo. |
Marcar chat como lido | Nenhum | Marque o chat como lido para um usuário. |
Marcar chat como não lido | Nenhum | Marque o chat como não lido para um usuário. |
Ocultar chat | Nenhum | Ocultar um chat para um usuário. |
Unhide chat | Nenhum | Desaguarde um chat para um usuário. |
Mensagens | ||
Listar mensagens no chat | chatMessage | Obtenha mensagens em um chat. |
Receba uma mensagem no bate-papo | chatMessage | Receba uma única mensagem em um bate-papo. |
Obter mensagens em todos os chats para o usuário | coleção de chat | Obter mensagens de todos os chats nos quais um usuário é um participante. |
Obter todas as mensagens de chat retidas | chatMessage collection | Obtenha todas as mensagens retidas de todos os chats em que um usuário é participante, incluindo chats individuais, chats em grupo e chats de reunião. |
Aplicativos | ||
Listar aplicativos no chat | Coleção teamsAppInstallation | Listar aplicativos instalados em um chat (e reunião associada). |
Obter aplicativo no chat | teamsAppInstallation | Obtenha um aplicativo específico instalado em um chat (e reunião associada). |
Adicionar aplicativo no chat | Adicione (instalar) um aplicativo em um chat (e reunião associada). | |
Atualizar aplicativo no chat | Nenhum | Atualize para a versão mais recente do aplicativo instalado no chat (e reunião associada). |
Desinstalar o aplicativo do chat | Nenhum | Remover o aplicativo (desinstalar) de um chat (e reunião associada). |
Listar as concessões de permissões | Coleção resourceSpecificPermissionGrant | Listar permissões concedidas aos aplicativos neste chat. |
Guias | ||
Listar guias no chat | teamsTab | Guias de lista fixadas em um chat (e reunião associada). |
Obter guia no chat | teamsTab | Obtenha uma guia específica fixada em um chat (e reunião associada). |
Adicionar guia ao chat | teamsTab | Adicione (fixar) uma guia a um chat (e reunião associada). |
Guia Atualizar no chat | teamsTab | Atualize as propriedades de uma guia em um chat (e reunião associada). |
Remover guia do chat | Nenhum | Remova (desapinar) uma guia de um chat (e reunião associada). |
Operations | ||
Listar operações no chat | Coleção teamsAsyncOperation | Obtenha a lista de operações assíncronas executadas ou em execução no chat. |
Obter operação no chat | teamsAsyncOperation | Obtenha uma única operação assíncrona que foi executada ou está em execução no chat. |
Mensagens fixas | ||
Listar mensagens fixas | coleção pinnedChatMessageInfo | Obtenha uma lista de mensagens fixadas em um chat. |
Fixar uma mensagem | pinnedChatMessageInfo | Fixar uma mensagem de chat em um chat. |
Desafixar uma mensagem | Nenhum | Desafixar uma mensagem de um chat. |
Nota: Ao usar permissões de aplicativo, certifique-se de saber como obter a ID do chat. Como não há suporte para listar chats com permissões de aplicativo, nem todos os cenários são possíveis. É possível obter IDs de chat com permissões delegadas e de notificações de alteração para /chats/getAllMessages com permissões de aplicativo.
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
chatType | chatType | Especifica o tipo de chat. Os valores possíveis são: group , oneOnOne , meeting , unknownFutureValue . |
createdDateTime | dateTimeOffset | Data e hora em que o chat foi criado. Somente leitura. |
id | Cadeia de caracteres | O identificador exclusivo do chat. Somente leitura. |
lastUpdatedDateTime | dateTimeOffset | Data e hora em que o chat foi renomeado ou a lista de membros foi alterada pela última vez. Somente leitura. |
onlineMeetingInfo | teamworkOnlineMeetingInfo | Representa detalhes sobre uma reunião online. Se o chat não estiver associado a uma reunião online, a propriedade estará vazia. Somente leitura. |
tenantId | String | O identificador do locatário no qual o chat foi criado. Somente leitura. |
topic | Cadeia de caracteres | (Opcional) Assunto ou tópico para o chat. Disponível apenas para chats em grupo. |
Vista | chatViewpoint | Representa informações específicas do chamador sobre o chat, como data e hora de leitura da última mensagem. Essa propriedade só é preenchida quando a solicitação é feita em um contexto delegado. |
webUrl | String | A URL do chat no Microsoft Teams. A URL deve ser tratada como um blob opaco e não analisada. Somente leitura. |
valores de chatType
Member | Descrição |
---|---|
oneOnOne | Indica que o chat é um chat 1:1. O tamanho da lista é corrigido para esse tipo de chat; os membros não podem ser removidos/adicionados. |
group | Indica que o chat é um chat em grupo. O tamanho da lista (de pelo menos duas pessoas) pode ser atualizado para esse tipo de chat. Os membros podem ser removidos/adicionados posteriormente. |
Reunião | Indica que o chat está associado a uma reunião online. Esse tipo de chat só é criado como parte da criação de uma reunião online. |
unknownFutureValue | Valor sentinela de enumeração evoluível. Não usar. |
Relações
Relação | Tipo | Descrição |
---|---|---|
installedApps | Coleção teamsAppInstallation | Uma coleção de todos os aplicativos no chat. Anulável. |
lastMessagePreview | chatMessageInfo | Visualização da última mensagem enviada no chat. Nulo se nenhuma mensagem tiver sido enviada no chat. Atualmente, apenas a operação de chats de lista dá suporte a essa propriedade. |
members | coleção conversationMember | Uma coleção de todos os membros no chat. Anulável. |
messages | chatMessage collection | Uma coleção de todas as mensagens no chat. Anulável. |
operations | Coleção teamsAsyncOperation | Uma coleção de todas as operações assíncronas do Teams que foram executadas ou estão em execução no chat. Anulável. |
permissionGrants | Coleção resourceSpecificPermissionGrant | Uma coleção de permissões concedidas aos aplicativos para o chat. |
pinnedMessages | coleção pinnedChatMessageInfo | Uma coleção de todas as mensagens fixadas no chat. Anulável. |
guias | teamsTab collection | Uma coleção de todas as guias no chat. Anulável. |
Representação JSON
Veja a seguir uma representação JSON do recurso.
{
"chatType": "string",
"createdDateTime": "dateTimeOffset",
"id": "string (identifier)",
"lastUpdatedDateTime": "dateTimeOffset",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
},
"tenantId": "string",
"topic": "string",
"viewpoint": {
"@odata.type": "microsoft.graph.chatViewpoint"
},
"webUrl": "string"
}
Conteúdo relacionado
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de