presence: setUserPreferredPresence

[アーティクル]
03/26/2023

名前空間: microsoft.graph

重要

Microsoft Graph のバージョンの /beta API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 API が v1.0 で使用できるかどうかを判断するには、 バージョン セレクターを使用します。

ユーザーの優先可用性とアクティビティの状態を設定します。ユーザーの優先プレゼンスが設定されている場合は、ユーザーのプレゼンスが優先プレゼンスになります。

優先プレゼンスは、ユーザーのプレゼンスセッションが少なくとも 1 つ存在する場合にのみ有効になります。それ以外の場合、ユーザーのプレゼンスはオフラインのままです。

プレゼンスセッションは、 setPresence 操作が成功した結果、またはユーザーが Teams クライアントにサインインした場合に作成できます。

プレゼンスセッションとそのタイムアウトと有効期限について詳しくは、こちらをご覧ください。

アクセス許可

API を呼び出すには、次のアクセス許可が必要です。アクセス許可の選択方法などの詳細については、「アクセス許可」を参照してください。

アクセス許可の種類	アクセス許可 (特権の小さいものから大きいものへ)
委任 (職場または学校のアカウント)	Presence.ReadWrite
委任 (個人用 Microsoft アカウント)	サポートされていません。
アプリケーション	Presence.ReadWrite.All

HTTP 要求

POST /users/{userId}/presence/setUserPreferredPresence

要求ヘッダー

名前	説明
Authorization	ベアラー {token}。必須です。
Content-Type	application/json. 必須です。

要求本文

要求本文で、次のパラメーターを含む JSON オブジェクトを指定します。

パラメーター	型	説明
availability	文字列	ベースプレゼンス情報。
アクティビティ	文字列	可用性に関する補足情報。
expirationDuration	duration	アプリプレゼンスセッションの有効期限。値は ISO 8601 形式で表示されます。指定しない場合は、既定の有効期限が適用されます。 DoNotDisturb または Busy: 1 日で期限切れその他: 7 日で有効期限が切れます

可用性とアクティビティのサポートされる組み合わせは次のとおりです。

availability	アクティビティ	説明
使用可能	使用可能	ユーザーの優先プレゼンスを [使用可能] に設定します。
多忙	多忙	ユーザー優先プレゼンスを [ビジー] に設定します。
DoNotDisturb	DoNotDisturb	ユーザー優先プレゼンスを DoNotDisturb に設定します。
BeRightBack	BeRightBack	ユーザー優先プレゼンスを BeRightBack に設定します。
離れて	離れて	ユーザーの優先プレゼンスを [退席] に設定します。
オフライン	OffWork	ユーザー優先プレゼンスを [オフライン] に設定します。

応答

成功した場合、このメソッドは 200 OK 応答コードを返します。

例

次の要求では、ユーザーの優先プレゼンスが DoNotDisturb for user fa8bf3dc-eca7-46b7-bad1-db199b62afc3に設定され、有効期限は 8 時間です。

要求

POST https://graph.microsoft.com/beta/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence
Content-Type: application/json

{
  "availability": "DoNotDisturb",
  "activity": "DoNotDisturb",
  "expirationDuration": "PT8H"
}


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Users.Item.Presence.SetUserPreferredPresence.SetUserPreferredPresencePostRequestBody
{
	Availability = "DoNotDisturb",
	Activity = "DoNotDisturb",
	ExpirationDuration = TimeSpan.Parse("PT8H"),
};
await graphClient.Users["{user-id}"].Presence.SetUserPreferredPresence.PostAsync(requestBody);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用できるすべての種類、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/Users/Item/Presence/SetUserPreferredPresence"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewSetUserPreferredPresencePostRequestBody()
availability := "DoNotDisturb"
requestBody.SetAvailability(&availability) 
activity := "DoNotDisturb"
requestBody.SetActivity(&activity) 
expirationDuration , err := abstractions.ParseISODuration("PT8H")
requestBody.SetExpirationDuration(&expirationDuration) 

graphClient.Users().ByUserId("user-id").Presence().SetUserPreferredPresence().Post(context.Background(), requestBody, nil)

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

String availability = "DoNotDisturb";

String activity = "DoNotDisturb";

Duration expirationDuration = DatatypeFactory.newInstance().newDuration("PT8H");

graphClient.users("fa8bf3dc-eca7-46b7-bad1-db199b62afc3").presence()
	.setUserPreferredPresence(PresenceSetUserPreferredPresenceParameterSet
		.newBuilder()
		.withAvailability(availability)
		.withActivity(activity)
		.withExpirationDuration(expirationDuration)
		.build())
	.buildRequest()
	.post();

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


const options = {
	authProvider,
};

const client = Client.init(options);

const setUserPreferredPresence = {
  availability: 'DoNotDisturb',
  activity: 'DoNotDisturb',
  expirationDuration: 'PT8H'
};

await client.api('/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence')
	.version('beta')
	.post(setUserPreferredPresence);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new SetUserPreferredPresencePostRequestBody();
$requestBody->setAvailability('DoNotDisturb');

$requestBody->setActivity('DoNotDisturb');

$requestBody->setExpirationDuration(new \DateInterval('PT8H'));



$graphServiceClient->users()->byUserId('user-id')->presence()->setUserPreferredPresence()->post($requestBody);

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。


Import-Module Microsoft.Graph.Users.Actions

$params = @{
	availability = "DoNotDisturb"
	activity = "DoNotDisturb"
	expirationDuration = "PT8H"
}

Set-MgUserPresenceUserPreferredPresence -UserId $userId -BodyParameter $params

重要

SDK をプロジェクトに追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。

応答

HTTP/1.1 200 OK

presence: setUserPreferredPresence

アクセス許可

HTTP 要求

要求ヘッダー

要求本文

応答

例

要求

応答

その他のリソース

その他のリソース