GatewayInfo
open class GatewayInfo : Parcelable
kotlin.Any | |
↳ | 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 ConnectionService
s 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:
- Call the appropriate gateway address.
- Display information about how the call is being routed to the user.
Summary
Inherited constants | |
---|---|
Public constructors | |
---|---|
GatewayInfo(packageName: String!, gatewayUri: Uri!, originalAddress: Uri!) |
Public methods | |
---|---|
open Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
open Uri! |
Returns the gateway address to dial when placing the call. |
open String! |
Package name of the gateway provider service that provided the gateway information. |
open Uri! |
Returns the address that the user is trying to connect to via the gateway. |
open Boolean |
isEmpty() Indicates whether this |
open Unit |
writeToParcel(destination: Parcel, flags: Int) Flatten this object in to a Parcel. |
Properties | |
---|---|
static Parcelable.Creator<GatewayInfo!> |
The Parcelable interface. |
Public constructors
GatewayInfo
GatewayInfo(
packageName: String!,
gatewayUri: Uri!,
originalAddress: Uri!)
Public methods
describeContents
open fun describeContents(): Int
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.
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
getGatewayAddress
open fun getGatewayAddress(): Uri!
Returns the gateway address to dial when placing the call.
getGatewayProviderPackageName
open fun getGatewayProviderPackageName(): String!
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.
getOriginalAddress
open fun getOriginalAddress(): Uri!
Returns the address that the user is trying to connect to via the gateway.
isEmpty
open fun isEmpty(): Boolean
Indicates whether this GatewayInfo
instance contains any data. A returned value of false indicates that no gateway number is being used for the call.
writeToParcel
open fun writeToParcel(
destination: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
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_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
Properties
CREATOR
static val CREATOR: Parcelable.Creator<GatewayInfo!>
The Parcelable interface.