Type de ressource channel

  • Article
  • 6 minutes de lecture

Espace de noms: microsoft.graph

Importante

Les API sous la /beta version dans Microsoft Graph sont susceptibles de changer. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans la version 1.0, utilisez le sélecteur de version .

Les équipes sont constituées de canaux qui sont les conversations que vous avez avec vos collègues. Chaque canal est dédié à un sujet, département ou projet spécifiques. Les canaux sont l’endroit où le travail est réellement effectué, où se déroulent les conversation à l’aide de texte, d’audio et de vidéo ouvertes à toute l’équipe, où les fichiers sont partagés et où des onglets sont ajoutés.

Méthodes

Méthode Type renvoyé Description
Répertorier les canaux collection channel Obtenez la liste des canaux d’une équipe.
Répertorier les canaux entrants collection channel Obtenez la liste des canaux entrants partagés avec une équipe.
Répertorier tous les canaux collection channel Obtenez la liste des canaux dans une équipe ou partagés avec une équipe (canaux entrants).
Créer un canal channel Créer un canal en incluant le nom d’affichage et la description.
Obtenir le canal channel Lit les propriétés et relations de l’objet channel.
Mettre à jour le canal channel Mettre à jour les propriétés du canal.
Supprimer un canal Aucun Supprimer un canal.
Obtenir la fonction message delta chatMessage Recevez des messages incrémentiels dans un canal.
Lister les messages du canal chatMessage Récupérer les messages d’un canal
Ajout de l’API de recherche de tous les messages de canal collection channel Obtenir tous les messages de tous les canaux auxquels un utilisateur participe.
Créer une publication de message de canal chatMessage Envoyer un message à un canal.
Créer une réponse à une publication de message de canal chatMessage Répondre à un message dans un canal.
Récupérer le dossier de fichiers driveItem Récupère les détails du dossier SharePoint dans lequel sont stockés les fichiers pour le canal.
Répertorier les onglets teamsTab Répertorie les onglets épinglé à un canal.
Lister les membres du canal Collection conversationMember Obtenir la liste des membres d’un canal.
Ajouter un membre au canal conversationMember Ajouter un membre à un canal. Uniquement pris en charge pour les canaux avec un membershipType de private ou shared.
Récupérer un membre du canal Collection conversationMember Récupérer un membre d’un canal.
Mise à jour du rôle d’un membre de canal conversationMember Mise à jour des propriétés d’un membre de canal. Uniquement pris en charge pour les canaux avec un membershipType de private ou shared.
Supprimer un membre d’un canal Aucune Supprimer un membre d’un canal. Uniquement pris en charge pour les canaux avec un membershipType de private ou shared.
Finaliser la migration canal Supprime le mode migration du canal, puis met le canal à la disposition des utilisateurs pour leur permettre de publier et de lire les messages.
Répertorier des onglets dans un canal teamsTab Répertorier les onglets épinglés à un canal.
Ajouter l’onglet au canal teamsTab Ajouter (épingler) un onglet à un canal.
Obtenir un onglet dans un canal teamsTab Obtenir un onglet spécifique épinglé à un canal.
Mettre à jour un onglet dans le canal teamsTab Met à jour les propriétés d’un onglet dans un canal.
Supprimer un onglet du canal Aucune Supprimer (désépingler) un onglet d’un canal.
Provisionner l’adresse e-mail du canal provisionChannelEmailResult Approvisionnement d’une adresse de messagerie pour le canal.
Supprimer l’adresse e-mail du canal Aucun Supprimez l’adresse e-mail du canal.
Supprimer un canal entrant Aucun Supprimez un canal entrant ( canal partagé avec une équipe) d’une équipe.
Répertorier les équipes partageant un canal Collection sharedWithChannelTeamInfo Obtenez la liste des équipes qui ont été partagées sur le canal spécifié.
Obtenir le partage d’équipe d’un canal sharedWithChannelTeamInfo Obtenez une équipe qui a partagé le canal spécifié.
Annuler le partage du canal avec l’équipe Aucun Annulez le partage d’un canal avec une équipe.
Répertorier les membres autorisés Collection conversationMember Obtenez la liste des membres de l’équipe qui ont accès au canal partagé.
Vérifier l’accès des utilisateurs Boolean Vérifiez si un utilisateur a accès ou non à un canal partagé.

