com.fangcloud.sdk.api.collab

Class YfyCollabRequest

java.lang.Object

com.fangcloud.sdk.api.collab.YfyCollabRequest

public class YfyCollabRequest
extends Object

Constructor Summary

Constructors

Constructor and Description
YfyCollabRequest(YfyClient.YfyInternalClient client)

Method Summary

Methods

Modifier and Type	Method and Description
SuccessResult	deleteCollab(long collabId) Delete collab by collab id
YfyCollab	getCollab(long collabId) Retrieve detailed collab information
YfyCollab	inviteCollab(long folderId, long userId, CollabRoleEnum collabRole, String invitationMessage) Invite a user to a specific folder
YfyCollab	updateCollab(long collabId, CollabRoleEnum collabRole) Update a collab role by collab id

Methods inherited from class java.lang.Object

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

Constructor Detail

YfyCollabRequest

public YfyCollabRequest(YfyClient.YfyInternalClient client)

Method Detail

getCollab

public YfyCollab getCollab(long collabId)
                    throws YfyException

Retrieve detailed collab information

Returns:

Detailed collab information

Throws:

YfyException

inviteCollab

public YfyCollab inviteCollab(long folderId,
                     long userId,
                     CollabRoleEnum collabRole,
                     String invitationMessage)
                       throws YfyException

Invite a user to a specific folder

Parameters:

folderId - Folder id in fangcloud

userId - User id you want to invite

collabRole - Collab role the user will grant

invitationMessage - invitation message

Returns:

Detailed collab information

Throws:

YfyException

updateCollab

public YfyCollab updateCollab(long collabId,
                     CollabRoleEnum collabRole)
                       throws YfyException

Update a collab role by collab id

Parameters:

collabId - Collab id

collabRole - New collab role

Returns:

Detailed collab information

Throws:

YfyException

deleteCollab

public SuccessResult deleteCollab(long collabId)
                           throws YfyException

Delete collab by collab id

Parameters:

collabId - Collab id

Returns:

An object only has one attribute named success

Throws:

YfyException