Package com.ringcentral

Class RestClient

java.lang.Object

com.ringcentral.RestClient

public class RestClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	clientId
String	clientSecret
okhttp3.OkHttpClient	httpClient
List<HttpEventListener>	httpEventListeners
static Logger	logger
static final String	PRODUCTION_SERVER
String	server
TokenInfo	token

Constructor Summary

Constructors

Constructor	Description
RestClient(String clientId, String clientSecret)
RestClient(String clientId, String clientSecret, String server)
RestClient(String clientId, String clientSecret, String server, okhttp3.OkHttpClient okHttpClient)
RestClient(String clientId, String clientSecret, okhttp3.OkHttpClient okHttpClient)

Method Summary

Modifier and Type	Method	Description
Index	ai()
Index	analytics()
TokenInfo	authorize(GetTokenRequest getTokenRequest)
TokenInfo	authorize(String jwt)
TokenInfo	authorize(String authCode, String redirectUri)
TokenInfo	authorize(String username, String extension, String password)	Deprecated. Password auth is deprecated.
String	authorizeUri(AuthorizeRequest request)
String	authorizeUri(String redirectUri)
String	authorizeUri(String redirectUri, String state)
void	autoRefresh()
void	autoRefresh(long period)
okhttp3.ResponseBody	delete(String endpoint)
okhttp3.ResponseBody	delete(String endpoint, Object queryParameters)
okhttp3.ResponseBody	delete(String endpoint, Object object, Object queryParameters)
okhttp3.ResponseBody	get(String endpoint)
okhttp3.ResponseBody	get(String endpoint, Object queryParameters)
okhttp3.ResponseBody	patch(String endpoint, Object object)
okhttp3.ResponseBody	patch(String endpoint, Object object, Object queryParameters)
okhttp3.ResponseBody	post(String endpoint)
okhttp3.ResponseBody	post(String endpoint, Object object)
okhttp3.ResponseBody	post(String endpoint, Object object, Object queryParameters)
okhttp3.ResponseBody	post(String endpoint, Object object, Object queryParameters, ContentType contentType)
okhttp3.ResponseBody	put(String endpoint)
okhttp3.ResponseBody	put(String endpoint, Object object)
okhttp3.ResponseBody	put(String endpoint, Object object, Object queryParameters)
okhttp3.ResponseBody	put(String endpoint, Object object, Object queryParameters, ContentType contentType)
Index	rcvideo()
TokenInfo	refresh()
okhttp3.ResponseBody	request(HttpMethod httpMethod, String endpoint, Object queryParameters, Object body)
okhttp3.ResponseBody	request(HttpMethod httpMethod, String endpoint, Object queryParameters, Object body, ContentType contentType)
okhttp3.ResponseBody	request(HttpMethod httpMethod, String endpoint, Object queryParameters, okhttp3.RequestBody requestBody)
okhttp3.Response	requestRaw(HttpMethod httpMethod, String endpoint, Object queryParameters, okhttp3.RequestBody requestBody)
Index	restapi()
Index	restapi(String apiVersion)
void	revoke()
Index	scim()
Index	scim(String version)
Index	teamMessaging()
Index	webinar()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PRODUCTION_SERVER

public static final String PRODUCTION_SERVER

See Also:

• Constant Field Values

logger

public static Logger logger

clientId

public String clientId

clientSecret

public String clientSecret

server

public String server

httpClient

public okhttp3.OkHttpClient httpClient

token

public TokenInfo token

httpEventListeners

public List<HttpEventListener> httpEventListeners

Constructor Details

RestClient

public RestClient(String clientId,
 String clientSecret,
 String server,
 okhttp3.OkHttpClient okHttpClient)

RestClient

public RestClient(String clientId,
 String clientSecret,
 String server)

RestClient

public RestClient(String clientId,
 String clientSecret,
 okhttp3.OkHttpClient okHttpClient)

RestClient

public RestClient(String clientId,
 String clientSecret)

Method Details

autoRefresh

public void autoRefresh(long period)

autoRefresh

public void autoRefresh()

refresh

public TokenInfo refresh()
                  throws IOException,
RestException

Throws:

IOException

RestException

revoke

public void revoke()
            throws IOException,
RestException

Throws:

IOException

RestException

authorize

@Deprecated
public TokenInfo authorize(String username,
 String extension,
 String password)
                    throws IOException,
