diff options
Diffstat (limited to 'docs/build/html/index.html')
| -rw-r--r-- | docs/build/html/index.html | 210 |
1 files changed, 120 insertions, 90 deletions
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 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Welcome to PubNub’s documentation! — PubNub 3.5.2 documentation</title> + <title>Welcome to PubNub’s documentation! — PubNub 3.5.3 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> @@ -14,7 +14,7 @@ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: './', - VERSION: '3.5.2', + VERSION: '3.5.3', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true @@ -23,7 +23,7 @@ <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> - <link rel="top" title="PubNub 3.5.2 documentation" href="#" /> + <link rel="top" title="PubNub 3.5.3 documentation" href="#" /> </head> <body> <div class="related"> @@ -35,7 +35,7 @@ <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="#">PubNub 3.5.2 documentation</a> »</li> + <li><a href="#">PubNub 3.5.3 documentation</a> »</li> </ul> </div> @@ -54,10 +54,10 @@ <h2>Pubnub<a class="headerlink" href="#pubnub" title="Permalink to this headline">¶</a></h2> <dl class="class"> <dt id="Pubnub.Pubnub"> -<em class="property">class </em><tt class="descclassname">Pubnub.</tt><tt class="descname">Pubnub</tt><big>(</big><em>publish_key</em>, <em>subscribe_key</em>, <em>secret_key=None</em>, <em>cipher_key=None</em>, <em>auth_key=None</em>, <em>ssl_on=False</em>, <em>origin='pubsub.pubnub.com'</em>, <em>uuid=None</em>, <em>pooling=True</em>, <em>pres_uuid=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub" title="Permalink to this definition">¶</a></dt> +<em class="property">class </em><tt class="descclassname">Pubnub.</tt><tt class="descname">Pubnub</tt><big>(</big><em>publish_key</em>, <em>subscribe_key</em>, <em>secret_key=None</em>, <em>cipher_key=None</em>, <em>auth_key=None</em>, <em>ssl_on=False</em>, <em>origin='pubsub.pubnub.com'</em>, <em>uuid=None</em>, <em>pooling=True</em>, <em>daemon=False</em>, <em>pres_uuid=None</em>, <em>azure=False</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="Pubnub.Pubnub.audit"> -<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.audit" title="Permalink to this definition">¶</a></dt> +<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.audit" title="Permalink to this definition">¶</a></dt> <dd><p>Method for fetching permissions from pubnub servers.</p> <p>This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.</p> @@ -67,7 +67,14 @@ for any combination of subscribe_key, channel and auth_key.</p> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> @@ -151,7 +158,7 @@ provided at time of initializing pubnub object</p> <dl class="method"> <dt id="Pubnub.Pubnub.grant"> -<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>auth_key=False</em>, <em>read=True</em>, <em>write=True</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.grant" title="Permalink to this definition">¶</a></dt> +<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=False</em>, <em>read=False</em>, <em>write=False</em>, <em>manage=False</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.grant" title="Permalink to this definition">¶</a></dt> <dd><p>Method for granting permissions.</p> <p>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.</p> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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.</dd> <dt>write: (boolean) (default: True)</dt> <dd>Write permissions are granted by setting to true. Write permissions are removed by setting to false.</dd> +<dt>manage: (boolean) (default: True)</dt> +<dd>Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.</dd> <dt>ttl: (int) (default: 1440 i.e 24 hrs)</dt> <dd>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 .</dd> <dl class="method"> <dt id="Pubnub.Pubnub.presence"> <tt class="descname">presence</tt><big>(</big><em>channel</em>, <em>callback</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.presence" title="Permalink to this definition">¶</a></dt> -<dd><p>Subscribe to presence data on a channel.</p> +<dd><p>Subscribe to presence events on a channel.</p> <blockquote> <div>Only works in async mode</div></blockquote> <dl class="docutils"> <dt>Args:</dt> -<dd><p class="first">channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.</p> +<dd><p class="first">channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.</p> <blockquote> -<div>If set, the api works in async mode. +<div>If passed, the api works in async mode. Required argument when working with twisted or tornado .</div></blockquote> <dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> +<dt>error: Optional variable. An error method can be passed as parameter.</dt> +<dd>If set, the api works in async mode.</dd> </dl> </dd> <dt>Returns:</dt> @@ -388,18 +404,25 @@ Async Mode : None</p> <dl class="method"> <dt id="Pubnub.Pubnub.revoke"> -<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.revoke" title="Permalink to this definition">¶</a></dt> +<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.revoke" title="Permalink to this definition">¶</a></dt> <dd><p>Method for revoking permissions.</p> <dl class="docutils"> <dt>Args:</dt> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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 .</dd> <dt id="Pubnub.Pubnub.unsubscribe"> <tt class="descname">unsubscribe</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#Pubnub.Pubnub.unsubscribe" title="Permalink to this definition">¶</a></dt> <dd><dl class="docutils"> -<dt>Subscribe to presence data on a channel.</dt> +<dt>Unsubscribe from channel .</dt> <dd>Only works in async mode</dd> <dt>Args:</dt> -<dd><p class="first">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.</p> -<blockquote> -<div>If set, the api works in async mode. -Required argument when working with twisted or tornado .</div></blockquote> -<dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> -</dl> -</dd> -<dt>Returns:</dt> -<dd>Returns a list in sync mode i.e. when callback argument is not given</dd> +<dd>channel: Channel name ( string ) on which to publish message</dd> </dl> </dd></dl> @@ -536,7 +546,7 @@ Required argument when working with twisted or tornado .</dd> <em class="property">class </em><tt class="descclassname">Pubnub.</tt><tt class="descname">PubnubTwisted</tt><big>(</big><em>publish_key</em>, <em>subscribe_key</em>, <em>secret_key=None</em>, <em>cipher_key=None</em>, <em>auth_key=None</em>, <em>ssl_on=False</em>, <em>origin='pubsub.pubnub.com'</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="Pubnub.PubnubTwisted.audit"> -<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.audit" title="Permalink to this definition">¶</a></dt> +<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.audit" title="Permalink to this definition">¶</a></dt> <dd><p>Method for fetching permissions from pubnub servers.</p> <p>This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.</p> @@ -546,7 +556,14 @@ for any combination of subscribe_key, channel and auth_key.</p> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> @@ -630,7 +647,7 @@ provided at time of initializing pubnub object</p> <dl class="method"> <dt id="Pubnub.PubnubTwisted.grant"> -<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>auth_key=False</em>, <em>read=True</em>, <em>write=True</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.grant" title="Permalink to this definition">¶</a></dt> +<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=False</em>, <em>read=False</em>, <em>write=False</em>, <em>manage=False</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.grant" title="Permalink to this definition">¶</a></dt> <dd><p>Method for granting permissions.</p> <p>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.</p> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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.</dd> <dt>write: (boolean) (default: True)</dt> <dd>Write permissions are granted by setting to true. Write permissions are removed by setting to false.</dd> +<dt>manage: (boolean) (default: True)</dt> +<dd>Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.</dd> <dt>ttl: (int) (default: 1440 i.e 24 hrs)</dt> <dd>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 .</dd> <dl class="method"> <dt id="Pubnub.PubnubTwisted.presence"> <tt class="descname">presence</tt><big>(</big><em>channel</em>, <em>callback</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.presence" title="Permalink to this definition">¶</a></dt> -<dd><p>Subscribe to presence data on a channel.</p> +<dd><p>Subscribe to presence events on a channel.</p> <blockquote> <div>Only works in async mode</div></blockquote> <dl class="docutils"> <dt>Args:</dt> -<dd><p class="first">channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.</p> +<dd><p class="first">channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.</p> <blockquote> -<div>If set, the api works in async mode. +<div>If passed, the api works in async mode. Required argument when working with twisted or tornado .</div></blockquote> <dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> +<dt>error: Optional variable. An error method can be passed as parameter.</dt> +<dd>If set, the api works in async mode.</dd> </dl> </dd> <dt>Returns:</dt> @@ -867,18 +893,25 @@ Async Mode : None</p> <dl class="method"> <dt id="Pubnub.PubnubTwisted.revoke"> -<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.revoke" title="Permalink to this definition">¶</a></dt> +<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.revoke" title="Permalink to this definition">¶</a></dt> <dd><p>Method for revoking permissions.</p> <dl class="docutils"> <dt>Args:</dt> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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 .</dd> <dt id="Pubnub.PubnubTwisted.unsubscribe"> <tt class="descname">unsubscribe</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTwisted.unsubscribe" title="Permalink to this definition">¶</a></dt> <dd><dl class="docutils"> -<dt>Subscribe to presence data on a channel.</dt> +<dt>Unsubscribe from channel .</dt> <dd>Only works in async mode</dd> <dt>Args:</dt> -<dd><p class="first">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.</p> -<blockquote> -<div>If set, the api works in async mode. -Required argument when working with twisted or tornado .</div></blockquote> -<dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> -</dl> -</dd> -<dt>Returns:</dt> -<dd>Returns a list in sync mode i.e. when callback argument is not given</dd> +<dd>channel: Channel name ( string ) on which to publish message</dd> </dl> </dd></dl> @@ -1015,7 +1035,7 @@ Required argument when working with twisted or tornado .</dd> <em class="property">class </em><tt class="descclassname">Pubnub.</tt><tt class="descname">PubnubTornado</tt><big>(</big><em>publish_key</em>, <em>subscribe_key</em>, <em>secret_key=False</em>, <em>cipher_key=False</em>, <em>auth_key=False</em>, <em>ssl_on=False</em>, <em>origin='pubsub.pubnub.com'</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado" title="Permalink to this definition">¶</a></dt> <dd><dl class="method"> <dt id="Pubnub.PubnubTornado.audit"> -<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.audit" title="Permalink to this definition">¶</a></dt> +<tt class="descname">audit</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.audit" title="Permalink to this definition">¶</a></dt> <dd><p>Method for fetching permissions from pubnub servers.</p> <p>This method provides a mechanism to reveal existing PubNub Access Manager attributes for any combination of subscribe_key, channel and auth_key.</p> @@ -1025,7 +1045,14 @@ for any combination of subscribe_key, channel and auth_key.</p> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> @@ -1109,7 +1136,7 @@ provided at time of initializing pubnub object</p> <dl class="method"> <dt id="Pubnub.PubnubTornado.grant"> -<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>auth_key=False</em>, <em>read=True</em>, <em>write=True</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.grant" title="Permalink to this definition">¶</a></dt> +<tt class="descname">grant</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=False</em>, <em>read=False</em>, <em>write=False</em>, <em>manage=False</em>, <em>ttl=5</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.grant" title="Permalink to this definition">¶</a></dt> <dd><p>Method for granting permissions.</p> <p>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.</p> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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.</dd> <dt>write: (boolean) (default: True)</dt> <dd>Write permissions are granted by setting to true. Write permissions are removed by setting to false.</dd> +<dt>manage: (boolean) (default: True)</dt> +<dd>Manage permissions are granted by setting to true. +Manage permissions are removed by setting to false.</dd> <dt>ttl: (int) (default: 1440 i.e 24 hrs)</dt> <dd>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 .</dd> <dl class="method"> <dt id="Pubnub.PubnubTornado.presence"> <tt class="descname">presence</tt><big>(</big><em>channel</em>, <em>callback</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.presence" title="Permalink to this definition">¶</a></dt> -<dd><p>Subscribe to presence data on a channel.</p> +<dd><p>Subscribe to presence events on a channel.</p> <blockquote> <div>Only works in async mode</div></blockquote> <dl class="docutils"> <dt>Args:</dt> -<dd><p class="first">channel: Channel name ( string ) on which to publish message -callback: A callback method should be passed to the method.</p> +<dd><p class="first">channel: Channel name ( string ) on which to listen for events +callback: A callback method should be passed as parameter.</p> <blockquote> -<div>If set, the api works in async mode. +<div>If passed, the api works in async mode. Required argument when working with twisted or tornado .</div></blockquote> <dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> +<dt>error: Optional variable. An error method can be passed as parameter.</dt> +<dd>If set, the api works in async mode.</dd> </dl> </dd> <dt>Returns:</dt> @@ -1346,18 +1382,25 @@ Async Mode : None</p> <dl class="method"> <dt id="Pubnub.PubnubTornado.revoke"> -<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.revoke" title="Permalink to this definition">¶</a></dt> +<tt class="descname">revoke</tt><big>(</big><em>channel=None</em>, <em>channel_group=None</em>, <em>auth_key=None</em>, <em>ttl=1</em>, <em>callback=None</em>, <em>error=None</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.revoke" title="Permalink to this definition">¶</a></dt> <dd><p>Method for revoking permissions.</p> <dl class="docutils"> <dt>Args:</dt> <dd><dl class="first last docutils"> <dt>channel: (string) (optional)</dt> <dd>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.</dd> +<dt>channel_group: (string) (optional)</dt> +<dd>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.</dd> <dt>auth_key: (string) (optional) </dt> <dd>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 .</dd> <dt id="Pubnub.PubnubTornado.unsubscribe"> <tt class="descname">unsubscribe</tt><big>(</big><em>channel</em><big>)</big><a class="headerlink" href="#Pubnub.PubnubTornado.unsubscribe" title="Permalink to this definition">¶</a></dt> <dd><dl class="docutils"> -<dt>Subscribe to presence data on a channel.</dt> +<dt>Unsubscribe from channel .</dt> <dd>Only works in async mode</dd> <dt>Args:</dt> -<dd><p class="first">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.</p> -<blockquote> -<div>If set, the api works in async mode. -Required argument when working with twisted or tornado .</div></blockquote> -<dl class="last docutils"> -<dt>error: Optional variable. An error method can be passed to the method.</dt> -<dd>If set, the api works in async mode. -Required argument when working with twisted or tornado .</dd> -</dl> -</dd> -<dt>Returns:</dt> -<dd>Returns a list in sync mode i.e. when callback argument is not given</dd> +<dd>channel: Channel name ( string ) on which to publish message</dd> </dl> </dd></dl> @@ -1544,7 +1574,7 @@ Required argument when working with twisted or tornado .</dd> <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="#">PubNub 3.5.2 documentation</a> »</li> + <li><a href="#">PubNub 3.5.3 documentation</a> »</li> </ul> </div> <div class="footer"> |