Code Monkey home page Code Monkey logo

crisp-sdk-ios's Introduction

Crisp

Chat with app users, integrate your favorite tools, and deliver a great customer experience.

Crisp iOS SDK

Crisp screenshot

CocoaPods Carthage Compatible Twitter

Installation

Cocoapods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate Crisp into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '9.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Crisp'
end

Then, run the following command:

$ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate Crisp into your Xcode project using Carthage, specify it in your Cartfile:

github "crisp-im/crisp-sdk-ios"

Run carthage update to build the framework and drag the built Crisp.framework into your Xcode project.

Requirements

โš ๏ธ Adding Camera and Photo permissions is mandatory, NSCameraUsageDescription and NSPhotoLibraryUsageDescription in Info.plist, to inform your users that you need to access to the Camera and Photo Library. You also have to enable "iCloud Documents" capability

Usage

Start using Crisp by adding the following code on your AppDelegate :

import Crisp
Crisp.initialize(websiteId: "YOUR_WEBSITE_ID")

Chatbox

You can add the Crisp bubble by adding in your view CrispButton() :

import UIKit
import Crisp

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        let crispButton = CrispButton()
        view.addSubview(crispButton)
        crispButton.bottomAnchor.constraint(equalTo: view.bottomAnchor, constant: -20).isActive = true
        crispButton.rightAnchor.constraint(equalTo: view.rightAnchor, constant: -20).isActive = true
    }

    override func didReceiveMemoryWarning() {
        super.didReceiveMemoryWarning()
    }
}

Preferences

You can change the main Crisp's color and texts :

Color

Crisp.preference.setColor(.red)
Crisp.preference.setColor(def: .blue)
Crisp.preference.setColor(hex: "000000")

Enum ThemeColors :

  • blue
  • amber
  • black
  • blueGrey
  • blueLight
  • brown
  • cyan
  • green
  • greenLight
  • grey
  • indigo
  • orange
  • orangeDeep
  • pink
  • purple
  • purpleDeep
  • red
  • teal

Theme Text

Crisp.preference.setThemeText(.defaultChat)
Crisp.preference.setThemeText(string: "LOCALIZED_STRING")

Enum ThemeText :

  • defaultChat
  • oneChat
  • twoChat
  • threeChat
  • fourChat

Theme Welcome

Crisp.preference.setThemeWelcome(.defaultChat)
Crisp.preference.setThemeWelcome(string: "LOCALIZED_STRING")

Enum ThemeWelcome :

  • defaultChat
  • oneChat
  • twoChat
  • threeChat
  • fourChat
  • fiveChat

User

  • Setters
Crisp.user.set(email: "[email protected]")
Crisp.user.set(avatar: "http://your.website.com/user_id/size")
Crisp.user.set(nickname: "Quentin de Quelen")
Crisp.user.set(phone: "+33645XXXXXX")
  • Getters
let email = Crisp.user.email
let avatar = Crisp.user.avatar
let nickname = Crisp.user.nickname
let phone = Crisp.user.phone

Chatbox

Open the chatbox with :

Crisp.chat.open()

Close the chatbox with :

Crisp.chat.close()

More

You can also check out our API Reference for more detailed information about our this SDK.

Credits

Crisp iOS SDk is owned and maintained by Crisp IM, inc. You can chat with us on crisp or follow us on Twitter at Crisp_im

License

Crisp iOS SDk is under Copyright license. see LICENSE for more details.

crisp-sdk-ios's People

Contributors

baptistejamin avatar qdequele 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.