WidgetAvenue

WidgetPublisher:Custom Preferences

You can define preference names to be used with your widget and stored by the host platforms when available.

Declaration

In order to declare a preference, you just need to add a parameter to the URL of the standalone version of the widget. See the Parameters page.

Naming restrictions

Names of parameters used by WidgetPublisher should not be used.Addtionally, some names used by host platforms should not be used, including the following names:

  • type

Naming conventions

The following conventions are used:

  • if the preference name starts with "_", the preference is not displayed by the host platform and not editable by the user
  • if the preference name ends with "_", the preference value is not retained when the user installs the widget to another platform. This is particularly useful for passwords.

Storage

When the host platform allows storage of preferences, the custom preferences that you have defined are stored on the host platform.

Also, when the host platform allows to edit the preferences of the widget (for example iGoogle and Netvibes), the custom preferences are editable this way, except those starting with a _.

Transmission

When a user moves a widget from a host platform to another one, the latest preferences stored on the origin platform are transmitted to the destination platform, except those ending with a _.