diff -r ec3f1313ae92 -r 641b65b14318 org.symbian.tools.wrttools.previewer/wrt.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/org.symbian.tools.wrttools.previewer/wrt.xml Wed Jan 20 16:51:26 2010 -0800 @@ -0,0 +1,2847 @@ + + + + + + The widget engine provides a set of system information (SystemInfo) API services. The SystemInfo Service API allows a widget to access a device's properties and to control certain device features. The API is implemented in a plug-in module and it is integrated into the WRT environment. + To use the SystemInfo APIs, each widget must load the plug-in module explicitly by defining the following HTML code in its main HTML document + + + + + + The widget object is a built-in JavaScript object in the widget engine. + + + + + + + + + + + + + + This is a read-only property that returns an integer indicating the current battery level. + The returned value is in the range of 0 to 100 as a percentage of the maximum battery level. + + + + + + + + The onshow property is an event handler for the event of when a widget is switching from the background to the foreground. In other words, when an opened widget gains focus, the assigned callback function will be called. + + + + + + + + + + The onhide property is an event handler for the event of when a widget is switching from the foreground to the background. In other words, when a running widget loses focus, the assigned callback function will be called. + + + + + + + + + + + isrotationsupported is a read-only property that returns a Boolean value determining if the device supports landscape and portrait screen orientations. + If the value is true, the device supports both landscape and portrait screen orientations. + + + + + + + + + + + + + + + + + The openURL method opens a specified link in the Web Browser for S60 in the stand-alone mode. The widget remains open but is sent to the background. + + + A compact string specifying a link to a resource to be opened. The URL string format is compliant with the RFC-1738 specification and must be encoded if it contains non-ASCII characters. + + + + + + + + + + + The setPreferenceForKey method allows a key to be stored along with its associated preference. The arguments are like name and value pairs. The preference value for the key is stored persistently, so if the widget or device is restarted, the value is retained. However, the values stored by a widget are removed when a widget is uninstalled from the device. This includes the case when a widget is reinstalled; where the old widget is uninstalled, the new widget is installed. + An existing preference can be overwritten with a new value by simply calling the method with the same key and new value. + + + + A short text string defined as the name of the preference to be stored. + + + A compact string specifying a link to a resource to be opened. The URL string format is compliant with the RFC-1738 specification and must be encoded if it contains non-ASCII characters. + + + + + + + + + + + + The preferenceForKey method allows a previously stored preference to be restored. + + + + A text string specifying the name that represents the preference to be restored. + + + + + + + + + + + + + The widget's view is composed by HTML elements such as text display area, buttons, edit fields, and so on. The appearance of these HTML elements can be dynamically changed. For example, they can be shown or hidden dynamically using the HTML DOM style object to set the display property to "block" or "none" respectively. + + + A text string defining a desired transition mode. Currently the only supported transition mode is "fade", which causes the widget's view changing in fading mode. + + + + + + + + + + + + + The performTransition method operates as a screen update command, which tells the widget UI framework to update the widget screen. It performs the animation while the widget's view is being changed. Currently, only fading animation mode is supported. + + + + + + + + + + The navigation mode in a widget can be toggled between a cursor and a tabbed navigation mode. By default, the browsing mode of a widget is set to use a cursor (pointer). The setNavigationEnabled method is used for changing the widget's navigation mode. + The argument navigationType is of Boolean type and can be set to true or false to toggle the navigation mode between the cursor mode and the tab mode respectively. + + + + Set to true to enable the cursor navigation mode, and set to false to enable the tabbed navigation mode. + + + + + + + + + + + + + The setDisplayLandscape method changes the orientation of a widget's screen to the landscape mode. + + + + + + + + The openApplication method enables a widget to launch an S60 mobile application in the stand-alone mode. + + + + + A hexadecimal number that specifies the UID of the S60 application to be activated. See the table below for example application UIDs. + + + + A text string defining a possible argument string that is accepted by the S60 application to be activated. + + + + + + + + + + + + + + The setDisplayPortrait method changes the orientation of a widget's screen to the portrait mode. + + + + + + + + + + + The menu object is supported since WRT version 1.0. + + + + + + + + + The menu object is a built-in object in the widget engine. It is extended from the window object to + provide widget-specific APIs for manipulating widget's options menu and softkeys. + The menu object can be accessed via the window object window.menu or just simply menu. Thus, in the + WRT environment, the term menu is a reserved keyword and should not be used as a user-defined global + variable name for other type of objects. + A widget's options menu can be constructed using the menu object. The options menu is automatically + associated with the device's left softkey and it cannot be reassigned to associate with another + softkey (for example, the right softkey). The label of the options menu (the left softkey) is the + system-defined term in the current used system language (for example, Options for English). + Thus, the left softkey label cannot be changed. + + + + + + + + + + + The onShow property of the menu object is an event handler for the event of when the options menu is open. In other words, when the end user presses the left softkey, the system will fire an event and a widget can catch the event by providing a callback function. + + + + + + + + + + + + + + + Call the append method to add a menu item to the top level of the options menu list. + Menu items are shown on the options menu list in the order in which they are appended. + For more general information on constructing an options menu. + + + + This is an instance of the MenuItem object which is being added to the top level of the options menu + + + + + + + + + + + + + + Call the remove method to remove a menu item from the top level of the options menu list. If the removed menu item has a cascading submenu in it, the submenu will also be removed. + + + + This is an instance of the MenuItem object which is being removed from the top level of the options menu list. + + + + + + + + + + + + + Call the getMenuItemById method with a specified menu item's identifier to retrieve the handle of the menu item instance. + + + + This is the identifier of an existing menu item whose handle is being retrieved. + + + + + + + + + + + + + Call the getMenuItemByName method with a specified menu item's label to retrieve the handle of the menu item instance. + + + + This is the identifier of an existing menu item whose handle is being retrieved. + + + + + + + + + + + + + Call the setRightSoftkeyLabel method to customize the label and the operation associated with the right softkey. + By default, the right softkey of a device is assigned to the "Exit" function, which terminates a running widget. The default label depends on the current used system language (Exit for English). + + + + A text string specifies the label to be shown on the right softkey. + + + + A reference to the callback function, which will be called by the system when the right softkey is pressed. + + + + + + + + + + + + + Call the showSoftkeys method to display the softkey pane at all times. + By default, the device's softkey pane is hidden. The softkey pane is shown either by programmatically calling the showSoftkeys method or when the end user presses one of the softkeys. + + + + + + + + + + + Call the hideSoftkeys method to hide the softkey pane. + By default, the device's softkey pane is hidden. The softkey pane is shown automatically when the end user presses one of the softkeys. + + + + + + + + + + + Call the clear method to delete all the menu items in the options menu pane. This operation will also clear all submenus if such exist + + + + + + + + + + + + The MenuItem object is supported since WRT version 1.0. + + + + + + + + + Creates a new instance of an Enumerator object. + + + + + + + A text string that defines the label for the menu item. + + + A unique integer that identifies the menu item. + + + + + + + + + + + + The onSelect property of the MenuItem object is an event handler for the event of when the menu item is selected. In other words, when the end user opens the options menu and selects a menu item either from the top-level menu list or from a submenu list, the system will fire an event and a widget can catch the event by providing a callback function. + + + + + + + + + + + + + Call the append method to add a child menu item to the parent menu item in the options menu list. This results in the creation of a submenu list in the menu tree. Use this method to create a cascading submenu when needed. + Menu items are shown on the options menu list in the order in which they are appended. + + + + This is an instance of the MenuItem object which is being added to the parent menu item. See also the menu.append method description for instructions on how to append a menu item to the top level of the options menu list. + + + + + + + + + + + + + Call the remove method to remove a child menu item and its children (if any) from the parent menu item. + + + + This is an instance of the MenuItem object which is being removed from the parent menu item. See also the menu.remove method description for instructions on how to remove a menu item from the top level of the options menu list. + + + + + + + + + + + + + Call the setDimmed method to show or hide an existing menu item. By default, a menu item is shown when it is appended to the options menu. + + + + true to show the menu item, and false to hide the menu item. + + + + + + + + + + + + + + + + + + + + + + + Each key represents one piece of contact information, such as first name, last name, home phone number, or email address. For each contact, GetList returns as many keys as has been defined for that contact. + + + + + + + + + + + Label + + + + + + + + + Value + + + + + + + + + FirstName + + + + + + + + + LastName + + + + + + + + + + + + + + + + Item + + + + + + + + + + + CalendarName + + + + + + + + + LocalId + + + + + + + + + InstanceStartTime + + + + + + + + + + + Unique identifier of the contact. + + + + + + + + + Each key represents one piece of contact information, such as first name, last name, home phone number, or email address. For each contact, GetList returns as many keys as has been defined for that contact. + + + + + + + + + Name of the group. + + + + + + + + + Contains the IDs of the contacts that belong to the group. + + + + + + + + + URI of the database. + + + + + + + + + + + AppManager: + Contains a unique ID for the application binary (EXE or DLL). + + + + + + + + + AppManager: + Contains the path of the application. For example, c:\sys\bin\calculator.exe. + + + + + + + + + AppManager: + Contains the title of the application. + + + + + + + + + AppManager: + Contains the short title of the application. For example, the short caption may be displayed beneath an icon on the mobile device. + + + + + + + + + AppManager: + Contains the name of the application. For example, the package name may be displayed in a menu on the mobile device. + + + + + + + + + AppManager: + Contains the version of the application. The version consists of two parts: Major, Minor. + For example, 1.01, where 1 is the major part and .02 is the minor part. + + + + + + + + + AppManager: + Contains the vendor of the application. + + + + + + + + + AppManager: + Contains the drive where the application is installed. + + + + + + + + + + + + + + + Iterator + + + + + + + + + + + + + + + + reset + + + + + + + + + + + + + + + + getNext + + + + + + + + + + + + + + + + result + + + + + + + + + + + + Return value + + + + + + + + + This is a number that specifies a predefined error code. + + + + + + + + + This is a text string that describes the error. + + + + + + + + + This is a number used as an identification to match transactions started with an asynchronous call to one or more calls it generates to callback. This is only valid for Asynchronous invocations. + + + + + + + + + + + + + + + + This Service API allows widgets to: + + <ul> + <li>access, create, and manage calendars/calendar entries,</li> + <li>access and manage information about contacts,</li> + <li>access and manage information about landmarks and landmark categories,</li> + <li>add, read, and delete logging events such as call logs, messaging logs, and so forth,</li> + <li>retrieve information (metadata) about the media files stored in the Media Gallery of a device.</li> + </ul> + + + To use the <code>IDataSource</code> Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + + + Use <code>Service.Calendar</code> or <code>Service.Contact</code> or <code>Service.Landmarks</code> or <code>Service.Logging</code> or <code>Service.MediaManagement</code> to identify the service provider and <code>IDataSource</code> to identify the supported interface: + + + <pre>var so = device.getServiceObject("Service.Calendar", "IDataSource");</pre> + + + + + + + + + + + + + + + + Calendar: + The <code>GetList</code> method retrieves a list of available calendars or calendar entries. Calendar entries are retrieved from the specified calendar or, if no calendar is specified, from the default one. + This is a synchronous method. + + Contacts: + The <code>GetList</code> method retrieves a list of contacts, contact groups, or contacts databases. Contacts and contact groups are retrieved from the specified contacts database or, if no database is specified, from the default one. + This method can be called both synchronously and asynchronously. + + Note: Calls that retrieve a list of databases must always be synchronous. + + Landmarks: + The <code>GetList</code> method retrieves information about landmarks, landmark categories, or landmark databases. Landmarks and landmark categories are retrieved from the specified landmark database or, if no database is specified, from the default one. + This method can be called both synchronously and asynchronously. + + Note: For retrieving information about databases, only synchronous GetList is supported. + + Logging: + The <code>GetList</code> method retrieves an iterable list of entries from the log event database. The database contains two types of entries, log entries (all entries) and recent log entries (a subset of all log entries). + This method can be called both synchronously and asynchronously. + + Media Management: + The <code>GetList</code> method retrieves a list of media information objects from the Media Gallery of the S60 device. Each object contains information about a single media file. + This is an asynchronous method. + + + + + + This is an object that specifies what type of calendar/location/landmark/log event information is returned and how the returned information is sorted. + + + + + + The callback argument is the name of the method that is executed when an asynchronous GetList call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + Calendar: + The <code>Add</code> method creates a new calendar on the device or adds an entry to a calendar. In the latter case, if an entry with the same LocalId already exists in the calendar, it is modified accordingly. You can thus use this method to both add and update calendar entries. The entry is added to the specified calendar or, if no calendar is specified, to the default one. If the default calendar does not exist, it is created. + This is a synchronous method. + + Contact: + The <code>Add</code> method adds a contact or contact group to a contacts database. If the contact or contact group already exists in the database, it is replaced with the new entry. You can thus use this method to both add and edit contacts and contact groups. The information is added to the specified database or, if no database is specified, to the default one. If the default database does not exist, it is created. + This method can be called both synchronously and asynchronously. + + Landmarks: + The <code>Add</code> method adds a new landmark or landmark category to a landmark database. You can also use this method to edit an existing landmark or landmark category. + This is a synchronous method. + + Logging: + The <code>Add</code> method adds an event (entry) to the event log database. + This method can be called both synchronously and asynchronously. + + + + + + This is an object that specifies the calendar/contact/landmark/log to create or to add or update. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Add call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + Calendar: + The <code>Delete</code> method deletes a calendar from the device or one or more entries from a calendar. Entries are deleted from the specified calendar or, if no calendar is specified, from the default one. + For deleting a calendar, this method is called synchronously. For deleting calendar entries, this method can be called both synchronously and asynchronously. + + Contacts: + The <code>Delete</code> method deletes one or more contacts or contact groups from a contacts database. The information is deleted from the specified database or, if no database is specified, from the default one. + This method can be called both synchronously and asynchronously + + Landmark: + The <code>Delete</code> method deletes a landmark or landmark category from a landmark database. + Note: You cannot delete landmark databases. + This is a synchronous method. + + Logging: + The <code>Delete</code> method deletes an event (entry) from the event log database. + This method can be called both synchronously and asynchronously. + + + + + + This is an object that specifies which calendar/calendar entries/contacts/contact groups/landmark/landmark category/event to delete from the database. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Delete call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + Calendar: + The <code>Import</code> method imports entries into a calendar. The information must be imported from an iCal or vCal file. For more information about these two formats, see the Calendar Service overview page. + This method can be called both synchronously and asynchronously. + + Contact: + The <code>Import</code> method imports a contact to a contacts database. The information must be imported from a vCard file. + This method can be called both synchronously and asynchronously. + + Landmark: + The <code>Import</code> method imports a set of landmarks to a landmark database. + This is a synchronous method. + + + + + + + This is an object that specifies the calendar entries/contacts/landmarks to import. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Import call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + Calendar: + The <code>Export</code> method exports entries from a calendar. The information is exported to an iCal or vCal file. For more information about these two formats, see the Calendar Service overview page. + This method can be called both synchronously and asynchronously. + + Contact: + The <code>Export</code> method exports a contact from a contacts database. The information is exported to a vCard file. + This method can be called both synchronously and asynchronously + + Landmark: + The <code>Export</code> method exports a set of landmarks from a landmark database. + This is a synchronous method. + + + + + + This is an object that specifies the calendar/contacts/landmarks entries to export. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Export call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + Calendar: + The <code>RequestNotification</code> method notifies the client when entries are created, updated, or deleted in the specified calendar. If no calendar is specified, the default calendar is used. + This is an asynchronous method. + + Logging: + The <code>RequestNotification</code> method registers the widget to receive notifications of changes to the event log. + This is an asynchronous method. + + + + + + This is an object that specifies which calendar, calendar entries and event log to monitor for changes and when. + + + + + + The callback argument is the name of the method that is executed when an asynchronous 'RequestNotification' call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + Calendar: + The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Calendar Service API method. + This is a synchronous method. + + Contact: + The <code>Cancel</code> method cancels an outstanding asynchronous call made with a Contacts Service API method. + This is a synchronous method. + + LandMark: + The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Landmarks Service API method. + This is a synchronous method. + + Logging: + The <code>Cancel</code> method cancels an ongoing asynchronous call made with a Landmarks Service API method. + This is a synchronous method. + + + + + + This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the asynchronous call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. + + + + + + + + + + + + + + + + + Calendar: + The <code>Organise</code> method adds contacts to a contact group (association) or removes contacts from a contact group (disassociation). The operation is performed on the specified database or, if no database is specified, on the default one. + This method can be called both synchronously and asynchronously. + + Landmark: + The <code>Organise</code> method adds landmarks to a landmark category (association) or removes landmarks from a landmark category (disassociation). The same landmark can belong to multiple categories or to no category. + This is a synchronous method. + + + + + + This is an object that specifies which contact group/landmarks to organize and how. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Organise call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + The <code>New</code> method creates an empty landmark or landmark category item. You can use the new item as a template. + This is a synchronous method. + + + + + + This is an object that specifies the type of item to create + + + + + + + + + + + + + + + + + + + + The AppManager Service API allows widgets to access and launch applications on a mobile device. + The API is integrated with WRT through the <code>device</code> object. + To use the AppManager Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.AppManager</code> to identify the service provider and <code>IAppManager</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.AppManager", "IAppManager");</pre> + + + + + + + + + + + + + + + + The <code>GetList</code> method retrieves an iterable list of either user-installed applications or all applications on the mobile device, regardless of whether they were preinstalled or installed by the user. + This is a synchronous method. + + + + + + This is an object that specifies what information is returned about the applications on the device. + + + + + + + + + + + + + + + + The <code>Cancel</code> method cancels an outstanding asynchronous call. + If a cancel is sent, but the asynchronous call has already been completed, then <code>result.Errorcode</code> is set to 0 (success). + This is a synchronous method. + + + + + + This is an object with the <code>TransactionID</code> property (number). + <code>criteria.TransactionID</code> specifies the transaction ID of the asynchronous call to cancel. + The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. + + + + + + + + + + + + + + + + + The <code>LaunchApp</code> method launches an application based on a unique ID for the application (UID). + It also provides a way to open a specific document (by specifying a document path), even if it is not the default file type for the application being launched. + For example, you can specify a path to a document with a .txt extension to open in WordPad, even though Notepad is the default application for .txt files. + The application can be launched as chained (embedded) or stand-alone. + + This method can be called both synchronously and asynchronously. + + + + + + + The criteria object specifies the application to launch. + The criteria object has three main properties: ApplicationID, CmdLine, and Options + + + + + + The callback argument is the name of the method that is executed when an asynchronous LaunchApp call has status information to return. You must define this method separately. + This argument is used only with an asynchronous LaunchApp call. + + + + + + + + + + + + + + + + + + The <code>LaunchDoc</code> method launches an application based on a given document. + This method automatically determines which application to launch for the specified document. + The application can be launched as chained (embedded) or stand-alone. + + This method can be called both synchronously and asynchronously. + + + + + + + This is an object that specifies which application to launch. + + + + + + The callback argument is the name of the method that is executed when an asynchronous LaunchDoc call has status information to return. You must define this method separately. + This argument is used only with an asynchronous LaunchDoc call. + + + + + + + + + + + + + + + + + + + The Messaging Service API allows widgets to send, retrieve, and manage messages using the Messaging Center of a device. + The API is integrated into WRT through the <code>device</code> object. + + To use the Messaging Service API, your widget must first createa service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.Messaging</code> to identify the service provider and <code>IMessaging</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.Messaging", "IMessaging");</pre> + + + + + + + + + + + + + + + + + The <code>GetList</code> method retrieves a list of messaging objects from the Messaging Center of the S60 device. + Each object contains messaging information, that is, header and content data for a single message. + This is a synchronous method. + The criteria object specifies what messaging information is returned and how the returned information is sorted. + The GetList method returns an object that contains the requested messaging information, an error code, and an error message. + To access information about individual messages, iterate through the list of objects contained in ReturnValue attribute of the returned object. + + + + + + This is an object that specifies the search criteria. + + + + + + + + + + + + + + + + + The <code>RegisterNotification</code> method registers the widget to receive notifications of new incoming messages. + For each new message, the method returns the header information of that message. + This is an asynchronous method. + + + <pre>result = so.IMessaging.RegisterNotification(criteria, callback);</pre> + + + Criteria object that specifies the request for notification of new messages. + The object must contain the Type property (string), and this property must contain the value <code>NewMessage</code>. + The callback argument is the name of the method that is executed when <code>RegisterNotification</code> has results or status information to return. + You must define this method separately. + The <code>RegisterNotification</code> method returns an object that contains the initial return value for the asynchronous call it started. + The actual notification information is returned by the callback method in the ReturnValue property of its result object. + <code>RegisterNotification</code> retrieves new message updates until cancelled with <code>CancelNotification</code> (or <code>Cancel</code>). + You can therefore have only one <code>RegisterNotification</code> call (one instance) pending or in use at any given time. + + + + + + + Criteria object specifies the type and details of the message to send. + + + + + The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + The <code>CancelNotification</code> method cancels notification of new incoming messages. + This is a synchronous method. + + + <pre>result = so.IMessaging.CancelNotification(criteria);</pre> + + + The criteria object specifies the request for cancelling notification of new messages. + The object must contain the Type property (string), and this property must contain the value <code>NewMessage</code>. + The <code>CancelNotification</code> method returns an object that contains an error code and an error message. + + + + + + + The criteria object specifies the request for cancelling notification of new messages. The object must contain the Type property (string), and this property must contain the value "NewMessage". + + + + + + + + + + + + + + + + + The <code>Send</code> method sends an SMS or MMS message. + This method can be called both synchronously and asynchronously. + + + + For synchronous calls: + + + <pre>result = so.IMessaging.Send(criteria);</pre> + + + For asynchronous calls: + + + <pre>result = so.IMessaging.Send(criteria, callback);</pre> + + + Criteria object specifies the type and details of the message to send. + The callback argument is the name of the method that is executed when an asynchronous <code>Send</code> call has status information to return. + You must define this method separately. + If synchronous, the method returns an object that contains an error code and an error message. + If asynchronous, the method returns an object that contains a transaction ID for the callback instance, an error code, and an error message. + When the asynchronous call has completed, callback returns an object that contains an error code and an error message. + + + + + + + Criteria object specifies the type and details of the message to send. + + + + + The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. + + + + + + + + + + + + + + + + The <code>Cancel</code> method cancels an outstanding asynchronous <code>Send</code> or <code>RegisterNotification</code> call. + To cancel a <code>RegisterNotification</code> call, use <code>CancelNotification</code> instead, as it provides a more convenient way of doing this. + This is a synchronous method. + The criteria object has <code>TransactionID</code> property which specifies the transaction ID of the <code>Send</code> or <code>RegisterNotification</code> call to cancel. + The transaction ID is the same <code>TransactionID</code> value that was returned as part of the result of the initial call. + The <code>Cancel</code> method returns an object that contains an error code and an error message. + + + + + + The criteria object has TransactionID property which specifies the transaction ID of the Send or RegisterNotification call to cancel. The transaction ID is the same TransactionID value that was returned as part of the result of the initial call. + + + + + + + + + + + + + + + + + + The <code>ChangeStatus</code> method changes the read status of a message. + The status can be "Read", "Unread", "Replied", or "Forwarded". + This is a synchronous method. + + + <pre>result = so.IMessaging.ChangeStatus(criteria);</pre> + + + Criteria object specifies the message whose status to change and the new status. + The <code>ChangeStatus</code> method returns an object that contains an error code and an error message. + + + + + + + Criteria object specifies the message whose status to change and the new status. The ChangeStatus method returns an object that contains an error code and an error message. + + + + + + + + + + + + + + + + + + + + The <code>Delete</code> method deletes a message. + This is a synchronous method. + + + <pre>result = so.IMessaging.Delete(criteria);</pre> + + + The criteria object has <code>messageId</code> attribute that specifies the message to delete. + The <code>Delete</code> method returns an object that contains an error code and an error message. + + + + + + + The criteria object has messageId attribute that specifies the message to delete. + + + + + + + + + + + + + + + + + + The SystemInfo Service API allows widgets to access and modify system information on a device. + The API is integrated into WRT through the <code>device</code> object. + To use the SystemInfo Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.SysInfo</code> to identify the service provider and <code>ISysInfo</code> to identify the supported interface: + <pre>var so = device.getServiceObject("Service.SysInfo", "ISysInfo");</pre> + + + + + + + + + + + + + + + + + The <code>GetInfo</code> method retrieves information about a system attribute. + This method can be called both synchronously and asynchronously. + + + + + + This is an object that specifies the search criteria. + + + + + + The callback argument is the name of the method that is executed when an asynchronous Send call has status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + The <code>SetInfo</code> method modifies the value of a system attribute. + This is a synchronous method. + + + + + + This is an object that specifies the new value for the system attribute. + + + + + + + + + + + + + + + + The <code>GetNotification</code> method notifies the client when the value of a system attribute is changed. + This is an asynchronous method. + + + + + + This is an object that specifies the system attribute to monitor for changes. + + + + + + The callback argument is the name of the method that is executed when a GetNotification call has results or status information to return. + + + + + + + + + + + + + + + + + The <code>Cancel</code> method cancels an ongoing asynchronous call made with a SystemInfo Service API method. + This is a synchronous method. + + + + + + This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the asynchronous call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. + + + + + + + + + + + + + + + + The Location Service API allows widgets to retrieve information about the physical location of a device and to perform calculations based on location information. + The API is integrated into WRT through the <code>device</code> object. + + To use the Location Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.Location</code> to identify the service provider and <code>ILocation</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.Location", "ILocation");</pre> + + + + + + + + + + + + + + + + + + + The <code>GetLocation</code> method retrieves the current location of the device. + This method can be called both synchronously and asynchronously. + + + + For synchronous calls: + + <pre>result = so.ILocation.GetLocation(criteria);</pre> + + + For asynchronous calls: + + <pre>result = so.ILocation.GetLocation(criteria, callback);</pre> + + + If synchronous, the <code>GetLocation</code> method returns an object that contains the requested location information, an error code, and an error message. + If asynchronous, the <code>GetLocation</code> method returns an object that contains the initial return value for the asynchronous call it started. + The actual location information is returned by the callback method in the ReturnValue property of its result object. + The availability of specific location information depends on the underlying GPS technology. + Other factors, such as the number of satellites available for a location fix, also affect what information can be returned. + You can change the positioning system used by an S60 device from the Settings > General > Positioning > Positioning methods menu. + It takes time to retrieve the initial position fix. Subsequent requests are faster. + This criteria object specifies what type of device location information is returned and how. + The callback argument is the name of the method that is executed when an asynchronous GetLocation call has results or status information to return. + You must define this method separately. + This argument is used only with an asynchronous <code>GetLocation</code> call. + For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. + + + + + + + This is an object that specifies what type of device location information is returned and how. + + + + + The callback argument is the name of the method that is executed when an asynchronous GetLocation call has results or status information to return. You must define this method separately. This argument is used only with an asynchronous GetLocation call. + + + + + + + + + + + + + + + + + The <code>Trace</code> method retrieves periodic updates about the current location of the device based on a predefined update interval. + This is an asynchronous method. + + + <pre>result = so.ILocation.Trace(criteria, callback);</pre> + + + The <code>Trace</code> method returns an object that contains the initial return value for the asynchronous call it started. + The actual location information is returned by the callback method in the ReturnValue property of its result object. + + + + <code>Trace</code> retrieves location updates until cancelled with <code>CancelNotification</code>. + You can therefore have only one <code>Trace</code> call (one instance) pending or in use at any given time. + The availability of specific location information depends on the underlying GPS technology. + Other factors, such as the number of satellites available for a location fix, also affect what information can be returned. + You can change the positioning system used by an S60 device from the Settings > General > Positioning > Positioning methods menu. + It takes time to retrieve the initial position fix. Subsequent requests are faster. + The criteria object specifies what type of device location information is returned and how. Note that these input properties are similar to what the GetLocation method uses. + The callback argument is the name of the method that is executed when Trace has results or status information to return. You must define this method separately. + For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. + + + + + + + This is an object that specifies what type of device location information is returned and how. Note that these input properties are similar to what the GetLocation method uses. + + + + The callback argument is the name of the method that is executed when Trace has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + The <code>Calculate</code> method performs mathematical calculations based on a source location and a target location. + This is a synchronous method. + + + <pre>result = so.ILocation.Calculate(criteria);</pre> + + + The <code>Calculate</code> method returns an object that contains the calculation results, an error code, and an error message. + The criteria object specifies the mathematical operation to perform and the input values to use in the operation. + For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. + + + + + + + This is an object that specifies the mathematical operation to perform and the input values to use in the operation. + + + + + + + + + + + + + + + + + The <code>CancelNotification</code> method cancels an outstanding asynchronous call. + This is a synchronous method. + + + <pre>result = so.ILocation.CancelNotification(criteria);</pre> + + + The criteria object specifies whether to cancel a GetLocation call or a Trace call. + The object must contain the <code>CancelRequestType</code> property (string) that is used to specify the type of call to cancel. + + + + The possible values for <code>criteria.CancelRequestType</code> are: + <ul> + <li><code>GetLocCancel</code> cancels an asynchronous <code>GetLocation</code> call.</li> + <li><code>TraceCancel</code> cancels a <code>Trace</code> call.</li> + </ul> + + + + The <code>CancelNotification</code> method returns an object that contains an error code and an error message. + For more information about the criteria and returned object properties and how to define them refer to WDL Help documentation. + + + + + + + This is an object that specifies whether to cancel a GetLocation call or a Trace call. The object must contain the CancelRequestType property (string) that is used to specify the type of call to cancel. The possible values for criteria.CancelRequestType are: "GetLocCancel" cancels an asynchronous GetLocation call. "TraceCancel" cancels a Trace call. + + + + + + + + + + + + + + + + + + + The Sensor Service API allows widgets to access data provided by the physical sensors of a device. + + + The data from a given sensor is mapped to one or more sensor channels, which the API can listen to. + The available sensors depend on the device. + + + The API is integrated into WRT through the <code>device</code> object. + + + To use the Sensor Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + + + Use <code>Service.Sensor</code> to identify the service provider and <code>ISensor</code> to identify the supported interface: + + + <pre>so = device.getServiceObject("Service.Sensor", "ISensor");</pre> + + + + + + + + + + + + + + + + + + + The <code>FindSensorChannel</code> method searches for sensor channels available on the device. + This is a synchronous method. + + + <pre>result = so.ISensor.FindSensorChannel(criteria);</pre> + + + The criteria object specifies the search criteria. + The <code>FindSensorChannel</code> method returns an object that contains the requested sensor channel information, an error code, and an error message. + + + + + + + This is an object that specifies the search criteria. + + + + + + + + + + + + + + + + + + + The <code>RegisterForNotification</code> method registers the client to receive data from one sensor channel. + This is an asynchronous method. + + + <pre>result = so.ISensor.RegisterForNotification(criteria, callback);</pre> + + + The <code>RegisterForNotification</code> method returns an object that contains the initial return value for the asynchronous call it started. + The actual sensor data is returned by the callback method in the ReturnValue property of its result object. + + + + + + + This is an object that specifies the sensor channel to listen for data. + + + + + The callback argument is the name of the method that is executed when a RegisterForNotification call has results or status information to return. You must define this method separately. + + + + + + + + + + + + + + + + + The <code>Cancel</code> method stops an ongoing <code>RegisterForNotification</code> call. + This is a synchronous method. + + + <pre>result = so.ISensor.Cancel(criteria);</pre> + + + The criteria object has the <code>TransactionID</code> property which specifies the transaction ID of the <code>RegisterForNotification</code> call to cancel. + The transaction ID is the value that was returned as part of the result of the initial call. + The <code>Cancel</code> method returns an object that contains an error code and an error message. + + + + + + + This is an object with the TransactionID property (number). criteria.TransactionID specifies the transaction ID of the RegisterForNotification call to cancel. The transaction ID is the result.TransactionID value that was returned as part of the result of the initial call. + + + + + + + + + + + + + + + + + The <code>GetChannelProperty</code> method retrieves information about a sensor channel property. + This is a synchronous method. + + + <pre>result = so.ISensor.GetChannelProperty(criteria);</pre> + + + This is an object that specifies which sensor channel property to retrieve information about. + The <code>GetChannelProperty</code> method returns an object that contains the requested channel property information, an error code, and an error message. + + + + + + + + This is an object that specifies which sensor channel property to retrieve information about. + + + + + + + + + + + + + + + + + Service Object + + + + + + + + + Service Object + + + + + + + + + + + + + + + This Service API allows widgets to: + + <ul> + <li>access, create, and manage calendars/calendar entries,</li> + <li>access and manage information about contacts,</li> + <li>access and manage information about landmarks and landmark categories,</li> + <li>add, read, and delete logging events such as call logs, messaging logs, and so forth,</li> + <li>retrieve information (metadata) about the media files stored in the Media Gallery of a device.</li> + </ul> + + + To use the <code>IDataSource</code> Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + + + Use <code>Service.Calendar</code> or <code>Service.Contact</code> or <code>Service.Landmarks</code> or <code>Service.Logging</code> or <code>Service.MediaManagement</code> to identify the service provider and <code>IDataSource</code> to identify the supported interface: + + + <pre>var so = device.getServiceObject("Service.Calendar", "IDataSource");</pre> + + + + + + + + + The AppManager Service API allows widgets to access and launch applications on a mobile device. + The API is integrated with WRT through the <code>device</code> object. + To use the AppManager Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.AppManager</code> to identify the service provider and <code>IAppManager</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.AppManager", "IAppManager");</pre> + + + + + + + + + The Messaging Service API allows widgets to send, retrieve, and manage messages using the Messaging Center of a device. + The API is integrated into WRT through the <code>device</code> object. + + To use the Messaging Service API, your widget must first createa service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.Messaging</code> to identify the service provider and <code>IMessaging</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.Messaging", "IMessaging");</pre> + + + + + + + + + + The SystemInfo Service API allows widgets to access and modify system information on a device. + The API is integrated into WRT through the <code>device</code> object. + To use the SystemInfo Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.SysInfo</code> to identify the service provider and <code>ISysInfo</code> to identify the supported interface: + <pre>var so = device.getServiceObject("Service.SysInfo", "ISysInfo");</pre> + + + + + + + + + The Location Service API allows widgets to retrieve information about the physical location of a device and to perform calculations based on location information. + The API is integrated into WRT through the <code>device</code> object. + + To use the Location Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.Location</code> to identify the service provider and <code>ILocation</code> to identify the supported interface: + + <pre>var so = device.getServiceObject("Service.Location", "ILocation");</pre> + + + + + + + + + + The Sensor Service API allows widgets to access data provided by the physical sensors of a device. + The data from a given sensor is mapped to one or more sensor channels, which the API can listen to. + The available sensors depend on the device. + The API is integrated into WRT through the <code>device</code> object. + To use the Sensor Service API, your widget must first create a service object for it using the <code>device.getServiceObject()</code> method. + Use <code>Service.Sensor</code> to identify the service provider and <code>ISensor</code> to identify the supported interface: + + <pre>so = device.getServiceObject("Service.Sensor", "ISensor");</pre> + + + + + + + + + + + + + + + The <code>device</code> object is a built-in JavaScript object in the widget engine. + It was introduced in WRT 1.1 to allow widgets access to S60 Platform Services through Service APIs. + The <code>device</code> object is used to create service objects for specific Service APIs. + These service objects can then be used to access the services made available through the Service APIs. + + + + + + + + + + + The <code>device</code> object is a built-in JavaScript object in the widget engine. + It was introduced in WRT 1.1 to allow widgets access to S60 Platform Services through Service APIs. + The <code>device</code> object is used to create service objects for specific Service APIs. + These service objects can then be used to access the services made available through the Service APIs. + + + + + + + + + + + + + + + + + + + + + The <code>getServiceObject</code> method creates an object that is used to access the services made available through a Service API. + This object is referred to as a service object. + + + + + + + + + + + + + + + + + + + + This is a text string that defines the service provider name, that is, the name of the type of service object to create. + Possible values : "Service.AppManager", + "Service.SysInfo", + "Service.Sensor", + "Service.Messaging", + "Service.MediaManagement", + "Service.Logging", + "Service.Location", + "Service.Calendar", + "Service.Contact" + + + + + + + This is a text string that defines the supported interface for the specified service provider. + Possible values : "IAppManager", + "ISysInfo", + "ISensor", + "IMessaging", + "IDataSource", + "ILocation" + + + + + + + + + + + + + + + + + + + The following example creates a service object for the Media Management Service API: + + + <pre>var so = device.getServiceObject("Service.MediaManagement", "IDataSource");</pre> + + + + + + + + +