スクリプト開発向けim-BizAPI

BoxClientオブジェクト

コンポーネント情報
version8.0.4
since8.0.4
コンポーネント概要
Boxのファイルサービスにアクセスするためのクラスです。
Boxの操作に関するAPIを提供します。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
  • Box にてアプリケーションが登録・設定されていること
  • intra-mart Accel Platformのユーザに対応するBoxユーザIDが存在すること
  • モジュール構成にて「Box 連携」モジュールを選択し WARファイルが作成されていること
  • Box 開発者コンソールからダウンロードした設定ファイルを intra-mart Accel Platform にアップロードされていること
上記の設定方法についてはBox 連携モジュール 利用ガイドを参照してください。

  • 実装例は以下の通りです。
     var boxClient = new BoxClient().asUser(boxUserId);

コンストラクタの概要

BoxClient (String [clientId])
コンストラクタ。clientIdを省略した場合、標準のクライアントIDを用いてインスタンスを生成します。

メソッドの概要

返却値の型 メソッド名
ResultObject addOrUpdateCollaboration (String path, String boxUserId, String accessLevel)
パスを指定してファイルまたはフォルダに対するアクセス権限を追加または更新します。
BoxClient asUser (String boxUserId)
接続するBoxユーザを指定します。
ResultObject copyFileById (String fromId, String toParentId, String name, Boolean overwrite)
ファイルIDを指定してファイルをコピーします。
ResultObject copyFile (String fromPath, String toPath, Boolean overwrite)
パスを指定してファイルをコピーします。
ResultObject copyFolderById (String fromId, String toParentId, String name, Boolean overwrite)
フォルダIDを指定してフォルダをコピーします。
ResultObject copyFolder (String fromPath, String toPath, Boolean overwrite)
パスを指定してフォルダをコピーします。
ResultObject createFolderById (String parentId, String name)
作成先のフォルダのIDを指定してフォルダを作成します。
ResultObject createFolder (String path)
パスを指定してフォルダを作成します。
ResultObject createMetadata (String path, String [templateName], String [scope], Object metadata)
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
ResultObject createSharedLink (String path, String unsharedDate, String access, Boolean canDownload, Boolean canPreview, Boolean [canEdit], String [password])
パスを指定してファイルの共有リンクを作成します。
ResultObject deleteCollaboration (String path, String boxUserId)
パスを指定してファイルまたはフォルダに対するアクセス権限を削除します。
ResultObject deleteFileById (String id)
ファイルIDを指定してファイルを削除します。
ResultObject deleteFileRequestInfo (String id)
ファイルリクエストを削除します。
ResultObject deleteFile (String path)
パスを指定してファイルを削除します。
ResultObject deleteFolderById (String id, Boolean recursive)
フォルダIDを指定してフォルダを削除します。
ResultObject deleteFolder (String path, Boolean recursive)
パスを指定してフォルダを削除します。
ResultObject deleteMetadata (String path, String [templateName], String [scope])
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
ResultObject deleteSharedLink (String path)
パスを指定してファイルの共有リンクを削除します。
ResultObject downloadFileById (String id, ByteWriter writer)
ファイルIDを指定してファイルをダウンロードします。
ResultObject downloadFile (String path, ByteWriter writer)
パスを指定してファイルをダウンロードします。
ResultObject getAllEnterpriseUsers ()
管理対象ユーザの一覧を取得します。
ResultObject getInfo (String path)
パスを指定してファイルまたはフォルダの情報を取得します。
ResultObject getItemId (String path)
パスを指定してファイルまたはフォルダのIDを取得します。
ResultObject getMetadata (String path, String [templateName], String [scope])
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
ResultObject getSharedLink (String path)
パスを指定してファイルの共有リンクを取得します。
ResultObject listById (String id, Boolean [recursive])
フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
ResultObject list (String path, Boolean [recursive])
パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
ResultObject lockFileById (String id, String [expiresAt], Boolean [isDownloadPrevented])
ファイルIDを指定してファイルをロックします。
ResultObject lockFile (String path, String [expiresAt], Boolean [isDownloadPrevented])
パスを指定してファイルをロックします。
ResultObject moveFileById (String fromId, String toParentId, String name)
ファイルIDを指定してファイルを移動します。
ResultObject moveFile (String fromPath, String toPath)
パスを指定してファイルを移動します。
ResultObject moveFolderById (String fromId, String toParentId, String name)
フォルダIDを指定してフォルダを移動します。
ResultObject moveFolder (String fromPath, String toPath)
パスを指定してフォルダを移動します。
ResultObject unlockFileById (String id)
ファイルIDを指定してファイルをロック解除します。
ResultObject unlockFile (String path)
パスを指定してファイルをロック解除します。
ResultObject updateMetadata (String path, String [templateName], String [scope], Object metadata)
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
ResultObject uploadFileById (String parentId, String name, ByteReader reader)
ファイルを配置するフォルダのIDを指定してファイルをアップロードします。
ResultObject uploadFile (String path, ByteReader reader)
パスを指定してファイルをアップロードします。
ResultObject uploadLargeFileById (String parentId, String name, ByteReader reader, Number size)
ファイルを配置するフォルダのIDを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。
ResultObject uploadLargeFile (String path, ByteReader reader, Number size)
パスを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。

