命名空间:microsoft.graph
重要
Microsoft Graph /beta
版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
隐藏用户的 聊天 。
注意: 如果在聊天级别执行“ 发送消息” 等操作,则会自动取消隐藏用户的聊天。
此 API 可用于以下国家级云部署。
全局服务 |
美国政府 L4 |
美国政府 L5 (DOD) |
由世纪互联运营的中国 |
✅ |
✅ |
✅ |
✅ |
权限
为此 API 选择标记为最低特权的权限。
只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 |
最低特权权限 |
更高特权权限 |
委派(工作或学校帐户) |
Chat.ReadWrite |
不可用。 |
委派(个人 Microsoft 帐户) |
不支持。 |
不支持。 |
应用程序 |
不支持。 |
不支持。 |
HTTP 请求
POST /chats/{chatsId}/hideForUser
名称 |
说明 |
Authorization |
持有者 {token}。 必填。 详细了解 身份验证和授权。 |
Content-Type |
application/json. 必需。 |
请求正文
在请求正文中,提供参数的 JSON 表示形式。
下表显示了可用于此操作的参数。
响应
如果成功,此操作返回 204 No Content
响应代码。
示例
请求
POST https://graph.microsoft.com/beta/chats/19:7d898072-792c-4006-bb10-5ca9f2590649_8ea0e38b-efb3-4757-924a-5f94061cf8c2@unq.gbl.spaces/hideForUser
Content-Type: application/json
{
"user": {
"id" : "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2",
"tenantId": "2a690434-97d9-4eed-83a6-f5f13600199a"
}
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Chats.Item.HideForUser;
using Microsoft.Graph.Beta.Models;
var requestBody = new HideForUserPostRequestBody
{
User = new TeamworkUserIdentity
{
Id = "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2",
AdditionalData = new Dictionary<string, object>
{
{
"tenantId" , "2a690434-97d9-4eed-83a6-f5f13600199a"
},
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Chats["{chat-id}"].HideForUser.PostAsync(requestBody);
mgc-beta chats hide-for-user post --chat-id {chat-id} --body '{\
"user": {\
"id" : "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2",\
"tenantId": "2a690434-97d9-4eed-83a6-f5f13600199a"\
}\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphchats "github.com/microsoftgraph/msgraph-beta-sdk-go/chats"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphchats.NewHideForUserPostRequestBody()
user := graphmodels.NewTeamworkUserIdentity()
id := "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2"
user.SetId(&id)
additionalData := map[string]interface{}{
"tenantId" : "2a690434-97d9-4eed-83a6-f5f13600199a",
}
user.SetAdditionalData(additionalData)
requestBody.SetUser(user)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Chats().ByChatId("chat-id").HideForUser().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.chats.item.hideforuser.HideForUserPostRequestBody hideForUserPostRequestBody = new com.microsoft.graph.beta.chats.item.hideforuser.HideForUserPostRequestBody();
TeamworkUserIdentity user = new TeamworkUserIdentity();
user.setId("d864e79f-a516-4d0f-9fee-0eeb4d61fdc2");
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("tenantId", "2a690434-97d9-4eed-83a6-f5f13600199a");
user.setAdditionalData(additionalData);
hideForUserPostRequestBody.setUser(user);
graphClient.chats().byChatId("{chat-id}").hideForUser().post(hideForUserPostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const hideForUser = {
user: {
id: 'd864e79f-a516-4d0f-9fee-0eeb4d61fdc2',
tenantId: '2a690434-97d9-4eed-83a6-f5f13600199a'
}
};
await client.api('/chats/19:7d898072-792c-4006-bb10-5ca9f2590649_8ea0e38b-efb3-4757-924a-5f94061cf8c2@unq.gbl.spaces/hideForUser')
.version('beta')
.post(hideForUser);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Chats\Item\HideForUser\HideForUserPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\TeamworkUserIdentity;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new HideForUserPostRequestBody();
$user = new TeamworkUserIdentity();
$user->setId('d864e79f-a516-4d0f-9fee-0eeb4d61fdc2');
$additionalData = [
'tenantId' => '2a690434-97d9-4eed-83a6-f5f13600199a',
];
$user->setAdditionalData($additionalData);
$requestBody->setUser($user);
$graphServiceClient->chats()->byChatId('chat-id')->hideForUser()->post($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Teams
$params = @{
user = @{
id = "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2"
tenantId = "2a690434-97d9-4eed-83a6-f5f13600199a"
}
}
Hide-MgBetaChatForUser -ChatId $chatId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.chats.item.hide_for_user.hide_for_user_post_request_body import HideForUserPostRequestBody
from msgraph_beta.generated.models.teamwork_user_identity import TeamworkUserIdentity
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = HideForUserPostRequestBody(
user = TeamworkUserIdentity(
id = "d864e79f-a516-4d0f-9fee-0eeb4d61fdc2",
additional_data = {
"tenant_id" : "2a690434-97d9-4eed-83a6-f5f13600199a",
}
),
)
await graph_client.chats.by_chat_id('chat-id').hide_for_user.post(request_body)
响应
HTTP/1.1 204 No Content