2.2.1

2.2.1

Bug Fixes

• default invoke() operators in public API don't use @JvmName annotation to avoid minification issues in ProGuard/R8
  • The API was extended with methods which have the same signature as was previously covered by invoke() operators.
    This should prevent binary compatibility issues.
• Fix missing contactId for live chat thread
  • This fixes issue where it wasn't possible to end the live chat session in certain scenarios

2.2.0 - 24.4

2.2.0

Bug Fixes

• Allow reconnect in offline state
• Fix ProGuard/R8 issues
  • Updated consumer-rules.pro to prevent minification of several problematic methods
  • Added rules to the internal SDK minification
• SDK awaits for authorization
  • NOTE
    Event sending may be delayed until server confirms user authorization to use Chat service,
    sending of events prior to this could lead to loss of such events.

Dependency Change

• Bump kotlin from 2.0.0 to 2.0.10
• Replace GSON with kotlinx.serialization
• Removed unused dependencies from the utilities module

Features

• Enable application LargeHeap for attachment upload
  • This allows upload of larger attachments on devices with sufficient RAM
• Enhance AuthorizeCustomer event
• Mobile SDK sends new headers for internal analytics
• Deprecate inContactId and emailAddress from Agent
  • Values for these fields are now always empty
• Update agent model
  • Added nickName field
  • imageUrl field now provides the public image url

2.1.1 - 24.3.1

2.1.1

Bug Fixes

• CaseStatusChanged with status closed doesn't archive thread in SingleThread mode

2.1.0 - 24.3

2.1.0

Bug Fixes

• Prevent duplicate welcome message

Dependency Change

• Update Kotlin 1.9.22 -> 1.9.24
• Bump retrofit from 2.10.0 to 2.11.0
• Bump com.google.code.gson:gson from 2.10.1 to 2.11.0

Features

• Live chat documentation update
• Add support for autolinking in text messages
• Allow to set customerId
• Coordinate ArchiveThread and ThreadArchived events
• Removed custom field validation

2.0.0 - 24.2

2.0.0

Bug Fixes

• Thread updates are delivered to all listeners

Code Refactoring

• BREAKING CHANGE Enum case name consistency
  • Enums are now consitently using CamelCase instead of mix with SCREAMING_CASE

Dependency Change

• Bump androidx.core:core-ktx from 1.13.0 -> 1.13.1
• Bump com.squareup.retrofit2 2.9.0 -> 2.10.0

Features

• BREAKING CHANGE Deprecate legacy plugins
  • Plugin Message type was removed, as it is being phased out and replaced with TORM types like QuickReply and RichMessage
• BREAKING CHANGE Add LiveChat support
• SDK doesn't allow messaging to archived thread
  • SDK will report an error when attempting to send a message to a thread with property isArchived set to true
• Align Single-threaded Channel Behavior with iOS implementation
  • SDK performs automatic steps to prepare (if no pre-contact survey is set) or retrieve thread in Single-Thread (or LiveChat) setup
• File upload restrictions are now published by the SDK
  • Chat Configuration now contains a subsection which contains allowed definitions of allowed file types (determined by the mime-type)
• SDK enforces published file restrictions
  • If application makes an attempt to send forbidden type the SDK will prevent that and report it as an error
• Update DeviceFingerprint
  • Fingerprint is used by chat automation
• Handle EventInS3 meta-event
  • Chat messages have size limit, if the incoming message would go over the limit the SDK has to retrieve it differently. In previous version the message would be ignored/discarded.

1.3.1

1.3.1

Bug Fixes

• Fix crash when agent is unassigned
  • EventContactInboxAssigneeChanged.agent is nullable
• Fix SDK is unable to prepare instance
  • Fix for compatibility with backend API changes

1.3.0 - 24.1

1.3.0

Bug Fixes

• Set CustomerId type to String
• Make date formatting thread safe
• Use referential equality for enum comparison
• Cancel start job in case of re-configuration
• Update Chat to separate prepare and connect actions
• Update Agent.isTyping only when agent isTyping value has changed
• Remove messages with duplicate id from thread
• Sockets created by SDK can be tagged for TrafficStats
• Delay SharedPreferences initialization
• Disable sending empty messages
• Return error when receiving "invalid" server response on image upload
• BREAKING CHANGE if uploaded filename has no extension, get one using MimeTypeMap

Dependency Change

• Update Kotlin 1.8.21 -> 1.9.21
• Bump com.squareup.okhttp3:okhttp from 4.11.0 to 4.12.0
• Bump androidx.core:core-ktx from 1.10.1 to 1.12.0

Features