RestException

Deprecated.

Password auth is deprecated. Use authorize(String) or authorize(String, String) instead.

Authorize or authenticate using the ROPC or password grant flow.

Throws:

IOException

RestException

authorize

public TokenInfo authorize(String authCode,
 String redirectUri)
                    throws IOException,
RestException

Throws:

IOException

RestException

authorize

public TokenInfo authorize(String jwt)
                    throws IOException,
RestException

Throws:

IOException

RestException

authorize

public TokenInfo authorize(GetTokenRequest getTokenRequest)
                    throws IOException,
RestException

Throws:

IOException

RestException

get

public okhttp3.ResponseBody get(String endpoint)
                         throws IOException,
RestException

Throws:

IOException

RestException

get

public okhttp3.ResponseBody get(String endpoint,
 Object queryParameters)
                         throws IOException,
RestException

Throws:

IOException

RestException

delete

public okhttp3.ResponseBody delete(String endpoint)
                            throws IOException,
RestException

Throws:

IOException

RestException

delete

public okhttp3.ResponseBody delete(String endpoint,
 Object queryParameters)
                            throws IOException,
RestException

Throws:

IOException

RestException

delete

public okhttp3.ResponseBody delete(String endpoint,
 Object object,
 Object queryParameters)
                            throws IOException,
RestException

Throws:

IOException

RestException

post

public okhttp3.ResponseBody post(String endpoint)
                          throws IOException,
RestException

Throws:

IOException

RestException

post

public okhttp3.ResponseBody post(String endpoint,
 Object object)
                          throws IOException,
RestException

Throws:

IOException

RestException

post

public okhttp3.ResponseBody post(String endpoint,
 Object object,
 Object queryParameters)
                          throws IOException,
RestException

Throws:

IOException

RestException

post

public okhttp3.ResponseBody post(String endpoint,
 Object object,
 Object queryParameters,
 ContentType contentType)
                          throws IOException,
RestException

Throws:

IOException

RestException

put

public okhttp3.ResponseBody put(String endpoint)
                         throws IOException,
RestException

Throws:

IOException

RestException

put

public okhttp3.ResponseBody put(String endpoint,
 Object object)
                         throws IOException,
RestException

Throws:

IOException

RestException

put

public okhttp3.ResponseBody put(String endpoint,
 Object object,
 Object queryParameters)
                         throws IOException,
RestException

Throws:

IOException

RestException

put

public okhttp3.ResponseBody put(String endpoint,
 Object object,
 Object queryParameters,
 ContentType contentType)
                         throws IOException,
RestException

Throws:

IOException

RestException

patch

public okhttp3.ResponseBody patch(String endpoint,
 Object object)
                           throws IOException,
RestException

Throws:

IOException

RestException

patch

public okhttp3.ResponseBody patch(String endpoint,
 Object object,
 Object queryParameters)
                           throws IOException,
RestException

Throws:

IOException

RestException

request

public okhttp3.ResponseBody request(HttpMethod httpMethod,
 String endpoint,
 Object queryParameters,
 Object body)
                             throws IOException,
RestException

Throws:

IOException

RestException

request

public okhttp3.ResponseBody request(HttpMethod httpMethod,
 String endpoint,
 Object queryParameters,
 Object body,
 ContentType contentType)
                             throws IOException,
RestException

Throws:

IOException

RestException

requestRaw

public okhttp3.Response requestRaw(HttpMethod httpMethod,
 String endpoint,
 Object queryParameters,
 okhttp3.RequestBody requestBody)
                            throws IOException,
RestException

Throws:

IOException

RestException

request

public okhttp3.ResponseBody request(HttpMethod httpMethod,
 String endpoint,
 Object queryParameters,
 okhttp3.RequestBody requestBody)
                             throws IOException,
RestException

Throws:

IOException

RestException

authorizeUri

public String authorizeUri(AuthorizeRequest request)

authorizeUri

public String authorizeUri(String redirectUri,
 String state)

authorizeUri

public String authorizeUri(String redirectUri)

restapi

public Index restapi(String apiVersion)

restapi

public Index restapi()

scim

public Index scim(String version)

scim

public Index scim()

analytics

public Index analytics()

teamMessaging

public Index teamMessaging()

ai

public Index ai()

rcvideo

public Index rcvideo()

webinar

public Index webinar()