コンストラクタの詳細

BoxClient (String [clientId])
コンストラクタ。clientIdを省略した場合、標準のクライアントIDを用いてインスタンスを生成します。
パラメータ
[clientId] : String
クライアントID

メソッドの詳細

ResultObject addOrUpdateCollaboration (String path, String boxUserId, String accessLevel)
パスを指定してファイルまたはフォルダに対するアクセス権限を追加または更新します。
パラメータ
path : String
アクセス権限を操作するファイルまたはフォルダのパス
boxUserId : String
BoxユーザID
accessLevel : String
アクセスの権限レベルの文字列。CO_OWNER/EDITOR/VIEWER_UPLOADER/PREVIEWER_UPLOADER/VIEWER/PREVIEWER/UPLOADERのいずれか
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 更新失敗
    • false ： 更新成功
BoxClient asUser (String boxUserId)
接続するBoxユーザを指定します。
パラメータ
boxUserId : String
BoxユーザID
返却値
BoxClient
BoxClient このBoxClientオブジェクト自身
ResultObject copyFileById (String fromId, String toParentId, String name, Boolean overwrite)
ファイルIDを指定してファイルをコピーします。
パラメータ
fromId : String
コピー元ファイルのファイルID
toParentId : String
コピー先ファイルを配置するフォルダのフォルダID
name : String
コピー先ファイルのファイル名
overwrite : Boolean
コピー先に同名ファイルが存在するとき、上書きする場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject copyFile (String fromPath, String toPath, Boolean overwrite)
パスを指定してファイルをコピーします。
パラメータ
fromPath : String
コピー元ファイルのパス
toPath : String
コピー先ファイルのパス
overwrite : Boolean
コピー先に同名ファイルが存在するとき、上書きする場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject copyFolderById (String fromId, String toParentId, String name, Boolean overwrite)
フォルダIDを指定してフォルダをコピーします。
パラメータ
fromId : String
コピー元フォルダのフォルダID
toParentId : String
コピー先フォルダを配置するフォルダのフォルダID
name : String
コピー先フォルダのフォルダ名
overwrite : Boolean
コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject copyFolder (String fromPath, String toPath, Boolean overwrite)
パスを指定してフォルダをコピーします。
パラメータ
fromPath : String
コピー元フォルダのパス
toPath : String
コピー先フォルダのパス
overwrite : Boolean
コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject createFolderById (String parentId, String name)
作成先のフォルダのIDを指定してフォルダを作成します。
パラメータ
parentId : String
作成するフォルダを配置するフォルダのフォルダID
name : String
作成するフォルダのフォルダ名
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 作成失敗
    • false ： 作成成功
