public class

PublicShareMethod

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.PublicShareMethod

Summary

[Expand]
Inherited Fields
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
Public Constructors
PublicShareMethod()
Public Methods
PublicShareResponse publicShare(PublicShareRequest publicShareRequest)
This method publicly shares a file or folder.
[Expand]
Inherited Methods
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
From class java.lang.Object

Public Constructors

public PublicShareMethod ()

Public Methods

public PublicShareResponse publicShare (PublicShareRequest publicShareRequest)

This method publicly shares a file or folder. 'target' param should be either 'file' or 'folder', 'target_id' is id of the file or folder to be shared. 'password' param is to protect sharing with a password, 'emails' params is array of emails to notify about a new share, 'message' param is some message to be included in a notification email. On a successful result, the status will be 'share_ok' and 'public_name' param will be a unique identifier of a publicly shared file or folder. If the result wasn't successful, the status field can be: 'share_error', 'wrong_node', 'not_logged_in', 'application_restricted'.

Parameters
publicShareRequest Request
Returns
  • response
Throws
IOException io exception
BoxException box exception