Net::Jabber::X - Jabber X Module
Net::Jabber::X is a companion to the Net::Jabber module. It provides the user a simple interface to set and retrieve all parts of a Jabber X.
Net::Jabber::X differs from the other modules in that its behavior and available functions are based off of the XML namespace that is set in it. The current supported namespaces are: jabber:x:autoupdate jabber:x:conference jabber:x:data jabber:x:delay jabber:x:encrypted jabber:x:event jabber:x:expire jabber:x:oob jabber:x:roster jabber:x:signed http://jabber.org/protocol/muc http://jabber.org/protocol/muc#user For more information on what these namespaces are for, visit http://www.jabber.org and browse the Jabber Programmers Guide. Each of these namespaces provide Net::Jabber::X with the functions to access the data. By using the AUTOLOAD function the functions for each namespace is used when that namespace is active. To access a X object you must create an object and use the access functions there to get to the X. To initialize the object with a Jabber packet you must pass it the XML::Stream hash from the Net::Jabber::Client module. my $mess = new Net::Jabber::Message(%hash); There has been a change from the old way of handling the callbacks. You no longer have to do the above yourself, a Net::Jabber object is passed to the callback function for the message. Also, the first argument to the callback functions is the session ID from XML::Streams. There are some cases where you might want this information, like if you created a Client that connects to two servers at once, or for writing a mini server. use Net::Jabber qw(Client); sub messageCB { my ($Mess) = @_; my $x = $Mess->GetX("jabber:x:delay"); . . . } You now have access to all of the retrieval functions available. To create a new x to send to the server: use Net::Jabber qw(Client); my $message = new Net::Jabber::Message(); my $x = $message->NewX("jabber:x:oob"); Now you can call the creation functions for the X as defined in the proper namespace. See below for the general <x/> functions broken down by namespace. For more information about the array format being passed to the CallBack please read the Net::Jabber::Client documentation.
GetXMLNS() - returns a string with the namespace of the packet that the <x/> contains. $xmlns = $X->GetXMLNS(); GetX(string) - since the behavior of this module depends on the namespace, an X object may contain X objects. This helps to leverage code reuse by making children behave in the same manner. More than likely this function will never be called. @x = GetX(); @x = GetX("jabber:x:delay");
SetXMLNS(string) - sets the xmlns of the <x/> to the string. $X->SetXMLNS("jabber:x:delay");
In an effort to make maintaining this document easier, I am not going to go into full detail on each of these functions. Rather I will present the functions in a list with a type in the first column to show what they return, or take as arugments. Here is the list of types I will use:
string - just a string array - array of strings flag - this means that the specified child exists in the XML <child/> and acts like a flag. get will return 0 or 1. JID - either a string or Net::Jabber::JID object. objects - creates new objects, or returns an array of objects. special - this is a special case kind of function. Usually just by calling Set() with no arguments it will default the value to a special value, like OS or time. Sometimes it will modify the value you set, like in jabber:iq:version SetVersion() the function adds on the Net::Jabber version to the string just for advertisement purposes. =) master - this desribes a function that behaves like the SetMessage() function in Net::Jabber::Message. It takes a hash and sets all of the values defined, and the Set returns a hash with the values that are defined in the object.
Type Get Set Defined ======= ================ ================ ================== JID GetJID() SetJID() DefinedJID() master GetAutoupdate() SetAutoupdate()
Type Get Set Defined ======= ================ ================ ================== JID GetJID() SetJID() DefinedJID() master GetConference() SetConference()
Type Get Set Defined ======= ================ ================ ================== string GetInstructions() SetInstructions() DefinedInstructions() master GetForm() SetForm() objects AddField() objects AddReported() objects GetFields() objects GetReported()
Type Get Set Defined ======= ================ ================ ================== string GetDesc() SetDesc() DefinedDesc() string GetLabel() SetLabel() DefinedLabel() string GetType() SetType() DefinedType() string GetValue() SetValue() DefinedValue() string GetVar() SetVar() DefinedVar() master GetField() SetField() objects AddOption() objects GetOptions()
Type Get Set Defined ======= ================ ================ ================== objects GetFields()
Type Get Set Defined ======= ================ ================ ================== string GetLabel() SetLabel() DefinedLabel() string GetValue() SetValue() DefinedValue() master GetOption() SetOption()
Type Get Set Defined ======= ================ ================ ================== JID GetFrom() SetFrom() DefinedFrom() string GetMessage() SetMessage() DefinedMessage() string GetStamp() SetStamp() DefinedStamp() master GetDelay() SetDelay()
Type Get Set Defined ======= ================ ================ ================== string GetMessage() SetMessage() DefinedMessage() master GetEncrypted() SetEncrypted()
Type Get Set Defined ======= ================ ================ ================== flag GetComposing() SetComposing() DefinedComposing() flag GetDelivered() SetDelivered() DefinedDelivered() flag GetDisplayed() SetDisplayed() DefinedDisplayed() string GetID() SetID() DefinedID() flag GetOffline() SetOffline() DefinedOffline() master GetEvent() SetEvent()
Type Get Set Defined ======= ================ ================ ================== string GetSeconds() SetSeconds() DefinedSeconds() master GetExpire() SetExpire()
Type Get Set Defined ======= ================ ================ ================== string GetDesc() SetDesc() DefinedDesc() string GetURL() SetURL() DefinedURL() master GetOob() SetOob()
Type Get Set Defined ======= ================ ================ ================== objects AddItem() objects GetItems()
Type Get Set Defined ======= ================ ================ ================== array GetGroup() SetGroup() DefinedGroup() JID GetJID() SetJID() DefinedJID() string GetName() SetName() DefinedName() master GetItem() SetItem()
Type Get Set Defined ======= ================ ================ ================== string GetSignature() SetSignature() DefinedSignature() master GetSigned() SetSigned()
Type Get Set Defined ======= ================ ================ ================== string GetPassword() SetPassword() DefinedPassword() master GetMUC() SetMUC()
Type Get Set Defined ======= ================ ================ ================== string GetAlt() SetAlt() DefinedAlt() string GetPassword() SetPassword() DefinedPassword() string GetStatusCode() SetStatusCode() DefinedStatusCode() objects GetInvite() AddInvite() objects GetItem() AddItem() master GetUser() SetUser()
Type Get Set Defined ======= ================ ================ ================== jid GetFrom() SetFrom() DefinedFrom() string GetReason() SetReason() DefinedReason() jid GetTo() SetTo() DefinedTo() master GetInvite() SetInvite()
Type Get Set Defined ======= ================ ================ ================== jid GetActorJID() SetActorJID() DefinedActorJID() string GetAffiliation() SetAffiliation() DefinedAffiliation() jid GetJID() SetJID() DefinedJID() string GetNick() SetNick() DefinedNick() string GetReason() SetReason() DefinedReason() string GetRole() SetRole() DefinedRole() master GetItem() SetItem()
Part of the flexability of this module is that you can define your own namespace. For more information on this topic, please read the Net::Jabber::Namespaces man page.
By Ryan Eatmon in May of 2001 for http://jabber.org..
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Net::Jabber, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Jabber
CPAN shell
perl -MCPAN -e shell install Net::Jabber
For more information on module installation, please visit the detailed CPAN module installation guide.