com.twilio.voice

Class CallInvite

java.lang.Object

com.twilio.voice.CallInvite

All Implemented Interfaces:

android.os.Parcelable

public class CallInvite
extends Object
implements android.os.Parcelable

Represents an incoming call message from Twilio. This object is used to respond to an incoming call by calling accept() or reject(). CallInvite.State transitions from PENDING to ACCEPTED, REJECTED or CANCELED.

Initial state of CallInvite is CallInvite.State.PENDING.

CallInvite transitions to CallInvite.State.ACCEPTED state when accept() is called.

CallInvite transitions to CallInvite.State.REJECTED state when reject() is called.

CallInvite transitions to CallInvite.State.CANCELED state when CallInvite.messageType is "twilio.voice.cancel".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallInvite.State

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
Call	accept(android.content.Context context, AcceptOptions acceptOptions, Call.Listener listener) Accepts the Call with ConnectOptions.
Call	accept(android.content.Context context, Call.Listener listener) Accepts the Call with ConnectOptions.
int	describeContents()
boolean	equals(Object o)
String	getCallSid() Returns the CallSid.
String	getFrom() Returns the caller information.
CallInvite.State	getState() Returns the current state of the call invite.
String	getTo() Returns the callee information.
void	reject(android.content.Context context) Rejects the Call.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Method Detail

getFrom

public String getFrom()

Returns the caller information.

getTo

public String getTo()

Returns the callee information.

getCallSid

public String getCallSid()

Returns the CallSid.

getState

public CallInvite.State getState()

Returns the current state of the call invite.

CallInvite is in CallInvite.State.PENDING state when it is created.

CallInvite transitions to CallInvite.State.ACCEPTED state when accepted.

CallInvite transitions to CallInvite.State.REJECTED state when rejected.

CallInvite transitions to CallInvite.State.CANCELED state when cancelled.

Returns:

Provides the state of this call invite.

accept

public Call accept(android.content.Context context,
                   AcceptOptions acceptOptions,
                   Call.Listener listener)

Accepts the Call with ConnectOptions.

A SecurityException will be thrown if RECORD_AUDIO is not granted.

Parameters:

context - The application context of your Android application.

acceptOptions - A set of options that allow you to configure your Call.

listener - A listener that receives call status.

Returns:

Will return null if the CallInvite is in CallInvite.State.REJECTED or CallInvite.State.CANCELED state else will return a Call object.

accept

public Call accept(android.content.Context context,
                   Call.Listener listener)

Accepts the Call with ConnectOptions.

A SecurityException will be thrown if RECORD_AUDIO is not granted.

Parameters:

context - The application context of your Android application.

listener - A listener that receives call status.

Returns:

Will return null if the CallInvite is in CallInvite.State.REJECTED or CallInvite.State.CANCELED state else will return a Call object.

reject

public void reject(android.content.Context context)

Rejects the Call.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(Object o)

Overrides:

equals in class Object