cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods
Class PrivateShareMethod

java.lang.Object
  extended by cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
      extended by cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.PrivateShareMethod

public class PrivateShareMethod
extends BaseBoxMethod

Author:
Jimmy

Field Summary
 
Fields inherited from class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
apiRequestFormat, apiUploadUrlPrefix, apiUrlPrefix, apiVersion, config, httpManager, soapApiUrl, xmlApiUrl
 
Constructor Summary
PrivateShareMethod()
           
 
Method Summary
 PrivateShareResponse privateShare(PrivateShareRequest privateShareRequest)
          This method privately shares a file or folder with another user(s).
 
Methods inherited from class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
getBaseSoapDocument, getElementByActionName, getRestUrl, getSoapElement
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PrivateShareMethod

public PrivateShareMethod()
Method Detail

privateShare

public PrivateShareResponse privateShare(PrivateShareRequest privateShareRequest)
                                  throws java.io.IOException,
                                         BoxException
This method privately shares a file or folder with another user(s). 'target' param should be either 'file' or 'folder', 'target_id' is the id of the file or folder to be shared. 'emails' params is an array of emails of users' to share files with. if 'notify' param is true, then a notification email will be sent to users, 'message' param is a message to be included in the notification email. Note: currently only files can be shared privately. On a successful result, the status will be 'private_share_ok'. If the result wasn't successful, the status field can be: 'private_share_error', 'wrong_node', 'not_logged_in', 'application_restricted'.

Parameters:
privateShareRequest - request
Returns:
response
Throws:
java.io.IOException - io exception
BoxException - box exception