LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
2.0.0
2.0.0
  • Getting Started
  • Widget
    • Overview
    • Installation
    • Customization
      • Settings
        • Greeting
        • Greeting Introduction
        • Conversation button
        • Conversation list title
        • Launcher Text
        • Widget Appearance
      • Methods
        • Widget visibility
        • Widget window state
        • Set Customer Info
        • Get Customer info
      • Events/Callbacks
        • reloadUI
        • onChatMaximize
        • onChatMinimize
        • onChatInitiated/Started
        • onChatClosed
        • onAgentAssign
        • onAgentStateChange (Available/Unavailable)
      • Link resources
        • Share channel link
  • SDK
    • [Under Development] Overview
    • [Under Development] iOS
      • [Under Development] iOS Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Initialization
      • [Under Development] Theme Setting
      • [Under Development] Acquire Delegates for iOS
      • [Under Development] Widget customization
      • [Under Development] React Native
    • [Under Development] Android
      • [Under Development] Android Setup Guide
        • [Under Development] Getting Started
        • [Under Development] Integration Guide (Core)
        • [Under Development] Integration Guide (Lite)
      • [Under Development] Acquire SDK APIs
      • [Under Development] Acquire Delegates for Android
      • [Under Development] React Native
  • Webhooks
    • Introduction
    • Getting Started
    • Securing Webhook
    • Webhook Events
  • REST APIs
    • Introduction
      • Request Types, Permissions, Errors, & Limits
    • Authorization
    • Conversation
      • Cases
        • Messages
          • Retrieve a list of messages
          • Retrieve a message
          • Send a message
          • Update message
          • Delete Message
        • Case List
        • Single Case
        • Create
        • Close Case
        • Reopen Case
        • Invite Agent
      • Snooze
        • [Under Construction] Delete Snooze
        • Create Snooze
      • Notes
        • List all notes
        • Retrieve a note
        • Create
        • Add note message
        • Delete note
        • Retrieve note messages
    • Contact
      • List all contacts
      • Retrieve a contact
      • Add contact
      • Block Contact
      • Merge contact
      • Update contact
      • Delete contact
    • Company
      • List all companies
      • Retrieve a company
      • Add company
      • Update company
      • Delete company
    • Phone
      • Call in queue
      • Ringing
      • Answered
      • Call end
    • Chatbot
      • Conversational Bot
        • Groups
          • Get Default Group
          • List
          • Add
          • Delete
          • Copy
        • Question And Answer
          • List
          • Get
          • Add
          • Update
          • Delete
          • Publish
          • Bulk Action
          • Push QnA To Suggestions
          • Import QnA
      • Sequence Bot
        • Sequence List
        • Get Single Sequence
        • Add
        • Update
        • Delete
        • Bulk Action
        • Copy Existing Sequence
        • Branch
          • Get Single Branch
          • Add
          • Update
          • Delete
          • Set as Parent Branch
      • Bot resources
      • Webhooks in chatbot
    • Analytics
      • Custom Reporting
      • General Analytics
      • Chat
        • Overview
        • Tags
        • Visitor Information
          • Visitor Analytics
          • Visitor Source Overview
        • Video Analytics
      • Cobrowse
      • Chatbot
        • Sequence Bot
        • Conversational Bot
      • Knowledge Base
      • Email
      • VoIP - Call SMS
      • Agent Performance
    • [Under Construction] Custom Cards
      • Timeline-cards
        • Create Interaction Card
        • Update Interaction Card
        • List all Cards
        • Retrieve a card
        • Delete card
      • Exclusive cards
        • Create general card
        • Create app card - from other system
        • Delete card
    • Knowledge Base
      • Groups
        • Add
        • Update
        • Get
        • Get Single
        • Delete
      • Articles
        • Add Article
        • Update Article
        • Delete Article
        • Get Articles
        • Get Single Article
      • Category
        • Add Category
        • Update Category
        • Delete Category
        • Get Category
    • Settings
      • Account Settings
        • Users
          • List
          • Get Single
          • Add
          • Update
          • Delete
        • Roles
          • List
          • Get Single Role
          • Add
          • Update
          • Delete
        • Departments
          • List
          • Get
          • Add
          • Update
          • Delete
        • Custom Attributes
          • List of custom attributes
          • Get a custom Attribute
          • Add a custom attribute
          • Update a custom attribute
          • Delete a custom attribute
      • Conversation Settings
        • Shortcuts
          • List Groups
          • Get
          • Add
          • Update
          • Delete
        • Tags
          • List All Tags
          • Get Single Tag
          • Add New Tag
          • Update Tag
          • Delete Tag
        • Feedback
          • List of all feedback
          • Get single feedback
          • Add feedback
          • Update Feedback
          • Delete feedback
      • Security
        • Block Visitor
          • List
          • Get
          • Add
          • Delete
        • Audit Logs
          • Audit Log
          • Audit Log Users
Powered by GitBook
On this page
  1. SDK
  2. [Under Development] iOS

[Under Development] Acquire Delegates for iOS

Our SDK is currently under review. Check back later for updates.

AcquireIOSupport iOS SDK Delegates

To add listeners provided by AcquireIOSupport SDK, add the following line on your class where you want to listen to our SDK events

AcquireIO.support.delegate = self

ConnectionStatusChange

This method will be called by SDK when connection status will change. The details of status that was updated during the connection will be available in the argument.

func didChangeConnectionStatus(status: AcquireIOConnectionStatus)

AcquireIOConnectionStatus - Connection session status

public enum AcquireIOConnectionStatus : Int {
    /// App support session connection status not connected.
    case notConnected = 0
    /// App support session connection status disconnected.
    case disconnected
    /// App support session connection status connecting.
    case connecting
    /// App support session connection status connected.
    case connected
    /// App support session connection status started.
    case sessionStarted
}

Once connection is established with Acquire server, the delegate will receive either didChangeConnectionStatus: or onError:.

onError

This function will provide connection related error i.e. invalid input data, expire data etc. To get more details about the error encountered while establishing connection, Implement below delegate method

func onError(error: Error)

onCallSupportStatusChange

When status of Audio/Video call with Agent changes SDK will call below method. The details of call status that was updated during the connection will be available in the arguments along with the optional message string. To get the call connection status, use

func onCallSupportStatusChange(_ status: AcquireIOCallSupportStatus, withMessage message: String?)

AcquireIOCallSupportStatus - Call status

public enum AcquireIOCallSupportStatus : Int {
    case notConnected
    case disconnected
    case connecting
    case connected
}

onAgentConnected

This will be called when agent is connected.

func onAgentConnected()

didChangeAgentStatus

This optional method will be called by SDK when Agent status changes. The details of agent status that was updated during the connection will be available in the argument along with Agent ID.

func didChangeAgentStatus(agentID: String, andStatus status: AcquireIOAgentStatus)

AcquireIOAgentStatus - Status for the agent.

public enum AcquireIOAgentStatus : Int {
    /// Online status for agent.
    case online = 0
    /// Offline status for agent.
    case offline
    /// Invisible status for agent.
    case invisible
}

didUserInteracted

This will be called when user interacts with events.

func didUserInteracted(withEvent type: AcquireIOInteractionEventType, withData data: [String : Any]?)

Event Types available are listed below:

public enum AcquireIOInteractionEventType : Int {
    case audioCallStarted = 0
    case videoCallStarted
    case audioCallAnswered
    case videoCallAnswered
    case callDeclined
    case callAutoDeclined
    case callerViewMinimize
    case callerViewMaximize
    case callerViewCameraSwitchToFront
    case callerViewCameraSwitchToBack
    case callSpeakerOn //10
    case callSpeakerOff
    case callMute
    case callUnmute
    case callVideoOn
    case callVideoOff
    case callDisconnected
    case conversationStart
    case conversationEnd
    case conversationFeedbackSubmit
}

Note: For Lite version, only following events will be received

  1. conversationStart

  2. conversationEnd

  3. conversationFeedbackSubmit

didReceiveTriggerEvent

This optional method will be called when fire rule matched for created Triggers from the agent panel. It will receive eventName as parameter

func didReceiveTriggerEvent(_ eventName: String)

openSupport

This optional method will be called when support view controller is open.

func didOpenAcquireSupport()

hideSupport

This optional method will be called when support view controller is dismissed.

func hideSupport()

didReceiveNewMessage

This optional method will be called by SDK when a new message has been received. The details of the message received will be available in the argument.

func didReceiveNewMessage(_ message: Any)
Previous[Under Development] Theme SettingNext[Under Development] Widget customization

Last updated 3 years ago