jp.co.intra_mart.foundation.box.api

インタフェース BoxClient

すべてのスーパーインタフェース:

Serializable

public interface BoxClient
extends Serializable

Box操作のためのAPIを用意したクライアントクラスのインタフェースです。

導入されたバージョン:

8.0.0

バージョン:

8.0.4

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static String	BOX_FILE_PATHSEPARATOR Boxのファイルパスのセパレータ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	addOrUpdateCollaboration(String path, String boxUserId, String accessLevel) パスを指定してファイルまたはフォルダに対するアクセス権限を追加または更新します。
BoxClient	asUser(String id) 接続するBoxユーザを指定します。
com.box.sdk.BoxFile.Info	copyFile(String fromPath, String toPath, boolean overwrite) パスを指定してファイルをコピーします。
com.box.sdk.BoxFile.Info	copyFileById(String fromId, String toParentId, String name, boolean overwrite) ファイルIDを指定してファイルをコピーします。
com.box.sdk.BoxFileRequest.Info	copyFileRequestInfo(String id, String folderPath, FileRequestInfoParameter info) ファイルリクエストの情報を更新しながらコピーします。
com.box.sdk.BoxFolder.Info	copyFolder(String fromPath, String toPath, boolean overwrite) パスを指定してフォルダをコピーします。
com.box.sdk.BoxFolder.Info	copyFolderById(String fromId, String toParentId, String name, boolean overwrite) フォルダIDを指定してフォルダをコピーします。
void	createFolder(String path) パスを指定してフォルダを作成します。
void	createFolderById(String parentId, String name) 作成先のフォルダのIDを指定してフォルダを作成します。
void	createMetadata(String path, Map<String,Object> metadata) パスを指定してファイルのカスタムメタデータを作成します。
void	createMetadata(String path, String templateName, Map<String,Object> metadata) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
void	createMetadata(String path, String templateName, String scope, Map<String,Object> metadata) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
String	createSharedLink(String path, String unsharedDate, String access, boolean canDownload, boolean canPreview) パスを指定してファイルの共有リンクを作成します。
String	createSharedLink(String path, String unsharedDate, String access, boolean canDownload, boolean canPreview, boolean canEdit, String password) パスを指定してファイルの共有リンクを作成します。
void	deleteCollaboration(String path, String boxUserId) パスを指定してファイルまたはフォルダに対するアクセス権限を削除します。
void	deleteFile(String path) パスを指定してファイルを削除します。
void	deleteFileById(String id) ファイルIDを指定してファイルを削除します。
void	deleteFileRequestInfo(String id) ファイルリクエストを削除します。
void	deleteFolder(String path, boolean recursive) パスを指定してフォルダを削除します。
void	deleteFolderById(String id, boolean recursive) フォルダIDを指定してフォルダを削除します。
void	deleteMetadata(String path) パスを指定してファイルのカスタムメタデータを削除します。
void	deleteMetadata(String path, String templateName) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
void	deleteMetadata(String path, String templateName, String scope) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
void	deleteSharedLink(String path) パスを指定してファイルの共有リンクを削除します。
void	downloadFile(String path, OutputStream out) パスを指定してファイルをダウンロードします。
void	downloadFileById(String id, OutputStream out) ファイルIDを指定してファイルをダウンロードします。
Iterable<com.box.sdk.BoxUser.Info>	getAllEnterpriseUsers() 管理対象ユーザの一覧を取得します。
String	getClientId() クライアントIDを返します。
com.box.sdk.BoxFileRequest.Info	getFileRequestInfo(String id) ファイルリクエストの情報を取得します。
com.box.sdk.BoxItem.Info	getInfo(String path) パスを指定してファイルまたはフォルダの情報を取得します。
String	getItemId(String path) パスを指定してファイルまたはフォルダのIDを取得します。
Map<String,Object>	getMetadata(String path) パスを指定してファイルのカスタムメタデータを取得します。
Map<String,Object>	getMetadata(String path, String templateName) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
Map<String,Object>	getMetadata(String path, String templateName, String scope) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
String	getSharedLink(String path) パスを指定してファイルの共有リンクを取得します。
String	getUserId() ユーザIDを返します。
String	getWidgetTag(String url, String view, String sortColumn, String sortDirection, Boolean showParentPath, Boolean showItemFeedActions, int width, int height) Box埋め込みウィジェットのhtmlタグ表現の文字列を取得します。
List<com.box.sdk.BoxItem.Info>	list(String path) パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
List<com.box.sdk.BoxItem.Info>	list(String path, boolean recursive) パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
List<com.box.sdk.BoxItem.Info>	list(String path, boolean recursive, java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter) パスを指定してフォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報の一覧を取得します。
<R> List<R>	list(String path, boolean recursive, java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter, java.util.function.BiFunction<com.box.sdk.BoxItem.Info,String,R> mapper) パスを指定して、フォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報から任意の型に変換した一覧を取得します。
List<com.box.sdk.BoxItem.Info>	listById(String id) フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
List<com.box.sdk.BoxItem.Info>	listById(String id, boolean recursive) フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。
List<com.box.sdk.BoxItem.Info>	listById(String id, boolean recursive, java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter) フォルダIDを指定してフォルダ内のフィルタ条件に一致すファイルまたはフォルダの情報の一覧を取得します。
<R> List<R>	listById(String id, boolean recursive, java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter, java.util.function.BiFunction<com.box.sdk.BoxItem.Info,String,R> mapper) フォルダIDを指定して、フォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報から任意の型に変換した一覧を取得します。
com.box.sdk.BoxLock	lockFile(String path) パスを指定してファイルをロックします。
com.box.sdk.BoxLock	lockFile(String path, String expiresAt, boolean isDownloadPrevented) パスを指定してファイルをロックします。
com.box.sdk.BoxLock	lockFileById(String id) ファイルIDを指定してファイルをロックします。
com.box.sdk.BoxLock	lockFileById(String id, String expiresAt, boolean isDownloadPrevented) ファイルIDを指定してファイルをロックします。
com.box.sdk.BoxItem.Info	moveFile(String fromPath, String toPath) パスを指定してファイルを移動します。
com.box.sdk.BoxItem.Info	moveFileById(String fromId, String toParentId, String name) ファイルIDを指定してファイルを移動します。
com.box.sdk.BoxItem.Info	moveFolder(String fromPath, String toPath) パスを指定してフォルダを移動します。
com.box.sdk.BoxItem.Info	moveFolderById(String fromId, String toParentId, String name) フォルダIDを指定してフォルダを移動します。
void	unlockFile(String path) パスを指定してファイルをロック解除します。
void	unlockFileById(String id) ファイルIDを指定してファイルをロック解除します。
com.box.sdk.BoxFileRequest.Info	updateFileRequestInfo(String id, FileRequestInfoParameter info) ファイルリクエストの情報を更新します。
com.box.sdk.BoxFile.Info	updateInfo(String path, com.box.sdk.BoxFile.Info info) パスを指定してファイルの情報を更新します。
com.box.sdk.BoxFile.Info	updateInfoById(String id, com.box.sdk.BoxFile.Info info) IDを指定してファイルの情報を更新します。
void	updateMetadata(String path, Map<String,Object> metadata) パスを指定してファイルのカスタムメタデータを更新します。
void	updateMetadata(String path, String templateName, Map<String,Object> metadata) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
void	updateMetadata(String path, String templateName, String scope, Map<String,Object> metadata) パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
com.box.sdk.BoxFile.Info	uploadFile(String path, InputStream in) パスを指定してファイルをアップロードします。
com.box.sdk.BoxFile.Info	uploadFileById(String parentId, String name, InputStream in) ファイルを配置するフォルダのIDを指定してファイルをアップロードします。
com.box.sdk.BoxFile.Info	uploadLargeFile(String path, InputStream in, long size) パスを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。
com.box.sdk.BoxFile.Info	uploadLargeFileById(String parentId, String name, InputStream in, long size) ファイルを配置するフォルダのIDを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。

