presence: setUserPreferredPresence

[アーティクル]
02/03/2022

名前空間: microsoft.graph

重要

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

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

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

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

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

アクセス許可

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

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

HTTP 要求

POST /users/{userId}/presence/setUserPreferredPresence

要求ヘッダー

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

要求本文

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

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

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

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

応答

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

例

次の要求は、ユーザーの優先プレゼンスをユーザーの DoNotDisturb 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"
}


GraphServiceClient graphClient = new GraphServiceClient( authProvider );

var availability = "DoNotDisturb";

var activity = "DoNotDisturb";

var expirationDuration = new Duration("PT8H");

await graphClient.Users["{user-id}"].Presence
    .SetUserPreferredPresence(availability,activity,expirationDuration)
    .Request()
    .PostAsync();

重要

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

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 のドキュメントを参照してください。


MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider];

NSString *MSGraphBaseURL = @"https://graph.microsoft.com/beta/";
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/users/fa8bf3dc-eca7-46b7-bad1-db199b62afc3/presence/setUserPreferredPresence"]]];
[urlRequest setHTTPMethod:@"POST"];
[urlRequest setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];

NSMutableDictionary *payloadDictionary = [[NSMutableDictionary alloc] init];

NSString *availability = @"DoNotDisturb";
payloadDictionary[@"availability"] = availability;

NSString *activity = @"DoNotDisturb";
payloadDictionary[@"activity"] = activity;

NSString *expirationDuration = @"PT8H";
payloadDictionary[@"expirationDuration"] = expirationDuration;

NSData *data = [NSJSONSerialization dataWithJSONObject:payloadDictionary options:kNilOptions error:&error];
[urlRequest setHTTPBody:data];

MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest 
    completionHandler: ^(NSData *data, NSURLResponse *response, NSError *nserror) {

        //Request Completed

}];

[meDataTask execute];

重要

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 のドキュメントを参照してください。


//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClient(requestAdapter)

requestBody := msgraphsdk.New()
availability := "DoNotDisturb"
requestBody.SetAvailability(&availability)
activity := "DoNotDisturb"
requestBody.SetActivity(&activity)
expirationDuration := "PT8H"
requestBody.SetExpirationDuration(&expirationDuration)
userId := "user-id"
graphClient.UsersById(&userId).Presence().SetUserPreferredPresence(user-id).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 要求

要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック