https://github.com/agoraio-extensions/agora-react-native-rtm

Agora RTM SDK for react-native
https://github.com/agoraio-extensions/agora-react-native-rtm

agora-sdk react-native rtm

Last synced: 24 days ago
JSON representation

Agora RTM SDK for react-native

• Host: GitHub
• URL: https://github.com/agoraio-extensions/agora-react-native-rtm
• Owner: AgoraIO-Extensions
• License: mit
• Created: 2023-11-16T10:53:55.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-08-27T10:28:29.000Z (about 2 months ago)
• Last Synced: 2025-08-27T17:05:14.049Z (about 2 months ago)
• Topics: agora-sdk, react-native, rtm
• Language: TypeScript
• Homepage: https://agoraio-extensions.github.io/agora-react-native-rtm/
• Size: 3.18 MB
• Stars: 0
• Watchers: 1
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# agora-react-native-rtm

[![npm](https://img.shields.io/npm/v/agora-react-native-rtm.svg)](https://www.npmjs.com/package/agora-react-native-rtm)

[![npm](https://img.shields.io/npm/dm/agora-react-native-rtm.svg)](https://www.npmjs.com/package/agora-react-native-rtm)

[![npm](https://img.shields.io/npm/dt/agora-react-native-rtm.svg)](https://www.npmjs.com/package/agora-react-native-rtm)

[![npm](https://img.shields.io/npm/l/agora-react-native-rtm.svg)](LICENSE)

This SDK takes advantage of React Native and Agora RTM SDK on Android && iOS.

## Release Note

[Changelog](CHANGELOG.md)

## Installation

### Installing (React Native >= 0.70.0)

Install `agora-react-native-rtm`(^2.2.3):

```shell script

yarn add agora-react-native-rtm

```

or

```shell script

npm i --save agora-react-native-rtm

```

Go to your **ios** folder and run:

```shell script

pod install

```

## General Usage

```typescript

import { createAgoraRtmClient, RtmConfig } from 'agora-react-native-rtm';

const engine = createAgoraRtmClient(

  new RtmConfig({

    userId: Config.uid,

    appId: Config.appId,

  })

);

```

## Doc

- [API Ref](https://agoraio-extensions.github.io/agora-react-native-rtm/)

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT