1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>xmpp.features</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="xmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="xmpp-module.html">Package xmpp</a> ::
Module features
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="xmpp.features-pysrc.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<h1 class="epydoc">Source Code for <a href="xmpp.features-module.html">Module xmpp.features</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment">## features.py </tt> </tt>
<a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## Copyright (C) 2003-2004 Alexey "Snake" Nezhdanov</tt> </tt>
<a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## This program is free software; you can redistribute it and/or modify</tt> </tt>
<a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## it under the terms of the GNU General Public License as published by</tt> </tt>
<a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## the Free Software Foundation; either version 2, or (at your option)</tt> </tt>
<a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## any later version.</tt> </tt>
<a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">##</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## This program is distributed in the hope that it will be useful,</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## but WITHOUT ANY WARRANTY; without even the implied warranty of</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">## GNU General Public License for more details.</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt> <tt class="py-line"><tt class="py-comment"># $Id: features.py,v 1.24 2006/03/25 05:47:22 snakeru Exp $</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt> <tt class="py-line"><tt class="py-docstring">This module contains variable stuff that is not worth splitting into separate modules.</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt> <tt class="py-line"><tt class="py-docstring">Here is:</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt> <tt class="py-line"><tt class="py-docstring"> DISCO client and agents-to-DISCO and browse-to-DISCO emulators.</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt> <tt class="py-line"><tt class="py-docstring"> IBR and password manager.</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt> <tt class="py-line"><tt class="py-docstring"> jabber:iq:privacy methods</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt> <tt class="py-line"><tt class="py-docstring">All these methods takes 'disp' first argument that should be already connected</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt> <tt class="py-line"><tt class="py-docstring">(and in most cases already authorised) dispatcher instance.</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt> <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt> <tt class="py-line"> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module xmpp.protocol=xmpp.protocol-module.html"><a title="xmpp.protocol" class="py-name" href="#" onclick="return doclink('link-0', 'protocol', 'link-0');">protocol</a></tt> <tt class="py-keyword">import</tt> <tt class="py-op">*</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt> <tt class="py-line"> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt> <tt class="py-line"><tt id="link-1" class="py-name" targets="Variable xmpp.features.REGISTER_DATA_RECEIVED=xmpp.features-module.html#REGISTER_DATA_RECEIVED"><a title="xmpp.features.REGISTER_DATA_RECEIVED" class="py-name" href="#" onclick="return doclink('link-1', 'REGISTER_DATA_RECEIVED', 'link-1');">REGISTER_DATA_RECEIVED</a></tt><tt class="py-op">=</tt><tt class="py-string">'REGISTER DATA RECEIVED'</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt> <tt class="py-line"> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt> <tt class="py-line"><tt class="py-comment">### DISCO ### http://jabber.org/protocol/disco ### JEP-0030 ####################</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">### Browse ### jabber:iq:browse ### JEP-0030 ###################################</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">### Agents ### jabber:iq:agents ### JEP-0030 ###################################</tt> </tt>
<a name="_discover"></a><div id="_discover-def"><a name="L34"></a><tt class="py-lineno"> 34</tt> <a class="py-toggle" href="#" id="_discover-toggle" onclick="return toggle('_discover');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#_discover">_discover</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">ns</tt><tt class="py-op">,</tt><tt class="py-param">jid</tt><tt class="py-op">,</tt><tt class="py-param">node</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt><tt class="py-param">fb2b</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt><tt class="py-param">fb2a</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_discover-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_discover-expanded"><a name="L35"></a><tt class="py-lineno"> 35</tt> <tt class="py-line"> <tt class="py-docstring">""" Try to obtain info from the remote object.</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt> <tt class="py-line"><tt class="py-docstring"> If remote object doesn't support disco fall back to browse (if fb2b is true)</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt> <tt class="py-line"><tt class="py-docstring"> and if it doesnt support browse (or fb2b is not true) fall back to agents protocol</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt> <tt class="py-line"><tt class="py-docstring"> (if gb2a is true). Returns obtained info. Used internally. """</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt> <tt class="py-line"> <tt class="py-name">iq</tt><tt class="py-op">=</tt><tt id="link-2" class="py-name" targets="Class xmpp.protocol.Iq=xmpp.protocol.Iq-class.html"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-2', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">jid</tt><tt class="py-op">,</tt><tt class="py-name">typ</tt><tt class="py-op">=</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt class="py-name">queryNS</tt><tt class="py-op">=</tt><tt class="py-name">ns</tt><tt class="py-op">)</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">node</tt><tt class="py-op">:</tt> <tt class="py-name">iq</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method xmpp.protocol.Iq.setQuerynode()=xmpp.protocol.Iq-class.html#setQuerynode"><a title="xmpp.protocol.Iq.setQuerynode" class="py-name" href="#" onclick="return doclink('link-3', 'setQuerynode', 'link-3');">setQuerynode</a></tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">)</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt> <tt class="py-line"> <tt class="py-name">rep</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method xmpp.dispatcher.Dispatcher.SendAndWaitForResponse()=xmpp.dispatcher.Dispatcher-class.html#SendAndWaitForResponse"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-4', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt class="py-name">iq</tt><tt class="py-op">)</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">fb2b</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-5" class="py-name" targets="Function xmpp.protocol.isResultNode()=xmpp.protocol-module.html#isResultNode"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-5', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">rep</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">rep</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-6', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-7" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-7', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">jid</tt><tt class="py-op">,</tt><tt class="py-name">typ</tt><tt class="py-op">=</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt class="py-name">queryNS</tt><tt class="py-op">=</tt><tt id="link-8" class="py-name" targets="Variable xmpp.protocol.NS_BROWSE=xmpp.protocol-module.html#NS_BROWSE"><a title="xmpp.protocol.NS_BROWSE" class="py-name" href="#" onclick="return doclink('link-8', 'NS_BROWSE', 'link-8');">NS_BROWSE</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-comment"># Fallback to browse</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">fb2a</tt> <tt class="py-keyword">and</tt> <tt class="py-keyword">not</tt> <tt id="link-9" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-9', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">rep</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">rep</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-10', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-11" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-11', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">jid</tt><tt class="py-op">,</tt><tt class="py-name">typ</tt><tt class="py-op">=</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt class="py-name">queryNS</tt><tt class="py-op">=</tt><tt id="link-12" class="py-name" targets="Variable xmpp.protocol.NS_AGENTS=xmpp.protocol-module.html#NS_AGENTS"><a title="xmpp.protocol.NS_AGENTS" class="py-name" href="#" onclick="return doclink('link-12', 'NS_AGENTS', 'link-12');">NS_AGENTS</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> <tt class="py-comment"># Fallback to agents</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-13" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-13', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">rep</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">rep</tt><tt class="py-op">.</tt><tt id="link-14" class="py-name" targets="Method xmpp.protocol.Iq.getQueryPayload()=xmpp.protocol.Iq-class.html#getQueryPayload"><a title="xmpp.protocol.Iq.getQueryPayload" class="py-name" href="#" onclick="return doclink('link-14', 'getQueryPayload', 'link-14');">getQueryPayload</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
</div><a name="L46"></a><tt class="py-lineno"> 46</tt> <tt class="py-line"> </tt>
<a name="discoverItems"></a><div id="discoverItems-def"><a name="L47"></a><tt class="py-lineno"> 47</tt> <a class="py-toggle" href="#" id="discoverItems-toggle" onclick="return toggle('discoverItems');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#discoverItems">discoverItems</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">jid</tt><tt class="py-op">,</tt><tt class="py-param">node</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="discoverItems-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="discoverItems-expanded"><a name="L48"></a><tt class="py-lineno"> 48</tt> <tt class="py-line"> <tt class="py-docstring">""" Query remote object about any items that it contains. Return items list. """</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt> <tt class="py-line"> <tt class="py-string">""" According to JEP-0030:</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt> <tt class="py-line"><tt class="py-string"> query MAY have node attribute</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt> <tt class="py-line"><tt class="py-string"> item: MUST HAVE jid attribute and MAY HAVE name, node, action attributes.</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt> <tt class="py-line"><tt class="py-string"> action attribute of item can be either of remove or update value."""</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt> <tt class="py-line"> <tt class="py-name">ret</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt id="link-15" class="py-name" targets="Function xmpp.features._discover()=xmpp.features-module.html#_discover"><a title="xmpp.features._discover" class="py-name" href="#" onclick="return doclink('link-15', '_discover', 'link-15');">_discover</a></tt><tt class="py-op">(</tt><tt class="py-name">disp</tt><tt class="py-op">,</tt><tt id="link-16" class="py-name" targets="Variable xmpp.protocol.NS_DISCO_ITEMS=xmpp.protocol-module.html#NS_DISCO_ITEMS"><a title="xmpp.protocol.NS_DISCO_ITEMS" class="py-name" href="#" onclick="return doclink('link-16', 'NS_DISCO_ITEMS', 'link-16');">NS_DISCO_ITEMS</a></tt><tt class="py-op">,</tt><tt class="py-name">jid</tt><tt class="py-op">,</tt><tt class="py-name">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method xmpp.roster.Roster.getName()=xmpp.roster.Roster-class.html#getName,Method xmpp.simplexml.Node.getName()=xmpp.simplexml.Node-class.html#getName"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-17', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'agent'</tt> <tt class="py-keyword">and</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-18" class="py-name" targets="Method xmpp.simplexml.Node.getTag()=xmpp.simplexml.Node-class.html#getTag"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-18', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name" targets="Method xmpp.simplexml.Node.setAttr()=xmpp.simplexml.Node-class.html#setAttr"><a title="xmpp.simplexml.Node.setAttr" class="py-name" href="#" onclick="return doclink('link-19', 'setAttr', 'link-19');">setAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-20" class="py-name" targets="Method xmpp.simplexml.Node.getTagData()=xmpp.simplexml.Node-class.html#getTagData"><a title="xmpp.simplexml.Node.getTagData" class="py-name" href="#" onclick="return doclink('link-20', 'getTagData', 'link-20');">getTagData</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt> <tt class="py-line"> <tt class="py-name">ret</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">attrs</tt><tt class="py-op">)</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt> </tt>
</div><a name="L58"></a><tt class="py-lineno"> 58</tt> <tt class="py-line"> </tt>
<a name="discoverInfo"></a><div id="discoverInfo-def"><a name="L59"></a><tt class="py-lineno"> 59</tt> <a class="py-toggle" href="#" id="discoverInfo-toggle" onclick="return toggle('discoverInfo');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#discoverInfo">discoverInfo</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">jid</tt><tt class="py-op">,</tt><tt class="py-param">node</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="discoverInfo-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="discoverInfo-expanded"><a name="L60"></a><tt class="py-lineno"> 60</tt> <tt class="py-line"> <tt class="py-docstring">""" Query remote object about info that it publishes. Returns identities and features lists."""</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt> <tt class="py-line"> <tt class="py-string">""" According to JEP-0030:</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt> <tt class="py-line"><tt class="py-string"> query MAY have node attribute</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt> <tt class="py-line"><tt class="py-string"> identity: MUST HAVE category and name attributes and MAY HAVE type attribute.</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt> <tt class="py-line"><tt class="py-string"> feature: MUST HAVE var attribute"""</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt> <tt class="py-line"> <tt class="py-name">identities</tt> <tt class="py-op">,</tt> <tt id="link-21" class="py-name" targets="Module xmpp.features=xmpp.features-module.html"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-21', 'features', 'link-21');">features</a></tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> <tt class="py-op">,</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt id="link-22" class="py-name"><a title="xmpp.features._discover" class="py-name" href="#" onclick="return doclink('link-22', '_discover', 'link-15');">_discover</a></tt><tt class="py-op">(</tt><tt class="py-name">disp</tt><tt class="py-op">,</tt><tt id="link-23" class="py-name" targets="Variable xmpp.protocol.NS_DISCO_INFO=xmpp.protocol-module.html#NS_DISCO_INFO"><a title="xmpp.protocol.NS_DISCO_INFO" class="py-name" href="#" onclick="return doclink('link-23', 'NS_DISCO_INFO', 'link-23');">NS_DISCO_INFO</a></tt><tt class="py-op">,</tt><tt class="py-name">jid</tt><tt class="py-op">,</tt><tt class="py-name">node</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-24', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'identity'</tt><tt class="py-op">:</tt> <tt class="py-name">identities</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">attrs</tt><tt class="py-op">)</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-25', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'feature'</tt><tt class="py-op">:</tt> <tt id="link-26" class="py-name"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-26', 'features', 'link-21');">features</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name" targets="Method xmpp.simplexml.Node.getAttr()=xmpp.simplexml.Node-class.html#getAttr"><a title="xmpp.simplexml.Node.getAttr" class="py-name" href="#" onclick="return doclink('link-27', 'getAttr', 'link-27');">getAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'var'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-28', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'agent'</tt><tt class="py-op">:</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-29', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="xmpp.simplexml.Node.setAttr" class="py-name" href="#" onclick="return doclink('link-30', 'setAttr', 'link-19');">setAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="xmpp.simplexml.Node.getTagData" class="py-name" href="#" onclick="return doclink('link-31', 'getTagData', 'link-20');">getTagData</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-32', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="xmpp.simplexml.Node.setAttr" class="py-name" href="#" onclick="return doclink('link-33', 'setAttr', 'link-19');">setAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">,</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="xmpp.simplexml.Node.getTagData" class="py-name" href="#" onclick="return doclink('link-34', 'getTagData', 'link-20');">getTagData</a></tt><tt class="py-op">(</tt><tt class="py-string">'description'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt> <tt class="py-line"> <tt class="py-name">identities</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt class="py-name">attrs</tt><tt class="py-op">)</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-35', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'groupchat'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-36" class="py-name"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-36', 'features', 'link-21');">features</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-37" class="py-name" targets="Variable xmpp.protocol.NS_GROUPCHAT=xmpp.protocol-module.html#NS_GROUPCHAT"><a title="xmpp.protocol.NS_GROUPCHAT" class="py-name" href="#" onclick="return doclink('link-37', 'NS_GROUPCHAT', 'link-37');">NS_GROUPCHAT</a></tt><tt class="py-op">)</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-38', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'register'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-39" class="py-name"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-39', 'features', 'link-21');">features</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-40" class="py-name" targets="Variable xmpp.protocol.NS_REGISTER=xmpp.protocol-module.html#NS_REGISTER"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-40', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">)</tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-41', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'search'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt id="link-42" class="py-name"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-42', 'features', 'link-21');">features</a></tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt id="link-43" class="py-name" targets="Variable xmpp.protocol.NS_SEARCH=xmpp.protocol-module.html#NS_SEARCH"><a title="xmpp.protocol.NS_SEARCH" class="py-name" href="#" onclick="return doclink('link-43', 'NS_SEARCH', 'link-43');">NS_SEARCH</a></tt><tt class="py-op">)</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">identities</tt> <tt class="py-op">,</tt> <tt id="link-44" class="py-name"><a title="xmpp.features" class="py-name" href="#" onclick="return doclink('link-44', 'features', 'link-21');">features</a></tt> </tt>
</div><a name="L77"></a><tt class="py-lineno"> 77</tt> <tt class="py-line"> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt> <tt class="py-line"><tt class="py-comment">### Registration ### jabber:iq:register ### JEP-0077 ###########################</tt> </tt>
<a name="getRegInfo"></a><div id="getRegInfo-def"><a name="L79"></a><tt class="py-lineno"> 79</tt> <a class="py-toggle" href="#" id="getRegInfo-toggle" onclick="return toggle('getRegInfo');">-</a><tt class="py-line"><tt class="py-comment"></tt><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#getRegInfo">getRegInfo</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">host</tt><tt class="py-op">,</tt><tt class="py-param">info</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">,</tt><tt class="py-param">sync</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getRegInfo-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getRegInfo-expanded"><a name="L80"></a><tt class="py-lineno"> 80</tt> <tt class="py-line"> <tt class="py-docstring">""" Gets registration form from remote host.</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt> <tt class="py-line"><tt class="py-docstring"> You can pre-fill the info dictionary.</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt> <tt class="py-line"><tt class="py-docstring"> F.e. if you are requesting info on registering user joey than specify </tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt> <tt class="py-line"><tt class="py-docstring"> info as {'username':'joey'}. See JEP-0077 for details.</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt> <tt class="py-line"><tt class="py-docstring"> 'disp' must be connected dispatcher instance."""</tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt> <tt class="py-line"> <tt class="py-name">iq</tt><tt class="py-op">=</tt><tt id="link-45" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-45', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt id="link-46" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-46', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">host</tt><tt class="py-op">)</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">info</tt><tt class="py-op">.</tt><tt id="link-47" class="py-name" targets="Method xmpp.roster.Roster.keys()=xmpp.roster.Roster-class.html#keys"><a title="xmpp.roster.Roster.keys" class="py-name" href="#" onclick="return doclink('link-47', 'keys', 'link-47');">keys</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">iq</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Method xmpp.simplexml.Node.setTagData()=xmpp.simplexml.Node-class.html#setTagData"><a title="xmpp.simplexml.Node.setTagData" class="py-name" href="#" onclick="return doclink('link-48', 'setTagData', 'link-48');">setTagData</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">,</tt><tt class="py-name">info</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">sync</tt><tt class="py-op">:</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-49', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt class="py-name">iq</tt><tt class="py-op">)</tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt> <tt class="py-line"> <tt id="link-50" class="py-name" targets="Function xmpp.features._ReceivedRegInfo()=xmpp.features-module.html#_ReceivedRegInfo"><a title="xmpp.features._ReceivedRegInfo" class="py-name" href="#" onclick="return doclink('link-50', '_ReceivedRegInfo', 'link-50');">_ReceivedRegInfo</a></tt><tt class="py-op">(</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-51" class="py-name" targets="Class xmpp.dispatcher.Dispatcher=xmpp.dispatcher.Dispatcher-class.html"><a title="xmpp.dispatcher.Dispatcher" class="py-name" href="#" onclick="return doclink('link-51', 'Dispatcher', 'link-51');">Dispatcher</a></tt><tt class="py-op">,</tt><tt class="py-name">resp</tt><tt class="py-op">,</tt> <tt class="py-name">host</tt><tt class="py-op">)</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-52" class="py-name" targets="Method xmpp.dispatcher.Dispatcher.SendAndCallForResponse()=xmpp.dispatcher.Dispatcher-class.html#SendAndCallForResponse"><a title="xmpp.dispatcher.Dispatcher.SendAndCallForResponse" class="py-name" href="#" onclick="return doclink('link-52', 'SendAndCallForResponse', 'link-52');">SendAndCallForResponse</a></tt><tt class="py-op">(</tt><tt class="py-name">iq</tt><tt class="py-op">,</tt><tt id="link-53" class="py-name"><a title="xmpp.features._ReceivedRegInfo" class="py-name" href="#" onclick="return doclink('link-53', '_ReceivedRegInfo', 'link-50');">_ReceivedRegInfo</a></tt><tt class="py-op">,</tt> <tt class="py-op">{</tt><tt class="py-string">'agent'</tt><tt class="py-op">:</tt> <tt class="py-name">host</tt><tt class="py-op">}</tt><tt class="py-op">)</tt> </tt>
</div><a name="L92"></a><tt class="py-lineno"> 92</tt> <tt class="py-line"> </tt>
<a name="_ReceivedRegInfo"></a><div id="_ReceivedRegInfo-def"><a name="L93"></a><tt class="py-lineno"> 93</tt> <a class="py-toggle" href="#" id="_ReceivedRegInfo-toggle" onclick="return toggle('_ReceivedRegInfo');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#_ReceivedRegInfo">_ReceivedRegInfo</a><tt class="py-op">(</tt><tt class="py-param">con</tt><tt class="py-op">,</tt> <tt class="py-param">resp</tt><tt class="py-op">,</tt> <tt class="py-param">agent</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="_ReceivedRegInfo-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="_ReceivedRegInfo-expanded"><a name="L94"></a><tt class="py-lineno"> 94</tt> <tt class="py-line"> <tt class="py-name">iq</tt><tt class="py-op">=</tt><tt id="link-54" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-54', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt id="link-55" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-55', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">agent</tt><tt class="py-op">)</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-56" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-56', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt> <tt class="py-line"> <tt class="py-name">df</tt><tt class="py-op">=</tt><tt class="py-name">resp</tt><tt class="py-op">.</tt><tt id="link-57" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-57', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">,</tt><tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt id="link-58" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-58', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-59" class="py-name"><a title="xmpp.simplexml.Node.getTag" class="py-name" href="#" onclick="return doclink('link-59', 'getTag', 'link-18');">getTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'x'</tt><tt class="py-op">,</tt><tt class="py-name">namespace</tt><tt class="py-op">=</tt><tt id="link-60" class="py-name" targets="Variable xmpp.protocol.NS_DATA=xmpp.protocol-module.html#NS_DATA"><a title="xmpp.protocol.NS_DATA" class="py-name" href="#" onclick="return doclink('link-60', 'NS_DATA', 'link-60');">NS_DATA</a></tt><tt class="py-op">)</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">df</tt><tt class="py-op">:</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt> <tt class="py-line"> <tt class="py-name">con</tt><tt class="py-op">.</tt><tt id="link-61" class="py-name" targets="Method xmpp.dispatcher.Dispatcher.Event()=xmpp.dispatcher.Dispatcher-class.html#Event"><a title="xmpp.dispatcher.Dispatcher.Event" class="py-name" href="#" onclick="return doclink('link-61', 'Event', 'link-61');">Event</a></tt><tt class="py-op">(</tt><tt id="link-62" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-62', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt id="link-63" class="py-name"><a title="xmpp.features.REGISTER_DATA_RECEIVED" class="py-name" href="#" onclick="return doclink('link-63', 'REGISTER_DATA_RECEIVED', 'link-1');">REGISTER_DATA_RECEIVED</a></tt><tt class="py-op">,</tt><tt class="py-op">(</tt><tt class="py-name">agent</tt><tt class="py-op">,</tt> <tt id="link-64" class="py-name" targets="Class xmpp.protocol.DataForm=xmpp.protocol.DataForm-class.html"><a title="xmpp.protocol.DataForm" class="py-name" href="#" onclick="return doclink('link-64', 'DataForm', 'link-64');">DataForm</a></tt><tt class="py-op">(</tt><tt class="py-name">node</tt><tt class="py-op">=</tt><tt class="py-name">df</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt> <tt class="py-line"> <tt class="py-name">df</tt><tt class="py-op">=</tt><tt id="link-65" class="py-name"><a title="xmpp.protocol.DataForm" class="py-name" href="#" onclick="return doclink('link-65', 'DataForm', 'link-64');">DataForm</a></tt><tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">=</tt><tt class="py-string">'form'</tt><tt class="py-op">)</tt> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt id="link-66" class="py-name"><a title="xmpp.protocol.Iq.getQueryPayload" class="py-name" href="#" onclick="return doclink('link-66', 'getQueryPayload', 'link-14');">getQueryPayload</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">)</tt><tt class="py-op"><></tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">iq</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
<a name="L103"></a><tt class="py-lineno">103</tt> <tt class="py-line"> <tt class="py-keyword">elif</tt> <tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-67" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-67', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'instructions'</tt><tt class="py-op">:</tt> <tt class="py-name">df</tt><tt class="py-op">.</tt><tt id="link-68" class="py-name" targets="Method xmpp.protocol.DataForm.addInstructions()=xmpp.protocol.DataForm-class.html#addInstructions"><a title="xmpp.protocol.DataForm.addInstructions" class="py-name" href="#" onclick="return doclink('link-68', 'addInstructions', 'link-68');">addInstructions</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-69" class="py-name" targets="Method xmpp.simplexml.Node.getData()=xmpp.simplexml.Node-class.html#getData"><a title="xmpp.simplexml.Node.getData" class="py-name" href="#" onclick="return doclink('link-69', 'getData', 'link-69');">getData</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">df</tt><tt class="py-op">.</tt><tt id="link-70" class="py-name" targets="Method xmpp.protocol.DataForm.setField()=xmpp.protocol.DataForm-class.html#setField"><a title="xmpp.protocol.DataForm.setField" class="py-name" href="#" onclick="return doclink('link-70', 'setField', 'link-70');">setField</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-71" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-71', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-72" class="py-name" targets="Method xmpp.protocol.DataField.setValue()=xmpp.protocol.DataField-class.html#setValue"><a title="xmpp.protocol.DataField.setValue" class="py-name" href="#" onclick="return doclink('link-72', 'setValue', 'link-72');">setValue</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">.</tt><tt id="link-73" class="py-name"><a title="xmpp.simplexml.Node.getData" class="py-name" href="#" onclick="return doclink('link-73', 'getData', 'link-69');">getData</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt> <tt class="py-line"> <tt class="py-name">con</tt><tt class="py-op">.</tt><tt id="link-74" class="py-name"><a title="xmpp.dispatcher.Dispatcher.Event" class="py-name" href="#" onclick="return doclink('link-74', 'Event', 'link-61');">Event</a></tt><tt class="py-op">(</tt><tt id="link-75" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-75', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt id="link-76" class="py-name"><a title="xmpp.features.REGISTER_DATA_RECEIVED" class="py-name" href="#" onclick="return doclink('link-76', 'REGISTER_DATA_RECEIVED', 'link-1');">REGISTER_DATA_RECEIVED</a></tt><tt class="py-op">,</tt><tt class="py-op">(</tt><tt class="py-name">agent</tt><tt class="py-op">,</tt> <tt class="py-name">df</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="L106"></a><tt class="py-lineno">106</tt> <tt class="py-line"> </tt>
<a name="register"></a><div id="register-def"><a name="L107"></a><tt class="py-lineno">107</tt> <a class="py-toggle" href="#" id="register-toggle" onclick="return toggle('register');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#register">register</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">host</tt><tt class="py-op">,</tt><tt class="py-param">info</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="register-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="register-expanded"><a name="L108"></a><tt class="py-lineno">108</tt> <tt class="py-line"> <tt class="py-docstring">""" Perform registration on remote server with provided info.</tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt> <tt class="py-line"><tt class="py-docstring"> disp must be connected dispatcher instance.</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt> <tt class="py-line"><tt class="py-docstring"> Returns true or false depending on registration result.</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt> <tt class="py-line"><tt class="py-docstring"> If registration fails you can get additional info from the dispatcher's owner</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt> <tt class="py-line"><tt class="py-docstring"> attributes lastErrNode, lastErr and lastErrCode.</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt> <tt class="py-line"> <tt class="py-name">iq</tt><tt class="py-op">=</tt><tt id="link-77" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-77', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-78" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-78', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">host</tt><tt class="py-op">)</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">info</tt><tt class="py-op">)</tt><tt class="py-op"><></tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-op">{</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">info</tt><tt class="py-op">=</tt><tt class="py-name">info</tt><tt class="py-op">.</tt><tt id="link-79" class="py-name" targets="Method xmpp.protocol.DataForm.asDict()=xmpp.protocol.DataForm-class.html#asDict"><a title="xmpp.protocol.DataForm.asDict" class="py-name" href="#" onclick="return doclink('link-79', 'asDict', 'link-79');">asDict</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">i</tt> <tt class="py-keyword">in</tt> <tt class="py-name">info</tt><tt class="py-op">.</tt><tt id="link-80" class="py-name"><a title="xmpp.roster.Roster.keys" class="py-name" href="#" onclick="return doclink('link-80', 'keys', 'link-47');">keys</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-name">iq</tt><tt class="py-op">.</tt><tt id="link-81" class="py-name" targets="Method xmpp.simplexml.Node.setTag()=xmpp.simplexml.Node-class.html#setTag"><a title="xmpp.simplexml.Node.setTag" class="py-name" href="#" onclick="return doclink('link-81', 'setTag', 'link-81');">setTag</a></tt><tt class="py-op">(</tt><tt class="py-string">'query'</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt id="link-82" class="py-name"><a title="xmpp.simplexml.Node.setTagData" class="py-name" href="#" onclick="return doclink('link-82', 'setTagData', 'link-48');">setTagData</a></tt><tt class="py-op">(</tt><tt class="py-name">i</tt><tt class="py-op">,</tt><tt class="py-name">info</tt><tt class="py-op">[</tt><tt class="py-name">i</tt><tt class="py-op">]</tt><tt class="py-op">)</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-83" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-83', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt class="py-name">iq</tt><tt class="py-op">)</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-84" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-84', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L119"></a><tt class="py-lineno">119</tt> <tt class="py-line"> </tt>
<a name="unregister"></a><div id="unregister-def"><a name="L120"></a><tt class="py-lineno">120</tt> <a class="py-toggle" href="#" id="unregister-toggle" onclick="return toggle('unregister');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#unregister">unregister</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">host</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="unregister-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="unregister-expanded"><a name="L121"></a><tt class="py-lineno">121</tt> <tt class="py-line"> <tt class="py-docstring">""" Unregisters with host (permanently removes account).</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt> <tt class="py-line"><tt class="py-docstring"> disp must be connected and authorized dispatcher instance.</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt> <tt class="py-line"><tt class="py-docstring"> Returns true on success."""</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-85" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-85', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-86" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-86', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-87" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-87', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">host</tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt id="link-88" class="py-name" targets="Class xmpp.simplexml.Node=xmpp.simplexml.Node-class.html"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-88', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-string">'remove'</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-89" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-89', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L126"></a><tt class="py-lineno">126</tt> <tt class="py-line"> </tt>
<a name="changePasswordTo"></a><div id="changePasswordTo-def"><a name="L127"></a><tt class="py-lineno">127</tt> <a class="py-toggle" href="#" id="changePasswordTo-toggle" onclick="return toggle('changePasswordTo');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#changePasswordTo">changePasswordTo</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">newpassword</tt><tt class="py-op">,</tt><tt class="py-param">host</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="changePasswordTo-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="changePasswordTo-expanded"><a name="L128"></a><tt class="py-lineno">128</tt> <tt class="py-line"> <tt class="py-docstring">""" Changes password on specified or current (if not specified) server.</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt> <tt class="py-line"><tt class="py-docstring"> disp must be connected and authorized dispatcher instance.</tt> </tt>
<a name="L130"></a><tt class="py-lineno">130</tt> <tt class="py-line"><tt class="py-docstring"> Returns true on success."""</tt> </tt>
<a name="L131"></a><tt class="py-lineno">131</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">host</tt><tt class="py-op">:</tt> <tt class="py-name">host</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt class="py-name">_owner</tt><tt class="py-op">.</tt><tt class="py-name">Server</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-90" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-90', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-91" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-91', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-92" class="py-name"><a title="xmpp.protocol.NS_REGISTER" class="py-name" href="#" onclick="return doclink('link-92', 'NS_REGISTER', 'link-40');">NS_REGISTER</a></tt><tt class="py-op">,</tt><tt class="py-name">to</tt><tt class="py-op">=</tt><tt class="py-name">host</tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt id="link-93" class="py-name"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-93', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-string">'username'</tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt class="py-name">_owner</tt><tt class="py-op">.</tt><tt class="py-name">Server</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">,</tt><tt id="link-94" class="py-name"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-94', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-string">'password'</tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">newpassword</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L133"></a><tt class="py-lineno">133</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-95" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-95', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L134"></a><tt class="py-lineno">134</tt> <tt class="py-line"> </tt>
<a name="L135"></a><tt class="py-lineno">135</tt> <tt class="py-line"><tt class="py-comment">### Privacy ### jabber:iq:privacy ### draft-ietf-xmpp-im-19 ####################</tt> </tt>
<a name="L136"></a><tt class="py-lineno">136</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#type=[jid|group|subscription]</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt> <tt class="py-line"><tt class="py-comment"></tt><tt class="py-comment">#action=[allow|deny]</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt> <tt class="py-line"><tt class="py-comment"></tt> </tt>
<a name="getPrivacyLists"></a><div id="getPrivacyLists-def"><a name="L139"></a><tt class="py-lineno">139</tt> <a class="py-toggle" href="#" id="getPrivacyLists-toggle" onclick="return toggle('getPrivacyLists');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#getPrivacyLists">getPrivacyLists</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getPrivacyLists-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getPrivacyLists-expanded"><a name="L140"></a><tt class="py-lineno">140</tt> <tt class="py-line"> <tt class="py-docstring">""" Requests privacy lists from connected server.</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt> <tt class="py-line"><tt class="py-docstring"> Returns dictionary of existing lists on success."""</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt> <tt class="py-line"> <tt class="py-name">dict</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-string">'lists'</tt><tt class="py-op">:</tt><tt class="py-op">[</tt><tt class="py-op">]</tt><tt class="py-op">}</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-96" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-96', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-97" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-97', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt id="link-98" class="py-name" targets="Variable xmpp.protocol.NS_PRIVACY=xmpp.protocol-module.html#NS_PRIVACY"><a title="xmpp.protocol.NS_PRIVACY" class="py-name" href="#" onclick="return doclink('link-98', 'NS_PRIVACY', 'link-98');">NS_PRIVACY</a></tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt id="link-99" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-99', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt> <tt class="py-line"> <tt class="py-keyword">for</tt> <tt class="py-name">list</tt> <tt class="py-keyword">in</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt id="link-100" class="py-name"><a title="xmpp.protocol.Iq.getQueryPayload" class="py-name" href="#" onclick="return doclink('link-100', 'getQueryPayload', 'link-14');">getQueryPayload</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">list</tt><tt class="py-op">.</tt><tt id="link-101" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-101', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">==</tt><tt class="py-string">'list'</tt><tt class="py-op">:</tt> <tt class="py-name">dict</tt><tt class="py-op">[</tt><tt class="py-string">'lists'</tt><tt class="py-op">]</tt><tt class="py-op">.</tt><tt class="py-name">append</tt><tt class="py-op">(</tt><tt class="py-name">list</tt><tt class="py-op">.</tt><tt id="link-102" class="py-name"><a title="xmpp.simplexml.Node.getAttr" class="py-name" href="#" onclick="return doclink('link-102', 'getAttr', 'link-27');">getAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">dict</tt><tt class="py-op">[</tt><tt class="py-name">list</tt><tt class="py-op">.</tt><tt id="link-103" class="py-name"><a title="xmpp.roster.Roster.getName
xmpp.simplexml.Node.getName" class="py-name" href="#" onclick="return doclink('link-103', 'getName', 'link-17');">getName</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">=</tt><tt class="py-name">list</tt><tt class="py-op">.</tt><tt id="link-104" class="py-name"><a title="xmpp.simplexml.Node.getAttr" class="py-name" href="#" onclick="return doclink('link-104', 'getAttr', 'link-27');">getAttr</a></tt><tt class="py-op">(</tt><tt class="py-string">'name'</tt><tt class="py-op">)</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt class="py-name">dict</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L151"></a><tt class="py-lineno">151</tt> <tt class="py-line"> </tt>
<a name="getPrivacyList"></a><div id="getPrivacyList-def"><a name="L152"></a><tt class="py-lineno">152</tt> <a class="py-toggle" href="#" id="getPrivacyList-toggle" onclick="return toggle('getPrivacyList');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#getPrivacyList">getPrivacyList</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">listname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="getPrivacyList-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="getPrivacyList-expanded"><a name="L153"></a><tt class="py-lineno">153</tt> <tt class="py-line"> <tt class="py-docstring">""" Requests specific privacy list listname. Returns list of XML nodes (rules)</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt> <tt class="py-line"><tt class="py-docstring"> taken from the server responce."""</tt> </tt>
<a name="L155"></a><tt class="py-lineno">155</tt> <tt class="py-line"> <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L156"></a><tt class="py-lineno">156</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-105" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-105', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-106" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-106', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'get'</tt><tt class="py-op">,</tt><tt id="link-107" class="py-name"><a title="xmpp.protocol.NS_PRIVACY" class="py-name" href="#" onclick="return doclink('link-107', 'NS_PRIVACY', 'link-98');">NS_PRIVACY</a></tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt id="link-108" class="py-name"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-108', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-string">'list'</tt><tt class="py-op">,</tt><tt class="py-op">{</tt><tt class="py-string">'name'</tt><tt class="py-op">:</tt><tt class="py-name">listname</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-109" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-109', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-name">resp</tt><tt class="py-op">.</tt><tt id="link-110" class="py-name"><a title="xmpp.protocol.Iq.getQueryPayload" class="py-name" href="#" onclick="return doclink('link-110', 'getQueryPayload', 'link-14');">getQueryPayload</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L158"></a><tt class="py-lineno">158</tt> <tt class="py-line"> <tt class="py-keyword">except</tt><tt class="py-op">:</tt> <tt class="py-keyword">pass</tt> </tt>
</div><a name="L159"></a><tt class="py-lineno">159</tt> <tt class="py-line"> </tt>
<a name="setActivePrivacyList"></a><div id="setActivePrivacyList-def"><a name="L160"></a><tt class="py-lineno">160</tt> <a class="py-toggle" href="#" id="setActivePrivacyList-toggle" onclick="return toggle('setActivePrivacyList');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#setActivePrivacyList">setActivePrivacyList</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">listname</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt><tt class="py-param">typ</tt><tt class="py-op">=</tt><tt class="py-string">'active'</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="setActivePrivacyList-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="setActivePrivacyList-expanded"><a name="L161"></a><tt class="py-lineno">161</tt> <tt class="py-line"> <tt class="py-docstring">""" Switches privacy list 'listname' to specified type.</tt> </tt>
<a name="L162"></a><tt class="py-lineno">162</tt> <tt class="py-line"><tt class="py-docstring"> By default the type is 'active'. Returns true on success."""</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">listname</tt><tt class="py-op">:</tt> <tt class="py-name">attrs</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-string">'name'</tt><tt class="py-op">:</tt><tt class="py-name">listname</tt><tt class="py-op">}</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> <tt class="py-name">attrs</tt><tt class="py-op">=</tt><tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-111" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-111', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-112" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-112', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-113" class="py-name"><a title="xmpp.protocol.NS_PRIVACY" class="py-name" href="#" onclick="return doclink('link-113', 'NS_PRIVACY', 'link-98');">NS_PRIVACY</a></tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt id="link-114" class="py-name"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-114', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-name">typ</tt><tt class="py-op">,</tt><tt class="py-name">attrs</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L166"></a><tt class="py-lineno">166</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-115" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-115', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L167"></a><tt class="py-lineno">167</tt> <tt class="py-line"> </tt>
<a name="setDefaultPrivacyList"></a><div id="setDefaultPrivacyList-def"><a name="L168"></a><tt class="py-lineno">168</tt> <a class="py-toggle" href="#" id="setDefaultPrivacyList-toggle" onclick="return toggle('setDefaultPrivacyList');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#setDefaultPrivacyList">setDefaultPrivacyList</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">listname</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="setDefaultPrivacyList-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="setDefaultPrivacyList-expanded"><a name="L169"></a><tt class="py-lineno">169</tt> <tt class="py-line"> <tt class="py-docstring">""" Sets the default privacy list as 'listname'. Returns true on success."""</tt> </tt>
<a name="L170"></a><tt class="py-lineno">170</tt> <tt class="py-line"> <tt class="py-keyword">return</tt> <tt id="link-116" class="py-name" targets="Function xmpp.features.setActivePrivacyList()=xmpp.features-module.html#setActivePrivacyList"><a title="xmpp.features.setActivePrivacyList" class="py-name" href="#" onclick="return doclink('link-116', 'setActivePrivacyList', 'link-116');">setActivePrivacyList</a></tt><tt class="py-op">(</tt><tt class="py-name">disp</tt><tt class="py-op">,</tt><tt class="py-name">listname</tt><tt class="py-op">,</tt><tt class="py-string">'default'</tt><tt class="py-op">)</tt> </tt>
</div><a name="L171"></a><tt class="py-lineno">171</tt> <tt class="py-line"> </tt>
<a name="setPrivacyList"></a><div id="setPrivacyList-def"><a name="L172"></a><tt class="py-lineno">172</tt> <a class="py-toggle" href="#" id="setPrivacyList-toggle" onclick="return toggle('setPrivacyList');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#setPrivacyList">setPrivacyList</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="setPrivacyList-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="setPrivacyList-expanded"><a name="L173"></a><tt class="py-lineno">173</tt> <tt class="py-line"> <tt class="py-docstring">""" Set the ruleset. 'list' should be the simpleXML node formatted</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt> <tt class="py-line"><tt class="py-docstring"> according to RFC 3921 (XMPP-IM) (I.e. Node('list',{'name':listname},payload=[...]) )</tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt> <tt class="py-line"><tt class="py-docstring"> Returns true on success."""</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-117" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-117', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-118" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-118', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-119" class="py-name"><a title="xmpp.protocol.NS_PRIVACY" class="py-name" href="#" onclick="return doclink('link-119', 'NS_PRIVACY', 'link-98');">NS_PRIVACY</a></tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt class="py-name">list</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-120" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-120', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L178"></a><tt class="py-lineno">178</tt> <tt class="py-line"> </tt>
<a name="delPrivacyList"></a><div id="delPrivacyList-def"><a name="L179"></a><tt class="py-lineno">179</tt> <a class="py-toggle" href="#" id="delPrivacyList-toggle" onclick="return toggle('delPrivacyList');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="xmpp.features-module.html#delPrivacyList">delPrivacyList</a><tt class="py-op">(</tt><tt class="py-param">disp</tt><tt class="py-op">,</tt><tt class="py-param">listname</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="delPrivacyList-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="delPrivacyList-expanded"><a name="L180"></a><tt class="py-lineno">180</tt> <tt class="py-line"> <tt class="py-docstring">""" Deletes privacy list 'listname'. Returns true on success."""</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt> <tt class="py-line"> <tt class="py-name">resp</tt><tt class="py-op">=</tt><tt class="py-name">disp</tt><tt class="py-op">.</tt><tt id="link-121" class="py-name"><a title="xmpp.dispatcher.Dispatcher.SendAndWaitForResponse" class="py-name" href="#" onclick="return doclink('link-121', 'SendAndWaitForResponse', 'link-4');">SendAndWaitForResponse</a></tt><tt class="py-op">(</tt><tt id="link-122" class="py-name"><a title="xmpp.protocol.Iq" class="py-name" href="#" onclick="return doclink('link-122', 'Iq', 'link-2');">Iq</a></tt><tt class="py-op">(</tt><tt class="py-string">'set'</tt><tt class="py-op">,</tt><tt id="link-123" class="py-name"><a title="xmpp.protocol.NS_PRIVACY" class="py-name" href="#" onclick="return doclink('link-123', 'NS_PRIVACY', 'link-98');">NS_PRIVACY</a></tt><tt class="py-op">,</tt><tt class="py-name">payload</tt><tt class="py-op">=</tt><tt class="py-op">[</tt><tt id="link-124" class="py-name"><a title="xmpp.simplexml.Node" class="py-name" href="#" onclick="return doclink('link-124', 'Node', 'link-88');">Node</a></tt><tt class="py-op">(</tt><tt class="py-string">'list'</tt><tt class="py-op">,</tt><tt class="py-op">{</tt><tt class="py-string">'name'</tt><tt class="py-op">:</tt><tt class="py-name">listname</tt><tt class="py-op">}</tt><tt class="py-op">)</tt><tt class="py-op">]</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt id="link-125" class="py-name"><a title="xmpp.protocol.isResultNode" class="py-name" href="#" onclick="return doclink('link-125', 'isResultNode', 'link-5');">isResultNode</a></tt><tt class="py-op">(</tt><tt class="py-name">resp</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> <tt class="py-keyword">return</tt> <tt class="py-number">1</tt> </tt>
</div><a name="L183"></a><tt class="py-lineno">183</tt> <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="xmpp-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Sat Dec 15 22:25:34 2007
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
|
