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
  • INSTALLATION
  • SETUP INFO.PLIST
  1. SDK
  2. [Under Development] iOS
  3. [Under Development] iOS Setup Guide

[Under Development] Integration Guide (Core)

This guide describes the process of implementing AcquireIOSupport Core SDK into your iOS app We recommend using CocoaPods as the most advanced way of managing iOS project dependencies.

Previous[Under Development] Getting StartedNext[Under Development] Integration Guide (Lite)

Last updated 3 years ago

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

INSTALLATION

To connect AcquireIOSupport Core SDK to your iOS app just add it into your Podfile:

1) Create a Podfile in your project's root directory, if it doesn't exist yet

2) Add the AcquireIOSupport-Core in Podfile under your desired target:

target :YourTargetName do
      pod 'AcquireIOSupport-Core'
end

3) The AcquireIOSupport SDK supports module stability and therefore all its dependencies must be built-in with the "Build Libraries for Distribution" setting enabled, however this is not currently supported in Cocoapods. Running the below command will ensure Xcode builds the dependencies with the correct settings. Once Cocoapods supports module stability, this workaround can be removed.

Add the following to the bottom of your Podfile:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    if ['TwilioVideo', 'Socket.IO-Client-Swift', 'Starscream'].include? target.name
      target.build_configurations.each do |config|
          config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
          config.build_settings['ENABLE_BITCODE'] = 'NO'
      end
    end
  end
end

4) Run the below command to install the SDK to your project

bash

$ pod install --repo-update

5) Open your project using the generated *.xcworkspace file.

Make sure to always open the Xcode workspace instead of the project file when building your project:

Open MyApp.xcworkspace

6) Make sure to disable bitcode for your project: Go to your project's settings and find the Build settings tab, check All and search for bitcode, then set it to No.

SETUP INFO.PLIST

Since iOS 10, it's mandatory to add before you access privacy-sensitive data like Camera, Microphone, and so on, you must ask for the authorization, or your app will crash when you access them.

Open the file in your project named info.plist, right-click it, opening as Source Code, paste this code below to it. Or you can open info.plist as Property List by default, click the add button, Xcode will give you the suggested completions while typing Privacy - with the help of keyboard and

Remember to write your description of why you ask for this authorization, between and, or your app will be rejected by Apple:

<!-- Camera -->
<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) use camera for video chat</string>

<!-- Microphone -->
<key>NSMicrophoneUsageDescription</key>
<string>$(PRODUCT_NAME) use microphone for voice chat</string>

<!-- Photo Library -->
<key>NSPhotoLibraryUsageDescription</key>
<string>$(PRODUCT_NAME) send photo/video to agent</string>

Also, The AcquireIOSupport SDK uses background mode Audio for when you are video/voice call to agent/visitor. If you have not enabled then background voice will not work. When the UIBackgroundModes key contains the audio value, the system’s media frameworks automatically prevent the corresponding app from being suspended when it moves to the background

To allow your AcquireIOSupport SDK to play audio in the background, Enable it using the below steps

1) Select your project file in the Navigator of Xcode. 2) From the Capabilities section, switch on the Background Modes subsection 3) Switch ON the Background Modes subsection. After background modes are listed, tick on the Audio, Airplay & picture in the picture

NOTE: IF YOU ARE NEW TO COCOAPODS, GO TO TO LEARN HOW TO INSTALL IT.

COCOAPODS