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

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

public class LogoutMethod
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
LogoutMethod()
           
 
Method Summary
 LogoutResponse logout(LogoutRequest logoutRequest)
          This method is used to logout a user.
 
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

LogoutMethod

public LogoutMethod()
Method Detail

logout

public LogoutResponse logout(LogoutRequest logoutRequest)
                      throws java.io.IOException,
                             BoxException
This method is used to logout a user. On successful logout method will return 'logout_ok' as status. If logout wasn't successful, then status filed can be: 'invalid_auth_token' when auth_token is invalid.

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