-
Notifications
You must be signed in to change notification settings - Fork 320
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22571 from microsoftgraph/main
Merge to publish.
- Loading branch information
Showing
24 changed files
with
493 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| title: "Delete chat" | ||
| description: "Delete a chat object." | ||
| author: "sthapliyal" | ||
| ms.prod: "microsoft-teams" | ||
| doc_type: apiPageType | ||
| ms.localizationpriority: medium | ||
| --- | ||
|
|
||
| # Delete chat | ||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Soft-delete a [chat](../resources/chat.md). When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins. | ||
|
|
||
| >**Note:** This delete operation is not supported for non-admin users. | ||
| ## Permissions | ||
| One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). | ||
|
|
||
| |Permission type|Permissions (from least to most privileged)| | ||
| |:---|:---| | ||
| |Delegated (work or school account)|Chat.ManageDeletion.All| | ||
| |Delegated (personal Microsoft account)|Not supported.| | ||
| |Application|Chat.ManageDeletion.All| | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| DELETE /chats/{chat-id} | ||
| ``` | ||
|
|
||
| ## Request headers | ||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required.| | ||
|
|
||
| ## Request body | ||
| Do not supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this action returns a `204 No Content` response code. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
|
|
||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "chat_delete", | ||
| "sampleKeys": ["19:7d898072-792c-4006-bb10-5ca9f2590649_8ea0e38b-efb3-4757-924a-5f94061cf8c2@unq.gbl.spaces"] | ||
| } | ||
| --> | ||
| ``` http | ||
| DELETE https://graph.microsoft.com/beta/chats/19:7d898072-792c-4006-bb10-5ca9f2590649_8ea0e38b-efb3-4757-924a-5f94061cf8c2@unq.gbl.spaces | ||
| ``` | ||
| ### Response | ||
|
|
||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 204 No Content | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| --- | ||
| title: "Get deletedChat" | ||
| description: "Read the properties and relationships of a deletedChat object." | ||
| author: "sthapliyal" | ||
| ms.localizationpriority: medium | ||
| ms.prod: "microsoft-teams" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # Get deletedChat | ||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Read the properties and relationships of a [deletedChat](../resources/deletedchat.md) object. | ||
|
|
||
| ## Permissions | ||
| One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). | ||
|
|
||
| |Permission type|Permissions (from least to most privileged)| | ||
| |:---|:---| | ||
| |Delegated (work or school account)|Chat.ManageDeletion.All| | ||
| |Delegated (personal Microsoft account)|Not supported.| | ||
| |Application|Chat.ManageDeletion.All| | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| GET /teamwork/deletedChats/{deleted-chat-id} | ||
| ``` | ||
|
|
||
| ## Optional query parameters | ||
| This method supports some of the OData query parameters to help customize the response. For general information, see [OData query parameters](/graph/query-parameters). | ||
|
|
||
| ## Request headers | ||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required.| | ||
|
|
||
| ## Request body | ||
| Do not supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this method returns a `200 OK` response code and a [deletedChat](../resources/deletedchat.md) object in the response body. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
| The following is an example of a request. | ||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "get_deletedchat", | ||
| "sampleKeys": ["19:64dedcac16b74a209b1f2ecb7f99c5e2@thread.v2"] | ||
| } | ||
| --> | ||
| ``` http | ||
| GET https://graph.microsoft.com/beta/teamwork/deletedChats/19:64dedcac16b74a209b1f2ecb7f99c5e2@thread.v2 | ||
| ``` | ||
|
|
||
|
|
||
| ### Response | ||
| The following is an example of the response | ||
| >**Note:** The response object shown here might be shortened for readability. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true, | ||
| "@odata.type": "microsoft.graph.deletedChat" | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 200 OK | ||
| Content-Type: application/json | ||
| { | ||
| "value": { | ||
| "@odata.type": "#microsoft.graph.deletedChat", | ||
| "id": "19:64dedcac16b74a209b1f2ecb7f99c5e2@thread.v2" | ||
| } | ||
| } | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| title: "deletedChat: undoDelete" | ||
| description: "Restores a deletedChat." | ||
| author: "sthapliyal" | ||
| ms.localizationpriority: medium | ||
| ms.prod: "microsoft-teams" | ||
| doc_type: apiPageType | ||
| --- | ||
|
|
||
| # deletedChat: undoDelete | ||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Restore a [deletedChat](../resources/deletedchat.md) to an active [chat](../resources/chat.md). | ||
|
|
||
| >**Note:** This operation is not supported for non-admin users. | ||
| ## Permissions | ||
| One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). | ||
|
|
||
| |Permission type|Permissions (from least to most privileged)| | ||
| |:---|:---| | ||
| |Delegated (work or school account)|Chat.ManageDeletion.All| | ||
| |Delegated (personal Microsoft account)|Not supported.| | ||
| |Application|Chat.ManageDeletion.All| | ||
|
|
||
| ## HTTP request | ||
|
|
||
| <!-- { | ||
| "blockType": "ignored" | ||
| } | ||
| --> | ||
| ``` http | ||
| POST /teamwork/deletedChats/{deletedChatId}/undoDelete | ||
| ``` | ||
|
|
||
| ## Request headers | ||
| |Name|Description| | ||
| |:---|:---| | ||
| |Authorization|Bearer {token}. Required.| | ||
|
|
||
| ## Request body | ||
| Do not supply a request body for this method. | ||
|
|
||
| ## Response | ||
|
|
||
| If successful, this action returns a `204 No Content` response code. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Request | ||
| The following is an example of a request. | ||
| <!-- { | ||
| "blockType": "request", | ||
| "name": "deletedchat.undodelete", | ||
| "sampleKeys": ["19:64dedcac16b74a209b1f2ecb7f99c5e2@thread.v2"] | ||
| } | ||
| --> | ||
| ``` http | ||
| POST https://graph.microsoft.com/beta/teamwork/deletedChats/19:64dedcac16b74a209b1f2ecb7f99c5e2@thread.v2/undoDelete | ||
| ``` | ||
|
|
||
|
|
||
| ### Response | ||
| The following is an example of the response. | ||
| <!-- { | ||
| "blockType": "response", | ||
| "truncated": true | ||
| } | ||
| --> | ||
| ``` http | ||
| HTTP/1.1 204 No Content | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| --- | ||
| title: "deletedChat resource type" | ||
| description: "Represents a deleted chat in Microsoft Teams." | ||
| author: sthapliyal | ||
| ms.localizationpriority: high | ||
| ms.prod: "microsoft-teams" | ||
| doc_type: resourcePageType | ||
| --- | ||
|
|
||
| # deletedChat resource type | ||
|
|
||
| Namespace: microsoft.graph | ||
|
|
||
| [!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] | ||
|
|
||
| Represents a [chat](../resources/chat.md) that was deleted in Microsoft Teams. | ||
|
|
||
| Inherits from [entity](../resources/entity.md). | ||
|
|
||
| ## Methods | ||
| |Method|Return type|Description| | ||
| |:---|:---|:---| | ||
| |[Get deletedChat](../api/deletedchat-get.md)|[deletedChat](../resources/deletedchat.md)|Read the properties and relationships of a [deletedChat](../resources/deletedchat.md) object.| | ||
| |[undoDelete deletedChat](../api/deletedchat-undodelete.md)|None|Restore a deleted chat as a [chat](../resources/chat.md).| | ||
|
|
||
| ## Properties | ||
| |Property|Type|Description| | ||
| |:---|:---|:---| | ||
| |id|String|The ID of a deleted chat. Inherited from [entity](../resources/entity.md).| | ||
|
|
||
| ## Relationships | ||
| None. | ||
|
|
||
| ## JSON representation | ||
| The following is a JSON representation of the resource. | ||
| <!-- { | ||
| "blockType": "resource", | ||
| "keyProperty": "id", | ||
| "@odata.type": "microsoft.graph.deletedChat", | ||
| "baseType": "microsoft.graph.entity", | ||
| "openType": false | ||
| } | ||
| --> | ||
| ``` json | ||
| { | ||
| "@odata.type": "#microsoft.graph.deletedChat", | ||
| "id": "String (identifier)" | ||
| } | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.