フィールドの詳細

BOX_FILE_PATHSEPARATOR

static final String BOX_FILE_PATHSEPARATOR

Boxのファイルパスのセパレータ

関連項目:

定数フィールド値

メソッドの詳細

getAllEnterpriseUsers

Iterable<com.box.sdk.BoxUser.Info> getAllEnterpriseUsers()
                                                  throws BoxSDKException

管理対象ユーザの一覧を取得します。

戻り値:

管理対象ユーザの一覧

例外:

BoxSDKException

getItemId

String getItemId(String path)
          throws BoxSDKException,
                 BoxConfigurationException

パスを指定してファイルまたはフォルダのIDを取得します。

パラメータ:

path - ファイルまたはフォルダパス

戻り値:

ファイルまたはフォルダのID

例外:

BoxSDKException

BoxConfigurationException

addOrUpdateCollaboration

void addOrUpdateCollaboration(String path,
                              String boxUserId,
                              String accessLevel)
                       throws BoxSDKException,
                              BoxConfigurationException

パスを指定してファイルまたはフォルダに対するアクセス権限を追加または更新します。

パラメータ:

path - アクセス権限を操作するファイルまたはフォルダのパス

boxUserId - BoxユーザID

accessLevel - アクセスの権限レベルの文字列。CO_OWNER/EDITOR/VIEWER_UPLOADER/PREVIEWER_UPLOADER/VIEWER/PREVIEWER/UPLOADERのいずれか

