This is the developer guide for Chat SDK v1. The new Chat SDK v2 for iOS is now available and is the recommended version to integrate Chat into your mobile app. It also removes the dependency on UIWebView which has been deprecated by Apple.

Chat triggers that send a greeting to the visitor can interfere with the SDK setting a department. You can add a Still on site condition to the trigger with a value of 1 to avoid this. This is the number of seconds to wait.

• If manually integrating 1.4.6 and above (not using CocoaPods), you will need to add the -ObjC linker flag to Other Linker Flags in the Build Settings of the target that imports the ZDCChat framework. Without this, some integrations can experience a crash. Read more about manually integrating the Chat SDK here.

• There currently is no support for iOS 13's Dark Mode. See how to style the chat screen appropriately for Dark Mode.

• ZDCChatEventTypeRatingComment is not used. Instead ZDCChatEventTypeRating is updated with the posted comment.

• There is an issue with uploading non-JPG images.ZDChatAPI.Instance().uploadImage only works with jpeg images. One workaround is to use UIImagePNGRepresentation(image); before calling uploadImage.

• There is an issue when observing account availability, where the end-user was occasionally unable to leave an offline message. Resolved in v1.4.4.

• If you're using Xcode 10 and see a build error related to ___isPlatformVersionAtLeast, then you'll need to update your Podfile to point to a specific branch as follows (replace 1.x.x with the version you're trying to use): pod 'ZDCChat', git: '[email protected]:zendesk/zendesk_sdk_chat_ios.git', branch: 'release/1.x.x-Xcode10'

• There is an issue when presenting with translucent UINavigationController on iOS 10 and below. This causes the first message of a chat to go under the navigation bar. The solution is to disable translucency on UINavigationBar.

• We're aware of padding issues when building for iOS 10. We will be addressing the issues in the next release. Known issues are as follows:

  • Chat messages appear under the navigation bar.
  • Pre-chat fields appear under the navigation bar.
  • The chat text view has too much upper and bottom padding.
  • The bottom part of chat messages is clipped.
  • Accessing the photo library on the simulator crashes the application. Note: ZDCChat SDK has been tested with Xcode8 beta 2 (8S162m)

• When uploading an image using the ZDCChatAPI, sometimes you will get a different event ID for the same uploaded image. This will make it hard to update an event as being verified (i.e. received by the server)

To work around that, match the upload URL to a specific event ID:

 // Create a dictionary that handles the duplicated uploads
 var duplicateUpload: [String: String]

 func filterDuplicateUploads(event: ZDCChatEvent) -> ZDCChatEvent! {
   if event.type != .VisitorUpload || event.fileUpload == nil {
     // If the event s not an upload event
     return event
   }

   // Get the stored ID for a specific Upload URL
   if let uid = duplicateUpload[event.fileUpload.uploadURL] {
     // Update the event's id
     event.eventId = uid
   }

   // Store the event id for the uploaded URL
   duplicateUpload[event.fileUpload.uploadURL] = event.eventId

   // Return the updated event
   return event
 }

• When rotating the attach image action sheet on iPad, the position of the action sheet changes place.

• Messages sent from an offline agent won't appear in the chat screen until that agent comes back online.

• iOS 9.0.2 UITextView links bug, see https://github.com/zendesk/zendesk_sdk_chat_ios/issues/17
• Integrators adding the Chat SDK via Cocoapods or manually may have to include the MobileCoreServices.framework in the Link Binary With Libraries section of their Xcode workspace.

• tags are not correctly submitted