Propriétés

Propriété Type Description
description Chaîne Description textuelle facultative pour le canal.
displayName Chaîne Le nom du canal tel qu’il apparaîtra à l’utilisateur dans Microsoft Teams. La longueur maximale est de 50 caractères.
id Chaîne Identificateur unique du canal. En lecture seule.
isFavoriteByDefault Valeur booléenne Indique si le canal doit être automatiquement marqué comme « favori » pour tous les membres de l’équipe. Ne peut être fixé de manière programmatique qu'avec Créer une équipe. La valeur par défaut est false.
email Chaîne L’adresse de messagerie pour l’envoi de messages au canal. En lecture seule.
webUrl String Un lien hypertexte qui vous redirige vers le canal dans Microsoft Teams. Il s’agit de l’URL que vous obtenez quand vous cliquez sur un canal dans le client Microsoft Teams et sélectionnez Récupérer le lien du canal. Cette URL doit être traitée comme un blob opaque et ne doit pas être analysée. En lecture seule.
membershipType channelMembershipType Type du canal. Peut être défini lors de la création et ne peut pas être modifié. Les valeurs possibles sont : standard, private, unknownFutureValue, shared. La valeur par défaut est standard. Notez que vous devez utiliser l’en-tête de requête Prefer: include-unknown-enum-members pour obtenir la valeur suivante dans cette evolvable enum : shared.
createdDateTime dateTimeOffset En lecture seule. Horodateur auquel le canal a été créé.
moderationSettings channelModerationSettings Paramètres de configuration de modération des canaux afin de contrôler qui peut lancer de nouvelles publications et répondre aux publications de ce canal.
tenantId chaîne ID du client Azure Active Directory.

Valeurs channelMembershipType

Member Description
standard Channel hérite de la liste des membres de l’équipe parente.
Privé Le canal peut avoir des membres qui sont un sous-ensemble de tous les membres de l’équipe parente.
unknownFutureValue Valeur sentinel de l’énumération évolutive. Ne pas utiliser.
partagé Les membres peuvent être ajoutés directement au canal sans les ajouter à l’équipe.

Attributs d’instance

Les attributs d’instance sont des propriétés avec des comportements spéciaux. Ces propriétés sont provisoires et, a) définissent le comportement que le service doit adopter, ou b) fournissent des valeurs à court terme, comme une URL de téléchargement pour un élément qui arrive à expiration.

Nom de la propriété Type Description
@microsoft.graph.channelCreationMode string Indique que le canal est à l’état de la migration et est actuellement utilisé à des fins de migration. Elle accepte une valeur : migration.

Remarque : channelCreationMode est un enum qui prend la valeur migration.

Pour consulter un exemple de demande POST, voir Demande (Créer canal en état de migration).

Relations

Relation Type Description
messages collectionchatMessage Une collection de tous les messages dans le canal. Propriété de navigation. Pouvant accepter la valeur Null.
onglets Collection teamsTab Une collection de tous les onglets dans le canal. Propriété de navigation.
members Collection conversationMember Collection des enregistrements d’appartenance associés au canal.
filesFolder driveItem Métadonnées de l’emplacement de stockage des fichiers du canal.
opérations Collection teamsAsyncOperation Opérations asynchrone ayant été exécutées ou en cours d’exécution sur cette équipe.
sharedWithTeams Collection sharedWithChannelTeamInfo Collection d’équipes avec lesquelles un canal est partagé.

Représentation JSON

Voici une représentation JSON de la ressource.

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

Voir aussi