tipo de recurso de chat
Namespace: microsoft.graph
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 a reunião de forma transitiva.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Gerenciamento de chat | ||
| Criar chat | chat | Crie um novo chat. |
| Obter bate-papo | chat | Leia as propriedades e as relações do chat. |
| Atualizar chat | chat | Atualize as propriedades do chat. |
| 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 | Obter um chat entre o usuário e o aplicativo |
| Mensagens | ||
| Listar mensagens no chat | chatMessage | Receba 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. |
| Aplicativos | ||
| Listar aplicativos no chat | Coleção teamsAppInstallation | Listar aplicativos instalados em um chat (e reunião associada). |
| Obter aplicativo no chat | teamsAppInstallation | Obter um aplicativo específico instalado em um chat (e reunião associada). |
| Adicionar aplicativo no chat | Adicione (instale) 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 na reunião associada). |
| Desinstalar o aplicativo do chat | Nenhum | Remova (desinstale) o aplicativo de um chat (e uma reunião associada). |
| Guias | ||
| Listar guias no chat | teamsTab | Listar guias fixadas em um chat (e reunião associada). |
| Guia Obter no chat | teamsTab | Obtenha uma guia específica fixada em um chat (e reunião associada). |
| Adicionar guia ao chat | teamsTab | Adicione (fixe) 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 (desafixar) uma guia de um chat (e uma reunião associada). |
Nota: Ao usar permissões de aplicativo, certifique-se de saber como obter a ID de chat. Como não há suporte para a listagem de 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 | String | (Opcional) Assunto ou tópico para o chat. Disponível apenas para chats em grupo. |
| 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 chatType
| Membro | Valor | Descrição |
|---|---|---|
| oneOnOne | 0 | Indica que o chat é um chat 1:1. O tamanho da lista de participantes é fixo para esse tipo de chat; membros não podem ser removidos/adicionados. |
| group | 1 | Indica que o chat é um chat em grupo. O tamanho da lista de participação (de pelo menos duas pessoas) pode ser atualizado para esse tipo de chat. Os membros podem ser removidos/adicionados posteriormente. |
| Reunião | 2 | 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 | 3 | Valor de sentinel de enumeração evolvá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. |
| 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. |
| 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.
{
"id": "string (identifier)",
"topic": "string",
"createdDateTime": "dateTimeOffset",
"lastUpdatedDateTime": "dateTimeOffset",
"chatType": "string",
"webUrl": "string",
"tenantId": "string",
"onlineMeetingInfo": {
"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
}
}
Confira também
Comentários
Enviar e exibir comentários de