| t |
","
"]),v.fn.extend({text:function(e){return v.access(this,function(e){return e===t?v.text(this):this.empty().append((this[0]&&this[0].ownerDocument||i).createTextNode(e))},null,e,arguments.length)},wrapAll:function(e){if(v.isFunction(e))return this.each(function(t){v(this).wrapAll(e.call(this,t))});if(this[0]){var t=v(e,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstChild&&e.firstChild.nodeType===1)e=e.firstChild;return e}).append(this)}return this},wrapInner:function(e){return v.isFunction(e)?this.each(function(t){v(this).wrapInner(e.call(this,t))}):this.each(function(){var t=v(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=v.isFunction(e);return this.each(function(n){v(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){v.nodeName(this,"body")||v(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.appendChild(e)})},prepend:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.insertBefore(e,this.firstChild)})},before:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(e,this),"before",this.selector)}},after:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this.nextSibling)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(this,e),"after",this.selector)}},remove:function(e,t){var n,r=0;for(;(n=this[r])!=null;r++)if(!e||v.filter(e,[n]).length)!t&&n.nodeType===1&&(v.cleanData(n.getElementsByTagName("*")),v.cleanData([n])),n.parentNode&&n.parentNode.removeChild(n);return this},empty:function(){var e,t=0;for(;(e=this[t])!=null;t++){e.nodeType===1&&v.cleanData(e.getElementsByTagName("*"));while(e.firstChild)e.removeChild(e.firstChild)}return this},clone:function(e,t){return e=e==null?!1:e,t=t==null?e:t,this.map(function(){return v.clone(this,e,t)})},html:function(e){return v.access(this,function(e){var n=this[0]||{},r=0,i=this.length;if(e===t)return n.nodeType===1?n.innerHTML.replace(ht,""):t;if(typeof e=="string"&&!yt.test(e)&&(v.support.htmlSerialize||!wt.test(e))&&(v.support.leadingWhitespace||!pt.test(e))&&!Nt[(vt.exec(e)||["",""])[1].toLowerCase()]){e=e.replace(dt,"<$1>");try{for(;r
|
+
D
+
|
+
E
+
|
+
G
+
|
+
H
+
|
+
|
+
P
+
|
+
|
+
R
+
|
+
S
+
|
+
T
+
|
+
U
+
|
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/objects.inv b/docs/build/html/objects.inv
new file mode 100644
index 0000000..1da9ba1
Binary files /dev/null and b/docs/build/html/objects.inv differ
diff --git a/docs/build/html/py-modindex.html b/docs/build/html/py-modindex.html
new file mode 100644
index 0000000..88fac11
--- /dev/null
+++ b/docs/build/html/py-modindex.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Welcome to PubNub’s documentation!¶
+
+
+-
+
+
+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)¶ +
-
+
- +audit(channel=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.
+-
+
- Args: +
-
+
- 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 +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. +
- auth_key: (string) (optional) +
- Specifies the auth_key to return PAM attributes for. +If only a single channel is specified, it is possible to return +results for a comma separated list of auth_keys. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response +{
++
+“message”:”Success”, +“payload”:{
++
+-
+
- “channels”:{ +
-
+
- “my_channel”:{ +
- “auths”:{“my_ro_authkey”:{“r”:1,”w”:0}, +“my_rw_authkey”:{“r”:0,”w”:1}, +“my_admin_authkey”:{“r”:1,”w”:1} +
}
+
+
}
+},
+}
+
+
Usage:
++
+pubnub.audit (‘my_channel’); # Sync Mode
-
+
- +decrypt(message)¶ +
Method for decrypting data.
+This method takes ciphertext as input and returns decrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be decrypted. +
- Returns: +
- Returns decrypted message if cipher key is set +
-
+
- +encrypt(message)¶ +
Method for encrypting data.
+This method takes plaintext as input and returns encrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be encrypted. +
- Returns: +
- Returns encrypted message if cipher key is set +
-
+
- +grant(channel=None, auth_key=False, read=True, write=True, 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 +to true. A grant with read or write set to false (or not included) +will revoke any previous grants with read or write set to true.
+-
+
- Permissions can be applied to any one of three levels: +
-
+
- Application level privileges are based on subscribe_key applying to all associated channels. +
- Channel level privileges are based on a combination of subscribe_key and channel name. +
- User level privileges are based on the combination of subscribe_key, channel and auth_key. +
+- Args: +
-
+
- channel: (string) (optional) +
- Specifies channel name to grant permissions to. +If channel 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. +
- auth_key: (string) (optional) +
- Specifies auth_key to grant permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- read: (boolean) (default: True) +
- Read permissions are granted by setting to True. +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. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_ro_authkey”:{“r”:1,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +here_now(channel, callback=None, error=None)¶ +
Get here now data.
+You can obtain information about the current state of a channel including +a list of unique user-ids currently subscribed to the channel and the total +occupancy count of the channel by calling the here_now() function in your +application.
+-
+
- Args: +
-
+
- channel: (string) (optional) +
- Specifies the channel name to return occupancy results. +If channel is not provided, here_now will return data for all channels. +
- callback: (optional) +
- 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) +
- 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: +
Sync Mode: list +Async Mode: None
+Response Format:
+The here_now() method returns a list of uuid s currently subscribed to the channel.
+uuids:[“String”,”String”, ... ,”String”] - List of UUIDs currently subscribed to the channel.
+occupancy: Number - Total current occupancy of the channel.
+Example Response: +{
++
+occupancy: 4, +uuids: [
++
+‘123123234t234f34fq3dq’, +‘143r34f34t34fq34q34q3’, +‘23f34d3f4rq34r34rq23q’, +‘w34tcw45t45tcw435tww3’,]
+}
+
+
-
+
- +history(channel, count=100, reverse=False, start=None, end=None, callback=None, error=None)¶ +
This method fetches historical messages of a channel.
+PubNub Storage/Playback Service provides real-time access to an unlimited +history for all messages published to PubNub. Stored messages are replicated +across multiple availability zones in several geographical data center +locations. Stored messages can be encrypted with AES-256 message encryption +ensuring that they are not readable while stored on PubNub’s network.
+It is possible to control how messages are returned and in what order, +for example you can:
++
+Return messages in the order newest to oldest (default behavior).
+Return messages in the order oldest to newest by setting reverse to true.
+Page through results by providing a start or end time token.
+Retrieve a “slice” of the time line by providing both a start and end time token.
+Limit the number of messages to a specific quantity using the count parameter.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel to return history messages from +
- count: (int) (default: 100) +
- Specifies the number of historical messages to return +
- callback: (optional) +
- 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) +
- 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
+-
+
- Sample Response: +
- [[“Pub1”,”Pub2”,”Pub3”,”Pub4”,”Pub5”],13406746729185766,13406746845892666] +
+
-
+
- +presence(channel, callback, error=None)¶ +
Subscribe to presence data 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.
++
+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: +
- None +
-
+
- +publish(channel, message, callback=None, error=None)¶ +
Publishes data on a channel.
+The publish() method is used to send a message to all subscribers of a channel. +To publish a message you must first specify a valid publish_key at initialization. +A successfully published message is replicated across the PubNub Real-Time Network +and sent simultaneously to all subscribed clients on a channel.
++
+Messages in transit can be secured from potential eavesdroppers with SSL/TLS bysetting ssl to True during initialization.
+Published messages can also be encrypted with AES-256 simply by specifying a cipher_key +during initialization.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel name to publish messages to. +
- message: (string/int/double/dict/list) +
- Message to be published +
- callback: (optional) +
- A callback 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) +
- 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: +
Sync Mode : list +Async Mode : None
+The function returns the following formatted response:
++
+[ Number, “Status”, “Time Token”]The output below demonstrates the response to a successful call:
++
+[1,”Sent”,”13769558699541401”]
+
-
+
- +revoke(channel=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 +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. +
- auth_key: (string) (optional) +
- Specifies auth_key to revoke permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_authkey”:{“r”:0,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +subscribe(channels, callback, error=None, connect=None, disconnect=None, reconnect=None, sync=False)¶ +
Subscribe to data on a channel.
+This function causes the client to create an open TCP socket to the +PubNub Real-Time Network and begin listening for messages on a specified channel. +To subscribe to a channel the client must send the appropriate subscribe_key at +initialization.
+Only works in async mode
+-
+
- Args: +
-
+
- channel: (string/list) +
- Specifies the channel to subscribe to. It is possible to specify +multiple channels as a comma separated list or andarray. +
- callback: (function) +
- This callback is called on receiving a message from the channel. +
- error: (function) (optional) +
- This callback is called on an error event +
- connect: (function) (optional) +
- This callback is called on a successful connection to the PubNub cloud +
- disconnect: (function) (optional) +
- This callback is called on client disconnect from the PubNub cloud +
- reconnect: (function) (optional) +
- This callback is called on successfully re-connecting to the PubNub cloud +
+- Returns: +
- None +
-
+
- +time(callback=None)¶ +
This function will return a 17 digit precision Unix epoch.
+Args:
++
+-
+
- callback: (optional) +
- 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 . +
-
+
- Returns: +
Returns a 17 digit number in sync mode i.e. when callback argument is not given
+-
+
- Sample: +
- 13769501243685161 +
+
-
+
- +unsubscribe(channel)¶ +
-
+
- Subscribe to presence data on a 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 +
+
+PubnubTwisted¶
+-
+
- +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)¶ +
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.
+-
+
- Args: +
-
+
- 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 +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. +
- auth_key: (string) (optional) +
- Specifies the auth_key to return PAM attributes for. +If only a single channel is specified, it is possible to return +results for a comma separated list of auth_keys. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response +{
++
+“message”:”Success”, +“payload”:{
++
+-
+
- “channels”:{ +
-
+
- “my_channel”:{ +
- “auths”:{“my_ro_authkey”:{“r”:1,”w”:0}, +“my_rw_authkey”:{“r”:0,”w”:1}, +“my_admin_authkey”:{“r”:1,”w”:1} +
}
+
+
}
+},
+}
+
+
Usage:
++
+pubnub.audit (‘my_channel’); # Sync Mode
-
+
- +decrypt(message)¶ +
Method for decrypting data.
+This method takes ciphertext as input and returns decrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be decrypted. +
- Returns: +
- Returns decrypted message if cipher key is set +
-
+
- +encrypt(message)¶ +
Method for encrypting data.
+This method takes plaintext as input and returns encrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be encrypted. +
- Returns: +
- Returns encrypted message if cipher key is set +
-
+
- +grant(channel=None, auth_key=False, read=True, write=True, 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 +to true. A grant with read or write set to false (or not included) +will revoke any previous grants with read or write set to true.
+-
+
- Permissions can be applied to any one of three levels: +
-
+
- Application level privileges are based on subscribe_key applying to all associated channels. +
- Channel level privileges are based on a combination of subscribe_key and channel name. +
- User level privileges are based on the combination of subscribe_key, channel and auth_key. +
+- Args: +
-
+
- channel: (string) (optional) +
- Specifies channel name to grant permissions to. +If channel 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. +
- auth_key: (string) (optional) +
- Specifies auth_key to grant permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- read: (boolean) (default: True) +
- Read permissions are granted by setting to True. +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. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_ro_authkey”:{“r”:1,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +here_now(channel, callback=None, error=None)¶ +
Get here now data.
+You can obtain information about the current state of a channel including +a list of unique user-ids currently subscribed to the channel and the total +occupancy count of the channel by calling the here_now() function in your +application.
+-
+
- Args: +
-
+
- channel: (string) (optional) +
- Specifies the channel name to return occupancy results. +If channel is not provided, here_now will return data for all channels. +
- callback: (optional) +
- 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) +
- 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: +
Sync Mode: list +Async Mode: None
+Response Format:
+The here_now() method returns a list of uuid s currently subscribed to the channel.
+uuids:[“String”,”String”, ... ,”String”] - List of UUIDs currently subscribed to the channel.
+occupancy: Number - Total current occupancy of the channel.
+Example Response: +{
++
+occupancy: 4, +uuids: [
++
+‘123123234t234f34fq3dq’, +‘143r34f34t34fq34q34q3’, +‘23f34d3f4rq34r34rq23q’, +‘w34tcw45t45tcw435tww3’,]
+}
+
+
-
+
- +history(channel, count=100, reverse=False, start=None, end=None, callback=None, error=None)¶ +
This method fetches historical messages of a channel.
+PubNub Storage/Playback Service provides real-time access to an unlimited +history for all messages published to PubNub. Stored messages are replicated +across multiple availability zones in several geographical data center +locations. Stored messages can be encrypted with AES-256 message encryption +ensuring that they are not readable while stored on PubNub’s network.
+It is possible to control how messages are returned and in what order, +for example you can:
++
+Return messages in the order newest to oldest (default behavior).
+Return messages in the order oldest to newest by setting reverse to true.
+Page through results by providing a start or end time token.
+Retrieve a “slice” of the time line by providing both a start and end time token.
+Limit the number of messages to a specific quantity using the count parameter.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel to return history messages from +
- count: (int) (default: 100) +
- Specifies the number of historical messages to return +
- callback: (optional) +
- 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) +
- 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
+-
+
- Sample Response: +
- [[“Pub1”,”Pub2”,”Pub3”,”Pub4”,”Pub5”],13406746729185766,13406746845892666] +
+
-
+
- +presence(channel, callback, error=None)¶ +
Subscribe to presence data 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.
++
+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: +
- None +
-
+
- +publish(channel, message, callback=None, error=None)¶ +
Publishes data on a channel.
+The publish() method is used to send a message to all subscribers of a channel. +To publish a message you must first specify a valid publish_key at initialization. +A successfully published message is replicated across the PubNub Real-Time Network +and sent simultaneously to all subscribed clients on a channel.
++
+Messages in transit can be secured from potential eavesdroppers with SSL/TLS bysetting ssl to True during initialization.
+Published messages can also be encrypted with AES-256 simply by specifying a cipher_key +during initialization.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel name to publish messages to. +
- message: (string/int/double/dict/list) +
- Message to be published +
- callback: (optional) +
- A callback 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) +
- 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: +
Sync Mode : list +Async Mode : None
+The function returns the following formatted response:
++
+[ Number, “Status”, “Time Token”]The output below demonstrates the response to a successful call:
++
+[1,”Sent”,”13769558699541401”]
+
-
+
- +revoke(channel=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 +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. +
- auth_key: (string) (optional) +
- Specifies auth_key to revoke permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_authkey”:{“r”:0,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +subscribe(channels, callback, error=None, connect=None, disconnect=None, reconnect=None, sync=False)¶ +
Subscribe to data on a channel.
+This function causes the client to create an open TCP socket to the +PubNub Real-Time Network and begin listening for messages on a specified channel. +To subscribe to a channel the client must send the appropriate subscribe_key at +initialization.
+Only works in async mode
+-
+
- Args: +
-
+
- channel: (string/list) +
- Specifies the channel to subscribe to. It is possible to specify +multiple channels as a comma separated list or andarray. +
- callback: (function) +
- This callback is called on receiving a message from the channel. +
- error: (function) (optional) +
- This callback is called on an error event +
- connect: (function) (optional) +
- This callback is called on a successful connection to the PubNub cloud +
- disconnect: (function) (optional) +
- This callback is called on client disconnect from the PubNub cloud +
- reconnect: (function) (optional) +
- This callback is called on successfully re-connecting to the PubNub cloud +
+- Returns: +
- None +
-
+
- +time(callback=None)¶ +
This function will return a 17 digit precision Unix epoch.
+Args:
++
+-
+
- callback: (optional) +
- 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 . +
-
+
- Returns: +
Returns a 17 digit number in sync mode i.e. when callback argument is not given
+-
+
- Sample: +
- 13769501243685161 +
+
-
+
- +unsubscribe(channel)¶ +
-
+
- Subscribe to presence data on a 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 +
+
+PubnubTornado¶
+-
+
- +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)¶ +
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.
+-
+
- Args: +
-
+
- 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 +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. +
- auth_key: (string) (optional) +
- Specifies the auth_key to return PAM attributes for. +If only a single channel is specified, it is possible to return +results for a comma separated list of auth_keys. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response +{
++
+“message”:”Success”, +“payload”:{
++
+-
+
- “channels”:{ +
-
+
- “my_channel”:{ +
- “auths”:{“my_ro_authkey”:{“r”:1,”w”:0}, +“my_rw_authkey”:{“r”:0,”w”:1}, +“my_admin_authkey”:{“r”:1,”w”:1} +
}
+
+
}
+},
+}
+
+
Usage:
++
+pubnub.audit (‘my_channel’); # Sync Mode
-
+
- +decrypt(message)¶ +
Method for decrypting data.
+This method takes ciphertext as input and returns decrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be decrypted. +
- Returns: +
- Returns decrypted message if cipher key is set +
-
+
- +encrypt(message)¶ +
Method for encrypting data.
+This method takes plaintext as input and returns encrypted data. +This need not be called directly as enncryption/decryption is +taken care of transparently by Pubnub class if cipher key is +provided at time of initializing pubnub object
+-
+
- Args: +
- message: Message to be encrypted. +
- Returns: +
- Returns encrypted message if cipher key is set +
-
+
- +grant(channel=None, auth_key=False, read=True, write=True, 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 +to true. A grant with read or write set to false (or not included) +will revoke any previous grants with read or write set to true.
+-
+
- Permissions can be applied to any one of three levels: +
-
+
- Application level privileges are based on subscribe_key applying to all associated channels. +
- Channel level privileges are based on a combination of subscribe_key and channel name. +
- User level privileges are based on the combination of subscribe_key, channel and auth_key. +
+- Args: +
-
+
- channel: (string) (optional) +
- Specifies channel name to grant permissions to. +If channel 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. +
- auth_key: (string) (optional) +
- Specifies auth_key to grant permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- read: (boolean) (default: True) +
- Read permissions are granted by setting to True. +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. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_ro_authkey”:{“r”:1,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +here_now(channel, callback=None, error=None)¶ +
Get here now data.
+You can obtain information about the current state of a channel including +a list of unique user-ids currently subscribed to the channel and the total +occupancy count of the channel by calling the here_now() function in your +application.
+-
+
- Args: +
-
+
- channel: (string) (optional) +
- Specifies the channel name to return occupancy results. +If channel is not provided, here_now will return data for all channels. +
- callback: (optional) +
- 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) +
- 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: +
Sync Mode: list +Async Mode: None
+Response Format:
+The here_now() method returns a list of uuid s currently subscribed to the channel.
+uuids:[“String”,”String”, ... ,”String”] - List of UUIDs currently subscribed to the channel.
+occupancy: Number - Total current occupancy of the channel.
+Example Response: +{
++
+occupancy: 4, +uuids: [
++
+‘123123234t234f34fq3dq’, +‘143r34f34t34fq34q34q3’, +‘23f34d3f4rq34r34rq23q’, +‘w34tcw45t45tcw435tww3’,]
+}
+
+
-
+
- +history(channel, count=100, reverse=False, start=None, end=None, callback=None, error=None)¶ +
This method fetches historical messages of a channel.
+PubNub Storage/Playback Service provides real-time access to an unlimited +history for all messages published to PubNub. Stored messages are replicated +across multiple availability zones in several geographical data center +locations. Stored messages can be encrypted with AES-256 message encryption +ensuring that they are not readable while stored on PubNub’s network.
+It is possible to control how messages are returned and in what order, +for example you can:
++
+Return messages in the order newest to oldest (default behavior).
+Return messages in the order oldest to newest by setting reverse to true.
+Page through results by providing a start or end time token.
+Retrieve a “slice” of the time line by providing both a start and end time token.
+Limit the number of messages to a specific quantity using the count parameter.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel to return history messages from +
- count: (int) (default: 100) +
- Specifies the number of historical messages to return +
- callback: (optional) +
- 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) +
- 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
+-
+
- Sample Response: +
- [[“Pub1”,”Pub2”,”Pub3”,”Pub4”,”Pub5”],13406746729185766,13406746845892666] +
+
-
+
- +presence(channel, callback, error=None)¶ +
Subscribe to presence data 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.
++
+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: +
- None +
-
+
- +publish(channel, message, callback=None, error=None)¶ +
Publishes data on a channel.
+The publish() method is used to send a message to all subscribers of a channel. +To publish a message you must first specify a valid publish_key at initialization. +A successfully published message is replicated across the PubNub Real-Time Network +and sent simultaneously to all subscribed clients on a channel.
++
+Messages in transit can be secured from potential eavesdroppers with SSL/TLS bysetting ssl to True during initialization.
+Published messages can also be encrypted with AES-256 simply by specifying a cipher_key +during initialization.
+-
+
- Args: +
-
+
- channel: (string) +
- Specifies channel name to publish messages to. +
- message: (string/int/double/dict/list) +
- Message to be published +
- callback: (optional) +
- A callback 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) +
- 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: +
Sync Mode : list +Async Mode : None
+The function returns the following formatted response:
++
+[ Number, “Status”, “Time Token”]The output below demonstrates the response to a successful call:
++
+[1,”Sent”,”13769558699541401”]
+
-
+
- +revoke(channel=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 +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. +
- auth_key: (string) (optional) +
- Specifies auth_key to revoke permissions to. +It is possible to specify multiple auth_keys as comma +separated list in combination with a single channel name. +If auth_key is provided as the special-case value “null” +(or included in a comma-separated list, eg. “null,null,abc”), +a new auth_key will be generated and returned for each “null” value. +
- ttl: (int) (default: 1440 i.e 24 hrs) +
- Time in minutes for which granted permissions are valid. +Max is 525600 , Min is 1. +Setting ttl to 0 will apply the grant indefinitely. +
- callback: (function) (optional) +
- A callback method can be passed to the method. +If set, the api works in async mode. +Required argument when working with twisted or tornado +
- error: (function) (optional) +
- 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 dict in sync mode i.e. when callback argument is not given +The dict returned contains values with keys ‘message’ and ‘payload’
+Sample Response: +{
++
+“message”:”Success”, +“payload”:{
++
+“ttl”:5, +“auths”:{
++
+“my_authkey”:{“r”:0,”w”:0}}, +“subscribe_key”:”my_subkey”, +“level”:”user”, +“channel”:”my_channel”
+}
+}
+
+
-
+
- +subscribe(channels, callback, error=None, connect=None, disconnect=None, reconnect=None, sync=False)¶ +
Subscribe to data on a channel.
+This function causes the client to create an open TCP socket to the +PubNub Real-Time Network and begin listening for messages on a specified channel. +To subscribe to a channel the client must send the appropriate subscribe_key at +initialization.
+Only works in async mode
+-
+
- Args: +
-
+
- channel: (string/list) +
- Specifies the channel to subscribe to. It is possible to specify +multiple channels as a comma separated list or andarray. +
- callback: (function) +
- This callback is called on receiving a message from the channel. +
- error: (function) (optional) +
- This callback is called on an error event +
- connect: (function) (optional) +
- This callback is called on a successful connection to the PubNub cloud +
- disconnect: (function) (optional) +
- This callback is called on client disconnect from the PubNub cloud +
- reconnect: (function) (optional) +
- This callback is called on successfully re-connecting to the PubNub cloud +
+- Returns: +
- None +
-
+
- +time(callback=None)¶ +
This function will return a 17 digit precision Unix epoch.
+Args:
++
+-
+
- callback: (optional) +
- 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 . +
-
+
- Returns: +
Returns a 17 digit number in sync mode i.e. when callback argument is not given
+-
+
- Sample: +
- 13769501243685161 +
+
-
+
- +unsubscribe(channel)¶ +
-
+
- Subscribe to presence data on a 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 +
+
+
+
+ Indices and tables¶
+-
+
- Index +
- Search Page +
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
new file mode 100644
index 0000000..43d1c8d
--- /dev/null
+++ b/docs/build/html/searchindex.js
@@ -0,0 +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
--
cgit v1.2.3
+
+
+
+
+
+
+
+
+ Search
+
+
+
+ + Please activate JavaScript to enable the search + functionality. +
++ From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +
+ + +
+
+
+
+
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +