Tipo de recurso de chat

  • Artigo

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 transitivamente a reunião.

Métodos

Método Tipo de retorno Descrição
Gerenciamento de chat
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.
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 individual entre o usuário e o aplicativo
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.
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).
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 a última mensagem de leitura data e hora. 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

Membro Valor Descrição
oneOnOne 0 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 1 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 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 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 foi 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.
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.

{
  "createdDateTime": "dateTimeOffset",
  "chatType": "string",
  "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