Tipo de recurso de usuário
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 de 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. |
| Update channel | channel | Atualize as propriedades do canal. |
| Delete channel | Nenhum | Exclua um canal. |
| Obter o delta de mensagem | chatMessage | Obtenha mensagens incrementais em um canal. |
| Listar mensagens do canal | 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. |
| 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. |
| 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. |
| Listar equipes que compartilham um canal | coleção sharedWithChannelTeamInfo | Obtenha a lista de equipes que foram compartilhadas no canal especificado. |
| Obter equipe compartilhando um canal | sharedWithChannelTeamInfo | Obtenha uma equipe que tenha sido compartilhada com 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 | String | Nome do canal como ele aparecerá ao usuário no Microsoft Teams. |
| id | Cadeia de caracteres | O identificador exclusivo do canal. Somente leitura. |
| isFavoriteByDefault | Booliano | Indica se o canal deve automaticamente ser marcado como “favorito” para todos os membros da equipe. Só pode ser definida por programação com Criar equipe. Padrão: false. |
| Cadeia de caracteres | O endereço de email para enviar mensagens ao canal. Somente leitura. | |
| webUrl | String | Um hiperlink que navegará até o canal no Microsoft Teams. Essa é a URL que você recebe ao clicar com o botão direito do mouse em um canal Microsoft Teams e selecionar Obter o link 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. Observe que você deve usar o cabeçalho de Prefer: include-unknown-enum-members solicitação para obter o seguinte valor nessa enumeração evolutiva: shared. |
| createdDateTime | dateTimeOffset | Somente leitura. Carimbo de data/hora da 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. |
| tenantId | cadeia de caracteres | A ID do locatário do Azure Active Directory. |
Atributos de instância
Atributos de instância são propriedades com comportamentos especiais. Essas propriedades são temporárias e a) definem o comportamento que o serviço deve apresentar ou b) fornecem valores de propriedades de curto prazo, como uma URL de download, para um item com data de expiração.
| Nome da propriedade | Tipo | Descrição |
|---|---|---|
| @microsoft.graph.channelCreationMode | string | Indica que o canal está em estado de migração e está sendo usado atualmente para fins de migração. Aceita um valor: migration. |
Observação:
channelCreationModeé um enum que usa o valormigration.
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 no canal. Uma propriedade de navegação. Anulável. |
| guias | teamsTab collection | Uma coleção de todas as guias no canal. Uma propriedade de navegação. |
| members | 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
Veja a seguir uma representação JSON do recurso.
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"isFavoriteByDefault": true,
"email": "string",
"webUrl": "string",
"membershipType": "channelMembershipType",
"createdDateTime": "string (timestamp)",
"moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}
Comentários
Enviar e exibir comentários de