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.BuilderBuilder class for  | 
| Constants | |
|---|---|
| int | DESTINATION_PORT_ANYThe visual voicemail SMS message does not have to be a data SMS, and can be directed to any port. | 
| int | DESTINATION_PORT_DATA_SMSThe 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 | clientPrefixThe client prefix for the visual voicemail SMS filter. | 
| 
    public
    
    final
    int | destinationPortThe destination port for the visual voicemail SMS filter, or  | 
| 
    public
    
    final
    List<String> | originatingNumbersThe originating number allow list 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
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
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
clientPrefix
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
public final int destinationPort
The destination port for the visual voicemail SMS filter, or DESTINATION_PORT_ANY,
 or DESTINATION_PORT_DATA_SMS
originatingNumbers
public final List<String> originatingNumbers
The originating number allow list 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
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(android.os.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.
 Value is either 0orCONTENTS_FILE_DESCRIPTOR | 
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
| String | a string representation of the object. | 
writeToParcel
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.
 This value cannot benull. | 
| flags | int: Additional flags about how the object should be written.
 May be 0 orParcelable.PARCELABLE_WRITE_RETURN_VALUE.
 Value is either0or a combination ofParcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | 
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
