</Module>
<Module name="MediaServer" id="::MediaServer">
<webidl> module MediaServer {
- [NoInterfaceObject] interface MediaServerManagerObject {
- readonly attribute <ref>MediaServerManager</ref> mediaserver;
+[NoInterfaceObject]
+interface MediaContainer : <ref>MediaObject</ref> {
+ readonly attribute unsigned long? childCount;
+ readonly attribute boolean canCreateContainer;
+ readonly attribute boolean canDelete;
+ readonly attribute boolean canUpload;
+ readonly attribute boolean canRename;
+ <ref>Promise</ref> upload (DOMString title, DOMString path);
+ <ref>Promise</ref> createFolder (DOMString title);
};
<ref>Navigator</ref> implements <ref>MediaServerManagerObject</ref>;
-[NoInterfaceObject] interface MediaServerManager {
- void scanNetwork(<ref>MediaServerFoundServerCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
+[NoInterfaceObject]
+interface Navigator {
+ readonly attribute <ref>MediaServerManager</ref> mediaServer;
};
-[NoInterfaceObject] interface MediaServer {
- readonly attribute DOMString id;
- readonly attribute DOMString friendlyName;
- readonly attribute object root;
-
- void browse(DOMString containerId, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
- void find(DOMString containerId, DOMString searchFilter, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
+[NoInterfaceObject]
+interface MediaServerManager {
+ void scanNetwork();
+ attribute <ref>EventHandler</ref> onserverfound;
+ attribute <ref>EventHandler</ref> onserverlost;
};
-[NoInterfaceObject] interface MediaServerError {
- const unsigned short GENERIC = 1;
- attribute unsigned short code;
- attribute DOMString message;
+interface MediaServerEvent : <ref>Event</ref> {
+ readonly attribute <ref>MediaServer</ref> server;
};
-[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerFoundServerCallback {
- void onsuccess(<ref>MediaServer</ref> value);
+interface MediaServerIdEvent : <ref>Event</ref> {
+ readonly attribute DOMString id;
};
-[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerBrowseFindCallback {
- void onsuccess(sequence< object > value);
+[NoInterfaceObject]
+interface MediaServer {
+ readonly attribute DOMString id;
+ readonly attribute DOMString friendlyName;
+ readonly attribute DOMString? manufacturer;
+ readonly attribute DOMString? manufacturerURL;
+ readonly attribute DOMString? modelDescription;
+ readonly attribute DOMString? modelName;
+ readonly attribute DOMString? modelNumber;
+ readonly attribute DOMString? serialNumber;
+ readonly attribute DOMString? UDN;
+ readonly attribute DOMString? presentationURL;
+ readonly attribute DOMString? iconURL;
+ readonly attribute DOMString? deviceType;
+ readonly attribute <ref>MediaContainer</ref>? root;
+ readonly attribute boolean canCreateContainer;
+ readonly attribute boolean canUpload;
+ readonly attribute DOMString[] searchAttrs;
+ readonly attribute DOMString[] sortAttrs;
+ <ref>Promise</ref> upload (DOMString path);
+ <ref>Promise</ref> browse(DOMString containerId, DOMString? sortMode, unsigned long? count, unsigned long? offset);
+ <ref>Promise</ref> find(DOMString containerId, DOMString searchFilter, DOMString? sortMode, unsigned long? count, unsigned long? offset);
+ <ref>Promise</ref> cancel ();
+ attribute <ref>EventHandler</ref> oncontainerchanged;
+
};
-[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerErrorCallback {
- void onfailure(<ref>MediaServerError</ref> error);
+interface MediaContainerIdEvent : <ref>Event</ref> {
+ readonly attribute DOMString id;
};</webidl>
- <Interface name="MediaServerManagerObject" id="::MediaServerManagerObject">
- <webidl>[NoInterfaceObject] interface MediaServerManagerObject {
- readonly attribute <ref>MediaServerManager</ref> mediaserver;
+ <Interface name="MediaContainer" id="::MediaContainer">
+ <webidl>[NoInterfaceObject]
+interface MediaContainer : <ref>MediaObject</ref> {
+ readonly attribute unsigned long? childCount;
+ readonly attribute boolean canCreateContainer;
+ readonly attribute boolean canDelete;
+ readonly attribute boolean canUpload;
+ readonly attribute boolean canRename;
+ <ref>Promise</ref> upload (DOMString title, DOMString path);
+ <ref>Promise</ref> createFolder (DOMString title);
};</webidl>
<ExtendedAttributeList>
<ExtendedAttribute name="NoInterfaceObject">
<webidl>NoInterfaceObject</webidl>
</ExtendedAttribute>
</ExtendedAttributeList>
- <Attribute readonly="readonly" name="mediaserver" id="::MediaServerManagerObject::mediaserver">
- <webidl> readonly attribute <ref>MediaServerManager</ref> mediaserver;</webidl>
- <Type name="MediaServerManager"/>
+ <InterfaceInheritance>
+ <Name name="MediaObject"/>
+ </InterfaceInheritance>
+ <Attribute readonly="readonly" name="childCount" id="::MediaContainer::childCount">
+ <webidl> readonly attribute unsigned long? childCount;</webidl>
+ <Type type="unsigned long" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canCreateContainer" id="::MediaContainer::canCreateContainer">
+ <webidl> readonly attribute boolean canCreateContainer;</webidl>
+ <Type type="boolean"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canDelete" id="::MediaContainer::canDelete">
+ <webidl> readonly attribute boolean canDelete;</webidl>
+ <Type type="boolean"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canUpload" id="::MediaContainer::canUpload">
+ <webidl> readonly attribute boolean canUpload;</webidl>
+ <Type type="boolean"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canRename" id="::MediaContainer::canRename">
+ <webidl> readonly attribute boolean canRename;</webidl>
+ <Type type="boolean"/>
</Attribute>
+ <Operation name="upload" id="::MediaContainer::upload">
+ <webidl> <ref>Promise</ref> upload (DOMString title, DOMString path);</webidl>
+ <Type name="Promise"/>
+ <ArgumentList>
+ <Argument name="title">
+ <Type type="DOMString"/>
+ </Argument>
+ <Argument name="path">
+ <Type type="DOMString"/>
+ </Argument>
+ </ArgumentList>
+ </Operation>
+ <Operation name="createFolder" id="::MediaContainer::createFolder">
+ <webidl> <ref>Promise</ref> createFolder (DOMString title);</webidl>
+ <Type name="Promise"/>
+ <ArgumentList>
+ <Argument name="title">
+ <Type type="DOMString"/>
+ </Argument>
+ </ArgumentList>
+ </Operation>
</Interface>
<Implements name1="Navigator" name2="MediaServerManagerObject">
<webidl><ref>Navigator</ref> implements <ref>MediaServerManagerObject</ref>;</webidl>
</Implements>
+ <Interface name="Navigator" id="::Navigator">
+ <webidl>[NoInterfaceObject]
+interface Navigator {
+ readonly attribute <ref>MediaServerManager</ref> mediaServer;
+};</webidl>
+ <ExtendedAttributeList>
+ <ExtendedAttribute name="NoInterfaceObject">
+ <webidl>NoInterfaceObject</webidl>
+ </ExtendedAttribute>
+ </ExtendedAttributeList>
+ <Attribute readonly="readonly" name="mediaServer" id="::Navigator::mediaServer">
+ <webidl> readonly attribute <ref>MediaServerManager</ref> mediaServer;</webidl>
+ <Type name="MediaServerManager"/>
+ </Attribute>
+ </Interface>
<Interface name="MediaServerManager" id="::MediaServerManager">
- <webidl>[NoInterfaceObject] interface MediaServerManager {
- void scanNetwork(<ref>MediaServerFoundServerCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
+ <webidl>[NoInterfaceObject]
+interface MediaServerManager {
+ void scanNetwork();
+ attribute <ref>EventHandler</ref> onserverfound;
+ attribute <ref>EventHandler</ref> onserverlost;
};</webidl>
<ExtendedAttributeList>
<ExtendedAttribute name="NoInterfaceObject">
</ExtendedAttribute>
</ExtendedAttributeList>
<Operation name="scanNetwork" id="::MediaServerManager::scanNetwork">
- <webidl> void scanNetwork(<ref>MediaServerFoundServerCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);</webidl>
+ <webidl> void scanNetwork();</webidl>
<Type type="void"/>
- <ArgumentList>
- <Argument name="successCallback">
- <Type name="MediaServerFoundServerCallback"/>
- </Argument>
- <Argument optional="optional" name="errorCallback">
- <Type name="MediaServerErrorCallback"/>
- </Argument>
- </ArgumentList>
+ <ArgumentList/>
</Operation>
+ <Attribute name="onserverfound" id="::MediaServerManager::onserverfound">
+ <webidl> attribute <ref>EventHandler</ref> onserverfound;</webidl>
+ <Type name="EventHandler"/>
+ </Attribute>
+ <Attribute name="onserverlost" id="::MediaServerManager::onserverlost">
+ <webidl> attribute <ref>EventHandler</ref> onserverlost;</webidl>
+ <Type name="EventHandler"/>
+ </Attribute>
+ </Interface>
+ <Interface name="MediaServerEvent" id="::MediaServerEvent">
+ <webidl>interface MediaServerEvent : <ref>Event</ref> {
+ readonly attribute <ref>MediaServer</ref> server;
+};</webidl>
+ <InterfaceInheritance>
+ <Name name="Event"/>
+ </InterfaceInheritance>
+ <Attribute readonly="readonly" name="server" id="::MediaServerEvent::server">
+ <webidl> readonly attribute <ref>MediaServer</ref> server;</webidl>
+ <Type name="MediaServer"/>
+ </Attribute>
+ </Interface>
+ <Interface name="MediaServerIdEvent" id="::MediaServerIdEvent">
+ <webidl>interface MediaServerIdEvent : <ref>Event</ref> {
+ readonly attribute DOMString id;
+};</webidl>
+ <InterfaceInheritance>
+ <Name name="Event"/>
+ </InterfaceInheritance>
+ <Attribute readonly="readonly" name="id" id="::MediaServerIdEvent::id">
+ <webidl> readonly attribute DOMString id;</webidl>
+ <Type type="DOMString"/>
+ </Attribute>
</Interface>
<Interface name="MediaServer" id="::MediaServer">
- <webidl>[NoInterfaceObject] interface MediaServer {
- readonly attribute DOMString id;
- readonly attribute DOMString friendlyName;
- readonly attribute object root;
-
- void browse(DOMString containerId, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
- void find(DOMString containerId, DOMString searchFilter, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);
+ <webidl>[NoInterfaceObject]
+interface MediaServer {
+ readonly attribute DOMString id;
+ readonly attribute DOMString friendlyName;
+ readonly attribute DOMString? manufacturer;
+ readonly attribute DOMString? manufacturerURL;
+ readonly attribute DOMString? modelDescription;
+ readonly attribute DOMString? modelName;
+ readonly attribute DOMString? modelNumber;
+ readonly attribute DOMString? serialNumber;
+ readonly attribute DOMString? UDN;
+ readonly attribute DOMString? presentationURL;
+ readonly attribute DOMString? iconURL;
+ readonly attribute DOMString? deviceType;
+ readonly attribute <ref>MediaContainer</ref>? root;
+ readonly attribute boolean canCreateContainer;
+ readonly attribute boolean canUpload;
+ readonly attribute DOMString[] searchAttrs;
+ readonly attribute DOMString[] sortAttrs;
+ <ref>Promise</ref> upload (DOMString path);
+ <ref>Promise</ref> browse(DOMString containerId, DOMString? sortMode, unsigned long? count, unsigned long? offset);
+ <ref>Promise</ref> find(DOMString containerId, DOMString searchFilter, DOMString? sortMode, unsigned long? count, unsigned long? offset);
+ <ref>Promise</ref> cancel ();
+ attribute <ref>EventHandler</ref> oncontainerchanged;
+
};</webidl>
<ExtendedAttributeList>
<ExtendedAttribute name="NoInterfaceObject">
</ExtendedAttribute>
</ExtendedAttributeList>
<Attribute readonly="readonly" name="id" id="::MediaServer::id">
- <webidl> readonly attribute DOMString id;</webidl>
+ <webidl> readonly attribute DOMString id;</webidl>
<Type type="DOMString"/>
</Attribute>
<Attribute readonly="readonly" name="friendlyName" id="::MediaServer::friendlyName">
- <webidl> readonly attribute DOMString friendlyName;</webidl>
+ <webidl> readonly attribute DOMString friendlyName;</webidl>
<Type type="DOMString"/>
</Attribute>
+ <Attribute readonly="readonly" name="manufacturer" id="::MediaServer::manufacturer">
+ <webidl> readonly attribute DOMString? manufacturer;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="manufacturerURL" id="::MediaServer::manufacturerURL">
+ <webidl> readonly attribute DOMString? manufacturerURL;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="modelDescription" id="::MediaServer::modelDescription">
+ <webidl> readonly attribute DOMString? modelDescription;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="modelName" id="::MediaServer::modelName">
+ <webidl> readonly attribute DOMString? modelName;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="modelNumber" id="::MediaServer::modelNumber">
+ <webidl> readonly attribute DOMString? modelNumber;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="serialNumber" id="::MediaServer::serialNumber">
+ <webidl> readonly attribute DOMString? serialNumber;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="UDN" id="::MediaServer::UDN">
+ <webidl> readonly attribute DOMString? UDN;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="presentationURL" id="::MediaServer::presentationURL">
+ <webidl> readonly attribute DOMString? presentationURL;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="iconURL" id="::MediaServer::iconURL">
+ <webidl> readonly attribute DOMString? iconURL;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="deviceType" id="::MediaServer::deviceType">
+ <webidl> readonly attribute DOMString? deviceType;</webidl>
+ <Type type="DOMString" nullable="nullable"/>
+ </Attribute>
<Attribute readonly="readonly" name="root" id="::MediaServer::root">
- <webidl> readonly attribute object root;</webidl>
- <Type type="object"/>
+ <webidl> readonly attribute <ref>MediaContainer</ref>? root;</webidl>
+ <Type name="MediaContainer" nullable="nullable"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canCreateContainer" id="::MediaServer::canCreateContainer">
+ <webidl> readonly attribute boolean canCreateContainer;</webidl>
+ <Type type="boolean"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="canUpload" id="::MediaServer::canUpload">
+ <webidl> readonly attribute boolean canUpload;</webidl>
+ <Type type="boolean"/>
+ </Attribute>
+ <Attribute readonly="readonly" name="searchAttrs" id="::MediaServer::searchAttrs">
+ <webidl> readonly attribute DOMString[] searchAttrs;</webidl>
+ <Type type="array">
+ <Type type="DOMString"/>
+ </Type>
+ </Attribute>
+ <Attribute readonly="readonly" name="sortAttrs" id="::MediaServer::sortAttrs">
+ <webidl> readonly attribute DOMString[] sortAttrs;</webidl>
+ <Type type="array">
+ <Type type="DOMString"/>
+ </Type>
</Attribute>
+ <Operation name="upload" id="::MediaServer::upload">
+ <webidl> <ref>Promise</ref> upload (DOMString path);</webidl>
+ <Type name="Promise"/>
+ <ArgumentList>
+ <Argument name="path">
+ <Type type="DOMString"/>
+ </Argument>
+ </ArgumentList>
+ </Operation>
<Operation name="browse" id="::MediaServer::browse">
- <webidl> void browse(DOMString containerId, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);</webidl>
- <Type type="void"/>
+ <webidl> <ref>Promise</ref> browse(DOMString containerId, DOMString? sortMode, unsigned long? count, unsigned long? offset);</webidl>
+ <Type name="Promise"/>
<ArgumentList>
<Argument name="containerId">
<Type type="DOMString"/>
</Argument>
<Argument name="sortMode">
- <Type type="DOMString"/>
+ <Type type="DOMString" nullable="nullable"/>
</Argument>
<Argument name="count">
- <Type type="unsigned long"/>
+ <Type type="unsigned long" nullable="nullable"/>
</Argument>
<Argument name="offset">
- <Type type="unsigned long"/>
- </Argument>
- <Argument name="successCallback">
- <Type name="MediaServerBrowseFindCallback"/>
- </Argument>
- <Argument optional="optional" name="errorCallback">
- <Type name="MediaServerErrorCallback"/>
+ <Type type="unsigned long" nullable="nullable"/>
</Argument>
</ArgumentList>
</Operation>
<Operation name="find" id="::MediaServer::find">
- <webidl> void find(DOMString containerId, DOMString searchFilter, DOMString sortMode, unsigned long count, unsigned long offset, <ref>MediaServerBrowseFindCallback</ref> successCallback, optional <ref>MediaServerErrorCallback</ref> errorCallback);</webidl>
- <Type type="void"/>
+ <webidl> <ref>Promise</ref> find(DOMString containerId, DOMString searchFilter, DOMString? sortMode, unsigned long? count, unsigned long? offset);</webidl>
+ <Type name="Promise"/>
<ArgumentList>
<Argument name="containerId">
<Type type="DOMString"/>
<Type type="DOMString"/>
</Argument>
<Argument name="sortMode">
- <Type type="DOMString"/>
+ <Type type="DOMString" nullable="nullable"/>
</Argument>
<Argument name="count">
- <Type type="unsigned long"/>
+ <Type type="unsigned long" nullable="nullable"/>
</Argument>
<Argument name="offset">
- <Type type="unsigned long"/>
- </Argument>
- <Argument name="successCallback">
- <Type name="MediaServerBrowseFindCallback"/>
- </Argument>
- <Argument optional="optional" name="errorCallback">
- <Type name="MediaServerErrorCallback"/>
+ <Type type="unsigned long" nullable="nullable"/>
</Argument>
</ArgumentList>
</Operation>
+ <Operation name="cancel" id="::MediaServer::cancel">
+ <webidl> <ref>Promise</ref> cancel ();</webidl>
+ <Type name="Promise"/>
+ <ArgumentList/>
+ </Operation>
+ <Attribute name="oncontainerchanged" id="::MediaServer::oncontainerchanged">
+ <webidl> attribute <ref>EventHandler</ref> oncontainerchanged;</webidl>
+ <Type name="EventHandler"/>
+ </Attribute>
</Interface>
- <Interface name="MediaServerError" id="::MediaServerError">
- <webidl>[NoInterfaceObject] interface MediaServerError {
- const unsigned short GENERIC = 1;
- attribute unsigned short code;
- attribute DOMString message;
+ <Interface name="MediaContainerIdEvent" id="::MediaContainerIdEvent">
+ <webidl>interface MediaContainerIdEvent : <ref>Event</ref> {
+ readonly attribute DOMString id;
};</webidl>
- <ExtendedAttributeList>
- <ExtendedAttribute name="NoInterfaceObject">
- <webidl>NoInterfaceObject</webidl>
- </ExtendedAttribute>
- </ExtendedAttributeList>
- <Const name="GENERIC" value="1" id="::MediaServerError::GENERIC">
- <webidl> const unsigned short GENERIC = 1;</webidl>
- <Type type="unsigned short"/>
- </Const>
- <Attribute name="code" id="::MediaServerError::code">
- <webidl> attribute unsigned short code;</webidl>
- <Type type="unsigned short"/>
- </Attribute>
- <Attribute name="message" id="::MediaServerError::message">
- <webidl> attribute DOMString message;</webidl>
+ <InterfaceInheritance>
+ <Name name="Event"/>
+ </InterfaceInheritance>
+ <Attribute readonly="readonly" name="id" id="::MediaContainerIdEvent::id">
+ <webidl> readonly attribute DOMString id;</webidl>
<Type type="DOMString"/>
</Attribute>
</Interface>
- <Interface name="MediaServerFoundServerCallback" id="::MediaServerFoundServerCallback">
- <webidl>[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerFoundServerCallback {
- void onsuccess(<ref>MediaServer</ref> value);
-};</webidl>
- <ExtendedAttributeList>
- <ExtendedAttribute name="Callback" value="FunctionOnly">
- <webidl>Callback</webidl>
- </ExtendedAttribute>
- <ExtendedAttribute name="NoInterfaceObject">
- <webidl> NoInterfaceObject</webidl>
- </ExtendedAttribute>
- </ExtendedAttributeList>
- <Operation name="onsuccess" id="::MediaServerFoundServerCallback::onsuccess">
- <webidl> void onsuccess(<ref>MediaServer</ref> value);</webidl>
- <Type type="void"/>
- <ArgumentList>
- <Argument name="value">
- <Type name="MediaServer"/>
- </Argument>
- </ArgumentList>
- </Operation>
- </Interface>
- <Interface name="MediaServerBrowseFindCallback" id="::MediaServerBrowseFindCallback">
- <webidl>[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerBrowseFindCallback {
- void onsuccess(sequence< object > value);
-};</webidl>
- <ExtendedAttributeList>
- <ExtendedAttribute name="Callback" value="FunctionOnly">
- <webidl>Callback</webidl>
- </ExtendedAttribute>
- <ExtendedAttribute name="NoInterfaceObject">
- <webidl> NoInterfaceObject</webidl>
- </ExtendedAttribute>
- </ExtendedAttributeList>
- <Operation name="onsuccess" id="::MediaServerBrowseFindCallback::onsuccess">
- <webidl> void onsuccess(sequence< object > value);</webidl>
- <Type type="void"/>
- <ArgumentList>
- <Argument name="value">
- <Type type="sequence">
- <Type type="object"/>
- </Type>
- </Argument>
- </ArgumentList>
- </Operation>
- </Interface>
- <Interface name="MediaServerErrorCallback" id="::MediaServerErrorCallback">
- <webidl>[Callback=FunctionOnly, NoInterfaceObject] interface MediaServerErrorCallback {
- void onfailure(<ref>MediaServerError</ref> error);
-};</webidl>
- <ExtendedAttributeList>
- <ExtendedAttribute name="Callback" value="FunctionOnly">
- <webidl>Callback</webidl>
- </ExtendedAttribute>
- <ExtendedAttribute name="NoInterfaceObject">
- <webidl> NoInterfaceObject</webidl>
- </ExtendedAttribute>
- </ExtendedAttributeList>
- <Operation name="onfailure" id="::MediaServerErrorCallback::onfailure">
- <webidl> void onfailure(<ref>MediaServerError</ref> error);</webidl>
- <Type type="void"/>
- <ArgumentList>
- <Argument name="error">
- <Type name="MediaServerError"/>
- </Argument>
- </ArgumentList>
- </Operation>
- </Interface>
</Module>
<Module name="Speech" id="::Speech">
<webidl> module Speech {
[NoInterfaceObject]
- interface SpeechManager {
+ interface SpeechManager {
void vocalizeString(DOMString speakString);
};
</Implements>
<Interface name="SpeechManager" id="::SpeechManager">
<webidl> [NoInterfaceObject]
- interface SpeechManager {
+ interface SpeechManager {
void vocalizeString(DOMString speakString);
};</webidl>
<ExtendedAttributeList>
};</webidl>
<descriptive>
<brief>
- This API provides the functionality for scheduling the system alarm.
-It allows you to run other applications and have them perform operations at the specific time.
-You can schedule an alarm to go off once or to repeat at specific intervals.
+ This API provides the functionality for scheduling the system alarm.
+It allows you to run other applications and have them perform operations at the specific time.
+You can schedule an alarm to go off once or to repeat at specific intervals.
</brief>
<description>
<p>
</p>
<p>
Once an alarm goes off, it will be removed from the alarm storage automatically.
-<em>AlarmManager</em> provides methods to manage alarms such as adding and removing.
+<em>AlarmManager</em> provides methods to manage alarms such as adding and removing.
For more information on the Alarm features, see <a href="../../org.tizen.web.appprogramming/html/guide/app_guide/alarm.htm">Alarm Guide</a>.
</p>
</description>
</brief>
<description>
<p>
-Set an alarm with the application ID to be run. You should definitely provide the application ID to run
-and the <a href=" ../../org.tizen.web.appprogramming/html/guide/app_guide/application_service.htm">application control </a>information if it is necessary.
+Set an alarm with the application ID to be run. You should definitely provide the application ID to run
+and the <a href=" ../../org.tizen.web.appprogramming/html/guide/app_guide/application_service.htm">application control </a>information if it is necessary.
For more information about the application contorl, see <a href="../../org.tizen.web.device.apireference/tizen/application.html">The Application API</a>.
</p>
</description>
<webidl> <ref>Alarm</ref>[] getAll() raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Retrieves all alarms in an application storage..
+ Retrieves all alarms in an application storage..
</brief>
<description>
<p>
</brief>
<description>
<p>
-This alarm triggers after a duration mentioned in <em>delay</em> attribute from the moment the alarm is added.
+This alarm triggers after a duration mentioned in <em>delay</em> attribute from the moment the alarm is added.
If a <em>period</em> is provided, the alarm keeps triggering for the given interval.
</p>
</description>
1.0
</version>
<Code> // Gets the current application id.
- var appId = tizen.application.getCurrentApplication().appInfo.id;
+ var appId = tizen.application.getCurrentApplication().appInfo.id;
// Sets an alarm in 3 hours from now
var alarm = new tizen.AlarmRelative(3 * tizen.alarm.PERIOD_HOUR);
tizen.alarm.add(alarm, appId);
-
+
var sec = alarm.getRemainingSeconds();
console.log("remaining time is " + sec);
</Code>
var date = new Date(2014, 0, 1, 8, 0);
var alarm1 = new tizen.AlarmAbsolute(date);
tizen.alarm.add(alarm1, appId);
-
+
var date = alarm1.getNextScheduledDate();
console.log("next scheduled time is " + date);
</Code>
<RaiseException name="WebAPIException">
<descriptive>
<description><p>
- with error type UnknownError, if the method cannot be completed because of an unknown error.
+ with error type UnknownError, if the method cannot be completed because of an unknown error.
</p></description>
</descriptive>
</RaiseException>
[NoInterfaceObject] interface ApplicationManager {
<ref>Application</ref> getCurrentApplication() raises(<ref>WebAPIException</ref>);
-
+
void kill(<ref>ApplicationContextId</ref> contextId,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void launch(<ref>ApplicationId</ref> id,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
-
+
[NoInterfaceObject] interface ApplicationCertificate {
readonly attribute DOMString type;
readonly attribute DOMString value;
};
-
+
[NoInterfaceObject] interface ApplicationMetaData {
<webidl> [NoInterfaceObject] interface ApplicationManager {
<ref>Application</ref> getCurrentApplication() raises(<ref>WebAPIException</ref>);
-
+
void kill(<ref>ApplicationContextId</ref> contextId,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void launch(<ref>ApplicationId</ref> id,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
var appId = appInfos[0].id; // select first app's id
tizen.application.launchAppControl(
- appControl,
+ appControl,
appId,
function() {console.log("launch application control succeed"); },
function(e) {console.log("launch application control failed. reason: " + e.message); },
<Type type="array">
<descriptive>
<description><p>
- ApplicationMetaData[] Array of meta data of a specified application. If there are no meta data for a specified application,
+ ApplicationMetaData[] Array of meta data of a specified application. If there are no meta data for a specified application,
empty array will be returned
</p></description>
</descriptive>
};</webidl>
<descriptive>
<brief>
- This interface defines the current application's information and
+ This interface defines the current application's information and
the basic operations (such as exit or hide) for the current application .
</brief>
<version>
};</webidl>
<descriptive>
<brief>
- This interface has an application control information requested and passed
-from other application and is passed to launch other applications. The newly
+ This interface has an application control information requested and passed
+from other application and is passed to launch other applications. The newly
launched application can get the requested application control through <em>getRequestedAppControl()</em> method, and send the results
to the calling application through the <em>replyResult()</em> method after performing the
required action requested the calling application.
<Argument optional="optional" name="data">
<descriptive>
<description><p>
- An array of ApplicationControlData objects.
+ An array of ApplicationControlData objects.
</p></description>
</descriptive>
<Type type="array" nullable="nullable">
<Module name="Bluetooth" id="::Bluetooth">
<webidl>module Bluetooth {
typedef DOMString BluetoothAddress;
-
+
typedef DOMString BluetoothUUID;
-
+
enum BluetoothSocketState { "CLOSED", "OPEN" };
enum BluetoothProfileType { "HEALTH" };
-
+
enum BluetoothHealthChannelType { "RELIABLE", "STREAMING" };
-
+
[NoInterfaceObject] interface BluetoothManagerObject {
readonly attribute <ref>BluetoothManager</ref> bluetooth;
};
[NoInterfaceObject] interface BluetoothAdapter {
readonly attribute DOMString name;
readonly attribute <ref>BluetoothAddress</ref> address;
- readonly attribute boolean powered;
+ readonly attribute boolean powered;
readonly attribute boolean visible;
void setName(DOMString name,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void setPowered(boolean state,
- optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+ optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
+
void setVisible(boolean mode,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback,
optional unsigned short? timeout) raises(<ref>WebAPIException</ref>);
void unsetChangeListener() raises(<ref>WebAPIException</ref>);
- void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
+ void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
+ void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
+ void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void getDevice(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void createBonding(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void destroyBonding(<ref>BluetoothAddress</ref> address,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void registerRFCOMMServiceByUUID(<ref>BluetoothUUID</ref> uuid,
DOMString name,
- <ref>BluetoothServiceSuccessCallback</ref> successCallback,
+ <ref>BluetoothServiceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
<ref>BluetoothProfileHandler</ref> getBluetoothProfileHandler(<ref>BluetoothProfileType</ref> profileType) raises(<ref>WebAPIException</ref>);
readonly attribute <ref>BluetoothUUID</ref>[] uuids;
void connectToServiceByUUID(<ref>BluetoothUUID</ref> uuid,
- <ref>BluetoothSocketSuccessCallback</ref> successCallback,
+ <ref>BluetoothSocketSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
[NoInterfaceObject] interface BluetoothSocket {
[NoInterfaceObject] interface BluetoothClass {
readonly attribute octet major;
-
+
readonly attribute octet minor;
-
+
readonly attribute unsigned short [] services ;
-
+
boolean hasService(unsigned short service) raises(<ref>WebAPIException</ref>);
};
[NoInterfaceObject] interface BluetoothClassDeviceService {
const unsigned short LIMITED_DISCOVERABILITY = 0x0001;
- const unsigned short POSITIONING = 0x0008;
- const unsigned short NETWORKING = 0x0010;
- const unsigned short RENDERING = 0x0020;
+ const unsigned short POSITIONING = 0x0008;
+ const unsigned short NETWORKING = 0x0010;
+ const unsigned short RENDERING = 0x0020;
const unsigned short CAPTURING = 0x0040;
- const unsigned short OBJECT_TRANSFER = 0x0080;
+ const unsigned short OBJECT_TRANSFER = 0x0080;
const unsigned short AUDIO = 0x0100;
const unsigned short TELEPHONY = 0x0200;
const unsigned short INFORMATION = 0x0400;
};
[NoInterfaceObject] interface BluetoothProfileHandler {
-
+
readonly attribute <ref>BluetoothProfileType</ref> profileType;
-
+
};
-
+
[NoInterfaceObject] interface BluetoothHealthProfileHandler : <ref>BluetoothProfileHandler</ref> {
-
+
void registerSinkApplication(unsigned short dataType, DOMString name, <ref>BluetoothHealthApplicationSuccessCallback</ref> successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void connectToSource(<ref>BluetoothDevice</ref> peer, <ref>BluetoothHealthApplication</ref> application, <ref>BluetoothHealthChannelSuccessCallback</ref> successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- };
+ };
[NoInterfaceObject] interface BluetoothHealthApplication {
readonly attribute unsigned short dataType;
-
+
readonly attribute DOMString name;
[TreatNonCallableAsNull] attribute <ref>BluetoothHealthChannelSuccessCallback</ref>? onconnect raises(<ref>WebAPIException</ref>);
-
+
void unregister(optional <ref>SuccessCallback</ref>? successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
- };
-
-
+
+ };
+
+
[NoInterfaceObject] interface BluetoothHealthChannel {
readonly attribute <ref>BluetoothDevice</ref> peer;
-
+
readonly attribute <ref>BluetoothHealthChannelType</ref> channelType;
readonly attribute <ref>BluetoothHealthApplication</ref> application;
-
+
readonly attribute boolean isConnected;
void close() raises(<ref>WebAPIException</ref>);
unsigned long sendData(byte[] data) raises(<ref>WebAPIException</ref>);
- void setListener(<ref>BluetoothHealthChannelChangeCallback</ref> listener) raises(<ref>WebAPIException</ref>);
-
+ void setListener(<ref>BluetoothHealthChannelChangeCallback</ref> listener) raises(<ref>WebAPIException</ref>);
+
void unsetListener() raises(<ref>WebAPIException</ref>);
-
+
};
-
+
[Callback, NoInterfaceObject] interface BluetoothAdapterChangeCallback {
void onstatechanged(boolean powered);
void onsuccess(<ref>BluetoothHealthApplication</ref> application);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface BluetoothHealthChannelSuccessCallback {
void onsuccess(<ref>BluetoothHealthChannel</ref> channel);
};
[Callback, NoInterfaceObject] interface BluetoothHealthChannelChangeCallback {
void onmessage(byte[] data);
-
- void onclose();
+
+ void onclose();
};
};</webidl>
<descriptive>
<description>
<p>
-To guarantee this application running on a device with Bluetooth feature, define below in the config file:
+To guarantee this application running on a device with Bluetooth feature, define below in the config file:
</p>
</description>
</descriptive>
<webidl> [NoInterfaceObject] interface BluetoothAdapter {
readonly attribute DOMString name;
readonly attribute <ref>BluetoothAddress</ref> address;
- readonly attribute boolean powered;
+ readonly attribute boolean powered;
readonly attribute boolean visible;
void setName(DOMString name,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void setPowered(boolean state,
- optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+ optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
+
void setVisible(boolean mode,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback,
optional unsigned short? timeout) raises(<ref>WebAPIException</ref>);
void unsetChangeListener() raises(<ref>WebAPIException</ref>);
- void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
+ void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
+ void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
+ void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void getDevice(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void createBonding(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void destroyBonding(<ref>BluetoothAddress</ref> address,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void registerRFCOMMServiceByUUID(<ref>BluetoothUUID</ref> uuid,
DOMString name,
- <ref>BluetoothServiceSuccessCallback</ref> successCallback,
+ <ref>BluetoothServiceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
<ref>BluetoothProfileHandler</ref> getBluetoothProfileHandler(<ref>BluetoothProfileType</ref> profileType) raises(<ref>WebAPIException</ref>);
<version>
1.0
</version>
- <Code>
+ <Code>
// Access adapter name
var adapter = tizen.bluetooth.getDefaultAdapter();
console.log ("Bluetooth adapter name: " + adapter.name);
</Attribute>
<Operation name="setName" id="::Bluetooth::BluetoothAdapter::setName">
<webidl> void setName(DOMString name,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.admin
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
- function changeName(newName)
- {
+
+ function changeName(newName)
+ {
if(adapter.name != newName) {
// initiate change name
adapter.setName(newName, function() {
</Operation>
<Operation name="setPowered" id="::Bluetooth::BluetoothAdapter::setPowered">
<webidl> void setPowered(boolean state,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.admin
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
- function powerOn()
+
+ function powerOn()
{
- // If adapter is not powered on
+ // If adapter is not powered on
if(!adapter.powered) {
// Initiates power on
adapter.setPowered(true, function() {
</Operation>
<Operation name="setVisible" id="::Bluetooth::BluetoothAdapter::setVisible">
<webidl> void setVisible(boolean mode,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback,
optional unsigned short? timeout) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
http://tizen.org/privilege/bluetoothmanager
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function showMe()
{
if (adapter.visible == false) {
//Shows device
- adapter.setVisible(true,
+ adapter.setVisible(true,
function() { console.log ('Device is visible to other devices for 3 minutes.'); },
function(e) { console.log ('Error: ' + e.message + '(' + e.name + ')'); });
}
}
}
- function hideMe()
+ function hideMe()
{
if (adapter.visible) {
// Hides device
</Raises>
</Operation>
<Operation name="discoverDevices" id="::Bluetooth::BluetoothAdapter::discoverDevices">
- <webidl> void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
+ <webidl> void discoverDevices(<ref>BluetoothDiscoverDevicesSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.gap
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function startDiscovery() {
var discoverDevicesSuccessCallback = {
- onstarted: function() {
+ onstarted: function() {
console.log ("Device discovery started...");
},
- ondevicefound: function(device) {
- console.log("Found device - name: " + device.name + ", Address: "+ device.address);
+ ondevicefound: function(device) {
+ console.log("Found device - name: " + device.name + ", Address: "+ device.address);
},
- ondevicedisappeared: function(address) {
- console.log("Device disappeared: " + address);
+ ondevicedisappeared: function(address) {
+ console.log("Device disappeared: " + address);
},
- onfinished: function(devices) {
+ onfinished: function(devices) {
console.log("Found Devices");
for (var i = 0; i < devices.length; i++) {
console.log("Name: " + devices[i].name + ", Address: " + devices[i].address);
console.log("Total: " + devices.length);
}
};
-
+
// Starts searching for nearby devices, for about 12 sec.
adapter.discoverDevices(discoverDevicesSuccessCallback, function(e){
console.log ("Failed to search devices: " + e.message + "(" + e.name + ")");
</Raises>
</Operation>
<Operation name="stopDiscovery" id="::Bluetooth::BluetoothAdapter::stopDiscovery">
- <webidl> void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
+ <webidl> void stopDiscovery(optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.gap
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
// Calls this method whenever user finds one of the device
function cancelDiscovery() {
adapter.stopDiscovery(function() {
function startDiscovery() {
var discoverDevicesSuccessCallback = {
- onstarted: function() {
+ onstarted: function() {
console.log ("Device discovery started...") ;
},
ondevicefound: function(device) {
cancelDiscovery();
},
- ondevicedisappeared: function(address) {
+ ondevicedisappeared: function(address) {
console.log("Device disappeared: " + address);
// Removes from list, as it is no longer valid.
},
- onfinished: function(devices) {
+ onfinished: function(devices) {
console.log("Found Devices");
for (var i = 0; i < devices.length; i++) {
console.log("Name: " + devices[i].name + ", Address: " + devices[i].address);
console.log("Total: " + devices.length);
}
};
-
+
// Starts searching for nearby devices, for about 12 sec.
adapter.discoverDevices(discoverDevicesSuccessCallback, function(e){
console.log ("Failed to search devices: " + e.message + "(" + e.name + ")");
</Raises>
</Operation>
<Operation name="getKnownDevices" id="::Bluetooth::BluetoothAdapter::getKnownDevices">
- <webidl> void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
+ <webidl> void getKnownDevices(<ref>BluetoothDeviceArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.gap
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function onGotDevices(devices) {
console.log("Devices");
for (var i = 0; i < devices.length; i++) {
function onBluetoothsetPowered() {
adapter.getKnownDevices(onGotDevices, onError);
}
-
+
// Turns on Bluetooth
adapter.setPowered(true, onBluetoothsetPowered);
</Code>
</Operation>
<Operation name="getDevice" id="::Bluetooth::BluetoothAdapter::getDevice">
<webidl> void getDevice(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
</brief>
<description>
<p>
-This method returns device information stored in the local Bluetooth adapter for the specified device <em>address</em> through
+This method returns device information stored in the local Bluetooth adapter for the specified device <em>address</em> through
BluetoothDeviceSuccessCallback.
A valid hardware address must be passed, such as "35:F4:59:D1:7A:03".
</p>
</Operation>
<Operation name="createBonding" id="::Bluetooth::BluetoothAdapter::createBonding">
<webidl> void createBonding(<ref>BluetoothAddress</ref> address,
- <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
+ <ref>BluetoothDeviceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
</Operation>
<Operation name="destroyBonding" id="::Bluetooth::BluetoothAdapter::destroyBonding">
<webidl> void destroyBonding(<ref>BluetoothAddress</ref> address,
- optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
http://tizen.org/privilege/bluetooth.gap
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function gotDevice(device) {
if (device.isBonded) {
// Initiates destroying bonding
- adapter.destroyBonding(device.address, function() {
+ adapter.destroyBonding(device.address, function() {
console.log("Succeeded to destroy the bond success with:" + device.address);
},
- function(e) {
- console.log("Failed to destroy the bond with " + device.address + ", reason: " + e.message);
+ function(e) {
+ console.log("Failed to destroy the bond with " + device.address + ", reason: " + e.message);
});
}
}
var deviceAddress = "35:F4:59:D1:7A:03";
- adapter.getDevice(deviceAddress, gotDevice, function(e) {
- console.log("Failed to get device info for " + deviceAddress + ", reason: " + e.message);
+ adapter.getDevice(deviceAddress, gotDevice, function(e) {
+ console.log("Failed to get device info for " + deviceAddress + ", reason: " + e.message);
} );
</Code>
</descriptive>
<Operation name="registerRFCOMMServiceByUUID" id="::Bluetooth::BluetoothAdapter::registerRFCOMMServiceByUUID">
<webidl> void registerRFCOMMServiceByUUID(<ref>BluetoothUUID</ref> uuid,
DOMString name,
- <ref>BluetoothServiceSuccessCallback</ref> successCallback,
+ <ref>BluetoothServiceSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
</brief>
<description>
<p>
-On success of the service registration, it returns a <em>BluetoothServiceHandler</em> object as the first parameter of <em>successCallback</em>, and listens for client connections.
+On success of the service registration, it returns a <em>BluetoothServiceHandler</em> object as the first parameter of <em>successCallback</em>, and listens for client connections.
The service handler can be used to be notified on client connections or to unregister the service.
User interaction is mandatory to connect to a registered service.
</p>
socket.onmessage = function() {
var data = socket.readData();
// Handles message code goes here
-
+
};
-
+
socket.onclose = function() {
console.log('The socket is closed.');
serviceSocket = null;
console.log( "Could not register service record, Error: " + e.message);
});
}
-
+
function unregisterChatService()
{
if (chatServiceHandler != null) {
readonly attribute <ref>BluetoothUUID</ref>[] uuids;
void connectToServiceByUUID(<ref>BluetoothUUID</ref> uuid,
- <ref>BluetoothSocketSuccessCallback</ref> successCallback,
+ <ref>BluetoothSocketSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
</Attribute>
<Operation name="connectToServiceByUUID" id="::Bluetooth::BluetoothDevice::connectToServiceByUUID">
<webidl> void connectToServiceByUUID(<ref>BluetoothUUID</ref> uuid,
- <ref>BluetoothSocketSuccessCallback</ref> successCallback,
+ <ref>BluetoothSocketSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
<privilege>
http://tizen.org/privilege/bluetooth.spp
</privilege>
- <Code>
+ <Code>
var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function onSocketConnected(socket) {
console.log ("Opened connection to remote device");
socket.onmessage = function () {
with error type NotSupportedError, if this feature is not supported.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
with error type NotSupportedError, if this feature is not supported.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
<Interface name="BluetoothClass" id="::Bluetooth::BluetoothClass">
<webidl> [NoInterfaceObject] interface BluetoothClass {
readonly attribute octet major;
-
+
readonly attribute octet minor;
-
+
readonly attribute unsigned short [] services ;
-
+
boolean hasService(unsigned short service) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
Zero or more <b>Major Service Classes</b>(bits 13-23) - Represents the services supported by the device. </li>
</ul>
<p>
-The Major and Minor classes are intended to define a general family of devices with which any particular implementation wishes to be associated.
+The Major and Minor classes are intended to define a general family of devices with which any particular implementation wishes to be associated.
No assumptions should be made about specific functionality or characteristics of any application, based solely on the assignment of a Major or minor device class.
</p>
</description>
1.0
</version>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
-
+
function evaluateDevice(address) {
adapter.getDevice(address, function(device) {
if (device.deviceClass.major == tizen.bluetooth.deviceMajor.COMPUTER) {
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
<Interface name="BluetoothClassDeviceService" id="::Bluetooth::BluetoothClassDeviceService">
<webidl> [NoInterfaceObject] interface BluetoothClassDeviceService {
const unsigned short LIMITED_DISCOVERABILITY = 0x0001;
- const unsigned short POSITIONING = 0x0008;
- const unsigned short NETWORKING = 0x0010;
- const unsigned short RENDERING = 0x0020;
+ const unsigned short POSITIONING = 0x0008;
+ const unsigned short NETWORKING = 0x0010;
+ const unsigned short RENDERING = 0x0020;
const unsigned short CAPTURING = 0x0040;
- const unsigned short OBJECT_TRANSFER = 0x0080;
+ const unsigned short OBJECT_TRANSFER = 0x0080;
const unsigned short AUDIO = 0x0100;
const unsigned short TELEPHONY = 0x0200;
const unsigned short INFORMATION = 0x0400;
</Interface>
<Interface name="BluetoothProfileHandler" id="::Bluetooth::BluetoothProfileHandler">
<webidl> [NoInterfaceObject] interface BluetoothProfileHandler {
-
+
readonly attribute <ref>BluetoothProfileType</ref> profileType;
-
+
};</webidl>
<descriptive>
<brief>
</Interface>
<Interface name="BluetoothHealthProfileHandler" id="::Bluetooth::BluetoothHealthProfileHandler">
<webidl> [NoInterfaceObject] interface BluetoothHealthProfileHandler : <ref>BluetoothProfileHandler</ref> {
-
+
void registerSinkApplication(unsigned short dataType, DOMString name, <ref>BluetoothHealthApplicationSuccessCallback</ref> successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
void connectToSource(<ref>BluetoothDevice</ref> peer, <ref>BluetoothHealthApplication</ref> application, <ref>BluetoothHealthChannelSuccessCallback</ref> successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
<descriptive>
<brief>
This interface represents the handler of Bluetooth health device profile.
-The BluetoothHealthProfileHandler object is created by <em>BluetoothAdapter.getBluetoothProfileHandler()</em>.
+The BluetoothHealthProfileHandler object is created by <em>BluetoothAdapter.getBluetoothProfileHandler()</em>.
</brief>
<version>
2.2
<Argument name="dataType">
<descriptive>
<description><p>
- The MDEP data type used for communication, which is referenced in the ISO/IEEE 11073-20601 spec. For example, pulse oximeter is 4100 and blood pressure monitor is 4103.
+ The MDEP data type used for communication, which is referenced in the ISO/IEEE 11073-20601 spec. For example, pulse oximeter is 4100 and blood pressure monitor is 4103.
</p></description>
</descriptive>
<Type type="unsigned short"/>
function healthConnectSuccess(channel) {
console.log("Health device is connected");
}
-
+
function healthConnectError(e) {
console.log("Failed to connect to source: " + e.message);
};
-
+
function gotDeviceInfo(device) {
healthProfileHandler.connectToSource(device, registerHealthApp, healthConnectSuccess, healthConnectError);
}
-
+
function healthRegisterSuccess(app) {
console.log("Registered application: " + app.name);
registerHealthApp = app;
<Argument name="peer">
<descriptive>
<description><p>
- The remote device which acts as the Source role.
+ The remote device which acts as the Source role.
</p></description>
</descriptive>
<Type name="BluetoothDevice"/>
<webidl> [NoInterfaceObject] interface BluetoothHealthApplication {
readonly attribute unsigned short dataType;
-
+
readonly attribute DOMString name;
[TreatNonCallableAsNull] attribute <ref>BluetoothHealthChannelSuccessCallback</ref>? onconnect raises(<ref>WebAPIException</ref>);
-
+
void unregister(optional <ref>SuccessCallback</ref>? successCallback, optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
};</webidl>
<descriptive>
<brief>
<webidl> [NoInterfaceObject] interface BluetoothHealthChannel {
readonly attribute <ref>BluetoothDevice</ref> peer;
-
+
readonly attribute <ref>BluetoothHealthChannelType</ref> channelType;
readonly attribute <ref>BluetoothHealthApplication</ref> application;
-
+
readonly attribute boolean isConnected;
void close() raises(<ref>WebAPIException</ref>);
unsigned long sendData(byte[] data) raises(<ref>WebAPIException</ref>);
- void setListener(<ref>BluetoothHealthChannelChangeCallback</ref> listener) raises(<ref>WebAPIException</ref>);
-
+ void setListener(<ref>BluetoothHealthChannelChangeCallback</ref> listener) raises(<ref>WebAPIException</ref>);
+
void unsetListener() raises(<ref>WebAPIException</ref>);
-
+
};</webidl>
<descriptive>
<brief>
</privilege>
<Code> var adapter = tizen.bluetooth.getDefaultAdapter();
var healthProfileHandler = adapter.getBluetoothProfileHandler("HEALTH");
-
+
function healthRegisterSuccess(app) {
console.log("Registered application: " + app.name);
app.onconnect = function(channel) {;
<Interface name="BluetoothHealthChannelChangeCallback" id="::Bluetooth::BluetoothHealthChannelChangeCallback">
<webidl> [Callback, NoInterfaceObject] interface BluetoothHealthChannelChangeCallback {
void onmessage(byte[] data);
-
- void onclose();
+
+ void onclose();
};</webidl>
<descriptive>
<brief>
</brief>
<description>
<p>
-For more information on the Bookmark features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/bookmark.htm">Bookmark Guide</a>.
+For more information on the Bookmark features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/bookmark.htm">Bookmark Guide</a>.
</p>
</description>
<version>
<Module name="Calendar" id="::Calendar">
<webidl>module Calendar {
typedef DOMString CalendarId;
-
+
typedef DOMString CalendarTaskId;
-
+
typedef (<ref>CalendarEventId</ref> or <ref>CalendarTaskId</ref>) CalendarItemId;
-
+
enum CalendarType { "EVENT", "TASK" };
-
+
enum CalendarTextFormat { "ICALENDAR_20", "VCALENDAR_10" };
-
+
enum AlarmMethod { "SOUND", "DISPLAY" };
-
-
+
+
enum RecurrenceRuleFrequency { "DAILY", "WEEKLY", "MONTHLY", "YEARLY" };
-
+
enum ByDayValue { "MO", "TU", "WE", "TH", "FR", "SA", "SU" };
-
+
enum EventAvailability { "BUSY", "FREE" };
-
+
enum AttendeeType { "INDIVIDUAL", "GROUP", "RESOURCE", "ROOM", "UNKNOWN" };
-
+
enum AttendeeStatus { "PENDING", "ACCEPTED", "DECLINED", "TENTATIVE", "DELEGATED", "COMPLETED", "IN_PROCESS" };
-
+
enum AttendeeRole { "REQ_PARTICIPANT", "OPT_PARTICIPANT", "NON_PARTICIPANT", "CHAIR" };
-
+
enum CalendarItemPriority { "HIGH", "MEDIUM", "LOW" };
-
+
enum CalendarItemVisibility { "PUBLIC", "PRIVATE", "CONFIDENTIAL" };
-
+
enum CalendarItemStatus { "TENTATIVE", "CONFIRMED", "CANCELLED", "NEEDS_ACTION", "IN_PROCESS", "COMPLETED" };
-
+
[NoInterfaceObject] interface CalendarManagerObject{
- readonly attribute <ref>CalendarManager</ref> calendar;
+ readonly attribute <ref>CalendarManager</ref> calendar;
};
- <ref>Tizen</ref> implements <ref>CalendarManagerObject</ref>;
+ <ref>Tizen</ref> implements <ref>CalendarManagerObject</ref>;
[NoInterfaceObject] interface CalendarManager {
void getCalendars(<ref>CalendarType</ref> type,
<ref>Calendar</ref> getUnifiedCalendar(<ref>CalendarType</ref> type) raises(<ref>WebAPIException</ref>);
<ref>Calendar</ref> getDefaultCalendar(<ref>CalendarType</ref> type) raises(<ref>WebAPIException</ref>);
-
+
<ref>Calendar</ref> getCalendar(<ref>CalendarType</ref> type, <ref>CalendarId</ref> id) raises(<ref>WebAPIException</ref>);
};
[NoInterfaceObject] interface Calendar {
-
+
readonly attribute <ref>CalendarId</ref> id;
readonly attribute DOMString name;
-
+
<ref>CalendarItem</ref> get(<ref>CalendarItemId</ref> id) raises(<ref>WebAPIException</ref>);
void add(<ref>CalendarItem</ref> item) raises(<ref>WebAPIException</ref>);
void removeBatch(<ref>CalendarItemId</ref>[] ids,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void find(<ref>CalendarItemArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback,
optional <ref>AbstractFilter</ref>? filter,
optional <ref>SortMode</ref>? sortMode) raises(<ref>WebAPIException</ref>);
-
+
long addChangeListener(<ref>CalendarChangeCallback</ref> successCallback) raises(<ref>WebAPIException</ref>);
-
+
void removeChangeListener(long watchId) raises(<ref>WebAPIException</ref>);
};
-
+
dictionary CalendarItemInit {
DOMString description;
DOMString summary;
DOMString[] categories;
<ref>CalendarAttendee</ref>[] attendees;
};
-
+
dictionary CalendarTaskInit: <ref>CalendarItemInit</ref> {
<ref>TZDate</ref> dueDate;
<ref>TZDate</ref> completedDate;
<ref>EventAvailability</ref> availability;
<ref>CalendarRecurrenceRule</ref> recurrenceRule;
};
-
+
[NoInterfaceObject] interface CalendarItem {
readonly attribute <ref>CalendarItemId</ref>? id;
readonly attribute <ref>CalendarId</ref>? calendarId;
readonly attribute <ref>TZDate</ref>? lastModificationDate;
-
+
attribute DOMString? description setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? summary setraises(<ref>WebAPIException</ref>);
-
+
attribute boolean isAllDay setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TZDate</ref>? startDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TimeDuration</ref>? duration setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? location setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>SimpleCoordinates</ref>? geolocation setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? organizer setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemVisibility</ref> visibility setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemStatus</ref> status setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemPriority</ref> priority setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarAlarm</ref>[] alarms setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString[] categories setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarAttendee</ref>[] attendees setraises(<ref>WebAPIException</ref>);
-
+
DOMString convertToString(<ref>CalendarTextFormat</ref> format) raises(<ref>WebAPIException</ref>);
<ref>CalendarItem</ref> clone() raises(<ref>WebAPIException</ref>);
};
-
+
[Constructor(optional <ref>CalendarTaskInit</ref>? taskInitDict),
Constructor(DOMString stringRepresentation, <ref>CalendarTextFormat</ref> format)]
interface CalendarTask : <ref>CalendarItem</ref> {
attribute <ref>TZDate</ref>? dueDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TZDate</ref>? completedDate setraises(<ref>WebAPIException</ref>);
-
+
attribute unsigned short progress setraises(<ref>WebAPIException</ref>);
};
Constructor(DOMString stringRepresentation, <ref>CalendarTextFormat</ref> format)]
interface CalendarEvent : <ref>CalendarItem</ref> {
readonly attribute boolean isDetached;
-
+
attribute <ref>TZDate</ref>? endDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>EventAvailability</ref> availability setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarRecurrenceRule</ref>? recurrenceRule setraises(<ref>WebAPIException</ref>);
-
+
void expandRecurrence(<ref>TZDate</ref> startDate,
<ref>TZDate</ref> endDate,
<ref>CalendarEventArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
-
+
dictionary CalendarAttendeeInit {
DOMString name;
<ref>AttendeeRole</ref> role;
interface CalendarAttendee
{
attribute DOMString uri;
-
+
attribute DOMString? name;
-
+
attribute <ref>AttendeeRole</ref> role;
-
+
attribute <ref>AttendeeStatus</ref> status;
-
+
attribute boolean RSVP;
-
+
attribute <ref>AttendeeType</ref> type;
-
+
attribute DOMString? group;
-
+
attribute DOMString? delegatorURI;
-
+
attribute DOMString? delegateURI;
-
+
attribute <ref>ContactRef</ref>? contactRef;
};
-
+
dictionary CalendarRecurrenceRuleInit {
short interval;
<ref>TZDate</ref> untilDate;
short[] setPositions;
<ref>TZDate</ref>[] exceptions;
};
-
+
[Constructor(<ref>RecurrenceRuleFrequency</ref> frequency, optional <ref>CalendarRecurrenceRuleInit</ref>? ruleInitDict)]
interface CalendarRecurrenceRule
- {
+ {
attribute <ref>RecurrenceRuleFrequency</ref> frequency;
-
+
attribute unsigned short interval;
-
+
attribute <ref>TZDate</ref>? untilDate;
-
+
attribute long occurrenceCount;
-
+
attribute <ref>ByDayValue</ref>[] daysOfTheWeek;
-
+
attribute short[] setPositions;
-
+
attribute <ref>TZDate</ref>[] exceptions;
};
-
+
[Constructor(DOMString uid, optional DOMString? rid)]
interface CalendarEventId {
attribute DOMString uid;
-
+
attribute DOMString? rid;
};
-
+
[Constructor(<ref>TZDate</ref> absoluteDate, <ref>AlarmMethod</ref> method, optional DOMString? description),
Constructor(<ref>TimeDuration</ref> before, <ref>AlarmMethod</ref> method, optional DOMString? description)]
interface CalendarAlarm {
attribute <ref>TZDate</ref>? absoluteDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TimeDuration</ref>? before setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>AlarmMethod</ref> method setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? description;
};
interface CalendarEventArraySuccessCallback {
void onsuccess(<ref>CalendarEvent</ref>[] events);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject]
interface CalendarItemArraySuccessCallback {
void onsuccess(<ref>CalendarItem</ref>[] items);
interface CalendarArraySuccessCallback {
void onsuccess(<ref>Calendar</ref>[] calendars);
};
-
+
[Callback, NoInterfaceObject] interface CalendarChangeCallback {
void onitemsadded(<ref>CalendarItem</ref>[] items);
-
+
void onitemsupdated(<ref>CalendarItem</ref>[] items);
-
+
void onitemsremoved(<ref>CalendarItemId</ref>[] ids);
};
};</webidl>
<descriptive>
<brief>
- This API provides interfaces and methods for users to manage their schedule.
+ This API provides interfaces and methods for users to manage their schedule.
Separate calendars can be implemented for group related events or tasks. For example, a user may have a work, personal, and family calendar. A calendar entry is called an event and is composed of a series of attributes, such as purpose, starting time, and duration. A calendar is a collection of events.
</brief>
<description>
<p>
-Internet Calendaring and Scheduling Core Object Specification (iCalendar), defines a format for exchanging event items. Mapping to specified event/task attributes in this API is as per this specification. To know more about this specification, see <a href="http://tools.ietf.org/html/rfc5545">RFC 5545</a>.
+Internet Calendaring and Scheduling Core Object Specification (iCalendar), defines a format for exchanging event items. Mapping to specified event/task attributes in this API is as per this specification. To know more about this specification, see <a href="http://tools.ietf.org/html/rfc5545">RFC 5545</a>.
</p>
<p>
This API provides functionality to read, create, delete, and update items in specific calendars. Calendars can be obtained using the <em>getCalendars() </em>method, which returns an array of Calendar objects.
</p>
<p>
-For more information on the Calendar features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/calendar.htm">Calendar Guide</a>.
+For more information on the Calendar features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/calendar.htm">Calendar Guide</a>.
</p>
</description>
<version>
</Enum>
<Interface name="CalendarManagerObject" id="::Calendar::CalendarManagerObject">
<webidl> [NoInterfaceObject] interface CalendarManagerObject{
- readonly attribute <ref>CalendarManager</ref> calendar;
+ readonly attribute <ref>CalendarManager</ref> calendar;
};</webidl>
<descriptive>
<brief>
- This interface gives access to the Calendar API from the <em>tizen.calendar </em>object.
+ This interface gives access to the Calendar API from the <em>tizen.calendar </em>object.
</brief>
<version>
1.0
<ref>Calendar</ref> getUnifiedCalendar(<ref>CalendarType</ref> type) raises(<ref>WebAPIException</ref>);
<ref>Calendar</ref> getDefaultCalendar(<ref>CalendarType</ref> type) raises(<ref>WebAPIException</ref>);
-
+
<ref>Calendar</ref> getCalendar(<ref>CalendarType</ref> type, <ref>CalendarId</ref> id) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<brief>
- This interface provides methods to access calendars and attributes for calendars.
-Once a calendar object is obtained, it is possible to add, remove, or update the information it contains through the Calendar interface methods.
+ This interface provides methods to access calendars and attributes for calendars.
+Once a calendar object is obtained, it is possible to add, remove, or update the information it contains through the Calendar interface methods.
</brief>
<version>
1.0
function eventFoundCallback(events) {
// The event has been successfully found
// Changes the summary
- events[0].summary = 'HTML6 Webinar';
+ events[0].summary = 'HTML6 Webinar';
calendar.update(events[0]);
console.log('First event was updated!');
}
console.log('The calendar id is ' + calendar.id + ' and name ' + calendar.name);
var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
- summary:'HTML5 Webinar',
- startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
+ summary:'HTML5 Webinar',
+ startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
duration: new tizen.TimeDuration(1, "HOURS"),
location:'Huesca'});
calendar.add(ev);
<Argument optional="optional" name="errorCallback">
<descriptive>
<description><p>
- The method to invoke when an error occurs.
+ The method to invoke when an error occurs.
</p></description>
</descriptive>
<Type name="ErrorCallback" nullable="nullable"/>
function eventFoundCallback(events) {
// The event has been successfully found
// Changes the summary
- events[0].summary = 'HTML6 Webinar';
+ events[0].summary = 'HTML6 Webinar';
unifiedCalendar.update(events[0]);
console.log('First event was updated!');
}
// Gets the unified calendar
unifiedCalendar = tizen.calendar.getUnifiedCalendar("EVENT");
- var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
- summary:'HTML5 Webinar ',
- startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
+ var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
+ summary:'HTML5 Webinar ',
+ startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
duration: new tizen.TimeDuration(1, "HOURS"),
location:'Huesca'});
unifiedCalendar.add(ev);
-
+
// The event has been added
// Checks if the added event can be retrieved from the calendar
// If the calendar was empty, only the item added through add() should be returned
var filter = new tizen.AttributeFilter('summary', 'CONTAINS', 'HTML5');
unifiedCalendar.find(eventFoundCallback, errorCallback, filter);
-
+
</Code>
</descriptive>
<Type name="Calendar">
function eventFoundCallback(events) {
// The event has been successfully found
// Changes the summary
- events[0].summary = 'HTML6 Webinar';
+ events[0].summary = 'HTML6 Webinar';
myCalendar.update(events[0]);
console.log('First event was updated!');
}
// Gets the default calendar
myCalendar = tizen.calendar.getDefaultCalendar("EVENT");
- var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
- summary:'HTML5 Webinar ',
- startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
+ var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
+ summary:'HTML5 Webinar ',
+ startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
duration: new tizen.TimeDuration(1, "HOURS"),
location:'Huesca'});
-
+
myCalendar.add(ev);
-
+
// The event has been added
// Checks if the added event can be retrieved from the calendar
// If the calendar was empty, only the item added through add() should be returned
var filter = new tizen.AttributeFilter('summary', 'CONTAINS', 'HTML5');
myCalendar.find(eventFoundCallback, errorCallback, filter);
-
+
</Code>
</descriptive>
<Type name="Calendar">
<RaiseException name="WebAPIException">
<descriptive>
<description><p>
- with error type NotFoundError, if there is no calendar with the given identifier.
+ with error type NotFoundError, if there is no calendar with the given identifier.
</p></description>
<description><p>
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
</Interface>
<Interface name="Calendar" id="::Calendar::Calendar">
<webidl> [NoInterfaceObject] interface Calendar {
-
+
readonly attribute <ref>CalendarId</ref> id;
readonly attribute DOMString name;
-
+
<ref>CalendarItem</ref> get(<ref>CalendarItemId</ref> id) raises(<ref>WebAPIException</ref>);
void add(<ref>CalendarItem</ref> item) raises(<ref>WebAPIException</ref>);
void removeBatch(<ref>CalendarItemId</ref>[] ids,
optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void find(<ref>CalendarItemArraySuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback,
optional <ref>AbstractFilter</ref>? filter,
optional <ref>SortMode</ref>? sortMode) raises(<ref>WebAPIException</ref>);
-
+
long addChangeListener(<ref>CalendarChangeCallback</ref> successCallback) raises(<ref>WebAPIException</ref>);
-
+
void removeChangeListener(long watchId) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
</privilege>
<Code> // Gets the default calendar
var calendar = tizen.calendar.getDefaultCalendar("EVENT");
-
- var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
- summary:'HTML5 Webinar ',
- startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
+
+ var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
+ summary:'HTML5 Webinar ',
+ startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
duration: new tizen.TimeDuration(1, "HOURS"),
location:'Huesca'});
-
+
calendar.add(ev);
console.log('Event added with uid ' + ev.id.uid);
</Code>
// Gets the default calendar
var calendar = tizen.calendar.getDefaultCalendar("EVENT");
-
- var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
- summary:'HTML5 Webinar ',
- startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
+
+ var ev = new tizen.CalendarEvent({description:'HTML5 Introduction',
+ summary:'HTML5 Webinar ',
+ startDate: new tizen.TZDate(2011, 3, 30, 10, 0),
duration: new tizen.TimeDuration(1, "HOURS"),
location:'Huesca'});
-
+
calendar.addBatch([ev], addEventsSuccess, errorCallback);
</Code>
</descriptive>
myCalendar.update(events[0]);
console.log("The first item description was updated!");
}
-
+
// Gets the default calendar
myCalendar = tizen.calendar.getDefaultCalendar("EVENT");
// Gets default calendar
myCalendar = tizen.calendar.getDefaultCalendar("EVENT");
-
+
// Finds all events in Calendar
myCalendar.find(eventSearchSuccessCallback, errorCallback);
</Code>
// Defines the event search success callback.
function eventSearchSuccessCallback(events) {
// Deletes the first two existing events.
- myCalendar.removeBatch([events[0].id, events[1].id],
- removeBatchCallback,
+ myCalendar.removeBatch([events[0].id, events[1].id],
+ removeBatchCallback,
errorCallback);
}
// Gets default calendar
myCalendar = tizen.calendar.getDefaultCalendar("EVENT");
-
+
// Retrieves all events in Calendar
myCalendar.find(eventSearchSuccessCallback, errorCallback);
</Code>
// Gets default calendar
var calendar = tizen.calendar.getDefaultCalendar("EVENT");
-
+
// Finds all events the calendar that contain in the summary the string Tizen.
var filter = new tizen.AttributeFilter('summary', 'CONTAINS', 'Tizen');
// The events returned by the find() query will be sorted by ascending summary
var sortingMode = new tizen.SortMode('summary', 'ASC');
-
+
calendar.find(eventSearchSuccessCallback, errorCallback, filter, sortingMode);
</Code>
</descriptive>
readonly attribute <ref>CalendarId</ref>? calendarId;
readonly attribute <ref>TZDate</ref>? lastModificationDate;
-
+
attribute DOMString? description setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? summary setraises(<ref>WebAPIException</ref>);
-
+
attribute boolean isAllDay setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TZDate</ref>? startDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TimeDuration</ref>? duration setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? location setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>SimpleCoordinates</ref>? geolocation setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? organizer setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemVisibility</ref> visibility setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemStatus</ref> status setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarItemPriority</ref> priority setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarAlarm</ref>[] alarms setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString[] categories setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarAttendee</ref>[] attendees setraises(<ref>WebAPIException</ref>);
-
+
DOMString convertToString(<ref>CalendarTextFormat</ref> format) raises(<ref>WebAPIException</ref>);
<ref>CalendarItem</ref> clone() raises(<ref>WebAPIException</ref>);
(See RFC 5545 - Section 3.8.1.5).
</p>
<p>
-The default value is an empty string.
+The default value is an empty string.
</p>
</description>
<version>
</brief>
<description>
<p>
-The default value is an empty string.
+The default value is an empty string.
</p>
</description>
<version>
</brief>
<description>
<p>
-The default value for this attribute is an empty string.
+The default value for this attribute is an empty string.
</p>
</description>
<version>
// Gets the default calendar
var myCalendar = tizen.calendar.getDefaultCalendar("EVENT");
-
+
// Finds all events in the first calendar that contain in the summary the string Tizen.
var filter = new tizen.AttributeFilter('summary', 'CONTAINS', 'Tizen');
myCalendar.find(eventSearchSuccessCallback, errorCallback, filter);
var html5seminar = new tizen.CalendarEvent({startDate: new tizen.TZDate(2012, 3, 4),
duration: new tizen.TimeDuration(3, "DAYS"),
summary: "HTML5 Seminar"});
-
+
calendar.add(html5seminar);
var tizenseminar = html5seminar.clone();
tizenseminar.summary = "Tizen Seminar";
Constructor(DOMString stringRepresentation, <ref>CalendarTextFormat</ref> format)]
interface CalendarTask : <ref>CalendarItem</ref> {
attribute <ref>TZDate</ref>? dueDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TZDate</ref>? completedDate setraises(<ref>WebAPIException</ref>);
-
+
attribute unsigned short progress setraises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
This attribute is precise to the second. Milliseconds are ignored.
</p>
<p>
-The default value is <var>null</var>. If no value is provided, the task is not completed yet.
+The default value is <var>null</var>. If no value is provided, the task is not completed yet.
</p>
</description>
<version>
Constructor(DOMString stringRepresentation, <ref>CalendarTextFormat</ref> format)]
interface CalendarEvent : <ref>CalendarItem</ref> {
readonly attribute boolean isDetached;
-
+
attribute <ref>TZDate</ref>? endDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>EventAvailability</ref> availability setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>CalendarRecurrenceRule</ref>? recurrenceRule setraises(<ref>WebAPIException</ref>);
-
+
void expandRecurrence(<ref>TZDate</ref> startDate,
<ref>TZDate</ref> endDate,
<ref>CalendarEventArraySuccessCallback</ref> successCallback,
"CATEGORIES:BUSINESS,HUMAN RESOURCES\r\n" +
"END:VEVENT\r\n" +
"END:VCALENDAR", "ICALENDAR_20");
-
+
calendar.add(ev);
console.log('Event added with UID ' + ev.id.uid);
} catch (err) {
(see RFC 5545 - Section 3.8.2.2).
</p>
<p>
-This <em>endDate</em> must be in the same time zone as the <em>startDate</em>.
+This <em>endDate</em> must be in the same time zone as the <em>startDate</em>.
Note that <em>duration</em> and <em>endDate</em> are mutually exclusive, only one of them can be non-null.
</p>
<p>
This attribute is precise to the second. Milliseconds are ignored.
</p>
<p>
-The default value for this attribute is <var>null</var>.
+The default value for this attribute is <var>null</var>.
</p>
</description>
<version>
The call involves retrieving from the database detached instances of an event to replace their corresponding virtual instances in the returned list. The client can then use <em>CalendarEvent.isDetached </em>attribute to identify detached instances. If the event is not saved to a calendar yet, only virtual instances will be returned.
</p>
<p>
-The errorCallback is launched with these error types:
+The errorCallback is launched with these error types:
</p>
<ul>
<li>
function eventExpandingSuccessCallback(events) {
console.log(events.length + ' event instances were returned.');
}
-
+
var calendar = tizen.calendar.getDefaultCalendar();
var event = calendar.get(eventId);
interface CalendarAttendee
{
attribute DOMString uri;
-
+
attribute DOMString? name;
-
+
attribute <ref>AttendeeRole</ref> role;
-
+
attribute <ref>AttendeeStatus</ref> status;
-
+
attribute boolean RSVP;
-
+
attribute <ref>AttendeeType</ref> type;
-
+
attribute DOMString? group;
-
+
attribute DOMString? delegatorURI;
-
+
attribute DOMString? delegateURI;
-
+
attribute <ref>ContactRef</ref>? contactRef;
};</webidl>
<descriptive>
<Interface name="CalendarRecurrenceRule" id="::Calendar::CalendarRecurrenceRule">
<webidl> [Constructor(<ref>RecurrenceRuleFrequency</ref> frequency, optional <ref>CalendarRecurrenceRuleInit</ref>? ruleInitDict)]
interface CalendarRecurrenceRule
- {
+ {
attribute <ref>RecurrenceRuleFrequency</ref> frequency;
-
+
attribute unsigned short interval;
-
+
attribute <ref>TZDate</ref>? untilDate;
-
+
attribute long occurrenceCount;
-
+
attribute <ref>ByDayValue</ref>[] daysOfTheWeek;
-
+
attribute short[] setPositions;
-
+
attribute <ref>TZDate</ref>[] exceptions;
};</webidl>
<descriptive>
For example, a yearly recurrence rule that has a <em>daysOfTheWeek </em>value that specifies Monday through Friday, and a <em>setPositions </em>array containing <var>2 </var>and <var>-1</var>, occurs only on the second weekday and last weekday of every year.
</p>
<p>
-Values can be from 1 to 366 or -366 to -1.
-Negative values indicate counting backwards from the end of the recurrence rule's frequency (week, month, or year).
+Values can be from 1 to 366 or -366 to -1.
+Negative values indicate counting backwards from the end of the recurrence rule's frequency (week, month, or year).
</p>
<p>
This attribute must only be used in conjunction with another BYxxx rule part (such as <em>daysOfTheWeek</em>).
<descriptive>
<brief>
An attribute to list date/time exceptions for the recurring event.
-(See RFC 5545, Section 3.8.5.1.)
+(See RFC 5545, Section 3.8.5.1.)
</brief>
<description>
<p>
<webidl> [Constructor(DOMString uid, optional DOMString? rid)]
interface CalendarEventId {
attribute DOMString uid;
-
+
attribute DOMString? rid;
};</webidl>
<descriptive>
Constructor(<ref>TimeDuration</ref> before, <ref>AlarmMethod</ref> method, optional DOMString? description)]
interface CalendarAlarm {
attribute <ref>TZDate</ref>? absoluteDate setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>TimeDuration</ref>? before setraises(<ref>WebAPIException</ref>);
-
+
attribute <ref>AlarmMethod</ref> method setraises(<ref>WebAPIException</ref>);
-
+
attribute DOMString? description;
};</webidl>
<descriptive>
<Interface name="CalendarChangeCallback" id="::Calendar::CalendarChangeCallback">
<webidl> [Callback, NoInterfaceObject] interface CalendarChangeCallback {
void onitemsadded(<ref>CalendarItem</ref>[] items);
-
+
void onitemsupdated(<ref>CalendarItem</ref>[] items);
-
+
void onitemsremoved(<ref>CalendarItemId</ref>[] ids);
};</webidl>
<descriptive>
[NoInterfaceObject] interface CallHistoryObject {
readonly attribute <ref>CallHistory</ref> callhistory;
};
-
+
<ref>Tizen</ref> implements <ref>CallHistoryObject</ref>;
[NoInterfaceObject] interface RemoteParty {
};
[NoInterfaceObject] interface CallHistoryEntry {
-
+
readonly attribute DOMString uid;
readonly attribute DOMString type;
</brief>
<description>
<p>
-For more information on the Callhistory features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/call.htm">Call History Guide</a>.
+For more information on the Callhistory features, see <a href="../../org.tizen.web.appprogramming/html/guide/social_guide/call.htm">Call History Guide</a>.
</p>
</description>
<version>
<descriptive>
<description>
<p>
-To guarantee this application running on a device with Telephony feature, define below in the config file:
+To guarantee this application running on a device with Telephony feature, define below in the config file:
</p>
</description>
</descriptive>
A <var>null </var>value means that the remote is hidden (private number).
</brief>
<version>
- 2.0
+ 2.0
</version>
</descriptive>
<Type type="DOMString" nullable="nullable"/>
</Interface>
<Interface name="CallHistoryEntry" id="::Callhistory::CallHistoryEntry">
<webidl> [NoInterfaceObject] interface CallHistoryEntry {
-
+
readonly attribute DOMString uid;
readonly attribute DOMString type;
"remoteParties.remoteParty",
"EXACTLY",
"123456789");
-
+
// Creates a composite filter for time constraints
var y2009Filter = new tizen.AttributeRangeFilter(
"startTime",
with error type TypeMismatchError, if the input parameter is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type SecurityError, if the application does not have the privilege to call this method.
+ with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
with error type NotSupportedError, if this feature is not supported.
<Argument optional="optional" name="successCallback">
<descriptive>
<description><p>
- A generic success handler.
+ A generic success handler.
</p></description>
</descriptive>
<Type name="SuccessCallback" nullable="nullable"/>
};</webidl>
<descriptive>
<brief>
- This API provides functionality to discover contents such as images, videos, music, or other.
+ This API provides functionality to discover contents such as images, videos, music, or other.
</brief>
<description>
<p>
http://tizen.org/privilege/content.write
</privilege>
<remark>
- The <em>editableAttributes </em>in <em>Content </em>interface indicates
-the attributes that can be changed.
+ The <em>editableAttributes </em>in <em>Content </em>interface indicates
+the attributes that can be changed.
This API does not support updating the metadata of a file.
</remark>
<Code> // Assume the content is a Content object as a result of find method.
http://tizen.org/privilege/content.write
</privilege>
<remark>
- The <em>editableAttributes </em>in <em>Content </em>interface indicates
+ The <em>editableAttributes </em>in <em>Content </em>interface indicates
the attributes that can be changed.
This API does not support updating the metadata of a file.
</remark>
var artistFilter = new tizen.AttributeFilter("artists", "EXACTLY", "U2");
var albumFilter = new tizen.AttributeFilter("album", "EXACTLY", "The Joshua Tree");
var filter = new tizen.CompositeFilter("INTERSECTION", [albumFilter, artistFilter]);
-
+
function errorCB(err) {
console.log( 'The following error occurred: ' + err.name);
}
</brief>
<description>
<p>
-When an application creates or updates a content, this method allows scan it
+When an application creates or updates a content, this method allows scan it
to insert or update the content in the content database.
</p>
</description>
<Module name="DataControl" id="::DataControl">
<webidl>module DataControl {
enum DataType { "MAP", "SQL"};
-
+
[NoInterfaceObject] interface DataControlManagerObject {
readonly attribute <ref>DataControlManager</ref> datacontrol;
};
<ref>Tizen</ref> implements <ref>DataControlManagerObject</ref>;
-
+
[NoInterfaceObject] interface DataControlManager {
<ref>DataControlConsumerObject</ref> getDataControlConsumer(DOMString providerId, DOMString dataId, <ref>DataType</ref> type) raises(<ref>WebAPIException</ref>);
};
-
+
[NoInterfaceObject] interface DataControlConsumerObject {
readonly attribute <ref>DataType</ref> type;
readonly attribute DOMString providerId;
readonly attribute DOMString dataId;
};
-
+
[NoInterfaceObject] interface SQLDataControlConsumer : <ref>DataControlConsumerObject</ref> {
- void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
- optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
+ void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
+ optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
- optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
+ void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void remove(unsigned long reqId, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ void remove(unsigned long reqId, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void select(unsigned long reqId, DOMString[] columns, DOMString where,
- <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
+ <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
optional unsigned long? page, optional unsigned long? maxNumberPerPage) raises(<ref>WebAPIException</ref>);
};
[NoInterfaceObject] interface MappedDataControlConsumer : <ref>DataControlConsumerObject</ref> {
- void addValue(unsigned long reqId, DOMString key, DOMString value,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ void addValue(unsigned long reqId, DOMString key, DOMString value,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void removeValue(unsigned long reqId, DOMString key, DOMString value,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ void removeValue(unsigned long reqId, DOMString key, DOMString value,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void getValue(unsigned long reqId, DOMString key,
- <ref>DataControlGetValueSuccessCallback</ref> successCallback,
+ void getValue(unsigned long reqId, DOMString key,
+ <ref>DataControlGetValueSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface DataControlSuccessCallback {
void onsuccess(unsigned long reqId);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface DataControlErrorCallback {
void onerror(unsigned long reqId, <ref>WebAPIError</ref> error);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface DataControlInsertSuccessCallback {
void onsuccess(unsigned long reqId, long insertRowId);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface DataControlSelectSuccessCallback {
void onsuccess(<ref>RowData</ref>[] rows, unsigned long reqId);
};
-
+
[Callback=FunctionOnly, NoInterfaceObject] interface DataControlGetValueSuccessCallback {
void onsuccess(DOMString[] values, unsigned long reqid);
};
-
-
+
+
dictionary RowData {
DOMString[] columns;
DOMString[] values;
<RaiseException name="WebAPIException">
<descriptive>
<description><p>
- with error type TypeMismatchError, if parameter type is mismatched.
+ with error type TypeMismatchError, if parameter type is mismatched.
</p></description>
<description><p>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
</Interface>
<Interface name="SQLDataControlConsumer" id="::DataControl::SQLDataControlConsumer">
<webidl> [NoInterfaceObject] interface SQLDataControlConsumer : <ref>DataControlConsumerObject</ref> {
- void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
- optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
+ void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
+ optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
- optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
+ void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void remove(unsigned long reqId, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ void remove(unsigned long reqId, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
-
+
void select(unsigned long reqId, DOMString[] columns, DOMString where,
- <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
+ <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
optional unsigned long? page, optional unsigned long? maxNumberPerPage) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<brief>
- This interface defines SQL data type operatiors.
+ This interface defines SQL data type operatiors.
</brief>
<version>
2.1
<Name name="DataControlConsumerObject"/>
</InterfaceInheritance>
<Operation name="insert" id="::DataControl::SQLDataControlConsumer::insert">
- <webidl> void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
- optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
+ <webidl> void insert(unsigned long reqId, <ref>RowData</ref> insertionData,
+ optional <ref>DataControlInsertSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
{
console.log("ok : reqid "+ id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
- var rowData = {
+ var rowData = {
columns : ["WORD", "WORD_DESC"] ,
values : ["'tizen1'", "'tizen2'"]
};
</Raises>
</Operation>
<Operation name="update" id="::DataControl::SQLDataControlConsumer::update">
- <webidl> void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ <webidl> void update(unsigned long reqId, <ref>RowData</ref> updateData, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
{
console.log("ok : reqid " + id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
- var rowData = {
+ var rowData = {
columns : ["WORD", "WORD_DESC"] ,
values : ["'tizen1'", "'samsung platform!'"]
};
</Raises>
</Operation>
<Operation name="remove" id="::DataControl::SQLDataControlConsumer::remove">
- <webidl> void remove(unsigned long reqId, DOMString where,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ <webidl> void remove(unsigned long reqId, DOMString where,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Delete rows from a table that is owned by an SQL-type data control provider.
+ Delete rows from a table that is owned by an SQL-type data control provider.
</brief>
<version>
2.1
{
console.log("ok : reqid " + id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
// Defines globalReqId before
// Increases globalReqId for uniqueness
</Operation>
<Operation name="select" id="::DataControl::SQLDataControlConsumer::select">
<webidl> void select(unsigned long reqId, DOMString[] columns, DOMString where,
- <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
+ <ref>DataControlSelectSuccessCallback</ref> successCallback, optional <ref>DataControlErrorCallback</ref>? errorCallback,
optional unsigned long? page, optional unsigned long? maxNumberPerPage) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Selects the specified columns to be queried. The result set of the specified columns is retrieved from a table owned by an SQL-type data control provider.
+ Selects the specified columns to be queried. The result set of the specified columns is retrieved from a table owned by an SQL-type data control provider.
</brief>
<version>
2.1
catch (err) {
console.log (err.name +": " + err.message);
}
-
-
+
+
</Code>
</descriptive>
<Type type="void"/>
</Interface>
<Interface name="MappedDataControlConsumer" id="::DataControl::MappedDataControlConsumer">
<webidl> [NoInterfaceObject] interface MappedDataControlConsumer : <ref>DataControlConsumerObject</ref> {
- void addValue(unsigned long reqId, DOMString key, DOMString value,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ void addValue(unsigned long reqId, DOMString key, DOMString value,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void removeValue(unsigned long reqId, DOMString key, DOMString value,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ void removeValue(unsigned long reqId, DOMString key, DOMString value,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void getValue(unsigned long reqId, DOMString key,
- <ref>DataControlGetValueSuccessCallback</ref> successCallback,
+ void getValue(unsigned long reqId, DOMString key,
+ <ref>DataControlGetValueSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
- void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<Name name="DataControlConsumerObject"/>
</InterfaceInheritance>
<Operation name="addValue" id="::DataControl::MappedDataControlConsumer::addValue">
- <webidl> void addValue(unsigned long reqId, DOMString key, DOMString value,
- optional <ref>DataControlSuccessCallback</ref>? successCallback,
+ <webidl> void addValue(unsigned long reqId, DOMString key, DOMString value,
+ optional <ref>DataControlSuccessCallback</ref>? successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Adds the value associated with the specified key to a key-values map owned by MAP-type data control provider.
+ Adds the value associated with the specified key to a key-values map owned by MAP-type data control provider.
</brief>
<version>
2.1
<privilege>
http://tizen.org/privilege/datacontrol.consumer
</privilege>
- <Code>
+ <Code>
function successcb(id)
{
console.log("ok : reqid " + id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
// Defines globalReqId before
// Increases globalReqId for uniqueness
</Raises>
</Operation>
<Operation name="removeValue" id="::DataControl::MappedDataControlConsumer::removeValue">
- <webidl> void removeValue(unsigned long reqId, DOMString key, DOMString value,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ <webidl> void removeValue(unsigned long reqId, DOMString key, DOMString value,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
{
console.log("ok : reqid " + id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
-
+
+
try {
// Defines globalReqId before
// Increases globalReqId for uniqueness
with error type TypeMismatchError, if parameter type is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if the passed parameter is not available in data provider side or platform.
+ with error type InvalidValuesError, if the passed parameter is not available in data provider side or platform.
</p></description>
<description><p>
- with error type IOError, if a DB operation has failed.
+ with error type IOError, if a DB operation has failed.
</p></description>
<description><p>
with error type NotFoundError, if the key cannot be found.
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
</Raises>
</Operation>
<Operation name="getValue" id="::DataControl::MappedDataControlConsumer::getValue">
- <webidl> void getValue(unsigned long reqId, DOMString key,
- <ref>DataControlGetValueSuccessCallback</ref> successCallback,
+ <webidl> void getValue(unsigned long reqId, DOMString key,
+ <ref>DataControlGetValueSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Gets value associated with the specified key, from a key-values map owned by MAP-type data control provider.
+ Gets value associated with the specified key, from a key-values map owned by MAP-type data control provider.
</brief>
<version>
2.1
{
console.log(result.length + ":" + result[0]);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
// Defines globalReqId before
// Increases globalReqId for uniqueness
</Raises>
</Operation>
<Operation name="updateValue" id="::DataControl::MappedDataControlConsumer::updateValue">
- <webidl> void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
- <ref>DataControlSuccessCallback</ref> successCallback,
+ <webidl> void updateValue(unsigned long reqId, DOMString key, DOMString oldValue, DOMString newValue,
+ <ref>DataControlSuccessCallback</ref> successCallback,
optional <ref>DataControlErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Sets the value associated with the specified key with a new value.
+ Sets the value associated with the specified key with a new value.
</brief>
<version>
2.1
<privilege>
http://tizen.org/privilege/datacontrol.consumer
</privilege>
- <Code>
+ <Code>
function successcb(id)
{
console.log("ok : reqid " + id);
}
-
+
function errorcb(id, error)
{
console.log("error id : " + id + ", error msg : " + error.message);
}
-
+
try {
// Defines globalReqId before
// Increases globalReqId for uniqueness
<descriptive>
<description>
<p>
-To guarantee this application running on a device with Wi-Fi feature, define below in the config file:
+To guarantee this application running on a device with Wi-Fi feature, define below in the config file:
</p>
</description>
</descriptive>
<descriptive>
<description>
<p>
-To guarantee this application running on a device with Cellular feature, define below in the config file:
+To guarantee this application running on a device with Cellular feature, define below in the config file:
</p>
</description>
</descriptive>
<Module name="Filesystem" id="::Filesystem">
<webidl>module Filesystem {
enum FileMode { "r", "rw", "w", "a" };
-
+
enum FileSystemStorageType { "INTERNAL", "EXTERNAL" };
-
+
enum FileSystemStorageState { "MOUNTED", "REMOVED", "UNMOUNTABLE" };
-
+
[NoInterfaceObject] interface FileSystemManagerObject {
readonly attribute <ref>FileSystemManager</ref> filesystem;
};
wgt-private-tmp: the widget private volatile storage area </li>
</ul>
<p>
-The file URI path is also supported. if you want to access other paths out of virtual root,
+The file URI path is also supported. if you want to access other paths out of virtual root,
for example '/tmp/', 'file:///tmp' could be used as location parameter.
</p>
<p>
}
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess, onerror);
<p>
The mode parameter specifies whether the resulting File object
has read-only access ("r" access), read and write access ("rw" access),
-append access ("a" access), or write access ("w" access)
-to the root location containing directory tree.
-Permission for the requested access is obtained from the security framework.
+append access ("a" access), or write access ("w" access)
+to the root location containing directory tree.
+Permission for the requested access is obtained from the security framework.
Once the resulting File object has access, access is inherited by
any other File objects derived from this instance without any
further reference to the security framework, as noted in
structure containing additional information about each drive found.
Can get storages would have a label named as 'internal0', virtual roots (images, documents,...), 'removable1', 'removable2'.
'removable1' label would be used to resolve sdcard and 'removable2' label would be used to resolve usb host, if supported.
-The vfat filesystem used widly as sdcard filesystem is not case-sensitive.
+The vfat filesystem used widly as sdcard filesystem is not case-sensitive.
If you want to handle the file on sdcard, you need to consider case-sensitive filenames are regarded as same name.
</p>
<p>
}
watchID = tizen.filesystem.addStorageStateChangeListener(onStorageStateChanged);
-
+
</Code>
</descriptive>
is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
with error type NotSupportedError, if the feature is not supported.
</p></description>
<description><p>
- with error type UnknownError, if any other error case.
+ with error type UnknownError, if any other error case.
</p></description>
<description><p>
- with error type NotFoundError, if the watchId does not exist.
+ with error type NotFoundError, if the watchId does not exist.
</p></description>
</descriptive>
</RaiseException>
<p>
The file object permissions for the file object location and tree rooted
at that location depends upon the mode defined in the resolve method.
-When a File object creates a child File object,
+When a File object creates a child File object,
the new File object inherits its access rights from
the parent object without any reference to the security framework, as
noted in certain methods of File.
music/ramones/.
</p>
<p>
-For the virtual roots, the path is same as the name of the virtual root.
+For the virtual roots, the path is same as the name of the virtual root.
For example, if the root is music, then the path is music. If the root is documents, then the path is documents.
</p>
</description>
If that URI corresponds to a file located in any of the widget private
areas (such as wgt-package, wgt-private, wgt-private-tmp). The generated
URI MUST be unique for that file and for the widget making the request
-(such as including some derived from the widget id in the URI).
+(such as including some derived from the widget id in the URI).
These URIs MUST NOT be accessible to other widgets,
apart from the one invoking this method.
</p>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError in any other error situation.
+ with error type UnknownError in any other error situation.
</p></description>
</descriptive>
</RaiseException>
var documentsDir;
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess,onerror);
<li>
NotFoundError: originFilePath does not correspond to a valid file or destinationPath is not a valid path. </li>
<li>
-IOError: The File in which the copyTo method is invoked is a file (not a directory),
+IOError: The File in which the copyTo method is invoked is a file (not a directory),
originFilePath corresponds to a file or directory in use by another process,
overwrite parameter is <em>false</em> and destinationFilePath corresponds to an existing
file or directory. </li>
}
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess, onerror);
<description>
<p>
The file or directory will be moved (and will overwrite if possible and specified)
-atomically to the given path. This operation is different from
+atomically to the given path. This operation is different from
instantiating copyTo and then deleting the original file, as on certain
platforms, this operation does not require extra disk space.
</p>
}
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess, onerror);
with error type NotSupportedError, if the feature is not supported.
</p></description>
<description><p>
- with error type UnknownError in any other error case.
+ with error type UnknownError in any other error case.
</p></description>
</descriptive>
</RaiseException>
with error type NotSupportedError, if the feature is not supported.
</p></description>
<description><p>
- with error type UnknownError, in any other error case.
+ with error type UnknownError, in any other error case.
</p></description>
</descriptive>
</RaiseException>
// Resolves helloWorld.doc file that is located in the
// documents root location
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){ file = dir.resolve("helloWorld.doc");},
function(e){ console.log("Error" + e.message);},
"rw");
with error type NotSupportedError, if the feature is not supported.
</p></description>
<description><p>
- with error type UnknownError in any other error case.
+ with error type UnknownError in any other error case.
</p></description>
</descriptive>
</RaiseException>
}
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess,onerror);
var documentsDir;
tizen.filesystem.resolve(
- 'documents',
+ 'documents',
function(dir){
documentsDir = dir;
dir.listFiles(onsuccess,onerror);
is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
</brief>
<description>
<p>
-This callback interface specifies a success callback with
+This callback interface specifies a success callback with
a File object as input argument. It is used in asynchronous
operations, such as FileSystemManager.resolve() and
copying, moving, and deleting files.
</brief>
<description>
<p>
-This callback interface specifies a success callback with
+This callback interface specifies a success callback with
an array of FileSystemStorage objects as input argument. It is used in asynchronous
operations, such as FileSystemManager.listStorages().
</p>
</brief>
<description>
<p>
-This callback interface specifies a success callback with
+This callback interface specifies a success callback with
a FileSystmeStorage object as input argument. It is used in asynchronous
operations, such as FileSystemManager.getStorage() and
FileSystemManager.addStorageStateChangeListener().
</brief>
<description>
<p>
-This callback interface specifies a success callback with
+This callback interface specifies a success callback with
a DOMString object as input argument. It is used in asynchronous
operations, such as File.readAsText().
</p>
</brief>
<description>
<p>
-This callback interface specifies a success callback with
+This callback interface specifies a success callback with
a FileStream object as input argument. It is used by asynchronous
methods, such as File.openStream().
</p>
<ref>Tizen</ref> implements <ref>MessageManagerObject</ref>;
enum MessageServiceTag {"messaging.sms", "messaging.mms", "messaging.email" };
-
+
typedef DOMString MessageId;
-
+
typedef DOMString MessageAttachmentId;
typedef DOMString MessageConvId;
- typedef DOMString MessageFolderId;
+ typedef DOMString MessageFolderId;
[Constructor(<ref>MessageServiceTag</ref> type, optional <ref>MessageInit</ref>? messageInitDict)]
interface Message {
[Constructor(DOMString filePath, optional DOMString? mimeType)]
interface MessageAttachment {
-
+
readonly attribute <ref>MessageAttachmentId</ref>? id;
-
+
readonly attribute <ref>MessageId</ref>? messageId;
-
+
readonly attribute DOMString? mimeType;
-
+
readonly attribute DOMString? filePath;
};
readonly attribute <ref>MessageServiceTag</ref> type;
readonly attribute DOMString name;
-
+
void sendMessage(<ref>Message</ref> message,
optional <ref>MessageRecipientsCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
[Callback, NoInterfaceObject] interface MessageFoldersChangeCallback {
-
+
void foldersadded(<ref>MessageFolder</ref>[] addedFolders);
void foldersupdated(<ref>MessageFolder</ref>[] updatedFolders);
readonly attribute <ref>MessageServiceTag</ref> type;
readonly attribute Date timestamp;
-
+
readonly attribute unsigned long messageCount;
readonly attribute unsigned long unreadMessages;
<descriptive>
<description>
<p>
-To guarantee this application running on a device with SMS feature, define below in the config file:
+To guarantee this application running on a device with SMS feature, define below in the config file:
</p>
</description>
</descriptive>
<descriptive>
<description>
<p>
-To guarantee this application running on a device with MMS feature, define below in the config file:
+To guarantee this application running on a device with MMS feature, define below in the config file:
</p>
</description>
</descriptive>
function errorCallback(err) {
console.log(err.name + " error: " + err.message);
}
-
+
function serviceListCB(services) {
if (services.length > 0) {
var msg = new tizen.Message("messaging.sms", {plainBody: "Tizen first SMS message."});
<webidl> readonly attribute <ref>MessageServiceTag</ref> type;</webidl>
<descriptive>
<brief>
- The type of a given message.
+ The type of a given message.
</brief>
<version>
1.0
<Code> // Define the success callback.
function serviceListCB(services) {
if (services.length > 0) {
- var msg = new tizen.Message("messaging.email");
+ var msg = new tizen.Message("messaging.email");
msg.attachments = [new tizen.MessageAttachment("images/myimage.png", "image/png"),
new tizen.MessageAttachment("documents/mydoc.pdf", "text/pdf")];
}
tizen.messaging.getMessageServices("messaging.email", serviceListCB);
-
+
</Code>
</descriptive>
<Type type="array">
</p>
<p>
To indicate where to show an inline attachment within the HTML body, a link of the following format should be provided:
-"<img src="The file name of a inline attachment">"
+"<img src="The file name of a inline attachment">"
This property is used only with email messages.
</p>
</description>
<Interface name="MessageAttachment" id="::Messaging::MessageAttachment">
<webidl> [Constructor(DOMString filePath, optional DOMString? mimeType)]
interface MessageAttachment {
-
+
readonly attribute <ref>MessageAttachmentId</ref>? id;
-
+
readonly attribute <ref>MessageId</ref>? messageId;
-
+
readonly attribute DOMString? mimeType;
-
+
readonly attribute DOMString? filePath;
};</webidl>
<descriptive>
</p>
<ul>
<li>
-InvalidValuesError - If any of the input parameters contain an invalid value, the encoding is not valid or onsuccess is null.
+InvalidValuesError - If any of the input parameters contain an invalid value, the encoding is not valid or onsuccess is null.
Please note that to allow developers to ignore errors, errorCallback accepts null as a valid value. </li>
<li>
UnknownError - In any other error case. </li>
readonly attribute <ref>MessageServiceTag</ref> type;
readonly attribute DOMString name;
-
+
void sendMessage(<ref>Message</ref> message,
optional <ref>MessageRecipientsCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
<webidl> readonly attribute DOMString id;</webidl>
<descriptive>
<brief>
- The unique identifier of this Messaging service.
+ The unique identifier of this Messaging service.
</brief>
<version>
1.0.
</p>
<p>
When the operation is fully completed (that is, the implementation has the
-result of the send operation for all recipients), the onsuccess()
-method of the successCallback will be invoked with an array of recipients who received
+result of the send operation for all recipients), the onsuccess()
+method of the successCallback will be invoked with an array of recipients who received
the sent message, as input parameter.
</p>
</description>
http://tizen.org/privilege/messaging.write
</privilege>
<Code> // Assume messaging service is initialized.
- var service;
+ var service;
// Define the success body loaded callback.
function successCallback(message) {
console.log ("body for message: " + message.subject + "from: " + message.from + "loaded.");
emailService.messageStorage.findFolders(filter, folderQueryCallback);
}
-
+
// Define the success callback.
function folderSynced() {
console.log("New messages are fetched!");
emailService.syncFolder (folders[i], folderSynced, null, 30);
}
}
-
+
tizen.messaging.getMessageServices("messaging.email", serviceCallback, errorCallback);
</Code>
</descriptive>
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
function messageArrayCB(messages) {
console.log(messages.length + " message(s) fetched!");
for (var i = 0; i < messages.length; i++) {
</privilege>
<Code> // Define success callback
var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
function successCallback() {
console.log("Messages were deleted");
}
http://tizen.org/privilege/messaging.write
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
// Define success callback
function successCallback() {
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
function conversationsArrayCB(conversations) {
console.log(conversations.length + " conversation(s) found!");
for (var i = 0; i < conversations.length; i++) {
http://tizen.org/privilege/messaging.write
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
// Define success callback.
function successCallback() {
console.log("Conversations deleted");
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
function folderArrayCB(folders) {
console.log(folders.length + " folders(s) found!");
for (var i = 0; i < folders.length; i++) {
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
var messageChangeCallback = {
messagesupdated: function(messages) {
console.log(messages.length + " message(s) updated");},
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
var conversationChangeCB = {
conversationsupdated: function(conversations) {
console.log(conversations.length + " conversations(s) updated");},
http://tizen.org/privilege/messaging.read
</privilege>
<Code> var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
var folderChangeCB = {
foldersupdated: function(folders) {
console.log(folders.length + " folders(s) updated");},
</privilege>
<Code> var watchId;
var service; // Assume messaging service is initialized
- var messageStorage = service.messageStorage;
+ var messageStorage = service.messageStorage;
var folderChangeCB = {
foldersupdated: function(folders) {
console.log(folders.length + " folders(s) updated. Cancel watching.");
</Interface>
<Interface name="MessageFoldersChangeCallback" id="::Messaging::MessageFoldersChangeCallback">
<webidl> [Callback, NoInterfaceObject] interface MessageFoldersChangeCallback {
-
+
void foldersadded(<ref>MessageFolder</ref>[] addedFolders);
void foldersupdated(<ref>MessageFolder</ref>[] updatedFolders);
readonly attribute <ref>MessageServiceTag</ref> type;
readonly attribute Date timestamp;
-
+
readonly attribute unsigned long messageCount;
readonly attribute unsigned long unreadMessages;
<ref>SuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises(<ref>WebAPIException</ref>);
};
-
+
[Callback, NoInterfaceObject] interface NetworkSuccessCallback {
void onsuccess();
- void ondisconnected();
- };
+ void ondisconnected();
+ };
};</webidl>
<descriptive>
<brief>
<descriptive>
<description>
<p>
-
-To guarantee this application running on a device with telephony feature, define below in the config file:
+
+To guarantee this application running on a device with telephony feature, define below in the config file:
</p>
</description>
</descriptive>
</version>
<Code> var statuscb = {
onsuccess: function() { console.log("onsuccess func is called"); },
- ondisconnected: function() { console.log("ondisconnected func is called"); }
+ ondisconnected: function() { console.log("ondisconnected func is called"); }
};
function ecb(e) { console.log("error callback is called : " + e.message + " : " + e.code); }
tizen.networkbearerselection.requestRouteToHost("CELLULAR", "www.tizen.org", statuscb, ecb);
-
+
</Code>
<privilegelevel>
partner
<Code> function scb() { console.log("success callback is called"); }
function ecb(e) { console.log("error callback is called : " + e.message + " : " + e.code); }
var statuscb = {
- onsuccess: function() {
- console.log("onsuccess func is called");
+ onsuccess: function() {
+ console.log("onsuccess func is called");
tizen.networkbearerselection.releaseRouteToHost("CELLULAR", "www.google.com", scb, ecb);
},
- ondisconnected: function() { console.log("ondisconnected func is called"); }
+ ondisconnected: function() { console.log("ondisconnected func is called"); }
};
tizen.networkbearerselection.requestRouteToHost("CELLULAR", "www.google.com", statuscb, ecb);
-
+
</Code>
<privilegelevel>
partner
<webidl> [Callback, NoInterfaceObject] interface NetworkSuccessCallback {
void onsuccess();
- void ondisconnected();
+ void ondisconnected();
};</webidl>
<descriptive>
<brief>
"MIFARE_MINI", "MIFARE_1K", "MIFARE_4K", "MIFARE_ULTRA", "MIFARE_DESFIRE",
"ISO14443_B", "ISO14443_4B", "ISO14443_BPRIME", "FELICA", "JEWEL", "ISO15693",
"UNKNOWN_TARGET" };
-
+
[NoInterfaceObject] interface NFCManagerObject {
readonly attribute <ref>NFCManager</ref> nfc;
};
[NoInterfaceObject] interface NFCPeer {
readonly attribute boolean isConnected;
-
+
void setReceiveNDEFListener(<ref>NDEFMessageReadCallback</ref> successCallback) raises(<ref>WebAPIException</ref>);
void unsetReceiveNDEFListener() raises(<ref>WebAPIException</ref>);
Constructor(byte[] rawData)]
interface NDEFMessage {
readonly attribute long recordCount;
-
+
attribute <ref>NDEFRecord</ref>[] records;
byte[] toByte() raises(<ref>WebAPIException</ref>);
readonly attribute byte[] type;
readonly attribute byte[] id;
-
+
readonly attribute byte[] payload;
};
[Constructor(DOMString text, DOMString languageCode, optional DOMString? encoding)]
interface NDEFRecordText : <ref>NDEFRecord</ref> {
readonly attribute DOMString text;
-
+
readonly attribute DOMString languageCode;
-
+
readonly attribute <ref>NDEFRecordTextEncoding</ref> encoding;
};
readonly attribute DOMString mimeType;
};
-
+
[Callback, NoInterfaceObject] interface NFCTagDetectCallback {
void onattach(<ref>NFCTag</ref> nfcTag);
void ondetach();
};</webidl>
<descriptive>
<brief>
- This interface specifies a protocol for simple wireless interconnection of
+ This interface specifies a protocol for simple wireless interconnection of
closely coupled devices operating at 13.56 MHz using Near Field Communication (NFC),
-which is an international standard (ISO/IEC 18092).
+which is an international standard (ISO/IEC 18092).
To know more, see <a href="http://www.nfc-forum.org/specs/spec_list/">Technical Specifications</a>.
</brief>
<description>
<descriptive>
<description>
<p>
-To guarantee this application running on a device with NFC feature, define below in the config file:
+To guarantee this application running on a device with NFC feature, define below in the config file:
</p>
</description>
</descriptive>
<Argument optional="optional" name="successCallback">
<descriptive>
<description><p>
- The method to call when NFC adapter is
+ The method to call when NFC adapter is
enabled or disabled successfully.
</p></description>
</descriptive>
<description>
<p>
If the registration completes successfully, the detectCallback must be
-invoked when NFC tag is detected.
+invoked when NFC tag is detected.
</p>
<p>
If no tagFilter is passed, it shall consider the default tagFilter, that is to set all tag types.
<description>
<p>
If the registration completes successfully, the detectCallback must be
-invoked when NFC peer-to-peer target is detected.
+invoked when NFC peer-to-peer target is detected.
</p>
</description>
<version>
<description>
<p>
If the operation completes successfully, the NDEF Message that was last read
-should be returned.
+should be returned.
</p>
</description>
<version>
<Interface name="NFCPeer" id="::NFC::NFCPeer">
<webidl> [NoInterfaceObject] interface NFCPeer {
readonly attribute boolean isConnected;
-
+
void setReceiveNDEFListener(<ref>NDEFMessageReadCallback</ref> successCallback) raises(<ref>WebAPIException</ref>);
void unsetReceiveNDEFListener() raises(<ref>WebAPIException</ref>);
Constructor(byte[] rawData)]
interface NDEFMessage {
readonly attribute long recordCount;
-
+
attribute <ref>NDEFRecord</ref>[] records;
byte[] toByte() raises(<ref>WebAPIException</ref>);
readonly attribute byte[] type;
readonly attribute byte[] id;
-
+
readonly attribute byte[] payload;
};</webidl>
<descriptive>
<webidl> [Constructor(DOMString text, DOMString languageCode, optional DOMString? encoding)]
interface NDEFRecordText : <ref>NDEFRecord</ref> {
readonly attribute DOMString text;
-
+
readonly attribute DOMString languageCode;
-
+
readonly attribute <ref>NDEFRecordTextEncoding</ref> encoding;
};</webidl>
<descriptive>
</brief>
<description>
<p>
-This callback interface specifies a success method with
+This callback interface specifies a success method with
an NDEF message as an input parameter.
It is used in asynchronous
operations, such as NFCTag.readNDEF() or NFCPeer.setReceiveNDEFListener().
<webidl>module Notification {
typedef DOMString NotificationId;
-
+
enum NotificationType { "STATUS" };
enum StatusNotificationType { "SIMPLE", "THUMBNAIL", "ONGOING", "PROGRESS" };
};
-
+
[NoInterfaceObject] interface Notification {
-
-
+
+
readonly attribute <ref>NotificationId</ref> id;
readonly attribute <ref>NotificationType</ref> type;
};
-
+
dictionary StatusNotificationInit {
DOMString? content;
- DOMString? iconPath;
+ DOMString? iconPath;
DOMString? soundPath;
boolean? vibration;
<ref>ApplicationControl</ref>? appControl;
DOMString? backgroundImagePath;
DOMString[]? thumbnails;
};
-
+
[Constructor(<ref>StatusNotificationType</ref> statusType, DOMString title, optional <ref>StatusNotificationInit</ref>? notificationInitDict)]
interface StatusNotification : <ref>Notification</ref> {
readonly attribute <ref>StatusNotificationType</ref> statusType;
-
+
attribute DOMString? iconPath;
attribute DOMString? subIconPath;
attribute long? number;
-
+
attribute <ref>NotificationDetailInfo</ref>[]? detailInfo;
attribute DOMString? ledColor;
attribute DOMString[]? thumbnails;
attribute DOMString? soundPath;
-
+
attribute boolean vibration;
attribute <ref>ApplicationControl</ref>? appControl;
attribute <ref>ApplicationId</ref>? appId;
- attribute <ref>NotificationProgressType</ref> progressType;
+ attribute <ref>NotificationProgressType</ref> progressType;
attribute unsigned long? progressValue;
};
attribute DOMString? subText;
};
-
+
};</webidl>
<descriptive>
<brief>
</brief>
<description>
<p>
-The following notification type is supported:
+The following notification type is supported:
</p>
<ul>
<li>
</brief>
<description>
<p>
-The following status notification types are supported:
+The following status notification types are supported:
</p>
<ul>
<li>
</brief>
<description>
<p>
-Supporting notification progress types are:
+Supporting notification progress types are:
</p>
<ul>
<li>
var notificationDict = {
content : "This is a simple notification.",
iconPath : "images/image1.jpg",
- soundPath : "music/Over the horizon.mp3",
- vibration : true,
+ soundPath : "music/Over the horizon.mp3",
+ vibration : true,
appControl : appControl};
-
- var notification = new tizen.StatusNotification("SIMPLE",
+
+ var notification = new tizen.StatusNotification("SIMPLE",
"Simple notification", notificationDict);
-
+
tizen.notification.post(notification);
} catch (err) {
console.log (err.name + ": " + err.message);
with error type TypeMismatchError, if any of the input parameter is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError if any other error occurs.
+ with error type UnknownError if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
<webidl> void update(<ref>Notification</ref> notification) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Updates a previously posted notification.
+ Updates a previously posted notification.
</brief>
<version>
2.0
<Code> try {
// Uses a variable for the previously posted notification.
notification.content = "My notification";
- tizen.notification.update(notification);
+ tizen.notification.update(notification);
} catch (err) {
console.log (err.name + ": " + err.message);
}
-
+
</Code>
</descriptive>
<Type type="void"/>
with error type TypeMismatchError, if any of the input parameter is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError if any other error occurs.
+ with error type UnknownError if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
<webidl> void remove(<ref>NotificationId</ref> id) raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Removes a previously posted notification.
+ Removes a previously posted notification.
</brief>
<version>
2.0
</privilege>
<Code> try {
// Uses a variable for the previously posted notification.
- tizen.notification.remove(notification.id);
+ tizen.notification.remove(notification.id);
} catch (err) {
console.log (err.name + ": " + err.message);
}
-
+
</Code>
</descriptive>
<Type type="void"/>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError if any other error occurs.
+ with error type UnknownError if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
http://tizen.org/privilege/notification
</privilege>
<Code> try {
- tizen.notification.removeAll();
+ tizen.notification.removeAll();
} catch (err) {
console.log (err.name + ": " + err.message);
}
-
+
</Code>
</descriptive>
<Type type="void"/>
with error type SecurityError, if the application does not have the privilege to call this method.
</p></description>
<description><p>
- with error type UnknownError if any other error occurs.
+ with error type UnknownError if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
// Uses a variable for the previously posted notification
// Saves notification ID for future use
var myId = notification.id;
-
- var myNotification = tizen.notification.get(myId);
+
+ var myNotification = tizen.notification.get(myId);
} catch (err) {
console.log (err.name + ": " + err.message);
}
-
+
</Code>
</descriptive>
<Type name="Notification"/>
with error type NotFoundError, if NotificationId is not found in the previously posted notifications.
</p></description>
<description><p>
- with error type UnknownError if any other error occurs.
+ with error type UnknownError if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
<Code> try {
var notifications = tizen.notification.getAll();
var index = 0;
-
+
for ( index = 0; notifications.length > index; index++ )
{
console.log(notifications[index].id);
<RaiseException name="WebAPIException">
<descriptive>
<description><p>
- with error type UnknownError, if any other error occurs.
+ with error type UnknownError, if any other error occurs.
</p></description>
</descriptive>
</RaiseException>
</Interface>
<Interface name="Notification" id="::Notification::Notification">
<webidl> [NoInterfaceObject] interface Notification {
-
-
+
+
readonly attribute <ref>NotificationId</ref> id;
readonly attribute <ref>NotificationType</ref> type;
<Dictionary name="StatusNotificationInit" id="::Notification::StatusNotificationInit">
<webidl> dictionary StatusNotificationInit {
DOMString? content;
- DOMString? iconPath;
+ DOMString? iconPath;
DOMString? soundPath;
boolean? vibration;
<ref>ApplicationControl</ref>? appControl;
interface StatusNotification : <ref>Notification</ref> {
readonly attribute <ref>StatusNotificationType</ref> statusType;
-
+
attribute DOMString? iconPath;
attribute DOMString? subIconPath;
attribute long? number;
-
+
attribute <ref>NotificationDetailInfo</ref>[]? detailInfo;
attribute DOMString? ledColor;
attribute DOMString[]? thumbnails;
attribute DOMString? soundPath;
-
+
attribute boolean vibration;
attribute <ref>ApplicationControl</ref>? appControl;
attribute <ref>ApplicationId</ref>? appId;
- attribute <ref>NotificationProgressType</ref> progressType;
+ attribute <ref>NotificationProgressType</ref> progressType;
attribute unsigned long? progressValue;
};</webidl>
<webidl> readonly attribute <ref>StatusNotificationType</ref> statusType;</webidl>
<descriptive>
<brief>
- The status notification type.
+ The status notification type.
</brief>
<version>
2.0
<webidl> attribute DOMString? iconPath;</webidl>
<descriptive>
<brief>
- The icon path to display in the notification.
+ The icon path to display in the notification.
</brief>
<version>
2.0
<webidl> attribute DOMString? subIconPath;</webidl>
<descriptive>
<brief>
- The sub icon path to display in the notification.
+ The sub icon path to display in the notification.
</brief>
<version>
2.1
<webidl> attribute long? number;</webidl>
<descriptive>
<brief>
- The number of events to display in the notification.
+ The number of events to display in the notification.
</brief>
<version>
2.1
<webidl> attribute DOMString? ledColor;</webidl>
<descriptive>
<brief>
- Sets the notification LED indicator color property.
+ Sets the notification LED indicator color property.
The color is a numerical RGB value(#rrggbb). The format of a RGB value in hexadecimal notation is a "#" immediately followed by exactly six hexadecimal characters(0-9, A-F). The color format is case-insensitive.
The LED indicator color will show its a close approximation.
-LED will only light on when screen is off. To turn the LED off, set "#000000" or null to ledColor.
+LED will only light on when screen is off. To turn the LED off, set "#000000" or null to ledColor.
This method has effects when the device has notification LED.
</brief>
<Code> try {
iconPath : "images/image1.jpg",
soundPath : "music/Over the horizon.mp3",
vibration : true,
- ledColor : "#FFFF00",
+ ledColor : "#FFFF00",
ledOnPeriod: 1000,
ledOffPeriod : 500 };
<webidl> attribute <ref>ApplicationControl</ref>? appControl;</webidl>
<descriptive>
<brief>
- Holds the application control to launch an application when the notification is selected from the notification tray.
+ Holds the application control to launch an application when the notification is selected from the notification tray.
</brief>
<version>
2.0
<webidl> attribute <ref>ApplicationId</ref>? appId;</webidl>
<descriptive>
<brief>
- Holds the application ID to launch when the notification is selected from the notification tray.
+ Holds the application ID to launch when the notification is selected from the notification tray.
</brief>
<version>
2.0
</version>
<Code> try {
-
+
// Gets a current application information with tizen.application.getAppInfo
var myappInfo = tizen.application.getAppInfo();
var notificationDict = {
content : "This is a simple notification.",
iconPath : "images/image1.jpg",
- soundPath : "music/Over the horizon.mp3",
- vibration : true,
+ soundPath : "music/Over the horizon.mp3",
+ vibration : true,
appId : myappInfo.id };
-
- var notification = new tizen.StatusNotification("SIMPLE",
+
+ var notification = new tizen.StatusNotification("SIMPLE",
"Simple notification", notificationDict);
-
+
tizen.notification.post(notification);
} catch (err) {
console.log (err.name + ": " + err.message);
<webidl> attribute <ref>NotificationProgressType</ref> progressType;</webidl>
<descriptive>
<brief>
- Defines the type for an ongoing notification's progress.
+ Defines the type for an ongoing notification's progress.
By default, this attribute is set to PERCENTAGE.
</brief>
<version>
This attribute is only available for StatusNotifcation of type <em>PROGRESS</em>.
</p>
<p>
-Application should keep the progress value for its job because
-the saved value in the notification status tray would be different from
+Application should keep the progress value for its job because
+the saved value in the notification status tray would be different from
exact progress value.
</p>
<p>
null,
"image/jpg",
null);
-
+
var notificationDict = {
content : "This is a progress notificaiton.",
iconPath : "images/image2.jpg",
- soundPath : "music/Over the horizon.mp3",
- vibration : true,
+ soundPath : "music/Over the horizon.mp3",
+ vibration : true,
appControl : appControl,
progressValue : 20};
// Constructs the progress notification
- var notification = new tizen.StatusNotification("PROGRESS",
- "Progress notification", notificationDict);
+ var notification = new tizen.StatusNotification("PROGRESS",
+ "Progress notification", notificationDict);
// Posts the notification
tizen.notification.post(notification);
notification.progressValue = 59;
tizen.notification.update(notification);
-
+
} catch (err) {
console.log (err.name + ": " + err.message);
}
<descriptive>
<description>
<p>
-To guarantee this application running on a device with SecureElement feature, define below in the config file:
+To guarantee this application running on a device with SecureElement feature, define below in the config file:
</p>
</description>
</descriptive>
<privilegelevel>
public
</privilegelevel>
- <Code> var session; //Session obtained from openSession callback
+ <Code> var session; //Session obtained from openSession callback
try {
session.closeChannels();
} catch (err) {
enum SystemInfoPropertyId { "BATTERY" , "CPU", "STORAGE", "DISPLAY", "DEVICE_ORIENTATION", "BUILD", "LOCALE", "NETWORK", "WIFI_NETWORK", "CELLULAR_NETWORK", "SIM", "PERIPHERAL" };
enum SystemInfoNetworkType { "NONE", "2G", "2.5G", "3G", "4G", "WIFI", "ETHERNET", "UNKNOWN" };
-
+
enum SystemInfoDeviceOrientationStatus { "PORTRAIT_PRIMARY", "PORTRAIT_SECONDARY", "LANDSCAPE_PRIMARY", "LANDSCAPE_SECONDARY" };
-
+
enum SystemInfoSimState { "ABSENT", "INITIALIZING", "READY", "PIN_REQUIRED", "PUK_REQUIRED", "NETWORK_LOCKED", "SIM_LOCKED", "UNKNOWN" };
-
+
enum SystemInfoProfile { "MOBILE_FULL", "MOBILE_WEB" };
[NoInterfaceObject] interface SystemInfoObject {
readonly attribute boolean visionFaceRecognition;
readonly attribute boolean secureElement;
-
+
readonly attribute boolean nativeOspCompatible;
readonly attribute <ref>SystemInfoProfile</ref> profile;
- };
-
+ };
+
dictionary SystemInfoOptions {
unsigned long timeout;
readonly attribute <ref>SystemInfoDeviceOrientationStatus</ref> status;
readonly attribute boolean isAutoRotation;
};
-
+
[NoInterfaceObject] interface SystemInfoBuild : <ref>SystemInfoProperty</ref> {
readonly attribute DOMString model;
readonly attribute DOMString country;
};
-
- [NoInterfaceObject] interface SystemInfoNetwork : <ref>SystemInfoProperty</ref> {
-
- readonly attribute <ref>SystemInfoNetworkType</ref> networkType;
- };
-
- [NoInterfaceObject] interface SystemInfoWifiNetwork : <ref>SystemInfoProperty</ref> {
-
- readonly attribute DOMString status;
- readonly attribute DOMString ssid;
- readonly attribute DOMString ipAddress;
- readonly attribute DOMString ipv6Address;
- readonly attribute double signalStrength;
- };
-
- [NoInterfaceObject] interface SystemInfoCellularNetwork : <ref>SystemInfoProperty</ref> {
-
- readonly attribute DOMString status;
- readonly attribute DOMString apn;
- readonly attribute DOMString ipAddress;
- readonly attribute DOMString ipv6Address;
- readonly attribute unsigned short mcc;
- readonly attribute unsigned short mnc;
- readonly attribute unsigned short cellId;
- readonly attribute unsigned short lac;
+
+ [NoInterfaceObject] interface SystemInfoNetwork : <ref>SystemInfoProperty</ref> {
+
+ readonly attribute <ref>SystemInfoNetworkType</ref> networkType;
+ };
+
+ [NoInterfaceObject] interface SystemInfoWifiNetwork : <ref>SystemInfoProperty</ref> {
+
+ readonly attribute DOMString status;
+ readonly attribute DOMString ssid;
+ readonly attribute DOMString ipAddress;
+ readonly attribute DOMString ipv6Address;
+ readonly attribute double signalStrength;
+ };
+
+ [NoInterfaceObject] interface SystemInfoCellularNetwork : <ref>SystemInfoProperty</ref> {
+
+ readonly attribute DOMString status;
+ readonly attribute DOMString apn;
+ readonly attribute DOMString ipAddress;
+ readonly attribute DOMString ipv6Address;
+ readonly attribute unsigned short mcc;
+ readonly attribute unsigned short mnc;
+ readonly attribute unsigned short cellId;
+ readonly attribute unsigned short lac;
readonly attribute boolean isRoaming;
readonly attribute boolean isFlightMode;
readonly attribute DOMString imei raises(<ref>WebAPIException</ref>);
readonly attribute unsigned short mnc raises(<ref>WebAPIException</ref>);
readonly attribute DOMString msin raises(<ref>WebAPIException</ref>);
readonly attribute DOMString spn raises(<ref>WebAPIException</ref>);
- };
-
+ };
+
[NoInterfaceObject] interface SystemInfoPeripheral : <ref>SystemInfoProperty</ref> {
readonly attribute boolean isVideoOutputOn;
</brief>
<description>
<p>
-This API also provides interfaces and methods that can retrieve statuses of hardware devices, get the value of selected properties, and subscribe to asynchronous notifications of changes for selected values.
+This API also provides interfaces and methods that can retrieve statuses of hardware devices, get the value of selected properties, and subscribe to asynchronous notifications of changes for selected values.
</p>
<p>
The following provides an overview of the tree data structure:
<webidl> <ref>SystemInfoDeviceCapability</ref> getCapabilities() raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Gets the capabilities of the device.
+ Gets the capabilities of the device.
</brief>
<description>
<p>
-The function must synchronously acquire the capabilities of the device.
+The function must synchronously acquire the capabilities of the device.
</p>
</description>
<version>
with error type NotSupportedError, if this feature is not supported.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
with error type NotSupportedError, if this feature is not supported.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
+ with error type InvalidValuesError, if any of the input
parameters contain an invalid value.
</p></description>
<description><p>
readonly attribute boolean visionFaceRecognition;
readonly attribute boolean secureElement;
-
+
readonly attribute boolean nativeOspCompatible;
readonly attribute <ref>SystemInfoProfile</ref> profile;
<RaiseException name="WebAPIException">
<descriptive>
<description><p>
- with error type SecurityError, if this attribute is not allowed.
+ with error type SecurityError, if this attribute is not allowed.
</p></description>
</descriptive>
</RaiseException>
<webidl> double highThreshold;</webidl>
<descriptive>
<brief>
- An attribute to indicate that the <em>successCallback()</em> method in the watch
+ An attribute to indicate that the <em>successCallback()</em> method in the watch
operation will be triggered only if the device property is a number and its value is greater than or equal to this number.
This attribute has no effect on the <em>get()</em> method.
</brief>
</brief>
<description>
<p>
-This callback interface specifies a success callback with SystemInfoProperty as input argument.
+This callback interface specifies a success callback with SystemInfoProperty as input argument.
It is used in asynchronous
operations, such as getPropertyValue() or addPropertyValueChangeListener()
</p>
USB_HOST </li>
<li>
MMC </li>
-
+
</ul>
</description>
<descriptive>
<brief>
Indicates the current language setting in the (LANGUAGE)_(REGION) syntax.
-The language setting is in the ISO 630-2 format and the region setting is in the ISO 3166-1 format.
+The language setting is in the ISO 630-2 format and the region setting is in the ISO 3166-1 format.
The language setting is case-sensitive.
</brief>
<version>
</Attribute>
</Interface>
<Interface name="SystemInfoNetwork" id="::SystemInfo::SystemInfoNetwork">
- <webidl> [NoInterfaceObject] interface SystemInfoNetwork : <ref>SystemInfoProperty</ref> {
+ <webidl> [NoInterfaceObject] interface SystemInfoNetwork : <ref>SystemInfoProperty</ref> {
- readonly attribute <ref>SystemInfoNetworkType</ref> networkType;
+ readonly attribute <ref>SystemInfoNetworkType</ref> networkType;
};</webidl>
<descriptive>
<brief>
- This property reflects the information of the data network in this system.
+ This property reflects the information of the data network in this system.
</brief>
<version>
- 2.0
+ 2.0
</version>
</descriptive>
<ExtendedAttributeList>
<webidl> readonly attribute <ref>SystemInfoNetworkType</ref> networkType;</webidl>
<descriptive>
<brief>
- Represents the network type of the current data network.
+ Represents the network type of the current data network.
</brief>
<version>
- 2.0
+ 2.0
</version>
</descriptive>
<Type name="SystemInfoNetworkType"/>
</Attribute>
</Interface>
<Interface name="SystemInfoWifiNetwork" id="::SystemInfo::SystemInfoWifiNetwork">
- <webidl> [NoInterfaceObject] interface SystemInfoWifiNetwork : <ref>SystemInfoProperty</ref> {
+ <webidl> [NoInterfaceObject] interface SystemInfoWifiNetwork : <ref>SystemInfoProperty</ref> {
- readonly attribute DOMString status;
- readonly attribute DOMString ssid;
- readonly attribute DOMString ipAddress;
- readonly attribute DOMString ipv6Address;
- readonly attribute double signalStrength;
+ readonly attribute DOMString status;
+ readonly attribute DOMString ssid;
+ readonly attribute DOMString ipAddress;
+ readonly attribute DOMString ipv6Address;
+ readonly attribute double signalStrength;
};</webidl>
<descriptive>
<brief>
- This property reflects the information of the Wi-Fi network in this system.
+ This property reflects the information of the Wi-Fi network in this system.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<ExtendedAttributeList>
<webidl> readonly attribute DOMString status;</webidl>
<descriptive>
<brief>
- Represents the status (ON or OFF) of the Wi-Fi interface.
+ Represents the status (ON or OFF) of the Wi-Fi interface.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString ssid;</webidl>
<descriptive>
<brief>
- Represents the SSID of a Wi-Fi network.
+ Represents the SSID of a Wi-Fi network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString ipAddress;</webidl>
<descriptive>
<brief>
- Represents the IPv4 address of Wi-Fi network.
+ Represents the IPv4 address of Wi-Fi network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString ipv6Address;</webidl>
<descriptive>
<brief>
- Represents the IPv6 address of Wi-Fi network.
+ Represents the IPv6 address of Wi-Fi network.
</brief>
<version>
- 2.0
+ 2.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute double signalStrength;</webidl>
<descriptive>
<brief>
- This connection's signal strength, as a normalized value between 0 (no signal detected) and 1 (the level is at its maximum value).
+ This connection's signal strength, as a normalized value between 0 (no signal detected) and 1 (the level is at its maximum value).
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="double"/>
</Attribute>
</Interface>
<Interface name="SystemInfoCellularNetwork" id="::SystemInfo::SystemInfoCellularNetwork">
- <webidl> [NoInterfaceObject] interface SystemInfoCellularNetwork : <ref>SystemInfoProperty</ref> {
-
- readonly attribute DOMString status;
- readonly attribute DOMString apn;
- readonly attribute DOMString ipAddress;
- readonly attribute DOMString ipv6Address;
- readonly attribute unsigned short mcc;
- readonly attribute unsigned short mnc;
- readonly attribute unsigned short cellId;
- readonly attribute unsigned short lac;
+ <webidl> [NoInterfaceObject] interface SystemInfoCellularNetwork : <ref>SystemInfoProperty</ref> {
+
+ readonly attribute DOMString status;
+ readonly attribute DOMString apn;
+ readonly attribute DOMString ipAddress;
+ readonly attribute DOMString ipv6Address;
+ readonly attribute unsigned short mcc;
+ readonly attribute unsigned short mnc;
+ readonly attribute unsigned short cellId;
+ readonly attribute unsigned short lac;
readonly attribute boolean isRoaming;
readonly attribute boolean isFlightMode;
readonly attribute DOMString imei raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<brief>
- This property reflects the information of the Cellular network in this system.
+ This property reflects the information of the Cellular network in this system.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<ExtendedAttributeList>
<webidl> readonly attribute DOMString status;</webidl>
<descriptive>
<brief>
- Represents the status (ON or OFF) of the cellular network.
+ Represents the status (ON or OFF) of the cellular network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString apn;</webidl>
<descriptive>
<brief>
- Represents an Access Point Name of the cellular network.
+ Represents an Access Point Name of the cellular network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString ipAddress;</webidl>
<descriptive>
<brief>
- Represents the IPv4 address of the cellular network.
+ Represents the IPv4 address of the cellular network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute DOMString ipv6Address;</webidl>
<descriptive>
<brief>
- Represents the IPv6 address of the cellular network.
+ Represents the IPv6 address of the cellular network.
</brief>
<version>
- 2.0
+ 2.0
</version>
</descriptive>
<Type type="DOMString"/>
<webidl> readonly attribute unsigned short mcc;</webidl>
<descriptive>
<brief>
- Represents Mobile Country Code (MCC) of the cellular network.
+ Represents Mobile Country Code (MCC) of the cellular network.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="unsigned short"/>
<webidl> readonly attribute unsigned short mnc;</webidl>
<descriptive>
<brief>
- Represents Mobile Network Code (MNC) of the cellular network. MNC is used in combination with MCC (also known as a "MCC / MNC tuple") to uniquely
-identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UMTS public land mobile networks and some satellite mobile networks.
+ Represents Mobile Network Code (MNC) of the cellular network. MNC is used in combination with MCC (also known as a "MCC / MNC tuple") to uniquely
+identify a mobile phone operator/carrier using the GSM, CDMA, iDEN, TETRA and UMTS public land mobile networks and some satellite mobile networks.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="unsigned short"/>
<webidl> readonly attribute unsigned short cellId;</webidl>
<descriptive>
<brief>
- Represents Cell Id.
+ Represents Cell Id.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="unsigned short"/>
<webidl> readonly attribute unsigned short lac;</webidl>
<descriptive>
<brief>
- Represents Location Area Code.
+ Represents Location Area Code.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="unsigned short"/>
<webidl> readonly attribute boolean isRoaming;</webidl>
<descriptive>
<brief>
- Whether the connection is set up while the device is roaming.
+ Whether the connection is set up while the device is roaming.
</brief>
<version>
- 1.0
+ 1.0
</version>
</descriptive>
<Type type="boolean"/>
};</webidl>
<descriptive>
<brief>
- This property reflects the information of the SIM card information.
+ This property reflects the information of the SIM card information.
</brief>
<version>
2.0
<webidl> readonly attribute DOMString operatorName raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Operator Name String (ONS) of Common PCN Handset Specification (CPHS) in SIM card.
+ Represents the Operator Name String (ONS) of Common PCN Handset Specification (CPHS) in SIM card.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
public
<webidl> readonly attribute DOMString msisdn raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the SIM card subscriber number.
+ Represents the SIM card subscriber number.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
partner
<webidl> readonly attribute DOMString iccid raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Integrated Circuit Card ID.
+ Represents the Integrated Circuit Card ID.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
public
<webidl> readonly attribute unsigned short mcc raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Mobile Country Code (MCC) of SIM provider.
+ Represents the Mobile Country Code (MCC) of SIM provider.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
public
<webidl> readonly attribute unsigned short mnc raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Mobile Network Code (MNC) of SIM provider.
+ Represents the Mobile Network Code (MNC) of SIM provider.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
public
<webidl> readonly attribute DOMString msin raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Mobile Subscription Identification Number (MSIN) of SIM provider.
+ Represents the Mobile Subscription Identification Number (MSIN) of SIM provider.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
partner
<webidl> readonly attribute DOMString spn raises(<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
- Represents the Service Provider Name (SPN) of SIM card.
+ Represents the Service Provider Name (SPN) of SIM card.
</brief>
<version>
- 2.0
+ 2.0
</version>
<privilegelevel>
public
void getProperty(<ref>SystemSettingType</ref> type,
<ref>SystemSettingSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
-
+
};
[Callback=FunctionOnly, NoInterfaceObject] interface SystemSettingSuccessCallback {
void getProperty(<ref>SystemSettingType</ref> type,
<ref>SystemSettingSuccessCallback</ref> successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
-
+
};</webidl>
<descriptive>
<brief>
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type UnknownError in any other error case.
+ with error type UnknownError in any other error case.
</p></description>
</descriptive>
</RaiseException>
</Module>
<Module name="Time" id="::Time">
<webidl>module Time {
-
+
enum TimeDurationUnit { "MSECS", "SECS", "MINS", "HOURS", "DAYS" };
-
+
[NoInterfaceObject] interface TimeManagerObject {
readonly attribute <ref>TimeUtil</ref> time;
};
<ref>Tizen</ref> implements <ref>TimeManagerObject</ref>;
-
+
[NoInterfaceObject] interface TimeUtil {
<ref>TZDate</ref> getCurrentDateTime() raises(<ref>WebAPIException</ref>);
-
+
DOMString getLocalTimezone() raises(<ref>WebAPIException</ref>);
-
+
DOMString[] getAvailableTimezones() raises(<ref>WebAPIException</ref>);
-
+
DOMString getDateFormat(optional boolean? shortformat) raises(<ref>WebAPIException</ref>);
-
+
DOMString getTimeFormat() raises(<ref>WebAPIException</ref>);
-
+
boolean isLeapYear(long year) raises(<ref>WebAPIException</ref>);
};
interface TZDate {
long getDate();
-
+
void setDate(long date);
-
+
long getDay();
-
+
long getFullYear();
-
+
void setFullYear(long year);
-
+
long getHours();
-
+
void setHours(long hours);
-
+
long getMilliseconds();
-
+
void setMilliseconds(long ms);
-
+
long getMinutes();
-
+
void setMinutes(long minutes);
-
+
long getMonth();
-
+
void setMonth(long month);
-
+
long getSeconds();
-
+
void setSeconds(long seconds);
-
+
long getUTCDate();
-
+
void setUTCDate(long date);
-
+
long getUTCDay();
-
+
long getUTCFullYear();
-
+
void setUTCFullYear(long year);
-
+
long getUTCHours();
-
+
void setUTCHours(long hours);
-
+
long getUTCMilliseconds();
-
+
void setUTCMilliseconds(long ms);
-
+
long getUTCMinutes();
-
+
void setUTCMinutes(long minutes);
-
+
long getUTCMonth();
-
+
void setUTCMonth(long month);
-
+
long getUTCSeconds();
-
+
void setUTCSeconds(long seconds);
-
+
DOMString getTimezone();
-
+
<ref>TZDate</ref> toTimezone(DOMString tzid) raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> toLocalTimezone() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> toUTC() raises(<ref>WebAPIException</ref>);
-
+
<ref>TimeDuration</ref> difference(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
boolean equalsTo(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean earlierThan(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean laterThan(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> addDuration(<ref>TimeDuration</ref> duration) raises(<ref>WebAPIException</ref>);
-
+
DOMString toLocaleDateString();
-
+
DOMString toLocaleTimeString();
-
+
DOMString toLocaleString();
-
+
DOMString toDateString();
-
+
DOMString toTimeString();
-
+
DOMString toString();
-
+
DOMString getTimezoneAbbreviation() raises(<ref>WebAPIException</ref>);
-
+
long secondsFromUTC() raises(<ref>WebAPIException</ref>);
-
+
boolean isDST() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref>? getPreviousDSTTransition() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref>? getNextDSTTransition() raises(<ref>WebAPIException</ref>);
};
-
+
[Constructor(long long length, optional <ref>TimeDurationUnit</ref>? unit)]
interface TimeDuration
- {
+ {
attribute long long length;
-
+
attribute <ref>TimeDurationUnit</ref> unit;
-
+
<ref>TimeDuration</ref> difference(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean equalsTo(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean lessThan(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean greaterThan(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
};
};</webidl>
or any other changes that may occur to a location's time zone over time.
Without the communication of the explicit time zone rules governing a given date and
time, the ability to effectively calculate the offset of the local time to UTC or to
-any other time zone at any point in the past or future is lost.
+any other time zone at any point in the past or future is lost.
</p>
<p>
This API can be used to get TZDate objects with full time zone support, convert them
between timezones, retrieve available timezones.
</p>
<p>
-For more information on the Time features, see <a href="../../org.tizen.web.appprogramming/html/guide/sys_guide/time.htm">Time Guide</a>.
+For more information on the Time features, see <a href="../../org.tizen.web.appprogramming/html/guide/sys_guide/time.htm">Time Guide</a>.
</p>
</description>
</descriptive>
<Interface name="TimeUtil" id="::Time::TimeUtil">
<webidl> [NoInterfaceObject] interface TimeUtil {
<ref>TZDate</ref> getCurrentDateTime() raises(<ref>WebAPIException</ref>);
-
+
DOMString getLocalTimezone() raises(<ref>WebAPIException</ref>);
-
+
DOMString[] getAvailableTimezones() raises(<ref>WebAPIException</ref>);
-
+
DOMString getDateFormat(optional boolean? shortformat) raises(<ref>WebAPIException</ref>);
-
+
DOMString getTimeFormat() raises(<ref>WebAPIException</ref>);
-
+
boolean isLeapYear(long year) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
is not compatible with the expected type for that parameter.
</p></description>
<description><p>
- with error type InvalidValuesError, if any of the input
-parameters contain an invalid value.
+ with error type InvalidValuesError, if any of the input
+parameters contain an invalid value.
</p></description>
<description><p>
with error type UnknownError, if the call failed due to an unknown error.
interface TZDate {
long getDate();
-
+
void setDate(long date);
-
+
long getDay();
-
+
long getFullYear();
-
+
void setFullYear(long year);
-
+
long getHours();
-
+
void setHours(long hours);
-
+
long getMilliseconds();
-
+
void setMilliseconds(long ms);
-
+
long getMinutes();
-
+
void setMinutes(long minutes);
-
+
long getMonth();
-
+
void setMonth(long month);
-
+
long getSeconds();
-
+
void setSeconds(long seconds);
-
+
long getUTCDate();
-
+
void setUTCDate(long date);
-
+
long getUTCDay();
-
+
long getUTCFullYear();
-
+
void setUTCFullYear(long year);
-
+
long getUTCHours();
-
+
void setUTCHours(long hours);
-
+
long getUTCMilliseconds();
-
+
void setUTCMilliseconds(long ms);
-
+
long getUTCMinutes();
-
+
void setUTCMinutes(long minutes);
-
+
long getUTCMonth();
-
+
void setUTCMonth(long month);
-
+
long getUTCSeconds();
-
+
void setUTCSeconds(long seconds);
-
+
DOMString getTimezone();
-
+
<ref>TZDate</ref> toTimezone(DOMString tzid) raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> toLocalTimezone() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> toUTC() raises(<ref>WebAPIException</ref>);
-
+
<ref>TimeDuration</ref> difference(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
boolean equalsTo(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean earlierThan(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean laterThan(<ref>TZDate</ref> other) raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref> addDuration(<ref>TimeDuration</ref> duration) raises(<ref>WebAPIException</ref>);
-
+
DOMString toLocaleDateString();
-
+
DOMString toLocaleTimeString();
-
+
DOMString toLocaleString();
-
+
DOMString toDateString();
-
+
DOMString toTimeString();
-
+
DOMString toString();
-
+
DOMString getTimezoneAbbreviation() raises(<ref>WebAPIException</ref>);
-
+
long secondsFromUTC() raises(<ref>WebAPIException</ref>);
-
+
boolean isDST() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref>? getPreviousDSTTransition() raises(<ref>WebAPIException</ref>);
-
+
<ref>TZDate</ref>? getNextDSTTransition() raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<Type name="TZDate">
<descriptive>
<description><p>
- TZDate New TZDate in given Timezone.
+ TZDate New TZDate in given Timezone.
</p></description>
</descriptive>
</Type>
<Type name="TZDate">
<descriptive>
<description><p>
- TZDate The new TZDate in local Timezone.
+ TZDate The new TZDate in local Timezone.
</p></description>
</descriptive>
</Type>
<Argument name="duration">
<descriptive>
<description><p>
- TimeDuration to add.
+ TimeDuration to add.
</p></description>
</descriptive>
<Type name="TimeDuration"/>
<descriptive>
<description><p>
with error type TypeMismatchError, if the input parameter
-is not compatible with the expected type for that parameter.
+is not compatible with the expected type for that parameter.
</p></description>
<description><p>
with error type UnknownError, if the call failed due to an unknown error.
<Interface name="TimeDuration" id="::Time::TimeDuration">
<webidl> [Constructor(long long length, optional <ref>TimeDurationUnit</ref>? unit)]
interface TimeDuration
- {
+ {
attribute long long length;
-
+
attribute <ref>TimeDurationUnit</ref> unit;
-
+
<ref>TimeDuration</ref> difference(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean equalsTo(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean lessThan(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
-
+
boolean greaterThan(<ref>TimeDuration</ref> other) raises(<ref>WebAPIException</ref>);
};</webidl>
<descriptive>
<brief>
- The TimeDuration object that contains the length and its associated
+ The TimeDuration object that contains the length and its associated
time unit.
</brief>
<version>
readonly attribute DOMString message;
const unsigned short INDEX_SIZE_ERR = 1;
- const unsigned short DOMSTRING_SIZE_ERR = 2;
+ const unsigned short DOMSTRING_SIZE_ERR = 2;
const unsigned short HIERARCHY_REQUEST_ERR = 3;
const unsigned short WRONG_DOCUMENT_ERR = 4;
const unsigned short INVALID_CHARACTER_ERR = 5;
- const unsigned short NO_DATA_ALLOWED_ERR = 6;
+ const unsigned short NO_DATA_ALLOWED_ERR = 6;
const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7;
const unsigned short NOT_FOUND_ERR = 8;
const unsigned short NOT_SUPPORTED_ERR = 9;
- const unsigned short INUSE_ATTRIBUTE_ERR = 10;
+ const unsigned short INUSE_ATTRIBUTE_ERR = 10;
const unsigned short INVALID_STATE_ERR = 11;
const unsigned short SYNTAX_ERR = 12;
const unsigned short INVALID_MODIFICATION_ERR = 13;
const unsigned short NAMESPACE_ERR = 14;
const unsigned short INVALID_ACCESS_ERR = 15;
- const unsigned short VALIDATION_ERR = 16;
+ const unsigned short VALIDATION_ERR = 16;
const unsigned short TYPE_MISMATCH_ERR = 17;
const unsigned short SECURITY_ERR = 18;
const unsigned short NETWORK_ERR = 19;
the Tizen Web Device API is instantiated (<em>window.tizen</em>).
</p>
<p>
-For more information on the Tizen features, see <a href="../../org.tizen.web.appprogramming/html/guide/tizen_guide/tizen.htm">Tizen Guide</a>.
+For more information on the Tizen features, see <a href="../../org.tizen.web.appprogramming/html/guide/tizen_guide/tizen.htm">Tizen Guide</a>.
</p>
</description>
<version>
</p>
<ul>
<li>
-EXACTLY - Indicates that an attribute value should match exactly with the specified default value.
+EXACTLY - Indicates that an attribute value should match exactly with the specified default value.
For strings, this type of comparison is case-sensitive. </li>
<li>
FULLSTRING - Indicates String-based comparison and that the attribute value should match the whole string (case insensitive). </li>
<li>
CONTAINS - Indicates that an attribute value should contain the specified string. This type of comparison works only on strings and is case insensitive. </li>
<li>
-STARTSWITH - Indicates that an attribute value should start with the specified string.
+STARTSWITH - Indicates that an attribute value should start with the specified string.
This type of comparison works only on strings and is case insensitive. </li>
<li>
ENDSWITH - Indicates that an attribute value should end with the specified string. This type of comparison works only on strings and is case insensitive. </li>
readonly attribute DOMString message;
const unsigned short INDEX_SIZE_ERR = 1;
- const unsigned short DOMSTRING_SIZE_ERR = 2;
+ const unsigned short DOMSTRING_SIZE_ERR = 2;
const unsigned short HIERARCHY_REQUEST_ERR = 3;
const unsigned short WRONG_DOCUMENT_ERR = 4;
const unsigned short INVALID_CHARACTER_ERR = 5;
- const unsigned short NO_DATA_ALLOWED_ERR = 6;
+ const unsigned short NO_DATA_ALLOWED_ERR = 6;
const unsigned short NO_MODIFICATION_ALLOWED_ERR = 7;
const unsigned short NOT_FOUND_ERR = 8;
const unsigned short NOT_SUPPORTED_ERR = 9;
- const unsigned short INUSE_ATTRIBUTE_ERR = 10;
+ const unsigned short INUSE_ATTRIBUTE_ERR = 10;
const unsigned short INVALID_STATE_ERR = 11;
const unsigned short SYNTAX_ERR = 12;
const unsigned short INVALID_MODIFICATION_ERR = 13;
const unsigned short NAMESPACE_ERR = 14;
const unsigned short INVALID_ACCESS_ERR = 15;
- const unsigned short VALIDATION_ERR = 16;
+ const unsigned short VALIDATION_ERR = 16;
const unsigned short TYPE_MISMATCH_ERR = 17;
const unsigned short SECURITY_ERR = 18;
const unsigned short NETWORK_ERR = 19;
<descriptive>
<brief>
An error type. The name attribute must return the value it was initialized with.
-This attribute can have one of the following values:
+This attribute can have one of the following values:
</brief>
<description>
<ul>
ServiceNotAvailableError - The requested service is not available. </li>
</ul>
<p>
-For other possible values for this attribute, see the values defined in <a href="http://www.w3.org/TR/dom/#error-types">DOM error types</a>
+For other possible values for this attribute, see the values defined in <a href="http://www.w3.org/TR/dom/#error-types">DOM error types</a>
</p>
</description>
<version>
<webidl> readonly attribute DOMString message;</webidl>
<descriptive>
<brief>
- An error message that describes the details of an encountered error.
+ An error message that describes the details of an encountered error.
This attribute is mainly intended to be used for developers rather than end users, so it should not be used directly in the user interfaces as it is.
</brief>
<version>
<descriptive>
<brief>
An error type. The name attribute must return the value it was initialized with.
-This attribute can have one of the following values:
+This attribute can have one of the following values:
</brief>
<description>
<ul>
ServiceNotAvailableError - The requested service is not available. </li>
</ul>
<p>
-For other possible values for this attribute, see the values defined in <a href="http://www.w3.org/TR/dom/#error-types">DOM error types</a>
+For other possible values for this attribute, see the values defined in <a href="http://www.w3.org/TR/dom/#error-types">DOM error types</a>
</p>
</description>
<version>
[NoInterfaceObject] interface WebSettingManager {
- void setUserAgentString(DOMString userAgent,
- optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
+ void setUserAgentString(DOMString userAgent,
+ optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
+
+ void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
- void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
-
};
};</webidl>
<descriptive>
Set a custom user agent string of the web view in the Web application. </li>
</ul>
<p>
-Note that all the settings using the Web setting API is bound to your application; thus, no other applications are affected via the Web setting API calls within your application.
+Note that all the settings using the Web setting API is bound to your application; thus, no other applications are affected via the Web setting API calls within your application.
</p>
</description>
<version>
</brief>
<description>
<p>
-<em>tizen.websetting</em> object is available to manage the settings of the Web view in your Web application.
+<em>tizen.websetting</em> object is available to manage the settings of the Web view in your Web application.
</p>
</description>
<version>
<Interface name="WebSettingManager" id="::WebSetting::WebSettingManager">
<webidl> [NoInterfaceObject] interface WebSettingManager {
- void setUserAgentString(DOMString userAgent,
- optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
+ void setUserAgentString(DOMString userAgent,
+ optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
+
+ void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
+ optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
- void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
- optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);
-
};</webidl>
<descriptive>
<brief>
</ExtendedAttribute>
</ExtendedAttributeList>
<Operation name="setUserAgentString" id="::WebSetting::WebSettingManager::setUserAgentString">
- <webidl> void setUserAgentString(DOMString userAgent,
- optional <ref>SuccessCallback</ref>? successCallback,
+ <webidl> void setUserAgentString(DOMString userAgent,
+ optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
<description>
<p>
This method allows the user to set the user agent string of the Web view in the Web application. By default, the Web view in your application
-has the same user agent string as the Tizen browser on the device.
+has the same user agent string as the Tizen browser on the device.
</p>
<p>
The <em>ErrorCallback</em> is launched with these error types:
}
tizen.websetting.setUserAgentString("the new user agent string to set", successCallback);
-
+
</Code>
</descriptive>
<Type type="void"/>
<Argument name="userAgent">
<descriptive>
<description><p>
- User agent to set for the Web view in your Web application.
+ User agent to set for the Web view in your Web application.
</p></description>
</descriptive>
<Type type="DOMString"/>
</Raises>
</Operation>
<Operation name="removeAllCookies" id="::WebSetting::WebSettingManager::removeAllCookies">
- <webidl> void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
+ <webidl> void removeAllCookies(optional <ref>SuccessCallback</ref>? successCallback,
optional <ref>ErrorCallback</ref>? errorCallback) raises (<ref>WebAPIException</ref>);</webidl>
<descriptive>
<brief>
</brief>
<description>
<p>
-The Web view in your Web application can store cookies like a browser. This method allows the user to remove all the cookies saved for the Web application.
+The Web view in your Web application can store cookies like a browser. This method allows the user to remove all the cookies saved for the Web application.
</p>
<p>
The <em>ErrorCallback</em> is launched with these error types:
}
tizen.websetting.removeAllCookies(successCallback);
-
+
</Code>
</descriptive>
<Type type="void"/>
<Argument optional="optional" name="successCallback">
<descriptive>
<description><p>
- To be invoked if the requested delete operation succeeds.
+ To be invoked if the requested delete operation succeeds.
</p></description>
</descriptive>
<Type name="SuccessCallback" nullable="nullable"/>
projects / profile / ivi / sdk / web-ide-resources.git / commitdiff