チャネルのリソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph のバージョンの /beta API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを確認するには、 バージョン セレクターを使用します。
チームはチャネルで構成されています。チャネルは、チームのメンバーと会話する場所です。 各チャネルは、特定のトピック、部門、プロジェクト専用です。 チャネルは、実際に作業を行う場所、チーム全体に対してテキスト、音声、ビデオによる会話を公開する場所、ファイルを共有する場所、タブを追加する場所です。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| チャネルを一覧表示する | channel コレクション | チーム内のチャネルの一覧を取得します。 |
| 受信チャネルを一覧表示する | channel コレクション | チーム と共有されている チャネルの一覧を取得します。 |
| すべてのチャネルを一覧表示する | channel コレクション | チーム 内またはこの チーム と共有されている チャネル (受信チャネル) の一覧を取得します。 |
| チャネルを作成する | channel | 表示名と説明を指定して新しいチャネルを作成します。 |
| チャネルを取得する | channel | チャネルのプロパティとリレーションシップを読み取ります。 |
| チャネルを更新する | channel | チャネルのプロパティを更新します。 |
| チャネルを削除する | なし | チャネルを削除します。 |
| メッセージの差分を取得する | chatMessage | チャネルの増分メッセージを取得します。 |
| チャネル メッセージを一覧表示する | chatMessage | チャネルのメッセージを取得します。 |
| 全チャネル メッセージ取得 API が追加されました | channel コレクション | ユーザーが参加しているすべてのチャネルからすべてのメッセージを取得します。 |
| チャネル メッセージの投稿を作成する | chatMessage | メッセージをチャネルに送信します。 |
| チャネル メッセージの投稿への返信を作成する | chatMessage | チャネル内のメッセージに返信します。 |
| ファイル フォルダーを取得する | driveItem | チャネルのファイルが保存されている SharePoint フォルダーの詳細情報を取得します。 |
| タブを一覧表示する | teamsTab | チャネルにピン留めされているタブを一覧表示します。 |
| チャネル メンバーを一覧表示する | conversationMember コレクション | チャネルのメンバーの一覧を取得します。 |
| チャネル メンバーを追加する | conversationMember | チャネルにメンバーを追加します。 membershipType が private またはshared のチャネルのみサポートされます。 |
| チャネル メンバーを取得する | conversationMember コレクション | チャネルのメンバーを取得します。 |
| チャネル メンバーの役割を更新する | conversationMember | チャネルのメンバーのプロパティを更新します。 membershipType が private またはshared のチャネルのみサポートされます。 |
| チャネル メンバーを削除する | なし | チャネルからメンバーを削除します。 membershipType が private またはshared のチャネルのみサポートされます。 |
| Complete migration | channel | チャネルから移行モードを削除し、ユーザーがメッセージを投稿および閲覧できるようにします。 |
| チャネル内のリスト タブ | teamsTab | チャネルにピン留めされているタブを一覧表示します。 |
| チャネルにタブを追加する | teamsTab | チャネルにタブを追加 (pin) します。 |
| チャネルの [取得] タブ | teamsTab | チャネルにピン留めされているタブを読み取ります。 |
| チャネルの [更新] タブ | teamsTab | チャネル内のタブのプロパティを更新します。 |
| チャネルからタブを削除する | なし | チャネルからタブを削除 (ピン留め解除) します。 |
| チャネルのメールアドレスをプロビジョニングする | provisionChannelEmailResult | チャネルのメール アドレスをプロビジョニングします。 |
| チャネルのメールアドレスを削除する | なし | チャネルのメール アドレスを削除します。 |
| 受信チャネルを削除する | なし | 受信チャネルを削除します。 |
| チャネルを共有するチームを一覧表示する | sharedWithChannelTeamInfo コレクション | 指定したチャネルが共有されているチームの一覧を取得します。 |
| チャネルを共有するチームを取得する | sharedWithChannelTeamInfo | 指定したチャネルが共有されているチームを取得します。 |
| チームとのチャネルの共有を解除する | なし | チームとチャネルの共有を解除します。 |
| 許可されているメンバーを一覧表示する | conversationMember コレクション | 共有チャネルにアクセスできるチーム メンバーの一覧を取得します。 |
| ユーザー アクセスを確認する | ブール型 | ユーザーが共有チャネルにアクセスできるかどうかを確認します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| description | String | チャネルの説明テキストです (省略可能)。 |
| displayName | String | Microsoft Teams でユーザーに対して表示されるチャネルの名前。 |
| id | String | チャネルの一意の識別子。読み取り専用です。 |
| isFavoriteByDefault | ブール値 | チームのメンバー全員に対してチャネルを「お気に入り」として自動的にマークするかどうかを示します。 チーム作成を使用して、プログラム設定だけ行えます。 既定値: false。 |
| メール | String | チャネルにメッセージを送信するときのメール アドレス。読み取り専用です。 |
| webUrl | String | Microsoft Teams のチャネルに移動するハイパーリンク。 これは、Microsoft Teams でチャネルを右クリックし、[チームへのリンクを取得] を選択すると作成される URL です。 この URL は不透明 blob として扱われる必要があり、また解析されません。 読み取り専用。 |
| membershipType | channelMembershipType | チャネルの種類。 作成中に設定でき、変更できません。 使用可能な値: standard、private、unknownFutureValue、shared。 既定値は standard です。 この進化可能な列挙型で次の値を取得するには、Prefer: include-unknown-enum-members 要求ヘッダーを使用する必要があることに注意してください: shared。 |
| createdDateTime | dateTimeOffset | 読み取り専用です。チャネルが作成されたときのタイムスタンプ。 |
| moderationSettings | channelModerationSettings | 新しい投稿を開始できるユーザーとそのチャネルの投稿に返信できるユーザーを、そのチャネル内で制御するため、チャネルのモデレーションを構成します。 |
| tenantId | string | Azure Active Directory テナントの ID。 |
インスタンスの属性
インスタンスの属性は、動作が特殊なプロパティです。これらのプロパティは一時的なものであり、a) サービスの動作を定義するか、b) 短期的なプロパティの値 (有効期限を持つアイテムのダウンロード URL など) を提供します。
| プロパティ名 | 種類 | 説明 |
|---|---|---|
| @microsoft.graph.channelCreationMode | string | チャネルが移行の状態にあり、現在移行目的で使用されていることを示します。1 つの値 migration を承認します。 |
注:
channelCreationModeは値migrationを取る列挙型です。
POST リクエストの例については、「リクエスト (移行状態でチャネルを作成する)」をご覧ください。
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| messages | chatMessage コレクション | 会話内のすべての会話スレッドのコレクションです。ナビゲーション プロパティです。Null 許容型。 |
| tabs | teamsTab コレクション | チャネル内のすべてのタブのコレクションです。ナビゲーション プロパティです。 |
| members | conversationMember コレクション | チャネルに関連付けられているメンバーシップ レコードのコレクション。 |
| filesFolder | driveItem | チャネルのファイルが保存されている場所のメタデータ。 |
| 操作 | teamsAsyncOperation コレクション | このチームで実行済みまたは実行中の非同期操作です。 |
| sharedWithTeams | sharedWithChannelTeamInfo コレクション | チャネルが共有されているチームのコレクション。 |
JSON 表記
リソースの JSON 表記を次に示します。
{
"description": "string",
"displayName": "string",
"id": "string (identifier)",
"isFavoriteByDefault": true,
"email": "string",
"webUrl": "string",
"membershipType": "channelMembershipType",
"createdDateTime": "string (timestamp)",
"moderationSettings": { "@odata.type": "microsoft.graph.channelModerationSettings" }
}
フィードバック
フィードバックの送信と表示