メソッドと操作

ツールキットの詳細

クラス名: box.Toolkit

インスタンス変数

mostRecentError

インスタンスメソッドの呼び出し時に発生した最新のエラーを示す文字列。

この文字列が存在しても、操作が成功しなかったことを意味するわけではありません。そのエラーが回復可能であった可能性もあります。ただし、この文字列に値がない場合は、操作が成功したことを示しています。

Enum CollaborationType

コラボレーションのタイプを示す列挙型。

可能性のある値: EDITOR、VIEWER、PREVIEWER、UPLOADER、COOWNER、OWNER、PREVIEWERUPLOADER、VIEWERUPLOADER

静的メソッド

deleteServiceUserAssociation

サービスアカウントとBox for Salesforce統合の関連付けをクリアするメソッド。間違ったサービスアカウントが使用されている場合、このメソッドを使用してアカウントを変更できます。

パラメータ:

• なし

戻り値:

• ユーザーのアカウントが存在していたが削除された場合はtrue。
• ユーザーのアカウントが何らかの理由 (存在しなかった場合を含む) で削除されなかった場合はfalse。

deleteUserAssociation

戻り値:

• ユーザーのアカウントが存在していたが削除された場合はtrue。
• ユーザーのアカウントが何らかの理由 (存在しなかった場合を含む) で削除されなかった場合はfalse。

インスタンスメソッド - コンストラクタ、デストラクタ

box.Toolkit()

パラメータ:

• なし

commitChanges

このメソッドはbox.Toolkit()メソッドのデストラクタとして扱います。

Salesforceではデータベースの更新/挿入/削除の後の呼び出しは許可されないため、Toolkitクラスではすべての呼び出し操作が完了した後で挿入するオブジェクトのコレクションが保持されます。このメソッドを呼び出さない場合、このようなオブジェクトがデータベースから消去され、ユーザー/レコード/フォルダの関連付けを追跡するテーブルの同期も失われて、高度なデバッグによる修正が必要になります。

パラメータ:

• なし

戻り値:

• Void

プラットフォームイベントを使用するcommitChanges

このメソッドはbox.Toolkit()メソッドのデストラクタとして扱います。

このメソッドは、上記のcommitChangesとよく似ています。ただし、別のトランザクションでDMLステートメントを実行し、一部のシナリオでガバナ制限を回避するために、プラットフォームイベントを使用してデータベースに変更をコミットします。

戻り値:

• Void

ジェネリックメソッド

Box for Salesforce Developer Toolkitは、パラメータとしてHttpRequestオブジェクトを受け取り、HttpResponseオブジェクトを返すグローバルメソッドを提供します。このメソッドではサービスアカウントの認証の詳細情報を利用してBoxのAPIを呼び出すため、開発者は統合のビジネスロジックに集中して取り組むことができます。

sendRequest

戻り値:

• BoxのAPIコールからのレスポンスの詳細情報が含まれたHttpResponseオブジェクト。
• HttpRequestのインプットの情報が不足している場合はToolkit.BoxApiException。
• サービスアカウントの認証の詳細情報を取得する際に問題が発生した場合はnull。この場合は、mostRecentErrorを確認してください。

ファイル操作

createFileFromAttachment

戻り値:

• string。作成されたBoxファイルのIDが返されます。
• エラーが発生した場合はnull。この場合には、mostRecentErrorを確認してください。

getObjectFolderByRecordId

戻り値:

• string。レコードIDが渡されたオブジェクトルートフォルダのBoxフォルダIDが返されます。

フォルダ操作

getRootFolderId

パラメータ:

• なし

戻り値:

• string。SalesforceルートフォルダのBoxフォルダIDが返されます。

getObjectFolderByRecordId

戻り値:

• string。レコードIDが渡されたオブジェクトルートフォルダのBoxフォルダIDが返されます。

getFolderUrl

• このメソッドは、特定のレコードの埋め込みウィジェットURLを取得します。このため、必要に応じて独自の埋め込みロジックを使用できます。
• このメソッドではシームレスログインの設定が優先されます。このため、シームレスログインが有効になっている場合、ユーザーはURLに自動的にログインされます。

戻り値:

• string。渡されたSalesforceレコードIDに関連付けられているフォルダを表すURLが返されます。このURLをBox埋め込みウィジェットで使用して、任意のVisualforceページに埋め込むことができます。

