← Back to branch summary

~ubuntu-branches/ubuntu/quantal/pyxmpp/quantal

« back to all changes in this revision

Viewing changes to doc/www/api/private/pyxmpp.jabber.vcard.VCardJID-class.html

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Habouzit
  • Date: 2006-06-29 14:28:32 UTC
  • mto: (2.1.2 edgy) (3.1.1 squeeze) (6.1.1 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20060629142832-rnmtcwypqzwlkosv
Tags: upstream-1.0.0
Import upstream version 1.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/www/api/private/pyxmpp.jabber.vcard.VCardJID-class.html
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>pyxmpp.jabber.vcard.VCardJID</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="middle">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pyxmpp-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://pyxmpp.jabberstudio.org/">PyXMPP</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <span class="breadcrumbs">
 
32
        <a href="pyxmpp-module.html">Package&nbsp;pyxmpp</a> ::
 
33
        <a href="pyxmpp.jabber-module.html">Package&nbsp;jabber</a> ::
 
34
        <a href="pyxmpp.jabber.vcard-module.html">Module&nbsp;vcard</a> ::
 
35
        Class&nbsp;VCardJID
 
36
      </span><br />
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><span class="options">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/pyxmpp.jabber.vcard.VCardJID-class.html">hide&nbsp;private</a>]</span></td></tr>
 
40
      <tr><td align="right"><span class="options">[<a href="frames.html" target="_top">frames</a>&nbsp;|&nbsp;<a href="pyxmpp.jabber.vcard.VCardJID-class.html" target="_top">no&nbsp;frames</a>]</span></td></tr>
 
41
    </table></td>
 
42
</tr></table>
 
43
 
 
44
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
45
<h2 class="class">Class VCardJID</h2>
 
46
 
 
47
<pre class="base-tree">
 
48
<a href="pyxmpp.jabber.vcard.VCardField-class.html"><code>VCardField</code></a> --+
 
49
             |
 
50
            <strong class="uidshort">VCardJID</strong>
 
51
</pre><br />
 
52
 
 
53
<hr/>
 
54
 
 
55
<p>JID vCard field.</p>
 
56
<p>This field is not defined in RFC 2426, so it will be named 'x-jabberid'
 
57
in RFC 2425 output.</p>
 
58
<hr/>
 
59
 
 
60
 
 
61
<!-- =========== START OF METHOD SUMMARY =========== -->
 
62
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
63
<tr bgcolor="#70b0f0" class="summary">
 
64
  <th colspan="2">Method Summary</th></tr>
 
65
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
66
  <td><code><span class="summary-sig"><a href="pyxmpp.jabber.vcard.VCardJID-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class="summary-sig-arg">self</span>,
 
67
          <span class="summary-sig-arg">name</span>,
 
68
          <span class="summary-sig-arg">value</span>,
 
69
          <span class="summary-sig-arg">rfc2425parameters</span>)</span></code>
 
70
<br />
 
71
Initialize a <a href="pyxmpp.jabber.vcard.VCardJID-class.html" class="link"><code>VCardJID</code></a> object.</td></tr>
 
72
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
73
  <td><code><a name="__str__"></a><span class="summary-sig"><span class="summary-sig-name">__str__</span>(<span class="summary-sig-arg">self</span>)</span></code>
 
74
</td></tr>
 
75
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
76
  <td><code><a name="__unicode__"></a><span class="summary-sig"><span class="summary-sig-name">__unicode__</span>(<span class="summary-sig-arg">self</span>)</span></code>
 
77
</td></tr>
 
78
<tr><td align="right" valign="top" width="15%" class="rtype"><code>libxml2.xmlNode</code></td>
 
79
  <td><code><span class="summary-sig"><a href="pyxmpp.jabber.vcard.VCardJID-class.html#as_xml" class="summary-sig-name"><code>as_xml</code></a>(<span class="summary-sig-arg">self</span>,
 
80
          <span class="summary-sig-arg">parent</span>)</span></code>
 
