SalesforceMobileSDK-Android

14.0.0-rc.0

SalesforceSDK/com.salesforce.androidsdk.rest/RestClient

RestClient

open class RestClient

RestClient allows you to send authenticated HTTP requests to a force.com server.

Constructors

constructor(clientInfo: RestClient.ClientInfo, authToken: String, httpAccessor: HttpAccess, authTokenProvider: RestClient.AuthTokenProvider)

Constructs a RestClient with the given clientInfo, authToken, httpAccessor and authTokenProvider.

constructor(clientInfo: RestClient.ClientInfo, authToken: String, tokenType: String, httpAccessor: HttpAccess, authTokenProvider: RestClient.AuthTokenProvider)

Constructs a RestClient with the given clientInfo, authToken, tokenType, httpAccessor and authTokenProvider.

constructor(clientInfo: RestClient.ClientInfo, authToken: String, tokenType: String, credentialsIdentifier: String, httpAccessor: HttpAccess, authTokenProvider: RestClient.AuthTokenProvider)

Constructs a RestClient with the given clientInfo, authToken, tokenType, credentialsIdentifier, httpAccessor and authTokenProvider.

Types

AsyncRequestCallback

interface AsyncRequestCallback

AsyncRequestCallback interface.

AuthTokenProvider

interface AuthTokenProvider

AuthTokenProvider interface.

open class ClientInfo

All immutable information for an authenticated client (e.g.

OAuthRefreshInterceptor

open class OAuthRefreshInterceptor : Interceptor

Network interceptor that does oauth refresh and request retry when access token has expired.

RefreshTokenRevokedException

open class RefreshTokenRevokedException : IOException

Exception thrown when refresh token was found to be revoked

UnauthenticatedClientInfo

open class UnauthenticatedClientInfo : RestClient.ClientInfo

Use a unauthenticated client info when do not need authentication support (e.g.

Properties

var clientInfo: RestClient.ClientInfo

oAuthRefreshInterceptor

open val oAuthRefreshInterceptor: RestClient.OAuthRefreshInterceptor

open var okHttpClient: OkHttpClient

okHttpClientBuilder

open val okHttpClientBuilder: OkHttpClient.Builder

Functions

open fun buildRequest(restRequest: RestRequest): Request

Builds an OK HTTP request from a REST request.

open fun clearCaches()

Clear caches of org-id/user-id to OkHttpClient.

open fun clearCaches(userAccount: UserAccount)

Remove cached OkHttpClient.

open fun getAuthToken(): String

getJSONCredentials

open fun getJSONCredentials(): JSONObject

getRefreshToken

open fun getRefreshToken(): String

open fun newWebSocket(request: Request, listener: WebSocketListener): WebSocket

Returns a new web socket for the provided request and web socket listener.

refreshAccessToken

open fun refreshAccessToken()

Proactively refresh this client's access token through the SDK's standard, app-wide serialized refresh path (the same path used when a request returns 401).

open fun sendAsync(restRequest: RestRequest, callback: RestClient.AsyncRequestCallback): Call

Send the given restRequest and process the result asynchronously with the given callback.

open fun sendSync(restRequest: RestRequest): RestResponse

open fun sendSync(restRequest: RestRequest, interceptors: Array<Interceptor>): RestResponse

Send the given restRequest synchronously and return a RestResponse Note: Cannot be used by code on the UI thread (use sendAsync instead).

open fun toString(): String