com.sinch.verification

Class SinchVerification

java.lang.Object

com.sinch.verification.SinchVerification

public final class SinchVerification
extends Object

SinchVerification is the Verification SDK entry point. It provides factory methods for SMS and flash call verification objects and a config builder.

Example

 
 // Create a configuration
 Config config = SinchVerification.config().applicationKey("your-app-key").context(getApplicationContext()).build();
 // Create the verification process listener
 VerificationListener listener = new VerificationListener() {
    @Override
     public void onInitiated() {
         // Update UI here if needed to show verification progress.
     }
    @Override
     public void onInitiationFailed(Exception e) {
         if (e instanceof InvalidInputException) {
             // Incorrect number provided, ask the user to input number again.
         } else if (e instanceof ServiceErrorException) {
             // Another service error, please report the error message to the developers.
         } else {
             // Other system error.
         }
     }
    @Override
     public void onVerified() {
         // Update UI for the successful case here.
     }
    @Override
     public void onVerificationFailed(Exception e) {
         if (e instanceof InvalidInputException) {
             // Incorrect number or code provided, ask the user to input number again.
         } else if (e instanceof CodeInterceptionException) {
             // Intercepting the verification code automatically failed, try to verify manually.
             verification.verify(userTypedCode);
         } else if (e instanceof IncorrectCodeException) {
             // The verification code provided was incorrect. Ask the user to type it again.
             verification.verify(userTypedCode);
         } else if (e instanceof ServiceErrorException) {
             // Another service error, please report the error message to the developers.
         } else {
             // Other system error.
         }
     }
 }
 // Create sms verification
 Verification verification = SinchVerification.createSmsVerification(config, phoneNumber, listener);
 // Or create a flash call verification
 Verification verification = SinchVerification.createFlashCallVerification(config, phoneNumber, listener);
 // Initiate the verification process. If initiation is successful, onInitiated() callback
 // will be executed and the verification code interceptor will be started automatically. When
 // it receives a call or sms, it will try to call verify() with that code and in case of success
 // execute the onVerified() callback.
 verification.initiate();
 
 

Constructor Summary

Constructors

Constructor and Description
SinchVerification()

Method Summary

Methods

Modifier and Type	Method and Description
static ConfigBuilder	config() Creates a config builder.
static Verification	createFlashCallVerification(Config config, String number, String custom, VerificationListener listener) Creates a flash call verification object.
static Verification	createFlashCallVerification(Config config, String number, VerificationListener listener) Creates a flash call verification object.
static Verification	createSmsVerification(Config config, String number, String custom, VerificationListener listener) Creates an sms verification object.
static Verification	createSmsVerification(Config config, String number, VerificationListener listener) Creates an sms verification object.
static String	getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

SinchVerification

public SinchVerification()

Method Detail

config

public static ConfigBuilder config()

Creates a config builder.

Returns:

a ConfigBuilder object.

createSmsVerification

public static Verification createSmsVerification(Config config,
                                 String number,
                                 VerificationListener listener)

Creates an sms verification object.

Parameters:

config - a Config

number - the number to be verified

listener - a VerificationListener

Returns:

the Verification object for sms verification.

Throws:

IllegalArgumentException - if number is null or if listener is null.

createSmsVerification

public static Verification createSmsVerification(Config config,
                                 String number,
                                 String custom,
                                 VerificationListener listener)

Creates an sms verification object.

Parameters:

config - a Config

number - the number to be verified

custom - opaque data that will be passed in any callbacks from the Sinch backend to the applications backend

listener - a VerificationListener

Returns:

the Verification object for sms verification.

Throws:

IllegalArgumentException - if number is null or if listener is null.

createFlashCallVerification

public static Verification createFlashCallVerification(Config config,
                                       String number,
                                       VerificationListener listener)

Creates a flash call verification object.

Parameters:

config - a Config

number - the number to be verified

listener - a VerificationListener

Returns:

the Verification object for flash call verification.

Throws:

IllegalArgumentException - if number is null or if listener is null.

createFlashCallVerification

public static Verification createFlashCallVerification(Config config,
                                       String number,
                                       String custom,
                                       VerificationListener listener)

Creates a flash call verification object.

Parameters:

config - a Config

number - the number to be verified

custom - opaque data that will be passed in any callbacks from the Sinch backend to the applications backend

listener - a VerificationListener

Returns:

the Verification object for flash call verification.

Throws:

IllegalArgumentException - if number is null or if listener is null.

getVersion

public static String getVersion()