Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
AuthConfiguration Class
AuthProviderCallbackState Class
AuthProviderPlugin Interface
AuthProviderPluginClass Class
AuthProviderTokenResponse Class
AuthToken Class
CommunitiesUtil Class
ConfigurableSelfRegHandler Interface
ConnectedAppPlugin Class
InvocationContext Enum
JWS Class
JWT Class
JWTBearerTokenExchange Class
LightningLoginEligibility Enum
LoginDiscoveryHandler Interface
LoginDiscoveryMethod Enum
MyDomainLoginDiscoveryHandler Interface
OAuthRefreshResult Class
OAuthRefreshResult Constructors
OAuthRefreshResult Properties
RegistrationHandler Interface
SamlJitHandler Interface
SessionManagement Class
SessionLevel Enum
UserData Class
VerificationMethod Enum
VerificationPolicy Enum
VerificationResult Class
Auth Exceptions
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
Functions Namespace (Beta)
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

OAuthRefreshResult Class

Stores the result of an AuthProviderPluginClass refresh method. OAuth authentication flow provides a refresh token that can be used to get a new access token. Access tokens have a limited lifetime as specified by the session timeout value. When an access token expires, use a refresh token to get a new access token.

Namespace

Auth

Usage

The OAuthRefreshResult class contains the parameters, accessToken, refreshToken, and error, all of which are of type string. For a code example, see Auth Exceptions.

OAuthRefreshResult Constructors

The following are constructors for OAuthRefreshResult.

OAuthRefreshResult(accessToken, refreshToken, error)

Creates an instance of the OAuthRefreshResult class using the specified access token, refresh token, and error for a custom authentication provider plug-in.

Signature

public OAuthRefreshResult(String accessToken, String refreshToken, String error)

Parameters

accessToken
Type: String
OAuth access token for the user who is currently logged in.
refreshToken
Type: String
OAuth refresh token for the user who is currently logged in.
error
Type: String
Error that occurred when a user attempted to authenticate with the custom authentication provider.

OAuthRefreshResult(accessToken, refreshToken)

Creates an instance of the OAuthRefreshResult class using the specified access token and refresh token for a custom authentication provider plug-in. Use this method when you know that the refresh was successful.

Signature

public OAuthRefreshResult(String accessToken, String refreshToken)

Parameters

accessToken
Type: String
The OAuth access token for the user who is logged in.
refreshToken
Type: String
The OAuth refresh token for the user who is logged in.

OAuthRefreshResult Properties

The following are properties for OAuthRefreshResult.

accessToken

The OAuth access token for the user who is currently logged in.

Signature

public String accessToken {get; set;}

Property Value

Type: String

error

Error that occurs when a user unsuccessfully attempts to authenticate with the custom authentication provider.

Signature

public String error {get; set;}

Property Value

Type: String

refreshToken

The OAuth refresh token for the user who is currently logged in.

Signature

public String refreshToken {get; set;}

Property Value

Type: String