public class

SetDescriptionMethod

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

Summary

[Expand]
Inherited Fields
From class cn.com.believer.songyuanframework.openapi.storage.box.impl.simple.methods.BaseBoxMethod
Public Constructors
SetDescriptionMethod()
Public Methods
SetDescriptionResponse setDescription(SetDescriptionRequest setDescriptionRequest)
This method sets a description to 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 SetDescriptionMethod ()

Public Methods

public SetDescriptionResponse setDescription (SetDescriptionRequest setDescriptionRequest)

This method sets a description to a file or folder. 'target' can be a 'file' or 'folder', 'target_id' - id of file or folder, description - string that should be set as description. On successful a result, you will receive status 's_set_description'. If the result wasn't successful, status field can be: e_set_description.

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