Kindly iOS SDK — Events Reference

KindlySDK.events: AnyPublisher<KindlyEvent, Never>    // all events
KindlySDK.state:  AnyPublisher<KindlyEventState, Never>  // state-only convenience

import Combine

var cancellables = Set<AnyCancellable>()

KindlySDK.events
    .sink { event in
        switch event.detail {
        case .load(let settings):             handleLoad(settings)
        case .message(let new, let log):      handleMessage(new, log: log)
        case .buttonClick(let btn, let type, let log, let last):
                                              handleButton(btn, type: type, log: log, last: last)
        case .ui(let action):                 handleUI(action)
        case .globalIcon(let action):         handleGlobalIcon(action)
        case .state(let state):               handleState(state)
        }
    }
    .store(in: &cancellables)

public struct KindlyEvent {
    public let type: KindlyEventType
    public let detail: KindlyEventDetail
    public let timestamp: Date   // when the event was emitted
}

public enum KindlyEventDetail {
    case load(settings: KindlyEventSettings)
    case message(newMessage: KindlyEventMessage, chatLog: [KindlyEventMessage])
    case buttonClick(button: KindlyEventButton, buttonType: String,
                     chatLog: [KindlyEventMessage], lastMessage: KindlyEventMessage)
    case ui(action: KindlyEventUIAction)
    case globalIcon(action: KindlyEventGlobalIcon)
    case state(state: KindlyEventState)
}

public struct KindlyEventMessage {
    public let id: String
    public let text: String?
    public let sender: KindlyEventMessageSender
    public let created: Date?
    public let isFromUser: Bool
    public let exchangeID: String?
    public let videoSource: String?
    public let exchangeType: KindlyEventExchangeType?
    public let buttons: [KindlyEventButton]
    public let images: [KindlyEventImage]
    public let attachments: [KindlyEventAttachment]
}

public struct KindlyEventButton {
    public let id: String?
    public let type: String        // e.g. "quickreply", "postback", "url"
    public let label: String       // text shown on the button
    public let value: String?      // payload; interpretation depends on `type`
    public let index: Int?         // position in the button list
    public let hasBeenSelected: Bool
    public let context: [String: Any]?
}

public struct KindlyEventUIAction {
    public let type: KindlyUIActionType
    public let source: String          // "user" or "programmatic"
    public let chatId: String
    public let value: [String: Any]?
    public let feedbackType: String?   // only for showFeedback/submitFeedback/dismissFeedback
    public let feedbackValue: [String: Any]?
    public let languageCode: String?           // only for changeLanguage
    public let languageName: String?
    public let previousLanguageCode: String?
    public let previousLanguageName: String?
    public let nextPage: String?
}

public struct KindlyEventGlobalIcon {
    public let type: String
    public let source: String
    public let value: [String: Any]?
}

public struct KindlyEventState {
    public let isChatDisplayed: Bool      // chat UI is on screen
    public let isStarted: Bool            // KindlySDK.start(...) completed
    public let isSocketConnected: Bool    // Pusher WebSocket is live
    public let isConnected: Bool          // isStarted && isSocketConnected
    public let connectionState: String    // "connected", "connecting", "disconnected", etc.
}

public struct KindlyEventLanguage {
    public let code: String       // "en", "sv", "fr", ...
    public let name: String       // "English", "Swedish", ...
    public let isDefault: Bool
}

public struct KindlyEventImage {
    public let url: String
    public let altText: String?
    public let id: String?
}

public struct KindlyEventAttachment {
    public let id: String
    public let name: String
    public let format: String       // e.g. "pdf", "png"
    public let status: String       // e.g. "uploaded", "pending"
    public let sender: String
    public let storagePath: String  // remote storage path
}

KindlySDK.events
    .compactMap { event -> KindlyEventMessage? in
        guard case .message(let new, _) = event.detail,
              new.sender == .bot else { return nil }
        return new
    }
    .sink { botMessage in
        print("Bot: \(botMessage.text ?? "")")
    }
    .store(in: &cancellables)

KindlySDK.events
    .sink { event in
        if case .buttonClick(let button, let type, _, _) = event.detail {
            print("User tapped [\(type)] \(button.label) → value=\(button.value ?? "nil")")
        }
    }
    .store(in: &cancellables)

KindlySDK.events
    .sink { event in
        guard case .ui(let action) = event.detail,
              action.type == .changeLanguage,
              let to = action.languageCode,
              let from = action.previousLanguageCode else { return }
        analytics.log("language_changed", from: from, to: to)
    }
    .store(in: &cancellables)

KindlySDK.state
    .filter { $0.isConnected }
    .prefix(1)
    .sink { _ in
        KindlySDK.triggerDialogue(id: "welcome_flow")
    }
    .store(in: &cancellables)

KindlySDK.events
    .compactMap { event -> [KindlyEventMessage]? in
        if case .message(_, let log) = event.detail { return log }
        return nil
    }
    .sink { transcript in
        // transcript is always the full, up-to-date chat log
        currentTranscript = transcript
    }
    .store(in: &cancellables)

KindlySDK.state
    .receive(on: DispatchQueue.main)
    .sink { state in
        self.statusLabel.text = state.connectionState
    }
    .store(in: &cancellables)