BoxClientオブジェクト
コンポーネント情報 | |
---|---|
version | 8.0.4 |
since | 8.0.4 |
Boxのファイルサービスにアクセスするためのクラスです。
Boxの操作に関するAPIを提供します。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
Boxの操作に関するAPIを提供します。
このAPIを利用するためには以下の前提条件を満たしている必要があります。
- Box にてアプリケーションが登録・設定されていること
- intra-mart Accel Platformのユーザに対応するBoxユーザIDが存在すること
- モジュール構成にて「Box 連携」モジュールを選択し WARファイルが作成されていること
- Box 開発者コンソールからダウンロードした設定ファイルを intra-mart Accel Platform にアップロードされていること
- 実装例は以下の通りです。
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を用いてインスタンスを生成します。
パラメータ
|
メソッドの詳細
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 )
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。 scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
返却値
|
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] )
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。 scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
返却値
|
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] )
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。 scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
返却値
|
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 )
パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
templateNameを省略した場合、メタデータはカスタムメタデータとして取り扱います。 scopeを省略した場合、カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。
パラメータ
返却値
|
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以上の)ファイルを分割アップロードします。
パラメータ
返却値
|