.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "AnyEvent::XMPP::IM::Account 3pm" .TH AnyEvent::XMPP::IM::Account 3pm "2022-12-06" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" AnyEvent::XMPP::IM::Account \- Instant messaging account .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& my $cl = AnyEvent::XMPP::IM::Client\->new; \& ... \& my $acc = $cl\->get_account ($jid); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module represents a class for \s-1IM\s0 accounts. It is used by AnyEvent::XMPP::Client. .PP You can get an instance of this class only by calling the \f(CW\*(C`get_account\*(C'\fR method on a AnyEvent::XMPP::Client object. .SH "METHODS" .IX Header "METHODS" .IP "\fBconnection ()\fR" 4 .IX Item "connection ()" Returns the AnyEvent::XMPP::IM::Connection object if this account already has one (undef otherwise). .IP "\fBis_connected ()\fR" 4 .IX Item "is_connected ()" Returns true if this accunt is connected. .IP "\fBjid ()\fR" 4 .IX Item "jid ()" Returns either the full \s-1JID\s0 if the account is connected or returns the bare jid if not. .IP "\fBbare_jid ()\fR" 4 .IX Item "bare_jid ()" Returns always the bare \s-1JID\s0 of this account after stringprep has been applied, so you can compare the JIDs returned from this function. .IP "\fBnickname ()\fR" 4 .IX Item "nickname ()" Your nickname for this account. .IP "\fBnickname_for_jid ($jid)\fR" 4 .IX Item "nickname_for_jid ($jid)" This method transforms the \f(CW$jid\fR to a nickname. It looks the \f(CW$jid\fR up in the roster and looks for a nickname. If no nickname could be found in the roster it returns the node part for the \f(CW$jid\fR. .IP "\fBsend_tracked_message ($msg)\fR" 4 .IX Item "send_tracked_message ($msg)" This method sends the AnyEvent::XMPP::IM::Message object in \f(CW$msg\fR. The \f(CW\*(C`to\*(C'\fR attribute of the message is adjusted by the conversation tracking mechanism. .SH "EVENTS" .IX Header "EVENTS" For these events callbacks can be registered (with the Object::Event interface): .ie n .IP "tracked_message_destination => $bare_jid, $full_jid" 4 .el .IP "tracked_message_destination => \f(CW$bare_jid\fR, \f(CW$full_jid\fR" 4 .IX Item "tracked_message_destination => $bare_jid, $full_jid" This event is emitted whenever the message tracking mechanism changes (or sets) it's destination resource for the \f(CW$bare_jid\fR to \f(CW$full_jid\fR. .IP "removed" 4 .IX Item "removed" Whenever the account is removed from the AnyEvent::XMPP::Client (eg. when disconnected) this event is emitted before it is destroyed. .SH "AUTHOR" .IX Header "AUTHOR" Robin Redeker, \f(CW\*(C`\*(C'\fR, \s-1JID:\s0 \f(CW\*(C`\*(C'\fR .SH "COPYRIGHT & LICENSE" .IX Header "COPYRIGHT & LICENSE" Copyright 2007, 2008 Robin Redeker, all rights reserved. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.