com.fangcloud.sdk.api.folder

Class YfyFolderRequest

java.lang.Object

com.fangcloud.sdk.api.folder.YfyFolderRequest

public class YfyFolderRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
YfyFolderRequest(YfyBaseClient.YfyInternalClient client)

Method Summary

Methods

Modifier and Type	Method and Description
YfyFolder	createFolder(String name, long parentId) Create a new empty folder inside the specified parent folder in the personal space
YfyFolder	createFolder(String name, long parentId, Long departmentId) Create a new empty folder inside the specified parent folder in the department space
SuccessResult	deleteFolder(long folderId) Delete a folder to trash
SuccessResult	deleteFolderFromTrash(long folderId) Permanently delete a specific folder that is in the trash.
GetChildrenResult	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	getCollabFolders(int pageId, int pageCapacity) Retrieve the folders that have collaboration with you.
GetChildrenResult	getDepartmentFolders(long departmentId, int pageId, int pageCapacity, ItemTypeEnum itemType) Retrieve the files and/or folders contained in department space.
YfyFolder	getFolder(long folderId) Retrieve detailed information about a folder
GetChildrenResult	getPersonalItems(int pageId, int pageCapacity, ItemTypeEnum itemType) Retrieve the files and/or folders contained in personal space.
ListCollabResult	listCollab(long folderId) List specific folder's all collab relationships
ListShareLinkResult	listShareLink(long folderId, int pageId) List share links of a folder
ListShareLinkResult	listShareLink(long folderId, int pageId, long ownerId) List folder's share links created by specific owner
SuccessResult	moveFolder(long folderId, long targetFolderId) Move a folder to another folder
SuccessResult	restoreFolderFromTrash(long folderId) Restore a specific folder that have been moved to the trash.
YfyFolder	updateFolder(long folderId, String newName) Update the name of the folder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

YfyFolderRequest

public YfyFolderRequest(YfyBaseClient.YfyInternalClient client)

Method Detail

getFolder

public YfyFolder getFolder(long folderId)
                    throws YfyException

Retrieve detailed information about a folder

Parameters:

folderId - Folder id in fangcloud

Returns:

Detailed folder's information

Throws:

YfyException

createFolder

public YfyFolder createFolder(String name,
                     long parentId)
                       throws YfyException

Create a new empty folder inside the specified parent folder in the personal space

Parameters:

name - New folder name

parentId - New folder's parent id in fangcloud

Returns:

Detailed new folder's information

Throws:

YfyException

createFolder

public YfyFolder createFolder(String name,
                     long parentId,
                     Long departmentId)
                       throws YfyException

Create a new empty folder inside the specified parent folder in the department space

Parameters:

name - New folder name

parentId - New folder's parent id in fangcloud

departmentId - New folder's department id in fangcloud(only effect when parent id is 0)

Returns:

Detailed new folder's information

Throws:

YfyException

updateFolder

public YfyFolder updateFolder(long folderId,
                     String newName)
                       throws YfyException

Update the name of the folder

Parameters:

folderId - Folder id in fangcloud

newName - New name of the folder

Returns:

Detailed folder's information

Throws:

YfyException

deleteFolder

public SuccessResult deleteFolder(long folderId)
                           throws YfyException

Delete a folder to trash

Parameters:

folderId - Folder id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

deleteFolderFromTrash

public SuccessResult deleteFolderFromTrash(long folderId)
                                    throws YfyException

Permanently delete a specific folder that is in the trash. The folder will no longer exist in fangcloud. This action cannot be undone.

Parameters:

folderId - Folder id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

restoreFolderFromTrash

public SuccessResult restoreFolderFromTrash(long folderId)
                                     throws YfyException

Restore a specific folder that have been moved to the trash. Default behavior is to restore the folder to the parent folder it was in before it was moved to the trash

Parameters:

folderId - Folder id in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

moveFolder

public SuccessResult moveFolder(long folderId,
                       long targetFolderId)
                         throws YfyException

Move a folder to another folder

Parameters:

folderId - Folder id in fangcloud

targetFolderId - Folder id of the destination folder in fangcloud

Returns:

An object only has one attribute named success

Throws:

YfyException

getChildren

public GetChildrenResult getChildren(long folderId,
                            int pageId,
                            int pageCapacity,
                            ItemTypeEnum itemType)
                              throws YfyException

Retrieve the files and/or folders contained within this folder without any other info about the folder. The requests need paging param assigned by developer.

Parameters:

folderId - Folder id in fangcloud

pageId - Page id begin with 0

pageCapacity - Files and/or folders' list size once return

itemType - Type of item. see ItemTypeEnum

Returns:

Object contains two lists named "folders" and "files", and other page information

Throws:

YfyException

getPersonalItems

public GetChildrenResult getPersonalItems(int pageId,
                                 int pageCapacity,
                                 ItemTypeEnum itemType)
                                   throws YfyException

Retrieve the files and/or folders contained in personal space. The requests need paging param assigned by developer.

Parameters:

pageId - Page id begin with 0

pageCapacity - Files and/or folders' list size once return

itemType - Type of item. see ItemTypeEnum

Returns:

Object contains two lists named "folders" and "files", and other page information

Throws:

YfyException

getDepartmentFolders

public GetChildrenResult getDepartmentFolders(long departmentId,
                                     int pageId,
                                     int pageCapacity,
                                     ItemTypeEnum itemType)
                                       throws YfyException

Retrieve the files and/or folders contained in department space. The requests need paging param assigned by developer.

Parameters:

departmentId - department id in Fangcloud

pageId - Page id begin with 0

pageCapacity - Files and/or folders' list size once return

itemType - Type of item. see ItemTypeEnum

Returns:

Object contains two lists named "folders" and "files", and other page information

Throws:

YfyException

getCollabFolders

public GetCollabFoldersResult getCollabFolders(int pageId,
                                      int pageCapacity)
                                        throws YfyException

Retrieve the folders that have collaboration with you. The requests need paging param assigned by developer.

Parameters:

pageId - Page id begin with 0

pageCapacity - Files and/or folders' list size once return

Returns:

Object contains a list named "folders", and other page information

Throws:

YfyException

listShareLink

public ListShareLinkResult listShareLink(long folderId,
                                int pageId)
                                  throws YfyException

List share links of a folder

Parameters:

folderId - Folder id in fangcloud

pageId - Page id begin with 0

Returns:

All related share links' information

Throws:

YfyException

listShareLink

public ListShareLinkResult listShareLink(long folderId,
                                int pageId,
                                long ownerId)
                                  throws YfyException

List folder's share links created by specific owner

Parameters:

folderId - Folder id in fangcloud

pageId - Page id begin with 0

ownerId - Owner id of share link you want to see

Returns:

All related share links' information

Throws:

YfyException

listCollab

public ListCollabResult listCollab(long folderId)
                            throws YfyException

List specific folder's all collab relationships

Parameters:

folderId - Folder id in fangcloud

Returns:

All collab infomations

Throws:

YfyException