ResultObject createFolder (String path)
パスを指定してフォルダを作成します。
パラメータ
path : String
作成するフォルダのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 作成失敗
    • false ： 作成成功
ResultObject createMetadata (String path, String [templateName], String [scope], Object metadata)
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。
scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。

  • 実装例は以下の通りです。
     boxClient.createMetadata('/foo/bar/baz.txt', {
 flowId: request.flowId,
 title: request.title
 });
パラメータ
path : String
メタデータを作成するファイルのパス
[templateName] : String
メタデータテンプレート名
[scope] : String
メタデータテンプレートのスコープ(globalまたはenterprise)
metadata : Object
メタデータのキー/値をフィールドに持つオブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 作成失敗
    • false ： 作成成功
ResultObject deleteCollaboration (String path, String boxUserId)
パスを指定してファイルまたはフォルダに対するアクセス権限を削除します。
パラメータ
path : String
アクセス権限を削除するファイルまたはフォルダのパス
boxUserId : String
BoxユーザID
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteFileById (String id)
ファイルIDを指定してファイルを削除します。
パラメータ
id : String
削除するファイルのファイルID
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteFileRequestInfo (String id)
ファイルリクエストを削除します。
パラメータ
id : String
ファイルリクエストのID
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteFile (String path)
パスを指定してファイルを削除します。
パラメータ
path : String
削除するファイルのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteFolderById (String id, Boolean recursive)
フォルダIDを指定してフォルダを削除します。
パラメータ
id : String
削除するフォルダのフォルダID
recursive : Boolean
フォルダ内のファイル/フォルダを再帰的に削除する場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteFolder (String path, Boolean recursive)
パスを指定してフォルダを削除します。
パラメータ
path : String
削除するフォルダのパス
recursive : Boolean
フォルダ内のファイル/フォルダを再帰的に削除する場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject deleteMetadata (String path, String [templateName], String [scope])
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。
scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
path : String
メタデータを削除するファイルのパス
[templateName] : String
メタデータテンプレート名
[scope] : String
メタデータテンプレートのスコープ(globalまたはenterprise)
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： 削除失敗
    • false ： 削除成功
ResultObject downloadFileById (String id, ByteWriter writer)
ファイルIDを指定してファイルをダウンロードします。
パラメータ
id : String
ダウンロードするファイルのファイルID
writer : ByteWriter
ダウンロード先のByteWriter
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： ダウンロード失敗
    • false ： ダウンロード成功
ResultObject downloadFile (String path, ByteWriter writer)
パスを指定してファイルをダウンロードします。
パラメータ
path : String
ダウンロードするファイルのパス
writer : ByteWriter
ダウンロード先のByteWriter
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： ダウンロード失敗
    • false ： ダウンロード成功
ResultObject getAllEnterpriseUsers ()
管理対象ユーザの一覧を取得します。
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject getInfo (String path)
パスを指定してファイルまたはフォルダの情報を取得します。
パラメータ
path : String
情報を取得するファイルまたはフォルダのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject getItemId (String path)
パスを指定してファイルまたはフォルダのIDを取得します。
パラメータ
path : String
ファイルまたはフォルダパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • data： ファイルまたはフォルダのID
ResultObject getMetadata (String path, String [templateName], String [scope])
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。
scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
path : String
メタデータを取得するファイルのパス
[templateName] : String
メタデータテンプレート名
[scope] : String
メタデータテンプレートのスコープ(globalまたはenterprise)
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • data： メタデータのキー/値をフィールドに持つオブジェクト
ResultObject listById (String id, Boolean [recursive])
フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
パラメータ
id : String
情報を取得するフォルダのID
[recursive] : Boolean
サブフォルダ内の情報を再帰的に取得する場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject list (String path, Boolean [recursive])
パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
パラメータ
path : String
情報を取得するフォルダのパス
[recursive] : Boolean
サブフォルダ内の情報を再帰的に取得する場合はtrue
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject lockFileById (String id, String [expiresAt], Boolean [isDownloadPrevented])
ファイルIDを指定してファイルをロックします。
パラメータ
id : String
ロックするファイルのファイルID
[expiresAt] : String
ロックが無効になる日時を表すISO8601形式の文字列
[isDownloadPrevented] : Boolean
ダウンロードも禁止する場合true
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject lockFile (String path, String [expiresAt], Boolean [isDownloadPrevented])
パスを指定してファイルをロックします。

  • 実装例は以下の通りです。 
     boxClient.lockFile('/foo/bar/baz.txt');
