A B C D E F G H I L M N O P R S T U V W

A

AbstractNotificationReceiver - Class in com.khoros.messaging.core

Abstract class that can be registered to receive Message notifications from FCM.

AbstractNotificationReceiver() - Constructor for class com.khoros.messaging.core.AbstractNotificationReceiver

ActionState - Enum in com.khoros.messaging.core

addConversationUiDelegate(int, ConversationDelegate) - Static method in class com.khoros.messaging.core.BrandMessenger

Add a ConversationDelegate used by the brandMessenger-ui package

addMessage(Message) - Method in interface com.khoros.messaging.core.Conversation

Adds a new message to the conversation without sending it.

addMessageAction(MessageAction) - Method in class com.khoros.messaging.core.Message

Adds a message action to the list of actions

addMessageAction(MessageAction) - Method in class com.khoros.messaging.core.MessageItem

Adds a message action to the list of actions

addMessageItem(MessageItem) - Method in class com.khoros.messaging.core.Message

Adds a message item to the list of items

addMetadata(Map<String, Object>) - Method in class com.khoros.messaging.core.User

Adds custom metadata to the user.

AuthenticationCallback - Interface in com.khoros.messaging.core

AuthenticationDelegate - Interface in com.khoros.messaging.core

AuthenticationError - Class in com.khoros.messaging.core

AuthenticationError(int, String) - Constructor for class com.khoros.messaging.core.AuthenticationError

B

beforeDisplay(ConversationDetails, Message) - Method in interface com.khoros.messaging.core.MessageModifierDelegate

Allows a delegate to modify the contents of a message before it's displayed in the conversation view.

beforeNotification(String, Message) - Method in interface com.khoros.messaging.core.MessageModifierDelegate

Allows a delegate to modify the contents of a message before it's displayed in a notification.

beforeSend(ConversationDetails, Message) - Method in interface com.khoros.messaging.core.MessageModifierDelegate

Allows a delegate to modify the contents of a message before sending to BrandMessenger servers.

BrandMessenger - Class in com.khoros.messaging.core

BrandMessenger Entry Point

BrandMessengerCallback<T> - Interface in com.khoros.messaging.core

Callback used to be notified of the result of an asynchronous action

BrandMessengerCallback.Response<T> - Class in com.khoros.messaging.core

The response body passed into a BrandMessengerCallback to pass along information about the result of the action being performed

BrandMessengerCallback.Response.Builder<T> - Class in com.khoros.messaging.core

Builder for creating instances of BrandMessengerCallback.Response with a status code and any additional information required for the callback being notified.

BrandMessengerConnectionStatus - Enum in com.khoros.messaging.core

BrandMessenger connection status.

brandMessengerHidden() - Method in interface com.khoros.messaging.core.Conversation

Notifies the delegate when BrandMessenger Conversation is hidden

brandMessengerShown() - Method in interface com.khoros.messaging.core.Conversation

Notifies the delegate when BrandMessenger Conversation is shown

build() - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response.Builder

Builds the BrandMessengerCallback.Response with the provided information

Builder(int) - Constructor for class com.khoros.messaging.core.BrandMessengerCallback.Response.Builder

Constructs an instance of this BrandMessengerCallback.Response.Builder

builder() - Static method in class com.khoros.messaging.ui.ConversationActivity

Returns a new builder for configuring and displaying ConversationActivity.

C

canUserCreateMoreConversations() - Method in class com.khoros.messaging.core.Config

CardSummary - Class in com.khoros.messaging.core

close() - Static method in class com.khoros.messaging.ui.ConversationActivity

Closes the conversation view.

closeFormFragment() - Method in class com.khoros.messaging.ui.ConversationActivity

com.khoros.messaging.core - package com.khoros.messaging.core

com.khoros.messaging.ui - package com.khoros.messaging.ui

compareTo(Message) - Method in class com.khoros.messaging.core.Message

Config - Class in com.khoros.messaging.core

ConnectionStatus - Enum in com.khoros.messaging.ui

User internet connection status.

Conversation - Interface in com.khoros.messaging.core

The Conversation provides an interface to interact with a user's conversation.

ConversationActivity - Class in com.khoros.messaging.ui

ConversationActivity() - Constructor for class com.khoros.messaging.ui.ConversationActivity

ConversationActivityBuilder - Class in com.khoros.messaging.ui

This builder is used to configure the ConversationActivity

ConversationDelegate - Interface in com.khoros.messaging.core

Delegate for events related to the conversation.

ConversationDelegateAdapter - Class in com.khoros.messaging.core

Abstract class that implements ConversationDelegate so individual methods can be overridden.

ConversationDelegateAdapter() - Constructor for class com.khoros.messaging.core.ConversationDelegateAdapter

ConversationDetails - Interface in com.khoros.messaging.core

Provides an interface to view the information of a Conversation.

ConversationEvent - Class in com.khoros.messaging.core

Object representing a conversation event.

ConversationEventType - Enum in com.khoros.messaging.core

ConversationViewDelegate - Interface in com.khoros.messaging.core

Delegate for events related to the conversation view.

ConversationViewDelegateAdapter - Class in com.khoros.messaging.core

Abstract class that implements ConversationViewDelegate

ConversationViewDelegateAdapter() - Constructor for class com.khoros.messaging.core.ConversationViewDelegateAdapter

Coordinates - Class in com.khoros.messaging.core

Coordinates(Double, Double) - Constructor for class com.khoros.messaging.core.Coordinates

Create coordinates with the given latitude/longitude.

copy() - Method in class com.khoros.messaging.core.Message

createConversation(String, String, String, List<Message>, Map<String, Object>, BrandMessengerCallback<Void>) - Static method in class com.khoros.messaging.core.BrandMessenger

Create a conversation for the current user.

CreditCard - Class in com.khoros.messaging.core

Object representing a user's credit card

CreditCard(String, int, int, String) - Constructor for class com.khoros.messaging.core.CreditCard

Create a credit card with the given details.

D

d(String, String, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs an Log.DEBUG level log message

d(String, String, Throwable, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.DEBUG level log message

destroy() - Static method in class com.khoros.messaging.core.BrandMessenger

Terminate the BrandMessenger facilities.

DisplaySettings - Class in com.khoros.messaging.core

E

e(String, String, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs an Log.ERROR level log message

e(String, String, Throwable, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.ERROR level log message

equals(Object) - Method in class com.khoros.messaging.core.Message

equals(Object) - Method in class com.khoros.messaging.core.MessageAction

equals(Object) - Method in class com.khoros.messaging.core.MessageItem

equals(Object) - Method in class com.khoros.messaging.core.Participant

F

FcmService - Class in com.khoros.messaging.core

Firebase Cloud Messaging Service

FcmService() - Constructor for class com.khoros.messaging.core.FcmService

findByValue(String) - Static method in enum com.khoros.messaging.core.ConversationEventType

Utility method to find the enum value of the provided string.

findByValue(String) - Static method in enum com.khoros.messaging.core.MessageType

Utility method to find the enum value of the provided string.

G

getAmount() - Method in class com.khoros.messaging.core.MessageAction

The price of the action

getAppName() - Method in class com.khoros.messaging.core.Config

String representing the name of the app

getAuthCode() - Method in class com.khoros.messaging.core.Settings

The auth code being used to authenticate as an existing user.

getAuthenticationDelegate() - Method in class com.khoros.messaging.core.Settings

A delegate to be notified about a failed request due to invalid credentials.

getAvatarUrl() - Method in class com.khoros.messaging.core.ConversationEvent

Returns the avatar URL of the participant related to this event if this event type is ConversationEventType.CONVERSATION_READ, ConversationEventType.TYPING_START or ConversationEventType.TYPING_STOP.

getAvatarUrl() - Method in class com.khoros.messaging.core.Message

The url for the user's avatar image.

getBrand() - Method in class com.khoros.messaging.core.CardSummary

The brand of the card

getBrandMessengerConnectionStatus() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for the current BrandMessengerConnectionStatus, or null if BrandMessenger.init(Application, Settings, BrandMessengerCallback) hasn't been called yet.

getBusinessLastRead() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the date when the business last read the user's messages.

getCardNumber() - Method in class com.khoros.messaging.core.CreditCard

getConfig() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for the currently connected app configuration.

getConversation() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for the current conversation.

getConversationById(String, BrandMessengerCallback<Conversation>) - Static method in class com.khoros.messaging.core.BrandMessenger

Get a Conversation by its ID.

getConversationDelegate() - Static method in class com.khoros.messaging.core.BrandMessenger

Gets the delegate set via BrandMessenger.setConversationDelegate(ConversationDelegate).

getConversationDelegates() - Static method in class com.khoros.messaging.core.BrandMessenger

Gets the collection of ConversationDelegate that have been set on the SDK as a SortedMap where the integrator defined delegate will appear before the delegate used to notify the BrandMessenger UI

getConversationId() - Method in class com.khoros.messaging.core.ConversationEvent

Returns the ID of the parent conversation of this event.

getConversationsList(BrandMessengerCallback<List<Conversation>>) - Static method in class com.khoros.messaging.core.BrandMessenger

Get the list of the 10 most recently active Conversations for the current user, sorted from most recently updated to last.

getConversationUiDelegate(int) - Static method in class com.khoros.messaging.core.BrandMessenger

Gets a delegate set via BrandMessenger.addConversationUiDelegate(int key, ConversationDelegate) using the key.

getConversationViewDelegate() - Static method in class com.khoros.messaging.core.BrandMessenger

Gets the delegate set via BrandMessenger.setConversationViewDelegate(ConversationViewDelegate).

getCoordinates() - Method in class com.khoros.messaging.core.Message

Returns Coordinates

getCurrency() - Method in class com.khoros.messaging.core.MessageAction

The type of currency

getCurrentUser() - Static method in class com.khoros.messaging.core.User

Returns the object representing the current user.

getData() - Method in class com.khoros.messaging.core.AuthenticationError

getData() - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response

Returns the resulting data from the action being performed.

getDate() - Method in class com.khoros.messaging.core.Message

The date and time the message was sent.

getDescription() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the description of this conversation.

getDescription() - Method in class com.khoros.messaging.core.MessageItem

The description of the item

getDisplayName() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the display name of this conversation.

getDisplaySettings() - Method in class com.khoros.messaging.core.Message

Returns DisplaySettings for carousel messages

getEmail() - Method in class com.khoros.messaging.core.User

String representing the user's email

getEntity() - Method in class com.khoros.messaging.core.Message

getError() - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response

Returns the error message from the action if there was a problem.

getExpMonth() - Method in class com.khoros.messaging.core.CreditCard

getExpYear() - Method in class com.khoros.messaging.core.CreditCard

getExternalId() - Method in class com.khoros.messaging.core.User

String representing the user's externalId.

getFallback() - Method in class com.khoros.messaging.core.MessageAction

Fallback URI for action types not supported by the SDK

getFile() - Method in class com.khoros.messaging.core.Message

The file of the message.

getFileProviderAuthorities() - Method in class com.khoros.messaging.core.Settings

A String that signifies which authority BrandMessenger will use to provide files to the CAMERA application.

getFirebaseCloudMessagingProjectId() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method to get the Firebase Cloud Messaging project id that was linked to the application via the Web portal.

getFirstName() - Method in class com.khoros.messaging.core.User

String representing the user's first name

getIconUrl() - Method in class com.khoros.messaging.core.Config

getIconUrl() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the icon url of this conversation.

getIconUrl() - Method in class com.khoros.messaging.core.MessageAction

The icon URL of the action

getId() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the ID of this conversation.

getId() - Method in class com.khoros.messaging.core.Message

The ID of the message.

getId() - Method in class com.khoros.messaging.core.Participant

The unique ID of this participant.

getImage() - Method in class com.khoros.messaging.core.Message

The image of the message.

getImageAspectRatio() - Method in class com.khoros.messaging.core.DisplaySettings

The image aspect ratio

getInitializationStatus() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for the current Initialization status.

getIntegrationId() - Method in class com.khoros.messaging.core.Settings

The integration id corresponding to your SDK integration.

getLast4() - Method in class com.khoros.messaging.core.CardSummary

The last 4 digits of the card

getLastLoginResult() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor for last known LoginResult or null if the user is anonymous or BrandMessenger.init(Application, Settings, BrandMessengerCallback) hasn't been called

getLastName() - Method in class com.khoros.messaging.core.User

String representing the user's last name

getLastRead() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the date when any other participant of the conversation last read the user's messages.

getLastRead() - Method in class com.khoros.messaging.core.ConversationEvent

Returns the date of the last read message if this event type is ConversationEventType.CONVERSATION_READ.

getLastRead() - Method in class com.khoros.messaging.core.Participant

Returns the date when this participant last read messages of the conversation.

getLastUpdatedAt() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the date when this conversation was last updated.

getLat() - Method in class com.khoros.messaging.core.Coordinates

The latitude

getLong() - Method in class com.khoros.messaging.core.Coordinates

The longitude

getMapsApiKey() - Method in class com.khoros.messaging.core.Settings

Google Maps API key to use to display a location preview for Location messages.

getMediaSize() - Method in class com.khoros.messaging.core.Message

The media size of the message.

getMediaType() - Method in class com.khoros.messaging.core.Message

The media type of the message.

getMediaType() - Method in class com.khoros.messaging.core.MessageItem

The media type of the item

getMediaUrl() - Method in class com.khoros.messaging.core.Message

The media URL of the message.

getMediaUrl() - Method in class com.khoros.messaging.core.MessageItem

The media url of the item

getMessageActions() - Method in class com.khoros.messaging.core.Message

The list of Message Action objects contained in the message.

getMessageActions() - Method in class com.khoros.messaging.core.MessageItem

The list of Message Action objects contained in the message item.

getMessageItems() - Method in class com.khoros.messaging.core.Message

The list of Message Item objects contained in the message.

getMessageModifierDelegate() - Static method in class com.khoros.messaging.core.BrandMessenger

Gets the delegate set via BrandMessenger.setMessageModifierDelegate(MessageModifierDelegate).

getMessages() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the list of messages of this conversation.

getMetadata() - Method in interface com.khoros.messaging.core.ConversationDetails

Data representing an optional flat object containing additional properties associated with the conversation.

getMetadata() - Method in class com.khoros.messaging.core.Message

The metadata of the message

getMetadata() - Method in class com.khoros.messaging.core.MessageAction

The action metadata

getMetadata() - Method in class com.khoros.messaging.core.MessageItem

The metadata of the item

getMetadata() - Method in class com.khoros.messaging.core.User

Map representing the user's custom metadata

getMoreConversationsList(BrandMessengerCallback<List<Conversation>>) - Static method in class com.khoros.messaging.core.BrandMessenger

Get the list of the 10 more recently active Conversations for the current user, sorted from most recently updated to last.

getName() - Method in class com.khoros.messaging.core.ConversationEvent

Returns the name of the participant related to this event if this event type is ConversationEventType.CONVERSATION_READ, ConversationEventType.TYPING_START or ConversationEventType.TYPING_STOP.

getName() - Method in class com.khoros.messaging.core.Message

The display name of the user.

getParticipants() - Method in interface com.khoros.messaging.core.ConversationDetails

Returns the list of participants of this conversation.

getPayload() - Method in class com.khoros.messaging.core.Message

The message payload from an action

getPayload() - Method in class com.khoros.messaging.core.MessageAction

The action payload

getRegion() - Method in class com.khoros.messaging.core.Settings

A String that determines which region to connect to.

getRole() - Method in class com.khoros.messaging.core.ConversationEvent

Returns the role of the participant related to this event (typically "appUser" or "business") if this event type is ConversationEventType.CONVERSATION_READ, ConversationEventType.TYPING_START or ConversationEventType.TYPING_STOP.

getSecurityCode() - Method in class com.khoros.messaging.core.CreditCard

getServiceBaseUrl() - Method in class com.khoros.messaging.core.Settings

getSettings() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for the SDK settings.

getSignedUpAt() - Method in class com.khoros.messaging.core.User

Date representing the date the user signed up

getSize() - Method in class com.khoros.messaging.core.MessageAction

The size of a webview

getSize() - Method in class com.khoros.messaging.core.MessageItem

The size of the item

getState() - Method in class com.khoros.messaging.core.MessageAction

The state of the action

getStatus() - Method in class com.khoros.messaging.core.AuthenticationError

getStatus() - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response

Returns the status code of the action.

getText() - Method in class com.khoros.messaging.core.Message

The text content of the message.

getText() - Method in class com.khoros.messaging.core.MessageAction

The text of the action

getTextFallback() - Method in class com.khoros.messaging.core.Message

Text to display for unsupported message types

getTitle() - Method in class com.khoros.messaging.core.MessageItem

The title of the item

getType() - Method in class com.khoros.messaging.core.ConversationEvent

The type of event that is being triggered.

getType() - Method in class com.khoros.messaging.core.Integration

The integration type

getType() - Method in class com.khoros.messaging.core.Message

The message type

getType() - Method in class com.khoros.messaging.core.MessageAction

The type of action

getUnreadCount() - Method in interface com.khoros.messaging.core.ConversationDetails

Count of unread messages in the conversation.

getUnreadCount() - Method in class com.khoros.messaging.core.Participant

Returns the unread count for this participant.

getUploadStatus() - Method in class com.khoros.messaging.core.Message

The upload status of the message.

getUri() - Method in class com.khoros.messaging.core.MessageAction

The URI of the action

getUserId() - Method in class com.khoros.messaging.core.ConversationEvent

Always available for ConversationEventType.PARTICIPANT_ADDED and ConversationEventType.PARTICIPANT_REMOVED.

getUserId() - Method in class com.khoros.messaging.core.Message

The id for the user.

getUserId() - Method in class com.khoros.messaging.core.Participant

The assigned userId for the user that this participant is associated with.

getUserId() - Method in class com.khoros.messaging.core.User

The assigned userId for this user.

getUserRole() - Method in class com.khoros.messaging.core.Message

The Role for the user.

getValue() - Method in enum com.khoros.messaging.core.ActionState

getValue() - Method in enum com.khoros.messaging.core.ConversationEventType

getValue() - Method in enum com.khoros.messaging.core.MessageType

H

hashCode() - Method in class com.khoros.messaging.core.Message

hashCode() - Method in class com.khoros.messaging.core.Participant

hasLocationRequest() - Method in class com.khoros.messaging.core.Message

Returns true if the message has a location request

hasMoreConversations() - Static method in class com.khoros.messaging.core.BrandMessenger

Accessor method for knowing if there are more conversations to be fetched or not.

hasPaymentInfo() - Method in class com.khoros.messaging.core.User

Boolean describing whether or not the user has payment information stored

hasReplies() - Method in class com.khoros.messaging.core.Message

Returns true if the message has reply actions

hasValidCoordinates() - Method in class com.khoros.messaging.core.Message

Returns true if the message has valid coordinates

I

i(String, String, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs an Log.INFO level log message

i(String, String, Throwable, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.INFO level log message

init(Application) - Static method in class com.khoros.messaging.core.BrandMessenger

Initializes BrandMessenger without settings.

init(Application, Settings, BrandMessengerCallback<InitializationStatus>) - Static method in class com.khoros.messaging.core.BrandMessenger

Initialize the BrandMessenger SDK with the provided settings.

InitializationStatus - Enum in com.khoros.messaging.core

Initialization response status.

Integration - Class in com.khoros.messaging.core

INTEGRATOR_DELEGATE - Static variable in interface com.khoros.messaging.core.ConversationDelegate

intent(Context) - Method in class com.khoros.messaging.ui.ConversationActivityBuilder

Creates an Intent for the ConversationActivity with the specified configuration

isBrandMessengerShown() - Method in interface com.khoros.messaging.core.Conversation

Returns true if the BrandMessenger UI is currently shown

isCarousel() - Method in class com.khoros.messaging.core.Message

isDefault() - Method in class com.khoros.messaging.core.MessageAction

Flag indicating if the message action should be the default for a given MessageItem

isEnabled() - Static method in class com.khoros.messaging.core.Logger

Returns the enabled state of the Logger.

isFirebaseCloudMessagingAutoRegistrationEnabled() - Method in class com.khoros.messaging.core.Settings

A boolean property that indicates whether BrandMessenger should manage the Firebase Cloud Messaging registration.

isFromCurrentUser() - Method in class com.khoros.messaging.core.Message

Returns true if the message originated from the user, or false if the message comes from another participant.

isRead() - Method in class com.khoros.messaging.core.Message

Return true if the message has been read

isRunning(String) - Static method in class com.khoros.messaging.ui.NotificationActivity

isStripeEnabled() - Method in class com.khoros.messaging.core.Config

Flag determining whether stripe is enabled for the app

L

loadCardSummary() - Method in interface com.khoros.messaging.core.Conversation

Loads billing info (if exists) to display last4 in credit form.

loadConversation(String, BrandMessengerCallback<Conversation>) - Static method in class com.khoros.messaging.core.BrandMessenger

Loads a conversation by its ID and sets it as the active conversation for the current session.

Logger - Class in com.khoros.messaging.core

Logger class that can be enabled/disable to assist with debugging SDK integrations without always printing information to the app output log.

login(String, String, BrandMessengerCallback<LoginResult>) - Static method in class com.khoros.messaging.core.BrandMessenger

Logs in a new BrandMessenger user.

LoginResult - Enum in com.khoros.messaging.core

Login response status

logout(BrandMessengerCallback<LogoutResult>) - Static method in class com.khoros.messaging.core.BrandMessenger

Logs out the current user.

LogoutResult - Enum in com.khoros.messaging.core

Logout response status

M

markAllAsRead() - Method in interface com.khoros.messaging.core.Conversation

Marks all unread messages as read.

Message - Class in com.khoros.messaging.core

Object representing a received or sent message

Message(String, String, Map<String, Object>) - Constructor for class com.khoros.messaging.core.Message

Create a message with the given text, payload, and metadata.

Message(Coordinates, Map<String, Object>) - Constructor for class com.khoros.messaging.core.Message

Create a message with the given coordinates.

MessageAction - Class in com.khoros.messaging.core

MessageAction() - Constructor for class com.khoros.messaging.core.MessageAction

Creates an empty message action.

MessageItem - Class in com.khoros.messaging.core

MessageItem() - Constructor for class com.khoros.messaging.core.MessageItem

Creates an empty message item.

MessageModifierDelegate - Interface in com.khoros.messaging.core

Delegate for events related to sending and displaying of specific messages.

MessageType - Enum in com.khoros.messaging.core

The Message type

MessageUploadStatus - Enum in com.khoros.messaging.core

Upload status of a Message.

N

NotificationActivity - Class in com.khoros.messaging.ui

NotificationActivity() - Constructor for class com.khoros.messaging.ui.NotificationActivity

NotificationController - Class in com.khoros.messaging.ui

NotificationController() - Constructor for class com.khoros.messaging.ui.NotificationController

Notifier - Class in com.khoros.messaging.core

Static utility class to broadcast notifications to the notification receiver.

notify(Context, String, MessageDto) - Static method in class com.khoros.messaging.core.Notifier

O

onBackPressed() - Method in class com.khoros.messaging.ui.ConversationActivity

onBrandMessengerConnectionStatusChanged(BrandMessengerConnectionStatus) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when the user's connection to BrandMessenger has changed.

onBrandMessengerConnectionStatusChanged(BrandMessengerConnectionStatus) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onBrandMessengerConnectionStatusChanged(BrandMessengerConnectionStatus) - Method in class com.khoros.messaging.ui.ConversationActivity

onBrandMessengerHidden() - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when the BrandMessenger Conversation is hidden.

onBrandMessengerHidden() - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onBrandMessengerHidden() - Method in class com.khoros.messaging.ui.ConversationActivity

onBrandMessengerShown() - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when the BrandMessenger Conversation is shown.

onBrandMessengerShown() - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onBrandMessengerShown() - Method in class com.khoros.messaging.ui.ConversationActivity

onCardSummaryLoaded(CardSummary) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when a saved stripe card is loaded.

onCardSummaryLoaded(CardSummary) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onCardSummaryLoaded(CardSummary) - Method in class com.khoros.messaging.ui.ConversationActivity

onConversationEventReceived(ConversationEvent) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate of a new activity.

onConversationEventReceived(ConversationEvent) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onConversationEventReceived(ConversationEvent) - Method in class com.khoros.messaging.ui.ConversationActivity

onConversationsListUpdated(List<Conversation>) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when the conversations list was updated.

onConversationsListUpdated(List<Conversation>) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onConversationsListUpdated(List<Conversation>) - Method in class com.khoros.messaging.ui.ConversationActivity

onCreate(Bundle) - Method in class com.khoros.messaging.ui.ConversationActivity

onCreate(Bundle) - Method in class com.khoros.messaging.ui.NotificationActivity

onCreateConversationClick() - Method in interface com.khoros.messaging.core.ConversationViewDelegate

Called when a new conversation is selected

onCreateConversationClick() - Method in class com.khoros.messaging.core.ConversationViewDelegateAdapter

Called when a new conversation is selected

onCreateOptionsMenu(Menu) - Method in class com.khoros.messaging.ui.ConversationActivity

onDestroy() - Method in class com.khoros.messaging.ui.ConversationActivity

onDestroy() - Method in class com.khoros.messaging.ui.NotificationActivity

onFormComplete() - Method in class com.khoros.messaging.ui.ConversationActivity

onFormFragmentClose(Message) - Method in class com.khoros.messaging.ui.ConversationActivity

onFormFragmentShown() - Method in class com.khoros.messaging.ui.ConversationActivity

onInitializationStatusChanged(InitializationStatus) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate of a change in Initialization status.

onInitializationStatusChanged(InitializationStatus) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onInitializationStatusChanged(InitializationStatus) - Method in class com.khoros.messaging.ui.ConversationActivity

onInvalidAuth(AuthenticationError, AuthenticationCallback) - Method in interface com.khoros.messaging.core.AuthenticationDelegate

Notifies the delegate of a failed request due to invalid credentials

onLoginComplete(LoginResult) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when a call to BrandMessenger.login(String, String, BrandMessengerCallback) is complete

onLoginComplete(LoginResult) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onLoginComplete(LoginResult) - Method in class com.khoros.messaging.ui.ConversationActivity

onLogoutComplete(LogoutResult) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when a call to BrandMessenger.logout(BrandMessengerCallback) is complete

onLogoutComplete(LogoutResult) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onLogoutComplete(LogoutResult) - Method in class com.khoros.messaging.ui.ConversationActivity

onMessageReceived(RemoteMessage) - Method in class com.khoros.messaging.core.FcmService

onMessageSent(Message, MessageUploadStatus) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate of a message being sent.

onMessageSent(Message, MessageUploadStatus) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onMessageSent(Message, MessageUploadStatus) - Method in class com.khoros.messaging.ui.ConversationActivity

onMessagesReceived(Conversation, List<Message>) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate of new incoming messages.

onMessagesReceived(Conversation, List<Message>) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onMessagesReceived(Conversation, List<Message>) - Method in class com.khoros.messaging.ui.ConversationActivity

onMessagesReset(Conversation, List<Message>) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate the messages in a conversation have been reset.

onMessagesReset(Conversation, List<Message>) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onMessagesReset(Conversation, List<Message>) - Method in class com.khoros.messaging.ui.ConversationActivity

onNewToken(String) - Method in class com.khoros.messaging.core.FcmService

onNotification(Context, String, Message) - Method in class com.khoros.messaging.core.AbstractNotificationReceiver

Method called when a new message is received.

onOptionsItemSelected(MenuItem) - Method in class com.khoros.messaging.ui.ConversationActivity

onPause() - Method in class com.khoros.messaging.ui.ConversationActivity

onPaymentProcessed(MessageAction, PaymentStatus) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate when payment is processed.

onPaymentProcessed(MessageAction, PaymentStatus) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onPaymentProcessed(MessageAction, PaymentStatus) - Method in class com.khoros.messaging.ui.ConversationActivity

onPurchaseComplete() - Method in class com.khoros.messaging.ui.ConversationActivity

onReceive(Context, Intent) - Method in class com.khoros.messaging.core.AbstractNotificationReceiver

onRequestPermissionsCalled(String[]) - Method in interface com.khoros.messaging.core.ConversationViewDelegate

Notifies the delegate that permissions for this app have been requested

onRequestPermissionsCalled(String[]) - Method in class com.khoros.messaging.core.ConversationViewDelegateAdapter

Notifies the delegate that permissions for this app have been requested

onResume() - Method in class com.khoros.messaging.ui.ConversationActivity

onShadedAreaClick() - Method in class com.khoros.messaging.ui.ConversationActivity

onStart() - Method in class com.khoros.messaging.ui.ConversationActivity

onStartActivityCalled(Intent) - Method in interface com.khoros.messaging.core.ConversationViewDelegate

Notifies the delegate that a call to start an activity has been made

onStartActivityCalled(Intent) - Method in class com.khoros.messaging.core.ConversationViewDelegateAdapter

Notifies the delegate that a call to start an activity has been made

onStop() - Method in class com.khoros.messaging.ui.ConversationActivity

onStripeFragmentClose() - Method in class com.khoros.messaging.ui.ConversationActivity

onStripeFragmentShown() - Method in class com.khoros.messaging.ui.ConversationActivity

onUnreadCountChanged(Conversation, int) - Method in interface com.khoros.messaging.core.ConversationDelegate

Notifies the delegate of a change in unread message count.

onUnreadCountChanged(Conversation, int) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

onUnreadCountChanged(Conversation, int) - Method in class com.khoros.messaging.ui.ConversationActivity

onWebviewHidden() - Method in class com.khoros.messaging.ui.ConversationActivity

onWebviewShown() - Method in class com.khoros.messaging.ui.ConversationActivity

P

Participant - Class in com.khoros.messaging.core

Object representing the participant of a Conversation.

PaymentStatus - Enum in com.khoros.messaging.core

Stripe payment status.

postback(MessageAction, BrandMessengerCallback<Void>) - Method in interface com.khoros.messaging.core.Conversation

Triggers MessageAction postback.

processPayment(CreditCard, MessageAction) - Method in interface com.khoros.messaging.core.Conversation

Processes a credit card payment.

R

removeMessage(Message) - Method in interface com.khoros.messaging.core.Conversation

Removes a failed or unsent message from the conversation.

removeMessageAction(MessageAction) - Method in class com.khoros.messaging.core.Message

Removes a message action from the list of actions

removeMessageAction(MessageAction) - Method in class com.khoros.messaging.core.MessageItem

Removes a message action from the list of actions

removeMessageItem(MessageItem) - Method in class com.khoros.messaging.core.Message

Removes a message item from the list of items

retryMessage(Message) - Method in interface com.khoros.messaging.core.Conversation

Retries a message that failed to send.

run(BrandMessengerCallback.Response<T>) - Method in interface com.khoros.messaging.core.BrandMessengerCallback

Invoke the BrandMessengerCallback with the results of the action

run(BrandMessengerCallback.Response<T>) - Method in class com.khoros.messaging.core.StubbedCallback

S

sendMessage(Message) - Method in interface com.khoros.messaging.core.Conversation

Adds a new message to the conversation.

setAmount(long) - Method in class com.khoros.messaging.core.MessageAction

Sets the price of the action

setAuthenticationDelegate(AuthenticationDelegate) - Method in class com.khoros.messaging.core.Settings

A delegate to be notified about a failed request due to invalid credentials.

setAvatarUrl(String) - Method in class com.khoros.messaging.core.Message

Sets the url for the user's avatar image.

setCardNumber(String) - Method in class com.khoros.messaging.core.CreditCard

setConversationDelegate(ConversationDelegate) - Static method in class com.khoros.messaging.core.BrandMessenger

Sets the ConversationDelegate

setConversationViewDelegate(ConversationViewDelegate) - Static method in class com.khoros.messaging.core.BrandMessenger

Sets the ConversationViewDelegate

setCoordinates(Coordinates) - Method in class com.khoros.messaging.core.Message

Sets the coordinates for the message

setCurrency(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the type of currency

setDefault(boolean) - Method in class com.khoros.messaging.core.MessageAction

Sets the default flag

setDescription(String) - Method in class com.khoros.messaging.core.MessageItem

Sets the description of the item

setDisplaySettings(DisplaySettings) - Method in class com.khoros.messaging.core.Message

Sets the display settings for the message

setEmail(String) - Method in class com.khoros.messaging.core.User

The user's email, to be used to display a gravatar.

setEnabled(boolean) - Static method in class com.khoros.messaging.core.Logger

Sets the enabled/disabled state of the Logger

setEntity(MessageDto) - Method in class com.khoros.messaging.core.Message

setExpMonth(int) - Method in class com.khoros.messaging.core.CreditCard

setExpYear(int) - Method in class com.khoros.messaging.core.CreditCard

setFallback(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the fallback URI for action types not supported by the SDK

setFile(File) - Method in class com.khoros.messaging.core.Message

Sets the file for the message.

setFileProviderAuthorities(String) - Method in class com.khoros.messaging.core.Settings

A String that signifies which authority BrandMessenger will use to provide files to the CAMERA application.

setFirebaseCloudMessagingAutoRegistrationEnabled(boolean) - Method in class com.khoros.messaging.core.Settings

A boolean property that indicates whether BrandMessenger should manage the Firebase Cloud Messaging registration.

setFirebaseCloudMessagingToken(String) - Static method in class com.khoros.messaging.core.BrandMessenger

Method used to register the Firebase Cloud Messaging token to BrandMessenger

setFirebaseCloudMessagingToken(String, BrandMessengerCallback<LoginResult>) - Static method in class com.khoros.messaging.core.BrandMessenger

Method used to register the Firebase Cloud Messaging token to BrandMessenger

setFirstName(String) - Method in class com.khoros.messaging.core.User

The user's first name, to be used as part of the display name when sending messages.

setIconUrl(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the icon URL of the action

setImage(Bitmap) - Method in class com.khoros.messaging.core.Message

Sets the image for the message.

setLastName(String) - Method in class com.khoros.messaging.core.User

The user's last name, to be used as part of the display name when sending messages.

setMapsApiKey(String) - Method in class com.khoros.messaging.core.Settings

Google Maps API key to use to display a location preview for Location messages.

setMediaSize(long) - Method in class com.khoros.messaging.core.Message

Sets the media size for the message

setMediaType(String) - Method in class com.khoros.messaging.core.Message

Sets the media type for the message

setMediaType(String) - Method in class com.khoros.messaging.core.MessageItem

Sets the media type of the item

setMediaUrl(String) - Method in class com.khoros.messaging.core.Message

Sets the media URL for the message

setMediaUrl(String) - Method in class com.khoros.messaging.core.MessageItem

Sets the media url of the item

setMessageModifierDelegate(MessageModifierDelegate) - Static method in class com.khoros.messaging.core.BrandMessenger

Sets the MessageModifierDelegate

setMetadata(Map<String, Object>) - Method in class com.khoros.messaging.core.Message

Sets the metadata for the message

setMetadata(Map<String, Object>) - Method in class com.khoros.messaging.core.MessageAction

Sets the action metadata

setMetadata(Map<String, Object>) - Method in class com.khoros.messaging.core.MessageItem

Sets the metadata of the item

setName(String) - Method in class com.khoros.messaging.core.Message

Sets the user's displayName for the message.

setPayload(String) - Method in class com.khoros.messaging.core.Message

Sets the payload for the message

setPayload(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the action payload

setRegion(String) - Method in class com.khoros.messaging.core.Settings

A String that determines which region to connect to.

setSecurityCode(String) - Method in class com.khoros.messaging.core.CreditCard

setServiceBaseUrl(String) - Method in class com.khoros.messaging.core.Settings

setSignedUpAt(Date) - Method in class com.khoros.messaging.core.User

The date the user started using your service

setSize(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the size for a webview

setSize(String) - Method in class com.khoros.messaging.core.MessageItem

Sets the size of the item

setText(String) - Method in class com.khoros.messaging.core.Message

Sets the text for the message.

setText(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the text of the action

setTextFallback(String) - Method in class com.khoros.messaging.core.Message

Sets the text to display for unsupported message types

Settings - Class in com.khoros.messaging.core

The settings used to initialise the SDK.

Settings(String) - Constructor for class com.khoros.messaging.core.Settings

Initializes a Settings with the given app id and integration id.

Settings(String, String) - Constructor for class com.khoros.messaging.core.Settings

Initializes a Settings instance with the given app id, integration id and auth code flag.

setTitle(String) - Method in class com.khoros.messaging.core.MessageItem

Sets the title of the item

setType(String) - Method in class com.khoros.messaging.core.Message

Sets the type of the message

setType(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the type of action

setUploadStatus(MessageUploadStatus) - Method in class com.khoros.messaging.core.Message

setUri(String) - Method in class com.khoros.messaging.core.MessageAction

Sets the URI of the action

shouldCreateCustomConversationFlow() - Method in interface com.khoros.messaging.core.ConversationViewDelegate

Notifies the ConverstationListActivity that the conversation activity create intent should be sent to the interceptor

shouldCreateCustomConversationFlow() - Method in class com.khoros.messaging.core.ConversationViewDelegateAdapter

Notifies the ConverstationListActivity that the conversation activity create intent should be sent to the interceptor

shouldTriggerAction(MessageAction) - Method in interface com.khoros.messaging.core.ConversationDelegate

Allows a delegate to override default action behavior.

shouldTriggerAction(MessageAction) - Method in class com.khoros.messaging.core.ConversationDelegateAdapter

shouldTriggerAction(MessageAction) - Method in class com.khoros.messaging.ui.ConversationActivity

show(Context) - Method in class com.khoros.messaging.ui.ConversationActivityBuilder

Starts the ConversationActivity with the specified configuration

startConversation(BrandMessengerCallback<Void>) - Static method in class com.khoros.messaging.core.BrandMessenger

Deprecated.

startTyping() - Method in interface com.khoros.messaging.core.Conversation

Notify the server that the user is typing.

stopTyping() - Method in interface com.khoros.messaging.core.Conversation

Notify the server that the user has finished typing.

StubbedCallback<T> - Class in com.khoros.messaging.core

Stubbed implementation of BrandMessengerCallback that does nothing when invoked

StubbedCallback() - Constructor for class com.khoros.messaging.core.StubbedCallback

submitForm(String, List<FormFieldDto>, <any>) - Method in interface com.khoros.messaging.core.Conversation

T

toString() - Method in class com.khoros.messaging.core.AuthenticationError

toString() - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response

triggerAction(MessageAction) - Method in interface com.khoros.messaging.core.Conversation

Triggers message action resulting from a click.

triggerBrandMessengerNotification(Map<String, String>, Context) - Static method in class com.khoros.messaging.core.FcmService

Helper function that handles a push notification received from BrandMessenger.

triggerNotification(Context, String, Message) - Static method in class com.khoros.messaging.ui.NotificationController

Triggers a BrandMessenger notification, which will open intent from resource BrandMessenger_settings_notificationIntent on tap.

U

updateConversationById(String, String, String, String, Map<String, Object>, BrandMessengerCallback<Conversation>) - Static method in class com.khoros.messaging.core.BrandMessenger

updateMessageSubmitStatus(Message) - Method in interface com.khoros.messaging.core.Conversation

updateToken(String) - Method in interface com.khoros.messaging.core.AuthenticationCallback

Updates the JWT used to authenticate the user

uploadFile(Message, BrandMessengerCallback<Message>) - Method in interface com.khoros.messaging.core.Conversation

Uploads a user file to the conversation.

uploadImage(Message, BrandMessengerCallback<Message>) - Method in interface com.khoros.messaging.core.Conversation

Uploads a user image to the conversation.

User - Class in com.khoros.messaging.core

Object representing the current user.

User() - Constructor for class com.khoros.messaging.core.User

V

v(String, String, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.VERBOSE log message

v(String, String, Throwable, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.VERBOSE level log message

validateFormField(MessageDto, FormFieldDto, String, ValidationResponseState, FormValidationListener) - Method in interface com.khoros.messaging.core.Conversation

valueOf(String) - Static method in enum com.khoros.messaging.core.ActionState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.BrandMessengerConnectionStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.ConversationEventType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.InitializationStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.LoginResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.LogoutResult

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.MessageType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.MessageUploadStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.core.PaymentStatus

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.khoros.messaging.ui.ConnectionStatus

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.khoros.messaging.core.ActionState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.BrandMessengerConnectionStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.ConversationEventType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.InitializationStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.LoginResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.LogoutResult

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.MessageType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.MessageUploadStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.core.PaymentStatus

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.khoros.messaging.ui.ConnectionStatus

Returns an array containing the constants of this enum type, in the order they are declared.

W

w(String, String, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs an Log.WARN level log message

w(String, String, Throwable, Object...) - Static method in class com.khoros.messaging.core.Logger

Logs a Log.WARN level log message

withConversationId(String) - Method in class com.khoros.messaging.ui.ConversationActivityBuilder

Specifies the conversation to be loaded

withData(T) - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response.Builder

Adds data to the response builder

withError(String) - Method in class com.khoros.messaging.core.BrandMessengerCallback.Response.Builder

Adds an error message to the response builder

withFlags(int) - Method in class com.khoros.messaging.ui.ConversationActivityBuilder

Specifies the intent flags for the conversation activity

withStartingText(String) - Method in class com.khoros.messaging.ui.ConversationActivityBuilder

Specifies the starting text used to pre-fill the conversation activity text box

A B C D E F G H I L M N O P R S T U V W