Widget.setMetadata()

Availability

Flash Player 7 + TheSpringBox v1.1.4

Usage

Widget.setMetadata(metadataObject:String) : Void;

Parameters

metadataObject - An object containing the Metadata of your widgets.

Returns

Nothing.

Description

Method; On the first frame of the widget you are required to set the Metadata of your widget. The object has a property for every piece of metadata:

version: String. This is the version number that will be used to check for updates. It is recommended that the number be in the format e.g. 1.3.12.

description: String. Briefly describe your widget.

author: String. Your name.

requiresInternetConnectivity: Boolean. Indicated whether or not the widget requires an internet connection to function.

Once this object is set your widget will now have "About this Widget" in the Right-Click menu.

Example

The following example shows how you sould set the Metadata of your widget.

var meta:Object = {};
meta.version = "1.2.3";
meta.description = "This widget displays XML Feeds from the internet.";
meta.author = "FIMLabs";
meta.requiresInternetConnectivity = true;

Widget.setMetadata(metaobj);