Android APIs
public class

GatewayInfo

extends Object
implements Parcelable
java.lang.Object
   ↳ android.telecom.GatewayInfo

Class Overview

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

[Expand]
Inherited Constants
From interface android.os.Parcelable
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's marshalled 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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<GatewayInfo> CREATOR

Added in API level 23

The Parcelable interface.

Public Constructors

public GatewayInfo (String packageName, Uri gatewayUri, Uri originalAddress)

Added in API level 23

Public Methods

public int describeContents ()

Added in API level 23

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

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public Uri getGatewayAddress ()

Added in API level 23

Returns the gateway address to dial when placing the call.

public String getGatewayProviderPackageName ()

Added in API level 23

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.

public Uri getOriginalAddress ()

Added in API level 23

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

public boolean isEmpty ()

Added in API level 23

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

public void writeToParcel (Parcel destination, int flags)

Added in API level 23

Flatten this object in to a Parcel.

Parameters
destination The Parcel in which the object should be written.
flags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.