The SDK provides a callback mechanism to keep the host app updated on events related to the conversation. This section details each callback.

Note: There are 2 ways to register to LivePerson events. For more information, click here.

Conversation Events

Conversation Started

Called whenever either the consumer or the agent starts a new conversation.

Intent Action:

ILivePersonIntentAction.LP_ON_CONVERSATION_STARTED_INTENT_ACTION

• To get the convData param from the Intent, use LivePersonIntents.getLPConversationData(intent).

Callback:

onConversationStarted(LPConversationData convData)

Deprecated since April 26, 2017
onConversationStarted()

Conversation Resolved

Called when the current conversation is marked as resolved by either the consumer or the agent.

Intent Action:

ILivePersonIntentAction.LP_ON_CONVERSATION_RESOLVED_INTENT_ACTION

• To get the convData param from the Intent, use LivePersonIntents.getLPConversationData(intent).

Callback:

onConversationResolved(LPConversationData convData)

Deprecated since February 13, 2017
onConversationResolved()

Deprecated since April 26, 2017
onConversationResolved(CloseReason reason)

Conversation Fragment Closed

Called when the Conversation Fragment is closed (only called when using Fragment Mode).

Intent Action:

ILivePersonIntentAction.LP_ON_CONVERSATION_FRAGMENT_CLOSED_INTENT_ACTION

Callback:

onConversationFragmentClosed()

Conversation Marked as Urgent

Called when the current conversation gets marked as urgent by either the consumer or the agent.

Intent Action:

ILivePersonIntentAction.LP_ON_CONVERSATION_MARKED_AS_URGENT_INTENT_ACTION

Callback:

onConversationMarkedAsUrgent()

Conversation Marked as Normal

Called when the current conversation gets marked as normal by either the consumer or the agent.

Intent Action:

ILivePersonIntentAction.LP_ON_CONVERSATION_MARKED_AS_NORMAL_INTENT_ACTION

Callback:

onConversationMarkedAsNormal()

Agent Action Events

Agent details changed

Called when the assigned agent of the current conversation has changed, or their details are updated. When no agent is associated with the conversation, the callback passes a null value. For example, this happens when an agent returns the consumer to the request queue.

Note: You must check for null value before using the agentData object.

Intent Action:

ILivePersonIntentAction.LP_ON_AGENT_DETAILS_CHANGED_INTENT_ACTION

• To get the agentData param from the Intent, use LivePersonIntents.getAgentData(intent).

Callback:

onAgentDetailsChanged(AgentData agentData)

Agent typing

Called when the assigned agent is typing a message. When there are 2 seconds of idle time, the callback returns false to indicate that the agent stopped typing.

Intent Action:

ILivePersonIntentAction.LP_ON_AGENT_TYPING_INTENT_ACTION

• To get the isTyping param from the Intent, use LivePersonIntents.getAgentTypingValue(intent).

Callback:

onAgentTyping(boolean isTyping)

Offline Hours Changed

Called when there is a change in agent availability.

Intent Action:

ILivePersonIntentAction.LP_ON_OFFLINE_HOURS_CHANGES_INTENT_ACTION

• To get the isOfflineHoursOn param from the Intent, use LivePersonIntents.getOfflineHoursOn(intent).

Callback:

onOfflineHoursChanges(boolean isOfflineHoursOn)

User Action Events

User Denied Permission

Android version supported: 6.0 and above

Called if the user denied a necessary system permission for the action they tried to perform. For example, when the user clicks on the camera/gallery button to add an image, the permission system dialog was displayed, and the user denied permission.

Intent Action:

ILivePersonIntentAction.LP_ON_USER_DENIED_PERMISSION

• To get the permissionType param from the Intent, use LivePersonIntents.getPermissionType(intent).
• To get the doNotShowAgainMarked param from the Intent, use LivePersonIntents.getPermissionDoNotShowAgainMarked(intent).

Callbacks:

onUserDeniedPermission(PermissionType permissionType, boolean doNotShowAgainMarked);

User Action On Prevented Permission

Android version supported: 6.0 (Marshmallow; API 23) and above

Called before requiring a permission that the user has not yet accepted. For example, when the user clicks the camera or gallery buttons to add an image, this callback gets called just before the permission dialog is displayed. If the user already allowed permission, this callback does not get called.

Intent Action:

ILivePersonIntentAction.LP_ON_USER_ACTION_ON_PREVENTED_PERMISSION

• To get the permissionType param from the Intent, use LivePersonIntents.getPermissionType(intent).

Callback:

onUserActionOnPreventedPermission(PermissionType permissionType)

Agent avatar tapped

Called when the user taps on the agent avatar.