例外:

BoxSDKException - アクセス権限の追加または更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

asUser

BoxClient asUser(String id)

接続するBoxユーザを指定します。

パラメータ:

id - BoxユーザID

戻り値:

このインスタンス自身

copyFile

com.box.sdk.BoxFile.Info copyFile(String fromPath,
                                  String toPath,
                                  boolean overwrite)
                           throws BoxSDKException,
                                  BoxConfigurationException

パスを指定してファイルをコピーします。

パラメータ:

fromPath - コピー元ファイルのパス

toPath - コピー先ファイルのパス

overwrite - コピー先に同名ファイルが存在するとき、上書きする場合はtrue

戻り値:

コピーしたファイルの情報

例外:

BoxSDKException - ファイルのコピーに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

copyFileById

com.box.sdk.BoxFile.Info copyFileById(String fromId,
                                      String toParentId,
                                      String name,
                                      boolean overwrite)
                               throws BoxSDKException,
                                      BoxConfigurationException

ファイルIDを指定してファイルをコピーします。

パラメータ:

fromId - コピー元ファイルのファイルID

toParentId - コピー先ファイルを配置するフォルダのフォルダID

name - コピー先ファイルのファイル名

overwrite - コピー先に同名ファイルが存在するとき、上書きする場合はtrue

戻り値:

コピーしたファイルの情報

例外:

BoxSDKException - ファイルのコピーに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

copyFileRequestInfo

com.box.sdk.BoxFileRequest.Info copyFileRequestInfo(String id,
                                                    String folderPath,
                                                    FileRequestInfoParameter info)
                                             throws BoxSDKException,
                                                    BoxConfigurationException

ファイルリクエストの情報を更新しながらコピーします。

パラメータ:

id - ファイルリクエストのID

folderPath - ファイルリクエストをコピーする先のフォルダのパス

info - ファイルリクエストの情報を更新する内容

戻り値:

コピー元のファイルリクエストの情報

例外:

BoxSDKException - ファイルリクエストのコピーに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

copyFolder

com.box.sdk.BoxFolder.Info copyFolder(String fromPath,
                                      String toPath,
                                      boolean overwrite)
                               throws BoxSDKException,
                                      BoxConfigurationException

パスを指定してフォルダをコピーします。

パラメータ:

fromPath - コピー元フォルダのパス

toPath - コピー先フォルダのパス

overwrite - コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrue

戻り値:

コピーしたフォルダの情報

例外:

BoxSDKException - フォルダのコピーに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

copyFolderById

com.box.sdk.BoxFolder.Info copyFolderById(String fromId,
                                          String toParentId,
                                          String name,
                                          boolean overwrite)
                                   throws BoxSDKException,
                                          BoxConfigurationException

フォルダIDを指定してフォルダをコピーします。

パラメータ:

fromId - コピー元フォルダのフォルダID

toParentId - コピー先フォルダを配置するフォルダのフォルダID

name - コピー先フォルダのフォルダ名

overwrite - コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrue

戻り値:

コピーしたフォルダの情報

例外:

BoxSDKException - フォルダのコピーに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createFolder

