ZohoSalesIQ class

Constructors

ZohoSalesIQ()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

articleEventChannel → Stream

Stream to receive events related to the knowledge base. See knowledgeBase.eventChannel in knowledgeBase

final

chat ↔ Chat

getter/setter pair

chatEventChannel → Stream

Stream to receive mobilisten events related to chat.

final

chatUnreadCount → Future<int>

An integer value representing the number of unread messages.

no setter

eventChannel → Stream

Stream to receive general mobilisten events.

final

isMultipleOpenChatRestricted → Future<bool>

A Boolean value used to determine whether a visitor can start multiple parallely open chats.

no setter

knowledgeBase ↔ KnowledgeBase

getter/setter pair

launcher ↔ Launcher

getter/setter pair

Static Methods

completeChatAction(String actionUUID) → Future<Null>

Marks a chat action as complete provided the actionUUID.

completeChatActionWithMessage(String actionUUID, bool state, String message) → Future<Null>

Marks a chat action as complete provided the actionUUID, completion state and the message to be shown upon completion.

disableInAppNotification() → Future<Null>

Disables in-app notifications from Mobilisten.

disablePreChatForms() → Future<Null>

Disables the pre-chat form.

disableScreenshotOption() → Future<Null>

Disables the option to capture screenshots fromm the attachments menu.

dismissUI() → void

enableInAppNotification() → Future<Null>

Enables in-app notifications from Mobilisten if previously disabled. In-app notifications are enabled by default.

enablePreChatForms() → Future<Null>

Enables the pre-chat form if previously disables. Pre-chat forms are enabled by default.

enablePushForiOS(String token, bool isTestDevice, bool productionMode) → Future<Null>

Enables push notifications for iOS using token, isTestDevice and productionMode. Set isTestDevice to false and productionMode to true before moving the app to production.

enableScreenshotOption() → Future<Null>

Enables the option to capture screenshots from the attachments menu.

endChat(String chatID) → Future<Null>

Ends the specified chat if provided the chatID.

fetchAttenderImage(String attenderID, bool fetchDefaultImage) → Future<String>

Returns the base64 representation of an attender image for the given attender ID.

getArticleCategories() → Future<List<SIQArticleCategory>>

Returns a list of article categories (Instances of SIQArticleCategory). See knowledgeBase.getCategories(type) in knowledgeBase

getArticles() → Future<List<SIQArticle>>

Returns a list of articles (Instances of SIQArticle). See knowledgeBase.getResources(type) in knowledgeBase

getArticlesWithCategoryID(String categoryID) → Future<List<SIQArticle>>

Returns a list of articles (Instances of SIQArticle) belonging to a specific category if provided a categoryID. See knowledgeBase.getResources(type) in knowledgeBase

getChats() → Future<List<SIQChat>>

Returns a list of chats (Instances of SIQChat).

getChatsWithFilter(SIQChatStatus chatStatus) → Future<List<SIQChat>>

Returns a list of chats (Instances of SIQChat) whose status matches chatStatus.

getDepartments() → Future<List<SIQDepartment>>

Returns a list of departments (Instances of SIQDepartment).

handleNotificationResponseForiOS(Map userInfo) → Future<Null>

Processes the content of push notifications in response to a the tap action in iOS. Use this API only if push notification configuration is to be done manually in dart.

init(String appKey, String accessKey) → Future<Null>

Initializes Mobilisten using the appKey and accessKey generated for the bundle ID/package name of an application.

openArticle(String articleID) → Future<String>

Opens an article from the knowledge base using the articleID. See knowledgeBase.openResource(type, id) in knowledgeBase

openChatWithID(String chatID) → Future<Null>

Opens the chat window for a specified chat if provided the chatID.

openNewChat() → Future<Null>

Opens a new chat window for creating a new chat.

performCustomAction(String actionName, [bool shouldOpenChatWindow = false]) → Future<Null>

Performs a custom action using the action name provided in actionName.

printDebugLogsForAndroid(bool value) → void

The android mobilisten debug logs will be printed only when true is set.

processNotificationWithInfoForiOS(Map userInfo) → Future<Null>

Processes the content of push notification received for iOS. Use this API only if push notification configuration is to be done manually in dart.

registerChatAction(String actionName) → Future<Null>

Registers a chat action to be used in display-cards using an action name.

registerVisitor(String registerID) → Future