81
<br />
 
82
Create vcard-tmp XML representation of the field.</td></tr>
 
83
<tr><td align="right" valign="top" width="15%" class="rtype"><code>str</code></td>
 
84
  <td><code><span class="summary-sig"><a href="pyxmpp.jabber.vcard.VCardJID-class.html#rfc2426" class="summary-sig-name"><code>rfc2426</code></a>(<span class="summary-sig-arg">self</span>)</span></code>
 
85
<br />
 
86
RFC2426-encode the field content.</td></tr>
 
87
<tr bgcolor="#e8f0f8" class="group">
 
88
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from VCardField</th></tr>
 
89
<tr><td align="right" valign="top" width="15%" class="rtype">&nbsp;</td>
 
90
  <td><code><span class="summary-sig"><a href="pyxmpp.jabber.vcard.VCardField-class.html#__repr__" class="summary-sig-name"><code>__repr__</code></a>(<span class="summary-sig-arg">self</span>)</span></code>
 
91
</td></tr>
 
92
</table><br />
 
93
 
 
94
 
 
95
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
 
96
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
97
<tr bgcolor="#70b0f0" class="summary">
 
98
  <th colspan="2">Instance Variable Summary</th></tr>
 
99
<tr><td align="right" valign="top" width="15%" class="vtype"><a href="pyxmpp.jid.JID-class.html" class="link"><code>JID</code></a></td>
 
100
<td><strong><a href="pyxmpp.jabber.vcard.VCardJID-class.html#value"><code>value</code></a></strong>: field value.</td></tr>
 
101
<tr bgcolor="#e8f0f8" class="group">
 
102
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from VCardField</th></tr>
 
103
<tr><td align="right" valign="top" width="15%" class="vtype">&nbsp;</td>
 
104
<td><strong><a href="pyxmpp.jabber.vcard.VCardField-class.html#name"><code>name</code></a></strong>: name of the field.</td></tr>
 
105
</table><br />
 
106
 
 
107
 
 
108
<!-- =========== START OF METHOD DETAILS =========== -->
 
109
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
110
<tr bgcolor="#70b0f0" class="details">
 
111
  <th colspan="2">Method Details</th></tr>
 
112
</table>
 
113
 
 
114
<a name="__init__"></a>
 
115
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
116
  <h3><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
 
117
          <span class="sig-arg">name</span>,
 
118
          <span class="sig-arg">value</span>,
 
119
          <span class="sig-arg">rfc2425parameters</span>=<span class="sig-default">None</span>)</span>
 
120
    <br /><em class="fname">(Constructor)</em>
 
121
  </h3>
 
122
Initialize a <a href="pyxmpp.jabber.vcard.VCardJID-class.html" class="link"><code>VCardJID</code></a> object.  <dl><dt></dt><dd>
 
123
    <dl><dt>Parameters:</dt>
 
124
      <dd><code><strong class="pname">name</strong></code> -
 
125
 field name
 
126
        <br /><em class="type">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
127
        (type=<code>str</code>)</em>
 
128
      </dd>
 
129
      <dd><code><strong class="pname">value</strong></code> -
 
130
 field value as string or an XML node
 
131
        <br /><em class="type">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
132
        (type=<code>str</code> or <code>libxml2.xmlNode</code>)</em>
 
133
      </dd>
 
134
      <dd><code><strong class="pname">rfc2425parameters</strong></code> -
 
135
 optional RFC 2425 parameters
 
136
        <br /><em class="type">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
137
        (type=<a href="__builtin__.dict-class.html" class="link"><code>dict</code></a>)</em>
 
138
      </dd>
 
139
    </dl>
 
140
    <dl><dt>Overrides:</dt>
 
141
      <dd><a href="pyxmpp.jabber.vcard.VCardField-class.html#__init__"><code>pyxmpp.jabber.vcard.VCardField.__init__</code></a></dd>
 
