Warning
This is a beta product
AgoraRtm is a Swift package that provides an easy-to-use interface for integrating Agora Real-Time Messaging (RTM) into your iOS applications. It offers a set of classes and methods that enable you to establish real-time messaging and communication channels.
- User Authentication: Authenticate users using tokens for secure communication.
- Message Communication: Send and receive real-time messages between users.
- Presence Management: Query and update the presence status of users.
- Lock Management: Manage locks for synchronization between users.
- Storage Management: Store and retrieve user-specific data in real time.
- Topic Management: Create and manage channels for different topics.
- iOS 13.0+ or macOS 10.15
- Xcode 14.0+
- Swift 5.8+
To integrate AgoraRtm into your Xcode project, you can use Swift Package Manager. Here's how:
- In Xcode, open your project.
- Select File > Swift Packages > Add Package Dependency.
- Enter the package repository URL:
https://github.com/AgoraIO/AgoraRtm_Apple.git. - Choose a version rule or enter a specific branch, tag, or commit hash.
- Click Next, then Add
AgoraRtmKit-Swiftlibrary.
To get started with AgoraRtm, you need to initialize an RtmClientConfig instance and create an RtmClientKit instance with it. Here's an example:
import AgoraRtm
// Create an `RtmClientConfig` instance
let rtmConfig = RtmClientConfig(
appId: "example-appId",
userId: "example-username"
)
let rtmClient = RtmClientKit(config: rtmConfig, delegate: self)