Registers a visitor using the unique ID provided for registerID. Once registered, conversations may be restored and synced across multiple devices that are registered with the same registerID. Use the API during a login operation to set the user's session.

sendEvent(SIQSendEvent eventName, List<Object> values) → Future<Null>

Use this API to send events to the SDK with SIQSendEvent and it's values with respect to the event

setChatActionTimeout(int timeout) → Future<Null>

Sets the timeout for all chat actions.

setChatTitle(String chatTitle) → Future<Null>

Sets the title displayed in the chat window prior to starting a conversation.

setConversationListTitle(String title) → Future<Null>

Sets the title for the conversations list.

setConversationVisibility(bool visibility) → Future<Null>

Enables or disables conversation history using the value provided for visibility.

setDepartment(String department) → Future<Null>

Sets the department to which all chat requests are routed by default.

setDepartments(List<String> departmentList) → Future<Null>

Sets the list of departments to which chat requests may be routed.

setFAQVisibility(bool visibility) → Future<Null>

Enables or disables the FAQs/the Knowledge base using the value provided for visibility. See knowledgeBase.setVisibility(type, shouldShow) in knowledgeBase

setFeedbackVisibility(bool visibility) → Future<Null>

Enables or disables the option to provide feedback for a chat once ended.

setLanguage(String language) → Future<Null>

Sets the language used by Mobilisten using the language code provided in language.

setLauncherPropertiesForAndroid(LauncherProperties launcherProperties) → void

Sets the properties for the launcher using LauncherProperties. This API is used to customize launcher's mode, y position, sides and icon.

setNotificationIconForAndroid(String resourceName) → void

This API sets the icon for the notifications created from SDK.

setOperatorEmail(String email) → Future<Null>

Sets the operator to whom all chat requests need to be routed using the provided email.

setPageTitle(String pageTitle) → Future<Null>

Sets the current page title to be shown in the visitor footpath on the SalesIQ console.

setQuestion(String question) → Future<Null>

Prefills the text provided as question in the chat input field for a new chat window.

setRatingVisibility(bool visibility) → Future<Null>

Enables or disables the option to provide rating for a chat once ended.

setTabOrder(List<SIQTab> tabs) → void

Sets the order for the bottom navigation tabs inside the SDK

setThemeColorForiOS(String hexColor) → Future<Null>

Sets the overall theme color used in the iOS platform.

setThemeForAndroid(String id) → Future<Null>

Sets the given theme in the Android platform.

setVisitorAddInfo(String key, String value) → Future<Null>

Sets the visitor's custom information as key, value pairs.

setVisitorContactNumber(String contactNumber) → Future<Null>

Sets the visitor's contact number.

setVisitorEmail(String visitorEmail) → Future<Null>

Sets the visitor's email.

setVisitorLocation(SIQVisitorLocation locationDetails) → Future<Null>

Sets the visitor's secondary location.

setVisitorName(String visitorName) → Future<Null>

Sets the visitor's name.

setVisitorNameVisibility(bool visibility) → Future<Null>

Enables or disables showing the visitor name if available as the sender name for outgoing messages within chat.

shouldOpenUrl(bool openUrl) → void

This API controls the behaviour of url opening behaviour

show() → Future<Null>

Opens the Mobilisten UI. Invoke this API only after initialization is complete.

showLauncher(bool show) → Future<Null>

Controls the visibility of the default launcher using the value provided for show.

showOfflineMessage(bool show) → Future<Null>

Shows an offline banner if all departments are offline. This API is indended for use only when then chat waiting time is set to Infinite.

showOperatorImageInChat(bool show) → Future<Null>

Enables or disables the display of sender images for incoming messages based on the value provided for show.

showOperatorImageInLauncher(bool show) → Future<Null>

Enables showing the operator's image in the default launcher.

startChat(String question) → Future<Null>

Automatically attempts to starts a chat using the text provided in question as the question.

syncThemeWithOSForAndroid(bool value) → void

If this API is enabled, the SDK theme will work in sync with system's dark/light mode

unregisterAllChatActions() → Future<Null>

Unregisters all registered chat action to be used in display-cards.

unregisterChatAction(String actionName) → Future<Null>

Unregisters a chat action to be used in display-cards using an action name.

unregisterVisitor() → Future<Null>

Unregisters and clears conversations and data for the current user. Use the API during a logout operation to clear data.