The icon is available next to the agent message bubble or on the top of the toolbar (if using activity mode).

Intent Action:

ILivePersonIntentAction.LP_ON_AGENT_AVATAR_TAPPED_INTENT_ACTION

• To get the agentData param from the Intent, use LivePersonIntents.getAgentData(intent).

Callback:

onAgentAvatarTapped (AgentData agentData)

Structured Content Link Clicked

Called when a structured content control with Link action gets clicked.

This callback only gets called if the structured_content_link_as_callback parameter in the branding.xml is set to true.

Intent Action:

ILivePersonIntentAction.LP_ON_STRUCTURED_CONTENT_LINK_CLICKED

• To get the uri param from the Intent, use LivePersonIntents.getLinkUri(intent).

Callback:

onStructuredContentLinkClicked(String uri)

Remote message Link Clicked

Since version 5.23.1.

Called when a link within text/file message, sent by brand/agent/bot/system or in structured content message, was clicked.

This callback only gets called if the lp_message_link_as_callback parameter in the branding.xml is set to true. For structured content messages in case when both structured_content_link_as_callback and lp_message_link_as_callback are enabled, callback method onStructuredContentLinkClicked will be called only, because it has higher priority.

Intent Action:

ILivePersonIntentAction.LP_ON_MESSAGE_LINK_CLICKED

• To get the url param from the Intent, use LivePersonIntents.getLinkUri(intent).

Callback:

onLinkClicked(String url)

Survey Events

CSAT Screen Launched

Called when the feedback screen launches.

Intent Action:

ILivePersonIntentAction.LP_ON_CSAT_LAUNCHED_INTENT_ACTION

Callback:

onCsatLaunched()

CSAT Screen Dismissed

Called when the feedback screen gets dismissed with any result, positive or negative. (The user taps the Submit, Skip, or Back buttons.)

Intent Action:

ILivePersonIntentAction.LP_ON_CSAT_DISMISSED_INTENT_ACTION

Callback:

onCsatDismissed()

CSAT Screen Submitted

Called when the user taps the Submit button on the feedback screen. The onCsatDismissed callback is called as well.

Intent Action:

ILivePersonIntentAction.LP_ON_CSAT_SUBMITTED_INTENT_ACTION

• To get the conversationID param from the Intent, use LivePersonIntents.getConversationID(intent).
• To get the starRating param from the Intent, use LivePersonIntents.getCsatStarRating(intent).

Callback:

onCsatSubmitted(String conversationId, int starRating)

Deprecated since August 19, 2019
onCsatSubmitted(String conversationId)

CSAT Screen Skipped

Called when the user taps the Skip or Back buttons. The onCsatDismissed callback is called as well.

Intent Action:

ILivePersonIntentAction.LP_ON_CSAT_SKIPPED_INTENT_ACTION

Callback:

onCsatSkipped()

Authentication Events

Token Expired

Called if the token used in the session has expired and is no longer valid. The host app needs to reconnect with a new authentication key.

Intent Action:

ILivePersonIntentAction.LP_ON_TOKEN_EXPIRED_INTENT_ACTION

Callback:

onTokenExpired()

Unauthenticated User Expired

Called if the temporary user authentication used specifically in an Unauthenticated type flow expires.

Intent Action:

ILivePersonIntentAction.LP_ON_UNAUTHENTICATED_USER_EXPIRED_INTENT_ACTION

Callback:

onUnauthenticatedUserExpired()

Connection Events

Connection State has Changed

Called when the connection to the conversation server has been established or disconnected.

Intent Action:

ILivePersonIntentAction.LP_ON_CONNECTION_CHANGED_INTENT_ACTION

• To get the isConnected param from the Intent, use LivePersonIntents.getConnectedValue(intent).

Callback:

onConnectionChanged(boolean isConnected)

Error Events

Multi-Type Error Indication

Called to indicate that an internal SDK error occurred.

Intent Action:

ILivePersonIntentAction.LP_ON_ERROR_INTENT_ACTION

• Deprecated since September 28, 2020.
• To get the type param from the Intent, use LivePersonIntents.getOnErrorTaskType(intent).
• To get the message param from the Intent, use LivePersonIntents.getOnErrorMessage(intent).

Callback:

onError(TaskType type, String message)

Intent Action:

ILivePersonIntentAction.LP_ON_ERROR_TYPE_INTENT_ACTION

• To get the type param from the Intent, use LivePersonIntents.getErrorType(intent).
• To get the message param from the Intent, use LivePersonIntents.getOnErrorMessage(intent).

Callback:

onError(LpError lpError, String message);

Welcome message Events

On Welcome message option tapped

Since version 5.23.0. Called when user taps on welcome message option.

Intent Action:

