public interface BoxClient extends Serializable
修飾子とタイプ | フィールドと説明 |
---|---|
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以上の)ファイルを分割アップロードします。
|
Iterable<com.box.sdk.BoxUser.Info> getAllEnterpriseUsers() throws BoxSDKException
BoxSDKException
String getItemId(String path) throws BoxSDKException, BoxConfigurationException
path
- ファイルまたはフォルダパスBoxSDKException
BoxConfigurationException
void addOrUpdateCollaboration(String path, String boxUserId, String accessLevel) throws BoxSDKException, BoxConfigurationException
path
- アクセス権限を操作するファイルまたはフォルダのパスboxUserId
- BoxユーザIDaccessLevel
- アクセスの権限レベルの文字列。CO_OWNER/EDITOR/VIEWER_UPLOADER/PREVIEWER_UPLOADER/VIEWER/PREVIEWER/UPLOADERのいずれかBoxSDKException
- アクセス権限の追加または更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info copyFile(String fromPath, String toPath, boolean overwrite) throws BoxSDKException, BoxConfigurationException
fromPath
- コピー元ファイルのパスtoPath
- コピー先ファイルのパスoverwrite
- コピー先に同名ファイルが存在するとき、上書きする場合はtrueBoxSDKException
- ファイルのコピーに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info copyFileById(String fromId, String toParentId, String name, boolean overwrite) throws BoxSDKException, BoxConfigurationException
fromId
- コピー元ファイルのファイルIDtoParentId
- コピー先ファイルを配置するフォルダのフォルダIDname
- コピー先ファイルのファイル名overwrite
- コピー先に同名ファイルが存在するとき、上書きする場合はtrueBoxSDKException
- ファイルのコピーに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFileRequest.Info copyFileRequestInfo(String id, String folderPath, FileRequestInfoParameter info) throws BoxSDKException, BoxConfigurationException
id
- ファイルリクエストのIDfolderPath
- ファイルリクエストをコピーする先のフォルダのパスinfo
- ファイルリクエストの情報を更新する内容BoxSDKException
- ファイルリクエストのコピーに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFolder.Info copyFolder(String fromPath, String toPath, boolean overwrite) throws BoxSDKException, BoxConfigurationException
fromPath
- コピー元フォルダのパスtoPath
- コピー先フォルダのパスoverwrite
- コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrueBoxSDKException
- フォルダのコピーに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFolder.Info copyFolderById(String fromId, String toParentId, String name, boolean overwrite) throws BoxSDKException, BoxConfigurationException
fromId
- コピー元フォルダのフォルダIDtoParentId
- コピー先フォルダを配置するフォルダのフォルダIDname
- コピー先フォルダのフォルダ名overwrite
- コピー先フォルダ内に同名ファイルが存在するとき、上書きする場合はtrueBoxSDKException
- フォルダのコピーに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void createFolder(String path) throws BoxSDKException, BoxConfigurationException
path
- 作成するフォルダのパスBoxSDKException
- フォルダの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void createFolderById(String parentId, String name) throws BoxSDKException, BoxConfigurationException
parentId
- 作成するフォルダを配置するフォルダのフォルダIDname
- 作成するフォルダのフォルダ名BoxSDKException
- フォルダの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void createMetadata(String path, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを作成するファイルのパスmetadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void createMetadata(String path, String templateName, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを作成するファイルのパスtemplateName
- メタデータテンプレート名metadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void createMetadata(String path, String templateName, String scope, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを作成するファイルのパスtemplateName
- メタデータテンプレート名scope
- メタデータテンプレートのスコープ(globalまたはenterprise)metadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合String createSharedLink(String path, String unsharedDate, String access, boolean canDownload, boolean canPreview) throws BoxSDKException, BoxConfigurationException
path
- 共有リンクを作成するファイルのパスunsharedDate
- 共有リンクが無効になる日時を表すISO8601形式の文字列access
- 共有リンクのアクセス権限を表す文字列。OPEN/COLLABORATORS/COMPANY/DEFAULTのいずれかcanDownload
- ダウンロードを許可する場合はtruecanPreview
- プレビューを許可する場合はtrueBoxSDKException
- 共有リンクの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合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
- ダウンロードを許可する場合はtruecanPreview
- プレビューを許可する場合はtruecanEdit
- 編集を許可する場合はtruepassword
- 共有リンクのパスワードBoxSDKException
- 共有リンクの作成に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteCollaboration(String path, String boxUserId) throws BoxSDKException, BoxConfigurationException
path
- アクセス権限を削除するファイルまたはフォルダのパスboxUserId
- BoxユーザIDBoxSDKException
- アクセス権限の削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteFile(String path) throws BoxSDKException, BoxConfigurationException
path
- 削除するファイルのパスBoxSDKException
- ファイルの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteFileById(String id) throws BoxSDKException, BoxConfigurationException
id
- 削除するファイルのファイルIDBoxSDKException
- ファイルの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteFileRequestInfo(String id) throws BoxSDKException, BoxConfigurationException
id
- ファイルリクエストのIDBoxSDKException
- ファイルリクエストの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteFolder(String path, boolean recursive) throws BoxSDKException, BoxConfigurationException
path
- 削除するフォルダのパスrecursive
- フォルダ内のファイル/フォルダを再帰的に削除する場合はtrueBoxSDKException
- フォルダの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteFolderById(String id, boolean recursive) throws BoxSDKException, BoxConfigurationException
id
- 削除するフォルダのフォルダIDrecursive
- フォルダ内のファイル/フォルダを再帰的に削除する場合はtrueBoxSDKException
- フォルダの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteMetadata(String path) throws BoxSDKException, BoxConfigurationException
path
- メタデータを削除するファイルのパスBoxSDKException
- メタデータの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteMetadata(String path, String templateName) throws BoxSDKException, BoxConfigurationException
path
- メタデータを削除するファイルのパスtemplateName
- メタデータテンプレート名BoxSDKException
- メタデータの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteMetadata(String path, String templateName, String scope) throws BoxSDKException, BoxConfigurationException
path
- メタデータを削除するファイルのパスtemplateName
- メタデータテンプレート名scope
- メタデータテンプレートのスコープ(globalまたはenterprise)BoxSDKException
- メタデータの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void deleteSharedLink(String path) throws BoxSDKException, BoxConfigurationException
path
- 共有リンクを削除するファイルのパスBoxSDKException
- 共有リンクの削除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void downloadFile(String path, OutputStream out) throws BoxSDKException, BoxConfigurationException
path
- ダウンロードするファイルのパスout
- ダウンロード先のストリームBoxSDKException
- ファイルのダウンロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void downloadFileById(String id, OutputStream out) throws BoxSDKException, BoxConfigurationException
id
- ダウンロードするファイルのファイルIDout
- ダウンロード先のストリームBoxSDKException
- ファイルのダウンロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合String getClientId()
com.box.sdk.BoxFileRequest.Info getFileRequestInfo(String id) throws BoxSDKException, BoxConfigurationException
id
- ファイルリクエストのIDBoxSDKException
- ファイルリクエストの情報の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxItem.Info getInfo(String path) throws BoxSDKException, BoxConfigurationException
path
- 情報を取得するファイルまたはフォルダのパスBoxSDKException
- ファイルまたはフォルダの情報の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合Map<String,Object> getMetadata(String path) throws BoxSDKException, BoxConfigurationException
path
- メタデータを取得するファイルのパスBoxSDKException
- メタデータの取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合Map<String,Object> getMetadata(String path, String templateName) throws BoxSDKException, BoxConfigurationException
path
- メタデータを取得するファイルのパスtemplateName
- メタデータテンプレート名BoxSDKException
- メタデータの取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合Map<String,Object> getMetadata(String path, String templateName, String scope) throws BoxSDKException, BoxConfigurationException
path
- メタデータを取得するファイルのパスtemplateName
- メタデータテンプレート名scope
- メタデータテンプレートのスコープ(globalまたはenterprise)BoxSDKException
- メタデータの取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合String getSharedLink(String path) throws BoxSDKException, BoxConfigurationException
path
- 共有リンクを取得するファイルのパスBoxSDKException
- 共有リンクの取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合String getUserId()
String getWidgetTag(String url, String view, String sortColumn, String sortDirection, Boolean showParentPath, Boolean showItemFeedActions, int width, int height) throws BoxSDKException
url
- ファイルまたはフォルダの共有リンクURLview
- ファイルまたはフォルダの表示方法の種類。list/iconのいずれかsortColumn
- ファイルまたはフォルダを並べ替える順番。date/name/sizeのいずれかsortDirection
- ファイルまたはフォルダの並べ替えの方向。ASC/DESCのいずれかshowParentPath
- フォルダパスを表示する場合は trueshowItemFeedActions
- アクティビティフィードを表示する場合は truewidth
- ウィジェットの幅BoxSDKException
- 指定されたパラメータに問題がある場合BoxConfigurationException
- Boxの接続設定に問題がある場合List<com.box.sdk.BoxItem.Info> list(String path) throws BoxSDKException, BoxConfigurationException
path
- 情報を取得するフォルダのパスBoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合List<com.box.sdk.BoxItem.Info> list(String path, boolean recursive) throws BoxSDKException, BoxConfigurationException
path
- 情報を取得するフォルダのパスrecursive
- サブフォルダ内の情報を再帰的に取得する場合はtrueBoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合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
- サブフォルダ内の情報を再帰的に取得する場合はtruefilter
- ファイルまたはフォルダの情報に関するフィルタ条件BoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合<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
- サブフォルダ内の情報を再帰的に取得する場合はtruefilter
- ファイルまたはフォルダの情報に関するフィルタ条件mapper
- ファイルまたはフォルダの情報と、情報を取得するフォルダのパスから任意の型への変換処理BoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合List<com.box.sdk.BoxItem.Info> listById(String id) throws BoxSDKException, BoxConfigurationException
id
- 情報を取得するフォルダのフォルダIDBoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合List<com.box.sdk.BoxItem.Info> listById(String id, boolean recursive) throws BoxSDKException, BoxConfigurationException
id
- 情報を取得するフォルダのフォルダIDrecursive
- サブフォルダ内の情報を再帰的に取得する場合はtrueBoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合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
- 情報を取得するフォルダのIDrecursive
- サブフォルダ内の情報を再帰的に取得する場合はtruefilter
- ファイルまたはフォルダの情報に関するフィルタ条件BoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合<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
R
- 任意の型id
- 情報を取得するフォルダのIDrecursive
- サブフォルダ内の情報を再帰的に取得する場合はtruefilter
- ファイルまたはフォルダの情報に関するフィルタ条件mapper
- ファイルまたはフォルダの情報と、情報を取得するフォルダのパスから任意の型への変換処理BoxSDKException
- ファイルまたはフォルダの情報の一覧の取得に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxLock lockFile(String path) throws BoxSDKException, BoxConfigurationException
path
- ロックするファイルのパスBoxSDKException
- ファイルのロックに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxLock lockFile(String path, String expiresAt, boolean isDownloadPrevented) throws BoxSDKException, BoxConfigurationException
path
- ロックするファイルのパスexpiresAt
- ロックが無効になる日時を表すISO8601形式の文字列isDownloadPrevented
- ダウンロードも禁止する場合trueBoxSDKException
- ファイルのロックに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxLock lockFileById(String id) throws BoxSDKException, BoxConfigurationException
id
- ロックするファイルのファイルIDBoxSDKException
- ファイルのロックに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxLock lockFileById(String id, String expiresAt, boolean isDownloadPrevented) throws BoxSDKException, BoxConfigurationException
id
- ロックするファイルのファイルIDexpiresAt
- ロックの期限となる日時を表すISO8601形式の文字列isDownloadPrevented
- ダウンロードを無効にする場合trueBoxSDKException
- ファイルのロックに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxItem.Info moveFile(String fromPath, String toPath) throws BoxSDKException, BoxConfigurationException
fromPath
- 移動元のファイルのパスtoPath
- 移動先のファイルのパスBoxSDKException
- ファイルの移動に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxItem.Info moveFileById(String fromId, String toParentId, String name) throws BoxSDKException, BoxConfigurationException
fromId
- 移動元のファイルのファイルIDtoParentId
- 移動先ファイルを配置するフォルダのフォルダIDname
- 移動先ファイルのファイル名BoxSDKException
- ファイルの移動に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxItem.Info moveFolder(String fromPath, String toPath) throws BoxSDKException, BoxConfigurationException
fromPath
- 移動元のフォルダのパスtoPath
- 移動先のフォルダのパスBoxSDKException
- フォルダの移動に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxItem.Info moveFolderById(String fromId, String toParentId, String name) throws BoxSDKException, BoxConfigurationException
fromId
- 移動元のファイルのファイルIDtoParentId
- 移動先ファイルを配置するフォルダのフォルダIDname
- 移動先フォルダのフォルダ名BoxSDKException
- フォルダの移動に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void unlockFile(String path) throws BoxSDKException, BoxConfigurationException
path
- ロック解除するファイルのパスBoxSDKException
- ファイルのロック解除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void unlockFileById(String id) throws BoxSDKException, BoxConfigurationException
id
- ロック解除するファイルのファイルIDBoxSDKException
- ファイルのロック解除に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFileRequest.Info updateFileRequestInfo(String id, FileRequestInfoParameter info) throws BoxSDKException, BoxConfigurationException
id
- ファイルリクエストのIDinfo
- ファイルリクエストの情報を更新する内容BoxSDKException
- ファイルリクエストの情報の更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info updateInfo(String path, com.box.sdk.BoxFile.Info info) throws BoxSDKException, BoxConfigurationException
path
- 更新するファイルのパスinfo
- 更新するファイルの情報BoxSDKException
- ファイルの情報の更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info updateInfoById(String id, com.box.sdk.BoxFile.Info info) throws BoxSDKException, BoxConfigurationException
id
- 更新するファイルのファイルIDinfo
- 更新するファイルの情報BoxSDKException
- ファイルの情報の更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void updateMetadata(String path, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを更新するファイルのパスmetadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void updateMetadata(String path, String templateName, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを更新するファイルのパスtemplateName
- メタデータテンプレート名metadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合void updateMetadata(String path, String templateName, String scope, Map<String,Object> metadata) throws BoxSDKException, BoxConfigurationException
path
- メタデータを更新するファイルのパスtemplateName
- メタデータテンプレート名scope
- メタデータテンプレートのスコープ(globalまたはenterprise)metadata
- メタデータのキー/値のマップBoxSDKException
- メタデータの更新に失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info uploadFile(String path, InputStream in) throws BoxSDKException, BoxConfigurationException
path
- アップロードする先のファイルのパスin
- アップロード元のストリームBoxSDKException
- ファイルのアップロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info uploadFileById(String parentId, String name, InputStream in) throws BoxSDKException, BoxConfigurationException
parentId
- ファイルを配置するフォルダのフォルダIDname
- アップロードするファイルのファイル名in
- アップロード元のストリームBoxSDKException
- ファイルのアップロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info uploadLargeFile(String path, InputStream in, long size) throws BoxSDKException, BoxConfigurationException
path
- アップロードする先のファイルのパスin
- アップロード元のストリームsize
- アップロードするファイルのサイズBoxSDKException
- ファイルのアップロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合com.box.sdk.BoxFile.Info uploadLargeFileById(String parentId, String name, InputStream in, long size) throws BoxSDKException, BoxConfigurationException
parentId
- ファイルを配置するフォルダのフォルダIDname
- アップロードするファイルのファイル名in
- アップロード元のストリームsize
- アップロードするファイルのサイズBoxSDKException
- ファイルのアップロードに失敗した場合BoxConfigurationException
- Boxの接続設定に問題がある場合Copyright © 2012 NTT DATA INTRAMART CORPORATION