Close Menu

channelssdk

Introduction

The Channels SDK is a powerful tool for integrating real-time messaging and notifications into your applications. With the SDK, you can easily enable features like instant messaging, real-time updates, push notifications, and more. This documentation will guide you through the process of setting up and using the Channels SDK.

Installation

To get started with the Channels SDK, you need to install it in your project. Follow the steps below to install the SDK:

  1. Open your project in Xcode.
  2. Click on “File” in the menu bar, then select “Swift Packages” and then “Add Package Dependency”.
  3. In the search bar, enter “https://github.com/ChannelsSDK/ChannelsSDK.git”.
  4. Select the latest version of the SDK and click on “Next”.
  5. Choose the desired target and click on “Finish” to complete the installation.

Getting Started

Once you have installed the Channels SDK in your project, you can begin integrating it into your application. Follow the steps below to get started:

Step 1: Import the SDK

In the file where you want to use the Channels SDK, import the SDK using the following line of code:

// Swift
import ChannelsSDK

// Objective-C
@import ChannelsSDK;

Step 2: Initialize Channels

Before using any Channels features, you need to initialize Channels with your credentials. This should be done early in your application’s lifecycle. Use the following code to initialize Channels:

// Swift
Channels.initialize(appId: "YOUR_APP_ID", appKey: "YOUR_APP_KEY")

// Objective-C
[Channels initializeWithAppId:@"YOUR_APP_ID" appKey:@"YOUR_APP_KEY"];

Step 3: Authenticate User

To use Channels’ user-specific features like private channels and direct messaging, you need to authenticate the user. Use the following code to authenticate the user:

// Swift
Channels.authenticateUser(userId: "USER_ID", token: "AUTH_TOKEN")

// Objective-C
[Channels authenticateUserWithUserId:@"USER_ID" token:@"AUTH_TOKEN"];

API Reference

The Channels SDK provides a rich set of APIs for managing channels, sending messages, handling notifications, and more. Refer to the API reference below for detailed information about each API:

  • Channels.initialize(appId: String, appKey: String): Initializes Channels with your app ID and app key.
  • Channels.authenticateUser(userId: String, token: String): Authenticates the user with the provided user ID and authentication token.
  • Channels.createChannel(channelName: String): Creates a new channel with the given name.
  • Channels.sendMessage(channelId: String, message: String): Sends a message to the specified channel.
  • Channels.addUserToChannel(userId: String, channelId: String): Adds a user to a channel.
  • Channels.sendPushNotification(channelId: String, message: String): Sends a push notification to the users in the specified channel.
  • And many more…

Troubleshooting

If you encounter any issues while using the Channels SDK, refer to the troubleshooting tips below:

  • Make sure you have entered the correct app ID and app key during initialization.
  • Check your internet connection to ensure you can communicate with the Channels servers.
  • Verify that the user ID and authentication token are valid and have sufficient permissions.
  • If you are experiencing push notification issues, ensure that push notifications are properly configured in your project settings.
  • If problems persist, refer to the Channels SDK GitHub repository for known issues and possible solutions.

Conclusion

With the Channels SDK, you can bring real-time messaging capabilities to your applications without hassle. Now that you have completed the setup and familiarized yourself with the API, you can unleash the power of real-time communication in your app. Happy coding!