• NAME
• SYNOPSIS
• DESCRIPTION
• CONSTRUCTOR
• INSTANCE METHODS

NAME

Net::Msmgr::Session -- The main point of contact in a Perl MSN Client

SYNOPSIS

 our $session = new Net::Msmgr::Session;
 our $user = new Net::Msmgr::User ( user => 'username@msn.com',
                             password => 'my_password' ) ;

 $session->user($user);
 $session->login_handler( sub { shift->Logout } ) ;
 $session->Login;

 Event::loop;

DESCRIPTION

Net::Msmgr::Session is the encapsulation for an entire MSN Messenger Client session. You register handlers to deal with various inbound messages such as incoming chat requests or state change notifications. When you are finished, you call instance method Logout and everything goes away.

CONSTRUCTOR

    my $session = new Net::Msmgr::Session (...);

        - or -

    my $session = Net::Msmgr::Session->new(...);

Constructor parameters are:

user (mandatory)

The container for the Authentication Data for the session.

login_handler (optional)

A code reference to a subroutine that will be called upon successful authentication and connection to the notification server.

connect_handler (optional)

A code reference to a subroutine that will be called after each connection to a server.

disconnect_handler (optional)

A code reference to a subroutine that will be called just before each close call when disconnecting from a server.

INSTANCE METHODS

$session->ui_new_conversation;

Instantiate a new conversation (which you can later invite people to)

$session->ui_invite_conversation($conversation, $username);

Send an invitation to another user.

=cut

$session->ui_sync;

Initiate list syncronization.

$session->ping;

Ping the Notification Server.

$session->ui_send_message($ssid, $message);

Send a message to all users in Switchboard Connection $ssid. $message must be a properly MIME formatted message.

$session->ui_state_nln;

$session->ui_state_bsy;

$session->ui_state_idl;

$session->ui_state_brb;

$session->ui_state_awy;

$session->ui_state_phn;

$session->ui_state_lun;

$session->ui_state_hdn;

Set your Notification Status to one of Online (NLN), Busy (BSY), Idle (IDL), Be Right Back (BRB), Away (AWY), Phone (PHN), Out To Lunch (LUN), or Hidden (HDN). All of these are advisory, except hidden, which makes you appear offline, and disallows initiation of Switchboard sessions.

$session->Logout;

The end of the road.

$session->Login;

The beginning of the road. If $session->login_handler is defined, it will be treated as a callback when the session connects, and passed the single parameter of the Net::Msmgr::Session object