Adapter: SimplePush

Methods

connect(options)

Connect the client to the messaging service

Parameters:

Name	Type	Argument	Description
options	Object	<optional>	Options to pass to the connect method Properties Name Type Argument Description url String <optional> The URL for the messaging service. This url will override and reset any connectURL specified when the client was created. protocols_whitelist Array <optional> A list protocols that may be used by SockJS. By default all available protocols will be used, which is equivalent to supplying: "['websocket', 'xdr-streaming', 'xhr-streaming', 'iframe-eventsource', 'iframe-htmlfile', 'xdr-polling', 'xhr-polling', 'iframe-xhr-polling', 'jsonp-polling']" onConnect Function <optional> callback to be executed when a connection is established and hello message has been acknowledged onConnectError Function <optional> callback to be executed when connecting to a service is unsuccessful onClose Function <optional> callback to be executed when a connection to the server is closed

Source:

• notifier/adapters/simplePush.js, line 287

Example

    var SPNotifier = AeroGear.Notifier({
        name: "sp",
        type: "SimplePush",
        settings: {
            connectURL: "http://localhost:7777/simplepush"
        }
    }).clients.sp;

    // Use all defaults
    SPNotifier.connect();

    // Custom options
    SPNotifier.connect({
        simplePushServerURL: "http://some.other.domain",
        onConnect: spConnect,
        onClose: spClose
    });

disconnect(onDisconnect)

Disconnect the client from the messaging service

Parameters:

Name	Type	Argument	Description
onDisconnect	Function	<optional>	callback to be executed when a connection is terminated

Source:

• notifier/adapters/simplePush.js, line 351

Example

    var SPNotifier = AeroGear.Notifier({
        name: "sp",
        type: "SimplePush",
        settings: {
            connectURL: "http://localhost:7777/simplepush"
        }
    }).clients.sp;

    // Default
    SPNotifier.disconnect();

    // Pass disconnect callback
    SPNotifier.disconnect(function() {
        console.log("Disconnected");
    });

subscribe(channels, reset)

Subscribe this client to a new channel

Parameters:

Name	Type	Argument	Description
channels	Object | Array		a channel object or array of channel objects to which this client can subscribe. At a minimum, each channel should contain a requestObject which will eventually contain the subscription success callback. Reused channels may also contain channelID and other metadata.
reset	Boolean	<optional>	if true, remove all channels from the set and replace with the supplied channel(s)

Source:

• notifier/adapters/simplePush.js, line 380

Example

    var SPNotifier = AeroGear.Notifier({
        name: "sp",
        type: "SimplePush",
        settings: {
            connectURL: "http://localhost:7777/simplepush"
        }
    }).clients.sp;

    SPNotifier.subscribe({
        requestObject: {},
        callback: function( message ) {
            console.log("Notification Received");
        }
    });

unsubscribe(channels)

Unsubscribe this client from a channel

Parameters:

Name	Type	Description
channels	Object | Array	a channel object or a set of channel objects to which this client nolonger wishes to subscribe

Source:

• notifier/adapters/simplePush.js, line 450

Example

    var SPNotifier = AeroGear.Notifier({
        name: "sp",
        type: "SimplePush",
        settings: {
            connectURL: "http://localhost:7777/simplepush"
        }
    }).clients.sp;

    SPNotifier.unsubscribe( channelObject );