Compartilhar via

Tipo de recurso de usuário

  • Artigo

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.

Teams é formado por canais que são as conversas que você tem com seus colegas. Cada canal é dedicado a um tópico específico, departamento ou projeto. Os canais estão onde o trabalho é feito - onde conversas via texto, áudio e vídeo abertas para toda a equipe ocontecem, onde os arquivos são compartilhados e as guias são adicionadas.

Métodos

Método Tipo de retorno Descrição
List channels channel collection Obtenha a lista de canais em uma equipe.
Lstar canais de entrada Coleção channel Obtenha a lista de canais compartilhados com uma equipe.
Listar todos os canais Coleção channel Obtenha a lista de canais em uma equipe ou compartilhada com uma equipe (canais de entrada).
Create channel channel Crie um novo canal ao incluir o nome de exibição e a descrição.
Get channel channel Leia as propriedades e as relações do canal.
Obter canal primário canal O canal geral da equipe.
Update channel channel Atualize as propriedades do canal.
Delete channel Nenhum Exclua um canal.
List channel messages chatMessage Obtenha mensagens em um canal.
Obter todas as mensagens do canal channel collection Obter todas as mensagens de todos os chats nos quais um usuário é um participante.
Obter todas as mensagens de canal retidas chatMessage collection Obtenha todas as mensagens retidas em todos os canais numa equipa.
Criar postagem de mensagem no canal chatMessage Envie uma mensagem para um canal.
Criar resposta à postagem da mensagem do canal chatMessage Responda a uma mensagem em um canal.
Obter pasta de arquivos. driveItem Recupera os detalhes da pasta do SharePoint em que os arquivos do canal estão armazenados.
Listar guias teamsTab Listar guias fixadas a um canal.
Listar membros do canal coleção conversationMember Obtenha uma lista de todas as mensagens raiz em um canal.
Adicionar membro do canal conversationMember Adicionar um membro a um canal. Só há suporte para canais com um membershipType de private ou shared.
Obter canal do membro coleção conversationMember Obtenha um membro em um canal.
Canal de arquivo Nenhum Arquivar um canal.
Canal unarchive Nenhum Desarcultar um canal.
Atualizar a função do membro do canal conversationMember Atualize as propriedades de um membro do canal. Só há suporte para canais com um membershipType de private ou shared.
Remover membro do canal Nenhum Exclua um membro de um canal. Só há suporte para canais com um membershipType de private ou shared.
Migração completa channel Remove o modo de migração do canal e torna o canal disponível para os usuários postarem e lerem mensagens.
Listar guias no canal teamsTab Listar guias fixadas a um canal.
Adicionar uma guia ao canal teamsTab Adicionar (fixar) uma guia a um canal.
Guia obter no canal teamsTab Ler uma guia fixada a um canal.
Guia atualizar no canal teamsTab Atualiza as propriedades de uma guia em um canal.
Remover guia do canal Nenhum Remover (Desafixar) uma Tabulação de um canal.
Endereço de email do canal de provisão provisionChannelEmailResult Provisione um endereço de e-mail para o canal.
Remover o endereço de email do canal Nenhum Remova o endereço de e-mail do canal.
Remover canal de entrada Nenhum Remova um canal de entrada (um canal compartilhado com uma equipe) de uma equipe.
Listar equipes que compartilham um canal coleção sharedWithChannelTeamInfo Obtenha a lista de equipas que partilham o canal especificado.
Obter equipe compartilhando um canal sharedWithChannelTeamInfo Obtenha uma equipa que partilhe o canal especificado.
Descompartilhar canal com a equipe Nenhum Descompartilhe um canal com uma equipe.
Listar membros permitidos conversationMembercoleção Obtenha a lista de membros da equipe que têm acesso ao canal compartilhado.
Verificar o acesso do usuário Boolean Verifique se um usuário tem acesso a um canal compartilhado ou não.

Propriedades

Propriedade Tipo Descrição
description String Descrição textual opcional do canal.
displayName Cadeia de caracteres Nome do canal tal como aparece ao utilizador no Microsoft Teams. O comprimento máximo é de 50 carateres.
id String O identificador exclusivo do canal. Somente leitura.
isFavoriteByDefault Booliano Indica se o canal deve ser marcado como recomendado para que todos os membros da equipa sejam apresentados na respetiva lista de canais. Nota: Todos os canais recomendados são apresentados automaticamente na lista de canais para utilizadores de educação e trabalhadores de primeira linha. A propriedade só pode ser definida programaticamente através do método Criar equipa . O valor padrão é false.
email Cadeia de caracteres O endereço de email para enviar mensagens ao canal. Somente leitura.
webUrl String Uma hiperligação para o canal no Microsoft Teams. Este URL é fornecido quando clica com o botão direito do rato num canal no Microsoft Teams e seleciona Obter ligação para o canal. Essa URL deve ser tratada como um blob opaco e não analisado. Somente leitura.
membershipType channelMembershipType O tipo do canal. Pode ser definido durante a criação e não pode ser alterado. Os valores possíveis são: standard, private, unknownFutureValue, shared. O valor padrão é standard. Tem de utilizar o cabeçalho do Prefer: include-unknown-enum-members pedido para obter o seguinte valor nesta enumeração evoluível: shared.
createdDateTime dateTimeOffset Somente leitura. Carimbo de data/hora de criação do canal.
moderationSettings channelModerationSettings Configurações para configurar a moderação do canal para controlar quem pode iniciar novas postagens e responder a postagens no canal.
summary channelSummary Contém informações de resumo sobre o canal, incluindo o número de convidados, membros, proprietários e um indicador para membros de outros inquilinos. A propriedade de resumo só é devolvida se aparecer na $select cláusula do método Get channel .
tenantId cadeia de caracteres O ID do inquilino Microsoft Entra.
isArchived Booliano Indica se o canal está arquivado. Somente leitura.

valores channelMembershipType

Member Descrição
padrão O Canal herda a lista de membros do equipe principal.
privado O Canal pode ter membros que são um subconjunto de todos os membros no equipe principal.
unknownFutureValue Valor da sentinela de enumeração evoluível. Não usar.
compartilhado Os membros podem ser adicionados diretamente ao canal sem os adicionar à equipa.

Atributos de instância

Atributos de instância são propriedades com comportamentos especiais. Estas propriedades são temporárias. Definem o comportamento que o serviço deve executar ou fornecem valores de propriedade de curto prazo, como um URL de transferência para um item que expira.

Nome da propriedade Tipo Descrição
@microsoft.graph.channelCreationMode string Indica que o canal está no estado de migração e está sendo usado no momento para fins de migração. Aceita um valor: migration.

Nota: channelCreationMode é uma enumeração que utiliza o valor migration.

Para obter um exemplo de uma solicitação POST, confira Solicitação (criar canal no estado de migração).

Relações

Relação Tipo Descrição
messages chatMessage collection Uma coleção de todas as mensagens do canal. Uma propriedade de navegação. Anulável.
guias teamsTab collection Uma coleção de todas as guias do canal. Uma propriedade de navegação.
membros coleção conversationMember Uma coleção de registros de associação ligados ao canal.
filesFolder driveItem Metadados para o local em que os arquivos do canal estão armazenados.
operations Coleção teamsAsyncOperation As operações assíncronas que foram executadas ou estão em execução nesta equipe.
sharedWithTeams coleção sharedWithChannelTeamInfo Uma coleção de equipes com as quais um canal é compartilhado.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isFavoriteByDefault": true,
  "email": "string",
  "webUrl": "string",
  "membershipType": "String",
  "isArchived": false,
  "createdDateTime": "string (timestamp)",
  "moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}

Conteúdo relacionado