Conversation

In this section you will learn how to create and launch the conversation.

Create and Launch Conversation

One of the easiest ways to create and launch the conversation is to use the below method.

// Pass an instance of the current UIViewController in the 'from' argument.
Kommunicate.createAndShowConversation(from: self) { error in
    guard error == nil else {
        print("Conversation error: \(error.debugDescription)")
        return
    }
    // Success
}

If there are no conversations present, then this method will create a new conversation where the agents and the logged in user will be present. If a conversation is already there, then it will open that conversation. In case there are multiple conversations present then the conversation list will be shown to the user.

If you want to customise it like you want to create your own flow, then check out the Custom Flow section below.

Sync conversations on app launch

Below code is used to sync conversations from server whenever app is launched. Put below lines in your AppDelegate's didFinishLaunchingWithOptions method.

KMPushNotificationHandler.shared.dataConnectionNotificationHandlerWith(Kommunicate.defaultConfiguration)
let kmApplocalNotificationHandler: KMAppLocalNotification =  KMAppLocalNotification.appLocalNotificationHandler()
kmApplocalNotificationHandler.dataConnectionNotificationHandler()

Custom Flow

Using this method you can create your own custom conversation flow. Let's say you want to create a new conversation every time when the user clicks on support, then use the API mentioned in the New Conversation section below.

Open Conversation List

To open a list of conversations use below method. Reference to current view controller needs to be passed.

  Kommunicate.showConversations(from: self)

New Conversation

To create a new conversation use below method. The agentIds and botIds are optional.

In the callback, conversationId will be returned in response.

Kommunicate.createConversation(
    userId: KMUserDefaultHandler.getUserId(),
    agentIds: ["<AGENT_IDS>"], // Optional. If you do not pass any agent ID, the default agent will automatically get selected. AGENT_ID is the emailID used to signup on Kommunicate dashboard.
    botIds: ["<BOT_IDS>"],// Optional list of botIds. Go to Manage Bots(https://dashboard.kommunicate.io/bots/manage-bots) -> Copy botID
    useLastConversation: true,
    clientConversationId: nil) { (conversationId) in

     guard !conversationId.isEmpty else {
         print("Failed to create conversation")
         return
      }

      // Use this conversationId to launch the conversation
         print(" ConversationId :  \(conversationId)")
 }

Parameters	Parameter Type	Default value	Descriptions
agentIds	Array of String	[]	Pass the list of human agents. The agent IDs would be the email IDs of your team members which they used to signup on Kommunicate. Otherwise, you can pass [] it will add deafult agents
botIds	Array of String	[]	Pass the list of bots. In Kommunicate dashboard account, go to Manage Bots -> Copy botID. Otherwise pass [] if you haven't integrated any bots.
useLastConversation	Bool	true	If you pass useLastConversation as false, then a new conversation will be created everytime. If you pass useLastConversation as true, then it will use old conversation which is already created with this data.
clientConversationId	String	nil	If you want to associate this conversation with a unique ID, then pass clientConversationId. If you pass clientConversationId then useLastConversation needs to be false.

Open Conversation

Open any particular conversation by passing the conversationId and reference to current view controller. You will get the conversationId after creating a conversation as described in the New Conversation section.

 Kommunicate.showConversationWith(
     groupId: conversationId,
     from: self,
     completionHandler: { success in
     print("conversation was shown")
 })