IncomingCallRetriever

Kotlin |Java

public static class IncomingCallRetriever

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

Summary

Constants
`static final @NonNull String`	`ACTIVITY_RESULT_INTENT_EXTRA_MESSAGE` `Intent` extra key of user consent activity result.
`static final @NonNull String`	`ACTIVITY_RESULT_INTENT_EXTRA_STATUS_CODE` `Intent` extra key for the status code of user consent activity result.
`static final @NonNull String`	`PHONE_VERIFICATION_STATUS_INTENT_ACTION` `Intent` action for broadcasting the phone number verification status.
`static final @NonNull String`	`PHONE_VERIFICATION_STATUS_INTENT_EXTRA` `Intent` extra key used in `PHONE_VERIFICATION_STATUS_INTENT_ACTION` broadcasts.
`static final @NonNull String`	`SEND_PERMISSION` Permission required to validate that the phone number verification status broadcast is indeed received from Google Play services.

Public fields
`static @NonNull IncomingCallRetriever`	`INSTANCE`

Public methods
`static final @NonNull IncomingCallRetrieverClient`	`getClient(@NonNull Activity activity)` Creates a new instance of `IncomingCallRetrieverClient`.
`static final @NonNull IncomingCallRetrieverClient`	`getClient(@NonNull Context context)` Creates a new instance of `IncomingCallRetrieverClient`.

Constants

ACTIVITY_RESULT_INTENT_EXTRA_MESSAGE

public static final @NonNull String ACTIVITY_RESULT_INTENT_EXTRA_MESSAGE

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

public static final @NonNull String ACTIVITY_RESULT_INTENT_EXTRA_STATUS_CODE

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

public static final @NonNull String PHONE_VERIFICATION_STATUS_INTENT_ACTION

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

PHONE_VERIFICATION_STATUS_INTENT_EXTRA

public static final @NonNull String PHONE_VERIFICATION_STATUS_INTENT_EXTRA

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

SEND_PERMISSION

public static final @NonNull String SEND_PERMISSION

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 fields

INSTANCE

public static @NonNull IncomingCallRetriever INSTANCE

Public methods

getClient

public static final @NonNull IncomingCallRetrieverClient getClient(@NonNull Activity activity)

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
`@NonNull Activity activity`	the `Activity` that is using this client

getClient

public static final @NonNull IncomingCallRetrieverClient getClient(@NonNull Context context)

Creates a new instance of IncomingCallRetrieverClient.

Parameters
`@NonNull Context context`	the `Context` that is using this client