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

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

public class RenameMethod
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
RenameMethod()
           
 
Method Summary
 RenameResponse rename(RenameRequest renameRequest)
          This method renames 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

RenameMethod

public RenameMethod()
Method Detail

rename

public RenameResponse rename(RenameRequest renameRequest)
                      throws java.io.IOException,
                             BoxException
This method renames a file or folder. 'target' param can be either 'file' or 'folder' depending on what you want to rename, 'target_id' is the id of a file or folder to be renamed, 'new_name' is the new name for a file or folder. On a successful result, status will be 's_rename_node'. If result wasn't successful, stat's field can be: 'e_rename_node', 'not_logged_in', 'application_restricted'.

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