Partilhar via

tipo de recurso de chat

  • Artigo

Namespace: microsoft.graph

Uma conversa é uma coleção de chatMessages entre um ou mais participantes. Os participantes podem ser utilizadores ou aplicações.

Nota: 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
Gestão de conversas
Criar chat chat Crie uma nova conversa.
Obter bate-papo chat Leia as propriedades e relações do chat.
Atualizar chat chat Atualize as propriedades do chat.
Delete Nenhum Eliminar uma conversa.
Listar membros coleção conversationMember Ver a lista de todos os usuários no bate-papo.
Adicionar membro Cabeçalho location Adicione um utilizador ao chat.
Obter membro conversationMember Obter um único usuário no bate-papo.
Remover membro Nenhum Remova um utilizador da conversa.
Obter chat entre o usuário e o aplicativo chat Obter uma conversa individual entre o utilizador e a aplicação
Mensagens
Listar mensagens em um bate-papo chatMessage Obter mensagens numa conversa.
Obter resposta da mensagem chatMessage Receba uma única mensagem em um bate-papo.
Obter mensagens em todas as conversas coleção de chat Obter mensagens de todos os chats nos quais um usuário é um participante.
Obter mensagens retidas em todas as conversas chatMessage collection Obtenha todas as mensagensretidas de todas as conversas nas quais um utilizador participa, incluindo conversas um-para-um, conversas de grupo e conversas de reunião.
Obter mensagens de chat delta para o utilizador chatMessage collection Obtenha a lista de mensagens de todas as conversas nas quais um utilizador é participante, incluindo conversas um-para-um, conversas de grupo e conversas de reunião.
Aplicativos
Listar aplicativos no chat Coleção teamsAppInstallation Listar aplicações instaladas num chat (e reunião associada).
Instalar a aplicação no chat teamsAppInstallation Instale uma aplicação específica numa conversa (e reunião associada).
Adicionar aplicação no chat Adicionar (instalar) uma aplicação numa conversa (e reunião associada).
Atualizar aplicativo instalado no chat Nenhum Atualize para a versão mais recente da aplicação instalada no chat (e reunião associada).
Remover a aplicação do chat Nenhum Remover (desinstalar) a aplicação de uma conversa (e reunião associada).
Listar as concessões de permissões Coleção resourceSpecificPermissionGrant Liste as permissões concedidas às aplicações neste chat.
Guias
Listar separadores no chat teamsTab Separadores de lista afixados a uma conversa (e reunião associada).
Obter o separador no chat teamsTab Obter um separador específico afixado a uma conversa (e reunião associada).
Adicionar separador ao chat teamsTab Adicione (afixe) um separador a uma conversa (e reunião associada).
Separador Atualizar no chat teamsTab Atualize as propriedades de um separador numa conversa (e reunião associada).
Remover separador do chat Nenhum Remover (remover) um separador de uma conversa (e reunião associada).
Mensagens afixadas
Listar mensagens afixadas pinnedChatMessageInfo collection Obtenha uma lista de mensagens afixadas numa conversa.
Afixar mensagem pinnedChatMessageInfo Afixe uma mensagem de chat numa conversa.
Remover mensagem Nenhum Remover uma mensagem de uma conversa.

Nota: Ao utilizar permissões de aplicação, certifique-se de que sabe como obter o ID de chat. Uma vez que a listagem de conversas com permissões de aplicação não é suportada, 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 aplicação.

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 a conversa foi criada. Somente leitura.
id Cadeia de caracteres O identificador exclusivo do chat. Somente leitura.
lastUpdatedDateTime dateTimeOffset Data e hora em que o nome da conversa foi mudado 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 inquilino no qual a conversa foi criada. Somente leitura.
topic Cadeia de caracteres (Opcional) Assunto ou tópico do chat. Apenas disponível para conversas de grupo.
ponto de vista chatViewpoint Representa informações específicas do autor da chamada sobre o chat, como a data e hora de leitura da última mensagem. Esta propriedade só é preenchida quando o pedido é feito num contexto delegado.
webUrl String O URL do chat no Microsoft Teams. O URL deve ser tratado como um blob opaco e não analisado. Somente leitura.

valores de chatType

Membro Valor Descrição
oneOnOne 0 Indica que o chat é uma conversa de 1:1. O tamanho da lista é fixo para este tipo de chat; os membros não podem ser removidos/adicionados.
group 1 Indica que o chat é uma conversa de grupo. O tamanho da lista (de, pelo menos, duas pessoas) pode ser atualizado para este tipo de chat. Os membros podem ser removidos/adicionados mais tarde.
reunião 2 Indica que o chat está associado a uma reunião online. Este tipo de chat só é criado como parte da criação de uma reunião online.
unknownFutureValue 3 Valor da sentinela de enumeração evoluível. Não usar.

Relações

Relação Tipo Descrição
installedApps Coleção teamsAppInstallation Uma coleção de todas as aplicações no chat. Anulável.
lastMessagePreview chatMessageInfo Pré-visualização da última mensagem enviada no chat. Nulo se não forem enviadas mensagens na conversa. Atualmente, apenas a operação de chats de lista suporta esta propriedade.
members coleção conversationMember Uma coleção de todos os membros na conversa. 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 às aplicações para o chat.
pinnedMessages pinnedChatMessageInfo collection Uma coleção de todas as mensagens afixadas no chat. Anulável.
guias teamsTab collection Uma coleção de todos os separadores no chat. Anulável.

Representação JSON

A representação JSON seguinte mostra o tipo de 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