名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
チャット、チャネル、会議をカスタムグループまたはシステム定義グループに整理する、ユーザーのMicrosoft Teamsチャット リスト内のセクションを表します。 セクションはユーザー定義で、ユーザーが作成、名前の変更、削除を行えるようにすることも、サービスによって管理されるシステム定義でもかまいません。
メソッド
| メソッド | 戻り値の種類 | 説明 |
|---|---|---|
| List | teamworkSection コレクション | ユーザーのチームワークのセクションの一覧を取得します。 |
| Create | teamworkSection | ユーザーのチームワークで新しいセクションを作成します。 |
| Get | teamworkSection | ユーザーのチームワークでセクションのプロパティを読み取る。 |
| Update | teamworkSection | ユーザーのチームワークのセクションのプロパティを更新します。 |
| Delete | なし | ユーザーのチームワークからユーザー定義セクションを削除します。 |
| リスト アイテム | 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 値は予約されており、ユーザー定義セクションには使用できません。
| displayName | 説明 |
|---|---|
| RecentChats | 既定のチャット セクション。 |
| QuickViews | [クイック ビュー] セクション。 |
| TeamsAndChannels | [チームとチャネル] セクション。 |
| MutedChats | ミュートされたチャット セクション。 |
| MeetingChats | [会議チャット] セクション。 |
| EngageCommunities | [コミュニティ] セクション。 |
システム定義セクションは削除できません。 また、sortType プロパティのみを更新できます。 他のプロパティを更新するか、システム定義セクションを削除しようとすると、 403 Forbiddenが返されます。 システム定義セクションの 項目 の一覧表示はサポートされておらず、 400 Bad Requestを返します。
sectionSortType 値
| メンバー | 説明 |
|---|---|
| mostRecent | 最新のアクティビティで項目を並べ替えます。 ユーザー定義セクションとほとんどのシステム定義セクションに対して有効です。 |
| unreadThenMostRecent | 最初に未読アイテムを並べ替え、次に最新のアクティビティで並べ替えます。 ユーザー定義セクションとほとんどのシステム定義セクションに対して有効です。 |
| nameAlphabetical | 名前で項目をアルファベット順に並べ替えます。 Teams やチャネルなど、特定のシステム定義セクションに対してのみ有効です。 ユーザー定義セクションでは無効です。 |
| userDefinedCustomOrder | ユーザー定義のカスタム順序に従って項目を並べ替えます。 ユーザー定義セクションに対してのみ有効です。 これは、新しいユーザー定義セクションの既定の並べ替えの種類です。 |
| unknownFutureValue | 進化可能な列挙センチネル値。 使用しないでください。 |
注:
システム定義セクションの有効な並べ替えの種類は、特定のセクションによって異なります。 たとえば、[ Teams と チャネル ] セクションでは nameAlphabeticalがサポートされていますが、[ RecentChats] セクションと [MutedChats ] セクションでは mostRecent と unreadThenMostRecentのみがサポートされます。 プロパティ isHierarchicalViewEnabled が Teams とチャネル セクションの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"
}