From a0ffcf82565df8358c8498dbf6da6889ef292b55 Mon Sep 17 00:00:00 2001 From: Devendra Date: Wed, 31 Dec 2014 00:21:27 +0530 Subject: updating docs --- docs/build/html/index.html | 210 ++++++++++++++++++++++++++------------------- 1 file changed, 120 insertions(+), 90 deletions(-) (limited to 'docs/build/html/index.html') diff --git a/docs/build/html/index.html b/docs/build/html/index.html index e183435..26bff5e 100644 --- a/docs/build/html/index.html +++ b/docs/build/html/index.html @@ -6,7 +6,7 @@ - Welcome to PubNub’s documentation! — PubNub 3.5.2 documentation + Welcome to PubNub’s documentation! — PubNub 3.5.3 documentation @@ -14,7 +14,7 @@ - +
@@ -35,7 +35,7 @@
  • modules |
    • -
  • PubNub 3.5.2 documentation »
    • +
  • PubNub 3.5.3 documentation »
    • @@ -54,10 +54,10 @@

    Pubnub

    -class Pubnub.Pubnub(publish_key, subscribe_key, secret_key=None, cipher_key=None, auth_key=None, ssl_on=False, origin='pubsub.pubnub.com', uuid=None, pooling=True, pres_uuid=None)
    +class Pubnub.Pubnub(publish_key, subscribe_key, secret_key=None, cipher_key=None, auth_key=None, ssl_on=False, origin='pubsub.pubnub.com', uuid=None, pooling=True, daemon=False, pres_uuid=None, azure=False)
    -audit(channel=None, auth_key=None, callback=None, error=None)
    +audit(channel=None, channel_group=None, auth_key=None, callback=None, error=None)

    Method for fetching permissions from pubnub servers.

    This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.

    @@ -67,7 +67,14 @@ for any combination of subscribe_key, channel and auth_key.

    channel: (string) (optional)
    Specifies channel name to return PAM attributes optionally in combination with auth_key. -If channel is not specified, results for all channels +If channel/channel_group is not specified, results for all channels +associated with subscribe_key are returned. +If auth_key is not specified, it is possible to return +results for a comma separated list of channels.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to return PAM +attributes optionally in combination with auth_key. +If channel/channel_group is not specified, results for all channels associated with subscribe_key are returned. If auth_key is not specified, it is possible to return results for a comma separated list of channels.
    @@ -151,7 +158,7 @@ provided at time of initializing pubnub object

    -grant(channel=None, auth_key=False, read=True, write=True, ttl=5, callback=None, error=None)
    +grant(channel=None, channel_group=None, auth_key=False, read=False, write=False, manage=False, ttl=5, callback=None, error=None)

    Method for granting permissions.

    This function establishes subscribe and/or write permissions for PubNub Access Manager (PAM) by setting the read or write attribute @@ -169,11 +176,18 @@ will revoke any previous grants with read or write set to true.

    channel: (string) (optional)
    Specifies channel name to grant permissions to. -If channel is not specified, the grant applies to all +If channel/channel_group is not specified, the grant applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to grant permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to grant permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to grant permissions to. It is possible to specify multiple auth_keys as comma @@ -187,6 +201,9 @@ Read permissions are removed by setting to False.
    write: (boolean) (default: True)
    Write permissions are granted by setting to true. Write permissions are removed by setting to false.
    +
    manage: (boolean) (default: True)
    +
    Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.
    ttl: (int) (default: 1440 i.e 24 hrs)
    Time in minutes for which granted permissions are valid. Max is 525600 , Min is 1. @@ -322,20 +339,19 @@ Required argument when working with twisted or tornado .
    presence(channel, callback, error=None)
    -

    Subscribe to presence data on a channel.

    +

    Subscribe to presence events on a channel.

    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.

    +

    channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.

    -
    If set, the api works in async mode. +
    If passed, the api works in async mode. Required argument when working with twisted or tornado .
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    +
    error: Optional variable. An error method can be passed as parameter.
    +
    If set, the api works in async mode.
    Returns:
    @@ -388,18 +404,25 @@ Async Mode : None

    -revoke(channel=None, auth_key=None, ttl=1, callback=None, error=None)
    +revoke(channel=None, channel_group=None, auth_key=None, ttl=1, callback=None, error=None)

    Method for revoking permissions.

    Args:
    channel: (string) (optional)
    Specifies channel name to revoke permissions to. -If channel is not specified, the revoke applies to all +If channel/channel_group is not specified, the revoke applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to revoke permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to revoke permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to revoke permissions to. It is possible to specify multiple auth_keys as comma @@ -506,23 +529,10 @@ Required argument when working with twisted or tornado .
    unsubscribe(channel)
    -
    Subscribe to presence data on a channel.
    +
    Unsubscribe from channel .
    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -message: Message to be published ( String / int / double / dict / list ). -callback: A callback method should be passed to the method.

    -
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    -
    Returns:
    -
    Returns a list in sync mode i.e. when callback argument is not given
    +
    channel: Channel name ( string ) on which to publish message
    @@ -536,7 +546,7 @@ Required argument when working with twisted or tornado .
    class Pubnub.PubnubTwisted(publish_key, subscribe_key, secret_key=None, cipher_key=None, auth_key=None, ssl_on=False, origin='pubsub.pubnub.com')
    -audit(channel=None, auth_key=None, callback=None, error=None)
    +audit(channel=None, channel_group=None, auth_key=None, callback=None, error=None)

    Method for fetching permissions from pubnub servers.

    This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.

    @@ -546,7 +556,14 @@ for any combination of subscribe_key, channel and auth_key.

    channel: (string) (optional)
    Specifies channel name to return PAM attributes optionally in combination with auth_key. -If channel is not specified, results for all channels +If channel/channel_group is not specified, results for all channels +associated with subscribe_key are returned. +If auth_key is not specified, it is possible to return +results for a comma separated list of channels.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to return PAM +attributes optionally in combination with auth_key. +If channel/channel_group is not specified, results for all channels associated with subscribe_key are returned. If auth_key is not specified, it is possible to return results for a comma separated list of channels.
    @@ -630,7 +647,7 @@ provided at time of initializing pubnub object

    -grant(channel=None, auth_key=False, read=True, write=True, ttl=5, callback=None, error=None)
    +grant(channel=None, channel_group=None, auth_key=False, read=False, write=False, manage=False, ttl=5, callback=None, error=None)

    Method for granting permissions.

    This function establishes subscribe and/or write permissions for PubNub Access Manager (PAM) by setting the read or write attribute @@ -648,11 +665,18 @@ will revoke any previous grants with read or write set to true.

    channel: (string) (optional)
    Specifies channel name to grant permissions to. -If channel is not specified, the grant applies to all +If channel/channel_group is not specified, the grant applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to grant permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to grant permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to grant permissions to. It is possible to specify multiple auth_keys as comma @@ -666,6 +690,9 @@ Read permissions are removed by setting to False.
    write: (boolean) (default: True)
    Write permissions are granted by setting to true. Write permissions are removed by setting to false.
    +
    manage: (boolean) (default: True)
    +
    Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.
    ttl: (int) (default: 1440 i.e 24 hrs)
    Time in minutes for which granted permissions are valid. Max is 525600 , Min is 1. @@ -801,20 +828,19 @@ Required argument when working with twisted or tornado .
    presence(channel, callback, error=None)
    -

    Subscribe to presence data on a channel.

    +

    Subscribe to presence events on a channel.

    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.

    +

    channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.

    -
    If set, the api works in async mode. +
    If passed, the api works in async mode. Required argument when working with twisted or tornado .
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    +
    error: Optional variable. An error method can be passed as parameter.
    +
    If set, the api works in async mode.
    Returns:
    @@ -867,18 +893,25 @@ Async Mode : None

    -revoke(channel=None, auth_key=None, ttl=1, callback=None, error=None)
    +revoke(channel=None, channel_group=None, auth_key=None, ttl=1, callback=None, error=None)

    Method for revoking permissions.

    Args:
    channel: (string) (optional)
    Specifies channel name to revoke permissions to. -If channel is not specified, the revoke applies to all +If channel/channel_group is not specified, the revoke applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to revoke permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to revoke permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to revoke permissions to. It is possible to specify multiple auth_keys as comma @@ -985,23 +1018,10 @@ Required argument when working with twisted or tornado .
    unsubscribe(channel)
    -
    Subscribe to presence data on a channel.
    +
    Unsubscribe from channel .
    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -message: Message to be published ( String / int / double / dict / list ). -callback: A callback method should be passed to the method.

    -
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    -
    Returns:
    -
    Returns a list in sync mode i.e. when callback argument is not given
    +
    channel: Channel name ( string ) on which to publish message
    @@ -1015,7 +1035,7 @@ Required argument when working with twisted or tornado .
    class Pubnub.PubnubTornado(publish_key, subscribe_key, secret_key=False, cipher_key=False, auth_key=False, ssl_on=False, origin='pubsub.pubnub.com')
    -audit(channel=None, auth_key=None, callback=None, error=None)
    +audit(channel=None, channel_group=None, auth_key=None, callback=None, error=None)

    Method for fetching permissions from pubnub servers.

    This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.

    @@ -1025,7 +1045,14 @@ for any combination of subscribe_key, channel and auth_key.

    channel: (string) (optional)
    Specifies channel name to return PAM attributes optionally in combination with auth_key. -If channel is not specified, results for all channels +If channel/channel_group is not specified, results for all channels +associated with subscribe_key are returned. +If auth_key is not specified, it is possible to return +results for a comma separated list of channels.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to return PAM +attributes optionally in combination with auth_key. +If channel/channel_group is not specified, results for all channels associated with subscribe_key are returned. If auth_key is not specified, it is possible to return results for a comma separated list of channels.
    @@ -1109,7 +1136,7 @@ provided at time of initializing pubnub object

    -grant(channel=None, auth_key=False, read=True, write=True, ttl=5, callback=None, error=None)
    +grant(channel=None, channel_group=None, auth_key=False, read=False, write=False, manage=False, ttl=5, callback=None, error=None)

    Method for granting permissions.

    This function establishes subscribe and/or write permissions for PubNub Access Manager (PAM) by setting the read or write attribute @@ -1127,11 +1154,18 @@ will revoke any previous grants with read or write set to true.

    channel: (string) (optional)
    Specifies channel name to grant permissions to. -If channel is not specified, the grant applies to all +If channel/channel_group is not specified, the grant applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to grant permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to grant permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to grant permissions to. It is possible to specify multiple auth_keys as comma @@ -1145,6 +1179,9 @@ Read permissions are removed by setting to False.
    write: (boolean) (default: True)
    Write permissions are granted by setting to true. Write permissions are removed by setting to false.
    +
    manage: (boolean) (default: True)
    +
    Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.
    ttl: (int) (default: 1440 i.e 24 hrs)
    Time in minutes for which granted permissions are valid. Max is 525600 , Min is 1. @@ -1280,20 +1317,19 @@ Required argument when working with twisted or tornado .
    presence(channel, callback, error=None)
    -

    Subscribe to presence data on a channel.

    +

    Subscribe to presence events on a channel.

    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.

    +

    channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.

    -
    If set, the api works in async mode. +
    If passed, the api works in async mode. Required argument when working with twisted or tornado .
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    +
    error: Optional variable. An error method can be passed as parameter.
    +
    If set, the api works in async mode.
    Returns:
    @@ -1346,18 +1382,25 @@ Async Mode : None

    -revoke(channel=None, auth_key=None, ttl=1, callback=None, error=None)
    +revoke(channel=None, channel_group=None, auth_key=None, ttl=1, callback=None, error=None)

    Method for revoking permissions.

    Args:
    channel: (string) (optional)
    Specifies channel name to revoke permissions to. -If channel is not specified, the revoke applies to all +If channel/channel_group is not specified, the revoke applies to all channels associated with the subscribe_key. If auth_key is not specified, it is possible to grant permissions to multiple channels simultaneously by specifying the channels as a comma separated list.
    +
    channel_group: (string) (optional)
    +
    Specifies channel group name to revoke permissions to. +If channel/channel_group is not specified, the grant applies to all +channels associated with the subscribe_key. If auth_key +is not specified, it is possible to revoke permissions to +multiple channel groups simultaneously by specifying the channel groups +as a comma separated list.
    auth_key: (string) (optional)
    Specifies auth_key to revoke permissions to. It is possible to specify multiple auth_keys as comma @@ -1464,23 +1507,10 @@ Required argument when working with twisted or tornado .
    unsubscribe(channel)
    -
    Subscribe to presence data on a channel.
    +
    Unsubscribe from channel .
    Only works in async mode
    Args:
    -

    channel: Channel name ( string ) on which to publish message -message: Message to be published ( String / int / double / dict / list ). -callback: A callback method should be passed to the method.

    -
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    error: Optional variable. An error method can be passed to the method.
    -
    If set, the api works in async mode. -Required argument when working with twisted or tornado .
    -
    -
    -
    Returns:
    -
    Returns a list in sync mode i.e. when callback argument is not given
    +
    channel: Channel name ( string ) on which to publish message
    @@ -1544,7 +1574,7 @@ Required argument when working with twisted or tornado .
  • modules |
    • -
  • PubNub 3.5.2 documentation »
    • +
  • PubNub 3.5.3 documentation »
    • -- cgit v1.2.3