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

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

public class SetDescriptionMethod
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
SetDescriptionMethod()
           
 
Method Summary
 SetDescriptionResponse setDescription(SetDescriptionRequest setDescriptionRequest)
          This method sets a description to a file or folder.
 
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

SetDescriptionMethod

public SetDescriptionMethod()
Method Detail

setDescription

public SetDescriptionResponse setDescription(SetDescriptionRequest setDescriptionRequest)
                                      throws java.io.IOException,
                                             BoxException
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:
java.io.IOException - io exception
BoxException - box exception