• Add ProxyLogger constructor with vararg param
• Improve Java compatibility
• Raise project compileSdk 33 -> 34
• Improve logging of outgoing events
• Pass server reported errors to integration
• Process events on background thread
• Allow to change users name
• Message is updated when read by agent
• Add seenAt and inferred state to message metadata
• Add logger-android module
• Extract logging library module
• Add option to specify Logger for the SDK
• Correct welcome message handling
• Implement CaseStatusChanged event

1.3.0-rc2

CXOne Chat SDK

Bug Fixes

• Set Connection.CustomerId type to String (was UUID)
• Make date formatting thread safe
• Use referential equality for enum comparison
• Cancel start job in case of re-configuration of ChatInstanceProvider
• Refactor Chat to separate prepare and connect actions
• Message.MessageAuthor is nullable
  • Application has to provide fallback based on direction of the message in such case
• Update Agent.isTyping only when agent is typing
• Remove messages with duplicate id from thread
• Sockets created by SDK can be tagged for TrafficStats
• Delay SharedPreferences initialization
• Fix unreliable unit tests depending on makeMessageModel being sequential
• fix display of new agent messages
• Disable sending empty messages
• return error when receiving "invalid" server response on image upload
• BREAKING CHANGE if uploaded filename has no extension, get one using MimeTypeMap
  • fileName and mimeType are now required parameters for attachment upload
• Correct welcome message handling

Dependency Change

• Update Kotlin 1.8.21 -> 1.9.21
• Bump com.squareup.okhttp3:okhttp from 4.11.0 to 4.12.0
• Bump androidx.core:core-ktx from 1.10.1 to 1.12.0

Features

• Extract logging library module
• Add logger-android module
• Add option to specify Logger for the SDK
• Add ProxyLogger constructor with vararg param
• Improve Java compatibility
• Raise project compileSdk 33 -> 34
• Improve logging of outgoing events
• Pass server reported errors to integration
• Process events on background thread
• Allow to change users name
• Message is updated when read by agent
• Add seenAt and inferred state to message metadata
• Implement CaseStatusChanged event
  • Thread list now receives updated thread when thread is archived

1.1.0

1.1.0 - 2023-06-26

Bug Fixes

• Allow lenient parsing of UUID type
• Successful thread-archived event will trigger thread list refresh
• Update thread agent correctly
• Allow application to respond to the websocket session state & reconnect
• Use OkHttp for WebSocket communication
• Add missing consumer ProGuard rule for GSON classes
• Modify Proguard/R8 rules to be compatible with R8 fullMode
• Fix threading issue introduced with postback support
• Use OkHttp for WebSocket communication
• Add missing consumer ProGuard rule for GSON classes

Dependency Change

• Bump androidx.core:core-ktx from 1.9.0 to 1.10.0
• Bump org.jetbrains.dokka from 1.6.10 to 1.8.10
• Bump org.jetbrains.kotlin.android from 1.6.10 to 1.8.10

Features

• Increase targetSdk 31 -> 33
• implement/fix LoadThreadMetadata and add loadMetadata entry to ChatThreadEventHandlerActions
• Dynamic pre contact survey
• Documentation update
• create ContentDescriptor.DataSource to facilitate minimizing memory usage
• Modify Custom Fields storing behavior
• implement RichLink message types
• implement ListPicker message type
• add support for QUICK_REPLIES message types
• Add an option to send postback value in a thread message
• Parse and utilize custom field definitions from the server.
• Fresh Naming in Websocket events
• Fresh Naming in Websocket events

Reverts

• [chore] Bump androidx.core:core-ktx from 1.9.0 to 1.10.0

1.0.0

1.0.0 - 2023-02-14

Features

• Logging PoC
• Error handling
• Connection
  • Ping to ensure connection state
  • Execute trigger manually
  • Handle unexpected disconnect
• Customer
  • Save customer credentials
  • Customer authorisation
  • Customer reconnect
  • OAuth
• Customer Custom Fields
  • Save customer custom fields
• Threads
  • Update thread name
  • „Read“ flag
  • „Delivered“ flag
  • Threads load
  • Contact inbox assignee change
  • Recover thread
  • Typing indicator
  • Archive thread
  • Load thread metadada
  • Handle proactive action
    • Welcome message
    • Custom popup box
• Contact Custom Fields
  • Save contact custom fields
• Messages
  • Send/Receive attachments
    • Image
    • Video
    • Documents
  • Handle a message
    • Text
    • Plugin
      • Gallery
      • Menu
      • Text and Buttons
      • Quick Replies
      • Satisfaction Survey
      • Custom
      • Sub Elements
        • Text
        • Title
        • File
        • Button/iFrame Button
  • Previous message load
• Analytics
  • Page view
  • Chat window open
  • App visit
  • Conversion
  • Custom visitor event
  • Proactive action
    • display
    • success
    • failure
  • typing start/end