パラメータ
path : String
ロックするファイルのパス
[expiresAt] : String
ロックが無効になる日時を表すISO8601形式の文字列
[isDownloadPrevented] : Boolean
ダウンロードも禁止する場合true
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject moveFileById (String fromId, String toParentId, String name)
ファイルIDを指定してファイルを移動します。
パラメータ
fromId : String
移動元のファイルのファイルID
toParentId : String
移動先ファイルを配置するフォルダのフォルダID
name : String
移動先ファイルのファイル名
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject moveFile (String fromPath, String toPath)
パスを指定してファイルを移動します。
パラメータ
fromPath : String
移動元のファイルのパス
toPath : String
移動先のファイルのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject moveFolderById (String fromId, String toParentId, String name)
フォルダIDを指定してフォルダを移動します。
パラメータ
fromId : String
移動元のファイルのファイルID
toParentId : String
移動先ファイルを配置するフォルダのフォルダID
name : String
移動先フォルダのフォルダ名
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject moveFolder (String fromPath, String toPath)
パスを指定してフォルダを移動します。
パラメータ
fromPath : String
移動元のフォルダのパス
toPath : String
移動先のフォルダのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject unlockFileById (String id)
ファイルIDを指定してファイルをロック解除します。
パラメータ
id : String
ロック解除するファイルのファイルID
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： ロック解除失敗
    • false ： ロック解除成功
ResultObject unlockFile (String path)
パスを指定してファイルをロック解除します。
パラメータ
path : String
ロック解除するファイルのパス
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： ロック解除失敗
    • false ： ロック解除成功
ResultObject updateMetadata (String path, String [templateName], String [scope], Object metadata)
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。
scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
path : String
メタデータを更新するファイルのパス
[templateName] : String
メタデータテンプレート名
[scope] : String
メタデータテンプレートのスコープ(globalまたはenterprise)
metadata : Object
メタデータのキー/値をフィールドに持つオブジェクト
返却値
ResultObject
ResultObject 処理結果オブジェクト
  • error
    • true ： メタデータの更新失敗
    • false ： メタデータの更新成功
ResultObject uploadFileById (String parentId, String name, ByteReader reader)
ファイルを配置するフォルダのIDを指定してファイルをアップロードします。
パラメータ
parentId : String
ファイルを配置するフォルダのフォルダID
name : String
アップロードするファイルのファイル名
reader : ByteReader
アップロード元のByteReader
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject uploadFile (String path, ByteReader reader)
パスを指定してファイルをアップロードします。
パラメータ
path : String
アップロードする先のファイルのパス
reader : ByteReader
アップロード元のByteReader
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject uploadLargeFileById (String parentId, String name, ByteReader reader, Number size)
ファイルを配置するフォルダのIDを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。
パラメータ
parentId : String
ファイルを配置するフォルダのフォルダID
name : String
アップロードするファイルのファイル名
reader : ByteReader
アップロード元のByteReader
size : Number
アップロードするファイルのサイズ
返却値
ResultObject
ResultObject 処理結果オブジェクト
ResultObject uploadLargeFile (String path, ByteReader reader, Number size)
パスを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。
パラメータ
path : String
アップロードする先のファイルのパス
reader : ByteReader
アップロード元のByteReader
size : Number
アップロードするファイルのサイズ
返却値
ResultObject
ResultObject 処理結果オブジェクト

Copyright © 2012 NTT DATA INTRAMART CORPORATION