名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
チャット、チャネル、会議をカスタム グループまたはシステム定義のグループに整理する、ユーザーの Microsoft Teams チャット リスト内のセクションを表します。 セクションは、ユーザー定義 (ユーザーが作成、名前変更、削除を許可する) することも、システム定義 (サービスによって管理) することもできます。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | teamworkSection コレクション | ユーザーのチームワークのセクションの一覧を取得します。 |
| Create | teamworkSection | ユーザーのチームワークに新しいセクションを作成します。 |
| Get | teamworkSection | ユーザーのチームワークのセクションのプロパティを読み取る。 |
| Update | teamworkSection | ユーザーのチームワークのセクションのプロパティを更新する。 |
| Delete | なし | ユーザーのチームワークからユーザー定義セクションを削除する。 |
| 並べ替え | teamworkSection コレクション | ユーザーのチームワークのすべてのセクションを並べ替えます。 |
| リスト アイテム | teamworkSectionItem コレクション | ユーザーのチームワークのセクション内の項目の一覧を取得します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| createdDateTime | DateTimeOffset | セクションが作成された日時。 読み取り専用です。 タイムスタンプの種類は、ISO 8601 形式を使用して、常に UTC 形式の日付と時刻情報を表します。 たとえば、2024 年 1 月 1 日の午前 0 時 UTC は 2024-01-01T00:00:00Z です。 |
| displayIcon | sectionDisplayIcon | セクションに表示されるアイコン。 |
| displayName | 文字列 | セクションの表示名。 必須です。 最大長は 50 文字です。 表示名は大文字と小文字が区別され、ユーザーのセクション内で一意である必要があります。
RecentChats、QuickViews、TeamsAndChannels、MutedChats、MeetingChats、EngageCommunities という名前は、システム定義セクション用に予約されており、ユーザー定義セクションの作成時には使用できません。 |
| id | 文字列 | セクションの一意識別子。 読み取り専用です。 |
| isExpanded | ブール型 | セクションがユーザー インターフェイスで展開されているかどうかを示します。 既定値は true です。 |
| isHierarchicalViewEnabled | ブール型 | セクションで階層ビューが有効かどうかを示します。 読み取り専用です。 |
| lastModifiedDateTime | DateTimeOffset | セクションが最後に変更された日時。 読み取り専用です。 タイムスタンプの種類は、ISO 8601 形式を使用して、常に UTC 形式の日付と時刻情報を表します。 たとえば、2024 年 1 月 1 日の午前 0 時 UTC は 2024-01-01T00:00:00Z です。 |
| sectionType | sectionType | セクションの種類。 使用可能な値: userDefined、systemDefined、unknownFutureValue。 読み取り専用です。 |
| sortType | sectionSortType | セクション内のアイテムの並べ替え順序。 有効な値は、 sectionType によって異なります。 使用可能な値: mostRecent、unreadThenMostRecent、nameAlphabetical、userDefinedCustomOrder、unknownFutureValue。 |
sectionType 値
| メンバー | 説明 |
|---|---|
| userDefined | ユーザーが作成したセクション。名前の変更、並べ替え、削除が可能です。 |
| systemDefined | サービスによって管理される、削除できないセクション。 sortType プロパティのみを更新できます。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
システム定義セクション
システム定義セクションは、サービスによってプロビジョニングされ、すべてのユーザーのセクション リストに表示されます。 表示名の値は予約済みであり、ユーザー定義セクションには使用できません。
| displayName | 説明 |
|---|---|
| RecentChats | 既定のチャット セクション。 |
| クイック ビュー | [クイック ビュー] セクション。 |
| TeamsAndChannels | [チームとチャネル] セクション。 |
| MutedChats | ミュートされたチャット セクション。 |
| MeetingChats | [会議チャット] セクション。 |
| EngageCommunities | コミュニティ セクション。 |
システム定義セクションは削除できません。また、 sortType プロパティのみを更新できます。 他のプロパティを更新しようとするか、システム定義セクションを削除しようとすると、 403 Forbiddenが返されます。
List items を呼び出してシステム定義セクションにアイテムを一覧表示することはサポートされておらず、400 Bad Request が返されます。
List sections または Get teamworkSection のいずれかが ?$expand=items で呼び出されると、システム定義のセクションの内容はパブリック Graph APIで公開されないため、システム定義のセクションは空の項目配列で返されます。
sectionSortType 値
| メンバー | 説明 |
|---|---|
| mostRecent | 最近のアクティビティでアイテムを並べ替えます。 ユーザー定義セクションおよびほとんどのシステム定義セクションに有効です。 |
| unreadThenMostRecent | 未読のアイテムを最初に並べ替え、次に最新のアクティビティで並べ替えます。 ユーザー定義セクションおよびほとんどのシステム定義セクションに有効です。 |
| 名前アルファベット順 | アイテムを名前のアルファベット順に並べ替えます。 チームやチャネルなどの特定のシステム定義セクションでのみ有効です。 ユーザー定義セクションには無効です。 |
| userDefinedCustomOrder | ユーザー定義のカスタム順序に従ってアイテムを並べ替えます。 ユーザー定義セクションに対してのみ有効です。 これは、新しいユーザー定義セクションの既定の並べ替えの種類です。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
注:
システム定義セクションの有効な並べ替えの種類は、セクションごとに異なります。 たとえば、[ Teams ] セクションと [チャネル] セクションでは nameAlphabetical がサポートされますが、 RecentChats セクションと MutedChats セクションでは mostRecent と unreadThenMostRecent のみがサポートされます。 プロパティ isHierarchicalViewEnabled が [チームとチャネル] セクションのtrueに設定されている場合、nameAlphabeticalのみが有効です。 サポートされていない並べ替えの種類を設定すると、 400 Bad Request エラーが返されます。
インスタンスの属性
インスタンスの属性は、動作が特殊なプロパティです。 これらのプロパティは一時的なものであり、a) サービスの動作を定義するか、b) 短期的なプロパティの値 (有効期限を持つアイテムのダウンロード URL など) を提供します。
| プロパティ名 | 種類 | 説明 |
|---|---|---|
| @microsoft.graph.sectionsOrder | String collection | ユーザーが優先するセクションの順序を表すセクション ID の順序付き配列。 |
| @microsoft.graph.sectionsVersion | 文字列 | 現在のセクション階層バージョン。 この値は、ミューテーション操作 (セクションの作成、更新、削除、または並べ替え、アイテムの追加、削除、移動、または並べ替え) でのオプティミスティック同時実行制御の If-Match ヘッダーとして使用します。 |
リレーションシップ
| リレーションシップ | 型 | 説明 |
|---|---|---|
| items | teamworkSectionItem コレクション | セクション内に整理されたアイテム (チャット、チャネル、会議、またはコミュニティ)。 |
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.teamworkSection",
"createdDateTime": "String (timestamp)",
"displayIcon": {"@odata.type": "microsoft.graph.sectionDisplayIcon"},
"displayName": "String",
"id": "String (identifier)",
"isExpanded": "Boolean",
"isHierarchicalViewEnabled": "Boolean",
"lastModifiedDateTime": "String (timestamp)",
"sectionType": "String",
"sortType": "String"
}