createObjectFolderForRecordId

戻り値:

• string。作成されたルートフォルダのBoxフォルダIDが返されます。
• ルートフォルダがすでに存在していた場合、そのルートフォルダのBoxフォルダIDが返されます。

createFolder

戻り値:

• string。作成されたフォルダのBoxフォルダIDが返されます。
• フォルダが作成されなかった場合はnullが返されます。この場合、mostRecentErrorで詳細を確認してください。

createFolderForRecordId

戻り値:

• string。作成されたフォルダのBoxフォルダIDが返されます。
• フォルダが作成されなかった場合はnullが返されます。この場合、mostRecentErrorで詳細を確認してください。
• SalesforceレコードがすでにBoxフォルダに関連付けられている場合、既存のBoxフォルダIDが返されます。

moveFolder

戻り値:

• フォルダが正常に移動された場合はtrue。
• フォルダが正常に移動されなかった場合はfalse。mostRecentErrorで詳細を確認してください。

getUrlForFolder

戻り値:

• 指定されたURLを含むpageReferenceオブジェクト。
• パラメータが正しくない場合はnull。

createFolderForRecordIdFromTemplate

戻り値:

• 新しく作成されたfolder Id。
• パラメータが正しくない場合はnull。

フォルダ関連付けメソッド

getFolderAssociationsByRecordId

戻り値:

• 返されるリストは、このレコードに関連付けられているすべてのフォルダマッピングエントリのコレクションです。
• 一般に、フォルダマッピングエントリが存在しない場合は空のリストになりますが、状況によってnullになる場合があります。

getFolderIdByRecordId

戻り値:

• string。渡されたSalesforceレコードIDに関連付けられたBoxフォルダIDが返されます。

getRecordIdByFolderId

戻り値:

• id。渡されたBoxフォルダIDに関連付けられたSalesforceレコードIDが返されます。

createFolderAssociation

戻り値:

• box__FRUP__cオブジェクト - エラーが発生した場合 (mostRecentErrorを確認)、返されるFRUPオブジェクトはnullになります。このFRUPエントリは、commitChangesメソッドの呼び出し時にデータベースに挿入されます。このメソッドでは、同じフォルダの複数レコードへの関連付けやその逆の関連付けが許可されないため、他のフォルダの関連付けとの一貫性が保証されます。

コラボレーションメソッド

createCollaboration

戻り値:

• string。作成されたBoxコラボレーションのIDが返されます。
• エラーが発生した場合はnullが返されます。その場合、mostRecentErrorを確認してください。

createCollaborationOnRecord

戻り値:

• string。作成されたBoxコラボレーションのIDが返されます。
• エラーが発生した場合はnullが返されます。その場合、mostRecentErrorを確認してください。

editCollaboration

戻り値:

• トランザクションが成功したかどうかを示すブール値。
• パラメータが正しくない場合はfalse。

deleteCollaboration

戻り値:

• トランザクションが成功したかどうかを示すブール値。
• パラメータが正しくない場合はfalse。

メタデータ

getBoxMetadataByFolderId

このメソッドでは、フォルダのメタデータインスタンスを取得エンドポイントを呼び出します。

戻り値:

• このフォルダ、スコープ、およびテンプレートキーに関連付けられたFolderMetadataレコード。カスタム値は、このオブジェクトのkeyValuePairs変数で確認できます。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーが見つからない

createBoxMetadataByFolderId

このメソッドでは、フォルダにメタデータインスタンスを作成エンドポイントを呼び出します。

戻り値:

• 新しく作成されたFolderMetadataオブジェクト。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーが見つからない

updateBoxMetadataByFolderId

フォルダのメタデータインスタンスを更新エンドポイントを呼び出します。

戻り値:

• 更新されたFolderMetadataオブジェクト。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーが見つからない

deleteBoxMetadataFolderId

このメソッドでは、フォルダからメタデータインスタンスを削除エンドポイントを呼び出します。

戻り値:

• トランザクションが成功したかどうかを示すブール値。
• パラメータが誤ったパラメータである場合またはメタデータが見つからない場合は、falseが返されることがあります。

getMetadataCascadePolicyById

