lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

VisualVoicemailSmsFilterSettings

public final class VisualVoicemailSmsFilterSettings
extends Object implements Parcelable

java.lang.Object
   ↳ android.telephony.VisualVoicemailSmsFilterSettings


Class to represent various settings for the visual voicemail SMS filter. When the filter is enabled, incoming SMS matching the generalized OMTP format:

[clientPrefix]:[prefix]:([key]=[value];)*

will be regarded as a visual voicemail SMS, and removed before reaching the SMS provider. The VisualVoicemailService in the current default dialer will be bound and VisualVoicemailService.onSmsReceived(VisualVoicemailTask, VisualVoicemailSms) will called with the information extracted from the SMS.

Use VisualVoicemailSmsFilterSettings.Builder to construct this class.

Summary

Nested classes

class VisualVoicemailSmsFilterSettings.Builder

Builder class for VisualVoicemailSmsFilterSettings objects. 

Constants

int DESTINATION_PORT_ANY

The visual voicemail SMS message does not have to be a data SMS, and can be directed to any port.

int DESTINATION_PORT_DATA_SMS

The visual voicemail SMS message can be directed to any port, but must be a data SMS.

Inherited constants

Fields

public static final Creator<VisualVoicemailSmsFilterSettings> CREATOR

public final String clientPrefix

The client prefix for the visual voicemail SMS filter.

public final int destinationPort

The destination port for the visual voicemail SMS filter, or DESTINATION_PORT_ANY, or DESTINATION_PORT_DATA_SMS

public final List<String> originatingNumbers

The originating number whitelist for the visual voicemail SMS filter of a phone account.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

DESTINATION_PORT_ANY

added in API level 26
public static final int DESTINATION_PORT_ANY

The visual voicemail SMS message does not have to be a data SMS, and can be directed to any port.

Constant Value: -1 (0xffffffff)

DESTINATION_PORT_DATA_SMS

added in API level 26
public static final int DESTINATION_PORT_DATA_SMS

The visual voicemail SMS message can be directed to any port, but must be a data SMS.

Constant Value: -2 (0xfffffffe)

Fields

CREATOR

added in API level 26
public static final Creator<VisualVoicemailSmsFilterSettings> CREATOR

clientPrefix

added in API level 26
public final String clientPrefix

The client prefix for the visual voicemail SMS filter. The client prefix will appear at the start of a visual voicemail SMS message, followed by a colon(:).

destinationPort

added in API level 26
public final int destinationPort

The destination port for the visual voicemail SMS filter, or DESTINATION_PORT_ANY, or DESTINATION_PORT_DATA_SMS

originatingNumbers

added in API level 26
public final List<String> originatingNumbers

The originating number whitelist for the visual voicemail SMS filter of a phone account. If the list is not null only the SMS messages from a number in the list can be considered as a visual voicemail SMS. Otherwise, messages from any address will be considered.

Public methods

describeContents

added in API level 26
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

toString

added in API level 26
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

added in API level 26
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.