Hyphenate Docs

Start Chatting with Hyphenate!

Welcome to the Hyphenate docs portal. Here you'll find comprehensive guides and technical documentation to help you integrate Hyphenate In-App Chat.

Get Started

Install the iOS SDK

Demo App

iTunes store download

There are two different Hyphenate SDKs

  1. Hyphenate
  2. HyphenateLite (without voice & video calling features)

Installation

There are two installation options for iOS, either use CocoaPods, an iOS library management tool, or download and install the library directly. We recommend using CocoaPods instead of downloading the library file for simplicity of library update and dependency management.

Option 1: Use CocoaPods (Recommended)

The Hyphenate SDK for iOS is available on CocoaPods. CocoaPods is an open source dependency manager for Cocoa projects.

  1. If you have not installed the CocoaPods tool yet, please check out CocoaPods Getting Started guide for more details.

  2. Add one of the following SDK files to the Podfile
    Hyphenate iOS Lite SDK

    $ pod 'HyphenateLite'
    

    Hyphenate iOS SDK (Supports real-time Voice & Video Calling features)

    $ pod 'Hyphenate'
    
  3. Open the Terminal and navigate to the directory containing the Podfile

    $ cd <path-to-project>
    
  4. To install or update the pod, run one of the following commands:

    $ pod install
    $ pod update
    
  5. Close the Xcode project if it's open. Double click to open the project workspace with the .xcworkspace file extension. From now on, you need to use the .xcworkspace file to open your project and associated Pods.

Please check out the CocoaPods Getting Started guide for more details.

Option 2: Download the SDK from Hyphenate

  1. Download and Import Hyphenate SDK

Drag the downloaded SDK folder into the project and select the Destination option.

  1. Configure the project settings.

SDK Implementation

AppDelegate.m

#import <Hyphenate/Hyphenate.h>

/** Hyphenate configuration constants **/
static NSString *const kAPIKey = @"hyphenate#demo";                    // API Key
static NSString *const kPushDev = @"DevelopmentCertificate";        // push service certificate name for development
static NSString *const kPushProduction = @"ProductionCertificate";    // push service certificate name for production 

@implementation AppDelegate

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 
{
    EMOptions *options = [EMOptions optionsWithAppkey:kAPIKey];

    NSString *apnsCertName = nil;
    #if DEBUG
        apnsCertName = kPushDev;
    #else
        apnsCertName = kPushProduction;
    #endif

    options.apnsCertName = apnsCertName;    
    [[EMClient sharedClient] initializeSDKWithOptions:options];
}

AppDelegate.swift

import Hyphenate

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

    let options = EMOptions.init(appkey: "hyphenate#demo")     

    var apnsCerName = ""     
    #if DEBUG
        apnsCerName = "DevelopmentCertificate"
    #else
        apnsCerName = "ProductionCertificate"
    #endif

    options?.apnsCertName = apnsCerName         
    EMClient.shared().initializeSDK(with: options)  
}

Use the resources below for getting your API Key and certificates:

  1. Get Hyphenate API Key
  2. Create and upload push service certificate

Next step: Push Notification

Install the iOS SDK


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.