Added in API level 23

Summary: Inherited Constants | Fields | Ctors | Methods | Inherited Methods

GatewayInfo

---

Kotlin |Java

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

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout 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 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
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 23

public static final Creator<GatewayInfo> CREATOR

The Parcelable interface.

Public constructors

GatewayInfo

Added in API level 23

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

Parameters
packageName	String
gatewayUri	Uri
originalAddress	Uri

Public methods

describeContents

Added in API level 23

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 0 or CONTENTS_FILE_DESCRIPTOR

getGatewayAddress

Added in API level 23

public Uri getGatewayAddress ()

Returns the gateway address to dial when placing the call.

Returns
Uri

getGatewayProviderPackageName

Added in API level 23

public 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

public Uri getOriginalAddress ()

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

Returns
Uri

isEmpty

Added in API level 23

public 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

public 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. This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES