Code Monkey home page Code Monkey logo

intercom-ios's Introduction

Intercom

CocoaPods Languages CocoaPods carthage compatible Apache License CocoaPods

Installation

Intercom for iOS supports iOS 8, iOS 9 and iOS 10.

CocoaPods

Add the Intercom pod into your Podfile and run pod install.

target :YourTargetName do
  pod 'Intercom'
end

Carthage

  1. Add github "intercom/intercom-ios" to your Cartfile.
  2. Run carthage update.
  3. Go to your Xcode project's "General" settings. Drag Intercom.framework from Carthage/Build/iOS to the "Embedded Binaries" section. Make sure “Copy items if needed” is selected and click Finish.

Manual Installation

  1. Download Intercom for iOS and extract the zip.

  2. Go to your Xcode project's "General" settings. Drag Intercom.framework to the "Embedded Binaries" section. Make sure "Copy items if needed" is selected and click Finish.

  3. Create a new "Run Script Phase" in your app’s target’s "Build Phases" and paste the following snippet in the script text field:

     bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Intercom.framework/strip-frameworks.sh"
    

This step is required to work around an App Store submission bug when archiving universal binaries.

Update Info.plist

When installing Intercom, you'll need to make sure that you have a NSPhotoLibraryUsageDescription entry in your Info.plist.

This is required by Apple for all apps that access the photo library. It is necessary when installing Intercom due to the image upload functionality. Users will be prompted for the photo library permission only when they tap the image upload button.

Example app

There is an example app provided here for both Objective-C and Swift.

Setup and Configuration

Cordova/Phonegap Support

Looking for Cordova/Phonegap support? We have a Cordova Plugin for Intercom 🎉

Upgrading to v3.0

Upgrading to the latest version of the iOS SDK is easy! 😉 Checkout out our upgrade guide for more info.

What about events, push notifications, company and user data?

Intercom for iOS has support for all these things. For full details please read our documentation.

Xcode Documentation

This documentation provides integrated help in Xcode for all public APIs in Intercom for iOS. Download the docset from the latest release and Copy the content into ~/Library/Developer/Shared/Documentation/DocSets.

Migrating from legacy version of the SDK

To upgrade from SDK versions older then version 2.2.4 there are some method changes that you may want to be aware of. See installation instructions at the top of this page for more information on how to install the new version of the SDK.

iOS Method Name Changes
Old NameTypeNew Name
From SDK version 2.0.x
beginSessionForUserWithUserIdName change. Dropped block parameter.registerUserWithUserId
beginSessionForUserWithEmailName change. Dropped block parameter.registerUserWithEmail
beginSessionForAnonymousUserWithCompletionName change. Dropped block parameter.registerUnidentifiedUser
updateUserWithAttributesDropped block parameter.n/a
logEventWithNameDropped block parameter.n/a
From SDK version 1.x.x
beginSessionForUserWithUserIdName change. Dropped block parameter.registerUserWithUserId
beginSessionForUserWithEmailName change. Dropped block parameter.registerUserWithEmail
updateAttributesName change. Dropped block parameter.updateUserWithAttributes

intercom-ios's People

Contributors

jtreanor avatar roland9 avatar br1an-boyle avatar dalecantwell avatar briandonohue avatar bnd5k avatar harkin avatar erskingardner avatar eoghanintercom avatar bryant1410 avatar idcuesta avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.