agora_rtm 0.9.7

  • Readme
  • Changelog
  • Example
  • Installing
  • 78

AgoraRtm #

This Flutter plugin is a wapper for Agora RTM SDK.

Agora.io provides building blocks for you to add real-time messaging through a simple and powerful SDK. You can integrate the Agora RTM SDK to enable real-time messaging in your own application quickly.

Note: This plugin is still under development, and some APIs might not be available yet.

Usage #

To use this plugin, add agora_rtm as a dependency in your pubspec.yaml file.

Getting Started #

  • See the example directory for a sample app using AgoraRtm.

Note #

Agora RTM sdk contain arm64 architecture, but Flutter is not shipping “libflutter.so” in arm64 currently. You need add "abiFilters" in build.gradle if you need build release apk.

android {
    ..
    defaultConfig {
        ..
         ndk {
             abiFilters 'armeabi-v7a'
        }
        ..
    }
    ..
}

How to contribute #

To help work on this sdk, see our contributor guide.

Change log #

0.9.7 #

  • fix iOS cocoapods target has transitive dependencies that include static binaries

0.9.6 #

  • upgrade to rtm 1.0.1: Support all agora_rtm native api.
  • refactor: ios & android, use FlutterEventChannel to serve agora_rtm event handler
  • fix multiple instance conflicts

0.9.5 #

  • upgrade to rtm 1.0.0
  • add method: setLocalUserAttributes, addOrUpdateLocalUserAttributes, deleteLocalUserAttributesByKeys clearLocalUserAttributes getUserAttributes getUserAttributesByKeys

0.9.4 #

  • fix android pending exception java.lang.RuntimeException: Methods marked with @UiThread must be executed on the main thread

0.9.3 #

  • Bump kotlin version to 1.3.0

0.9.2 #

  • Flutter for Agora RTM SDK first release

example/README.md

AgoraRtm Example #

Demonstrates how to use the agora_rtm plugin.

Getting Started #

Create an Account and Obtain an App ID #

  1. Create a developer account at agora.io.
  2. In the Agora.io Dashboard that appears, click Projects > Project List in the left navigation.
  3. Copy the App ID from the Dashboard to a text file. You will use this ID later when you launch the app.

Update and Run the Sample Application #

Open the main.dart file. In the _createClient() method, update YOUR APP ID with your App ID.

_client = await AgoraRtmClient.createInstance('YOUR APP ID');

Run example #

Connect device and run.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  agora_rtm: ^0.9.7

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:agora_rtm/agora_rtm.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
65
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
80
Overall:
Weighted score of the above. [more]
78
Learn more about scoring.

We analyzed this package on Oct 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/agora_rtm.dart.

Run flutter format to format lib/agora_rtm.dart.

Format lib/src/agora_rtm_channel.dart.

Run flutter format to format lib/src/agora_rtm_channel.dart.

Format lib/src/agora_rtm_client.dart.

Run flutter format to format lib/src/agora_rtm_client.dart.

Format lib/src/agora_rtm_plugin.dart.

Run flutter format to format lib/src/agora_rtm_plugin.dart.

Format lib/src/utils.dart.

Run flutter format to format lib/src/utils.dart.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test