TwilioConversations (conversations API)

java.lang.Object
- com.twilio.conversations.TwilioConversations

public class TwilioConversations
extends Object

Twilio Conversations SDK

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`TwilioConversations.InitListener` Interface for the listener object to pass to `initialize(Context, InitListener)`.
`class`	`TwilioConversations.LogLevel` Log levels for the Twilio Conversations SDK

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CLIENT_DISCONNECTED` The client disconnected unexpectedly.
`static int`	`CLIENT_REGISTATION_ERROR` There was an error during Client registration.
`static int`	`CONVERSATION_FAILED` The Conversation failed to start.
`static int`	`CONVERSATION_IGNORED` The Client was busy; and could not handle your invitation.
`static int`	`CONVERSATION_PARTICIPANT_NOT_AVAILABLE` The Client you invited was not available.
`static int`	`CONVERSATION_REJECTED` The Client rejected your invitation.
`static int`	`CONVERSATION_TERMINATED` The Conversation was terminated due to an unforeseen error.
`static int`	`INVALID_AUTH_DATA` Authenticating your Client failed due to invalid auth credentials.
`static int`	`INVALID_CONVERSATION` The Conversation was invalid.
`static int`	`INVALID_PARTICIPANT_ADDRESSES` The remote client address was invalid.
`static int`	`INVALID_SIP_ACCOUNT` The SIP account was invalid.
`static int`	`INVALID_VIDEO_CAPTURER` An invalid video capturer was added to the local media
`static int`	`INVALID_VIDEO_TRACK_STATE` An attempt was made to remove a track that has already ended.
`static int`	`PEER_CONNECTION_FAILED` Establishing a media connection with the remote peer failed.
`static int`	`TOO_MANY_ACTIVE_CONVERSATIONS` Too many active Conversations.
`static int`	`TOO_MANY_TRACKS` Too many tracks were added to the local media.
`static int`	`TRACK_OPERATION_IN_PROGRESS` An attempt was made to add or remove a track that is already being operated on.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ConversationsClient`	`createConversationsClient(String token, ConversationsClientListener listener)` Creates a new ConversationsClient.
`static ConversationsClient`	`createConversationsClient(TwilioAccessManager accessManager, ConversationsClientListener listener)` Creates a new `ConversationsClient`.
`static void`	`destroy()` Dispose the Twilio Conversations SDK.
`static int`	`getLogLevel()` Gets the logging level for messages logged by the Twilio Conversations SDK.
`static String`	`getVersion()` Returns the version of the Twilio Conversations SDK.
`static void`	`initialize(Context context, TwilioConversations.InitListener initListener)` Initialize the Twilio Conversations SDK.
`static boolean`	`isInitialized()` Informs whether `TwilioConversations` is initialized or not.
`static void`	`setLogLevel(int level)` Sets the logging level for messages logged by the Twilio Conversations SDK.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INVALID_AUTH_DATA
```
public static final int INVALID_AUTH_DATA
```
    Authenticating your Client failed due to invalid auth credentials.
    
    See Also:
    
    Constant Field Values
  - INVALID_SIP_ACCOUNT
```
public static final int INVALID_SIP_ACCOUNT
```
    The SIP account was invalid.
    
    See Also:
    
    Constant Field Values
  - CLIENT_REGISTATION_ERROR
```
public static final int CLIENT_REGISTATION_ERROR
```
    There was an error during Client registration.
    
    See Also:
    
    Constant Field Values
  - INVALID_CONVERSATION
```
public static final int INVALID_CONVERSATION
```
    The Conversation was invalid.
    
    See Also:
    
    Constant Field Values
  - CONVERSATION_PARTICIPANT_NOT_AVAILABLE
```
public static final int CONVERSATION_PARTICIPANT_NOT_AVAILABLE
```
    The Client you invited was not available.
    
    See Also:
    
    Constant Field Values
  - CONVERSATION_REJECTED
```
public static final int CONVERSATION_REJECTED
```
    The Client rejected your invitation.
    
    See Also:
    
    Constant Field Values
  - CONVERSATION_IGNORED
```
public static final int CONVERSATION_IGNORED
```
    The Client was busy; and could not handle your invitation.
    
    See Also:
    
    Constant Field Values
  - CONVERSATION_FAILED
```
public static final int CONVERSATION_FAILED
```
    The Conversation failed to start.
    
    See Also:
    
    Constant Field Values
  - CONVERSATION_TERMINATED
```
public static final int CONVERSATION_TERMINATED
```
    The Conversation was terminated due to an unforeseen error.
    
    See Also:
    
    Constant Field Values
  - PEER_CONNECTION_FAILED
```
public static final int PEER_CONNECTION_FAILED
```
    Establishing a media connection with the remote peer failed.
    
    See Also:
    
    Constant Field Values
  - INVALID_PARTICIPANT_ADDRESSES
```
public static final int INVALID_PARTICIPANT_ADDRESSES
```
    The remote client address was invalid.
    
    See Also:
    
    Constant Field Values
  - CLIENT_DISCONNECTED
```
public static final int CLIENT_DISCONNECTED
```
    The client disconnected unexpectedly.
    
    See Also:
    
    Constant Field Values
  - TOO_MANY_ACTIVE_CONVERSATIONS
```
public static final int TOO_MANY_ACTIVE_CONVERSATIONS
```
    Too many active Conversations.
    
    See Also:
    
    Constant Field Values
  - TOO_MANY_TRACKS
```
public static final int TOO_MANY_TRACKS
```
    Too many tracks were added to the local media.
    
    See Also:
    
    Constant Field Values
  - INVALID_VIDEO_CAPTURER
```
public static final int INVALID_VIDEO_CAPTURER
```
    An invalid video capturer was added to the local media
    
    See Also:
    
    Constant Field Values
  - TRACK_OPERATION_IN_PROGRESS
```
public static final int TRACK_OPERATION_IN_PROGRESS
```
    An attempt was made to add or remove a track that is already being operated on.
    
    See Also:
    
    Constant Field Values
  - INVALID_VIDEO_TRACK_STATE
```
public static final int INVALID_VIDEO_TRACK_STATE
```
    An attempt was made to remove a track that has already ended.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - initialize
```
public static void initialize(Context context,
                              TwilioConversations.InitListener initListener)
```
    Initialize the Twilio Conversations SDK.
    
    Parameters:
    
    context - The application context of your Android application
    
    initListener - A TwilioConversations.InitListener that will notify you when the service is ready
  - destroy
```
public static void destroy()
```
    Dispose the Twilio Conversations SDK. Note that once this completes all ConversationsClient are destroyed and are no longer usable.
  - isInitialized
```
public static boolean isInitialized()
```
    Informs whether TwilioConversations is initialized or not.
    
    Returns:
    
    true if Twilio Conversations client is initialized, false otherwise.
  - getLogLevel
```
public static int getLogLevel()
```
    Gets the logging level for messages logged by the Twilio Conversations SDK.
    
    Returns:
    
    the logging level
  - setLogLevel
```
public static void setLogLevel(int level)
```
    Sets the logging level for messages logged by the Twilio Conversations SDK.
    
    Parameters:
    
    level - The logging level
  - createConversationsClient
```
public static ConversationsClient createConversationsClient(String token,
                                                            ConversationsClientListener listener)
```
    Creates a new ConversationsClient.
    
    Parameters:
    
    token - The access token.
    
    listener - A listener that receives events from the conversations client.
    
    Returns:
    
    the initialized ConversationsClient, or null if the Twilio Conversations Client was not initialized
  - createConversationsClient
```
public static ConversationsClient createConversationsClient(TwilioAccessManager accessManager,
                                                            ConversationsClientListener listener)
```
    Creates a new ConversationsClient.
    
    Parameters:
    
    accessManager - The instance of TwilioAccessManager that is handling token lifetime
    
    listener - A listener that receive events from the ConversationsClient.
    
    Returns:
    
    the initialized ConversationsClient, or null if the Twilio Conversations Client was not initialized
  - getVersion
```
public static String getVersion()
```
    Returns the version of the Twilio Conversations SDK.
    
    Returns:
    
    the version of the SDK

Class TwilioConversations

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_AUTH_DATA

INVALID_SIP_ACCOUNT

CLIENT_REGISTATION_ERROR

INVALID_CONVERSATION

CONVERSATION_PARTICIPANT_NOT_AVAILABLE

CONVERSATION_REJECTED

CONVERSATION_IGNORED

CONVERSATION_FAILED

CONVERSATION_TERMINATED

PEER_CONNECTION_FAILED

INVALID_PARTICIPANT_ADDRESSES

CLIENT_DISCONNECTED

TOO_MANY_ACTIVE_CONVERSATIONS

TOO_MANY_TRACKS

INVALID_VIDEO_CAPTURER

TRACK_OPERATION_IN_PROGRESS

INVALID_VIDEO_TRACK_STATE

Method Detail

initialize

destroy

isInitialized

getLogLevel

setLogLevel

createConversationsClient

createConversationsClient

getVersion