ILivePersonIntentAction.LP_ON_WELCOME_MESSAGE_OPTION_TAPPED

• To get an actual value of tapped option's title, use LivePersonIntents.getTappedOptionTitle(intent).

Callback:

onWelcomeMessageOptionTapped(String title);

LivePerson Callbacks

Definition:

public interface LivePersonCallback {
    // Conversation Events
    void onConversationStarted(LPConversationData convData);
    @Deprecated @LPDeprecated(since = 1493164800) // April 26, 2017
    void onConversationStarted();
    void onConversationResolved(LPConversationData convData);
    @Deprecated @LPDeprecated(since = 1486944000) // February 13, 2017
    void onConversationResolved();
    @Deprecated @LPDeprecated(since = 1493164800) // April 26, 2017
    void onConversationResolved(CloseReason reason);
    void onConversationFragmentClosed();
    void onConversationMarkedAsUrgent();
    void onConversationMarkedAsNormal();

    // Agent Events
    void onAgentTyping(boolean isTyping);
    void onAgentDetailsChanged(AgentData agentData);
    void onOfflineHoursChanges(boolean isOfflineHoursOn);

    // User Action Events
    void onUserDeniedPermission(PermissionType permissionType, boolean doNotShowAgainMarked);
    void onUserActionOnPreventedPermission(PermissionType permissionType);
    void onAgentAvatarTapped(AgentData agentData);
    void onStructuredContentLinkClicked(String uri);

    // Survey Events
    void onCsatLaunched();
    void onCsatDismissed();
    @Deprecated
    @LPDeprecated(since = 1566261196) // August 19, 2019
    void onCsatSubmitted(String conversationId);
    void onCsatSubmitted(String conversationId,int starRating);
    void onCsatSkipped();

    // Authentication Events
    void onTokenExpired();
    void onUnauthenticatedUserExpired();

    // Connection Events
    void onConnectionChanged(boolean isConnected);

    // Error Events
    @Deprecated @LPDeprecated(since = 1601280000) // September 28, 2020
    void onError(TaskType type, String message);
    void onError(LpError lpError, String message);

    // Welcome message tapped events
    // Since version 5.23.0
    void onWelcomeMessageOptionTapped(String title);

    // Link navigation interception events
    // Since version 5.23.1
    void onLinkClicked(String url);
}

LivePerson Intents

Intent Actions

public interface ILivePersonIntentAction {
    // Conversation Events
    String LP_ON_CONVERSATION_STARTED_INTENT_ACTION = "LP_ON_CONVERSATION_STARTED_INTENT_ACTION";
    String LP_ON_CONVERSATION_RESOLVED_INTENT_ACTION = "LP_ON_CONVERSATION_RESOLVED_INTENT_ACTION";
    String LP_ON_CONVERSATION_FRAGMENT_CLOSED_INTENT_ACTION = "LP_ON_CONVERSATION_FRAGMENT_CLOSED_INTENT_ACTION";
    String LP_ON_CONVERSATION_MARKED_AS_URGENT_INTENT_ACTION = "LP_ON_CONVERSATION_MARKED_AS_URGENT_INTENT_ACTION";
    String LP_ON_CONVERSATION_MARKED_AS_NORMAL_INTENT_ACTION = "LP_ON_CONVERSATION_MARKED_AS_NORMAL_INTENT_ACTION";

    // Agent Action Events
    String LP_ON_AGENT_TYPING_INTENT_ACTION = "LP_ON_AGENT_TYPING_INTENT_ACTION";
    String LP_ON_AGENT_DETAILS_CHANGED_INTENT_ACTION = "LP_ON_AGENT_DETAILS_CHANGED_INTENT_ACTION";
    String LP_ON_OFFLINE_HOURS_CHANGES_INTENT_ACTION = "LP_ON_OFFLINE_HOURS_CHANGES_INTENT_ACTION";

    // User Action Events
    String LP_ON_USER_DENIED_PERMISSION = "LP_ON_USER_DENIED_PERMISSION";
    String LP_ON_USER_ACTION_ON_PREVENTED_PERMISSION = "LP_ON_USER_ACTION_ON_PREVENTED_PERMISSION";
    String LP_ON_AGENT_AVATAR_TAPPED_INTENT_ACTION = "LP_ON_AGENT_AVATAR_TAPPED_INTENT_ACTION";
    String LP_ON_STRUCTURED_CONTENT_LINK_CLICKED = "LP_ON_STRUCTURED_CONTENT_LINK_CLICKED";