このメソッドでは、フォルダからメタデータカスケードポリシーを取得エンドポイントを呼び出します。このメソッドはIDを必要とするため、最初にgetMetadataCascadePoliciesByFolderIdメソッドを呼び出す必要があります。

戻り値:

• Boxから取得されたMetadataCascadePolicyオブジェクト。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーが見つからない

getMetadataCascadePoliciesByFolderId

このメソッドでは、フォルダIDを指定し、メタデータカスケードポリシーを取得エンドポイントを呼び出すことで、カスケードポリシーを取得します。

戻り値:

• Boxから取得されたMetadataCascadePolicyオブジェクトのリスト。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーが見つからない

createMetadataCascadePolicy

このメソッドでは、BoxフォルダID、スコープ、テンプレートキーを指定し、メタデータカスケードポリシーを投稿エンドポイントを呼び出すことで、カスケードポリシーを作成します。

戻り値:

• 新しく生成されたMetadataCascadePolicy。

• 以下の場合はnull。

  • パラメータが正しくない
  • フォルダへのアクセス権限がない
  • メタデータカスケードポリシーの詳細が見つからない

deleteMetadataCascadePolicy

このメソッドでは、カスケードポリシーIDを指定し、メタデータカスケードポリシーIDを削除エンドポイントを呼び出すことで、カスケードポリシーを削除します。

戻り値:

• トランザクションが成功したかどうかを示すブール値。
• パラメータが正しくない場合、フォルダへのアクセス権限がない場合、またはメタデータカスケードポリシーが見つからない場合は、falseが返されます。

enableAppActivity

このメソッドでは、アプリアクティビティに指定されたフォルダにメタデータを適用してカスケードすることで、そのフォルダを有効にします。

戻り値:

• トランザクションが成功したかどうかを示すブール値。
• パラメータが正しくない場合はfalse。

SalesforceとSlack

getIntegrationMappings

このツールキットのメソッドでは、統合マッピングを取得エンドポイントを呼び出して既存のマッピングを取得します。

戻り値:

• IntegrationMappingオブジェクトのリスト。
• パラメータが正しくない場合、アクセス権限がない場合、または統合マッピングが見つからない場合は、nullが返されます。

createIntegrationMapping

このツールキットのメソッドでは、統合マッピングを取得エンドポイントを呼び出してマッピングを作成します。

戻り値:

• トランザクションが成功したかどうかを示すブール値。

deleteIntegrationMapping

このツールキットのメソッドでは、統合マッピングを削除エンドポイントを呼び出してマッピングを削除します。

戻り値:

• トランザクションが成功したかどうかを示すブール値。

mapSfdcRecordToSlackChannel

このツールキットのメソッドでは、上記の統合マッピングメソッドを使用し、以下の4種類のユースケースで使用できるラッパーを提供します。

1. SalesforceまたはSlackにマッピングが存在しない場合は、Box for Salesforceフォルダ構造にフォルダが作成され、そのフォルダをSlackチャンネルとリンクするための統合マッピングが作成されます。
2. Salesforceからのマッピングのみ存在する場合は、引き続きそのフォルダが使用され、場所は変更されません。そのフォルダをSlackチャンネルとリンクするための統合マッピングを作成します。
3. Slackからのマッピングのみ存在する場合は、引き続きそのフォルダが使用され、既存のフォルダを使用するためにSalesforceレコード用にFRUPレコードが作成されます。このフォルダは、Salesforceルートフォルダ外に存在する可能性があります。
4. SalesforceとSlackに既存のマッピングがあるものの、相互に関連付けられていない場合は、Toolkit.mostRecentErrorまたはフローアクション内でエラーがスローされ、マッピングがすでに存在することが示されます。

このメソッド/呼び出し可能なアクションは、Box for SalesforceパッケージのCreate Box Folder/Slack Channel Mappingで提供されるフローテンプレートで使用されています。

戻り値:

• トランザクションが成功したかどうかを示すブール値。

setSlackChannelAccessManagementDisabled

このツールキットのメソッドでは、統合マッピングを更新エンドポイントを呼び出して、アクセス管理の非アクティブ化設定を更新します。

このメソッド/呼び出し可能なアクションは、Box for SalesforceパッケージのCreate Box Folder/Slack Channel Mappingで提供されるフローテンプレートで使用されています。

戻り値:

• トランザクションが成功したかどうかを示すブール値。