Windows Messenger Service Reference

This is the entry page to the reference documentation for the Messenger service APIs.

Applications cannot connect to Microsoft .NET Messenger Services or use any of the Messenger service APIs until they have successfully authenticated with the Messenger Lock and Key mechanism. Once authentication is complete, the Messenger service APIs are unlocked and can be used as necessary by the application.

The Messenger service API references are provided for Microsoft Visual C++. Also there is an overview included (Messenger Lock and Key API), that provides general guidelines on unlocking and using the Messenger service APIs.

Enums

LockError

Provides a list of Lock and Key error status codes.

LockStatus

Provides the list of possible status codes for the Messenger Lock and Key API.

SESSION_FLAGS

Provides the list of possible flag codes for the session invitation.

SESSION_RESULT

Provides the list of possible result codes of the session invitation.

SESSION_STATE

Provides the list of possible state codes of the session invitation.

DispInterfaces

DMessengerPrivateEvents

The DMessengerPrivateEvents dispinterface fires events in the Messenger client when notifications from IMessengerPrivate are received.

DMsgrSessionEvents

The DMessengerPrivateEvents dispinterface fires events in the Messenger client when notifications from IMsgrSession are received.

DMsgrSessionManagerEvents

The DMsgrSessionManagerEvents dispinterface fires events in the Messenger client when notifications from IMsgrSessionManager are received.

Events

DMsgrSessionEvents::BeforeAppLaunch

Fires when the session's application is about to be launched.

DMsgrSessionEvents::OnAccepted

Fires when the recipient has accepted the invitation.

DMessengerPrivateEvents::OnAlertReceived

Fires when an alert notification is sent from a Messenger service to a Messenger client application.

DMsgrSessionEvents::OnAppNotPresent

Fires when the application requested by the invitation is not present.

DMsgrSessionManagerEvents::OnAppRegistered

Fires when a new application has been registered.

DMsgrSessionManagerEvents::OnAppShutdown

Fires when Microsoft Windows Messenger is shutting down.

DMsgrSessionManagerEvents::OnAppUnRegistered

Fires when an application has been unregistered.

DMsgrSessionEvents::OnCancelled

Fires when the session has been canceled by the inviter.

DMessengerPrivateEvents::OnContactListAdd

Notifies a Messenger client that a contact has been added to the contact list.

DMsgrSessionEvents::OnContextData

Fires when new context data has arrived.

DMsgrSessionEvents::OnDeclined

Fires when the recipient has declined the invitation.

DMsgrSessionManagerEvents::OnInvitation

Fires when a new session invitation has been received.

DMessengerPrivateEvents::OnLockChallenge

Notifies a Messenger client that an authentication challenge from a Messenger service has been received.

DMsgrSessionManagerEvents::OnLockChallenge

Notifies a Messenger client that an authentication challenge from a Messenger service has been received.

DMessengerPrivateEvents::OnLockEnable

Notifies a Messenger client with the status of the Messenger Lock and Key APIs.

DMsgrSessionManagerEvents::OnLockEnable

Notifies a Messenger client with the status of the Messenger Lock and Key APIs.

DMessengerPrivateEvents::OnLockResult

Returns the result of a Lock and Key authentication transaction between a Messenger client and the .NET Messenger Service.

DMsgrSessionManagerEvents::OnLockResult

Returns the result of a Lock and Key authentication transaction between a Messenger client and the .NET Messenger Service.

DMsgrSessionManagerEvents::OnLockStatusChanged

Fires when the lock status changes.

DMsgrSessionEvents::OnReadyToLaunch

Fires when the session is approved to start.

DMsgrSessionEvents::OnSendError

Fires when the last operation fails when sending.

DMsgrSessionEvents::OnStateChanged

Fires when the session state has changed from the previous state.

DMsgrSessionEvents::OnTermination

Fires when the session has ended.

Interfaces

IMessengerPrivate

The IMessengerPrivate interface is a Messenger service

IMsgrLock

The IMsgrLock interface implements an API that is used to unlock Licensed Messenger objects.

IMsgrSession

The IMsgrSession interface provides programmatic access to the MsgrSession object.

IMsgrSessionManager

The IMsgrSessionManager interface is a Messenger service

Objects

MessengerPriv

The Messenger service

MsgrSession

The Messenger client session object.

MsgrSessionManager

The Messenger client session manager object.