GatewayInfo

public class GatewayInfo
extends Object implements Parcelable

java.lang.Object
   ↳ android.telecom.GatewayInfo


Encapsulated gateway address information for outgoing call. When calls are made, the system provides a facility to specify two addresses for the call: one to display as the address being dialed and a separate (gateway) address to actually dial. Telecom provides this information to ConnectionServices when placing the call as an instance of GatewayInfo.

The data consists of an address to call, an address to display and the package name of the service. This data is used in two ways:

  1. Call the appropriate gateway address.
  2. Display information about how the call is being routed to the user.

Summary

Inherited constants

Fields

public static final Creator<GatewayInfo> CREATOR

The Parcelable interface.

Public constructors

GatewayInfo(String packageName, Uri gatewayUri, Uri originalAddress)

Public methods

int describeContents()

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

Uri getGatewayAddress()

Returns the gateway address to dial when placing the call.

String getGatewayProviderPackageName()

Package name of the gateway provider service that provided the gateway information.

Uri getOriginalAddress()

Returns the address that the user is trying to connect to via the gateway.

boolean isEmpty()

Indicates whether this GatewayInfo instance contains any data.

void writeToParcel(Parcel destination, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

added in API level 23
Creator<GatewayInfo> CREATOR

The Parcelable interface.

Public constructors

GatewayInfo

added in API level 23
GatewayInfo (String packageName, 
                Uri gatewayUri, 
                Uri originalAddress)

Parameters
packageName String

gatewayUri Uri

originalAddress Uri

Public methods

describeContents

added in API level 23
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.

getGatewayAddress

added in API level 23
Uri getGatewayAddress ()

Returns the gateway address to dial when placing the call.

Returns
Uri

getGatewayProviderPackageName

added in API level 23
String getGatewayProviderPackageName ()

Package name of the gateway provider service that provided the gateway information. This can be used to identify the gateway address source and to load an appropriate icon when displaying gateway information in the in-call UI.

Returns
String

getOriginalAddress

added in API level 23
Uri getOriginalAddress ()

Returns the address that the user is trying to connect to via the gateway.

Returns
Uri

isEmpty

added in API level 23
boolean isEmpty ()

Indicates whether this GatewayInfo instance contains any data. A returned value of false indicates that no gateway number is being used for the call.

Returns
boolean

writeToParcel

added in API level 23
void writeToParcel (Parcel destination, 
                int flags)

Flatten this object in to a Parcel.

Parameters
destination 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_WRITE_RETURN_VALUE.