IncomingCallRetriever

object IncomingCallRetriever


Entry point for developers to instantiate incoming call retriever API client.

Summary

Constants

const String

Intent extra key of user consent activity result.

const String

Intent extra key for the status code of user consent activity result.

const String

Intent action for broadcasting the phone number verification status.

const String

Intent extra key used in PHONE_VERIFICATION_STATUS_INTENT_ACTION broadcasts.

const String

Permission required to validate that the phone number verification status broadcast is indeed received from Google Play services.

Public functions

IncomingCallRetrieverClient
getClient(activity: Activity)

Creates a new instance of IncomingCallRetrieverClient.

IncomingCallRetrieverClient
getClient(context: Context)

Creates a new instance of IncomingCallRetrieverClient.

Constants

ACTIVITY_RESULT_INTENT_EXTRA_MESSAGE

const val ACTIVITY_RESULT_INTENT_EXTRA_MESSAGEString

Intent extra key of user consent activity result. Used to provide additional details on the user consent process outcome, such as failure reasons or success.

ACTIVITY_RESULT_INTENT_EXTRA_STATUS_CODE

const val ACTIVITY_RESULT_INTENT_EXTRA_STATUS_CODEString

Intent extra key for the status code of user consent activity result. Represents the success or failure state of the user consent process. Possible values come from IncomingCallRetrieverStatusCodes.

PHONE_VERIFICATION_STATUS_INTENT_ACTION

const val PHONE_VERIFICATION_STATUS_INTENT_ACTIONString

Intent action for broadcasting the phone number verification status. This is sent when the verification process completes.

PHONE_VERIFICATION_STATUS_INTENT_EXTRA

const val PHONE_VERIFICATION_STATUS_INTENT_EXTRAString

Intent extra key used in PHONE_VERIFICATION_STATUS_INTENT_ACTION broadcasts. Contains the verification result data.

SEND_PERMISSION

const val SEND_PERMISSIONString

Permission required to validate that the phone number verification status broadcast is indeed received from Google Play services. Apps receiving these broadcasts must register receiver with this permission.

Public functions

getClient

fun getClient(activity: Activity): IncomingCallRetrieverClient

Creates a new instance of IncomingCallRetrieverClient.

A dialog may appear when the provided activity is in the foreground and Google Play services needs to be updated.

Parameters
activity: Activity

the Activity that is using this client

getClient

fun getClient(context: Context): IncomingCallRetrieverClient

Creates a new instance of IncomingCallRetrieverClient.

Parameters
context: Context

the Context that is using this client