Tour API Demos Download Tests
Aperture version 1.0
Generated by: JsDoc Toolkit 2.4.0

Namespace aperture.pubsub

Aperture Publish / Subscribe (PubSub) API.

Namespace Summary
Constructor Attributes Constructor Name and Description
 

Method Summary

Namespace Detail

aperture.pubsub
Requires:
OpenAjax Hub

Method Detail

  • <static> aperture.pubsub.publish(topic, message)
    Publishes a message
    Parameters:
    {String} topic
    The named message topic
    message
    The payload of the message
  • <static> {String} aperture.pubsub.subscribe(topic, handler, context, subscriberData)
    Subscribes to a message topic
    Parameters:
    {String} topic
    The named message topic
    {Function} handler
    The message handler function.
    {Object} context Optional
    The optional context that will be the value of this when the handler is invoked.
    {*} subscriberData Optional
    The optional data to pass as an argument to the handler.
    Returns:
    {String} A subscription id to use for unsubscription.
  • <static> aperture.pubsub.unsubscribe(subscriptionId)
    Unsubscribes from a previous subscription.
    Parameters:
    {String} subscriptionId
    A subscription id returned by a call to subscribe.