| Modifier and Type | Method and Description |
|---|---|
static YfyException |
YfyRequestUtil.unexpectedStatus(HttpRequestor.Response response) |
| Modifier and Type | Method and Description |
|---|---|
InputStream |
YfyBaseClient.YfyInternalClient.doDownload(String downloadUrl,
boolean needToken,
YfyProgressListener progressListener) |
InputStream |
YfyBaseClient.YfyInternalClient.doDownload(String downloadUrl,
List<HttpRequestor.Header> headers,
YfyProgressListener progressListener) |
<T> T |
YfyBaseClient.YfyInternalClient.doGet(String path,
Object[] listParams,
Map<String,String> mapParams,
Class<T> tClass) |
static <T> T |
YfyRequestUtil.doGetNoAuth(YfyRequestConfig requestConfig,
String host,
String path,
Map<String,String> params,
List<HttpRequestor.Header> headers,
Class<T> tClass) |
<T> T |
YfyBaseClient.YfyInternalClient.doPost(String path,
Object[] listParams,
YfyArg arg,
Class<T> tClass) |
static <T> T |
YfyRequestUtil.doPostInAuth(YfyRequestConfig requestConfig,
String host,
String path,
Map<String,String> params,
Class<T> tClass)
only use in oauth server, user content-type application/x-www-form-urlencoded
|
static <T> T |
YfyRequestUtil.doPostNoAuth(YfyRequestConfig requestConfig,
String host,
String path,
YfyArg arg,
List<HttpRequestor.Header> headers,
Class<T> tClass)
only use in api server, user content-type application/json
|
YfyFile |
YfyBaseClient.YfyInternalClient.doUpload(String uploadUrl,
InputStream fileStream,
long fileSize,
YfyProgressListener progressListener) |
static <T> T |
YfyRequestUtil.finishResponse(HttpRequestor.Response response,
Class<T> tClass) |
| Modifier and Type | Method and Description |
|---|---|
AdminDepartmentUserResult |
YfyAdminDepartmentRequest.getDepartmentUsers(long departmentId,
String queryWords,
int pageId)
Retrieve detailed members info of the department
|
| Modifier and Type | Method and Description |
|---|---|
AdminGroupListResult |
YfyAdminGroupRequest.getGroupList(String queryWords,
int pageId)
Retrieve detailed groups info
|
| Modifier and Type | Method and Description |
|---|---|
YfyMappingDepartment |
YfyAdminPlatformRequest.getMappingDepartment(long platformId,
long yfyDepartmentId)
get a mapping department's information
|
YfyMappingDepartment |
YfyAdminPlatformRequest.getMappingDepartment(long platformId,
String departmentId)
get a mapping department's information
|
YfyMappingGroup |
YfyAdminPlatformRequest.getMappingGroup(long platformId,
long yfyGroupId)
get a mapping group's information
|
YfyMappingGroup |
YfyAdminPlatformRequest.getMappingGroup(long platformId,
String groupId)
get a mapping group's information
|
YfyDetailedUser |
YfyAdminPlatformRequest.getMappingUser(long platformId,
long yfyUserId)
get a mapping user's information
|
YfyDetailedUser |
YfyAdminPlatformRequest.getMappingUser(long platformId,
String userId)
get a mapping user's information
|
| Modifier and Type | Method and Description |
|---|---|
SuccessResult |
YfyAdminUserRequest.deleteUser(long userId,
Long receiveUserId)
Delete a user with handing over files.
|
GetUserLoginParamsResult |
YfyAdminUserRequest.getUserLoginParams(String identifier,
IdentifierTypeEnum identifierType) |
GetUserLoginUrlResult |
YfyAdminUserRequest.getUserLoginUrl(String identifier,
IdentifierTypeEnum identifierType) |
| Modifier and Type | Method and Description |
|---|---|
SuccessResult |
YfyCollabRequest.deleteCollab(long collabId)
Delete collab by collab id
|
YfyCollab |
YfyCollabRequest.getCollab(long collabId)
Retrieve detailed collab information
|
YfyCollab |
YfyCollabRequest.inviteCollab(long folderId,
AccessibleByTypeEnum accessibleByType,
long accessibleById,
CollabRoleEnum collabRole,
String invitationMessage)
Invite a user to a specific folder
|
YfyCollab |
YfyCollabRequest.updateCollab(long collabId,
CollabRoleEnum collabRole)
Update a collab role by collab id
|
| Modifier and Type | Method and Description |
|---|---|
YfyComment |
YfyCommentRequest.createComment(long fileId,
String content)
Create comment on a file
|
SuccessResult |
YfyCommentRequest.deleteComment(long commentId)
Delete comment by comment id
|
| Modifier and Type | Method and Description |
|---|---|
YfyDepartment |
YfyDepartmentRequest.getDepartment(long departmentId)
Retrieve detailed department information
|
DepartmentChildrenResult |
YfyDepartmentRequest.getDepartmentChildren(long departmentId,
boolean permissionFilter)
Retrieve department children
|
| Modifier and Type | Method and Description |
|---|---|
YfyFile |
YfyFileRequest.copyFile(long fileId,
long targetFolderId)
Copy the specific file to a folder
|
SuccessResult |
YfyFileRequest.deleteFile(long fileId)
Discard a file to the trash
|
SuccessResult |
YfyFileRequest.deleteFileFromTrash(long fileId)
Permanently delete a specific file that is in the trash.
|
void |
YfyFileRequest.directDownloadFile(long fileId,
String savePath)
Combine the
YfyFileRequest.preSignatureDownload(long)
and YfyFileRequest.downloadFile(String,String) method, direct download the file |
InputStream |
YfyFileRequest.directDownloadFileStream(long fileId)
Combine the
YfyFileRequest.preSignatureDownload(long)
and YfyFileRequest.downloadFile(String,String) method, direct get a InputStream of the file |
YfyFile |
YfyFileRequest.directUploadFile(long parentId,
String name,
InputStream fileStream)
Combine the
this#preSignatureUpload(long, String)
and this#uploadFile(String,InputStream) method, direct upload the file |
YfyFile |
YfyFileRequest.directUploadFile(long parentId,
String name,
String filePath)
Combine the
this#preSignatureUpload(long, String)
and this#uploadFile(String,InputStream) method, direct upload the file |
YfyFile |
YfyFileRequest.directUploadNewVersionFile(long fileId,
String name,
String remark,
InputStream fileStream)
Combine the
this#newVersionPreSignatureUpload(long,String,String)
and this#uploadFile(String,InputStream) method, direct upload the new version file |
YfyFile |
YfyFileRequest.directUploadNewVersionFile(long fileId,
String name,
String remark,
String filePath)
Combine the
this#newVersionPreSignatureUpload(long,String,String)
and this#uploadFile(String,InputStream) method, direct upload the new version file |
void |
YfyFileRequest.downloadFile(String downloadUrl,
String savePath)
When get a file download url, use this method to save the file to the certain path
|
void |
YfyFileRequest.downloadFile(String downloadUrl,
String savePath,
YfyProgressListener progressListener)
When get a file download url, use this method to save the file to the certain path
|
InputStream |
YfyFileRequest.downloadFileStream(String downloadUrl)
When get a file download url, use this method to get a InputStream of the file
|
InputStream |
YfyFileRequest.downloadFileStream(String downloadUrl,
YfyProgressListener progressListener)
When get a file download url, use this method to get a InputStream of the file
|
YfyFile |
YfyFileRequest.getFile(long fileId)
Retrieve file info
|
YfyFileVersion |
YfyFileRequest.getFileVersion(long fileId,
long fileVersionId)
List file's version's information
|
String |
YfyFileRequest.getPreviewUrl(long fileId,
int period)
get file's preview url
|
String |
YfyFileRequest.getPreviewUrl(long fileId,
long fileVersionId,
int period)
get fileVersion's preview url
|
ListCommentResult |
YfyFileRequest.listComment(long fileId)
List file's all comments' information
|
ListShareLinkResult |
YfyFileRequest.listShareLink(long fileId,
int pageId)
List share links of a file
|
ListShareLinkResult |
YfyFileRequest.listShareLink(long fileId,
int pageId,
long ownerId)
List file's share links created by specific owner
|
ListFileVersionsResult |
YfyFileRequest.listVersions(long fileId)
List file's all versions' information
|
SuccessResult |
YfyFileRequest.moveFile(long fileId,
long targetFolderId)
Move a file to another folder
|
String |
YfyFileRequest.newVersionPreSignatureUpload(long fileId,
String name,
String remark)
Get the new version file upload url, then use the url to upload new version file.
|
String |
YfyFileRequest.preSignatureDownload(long fileId)
Get file download url, then use the url to download file.
|
String |
YfyFileRequest.preSignatureUpload(long parentId,
String name)
Get the file upload url, then use the url to upload file.
|
SuccessResult |
YfyFileRequest.restoreFileFromTrash(long fileId)
Restore a file that has been moved to the trash.
|
YfyFile |
YfyFileRequest.updateFile(long fileId,
String newName,
String newDescription)
Update fields in file, including file name and file description
|
YfyFile |
YfyFileRequest.uploadFile(String uploadUrl,
InputStream fileStream)
When get a file upload url, use this method to upload the file to the server
(note that real file name used name in pre signature arg)
|
YfyFile |
YfyFileRequest.uploadFile(String uploadUrl,
InputStream fileStream,
long fileSize,
YfyProgressListener progressListener)
When get a file upload url, use this method to upload the file to the server
(note that real file name used name in pre signature arg)
|
YfyFile |
YfyFileRequest.uploadFile(String uploadUrl,
String filePath)
When get a file upload url, use this method to upload the file to the server
(note that real file name used name in pre signature arg)
|
YfyFile |
YfyFileRequest.uploadFile(String uploadUrl,
String filePath,
long fileSize,
YfyProgressListener progressListener)
When get a file upload url, use this method to upload the file to the server
(note that real file name used name in pre signature arg)
|
| Modifier and Type | Method and Description |
|---|---|
YfyFolder |
YfyFolderRequest.createFolder(String name,
long parentId)
Create a new empty folder inside the specified parent folder in the personal space
|
YfyFolder |
YfyFolderRequest.createFolder(String name,
long parentId,
Long departmentId)
Create a new empty folder inside the specified parent folder in the department space
|
SuccessResult |
YfyFolderRequest.deleteFolder(long folderId)
Delete a folder to trash
|
SuccessResult |
YfyFolderRequest.deleteFolderFromTrash(long folderId)
Permanently delete a specific folder that is in the trash.
|
GetChildrenResult |
YfyFolderRequest.getChildren(long folderId,
int pageId,
int pageCapacity,
ItemTypeEnum itemType)
Retrieve the files and/or folders contained within this folder without any other info about the folder.
|
GetCollabFoldersResult |
YfyFolderRequest.getCollabFolders(int pageId,
int pageCapacity)
Retrieve the folders that have collaboration with you.
|
GetChildrenResult |
YfyFolderRequest.getDepartmentFolders(long departmentId,
int pageId,
int pageCapacity,
ItemTypeEnum itemType)
Retrieve the files and/or folders contained in department space.
|
YfyFolder |
YfyFolderRequest.getFolder(long folderId)
Retrieve detailed information about a folder
|
GetChildrenResult |
YfyFolderRequest.getPersonalItems(int pageId,
int pageCapacity,
ItemTypeEnum itemType)
Retrieve the files and/or folders contained in personal space.
|
ListCollabResult |
YfyFolderRequest.listCollab(long folderId)
List specific folder's all collab relationships
|
ListShareLinkResult |
YfyFolderRequest.listShareLink(long folderId,
int pageId)
List share links of a folder
|
ListShareLinkResult |
YfyFolderRequest.listShareLink(long folderId,
int pageId,
long ownerId)
List folder's share links created by specific owner
|
SuccessResult |
YfyFolderRequest.moveFolder(long folderId,
long targetFolderId)
Move a folder to another folder
|
SuccessResult |
YfyFolderRequest.restoreFolderFromTrash(long folderId)
Restore a specific folder that have been moved to the trash.
|
YfyFolder |
YfyFolderRequest.updateFolder(long folderId,
String newName)
Update the name of the folder
|
| Modifier and Type | Method and Description |
|---|---|
SearchItemResult |
YfyItemRequest.searchItem(String queryWords,
ItemTypeEnum itemType,
QueryFilterEnum queryFilter,
int pageId,
long searchInFolder)
Retrieve relevant files and/or folders with query words in user's account.
|
| Modifier and Type | Method and Description |
|---|---|
YfyShareLink |
YfyShareLinkRequest.createFileShareLink(long fileId,
ShareLinkAccessEnum access,
boolean disableDownload,
String dueTime,
String password)
Create file share link with all personal params.
|
YfyShareLink |
YfyShareLinkRequest.createFolderShareLink(long folderId,
ShareLinkAccessEnum access,
boolean disableDownload,
String dueTime,
String password)
Create folder share link with all personal params.
|
YfyShareLink |
YfyShareLinkRequest.getShareLink(String uniqueName)
Retrieve share link info by unique name
|
YfyShareLink |
YfyShareLinkRequest.getShareLink(String uniqueName,
String password)
Retrieve share link info by unique name
|
SuccessResult |
YfyShareLinkRequest.revokeShareLink(String uniqueName)
Revoke share link by unique name
|
YfyShareLink |
YfyShareLinkRequest.updateShareLink(String uniqueName,
ShareLinkAccessEnum access,
boolean disableDownload,
String dueTime,
String password)
Update folder share link with all personal params.
|
| Modifier and Type | Method and Description |
|---|---|
SuccessResult |
YfyTrashRequest.clearTrash(ItemTypeEnum itemType)
Permanently delete all items(file or folder or all) in trash
|
SuccessResult |
YfyTrashRequest.restoreTrash(ItemTypeEnum itemType)
Restore all items(file or folder or all) in trash
|
| Modifier and Type | Method and Description |
|---|---|
void |
YfyUserRequest.downloadProfilePic(long userId,
String profilePicKey,
String savePath)
Download the specific user profile picture
|
YfyUser |
YfyUserRequest.getSelf()
Retrieve detailed self user information
|
YfyUser |
YfyUserRequest.getUser(long userId)
Retrieve detailed user information
|
SearchUserResult |
YfyUserRequest.searchUser(String queryWords,
int pageId)
Search user in the same enterprise with query key word
|
YfyUser |
YfyUserRequest.updateSelf(String name)
Update self user information
|
| Modifier and Type | Method and Description |
|---|---|
YfyAuthFinish |
YfyWebAuth.finishFromCode(String code)
Call this after the user has visited the authorization URL and copy/pasted the authorization
code that Fangcloud gave them.
|
YfyAuthFinish |
YfyWebAuth.finishFromRedirect(String redirectUri,
YfySessionStore sessionStore,
Map<String,String[]> params)
Call this after the user has visited the authorization URL and Fangcloud has redirected them
back to you at the redirect URI.
|
YfyAuthFinish |
YfyEnterpriseAuth.getEnterpriseToken(long enterpriseId)
Get the enterprise token witch can used to invoke admin api,such as managing departments and groups
|
YfyAuthFinish |
YfyEnterpriseAuth.getEnterpriseToken(long enterpriseId,
int expirationTimeSeconds)
Get the enterprise token witch can used to invoke admin api,such as managing departments and groups
|
YfyAuthFinish |
YfyEnterpriseAuth.getUserToken(long userId)
Get the user token witch can used to invoke personal api,such as get folder information
|
YfyAuthFinish |
YfyEnterpriseAuth.getUserToken(long userId,
int expirationTimeSeconds)
Get the user token witch can used to invoke personal api,such as get folder information
|
YfyAuthFinish |
YfyWebAuth.passwordLogin(String username,
String password)
The method is used by password model user, the user is not the Fangcloud user.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BadResponseException
Thrown when we the response from the Fangcloud server isn't something we expect.
|
class |
ClientValidationException
Some client validation to avoid wrong parameter
|
class |
InvalidTokenException
User token is invalid
|
class |
NeedAuthorizationException
The exception suggest the user need to authorise
|
class |
NetworkIOException
This gets thrown when there's an
IOException when reading or writing to the
network (when communicating with the Fangcloud API servers). |
class |
NormalException
Normal exception usually cased by wrong resource, like wrong permission
|
class |
OtherErrorException
Other error exception, return by other server, like upload and download server
|
class |
RateLimitException
The app has exceeded request limit in a time slot
|
class |
ServerException
Server side exception usually caused by server bug, report to us
|
Copyright © 2018 YiFangYun. All rights reserved.