com.truecaller.android.sdk

Class TruecallerSDK

java.lang.Object

com.truecaller.android.sdk.TruecallerSDK

public final class TruecallerSDK
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
static void	clear()
static TruecallerSDK	getInstance() Must call TruecallerSDK#init(Context, ProfileCallback) to initialize the instance, otherwise this method will throw exception
void	getUserProfile(Fragment fragment) This is same as TruecallerSDK#getUserProfile(Activity), except that it accepts fragment.
void	getUserProfile(FragmentActivity activity) This is the method to be called to get the user verified.
static void	init(android.content.Context context, ITrueCallback callback) Deprecated. Use init(TruecallerSdkScope) instead. This method has to be called before you can use TruecallerSDK#getUserProfile(Activity) and other methods. SDK methods will have undesirable behaviour otherwise.
static void	init(TruecallerSdkScope trueScope) This method has to be called before you can use TruecallerSDK#getUserProfile(Activity) and other methods.
boolean	isUsable()
boolean	onActivityResultObtained(FragmentActivity activity, int resultCode, android.content.Intent data) Make sure Activity.onActivityResult(int, int, Intent) of your Activity calls this method and passes the intent and resultCode.
void	requestVerification(java.lang.String countryISO, java.lang.String phoneNumber, VerificationCallback callback, FragmentActivity activity) This method will initiate a verification asynchronously.
void	setLocale(java.util.Locale locale) Call this to set locale
void	setRequestNonce(java.lang.String requestNonce) Set a nonce for the next request, which will be passed back with the verification result.
void	setTheme(int theme) Call this to set theme
void	updateCallback(ITrueCallback trueCallback) Helper method to update the main callback ITrueCallback, that receives profile information at different point than only during initialization.
void	verifyMissedCall(TrueProfile trueProfile, VerificationCallback callback) If the number has to be verified with a missed call on that number, call this method to complete verification asynchronously, after receiving success in VerificationCallback#onRequestSuccess(int, String).
void	verifyOtp(TrueProfile trueProfile, java.lang.String otp, VerificationCallback callback) If the number has to be verified with an OTP, after receiving the code via SMS, call this method to complete verification asynchronously.

Methods inherited from class java.lang.Object

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

Method Detail

init

@Deprecated
public static void init(android.content.Context context,
                                    ITrueCallback callback)
                             throws java.lang.RuntimeException

Deprecated. Use init(TruecallerSdkScope) instead.

This method has to be called before you can use TruecallerSDK#getUserProfile(Activity) and other methods. SDK methods will have undesirable behaviour otherwise.

Parameters:

context, - can be Application context

callback, - see ProfileCallback for more info

showConsentInFullScreen, - boolean to decide whether to show the confirm profile popup in full-screen or as a dialog

Throws:

RuntimeException, - if partner key is not added in the manifest file

java.lang.RuntimeException

init

public static void init(TruecallerSdkScope trueScope)

This method has to be called before you can use TruecallerSDK#getUserProfile(Activity) and other methods. SDK methods will have undesirable behaviour otherwise.

Parameters:

trueScope, - Scope to define on the features of sdk to use

getInstance

public static TruecallerSDK getInstance()
                                 throws java.lang.RuntimeException

Must call TruecallerSDK#init(Context, ProfileCallback) to initialize the instance, otherwise this method will throw exception

Returns:

TruecallerSDK instance to request SDK operations

Throws:

java.lang.RuntimeException

isUsable

public boolean isUsable()

Returns:

true, if sdk features can be used or else returns false Client can use it to toggle Truecaller login Button visibility, or before making any requests on sdk

setRequestNonce

public void setRequestNonce(java.lang.String requestNonce)

Set a nonce for the next request, which will be passed back with the verification result. Can be used to verify the authenticity of the returned payload.

Parameters:

requestNonce - - must be min length: 8, max length: 64 bas64 URL safe string .

updateCallback

public void updateCallback(ITrueCallback trueCallback)

Helper method to update the main callback ITrueCallback, that receives profile information at different point than only during initialization.

Parameters:

trueCallback, - callback to set

getUserProfile

public void getUserProfile(FragmentActivity activity)

This is the method to be called to get the user verified. Depending on whether the User has Truecaller installed or not, it will take different paths (and trigger callbacks)

Make sure Activity.onActivityResult(int, int, Intent) of your Activity calls TruecallerSDK#onActivityResultObtained(Activity, int, Intent)

Parameters:

activity, - which will receive the activity result, if Truecaller is installed

getUserProfile

public void getUserProfile(Fragment fragment)

This is same as TruecallerSDK#getUserProfile(Activity), except that it accepts fragment. Make sure Activity.onActivityResult(int, int, Intent) of your Activity calls TruecallerSDK#onActivityResultObtained(Activity, int, Intent)

Parameters:

fragment, - which will receive the activity result, if Truecaller is installed

onActivityResultObtained

public boolean onActivityResultObtained(FragmentActivity activity,
                                        int resultCode,
                                        android.content.Intent data)

Make sure Activity.onActivityResult(int, int, Intent) of your Activity calls this method and passes the intent and resultCode.

Parameters:

activity - parent activity which requested the profile

resultCode - resultCode from Activity.onActivityResult(int, int, Intent)

data - intent from Activity.onActivityResult(int, int, Intent)

Returns:

true if Truecaller app is installed and we received the request for SDK authentication

requestVerification

public void requestVerification(java.lang.String countryISO,
                                java.lang.String phoneNumber,
                                VerificationCallback callback,
                                FragmentActivity activity)

This method will initiate a verification asynchronously. The result will be returned asynchronously via VerificationCallback interface. Check documentation for VerificationCallback to understand the flow and different verifications states.

This method may lead to verification with a SMS Code (OTP) or verification with a CALL, or if the user is already verified on the device, will get the call back in ProfileCallback#onSuccessProfileShared(TrueProfile).

Parameters:

countryISO - pass the countrycode in ISO format eg: "IN" for India.

phoneNumber - the phone number to be verified (local, without country code)

callback - VerificationCallback which will return the result of the verification.

verifyOtp

public void verifyOtp(TrueProfile trueProfile,
                      java.lang.String otp,
                      VerificationCallback callback)

If the number has to be verified with an OTP, after receiving the code via SMS, call this method to complete verification asynchronously. The method will take the same callback interface VerificationCallback as passed with TruecallerSDK#requestVerification(String, String, VerificationCallback)

Parameters:

trueProfile - To complete verification it is mandatory to pass a newly created TrueProfile object of the current (verifying) user. The profile should at least contain, TrueProfile.firstName and TrueProfile.lastName filled.

otp - the code received over SMS

callback - the call back to which verification result has to be passed

verifyMissedCall

public void verifyMissedCall(TrueProfile trueProfile,
                             VerificationCallback callback)

If the number has to be verified with a missed call on that number, call this method to complete verification asynchronously, after receiving success in VerificationCallback#onRequestSuccess(int, String). with request type VerificationCallback#TYPE_MISSED_CALL_RECEIVED The method will take the same callback interface VerificationCallback as passed with TruecallerSDK#requestVerification(String, String, VerificationCallback)

Parameters:

trueProfile - To complete verification it is mandatory to pass a newly created TrueProfile object of the current (verifying) user. The profile should at least contain, TrueProfile.firstNamex and TrueProfile.lastName filled.

callback - the call back to which verification result has to be passed

setLocale

public void setLocale(java.util.Locale locale)

Call this to set locale

Parameters:

locale - Locale to set to

setTheme

public void setTheme(int theme)

Call this to set theme

Parameters:

theme - Pass theme from one of the values in SdkThemeOptions

clear

public static void clear()