CallScreeningService.CallResponse.Builder

public static class CallScreeningService.CallResponse.Builder
extends Object

java.lang.Object
   ↳ android.telecom.CallScreeningService.CallResponse.Builder


Summary

Public constructors

Builder()

Public methods

CallScreeningService.CallResponse build()
CallScreeningService.CallResponse.Builder setCallComposerAttachmentsToShow(int callComposerAttachmentsToShow)

Sets the call composer attachments that should be shown to the user.

CallScreeningService.CallResponse.Builder setDisallowCall(boolean shouldDisallowCall)

Sets whether the incoming call should be blocked.

CallScreeningService.CallResponse.Builder setRejectCall(boolean shouldRejectCall)

Sets whether the incoming call should be disconnected as if the user had manually rejected it.

CallScreeningService.CallResponse.Builder setSilenceCall(boolean shouldSilenceCall)

Sets whether ringing should be silenced for the incoming call.

CallScreeningService.CallResponse.Builder setSkipCallLog(boolean shouldSkipCallLog)

Sets whether the incoming call should not be displayed in the call log.

CallScreeningService.CallResponse.Builder setSkipNotification(boolean shouldSkipNotification)

Sets whether a missed call notification should not be shown for the incoming call.

Inherited methods

Public constructors

Builder

public Builder ()

Public methods

setCallComposerAttachmentsToShow

Added in API level 31
public CallScreeningService.CallResponse.Builder setCallComposerAttachmentsToShow (int callComposerAttachmentsToShow)

Sets the call composer attachments that should be shown to the user. Attachments that are not shown will not be passed to the in-call UI responsible for displaying the call to the user. If this method is not called on a Builder, all attachments will be shown, except pictures, which will only be shown to users if the call is from a contact. Setting attachments to show will have no effect if the call screening service does not belong to the same package as the system dialer (as returned by TelecomManager#getSystemDialerPackage()).

Parameters
callComposerAttachmentsToShow int: A bitmask of call composer attachments to show. Value is either 0 or a combination of CallScreeningService.CallResponse.CALL_COMPOSER_ATTACHMENT_PICTURE, CallScreeningService.CallResponse.CALL_COMPOSER_ATTACHMENT_LOCATION, CallScreeningService.CallResponse.CALL_COMPOSER_ATTACHMENT_SUBJECT, and CallScreeningService.CallResponse.CALL_COMPOSER_ATTACHMENT_PRIORITY

Returns
CallScreeningService.CallResponse.Builder This value cannot be null.

setDisallowCall

Added in API level 24
public CallScreeningService.CallResponse.Builder setDisallowCall (boolean shouldDisallowCall)

Sets whether the incoming call should be blocked.

Parameters
shouldDisallowCall boolean

Returns
CallScreeningService.CallResponse.Builder

setRejectCall

Added in API level 24
public CallScreeningService.CallResponse.Builder setRejectCall (boolean shouldRejectCall)

Sets whether the incoming call should be disconnected as if the user had manually rejected it. This property should only be set to true if the call is disallowed.

Parameters
shouldRejectCall boolean

Returns
CallScreeningService.CallResponse.Builder

setSilenceCall

Added in API level 29
public CallScreeningService.CallResponse.Builder setSilenceCall (boolean shouldSilenceCall)

Sets whether ringing should be silenced for the incoming call. When set to true, the Telecom framework will not play a ringtone for the call. The call will, however, still be sent to the default dialer app if it is not blocked. A CallScreeningService can use this to ensure a potential nuisance call is still surfaced to the user, but in a less intrusive manner. Setting this to true only makes sense when the call has not been disallowed using setDisallowCall(boolean).

Parameters
shouldSilenceCall boolean

Returns
CallScreeningService.CallResponse.Builder This value cannot be null.

setSkipCallLog

Added in API level 24
public CallScreeningService.CallResponse.Builder setSkipCallLog (boolean shouldSkipCallLog)

Sets whether the incoming call should not be displayed in the call log. This property should only be set to true if the call is disallowed.

Note: Calls will still be logged with type CallLog.Calls.BLOCKED_TYPE, regardless of how this property is set.

Note: Only the carrier and system call screening apps can use this parameter; this parameter is ignored otherwise.

Parameters
shouldSkipCallLog boolean

Returns
CallScreeningService.CallResponse.Builder

setSkipNotification

Added in API level 24
public CallScreeningService.CallResponse.Builder setSkipNotification (boolean shouldSkipNotification)

Sets whether a missed call notification should not be shown for the incoming call. This property should only be set to true if the call is disallowed.

Parameters
shouldSkipNotification boolean

Returns
CallScreeningService.CallResponse.Builder