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
RegistrationHandler Interface
SamlJitHandler Interface
SessionManagement Class
SessionLevel Enum
UserData Class
VerificationMethod Enum
VerificationPolicy Enum
VerificationResult Class
VerificationResult Constructor
VerificationResult Properties
VerificationResult Method
Auth Exceptions
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc 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

VerificationResult Class

Contains the result of a verification challenge that you invoke when you create your own Verify page. The challenge can be initiated by either the System.UserManagement.verifyPasswordlessLogin or System.UserManagement.verifySelfRegistration method.

Namespace

Auth

Usage

When users sign up for or log in to your community with an email address or phone number, Salesforce sends them a verification code. At the same time, Salesforce generates the Verify page for users to enter the code to verify their identity. You can replace the Salesforce-generated Verify page with one that you create with Visualforce. Then invoke the verification challenge and, if the verification code is entered correctly, log in the user. For sign-up, you use the System.UserManagement.verifySelfRegistration method. For passwordless login, you use the System.UserManagement.verifyPasswordlessLogin method. The methods return the verification result, which contains the message displayed as a result of the challenge, whether the challenge is successful, and where to direct the user when the verification code is entered correctly.

Example

This code contains the result of a verification challenge that registers a new user. 

1String id = System.UserManagement.initSelfRegistration​
2          (Auth.VerificationMethod.SMS, user);
3        Auth.VerificationResult res = System.UserManagement.verifySelfRegistration​
4          (Auth.VerificationMethod.SMS, id, ‘123456’, null);
5        if(res.status == SUCCESS){
6     //redirect
7}

VerificationResult Constructor

VerificationResult has the following constructor.

VerificationResult(redirect, success, message)

Creates an instance of the VerificationResult class that contains the verification result from System.UserManagement.verifySelfRegistration.

Signature

public VerificationResult(System.PageReference redirect, Boolean success, String message)

Parameters

redirect
Type: System.PageReferenceSystem.PageReference
Where user is directed upon successful verification.
success
Type: Boolean
Indicates whether verification succeeded.
message
Type: String
Message that displays as a result of a verification challenge.

VerificationResult Properties

The following are properties for VerificationResult.

message

Message that displays as a result of a verification challenge. SUCCESS if the identity verification is successful. Other values are FAILURE, PENDING, RATE_LIMITED, or FAILURE_REPORT.

Signature

public String message {get; set;}

Property Value

Type: String

redirect

Where the user is directed after entering the verification code successfully, for example, the community home page or location specified by the start URL.

Signature

public System.PageReference redirect {get; set;}

Property Value

Type: System.PageReferenceSystem.PageReference

success

The verification challenge is successful.

Signature

public Boolean success {get; set;}

Property Value

Type: Boolean

VerificationResult Method

VerificationResult has the following method.

clone()

Duplicates the Auth.VerificationResult object.

Signature

public Object clone()

Return Value

Type: VerificationResult