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

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

public class RequestFriendsMethod
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
RequestFriendsMethod()
           
 
Method Summary
 RequestFriendsResponse requestFriends(RequestFriendsRequest requestFriendsRequest)
          This method requests new friends to be added to your network.
 
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

RequestFriendsMethod

public RequestFriendsMethod()
Method Detail

requestFriends

public RequestFriendsResponse requestFriends(RequestFriendsRequest requestFriendsRequest)
                                      throws java.io.IOException,
                                             BoxException
This method requests new friends to be added to your network. 'emails' - array of emails. 'message' - text message that you want to send to freinds. 'params' is an array of string where you can set additional parameters, which are: box_auto_subscribe - subscribe to public boxes of inveted users. no_email - don't send emails to invited users. On a successful result, you will receive status 's_request_friends'. If the result wasn't successful, status field can be: e_request_friends.

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