Stickies

The following is description of each of the events which your application may be sent, once it's registered with Stickies for events. Some you may want to ignore, others you may need to process.

Text in <angle brackets> is a parameter - it will change according to the current state of Stickies.

500 created desktop sticky <reason> <uniqueid>

A desktop sticky with the specified unique id has been created, for the specified reason

Remarks

The unique id identifies a sticky which has just been created on the desktop. It will now be visible to the user, and can be queried for additional values by the API. The basic source of this message is that a user has created a new note. However, it will also be generated whenever any activity causes a new sticky to appear - loading Stickies, copying an existing one, an attached sticky appearing and so on.

The reason given explains why the sticky has been created. It will be one of the following values:


welcome
loaded
imported
network
new
waking
attached
undeleted
woken
unattached
unstored
copied
fromppc

501 closed desktop sticky <reason> <uniqueid>

The specified desktop sticky has been closed

Remarks

The sticky has been closed, and is now in the Closed stickies list. It is no longer be accessible on the desktop to the user, or to the API.

The reason given explains why the sticky has been closed. It will be one of the following values:


closed
exiting
unattached
stored
topalm
network
email
movetofile
slept
toppc

502 deleted desktop sticky <uniqueid>

The specified sticky has been deleted from the desktop

Remarks

This command indicates that the sticky has been permanently removed from the desktop. One cause of this is that the user has shift-deleted it, or perhaps that they store no closed stickies, but it may also mean that the sticky has been sent to sleep, moved to file, or stored. The event means that it is gone, and has not been added to the Closed list of stickies. The sticky is no longer available on the desktop to the user, or to the API.

503 stickies is exiting

Stickies is terminating

Remarks

Stickies is terminating. No more communication will be possible until it is restarted. If your application was registered, it will need to re-register for events when Stickies is running again.

504 custom Stickies command: <command>

A custom menu command was clicked on the Stickies task-tray menu

Remarks

The custom command string which this event contains details which of the custom commands, added with the "do stickymenuadd" command above the user has clicked. Your application should check that the command is one which it needs to respond to, as any command clicked in Stickies will cause this event to be sent to all registered API clients.

505 custom sticky command: <command> <uniqueid>

A custom menu command was clicked on a sticky right-click menu

Remarks

The custom command string which this event contains details which of the custom commands, added with the "do stickiesmenuadd" command above the user has clicked. Your application should check that the command is one which it needs to respond to, as any command clicked in Stickies will cause this event to be sent to all registered API clients. The unique id identifies which sticky the user has selected, and clicked this menu item on.

506 desktop sticky focus <uniqueid>

The user clicked the mouse into a desktop sticky

Remarks

Used to identify the currently selected sticky - this event is sent when any desktop sticky gains input focus.