Messenger Plus! Live - Scripting Documentation

ToastCallbackTemplate is a template showing how to define an event handler for a "click" event happening in a toast created with MsgPlus::DisplayToast or MsgPlus::DisplayToastContact. The handler can have any function name and many different handlers can be defined for toasts.

Syntax

ToastCallbackTemplate(
    [var] Param
);

Parameters

Param
[var] Parameter specified in CallbackParam when the toast was created.

Return Value

No value has to be returned by this event.

Remarks

The handler is never called if the user does not click on the toast before it disappears.

Example

A toast is displayed with the following call:

MsgPlus.DisplayToast("", "Something happened!\nClick for more information.", "",
                     "OnSomethingHappenedClick", 42);

When the user clicks on the toast, the event is handled by the following handler.

function OnSomethingHappenedClick(Param)
{
	Debug.Trace("The toast was clicked. Parameter: " + Param);
}

Event Information

Event Source Messenger Plus!
Availability Messenger Plus! Live 4.00

See Also

Messenger Plus! Events, MsgPlus::DisplayToast, MsgPlus::DisplayToastContact.