void createFolder(String path)
           throws BoxSDKException,
                  BoxConfigurationException

パスを指定してフォルダを作成します。

パラメータ:

path - 作成するフォルダのパス

例外:

BoxSDKException - フォルダの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createFolderById

void createFolderById(String parentId,
                      String name)
               throws BoxSDKException,
                      BoxConfigurationException

作成先のフォルダのIDを指定してフォルダを作成します。

パラメータ:

parentId - 作成するフォルダを配置するフォルダのフォルダID

name - 作成するフォルダのフォルダ名

例外:

BoxSDKException - フォルダの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createMetadata

void createMetadata(String path,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのカスタムメタデータを作成します。

パラメータ:

path - メタデータを作成するファイルのパス

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createMetadata

void createMetadata(String path,
                    String templateName,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。
カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。

パラメータ:

path - メタデータを作成するファイルのパス

templateName - メタデータテンプレート名

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createMetadata

void createMetadata(String path,
                    String templateName,
                    String scope,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを作成します。

パラメータ:

path - メタデータを作成するファイルのパス

templateName - メタデータテンプレート名

scope - メタデータテンプレートのスコープ(globalまたはenterprise)

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createSharedLink

String createSharedLink(String path,
                        String unsharedDate,
                        String access,
                        boolean canDownload,
                        boolean canPreview)
                 throws BoxSDKException,
                        BoxConfigurationException

パスを指定してファイルの共有リンクを作成します。

パラメータ:

path - 共有リンクを作成するファイルのパス

unsharedDate - 共有リンクが無効になる日時を表すISO8601形式の文字列

access - 共有リンクのアクセス権限を表す文字列。OPEN/COLLABORATORS/COMPANY/DEFAULTのいずれか

canDownload - ダウンロードを許可する場合はtrue

canPreview - プレビューを許可する場合はtrue

戻り値:

共有リンクのURLを表す文字列

例外:

BoxSDKException - 共有リンクの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

createSharedLink

String createSharedLink(String path,
                        String unsharedDate,
                        String access,
                        boolean canDownload,
                        boolean canPreview,
                        boolean canEdit,
                        String password)
                 throws BoxSDKException,
                        BoxConfigurationException

パスを指定してファイルの共有リンクを作成します。

パラメータ:

path - 共有リンクを作成するファイルのパス

unsharedDate - 共有リンクが無効になる日時を表すISO8601形式の文字列

access - 共有リンクのアクセス権限を表す文字列。OPEN/COLLABORATORS/COMPANY/DEFAULTのいずれか

canDownload - ダウンロードを許可する場合はtrue

canPreview - プレビューを許可する場合はtrue

canEdit - 編集を許可する場合はtrue

password - 共有リンクのパスワード

戻り値:

共有リンクのURLを表す文字列

例外:

BoxSDKException - 共有リンクの作成に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteCollaboration

void deleteCollaboration(String path,
                         String boxUserId)
                  throws BoxSDKException,
                         BoxConfigurationException

パスを指定してファイルまたはフォルダに対するアクセス権限を削除します。

パラメータ:

path - アクセス権限を削除するファイルまたはフォルダのパス

boxUserId - BoxユーザID

例外:

BoxSDKException - アクセス権限の削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteFile

void deleteFile(String path)
         throws BoxSDKException,
                BoxConfigurationException

パスを指定してファイルを削除します。

パラメータ:

path - 削除するファイルのパス

例外:

BoxSDKException - ファイルの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteFileById

void deleteFileById(String id)
             throws BoxSDKException,
                    BoxConfigurationException

ファイルIDを指定してファイルを削除します。

パラメータ:

id - 削除するファイルのファイルID

例外:

BoxSDKException - ファイルの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteFileRequestInfo

void deleteFileRequestInfo(String id)
                    throws BoxSDKException,
                           BoxConfigurationException

ファイルリクエストを削除します。

パラメータ:

id - ファイルリクエストのID

例外:

BoxSDKException - ファイルリクエストの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteFolder

void deleteFolder(String path,
                  boolean recursive)
           throws BoxSDKException,
                  BoxConfigurationException

パスを指定してフォルダを削除します。

パラメータ:

path - 削除するフォルダのパス

recursive - フォルダ内のファイル/フォルダを再帰的に削除する場合はtrue

例外:

BoxSDKException - フォルダの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteFolderById

void deleteFolderById(String id,
                      boolean recursive)
               throws BoxSDKException,
                      BoxConfigurationException

フォルダIDを指定してフォルダを削除します。

パラメータ:

id - 削除するフォルダのフォルダID

recursive - フォルダ内のファイル/フォルダを再帰的に削除する場合はtrue

例外:

BoxSDKException - フォルダの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteMetadata

void deleteMetadata(String path)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのカスタムメタデータを削除します。

パラメータ:

path - メタデータを削除するファイルのパス

例外:

BoxSDKException - メタデータの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteMetadata

void deleteMetadata(String path,
                    String templateName)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。
カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。

パラメータ:

path - メタデータを削除するファイルのパス

templateName - メタデータテンプレート名

例外:

BoxSDKException - メタデータの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteMetadata

void deleteMetadata(String path,
                    String templateName,
                    String scope)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを削除します。

パラメータ:

path - メタデータを削除するファイルのパス

templateName - メタデータテンプレート名

scope - メタデータテンプレートのスコープ(globalまたはenterprise)

例外:

BoxSDKException - メタデータの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

deleteSharedLink

void deleteSharedLink(String path)
               throws BoxSDKException,
                      BoxConfigurationException

パスを指定してファイルの共有リンクを削除します。

パラメータ:

path - 共有リンクを削除するファイルのパス

例外:

BoxSDKException - 共有リンクの削除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

downloadFile

void downloadFile(String path,
                  OutputStream out)
           throws BoxSDKException,
                  BoxConfigurationException

パスを指定してファイルをダウンロードします。

パラメータ:

path - ダウンロードするファイルのパス

out - ダウンロード先のストリーム

例外:

BoxSDKException - ファイルのダウンロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

downloadFileById

void downloadFileById(String id,
                      OutputStream out)
               throws BoxSDKException,
                      BoxConfigurationException

ファイルIDを指定してファイルをダウンロードします。

パラメータ:

id - ダウンロードするファイルのファイルID

out - ダウンロード先のストリーム

例外:

BoxSDKException - ファイルのダウンロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getClientId

String getClientId()

クライアントIDを返します。

戻り値:

クライアントID

getFileRequestInfo

com.box.sdk.BoxFileRequest.Info getFileRequestInfo(String id)
                                            throws BoxSDKException,
                                                   BoxConfigurationException

ファイルリクエストの情報を取得します。

パラメータ:

id - ファイルリクエストのID

戻り値:

ファイルリクエストの情報

例外:

BoxSDKException - ファイルリクエストの情報の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getInfo

com.box.sdk.BoxItem.Info getInfo(String path)
                          throws BoxSDKException,
                                 BoxConfigurationException

パスを指定してファイルまたはフォルダの情報を取得します。

パラメータ:

path - 情報を取得するファイルまたはフォルダのパス

戻り値:

ファイルまたはフォルダの情報

例外:

BoxSDKException - ファイルまたはフォルダの情報の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getMetadata

Map<String,Object> getMetadata(String path)
                        throws BoxSDKException,
                               BoxConfigurationException

パスを指定してファイルのカスタムメタデータを取得します。

パラメータ:

path - メタデータを取得するファイルのパス

戻り値:

メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getMetadata

Map<String,Object> getMetadata(String path,
                               String templateName)
                        throws BoxSDKException,
                               BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。
カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。

パラメータ:

path - メタデータを取得するファイルのパス

templateName - メタデータテンプレート名

戻り値:

メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getMetadata

Map<String,Object> getMetadata(String path,
                               String templateName,
                               String scope)
                        throws BoxSDKException,
                               BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを取得します。

パラメータ:

path - メタデータを取得するファイルのパス

templateName - メタデータテンプレート名

scope - メタデータテンプレートのスコープ(globalまたはenterprise)

戻り値:

メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getSharedLink

String getSharedLink(String path)
              throws BoxSDKException,
                     BoxConfigurationException

パスを指定してファイルの共有リンクを取得します。

パラメータ:

path - 共有リンクを取得するファイルのパス

戻り値:

共有リンクのURLを表す文字列

例外:

BoxSDKException - 共有リンクの取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

getUserId

String getUserId()

ユーザIDを返します。

戻り値:

ユーザID

getWidgetTag

String getWidgetTag(String url,
                    String view,
                    String sortColumn,
                    String sortDirection,
                    Boolean showParentPath,
                    Boolean showItemFeedActions,
                    int width,
                    int height)
             throws BoxSDKException

Box埋め込みウィジェットのhtmlタグ表現の文字列を取得します。

パラメータ:

url - ファイルまたはフォルダの共有リンクURL

view - ファイルまたはフォルダの表示方法の種類。list/iconのいずれか

sortColumn - ファイルまたはフォルダを並べ替える順番。date/name/sizeのいずれか

sortDirection - ファイルまたはフォルダの並べ替えの方向。ASC/DESCのいずれか

showParentPath - フォルダパスを表示する場合は true

showItemFeedActions - アクティビティフィードを表示する場合は true

width - ウィジェットの幅

戻り値:

height ウィジェットの高さ

例外:

BoxSDKException - 指定されたパラメータに問題がある場合

BoxConfigurationException - Boxの接続設定に問題がある場合

list

List<com.box.sdk.BoxItem.Info> list(String path)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

path - 情報を取得するフォルダのパス

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

list

List<com.box.sdk.BoxItem.Info> list(String path,
                                    boolean recursive)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

path - 情報を取得するフォルダのパス

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

list

List<com.box.sdk.BoxItem.Info> list(String path,
                                    boolean recursive,
                                    java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してフォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

path - 情報を取得するフォルダのパス

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

filter - ファイルまたはフォルダの情報に関するフィルタ条件

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

list

<R> List<R> list(String path,
                 boolean recursive,
                 java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter,
                 java.util.function.BiFunction<com.box.sdk.BoxItem.Info,String,R> mapper)
          throws BoxSDKException,
                 BoxConfigurationException

パスを指定して、フォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報から任意の型に変換した一覧を取得します。

型パラメータ:

R - 任意の型

パラメータ:

path - 情報を取得するフォルダのパス

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

filter - ファイルまたはフォルダの情報に関するフィルタ条件

mapper - ファイルまたはフォルダの情報と、情報を取得するフォルダのパスから任意の型への変換処理

戻り値:

List 任意の型の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

listById

List<com.box.sdk.BoxItem.Info> listById(String id)
                                 throws BoxSDKException,
                                        BoxConfigurationException

フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

id - 情報を取得するフォルダのフォルダID

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

listById

List<com.box.sdk.BoxItem.Info> listById(String id,
                                        boolean recursive)
                                 throws BoxSDKException,
                                        BoxConfigurationException

フォルダIDを指定してフォルダ内のファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

id - 情報を取得するフォルダのフォルダID

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

listById

List<com.box.sdk.BoxItem.Info> listById(String id,
                                        boolean recursive,
                                        java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter)
                                 throws BoxSDKException,
                                        BoxConfigurationException

フォルダIDを指定してフォルダ内のフィルタ条件に一致すファイルまたはフォルダの情報の一覧を取得します。

パラメータ:

id - 情報を取得するフォルダのID

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

filter - ファイルまたはフォルダの情報に関するフィルタ条件

戻り値:

ファイルまたはフォルダの情報の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

listById

<R> List<R> listById(String id,
                     boolean recursive,
                     java.util.function.Predicate<com.box.sdk.BoxItem.Info> filter,
                     java.util.function.BiFunction<com.box.sdk.BoxItem.Info,String,R> mapper)
              throws BoxSDKException,
                     BoxConfigurationException

フォルダIDを指定して、フォルダ内のフィルタ条件に一致するファイルまたはフォルダの情報から任意の型に変換した一覧を取得します。

型パラメータ:

R - 任意の型

パラメータ:

id - 情報を取得するフォルダのID

recursive - サブフォルダ内の情報を再帰的に取得する場合はtrue

filter - ファイルまたはフォルダの情報に関するフィルタ条件

mapper - ファイルまたはフォルダの情報と、情報を取得するフォルダのパスから任意の型への変換処理

戻り値:

List 任意の型の一覧

例外:

BoxSDKException - ファイルまたはフォルダの情報の一覧の取得に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

lockFile

com.box.sdk.BoxLock lockFile(String path)
                      throws BoxSDKException,
                             BoxConfigurationException

パスを指定してファイルをロックします。

パラメータ:

path - ロックするファイルのパス

戻り値:

BoxLock ファイルロック

例外:

BoxSDKException - ファイルのロックに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

lockFile

com.box.sdk.BoxLock lockFile(String path,
                             String expiresAt,
                             boolean isDownloadPrevented)
                      throws BoxSDKException,
                             BoxConfigurationException

パスを指定してファイルをロックします。

パラメータ:

path - ロックするファイルのパス

expiresAt - ロックが無効になる日時を表すISO8601形式の文字列

isDownloadPrevented - ダウンロードも禁止する場合true

戻り値:

BoxLock ファイルロック

例外:

BoxSDKException - ファイルのロックに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

lockFileById

com.box.sdk.BoxLock lockFileById(String id)
                          throws BoxSDKException,
                                 BoxConfigurationException

ファイルIDを指定してファイルをロックします。

パラメータ:

id - ロックするファイルのファイルID

戻り値:

BoxLock ファイルロック

例外:

BoxSDKException - ファイルのロックに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

lockFileById

com.box.sdk.BoxLock lockFileById(String id,
                                 String expiresAt,
                                 boolean isDownloadPrevented)
                          throws BoxSDKException,
                                 BoxConfigurationException

ファイルIDを指定してファイルをロックします。

パラメータ:

id - ロックするファイルのファイルID

expiresAt - ロックの期限となる日時を表すISO8601形式の文字列

isDownloadPrevented - ダウンロードを無効にする場合true

戻り値:

BoxLock ファイルロック

例外:

BoxSDKException - ファイルのロックに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

moveFile

com.box.sdk.BoxItem.Info moveFile(String fromPath,
                                  String toPath)
                           throws BoxSDKException,
                                  BoxConfigurationException

パスを指定してファイルを移動します。

パラメータ:

fromPath - 移動元のファイルのパス

toPath - 移動先のファイルのパス

戻り値:

移動したファイルの情報

例外:

BoxSDKException - ファイルの移動に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

moveFileById

com.box.sdk.BoxItem.Info moveFileById(String fromId,
                                      String toParentId,
                                      String name)
                               throws BoxSDKException,
                                      BoxConfigurationException

ファイルIDを指定してファイルを移動します。

パラメータ:

fromId - 移動元のファイルのファイルID

toParentId - 移動先ファイルを配置するフォルダのフォルダID

name - 移動先ファイルのファイル名

戻り値:

移動したファイルの情報

例外:

BoxSDKException - ファイルの移動に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

moveFolder

com.box.sdk.BoxItem.Info moveFolder(String fromPath,
                                    String toPath)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してフォルダを移動します。

パラメータ:

fromPath - 移動元のフォルダのパス

toPath - 移動先のフォルダのパス

戻り値:

移動したフォルダの情報

例外:

BoxSDKException - フォルダの移動に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

moveFolderById

com.box.sdk.BoxItem.Info moveFolderById(String fromId,
                                        String toParentId,
                                        String name)
                                 throws BoxSDKException,
                                        BoxConfigurationException

フォルダIDを指定してフォルダを移動します。

パラメータ:

fromId - 移動元のファイルのファイルID

toParentId - 移動先ファイルを配置するフォルダのフォルダID

name - 移動先フォルダのフォルダ名

戻り値:

移動したフォルダの情報

例外:

BoxSDKException - フォルダの移動に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

unlockFile

void unlockFile(String path)
         throws BoxSDKException,
                BoxConfigurationException

パスを指定してファイルをロック解除します。

パラメータ:

path - ロック解除するファイルのパス

例外:

BoxSDKException - ファイルのロック解除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

unlockFileById

void unlockFileById(String id)
             throws BoxSDKException,
                    BoxConfigurationException

ファイルIDを指定してファイルをロック解除します。

パラメータ:

id - ロック解除するファイルのファイルID

例外:

BoxSDKException - ファイルのロック解除に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateFileRequestInfo

com.box.sdk.BoxFileRequest.Info updateFileRequestInfo(String id,
                                                      FileRequestInfoParameter info)
                                               throws BoxSDKException,
                                                      BoxConfigurationException

ファイルリクエストの情報を更新します。

パラメータ:

id - ファイルリクエストのID

info - ファイルリクエストの情報を更新する内容

戻り値:

更新したファイルリクエストの情報

例外:

BoxSDKException - ファイルリクエストの情報の更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateInfo

com.box.sdk.BoxFile.Info updateInfo(String path,
                                    com.box.sdk.BoxFile.Info info)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してファイルの情報を更新します。

パラメータ:

path - 更新するファイルのパス

info - 更新するファイルの情報

戻り値:

更新したファイルの情報

例外:

BoxSDKException - ファイルの情報の更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateInfoById

com.box.sdk.BoxFile.Info updateInfoById(String id,
                                        com.box.sdk.BoxFile.Info info)
                                 throws BoxSDKException,
                                        BoxConfigurationException

IDを指定してファイルの情報を更新します。

パラメータ:

id - 更新するファイルのファイルID

info - 更新するファイルの情報

戻り値:

更新したファイルの情報

例外:

BoxSDKException - ファイルの情報の更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateMetadata

void updateMetadata(String path,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのカスタムメタデータを更新します。

パラメータ:

path - メタデータを更新するファイルのパス

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateMetadata

void updateMetadata(String path,
                    String templateName,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。
カスタムメタデータであればglobalスコープ、そうでなければenterpriseスコープとして取り扱います。

パラメータ:

path - メタデータを更新するファイルのパス

templateName - メタデータテンプレート名

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

updateMetadata

void updateMetadata(String path,
                    String templateName,
                    String scope,
                    Map<String,Object> metadata)
             throws BoxSDKException,
                    BoxConfigurationException

パスを指定してファイルのメタデータテンプレートの形式に従ったメタデータを更新します。

パラメータ:

path - メタデータを更新するファイルのパス

templateName - メタデータテンプレート名

scope - メタデータテンプレートのスコープ(globalまたはenterprise)

metadata - メタデータのキー/値のマップ

例外:

BoxSDKException - メタデータの更新に失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

uploadFile

com.box.sdk.BoxFile.Info uploadFile(String path,
                                    InputStream in)
                             throws BoxSDKException,
                                    BoxConfigurationException

パスを指定してファイルをアップロードします。

パラメータ:

path - アップロードする先のファイルのパス

in - アップロード元のストリーム

戻り値:

アップロードしたファイルの情報

例外:

BoxSDKException - ファイルのアップロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

uploadFileById

com.box.sdk.BoxFile.Info uploadFileById(String parentId,
                                        String name,
                                        InputStream in)
                                 throws BoxSDKException,
                                        BoxConfigurationException

ファイルを配置するフォルダのIDを指定してファイルをアップロードします。

パラメータ:

parentId - ファイルを配置するフォルダのフォルダID

name - アップロードするファイルのファイル名

in - アップロード元のストリーム

戻り値:

アップロードしたファイルの情報

例外:

BoxSDKException - ファイルのアップロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

uploadLargeFile

com.box.sdk.BoxFile.Info uploadLargeFile(String path,
                                         InputStream in,
                                         long size)
                                  throws BoxSDKException,
                                         BoxConfigurationException

パスを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。

パラメータ:

path - アップロードする先のファイルのパス

in - アップロード元のストリーム

size - アップロードするファイルのサイズ

戻り値:

アップロードしたファイルの情報

例外:

BoxSDKException - ファイルのアップロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合

uploadLargeFileById

com.box.sdk.BoxFile.Info uploadLargeFileById(String parentId,
                                             String name,
                                             InputStream in,
                                             long size)
                                      throws BoxSDKException,
                                             BoxConfigurationException

ファイルを配置するフォルダのIDを指定してサイズの大きい(20MB以上の)ファイルを分割アップロードします。

パラメータ:

parentId - ファイルを配置するフォルダのフォルダID

name - アップロードするファイルのファイル名

in - アップロード元のストリーム

size - アップロードするファイルのサイズ

戻り値:

アップロードしたファイルの情報

例外:

BoxSDKException - ファイルのアップロードに失敗した場合

BoxConfigurationException - Boxの接続設定に問題がある場合