diff options
| author | Devendra | 2014-12-31 00:21:27 +0530 |
|---|---|---|
| committer | Devendra | 2014-12-31 00:21:27 +0530 |
| commit | a0ffcf82565df8358c8498dbf6da6889ef292b55 (patch) | |
| tree | dbd6009753801df9cd05503072ae5eff11a09178 /docs | |
| parent | c5823985237dbe649236b962fce36023e534af00 (diff) | |
| download | pubnub-python-a0ffcf82565df8358c8498dbf6da6889ef292b55.tar.bz2 | |
updating docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build/doctrees/environment.pickle | bin | 10081 -> 10081 bytes | |||
| -rw-r--r-- | docs/build/doctrees/index.doctree | bin | 399147 -> 412563 bytes | |||
| -rw-r--r-- | docs/build/html/.buildinfo | 2 | ||||
| -rw-r--r-- | docs/build/html/genindex.html | 10 | ||||
| -rw-r--r-- | docs/build/html/index.html | 210 | ||||
| -rw-r--r-- | docs/build/html/objects.inv | bin | 411 -> 411 bytes | |||
| -rw-r--r-- | docs/build/html/py-modindex.html | 10 | ||||
| -rw-r--r-- | docs/build/html/search.html | 10 | ||||
| -rw-r--r-- | docs/build/html/searchindex.js | 2 |
9 files changed, 137 insertions, 107 deletions
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle Binary files differindex c12faad..eab7341 100644 --- a/docs/build/doctrees/environment.pickle +++ b/docs/build/doctrees/environment.pickle diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree Binary files differindex b081b22..2075527 100644 --- a/docs/build/doctrees/index.doctree +++ b/docs/build/doctrees/index.doctree diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo index c24b844..b4b3186 100644 --- a/docs/build/html/.buildinfo +++ b/docs/build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9bfef501afd0f10215c217de6f058e7b +config: f25f30516c827cc5c86d7dbb326ddd20 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html index 144f61e..80a0f59 100644 --- a/docs/build/html/genindex.html +++ b/docs/build/html/genindex.html @@ -7,7 +7,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Index — PubNub 3.5.2 documentation</title> + <title>Index — 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" /> @@ -15,7 +15,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 @@ -24,7 +24,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="index.html" /> + <link rel="top" title="PubNub 3.5.3 documentation" href="index.html" /> </head> <body> <div class="related"> @@ -36,7 +36,7 @@ <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> @@ -347,7 +347,7 @@ <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> <div class="footer"> 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"> diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv Binary files differindex 1da9ba1..a3f471d 100644 --- a/docs/build/html/objects.inv +++ b/docs/build/html/objects.inv diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html index 88fac11..9df1a1a 100644 --- a/docs/build/html/py-modindex.html +++ b/docs/build/html/py-modindex.html @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Python Module Index — PubNub 3.5.2 documentation</title> + <title>Python Module Index — 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="index.html" /> + <link rel="top" title="PubNub 3.5.3 documentation" href="index.html" /> <script type="text/javascript"> @@ -42,7 +42,7 @@ <li class="right" > <a href="#" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> @@ -101,7 +101,7 @@ <li class="right" > <a href="#" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/search.html b/docs/build/html/search.html index f437e13..49ee6c8 100644 --- a/docs/build/html/search.html +++ b/docs/build/html/search.html @@ -6,7 +6,7 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> - <title>Search — PubNub 3.5.2 documentation</title> + <title>Search — 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 @@ -24,7 +24,7 @@ <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/searchtools.js"></script> - <link rel="top" title="PubNub 3.5.2 documentation" href="index.html" /> + <link rel="top" title="PubNub 3.5.3 documentation" href="index.html" /> <script type="text/javascript"> jQuery(function() { Search.loadIndex("searchindex.js"); }); </script> @@ -43,7 +43,7 @@ <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> @@ -94,7 +94,7 @@ <li class="right" > <a href="py-modindex.html" title="Python Module Index" >modules</a> |</li> - <li><a href="index.html">PubNub 3.5.2 documentation</a> »</li> + <li><a href="index.html">PubNub 3.5.3 documentation</a> »</li> </ul> </div> <div class="footer"> diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js index 43d1c8d..4d83cb9 100644 --- a/docs/build/html/searchindex.js +++ b/docs/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({envversion:42,terms:{"23f34d3f4rq34r34rq23q":0,all:0,newest:0,my_rw_authkei:0,obtain:0,tcp:0,ssl_on:0,reconnect:0,ttl:0,follow:0,twist:0,simultan:0,callback:0,cipher:0,paramet:0,access:0,onli:0,locat:0,uuid:0,zone:0,how:0,here_now:0,readabl:0,publish_kei:0,send:0,should:0,pub2:0,valid:0,dict:0,appli:0,input:0,sent:0,pubsub:0,real:0,applic:0,digit:0,"return":0,string:0,thei:0,transpar:0,fals:0,ciphertext:0,auth:0,ssl:0,mechan:0,now:0,requir:0,my_channel:0,reveal:0,name:0,specif:0,level:0,revers:0,list:0,geograph:0,privileg:0,server:0,separ:0,provid:0,token:0,api:0,mode:0,contain:0,comma:0,servic:0,set:0,specifi:0,permiss:0,my_admin_authkei:0,multipl:0,sync:0,my_ro_authkei:0,sampl:0,result:0,pass:0,pres_uuid:0,successfulli:0,event:0,special:0,page:0,variabl:0,index:0,what:0,oldest:0,network:0,channel:0,subscribe_kei:0,"while":0,publish:0,cipher_kei:0,current:0,method:0,state:0,pool:0,enncrypt:0,"new":0,get:0,across:0,attribut:0,object:0,kei:0,gener:0,each:0,usag:0,here:0,plaintext:0,base:0,async:0,disconnect:0,my_authkei:0,secret_kei:0,valu:0,care:0,both:0,about:0,output:0,socket:0,success:0,through:0,manag:0,precis:0,"123123234t234f34fq3dq":0,auth_kei:0,my_subkei:0,com:0,first:0,origin:0,arg:0,simpli:0,directli:0,revok:0,slice:0,transit:0,number:0,unix:0,"boolean":0,uniqu:0,ensur:0,total:0,storag:0,your:0,cloud:0,min:0,given:0,from:0,associ:0,doubl:0,three:0,messag:0,avail:0,start:0,call:0,includ:0,subscrib:0,taken:0,unsubscrib:0,store:0,listen:0,"function":0,option:0,presenc:0,search:0,andarrai:0,ani:0,line:0,"true":0,must:0,count:0,replic:0,none:0,retriev:0,possibl:0,"default":0,remov:0,work:0,histor:0,histori:0,below:0,limit:0,can:0,behavior:0,error:0,minut:0,initi:0,fetch:0,connect:0,control:0,payload:0,exampl:0,creat:0,"int":0,dure:0,respons:0,decrypt:0,argument:0,pub3:0,"case":0,pub1:0,exist:0,pub5:0,pub4:0,need:0,w34tcw45t45tcw435tww3:0,"null":0,sever:0,occup:0,end:0,open:0,grant:0,receiv:0,format:0,when:0,write:0,also:0,epoch:0,playback:0,take:0,which:0,indefinit:0,you:0,unlimit:0,singl:0,begin:0,thi:0,tornado:0,max:0,previou:0,"143r34f34t34fq34q34q3":0,statu:0,abc:0,user:0,establish:0,eavesdropp:0,encrypt:0,data:0,"class":0,demonstr:0,audit:0,appropri:0,center:0,read:0,secur:0,quantiti:0,caus:0,inform:0,client:0,combin:0,potenti:0,time:0,pam:0,order:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["index"],titles:["Welcome to PubNub’s documentation!"],objects:{"":{Pubnub:[0,0,0,"-"]},"Pubnub.PubnubTornado":{audit:[0,1,1,""],revoke:[0,1,1,""],grant:[0,1,1,""],here_now:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],presence:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]},"Pubnub.PubnubTwisted":{audit:[0,1,1,""],revoke:[0,1,1,""],grant:[0,1,1,""],here_now:[0,1,1,""],presence:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]},Pubnub:{PubnubTornado:[0,2,1,""],Pubnub:[0,2,1,""],PubnubTwisted:[0,2,1,""]},"Pubnub.Pubnub":{audit:[0,1,1,""],revoke:[0,1,1,""],here_now:[0,1,1,""],grant:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],presence:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]}},titleterms:{welcom:0,pubnub:0,indic:0,pubnubtwist:0,tabl:0,pubnubtornado:0,document:0}})
\ No newline at end of file +Search.setIndex({envversion:42,terms:{"23f34d3f4rq34r34rq23q":0,all:0,newest:0,my_rw_authkei:0,obtain:0,tcp:0,ssl_on:0,reconnect:0,ttl:0,follow:0,twist:0,simultan:0,callback:0,cipher:0,paramet:0,access:0,onli:0,group:0,uuid:0,zone:0,how:0,here_now:0,readabl:0,publish_kei:0,send:0,should:0,pub2:0,valid:0,dict:0,appli:0,input:0,sent:0,pubsub:0,real:0,applic:0,digit:0,"return":0,string:0,thei:0,transpar:0,fals:0,none:0,auth:0,ssl:0,mechan:0,now:0,requir:0,my_channel:0,reveal:0,daemon:0,name:0,specif:0,level:0,channel_group:0,revers:0,list:0,geograph:0,privileg:0,server:0,separ:0,provid:0,token:0,api:0,mode:0,contain:0,comma:0,remov:0,set:0,specifi:0,permiss:0,my_admin_authkei:0,multipl:0,sync:0,my_ro_authkei:0,sampl:0,result:0,pass:0,pres_uuid:0,successfulli:0,event:0,special:0,page:0,variabl:0,index:0,what:0,oldest:0,network:0,channel:0,subscribe_kei:0,"while":0,publish:0,cipher_kei:0,current:0,method:0,state:0,pool:0,enncrypt:0,"new":0,get:0,across:0,attribut:0,object:0,kei:0,gener:0,each:0,usag:0,here:0,plaintext:0,base:0,async:0,locat:0,my_authkei:0,secret_kei:0,valu:0,care:0,both:0,about:0,output:0,socket:0,success:0,through:0,manag:0,precis:0,"123123234t234f34fq3dq":0,auth_kei:0,my_subkei:0,com:0,first:0,origin:0,arg:0,simpli:0,directli:0,revok:0,slice:0,transit:0,number:0,unix:0,"boolean":0,uniqu:0,ensur:0,total:0,storag:0,your:0,cloud:0,min:0,given:0,from:0,associ:0,doubl:0,three:0,messag:0,avail:0,start:0,call:0,includ:0,subscrib:0,taken:0,unsubscrib:0,store:0,listen:0,"function":0,option:0,presenc:0,search:0,andarrai:0,ani:0,line:0,"true":0,must:0,count:0,replic:0,ciphertext:0,retriev:0,possibl:0,"default":0,servic:0,work:0,histor:0,histori:0,below:0,limit:0,can:0,behavior:0,error:0,minut:0,initi:0,fetch:0,connect:0,control:0,payload:0,exampl:0,creat:0,"int":0,dure:0,respons:0,decrypt:0,argument:0,pub3:0,"case":0,pub1:0,exist:0,pub5:0,pub4:0,need:0,w34tcw45t45tcw435tww3:0,"null":0,sever:0,occup:0,end:0,open:0,grant:0,receiv:0,format:0,when:0,write:0,also:0,epoch:0,playback:0,take:0,which:0,indefinit:0,you:0,unlimit:0,singl:0,begin:0,thi:0,tornado:0,max:0,previou:0,"143r34f34t34fq34q34q3":0,statu:0,disconnect:0,abc:0,user:0,establish:0,eavesdropp:0,encrypt:0,data:0,"class":0,demonstr:0,audit:0,appropri:0,center:0,read:0,secur:0,quantiti:0,caus:0,inform:0,client:0,combin:0,potenti:0,time:0,pam:0,azur:0,order:0},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","class","Python class"]},filenames:["index"],titles:["Welcome to PubNub’s documentation!"],objects:{"":{Pubnub:[0,0,0,"-"]},"Pubnub.PubnubTornado":{audit:[0,1,1,""],revoke:[0,1,1,""],grant:[0,1,1,""],here_now:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],presence:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]},"Pubnub.PubnubTwisted":{audit:[0,1,1,""],revoke:[0,1,1,""],grant:[0,1,1,""],here_now:[0,1,1,""],presence:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]},Pubnub:{PubnubTornado:[0,2,1,""],Pubnub:[0,2,1,""],PubnubTwisted:[0,2,1,""]},"Pubnub.Pubnub":{audit:[0,1,1,""],revoke:[0,1,1,""],here_now:[0,1,1,""],grant:[0,1,1,""],decrypt:[0,1,1,""],publish:[0,1,1,""],presence:[0,1,1,""],subscribe:[0,1,1,""],unsubscribe:[0,1,1,""],time:[0,1,1,""],encrypt:[0,1,1,""],history:[0,1,1,""]}},titleterms:{welcom:0,pubnub:0,indic:0,pubnubtwist:0,tabl:0,pubnubtornado:0,document:0}})
\ No newline at end of file |