142
    </dl>
 
143
  </dd></dl>
 
144
</td></tr></table>
 
145
 
 
146
<a name="as_xml"></a>
 
147
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
148
  <h3><span class="sig"><span class="sig-name">as_xml</span>(<span class="sig-arg">self</span>,
 
149
          <span class="sig-arg">parent</span>)</span>
 
150
  </h3>
 
151
Create vcard-tmp XML representation of the field.  <dl><dt></dt><dd>
 
152
    <dl><dt>Parameters:</dt>
 
153
      <dd><code><strong class="pname">parent</strong></code> -
 
154
 parent node for the element
 
155
        <br /><em class="type">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
156
        (type=<code>libxml2.xmlNode</code>)</em>
 
157
      </dd>
 
158
    </dl>
 
159
    <dl><dt>Returns:</dt>
 
160
      <dd>
 
161
xml node with the field data.        <br /><em>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
162
        (type=<code>libxml2.xmlNode</code>)</em>
 
163
      </dd>
 
164
    </dl>
 
165
  </dd></dl>
 
166
</td></tr></table>
 
167
 
 
168
<a name="rfc2426"></a>
 
169
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
 
170
  <h3><span class="sig"><span class="sig-name">rfc2426</span>(<span class="sig-arg">self</span>)</span>
 
171
  </h3>
 
172
RFC2426-encode the field content.  <dl><dt></dt><dd>
 
173
    <dl><dt>Returns:</dt>
 
174
      <dd>
 
175
the field in the RFC 2426 format.        <br /><em>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
176
        (type=<code>str</code>)</em>
 
177
      </dd>
 
178
    </dl>
 
179
    <dl><dt>Overrides:</dt>
 
180
      <dd><a href="pyxmpp.jabber.vcard.VCardField-class.html#rfc2426"><code>pyxmpp.jabber.vcard.VCardField.rfc2426</code></a></dd>
 
181
    </dl>
 
182
  </dd></dl>
 
183
</td></tr></table>
 
184
<br />
 
185
 
 
186
 
 
187
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
 
188
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
189
<tr bgcolor="#70b0f0" class="details">
 
190
  <th colspan="2">Instance Variable Details</th></tr>
 
191
</table>
 
192
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
193
<a name="value"></a>
 
194
<h3>value</h3>
 
195
field value.<dl>
 
196
  <dt></dt>
 
197
  <dd>
 
198
    <dl>
 
199
      <dt>Type:</dt>
 
200
      <dd>
 
201
<a href="pyxmpp.jid.JID-class.html" class="link"><code>JID</code></a>
 
202
      </dd>
 
203
    </dl>
 
204
  </dd>
 
205
</dl></td></tr></table>
 
206
<br />
 
207
 
 
208
 
 
209
<!-- =========== START OF NAVBAR =========== -->
 
210
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
211
  <tr valign="middle">
 
212
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="pyxmpp-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
213
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
214
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
215
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
216
    <th class="navbar" align="right" width="100%">
 
217
      <table border="0" cellpadding="0" cellspacing="0">
 
218
      <tr><th class="navbar" align="center">
 
219
        <p class="nomargin">
 
220
          <a class="navbar" target="_top" href="http://pyxmpp.jabberstudio.org/">PyXMPP</a>
 
221
      </p></th></tr></table>
 
222
    </th>
 
223
  </tr>
 
224
</table>
 
225
 
 
226
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
227
  <tr>
 
228
    <td align="left" class="footer">Generated by Epydoc 2.1 on Mon Dec 26 17:57:27 2005</td>
 
229
    <td align="right" class="footer">
 
230
      <a href="http://epydoc.sourceforge.net">http://epydoc.sf.net</a>
 
231
    </td>
 
232
  </tr>
 
233
</table>
 
234
</body>
 
235
</html>