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

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

public class GetFriendsMethod
extends BaseBoxMethod

Author:
Jimmy

Field Summary
static java.lang.String PARAMS_KEY_NOZIP
          this parameter decides whether zip the content with base64 encode or not.
 
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
GetFriendsMethod()
           
 
Method Summary
 GetFriendsResponse getFriends(GetFriendsRequest getFriendsRequest)
          This method is used to retrieve a list of freinds.
 
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
 

Field Detail

PARAMS_KEY_NOZIP

public static final java.lang.String PARAMS_KEY_NOZIP
this parameter decides whether zip the content with base64 encode or not.

See Also:
Constant Field Values
Constructor Detail

GetFriendsMethod

public GetFriendsMethod()
Method Detail

getFriends

public GetFriendsResponse getFriends(GetFriendsRequest getFriendsRequest)
                              throws java.io.IOException,
                                     BoxException
This method is used to retrieve a list of freinds. 'params' is an array of the string where you can set additional parameters, which are: nozip - do not zip tree xml. On a successful result you will receive 's_get_friends' as the status and base64 encoded (and zipped) friends xml. Friends xml looks like this: ......

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