1Net::Jabber::XDB(3) User Contributed Perl Documentation Net::Jabber::XDB(3)
2
6 Net::Jabber::XDB - Jabber XDB Library
7
9 Net::Jabber::XDB is a companion to the Net::Jabber module. It
10 provides the user a simple interface to set and retrieve all
11 parts of a Jabber XDB.
12
14 Net::Jabber::XDB differs from the other Net::Jabber::* modules in that
15 the XMLNS of the data is split out into more submodules under
16 XDB. For specifics on each module please view the documentation
17 for each Net::Jabber::Data::* module. To see the list of avilable
18 namspaces and modules see Net::Jabber::Data.
19 To initialize the XDB with a Jabber <xdb/> you must pass it the
21 XML::Parser Tree array. For example:
22 my $xdb = new Net::Jabber::XDB(@tree);
24 There has been a change from the old way of handling the callbacks.
26 You no longer have to do the above, a Net::Jabber::XDB object is passed
27 to the callback function for the xdb:
28 use Net::Jabber qw(Component);
30 sub xdb {
32 my ($XDB) = @_;
33 .
34 .
35 .
36 }
37 You now have access to all of the retrieval functions available.
39 To create a new xdb to send to the server:
41 use Net::Jabber;
43 $XDB = new Net::Jabber::XDB();
45 $XDBType = $XDB->NewData( type );
46 $XDBType->SetXXXXX("yyyyy");
47 Now you can call the creation functions for the XDB, and for the <data/>
49 on the new Data object itself. See below for the <xdb/> functions, and
50 in each data module for those functions.
51 For more information about the array format being passed to the CallBack
53 please read the Net::Jabber::Client documentation.
54
56 Retrieval functions
57 GetTo() - returns either a string with the Jabber Identifier,
58 GetTo("jid") or a Net::Jabber::JID object for the person who is
59 going to receive the <xdb/>. To get the JID
60 object set the string to "jid", otherwise leave
61 blank for the text string.
62 $to = $XDB->GetTo();
64 $toJID = $XDB->GetTo("jid");
65 GetFrom() - returns either a string with the Jabber Identifier,
67 GetFrom("jid") or a Net::Jabber::JID object for the person who
68 sent the <xdb/>. To get the JID object set
69 the string to "jid", otherwise leave blank for the
70 text string.
71 $from = $XDB->GetFrom();
73 $fromJID = $XDB->GetFrom("jid");
74 GetType() - returns a string with the type <xdb/> this is.
76 $type = $XDB->GetType();
78 GetID() - returns an integer with the id of the <xdb/>.
80 $id = $XDB->GetID();
82 GetAction() - returns a string with the action <xdb/> this is.
84 $action = $XDB->GetAction();
86 GetMatch() - returns a string with the match <xdb/> this is.
88 $match = $XDB->GetMatch();
90 GetError() - returns a string with the text description of the error.
92 $error = $XDB->GetError();
94 GetErrorCode() - returns a string with the code of error.
96 $errorCode = $XDB->GetErrorCode();
98 GetData() - returns a Net::Jabber::Data object that contains the data
100 in the <data/> of the <xdb/>.
101 $dataTag = $XDB->GetData();
103 GetDataXMLNS() - returns a string with the namespace of the data
105 for this <xdb/>, if one exists.
106 $xmlns = $XDB->GetDataXMLNS();
108 Creation functions
110 SetXDB(to=>string|JID, - set multiple fields in the <xdb/> at one
111 from=>string|JID, time. This is a cumulative and over
112 id=>string, writing action. If you set the "to"
113 type=>string, attribute twice, the second setting is
114 action=>string, what is used. If you set the status, and
115 match=>string) then set the priority then both will be in
116 errorcode=>string, the <xdb/> tag. For valid settings read the
117 error=>string) specific Set functions below.
118 $XDB->SetXDB(type=>"get",
120 to=>"bob\@jabber.org",
121 data=>"info");
122 $XDB->SetXDB(to=>"bob\@jabber.org",
124 errorcode=>403,
125 error=>"Permission Denied");
126 SetTo(string) - sets the to attribute. You can either pass a string
128 SetTo(JID) or a JID object. They must be a valid Jabber
129 Identifiers or the server will return an error message.
130 (ie. jabber:bob@jabber.org, etc...)
131 $XDB->SetTo("bob\@jabber.org");
133 SetFrom(string) - sets the from attribute. You can either pass a string
135 SetFrom(JID) or a JID object. They must be a valid Jabber
136 Identifiers or the server will return an error message.
137 (ie. jabber:bob@jabber.org, etc...)
138 $XDB->SetFrom("me\@jabber.org");
140 SetType(string) - sets the type attribute. Valid settings are:
142 get request information
144 set set information
145 result results of a get
146 error there was an error
147 $XDB->SetType("set");
149 SetAction(string) - sets the error code of the <xdb/>.
151 $XDB->SetAction("foo");
153 SetMatch(string) - sets the error code of the <xdb/>.
155 $XDB->SetMatch("foo");
157 SetErrorCode(string) - sets the error code of the <xdb/>.
159 $XDB->SetErrorCode(403);
161 SetError(string) - sets the error string of the <xdb/>.
163 $XDB->SetError("Permission Denied");
165 NewData(string) - creates a new Net::Jabber::Data object with the
167 namespace in the string. In order for this function
168 to work with a custom namespace, you must define and
169 register that namespace with the XDB module. For more
170 information please read the documentation for
171 Net::Jabber::Data.
172 $dataObj = $XDB->NewData("jabber:xdb:auth");
174 $dataObj = $XDB->NewData("jabber:xdb:roster");
175 Reply(hash) - creates a new XDB object and populates the to/from
177 fields. If you specify a hash the same as with SetXDB
178 then those values will override the Reply values.
179 $xdbReply = $XDB->Reply();
181 $xdbReply = $XDB->Reply(type=>"result");
182 Test functions
184 DefinedTo() - returns 1 if the to attribute is defined in the <xdb/>,
185 0 otherwise.
186 $test = $XDB->DefinedTo();
188 DefinedFrom() - returns 1 if the from attribute is defined in the <xdb/>,
190 0 otherwise.
191 $test = $XDB->DefinedFrom();
193 DefinedID() - returns 1 if the id attribute is defined in the <xdb/>,
195 0 otherwise.
196 $test = $XDB->DefinedID();
198 DefinedType() - returns 1 if the type attribute is defined in the <xdb/>,
200 0 otherwise.
201 $test = $XDB->DefinedType();
203 DefinedAction() - returns 1 if the action attribute is defined in the <xdb/>,
205 0 otherwise.
206 $test = $XDB->DefinedAction();
208 DefinedMatch() - returns 1 if the match attribute is defined in the <xdb/>,
210 0 otherwise.
211 $test = $XDB->DefinedMatch();
213 DefinedError() - returns 1 if <error/> is defined in the <xdb/>,
215 0 otherwise.
216 $test = $XDB->DefinedError();
218 DefinedErrorCode() - returns 1 if the code attribute is defined in
220 <error/>, 0 otherwise.
221 $test = $XDB->DefinedErrorCode();
223
225 By Ryan Eatmon in May of 2001 for http://jabber.org..
226
228 This module is free software; you can redistribute it and/or modify it
229 under the same terms as Perl itself.
230perl v5.28.1 2004-08-17 Net::Jabber::XDB(3)