IncomingCallRetrieverClient

@DoNotMock(value = "Use canonical fakes instead.")
interface IncomingCallRetrieverClient : HasApiKey


A client for developers to instantiate incoming call retriever API.

Summary

Public functions

Task<PendingIntent>
@RequiresApi(value = 29)
startIncomingCallRetriever(
    incomingCallRetrieverRequest: IncomingCallRetrieverRequest
)

Starts the incoming call retriever API, which rejects the first incoming call within the phone range provided in the IncomingCallRetrieverRequest within a timeout.

Public functions

startIncomingCallRetriever

@RequiresApi(value = 29)
fun startIncomingCallRetriever(
    incomingCallRetrieverRequest: IncomingCallRetrieverRequest
): Task<PendingIntent>

Starts the incoming call retriever API, which rejects the first incoming call within the phone range provided in the IncomingCallRetrieverRequest within a timeout.

Parameters
incomingCallRetrieverRequest: IncomingCallRetrieverRequest

calling client needs to pass a corresponding IncomingCallRetrieverRequest instance. This contains a phone number range from which the incoming call is expected for verification.

Returns
Task<PendingIntent>

a PendingIntent to launch the user consent screen.