ConnectionRequest
public final class ConnectionRequest
extends Object
implements Parcelable
java.lang.Object | |
↳ | android.telecom.ConnectionRequest |
Simple data container encapsulating a request to some entity to create a new Connection
.
Summary
Inherited constants |
---|
Fields | |
---|---|
public static final Creator<ConnectionRequest> | CREATOR
|
Public constructors | |
---|---|
ConnectionRequest(PhoneAccountHandle accountHandle, Uri handle, Bundle extras) | |
ConnectionRequest(PhoneAccountHandle accountHandle, Uri handle, Bundle extras, int videoState) |
Public methods | |
---|---|
int | describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
PhoneAccountHandle | getAccountHandle() The account which should be used to place the call. |
Uri | getAddress() The handle (e.g., phone number) to which the |
Bundle | getExtras() Application-specific extra data. |
List<Uri> | getParticipants() The participants to which the |
Connection.RttTextStream | getRttTextStream() Gets the |
int | getVideoState() Describes the video states supported by the client requesting the connection. |
boolean | isAdhocConferenceCall() |
boolean | isRequestingRtt() Convenience method for determining whether the ConnectionRequest is requesting an RTT session |
String | toString() Returns a string representation of the object. |
void | writeToParcel(Parcel destination, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public constructors
ConnectionRequest
public ConnectionRequest (PhoneAccountHandle accountHandle, Uri handle, Bundle extras)
Parameters | |
---|---|
accountHandle | PhoneAccountHandle : The accountHandle which should be used to place the call. |
handle | Uri : The handle (e.g., phone number) to which the Connection is to connect. |
extras | Bundle : Application-specific extra data. |
ConnectionRequest
public ConnectionRequest (PhoneAccountHandle accountHandle, Uri handle, Bundle extras, int videoState)
Parameters | |
---|---|
accountHandle | PhoneAccountHandle : The accountHandle which should be used to place the call. |
handle | Uri : The handle (e.g., phone number) to which the Connection is to connect. |
extras | Bundle : Application-specific extra data. |
videoState | int : Determines the video state for the connection. |
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 0 or CONTENTS_FILE_DESCRIPTOR |
getAccountHandle
public PhoneAccountHandle getAccountHandle ()
The account which should be used to place the call.
Returns | |
---|---|
PhoneAccountHandle |
getAddress
public Uri getAddress ()
The handle (e.g., phone number) to which the Connection
is to connect.
Returns | |
---|---|
Uri |
getExtras
public Bundle getExtras ()
Application-specific extra data. Used for passing back information from an incoming call Intent
, and for any proprietary extensions arranged between a client and servant ConnectionService
which agree on a vocabulary for such data.
Returns | |
---|---|
Bundle |
getParticipants
public List<Uri> getParticipants ()
The participants to which the Connection
is to connect.
Returns | |
---|---|
List<Uri> | This value may be null . |
getRttTextStream
public Connection.RttTextStream getRttTextStream ()
Gets the Connection.RttTextStream
object that should be used to send and receive RTT text to/from the in-call app.
Returns | |
---|---|
Connection.RttTextStream | An instance of Connection.RttTextStream , or null if this connection request is not requesting an RTT session upon connection establishment. |
getVideoState
public int getVideoState ()
Describes the video states supported by the client requesting the connection. Valid values: VideoProfile.STATE_AUDIO_ONLY
, VideoProfile.STATE_BIDIRECTIONAL
, VideoProfile.STATE_TX_ENABLED
, VideoProfile.STATE_RX_ENABLED
.
Returns | |
---|---|
int | The video state for the connection. |
isAdhocConferenceCall
public boolean isAdhocConferenceCall ()
Returns | |
---|---|
boolean | true if the call is a adhoc conference call else @return false |
isRequestingRtt
public boolean isRequestingRtt ()
Convenience method for determining whether the ConnectionRequest is requesting an RTT session
Returns | |
---|---|
boolean | true if RTT is requested, false otherwise. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String | a string representation of the object. |
writeToParcel
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 |