    // Survey Events
    String LP_ON_CSAT_LAUNCHED_INTENT_ACTION = "LP_ON_CSAT_LAUNCHED_INTENT_ACTION";
    String LP_ON_CSAT_DISMISSED_INTENT_ACTION = "LP_ON_CSAT_DISMISSED_INTENT_ACTION";
    String LP_ON_CSAT_SUBMITTED_INTENT_ACTION = "LP_ON_CSAT_SUBMITTED_INTENT_ACTION";
    String LP_ON_CSAT_SKIPPED_INTENT_ACTION = "LP_ON_CSAT_SKIPPED_INTENT_ACTION";

    // Authentication Events
    String LP_ON_TOKEN_EXPIRED_INTENT_ACTION = "LP_ON_TOKEN_EXPIRED_INTENT_ACTION";
    String LP_ON_UNAUTHENTICATED_USER_EXPIRED_INTENT_ACTION = "LP_ON_UNAUTHENTICATED_USER_EXPIRED_INTENT_ACTION";

    // Connection Events
    String LP_ON_CONNECTION_CHANGED_INTENT_ACTION = "LP_ON_CONNECTION_CHANGED_INTENT_ACTION";

    // Error Events
    String LP_ON_ERROR_INTENT_ACTION = "LP_ON_ERROR_INTENT_ACTION";

    // Welcome message tapped events
    // Since version 5.23.0
    String LP_ON_WELCOME_MESSAGE_OPTION_TAPPED = "LP_ON_WELCOME_MESSAGE_OPTION_TAPPED";

    // Link navigation interception events
    // Since version 5.23.1
    String LP_ON_MESSAGE_LINK_CLICKED = "LP_ON_MESSAGE_LINK_CLICKED";
}

Intent parameter 'Extras'

public interface ILivePersonIntentExtras{
    // Conversation Extras
    String LP_CONVERSATION_DATA_INTENT_PARCELABLE_EXTRA = "LP_CONVERSATION_DATA_INTENT_PARCELABLE_EXTRA";

    // Agent Extras
    String LP_AGENT_IS_TYPING_INTENT_BOOLEAN_EXTRA = "LP_AGENT_IS_TYPING_INTENT_BOOLEAN_EXTRA";
    String LP_AGENT_DATA_INTENT_PARCELABLE_EXTRA = "LP_AGENT_DATA_INTENT_PARCELABLE_EXTRA";
    String LP_IS_OFFLINE_HOURS_ON_INTENT_BOOLEAN_EXTRA = "LP_IS_OFFLINE_HOURS_ON_INTENT_BOOLEAN_EXTRA";

    // User Extras
    String LP_PERMISSION_TYPE_EXTRA = "LP_PERMISSION_TYPE_EXTRA";
    String LP_PERMISSION_DO_NOT_SHOW_AGAIN_EXTRA = "LP_PERMISSION_DO_NOT_SHOW_AGAIN_EXTRA";
    String LP_LINK_URI_EXTRA = "LP_LINK_URI_EXTRA";

    // Survey Extras
    String LP_CONVERSATION_ID_INTENT_STRING_EXTRA = "LP_CONVERSATION_ID_INTENT_STRING_EXTRA";
    String LP_CSAT_STAR_RATING_INTENT_INT_EXTRA = "LP_CSAT_STAR_RATING_INTENT_INT_EXTRA";

    // Connection Extras
    String LP_IS_CONNECTED_INTENT_BOOLEAN_EXTRA = "LP_IS_CONNECTED_INTENT_BOOLEAN_EXTRA";

    // Error Extras
    @Deprecated @LPDeprecated(since = 1601280000) // September 28, 2020
    String LP_ON_ERROR_TASK_TYPE_INTENT_INT_EXTRA = "LP_ON_ERROR_TASK_TYPE_INTENT_INT_EXTRA";
    String LP_ON_ERROR_INTENT_INT_EXTRA = "LP_ON_ERROR_INTENT_INT_EXTRA";
    String LP_ON_ERROR_MESSAGE_INTENT_STRING_EXTRA = "LP_ON_ERROR_MESSAGE_INTENT_STRING_EXTRA";
    
    // Welcome message tapped events
    // Since version 5.23.0
    String LP_TAPPED_OPTION_TITLE_EXTRA = "LP_TAPPED_OPTION_TITLE_EXTRA";
}

TaskType enum

/**
* @deprecated Since September 28, 2020
*/
enum TaskType {
  CSDS,
  IDP,
  VERSION,
  OPEN_SOCKET,
  INVALID_CERTIFICATE,
  USER_EXPIRED,
  CLOSING_SOCKET
}

LpError enum

enum class LpError {
  IDP,
  CSDS,
  INVALID_CERTIFICATE,
  SOCKET,
  TIMEOUT,
  INVALID_SDK_VERSION,
  UNKNOWN,
  STEP_UP_FAILURE
}