Experience Cloud Toolkitのグローバルメソッド

ExperienceCloudToolkitクラスは、Box App UserをSalesforce Experience Cloud環境内で管理するためのグローバルメソッドを提供します。これらのメソッドでは、Salesforceユーザーに関連付けられたBox App Userの作成、非アクティブ化、検索をサポートしています。

メソッド

`createAppUserforCurrentUser()`

現在ログインしているSalesforceユーザーのBox App Userを作成します。シグネチャ: Global static BoxUser.Info createAppUserforCurrentUser() 戻り値:

BoxUser.Info。作成されたBox App User、または既存のBox App Userについての情報です。

説明: 現在のユーザーのIDを使用してcreateAppUserforUser()を呼び出すことができる便利なメソッドです。現在のユーザーにアクティブなApp Userがすでに存在する場合は、既存のApp Userの情報が返されます。例:

BoxUser.Info appUser = ExperienceCloudToolkit.createAppUserforCurrentUser();
System.debug('Box User ID: ' + appUser.boxId);

`createAppUserforUser(String userId)`

特定のSalesforceユーザーのBox App Userを作成または再アクティブ化します。シグネチャ: Global static BoxUser.Info createAppUserforUser(String userId) パラメータ:

名前	型	説明
`userId`	`String`	Box App Userの作成対象となるSalesforceユーザーのID。

戻り値:

BoxUser.Info。作成されたBox App User、または既存のBox App Userについての情報です。

説明: プラットフォームアクセス専用のBox App Userを、指定されたSalesforceユーザーIDに関連付けます。ロジックは次のとおりです。

このメソッドが、external_app_user_idとSalesforce userIdが一致する既存のBox App Userを検索します。
アクティブなユーザーが見つかった場合は、そのユーザーの情報を返します。
アクティブでないユーザーが見つかった場合は、そのユーザーを再アクティブ化し、そのユーザーの情報を返します。
ユーザーが見つからなかった場合は、以下のプロパティを使用して新しいApp Userを作成します。
- name: Salesforceユーザーの名前
- external_app_user_id: SalesforceのuserId
- is_platform_access_only: true
- status: active

例:

String salesforceUserId = '005xx000001SvWlAAK';
BoxUser.Info appUser = ExperienceCloudToolkit.createAppUserforUser(salesforceUserId);
System.debug('Created Box App User: ' + appUser.name);

`deactivateCurrentUserAccount()`

現在のSalesforceユーザーのBox App Userアカウントを非アクティブ化します。シグネチャ: Global static Boolean deactivateCurrentUserAccount() 戻り値:

Boolean。非アクティブ化が成功した場合はtrue、成功しなかった場合はfalseです。

説明: 現在のユーザーのIDを使用してdeactivateUserAccount()を呼び出し、Box App Userのステータスをinactiveに設定することができる、便利なメソッドです。例:

Boolean success = ExperienceCloudToolkit.deactivateCurrentUserAccount();
if (success) { 
   System.debug('Account deactivated successfully.');
}

`deactivateUserAccount(String boxUserId)`

特定のBox App Userアカウントを非アクティブ化します。シグネチャ: Global static Boolean deactivateUserAccount(String boxUserId) パラメータ:

名前	型	説明
`boxUserId`	`String`	非アクティブ化するBoxユーザーID。

戻り値:

Boolean。非アクティブ化が成功 (HTTP 200 OK) の場合はtrue、そうでない場合はfalseです。

説明: リクエストをBox APIに送信して、ユーザーのステータスをinactiveに更新します。これにより、ユーザーはBoxコンテンツにアクセスできなくなりますが、アカウント自体は削除されません。例:

String boxUserId = '12345678';
Boolean success = ExperienceCloudToolkit.deactivateUserAccount(boxUserId);
if (success) {
    System.debug('Box user deactivated.');
}

`searchForExistingUser(String externalAppUserId)`

外部IDを使用してBox App Userを検索します。シグネチャ: Global static BoxUser.Info searchForExistingUser(String externalAppUserId) パラメータ:

名前	型	説明
`externalAppUserId`	`String`	検索の対象となる外部ID (通常はSalesforceユーザーID)。

戻り値:

BoxUser.Info。見つかったBox App Userについての情報です。

スローされる例外:

ExperienceCloudToolkitException (指定した外部IDでユーザーが見つからなかった場合)。

説明: Box APIにクエリを実行し、external_app_user_idが指定された値に一致するApp Userを検索します。Salesforceユーザーに関連付けられたBox App Userがすでに存在するかどうかを確認する場合に便利です。例:

try {
    String sfUserId = UserInfo.getUserId();
    BoxUser.Info existingUser = ExperienceCloudToolkit.searchForExistingUser(sfUserId);
    System.debug('Found existing Box user: ' + existingUser.boxId);
} catch (ExperienceCloudToolkit.ExperienceCloudToolkitException e) {
    System.debug('No existing user found. A new one can be created.');
}

例外

`ExperienceCloudToolkitException`

searchForExistingUser()でユーザーが見つからなかったときなど、操作が失敗した場合にはカスタム例外がスローされます。

メモ

すべてのメソッドは、サービスアカウントトークンを使用してBox APIに対する認証を行います。
作成されたApp Userは「プラットフォームアクセス専用」 (is_platform_access_only = true) です。つまり、アプリケーションを通じてのみBoxにアクセスできます。
external_app_user_idフィールドは、Box App UserをSalesforceユーザーIDに関連付けます。
APIのバージョン管理は、SettingUtils.getAPISetting('ExperienceCloudToolkit')構成を通じて行われます。

​メソッド

​createAppUserforCurrentUser()

​createAppUserforUser(String userId)

​deactivateCurrentUserAccount()

​deactivateUserAccount(String boxUserId)

​searchForExistingUser(String externalAppUserId)

​例外

​ExperienceCloudToolkitException

​メモ

メソッド

`createAppUserforCurrentUser()`

`createAppUserforUser(String userId)`

`deactivateCurrentUserAccount()`

`deactivateUserAccount(String boxUserId)`

`searchForExistingUser(String externalAppUserId)`

例外

`ExperienceCloudToolkitException`

メモ