🗯️
Chat SDK
  • Chat SDK Docs
  • Guides
    • Android Docs
    • iOS Docs
    • API Cheat Sheet
    • Best Practices and Troubleshooting
    • Custom Token Authentication
    • Firebase Schema
    • Custom File Upload Handler
  • Commercial
    • Module Licensing
    • Consulting Charges
    • Scalability and Cost
    • Firebase vs. Firestream vs. XMPP
    • Licensing FAQ
    • Adding Modules from source
  • XMPP
    • XMPP Setup Guide
  • About Us
    • History of Chat SDK
  • Architecture
    • Backend Agnostic Architecture
  • Modules
    • Sticker Message Module
Powered by GitBook
On this page
  • iOS
  • Android

Was this helpful?

  1. Commercial

Adding Modules from source

iOS

To add an iOS module from source, do the following.

  1. Unzip the module archive to a known location on your system. We will use the path to the module folder later

  2. Add the licensing pod to your Podspec:

    pod "Licensing", :path => "Path to module folder"

3. Add the module pod:

 pod "MessageModules/StickerMessage", :path => "Path to module folder"
 pod "MessageModules/VideoMessage", :path => "Path to module folder"
 pod "MessageModules/AudioMessage", :path => "Path to module folder"
 pod "MessageModules/KeyboardOverlayOptions", :path => "Path to module folder"
 pod "MessageModules/FileMessage", :path => "Path to module folder"
    
 pod "FirebaseModules/FirebaseBlocking", :path => "Path to module folder"
 pod "FirebaseModules/FirebaseLastOnline", :path => "Path to module folder"
 pod "FirebaseModules/FirebaseTypingIndicator", :path => "Path to module folder"
 pod "FirebaseModules/FirebaseReadReceipts", :path => "Path to module folder"
 pod "FirebaseNearbyUsersModule/FirebaseNearbyUsers", :path => "Path to module folder"

 pod "ContactBookModule/ContactBook", :path => "Path to module folder"
 pod "EncryptionModule/Encryption", :path => "Path to module folder"

 pod "ChatSDKXMPP/XMPPAdapter", :path => "Path to module folder"
 pod "ChatSDKXMPP/XMPPReadReceipts", :path => "Path to module folder"

4. Run pod install 5. Import the module in your app delegate:

import MessageModules
import FirebaseModules
import ContactBookModule
...

6. Enable the module:

let modules = [
    // Other ChatSDK dependencies
    ...
    BBlockingModule.init(),
    BReadReceiptsModule.init(),
    BTypingIndicatorModule.init(),
    BLastOnlineModule.init(),
    StickerMessageModule.shared(),
    BVideoMessageModule.init(),
    FileMessageModule.init(),
    BContactBookModule.init(),
    BAudioMessageModule.init(),
    BKeyboardOverlayOptionsModule.init(),
    BNearbyUsersModule.shared(),
    EncryptionModule.init(),
]

Android

  1. Unzip the archive to a known location

  2. Open Android Studio

  3. Click File -> New -> Import Module

  4. Select the module directory

  5. Enable the module. In your main application class add:

ChatSDK.builder()
    ...
    build()
    .addModule(FirebaseEncryptionModule.shared())
    .addModule(ContactBookModule.shared())
    .addModule(FileMessageModule.shared())
    .addModule(AudioMessageModule.shared())
    .addModule(StickerMessageModule.shared())
    .addModule(VideoMessageModule.shared())
    .addModule(FirebaseBlockingModule.shared())
    .addModule(FirebaseLastOnlineModule.shared())
    .addModule(FirebaseNearbyUsersModule.builder().build())
    .addModule(FirebaseReadReceiptsModule.shared())
    .addModule(FirebaseTypingIndicatorModule.shared())
    .build().activate...
PreviousLicensing FAQNextXMPP Setup Guide

Last updated 3 years ago

Was this helpful?