flutter_pusher_client 0.2.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 87

Pusher Flutter Client #

pub package

An unofficial Flutter plugin that wraps pusher-websocket-java on Android and pusher-websocket-swift on iOS.

This package lets you consume events from a Pusher server. In order to use this library, you need to have a free account on http://pusher.com. After registering, you will need the application credentials for your app.

Note: This plugin is still under development, and some APIs might not be available yet. Feedback and Pull Requests are most welcome!

How to install #

  • Add to your pubspec.yaml
dependencies:
  flutter_pusher_client: ^0.1.0

Getting Started #

import 'package:flutter_pusher_client/flutter_pusher.dart';

void main() {

  var options = PusherOptions(host: '10.0.2.2', port: 6001, encrypted: false);
  FlutterPusher pusher = FlutterPusher('app', options, enableLogging: true);

  pusher.subscribe('channel').bind('event', (event) => {});
}

Lazy Connect #

Connection to the server can be delayed, so set the lazyConnect prop on the client constructor.

Development #

Generate the models and the factories: flutter packages pub run build_runner build --delete-conflicting-outputs

0.2.1 #

  • Upgrade kotlin version to (v1.3.61)

0.2.0 #

  • Fix multi-instance flow

0.1.1 #

  • Updates on documentation.
  • FlutterPusher.subscribe now returns Channel instead of Future<Channel>

0.1.0 #

  • TODO: Describe initial release.

example/lib/main.dart

import 'dart:developer';

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutter_pusher_client/flutter_pusher.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      var options =
          PusherOptions(host: '10.0.2.2', port: 6001, encrypted: false);
      PusherClient pusher = PusherClient('app', options, enableLogging: true);

      pusher
          .subscribe('channel')
          .bind('event', (event) => log('event =>' + event.toString()));
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Running on: $_platformVersion\n'),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_pusher_client: ^0.2.1

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:flutter_pusher_client/flutter_pusher.dart';
import 'package:flutter_pusher_client/flutter_pusher.g.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
75
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
87
Learn more about scoring.

We analyzed this package on Mar 27, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health suggestions

Format lib/flutter_pusher.dart.

Run flutter format to format lib/flutter_pusher.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.2 <3.0.0
flutter 0.0.0
json_annotation ^3.0.0 3.0.1
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
build_runner ^1.5.2
flutter_test
json_serializable ^3.2.0