channel resource type

مقالة
10/01/2021
قراءة خلال 3 دقائق

Namespace: microsoft.graph

Teams are made up of channels, which are the conversations you have with your teammates. Each channel is dedicated to a specific topic, department, or project. Channels are where the work actually gets done - where text, audio, and video conversations open to the whole team happen, where files are shared, and where tabs are added.

Methods

Method	Return Type	Description
List channels	channel collection	Get the list of channels in this team.
Create channel	channel	Create a new channel by including the display name and description.
Get channel	channel	Read properties and relationships of the channel.
Update channel	channel	Update properties of the channel.
Delete channel	None	Delete a channel.
Get message delta	chatMessage	Get incremental messages in a channel.
List channel messages	chatMessage	Get messages in a channel
Get all channel messages	channel collection	Get all messages from all channels that a user is a participant in.
Create channel message post	chatMessage	Send a message to a channel.
Create reply to channel message post	chatMessage	Reply to a message in a channel.
Get files folder	driveItem	Retrieves the details of the SharePoint folder where the files for the channel are stored.
List tabs	teamsTab	Lists tabs pinned to a channel.
List channel members	conversationMember collection	Get the list of members in a channel.
Add channel member	conversationMember	Add a member to a channel. Only supported for `channel` with membershipType of `private`.
Get channel member	conversationMember collection	Get a member in a channel.
Update channel member's role	conversationMember	Update the properties of a member of the channel. Only supported for channel with membershipType of `private`.
Remove channel member	None	Delete a member from a channel. Only supported for `channelType` of `private`.
Complete migration	channel	Removes the migration mode from the channel and makes the channel available to users to post and read messages.
List tabs in channel	teamsTab	List tabs pinned to a channel.
Add tab to channel	teamsTab	Add (pin) a tab to a channel.
Get tab in channel	teamsTab	Get a specific tab pinned to a channel.
Update tab in channel	teamsTab	Updates the properties of a tab in a channel.
Remove tab from channel	None	Remove (unpin) a tab from a channel.
Provision channel email address	provisionChannelEmailResult	Provision an email address for the channel.
Remove channel email address	None	Remove the email address of the channel.

Properties

Property	Type	Description
description	String	Optional textual description for the channel.
displayName	String	Channel name as it will appear to the user in Microsoft Teams.
id	String	The channel's unique identifier. Read-only.
isFavoriteByDefault	Boolean	Indicates whether the channel should automatically be marked 'favorite' for all members of the team. Can only be set programmatically with Create team. Default: `false`.
email	String	The email address for sending messages to the channel. Read-only.
webUrl	String	A hyperlink that will go to the channel in Microsoft Teams. This is the URL that you get when you right-click a channel in Microsoft Teams and select Get link to channel. This URL should be treated as an opaque blob, and not parsed. Read-only.
membershipType	channelMembershipType	The type of the channel. Can be set during creation and can't be changed. Possible values are: `standard` - Channel inherits the list of members of the parent team; `private` - Channel can have members that are a subset of all the members on the parent team.
createdDateTime	dateTimeOffset	Read only. Timestamp at which the channel was created.

Instance attributes

Instance attributes are properties with special behaviors. These properties are temporary and either a) define behavior the service should perform or b) provide short-term property values, like a download URL for an item that expires.

Property name	Type	Description
@microsoft.graph.channelCreationMode	string	Indicates that the channel is in migration state and is currently being used for migration purposes. It accepts one value: `migration`.

Note: channelCreationMode is an enum that takes the value migration.

For a POST request example, see Request (create channel in migration state).

Relationships

Relationship	Type	Description
messages	chatMessage collection	A collection of all the messages in the channel. A navigation property. Nullable.
tabs	teamsTab collection	A collection of all the tabs in the channel. A navigation property.
members	conversationMember collection	A collection of membership records associated with the channel.
filesFolder	driveItem	Metadata for the location where the channel's files are stored.
operations	teamsAsyncOperation collection	The async operations that ran or are running on this team.

JSON representation

The following is a JSON representation of the resource.

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "isFavoriteByDefault": true,
  "email": "string",
  "webUrl": "string",
  "membershipType": "channelMembershipType",
  "createdDateTime": "string (timestamp)"
}