public class

PrivateShareMethod

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

Summary

[Expand]
Inherited Fields
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
Public Constructors
PrivateShareMethod()
Public Methods
PrivateShareResponse privateShare(PrivateShareRequest privateShareRequest)
This method privately shares a file or folder with another user(s).
[Expand]
Inherited Methods
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
From class java.lang.Object

Public Constructors

public PrivateShareMethod ()

Public Methods

public PrivateShareResponse privateShare (PrivateShareRequest privateShareRequest)

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
IOException io exception
BoxException box exception