Pusher Flutter Client

pub package

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

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: ^0.0.4
  • In /ios/Podfile, set global platform to at least 9.0 platform :ios, '9.0'

For iOS Objective-C based Flutter apps

It is currently a bit difficult to get some Swift based Flutter plugins working in an Objective-C based Flutter app. See here for info and here for a way to fix.

This set of steps should work to fix this for your project.

  • Add use_frameworks! to the end of the Runner section in /ios/Podfile
  • Set Swift version in your iOS Runner project.
    • Open the project with Xcode.
    • In Runner, File -> New -> File -> Swift File. Name it anything.
    • Xcode will ask you if you wish to create Bridging Header, click yes.
    • Go to Runner Build Settings and set SWIFT_VERSION to either 4.2 or 5.0
    • Delete the Swift file created in step 2
    • Delete the Bridging Header created in step 3
  • flutter clean
  • In /ios pod install --repo-update

How to use

Pusher.init( ... )

ParameterTypeDescription
appKeyStringRequired - The application key is a string which is globally unique to your application. It can be found in the API Access section of your application within the Channels user dashboard.
optionsPusherOptionsRequired - The options provided to pusher, more information in the PusherOptions section.
enableLoggingboolOptional - Enabling this will activate the logging of important events to the console.

Pusher.connect( ... )

ParameterTypeDescription
onConnectionStateChangeFunction(ConnectionStateChange)Optional - Callback when the state of the connection changes (eg. CONNECTING, CONNECTED, DISCONNECTED, ... ).
onErrorFunction(ConnectionError)Optional - Callback when the connection fires an error (eg. UnauthorizedException).

Pusher.subscribe( ... )

ParameterTypeDescription
channelNameStringRequired - provide the channel name to subscribe to (eg. mychannel, private-mychannel or presence-mychannel).

PusherOptions

ParameterTypeDescription
authPusherAuthOptional - A mechanism for authenticating a user's access to a channel at the point of subscription.
clusterStringOptional - The identifier of the cluster your application was created in. When not supplied, will connect to the mt1(us-east-1) cluster.
hostStringOptional - Provide your own (websocket) host instead of the default ws.pusherapp.com
portintOptional - Provide your own (websocket) port instead of the default 443 (when encryption is enabled) or port 80 (when encryption is disabled).
encryptedboolOptional - Tell pusher to only connect over TLS connections to ensure connection traffic is encrypted. This means using wss:// instead of ws://, encryption is enabled by default.
activityTimeoutintOptional - After this time (in milliseconds) without any messages received from the server, a ping message will be sent to check if the connection is still working. Default value is supplied by the server, low values will result in unnecessary traffic. The default is set to 30000.

PusherAuth

ParameterTypeDescription
endpointStringRequired - The endpoint pusher should query to make the post request (eg. https://api.example.com/broadcating/auth).
headersMap<String,String>Optional - The headers that should be sent with the POST request to the above endpoint. 2 Different Content-Types are supported: application/x-www-form-urlencoded & application/json. Supplying any of the above types will result into the request body being sent in form-urlencoded format or JSON format. Defaults to {'Content-Type': 'application/x-www-form-urlencoded'}

Development

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

Libraries

pusher