Windows Messenger Service Reference

[Windows Messenger Service Reference may be altered or unavailable in subsequent versions of the operating system or product.]

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

New applications should not use this set of interfaces. These interfaces exist for backward compatibility with legacy applications. These interfaces will be unavailable in the future.

Applications cannot connect to Microsoft .NET Messenger Service 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.

Events

OnAlertReceived

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

OnContactListAdd

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

OnLockChallenge

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

OnLockEnable

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

OnLockResult

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

BeforeAppLaunch

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

OnAccepted

Fires when the recipient has accepted the invitation.

OnAppNotPresent

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

OnCancelled

Fires when the session has been canceled by the inviter.

OnContextData

Fires when new context data has arrived.

OnDeclined

Fires when the recipient has declined the invitation.

OnReadyToLaunch

Fires when the session is approved to start.

OnSendError

Fires when the last operation fails when sending.

OnStateChanged

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

OnTermination

Fires when the session has ended.

OnAppRegistered

Fires when a new application has been registered.

OnAppShutdown

Fires when Windows Messenger is shutting down.

OnAppUnRegistered

Fires when an application has been unregistered.

OnInvitation

Fires when a new session invitation has been received.

OnLockChallenge

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

OnLockEnable

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

OnLockResult

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

OnLockStatusChanged

Fires when the lock status changes.

 

DispInterfaces

DMessengerPrivateEvents

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

DMsgrSessionEvents

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

DMsgrSessionManagerEvents

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

 

Interfaces

IMessengerPrivate

Do not use. The IMessengerPrivate interface is a Messenger service  API that provides programmatic access to the MessengerPriv object.

IMsgrLock

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

IMsgrSession

Do not use. The IMsgrSession interface provides programmatic access to the MsgrSession object.

IMsgrSessionManager

Do not use. The IMsgrSessionManager interface is a Messenger service  API that provides programmatic access to the MsgrSessionManager object.

 

Objects

MessengerPriv

Do not use. The Messenger service  MessengerPriv object.

MsgrSession

Do not use. The Messenger client session object.

MsgrSessionManager

Do not use. The Messenger client session manager object.

 

Enums

LockError

Do not use. Provides a list of Lock and Key error status codes.

LockStatus

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

SESSION_STATE

Do not use. Provides the list of possible state codes of the session invitation.

SESSION_FLAGS

Do not use. Provides the list of possible flag codes for the session invitation.

SESSION_RESULT

Do not use. Provides the list of possible result codes of the session invitation.

 

 

 

Send comments about this topic to Microsoft

Build date: 6/30/2010

Show: