The Iotcon API provides functions for IoT connectivity.
It allows to register, discover and access to resources via RESTful API.
Since: 3.0
A resource type.
typedef DOMString ResourceType;
Remark : The length of resource type should be less than or equal to 61. The resource type must start with a lowercase alphabetic character, followed by a sequence of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.
Enumeration for quality of service level.
enum QosLevel{ "HIGH", "LOW" };
The following values are supported:
Enumeration for result of response.
enum ResponseResult { "SUCCESS", "ERROR", "RESOURCE_CREATED", "RESOURCE_DELETED", "RESOURCE_CHANGED", "SLOW", "FORBIDDEN" };
Enumeration for result of presence response.
enum PresenceResponseResultType { "OK", "STOPPED", "TIMEOUT" };
Enumeration for trigger type of presence. It is set only if a PresenceResponseResultType is OK.
enum PresenceTriggerType { "CREATED", "UPDATED", "DESTROYED" };
Enumeration for connectivities type of connection.
enum ConnectivityType { "IP", "PREFER_UDP", "PREFER_TCP", "IPV4_ONLY", "IPV6_ONLY", "ALL" };
Type of interfaces which can be held in a resource.
typedef DOMString ResourceInterface;
The following values are allowed:
Enumeration for policy of observation.
enum ObservePolicy { "IGNORE_OUT_OF_ORDER", "ACCEPT_OUT_OF_ORDER" };
Enumeration for type of observation.
enum ObserveType { "NO_TYPE", "REGISTER", "DEREGISTER" };
This interface defines what is instantiated by the Tizen object from the Tizen platform.
[NoInterfaceObject] interface IotconObject { readonly attribute Iotcon iotcon; };
Tizen implements IotconObject;
There is a tizen.iotcon object that allows access to the Iotcon API.
This interface provides access to the IotconObject object.
[NoInterfaceObject] interface Iotcon { attribute DOMString deviceName; void initialize(DOMString filePath) raises(WebAPIException); Client getClient(); Server getServer(); long getTimeout(); void setTimeout(long timeout) raises(WebAPIException); long addGeneratedPinListener(GeneratedPinCallback successCallback) raises(WebAPIException); void removeGeneratedPinListener(long watchId) raises(WebAPIException); };
DOMString deviceName
The device name of this application.
initialize
Connects to the iotcon service. Call this function to start Iotcon.
void initialize(DOMString filePath);
Privilege level: public
Privilege: http://tizen.org/privilege/internet
Remark : Recommends to use application local file for CBOR file path. If you want to know about iotivity security in detail, See iotivity security.
Parameters:
Exceptions:
with error type SecurityError, if the application does not have the privilege to call this method.
with error type AbortError, if the operation has been stopped.
Code example:
try { var cborPath = "App_installed_fullpath/iotcon-test.dat" tizen.iotcon.initialize(cborPath); tizen.iotcon.deviceName = "my_test"; } catch(err) { console.log(err.name +': ' + err.message); }
getClient
Returns object of Client singleton, which provides methods for working with remote resources.
Client getClient();
Return value:
Client The Client object.
try { var cborPath = "App_installed_fullpath/iotcon-test.dat" tizen.iotcon.initialize(cborPath); tizen.iotcon.deviceName = "my_test"; var iotClient = tizen.iotcon.getClient(); } catch(err) { console.log(err.name +': ' + err.message); }
getServer
Returns the Server object, which provides methods for managing resources on current device.
Server getServer();
Server The Server object.
try { var cborPath = "App_installed_fullpath/iotcon-test.dat" tizen.iotcon.initialize(cborPath); tizen.iotcon.deviceName = "my_test"; var iotServer = tizen.iotcon.getServer(); } catch(err) { console.log(err.name +': ' + err.message); }
getTimeout
Returns the number of seconds set as the timeout threshold of asynchronous API.
long getTimeout();
This method returns the common timeout value for methods: findDeviceInfo findPlatformInfo findResource methodGet methodPut methodPost methodDelete All asynchronous APIs have the same timeout value, there is no way to have different timeout values at each method. Without a response after the specified time, the mentioned methods would trigger an error callback with TimeoutError.
long The timeout value in seconds.
tizen.iotcon.setTimeout(60); var timeout = tizen.iotcon.getTimeout(); console.log("timeout value is " + timeout);
Output example:
timeout value is 60
setTimeout
Sets the timeout value, in seconds, of asynchronous APIs.
void setTimeout(long timeout);
The timeout value is common for methods: findDeviceInfo findPlatformInfo findResource methodGet methodPut methodPost methodDelete All asynchronous APIs have the same timeout value, there is no way to have different timeout values at each method. Without a response after the specified time, the mentioned methods would trigger an error callback with TimeoutError.
addGeneratedPinListener
Adds a listener to receive generated random pin from provisioning tool .
long addGeneratedPinListener(GeneratedPinCallback successCallback);
Remark : Listener's callback only be invoked when provisioning tool tries to register this device using random pin based. If you want to know about provisioning tool and random pin, See iotivity provisioning.
long The watchID which can be used to remove the listener
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type AbortError, If the operation has been stopped.
var watchId function RandomPinSuccess(pin){ console.log("Pin code : " + pin); tizen.iotcon.removeGeneratedPinListener(watchId); } var cborPath = "App_installed_fullpath/iotcon-test.dat" tizen.iotcon.initialize(cborPath); watchId =tizen.iotcon.addGeneratedPinListener(RandomPinSuccess);
Pin code : 73883075
removeGeneratedPinListener
Unregisters the listener and stops receiving generated random pin.
void removeGeneratedPinListener(long watchId);
Remark : Example of using can be find at addGeneratedPinListener code example.
The Client provides API for client side.
[NoInterfaceObject] interface Client { void findResource(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundResourceSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); long addPresenceEventListener(DOMString? hostAddress, ResourceType? resourceType, ConnectivityType connectivityType, PresenceEventCallback successCallback) raises(WebAPIException); void removePresenceEventListener(long watchId) raises(WebAPIException); void findDeviceInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundDeviceInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void findPlatformInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundPlatformInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); };
findResource
Finds resources using host address and resource type.
void findResource(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundResourceSuccessCallback successCallback, optional ErrorCallback? errorCallback);
The ErrorCallback is launched with these error types:
remarks hostAddress should be in the format coap://address:port. For example "coaps://[fe80::ae5a:14ff:fe24:b8fe]:12345" or "coaps://192.168.1.10:12345".
function onerror(err) { console.log("Failed to find resource: " + err.message); } function foundSuccess(resource) { if(resource) { console.log("######## Found a resource ########") console.log("URI: " + resource.uriPath); console.log("Host Address: " + resource.hostAddress); console.log("Device ID: " + resource.deviceId); var resourceTypes = resource.resourceTypes; console.log("Resource Types: "); for(var index in resourceTypes) { console.log(" " + resourceTypes[index]); } var resourceInterfaces = resource.resourceInterfaces; console.log("Resource interfaces: "); for(var index in resourceInterfaces) { console.log(" " + resourceInterfaces[index]); } } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
######## Found a resource ######## URI: /door Host Address: coaps://192.168.0.10:12345 Device ID: 3f58ff10-fc23-444c-9e42-e15b295722a7 Resource types: core.door Resource interfaces: oic.if.b
addPresenceEventListener
Adds a listener to receive a presence events from the server. A server sends presence events when starts or stops presence.
long addPresenceEventListener(DOMString? hostAddress, ResourceType? resourceType, ConnectivityType connectivityType, PresenceEventCallback successCallback);
var client; var watchID; var connectivityType = "IP"; function presenceSuccess(presenceResponse) { console.log("######## Get a presence response ########"); if(presenceResponse.resultType != "OK") { console.log("the result is not OK") return; } console.log("Trigger type: " + presenceResponse.triggerType); console.log("Host address: " + presenceResponse.hostAddress); console.log("Connectivity type: " + presenceResponse.connectivityType); console.log("Presence resource type: " + presenceResponse.resourceType); client.removePresenceEventListener(watchID); } try { client = tizen.iotcon.getClient(); watchID = client.addPresenceEventListener(null, null, connectivityType, presenceSuccess); } catch(err) { console.log(err.name +': ' + err.message); }
######## Get a presence response ######## Trigger type: UPDATED Host address: coaps://192.168.0.10:12345 Connectivity type: IP Resource type: oic.wk.ad
removePresenceEventListener
Unregisters a presence event listener.
void removePresenceEventListener(long watchId);
Remark : Example of using can be find at addPresenceEventListener code example.
findDeviceInfo
Gets the device information of remote server.
void findDeviceInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundDeviceInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback);
// hostDeviceIpAddress should be a valid IP address var hostDeviceIpAddress = "coaps://192.168.0.10:12345"; var connectivityType = "IP"; var query = { resourceType: "core.door" }; function onerror(err) { console.log("Failed to find resource: " + err.message); } function foundSuccess(deviceInfo) { if(deviceInfo) { console.log("######## Get a device info ########"); console.log("Name: " + deviceInfo.deviceName); // human friendly name for device. console.log("Spec version: " + deviceInfo.specVersion); // spec version of the core specification. console.log("ID: " + deviceInfo.oicDeviceId); // unique identifier for OIC device. console.log("Data model version: " + deviceInfo.dataModelVersion); // version of the specs this device data model is implemented to. } } try { var client = tizen.iotcon.getClient(); client.findDeviceInfo(hostDeviceIpAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
######## Get a device info ######## Name: Tizen Spec version: core.1.0.0 ID: 3f58ff10-fc23-444c-9e42-e15b295722a7 Data model version: res.1.0.0
findPlatformInfo
Gets the platform information of remote server.
void findPlatformInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundPlatformInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback);
var hostDeviceIpAddress = "coaps://192.168.0.10:12345"; var connectivityType = "IP"; var query = { resourceType: "core.door" }; function onerror(err) { console.log("Failed to find resource: " + err.message); } function foundSuccess(platformInfo) { console.log("######## Get a platform info ########"); console.log("ID: " + platformInfo.platformId); console.log("Manufacturer name: " + platformInfo.manufacturerName); console.log("Manufacturer URL: " + platformInfo.manufacturerUrl); console.log("Model number: " + platformInfo.modelNumber); console.log("Date of manufacture: " + platformInfo.manufactureDate); console.log("Platform version: " + platformInfo.platformVersion); console.log("OS version: " + platformInfo.operatingSystemVersion); console.log("Hardware version: " + platformInfo.hardwareVersion); console.log("Firmware version: " + platformInfo.firmwareVersion); console.log("Support URL: " + platformInfo.supportUrl); console.log("System time: " + platformInfo.systemTime); } try { var client = tizen.iotcon.getClient(); client.findPlatformInfo(hostDeviceIpAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
######## Get a platform info ######## ID: Tizen Manufacturer name: Tizen Manufacturer URL: Model number: tm1 Date of manufacture: Platform version: 3.0 OS version: Hardware version: Firware version: tizen-mobile_20160220.2 Support URL: System time:
Provides functions for creating resource, registering a resource, handling request from client .
[NoInterfaceObject] interface Server { Resource[] getResources() raises(WebAPIException); Resource createResource(DOMString uriPath, ResourceType[] resourceTypes, ResourceInterface[] resourceInterfaces, RequestCallback listener, optional ResourcePolicy policy) raises(WebAPIException); void removeResource(Resource resource) raises(WebAPIException); void startPresence(unsigned long timeToLive) raises(WebAPIException); void stopPresence() raises(WebAPIException); };
A Resource is a component in a server that can be viewed and controlled by another client. There are different resource types, for example a temperature sensor, a light controller etc.
getResources
Returns an array of resources which are registered on the server.
Resource[] getResources();
Array of Resource objects registered on server.
var server = tizen.iotcon.getServer(); var resources = server.getResources();
createResource
Creates a resource and registers the resource on server.
Resource createResource(DOMString uriPath, ResourceType[] resourceTypes, ResourceInterface[] resourceInterfaces, RequestCallback listener, optional ResourcePolicy policy);
Instance of Resource object.
var server = tizen.iotcon.getServer(); var doorResource; var uriPath = "/door"; var resourceTypes = ["core.door"]; var resourceInterfaces = ["oic.if.b"]; var attributes = { openstate : 'open' }; var policy = { isObservable : true, isDiscoverable : true }; var requestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); //add request handle code }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); //add request handle code }, onobserving: function(request, observeType, observeId) { console.log("onobserving"); //add request handle code } } doorResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy);
removeResource
Removes the resource and unregisters it from server.
void removeResource(Resource resource);
var resource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); server.removeResource(resource);
startPresence
Starts sending presence event of server. Server can send presence event to client when become online for the first time or come back from offline to online.
void startPresence(unsigned long timeToLive);
Remark : If Server doesn't call startPresence(), client can't get presence event with addPresenceEventListener().
Remark : If timeToLive is 0, server will set default value as 60 seconds. If timeToLive is bigger than maximum seconds, server will set maximum value as (60 * 60 * 24) seconds (24 hours).
var server = tizen.iotcon.getServer(); server.startPresence(60); /* Do something */ server.stopPresence();
stopPresence
Stops sending presence announcement of a server.
void stopPresence();
Remark : Example of using can be find at startPresence code example.
This interface provides API to manage remote resource for client side.
interface RemoteResource { readonly attribute DOMString uriPath; readonly attribute ConnectivityType connectivityType; readonly attribute DOMString hostAddress; readonly attribute ResourceType[] resourceTypes; readonly attribute ResourceInterface[] resourceInterfaces; readonly attribute boolean isObservable; readonly attribute boolean isDiscoverable; readonly attribute boolean isActive; readonly attribute boolean isSlow; readonly attribute boolean isSecure; readonly attribute boolean isExplicitDiscoverable; readonly attribute DOMString deviceId; readonly attribute DOMString deviceName; attribute IotconOption[]? options; readonly attribute Representation? cachedRepresentation; attribute long timeInterval; void methodGet(RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodPut(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodPost(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodDelete(RemoteResourceResponseCallback responseCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void startObserving(ObservePolicy observePolicy, RemoteResourceResponseCallback successCallback, optional Query? query) raises(WebAPIException); void stopObserving() raises(WebAPIException); void startCaching(optional CacheUpdatedCallback? updatedCallback) raises(WebAPIException); void stopCaching() raises(WebAPIException); void setResourceStateChangeListener(ResourceStateChangeCallback successCallback) raises(WebAPIException); void unsetResourceStateChangeListener() raises(WebAPIException); };
readonly DOMString uriPath
The resource URI.
readonly ConnectivityType connectivityType
It is connectivity type.
readonly DOMString hostAddress
The host address
readonly ResourceType[] resourceTypes
A list of types in this resource
readonly ResourceInterface[] resourceInterfaces
A list of interfaces in the resource.
readonly boolean isObservable
Indicates if the resource is observable or not
readonly boolean isDiscoverable
Indicates if the resource is discoverable or not
readonly boolean isActive
Indicates if the resource is initialized and activated or not
readonly boolean isSlow
Indicates if the resource takes some delay to respond or not
readonly boolean isSecure
Indicates if the resource is secure or not
readonly boolean isExplicitDiscoverable
Indicates if the resource is is allowed to be discovered only if discovery request contains an explicit querystring or not
readonly DOMString deviceId
The device unique id. this is unique per-server independent on how it was discovered.
readonly DOMString deviceName
The device name of the remote resource.
options [nullable]
The option for managing vendor specific option of COAP packet.
Remark : Options can have up to 2 IotconOption.
readonly Representation cachedRepresentation [nullable]
The cached representation of remote resource.
long timeInterval
The time interval in seconds for monitoring state (registered with setResourceStateChangeListener() ) and caching (registered with startCaching() ). Provided value must be in range from 1 to 3600 inclusive. The default value is 10 seconds.
methodGet
Gets the attributes of a resource.
void methodGet(RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback);
var query = {}; function onerror(err) { console.log("Error occured: " + err.message); } function onresponse(remoteResponse) { if(remoteResponse.result != "SUCCESS") { console.log("the result is not SUCCESS"); return; } var repr = remoteResponse.representation; console.log("Resource attributes: ") for(var key in repr.attributes) { console.log(" key: " + key + ", value: " + repr.attributes[key]); } } function foundSuccess(resource) { if(resource){ query["filter"] = {openstate: 'open'}; resource.methodGet(onresponse, query, onerror); } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log (err.name +': ' + err.message); }
Resource attributes: key: openstate, value: open
methodPut
Puts the representation of a resource for update.
void methodPut(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback);
var query = {}; var representation; var uriPath = "/door"; function onerror(err) { console.log("Error occured: " + err.message); } function onresponse(remoteResponse) { console.log("result is "+remoteResponse.result ); var repr = remoteResponse.representation; console.log("representation attributes: ") for(var key in repr.attributes) { console.log(" key: " + key + ", value: " + repr.attributes[key]); } } function foundSuccess(resource) { if(resource){ query["filter"] = {openstate: 'open'}; representation = new tizen.Representation(uriPath); representation.resourceTypes = ["core.door"]; representation.attributes = {openstate : 'closed'}; resource.methodPut(representation, onresponse, query, onerror); } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
result is RESOURCE_CHANGED representation attributes: key: openstate, value: closed
methodPost
Posts the representation of a resource for create.
void methodPost(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback);
var representation; var uriPath = "/door"; function onerror(err) { console.log("Error occured: " + err.message); } function onresponse(remoteResponse) { console.log("result is "+remoteResponse.result ); var repr = remoteResponse.representation; console.log("representation attributes: ") for(var key in repr.attributes) { console.log(" key: " + key + ", value: " + repr.attributes[key]); } } function foundSuccess(resource) { if(resource){ representation = new tizen.Representation(uriPath); representation.resourceTypes = ["core.door"]; representation.attributes = {openstate: 'closed'}; resource.methodPost(representation, onresponse, null, onerror); } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
methodDelete
Deletes the remote resource.
void methodDelete(RemoteResourceResponseCallback responseCallback, optional ErrorCallback? errorCallback);
function onerror(err) { console.log("Error occured: " + err.message); } function onresponse(remoteResponse) { if(remoteResponse.result == "RESOURCE_DELETED" || remoteResponse.result == "SUCCESS") { console.log("Successfully deleted"); } function foundSuccess(resource) { if(resource){ resource.methodDelete(onresponse, onerror); } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log (err.name +': ' + err.message); }
Successfully deleted
startObserving
Sets the listener to receive notification about attribute change of remote resource. When server sends notification message, successCallback will be called.
void startObserving(ObservePolicy observePolicy, RemoteResourceResponseCallback successCallback, optional Query? query);
var doorResource; function onchanged(remoteResponse) { if(remoteResponse.result == "SUCCESS") { var attributes = remoteResponse.representation.attributes; console.log("start observing, door is " + attributes["openstate"]); } doorResource.stopObserving(); } function foundSuccess(resource) { if(resource) { if(resource.uriPath == "/door") { doorResource = resource; try { doorResource.startObserving("IGNORE_OUT_OF_ORDER", onchanged); } catch(err) { console.log(err.name + ': ' + err.message); } } } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log(err.name +': ' + err.message); }
start observing, door is open
stopObserving
Unregisters the listener. so stop receiving notification about attribute change of remote resource.
void stopObserving();
Remark : Example of using can be find at startObserving code example.
startCaching
Starts caching of a remote resource. cached representation is updated when remote resource is changed.
void startCaching(optional CacheUpdatedCallback? updatedCallback);
with error type InvalidStateError, this error occur when already started.
var resource; function onerror(err) { console.log("Error occured: " + err.message); } function onupdated(representation) { console.log("######## updated representation ########"); for(var key in representation.attributes) { console.log("key: " + key + ", value: " + representation.attributes[key]); } resource.stopCaching(); } function foundSuccess(remoteResource) { if(remoteResource) { resource = remoteResource; remoteResource.startCaching(onupdated); //start caching } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log (err.name +': ' + err.message); }
######## updated representation ######## key: openstate, value: open
stopCaching
Stops caching of a remote resource.
void stopCaching();
Remark : Example of using can be find at startCaching code example.
with error type AbortError, If the operation has been stopped
setResourceStateChangeListener
Sets a listener to monitor the state of the remote resource.
void setResourceStateChangeListener(ResourceStateChangeCallback successCallback);
var doorResource; function onchanged(isAlive) { if (isAlive == true) { console.log("Remote resource is alive"); } else { console.log("Remote resource is lost"); } doorResource.unsetResourceStateChangeListener(); } function foundSuccess(resource) { if(resource) { if(resource.uriPath == "/door") { try { resource.setResourceStateChangeListener(onchanged); } catch(err) { console.log(err.name + ': ' + err.message); } } } } try { var client = tizen.iotcon.getClient(); var hostAddress = null; var query = { resourceType: "core.door" }; var connectivityType = "IP"; client.findResource(hostAddress, query, connectivityType, foundSuccess, onerror); } catch(err) { console.log (err.name +': ' + err.message); }
Remote resource is alive
unsetResourceStateChangeListener
Unsets the listener to stop monitoring the state of the remote resource.
void unsetResourceStateChangeListener();
Remark : Example of using can be find at setResourceStateChangeListener code example.
The ResourcePolicy dictionary specifies resource attributes upon resource creation.
dictionary ResourcePolicy { boolean isObservable; boolean isDiscoverable; boolean isActive; boolean isSlow; boolean isSecure; boolean isExplicitDiscoverable; };
This dictionary is used to input parameters when resources are created.
boolean isObservable
Indicates resource that is allowed to be observed.
The default value is false
boolean isDiscoverable
Indicates resource that is allowed to be discovered.
The default value is true
boolean isActive
Indicates resource initialized and activated.
boolean isSlow
Indicates resource which takes some delay to respond.
boolean isSecure
Indicates secure resource.
boolean isExplicitDiscoverable
When this value is set true, the resource is allowed to be discovered only if discovery request contains an explicit querystring.
This interface provides API to manage resource for server side.
[NoInterfaceObject] interface Resource { readonly attribute DOMString uriPath; readonly attribute ResourceType[] resourceTypes; readonly attribute ResourceInterface[] resourceInterfaces; readonly attribute boolean isObservable; readonly attribute boolean isDiscoverable; readonly attribute boolean isActive; readonly attribute boolean isSlow; readonly attribute boolean isSecure; readonly attribute boolean isExplicitDiscoverable; readonly attribute Resource[] resources; readonly attribute long[] observerIds; attribute object? attributes; void notify(QosLevel qosLevel, optional long[]? observerIds) raises(WebAPIException); void addResourceTypes(ResourceType[] types) raises(WebAPIException); void addResourceInterface(ResourceInterface interface) raises(WebAPIException); void addChildResource(Resource resource) raises(WebAPIException); void removeChildResource(Resource resource) raises(WebAPIException); void setRequestListener(RequestCallback listener) raises(WebAPIException); void unsetRequestListener(); };
A list of types in this resource.
readonly Resource[] resources
A list of childs of this resource. Since: 3.0
readonly long[] observerIds
A list of observation IDs of this resource. Since: 3.0
object attributes [nullable]
A lists of attributes of this resource.
notify
Notifies specific clients that resource's attributes have been changed.
void notify(QosLevel qosLevel, optional long[]? observerIds);
with error type InvalidValuesError, if any input parameter does not contain a valid value.
resource.attributes = {openstate: 'open'}; resource.notify("LOW", resource.observerIds);
addResourceTypes
Adds resource type to this resource.
void addResourceTypes(ResourceType[] types);
var server = tizen.iotcon.getServer(); var uriPath = "/door"; var resourceTypes = ["core.door"]; var resourceInterfaces = ["oic.if.b"]; var resource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); var types = [ "org.tizen.door"]; resource.addResourceTypes(types);
addResourceInterface
Adds resource interface to this resource.
void addResourceInterface(ResourceInterface interface);
var resource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); var interface = "oic.if.ll"; resource.addResourceInterface(interface);
addChildResource
Adds child resource into the parent resource.
void addChildResource(Resource resource);
var doorResource; var lockResource; var uriPath = "/door"; var resourceTypes = ["core.door"]; var resourceInterfaces : ["oic.if.b"]; var doorAttributes = { openstate : 'open' }; var requestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = doorResource.attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); //add request handle code }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); //add request handle code }, onobserving: function(request, observeType, observeId) { console.log("onobserving"); //add request handle code } } doorResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); doorResource.attributes = doorAttributes; uriPath = "/door/lock"; resourceTypes = ["core.lock"]; resourceInterfaces : ["oic.if.baseline"]; var lockAttributes = { lockstate : 'closed' }; policy = { isObservable : true, isDiscoverable : true }; var lockRequestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(lockResource.uriPath); representation.resourceTypes =lockResource.resourceTypes; representation.resourceInterfaces = lockResource.resourceInterfaces; representation.attributes = lockResource.attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); //add request handle code }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); //add request handle code }, onobserving: function(request, observeType, observeId) { console.log("onobserving"); //add request handle code } } lockResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, lockRequestListener, policy); lockResource.attributes = lockAttributes; doorResource.addChildResource(lockResource);
removeChildResource
Removes child resource from the parent resource.
void removeChildResource(Resource resource);
with error type InvalidValuesError, if the resource does not have the input child resource.
var lockResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); doorResource.addChildResource(lockResource); doorResource.removeChildResource(lockResource);
setRequestListener
Sets the listener for request from client.
void setRequestListener(RequestCallback listener);
var server; var doorResource; var requestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = doorResource.attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); //add request handle code }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); //add request handle code }, onobserving: function(request, observeType, observeId) { console.log("onobserving"); //add request handle code } } var newRequestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = doorResource.attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); var response = new tizen.Response(request); try { doorResource.attributes = request.representation.attributes; response.representation = request.representation; response.result = "RESOURCE_CHANGED"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = doorResource.attributes; response.representation = representation; response.result = "RESOURCE_DELETED"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); server.removeResource(doorResource); }, onobserving: function(request, observeType, observeId) { console.log("onobserving observeType:" +observeType + ", observeId:" + observeId); } } try { server = tizen.iotcon.getServer(); var uriPath = "/door"; var resourceTypes = ["core.door"]; var resourceInterfaces = ["oic.if.b"]; var attributes = {openstate : 'open' }; var policy = { isObservable : true, isDiscoverable : true }; doorResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); doorResource.attributes = attributes; doorResource.setRequestListener(newRequestListener); } catch(err) { console.log(err.name +': ' + err.message); }
unsetRequestListener
Remove the listener.
void unsetRequestListener();
Remark : Example of using can be find at setRequestListener code example.
The Representation Interface contains information of a resource. It can be used to communicate between a client and a server.
[Constructor(DOMString uriPath)] interface Representation { attribute DOMString uriPath; attribute ResourceType[] resourceTypes; attribute ResourceInterface[] resourceInterfaces; attribute object? attributes; attribute Representation[]? children; };
var uriPath = "/door"; // construct an Representation object with uriPath. var representation = new tizen.Representation(uriPath);
Representation(DOMString uriPath);
DOMString uriPath
ResourceType[] resourceTypes
ResourceInterface[] resourceInterfaces
A lists of attribute in this resource.
Representation[] children [nullable]
the representations belong to the representation as children.
[NoInterfaceObject] interface PresenceResponse { readonly attribute DOMString hostAddress; readonly attribute ConnectivityType connectivityType; readonly attribute ResourceType? resourceType; readonly attribute PresenceResponseResultType resultType; readonly attribute PresenceTriggerType? triggerType; };
The host address of the presence.
The connectivity type of the presence.
readonly ResourceType resourceType [nullable]
The resource type of the presence.
readonly PresenceResponseResultType resultType
The results type of presence.
readonly PresenceTriggerType triggerType [nullable]
The trigger type of presence. It is set only if a response result type is "OK".
The Query dictionary provides a query.
dictionary Query { ResourceType? resourceType; ResourceInterface? resourceInterface; object? filter; };
var filter = {"openstate": "open"}; var query = { resourceType: "core.door", resourceInterface: "oic.if.b" } query["filter"] = filter;
ResourceType? resourceType
resourceType The resource type specified as a filter for the resource.
ResourceInterface? resourceInterface
resourceInterfaces The resource interface specified as a filter for the resource.
object? filter
filter The query filter consists of key and string data.
The IotconOption Interface provides vendor specific options of COAP packet.
[Constructor(unsigned long id, DOMString data)] interface IotconOption { attribute unsigned long id; attribute DOMString data; };
var option = new tizen.IotconOption(3000, "12345");
IotconOption(unsigned long id, DOMString data);
unsigned longid
The ID of the option. id is always situated between 2048 and 3000.
DOMString data
The string data to add. Length of data is less than or equal to 15.
The Request interface represents a details from client.
[NoInterfaceObject] interface Request { readonly attribute DOMString hostAddress; readonly attribute ConnectivityType connectivityType; readonly attribute Representation? representation; readonly attribute IotconOption[] options; readonly attribute Query query; };
The address of host of the request.
Connectivities type of connection.
readonly Representationrepresentation [nullable]
The request representation.
readonly IotconOption[] options
The option which was sent from client.
readonly Query query
The query parameters from the request.
The Response Interface holds response from server for specified request of client. It is server-side object, Response on client-side is hold as RemoteResponse object.
[Constructor(Request request)] interface Response { readonly attribute Request request; attribute ResponseResult result; attribute Representation representation; attribute IotconOption[]? options; void send() raises(WebAPIException); };
var server; var doorResource; var requestListener = { onget: function(request) { console.log("onget"); var response = new tizen.Response(request); try { var representation = new tizen.Representation(doorResource.uriPath); representation.resourceTypes =doorResource.resourceTypes; representation.resourceInterfaces = doorResource.resourceInterfaces; representation.attributes = doorResource.attributes; response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ": " + err.message); response.result = "ERROR"; } response.send(); }, onput: function(request) { console.log("onput"); //add request handle code }, onpost: function(request) { console.log("onpost"); //add request handle code }, ondelete: function(request) { console.log("ondelete"); //add request handle code }, onobserving: function(request, observeType, observeId) { console.log("onobserving"); //add request handle code } } try { server = tizen.iotcon.getServer(); var uriPath = "/door"; var resourceTypes = ["core.door"]; var resourceInterfaces = ["oic.if.b"]; var policy = { isObservable : true, isDiscoverable : true }; doorResource = server.createResource(uriPath, resourceTypes, resourceInterfaces, requestListener, policy); doorResource.attributes = {openstate : 'open' }; } catch(err) { console.log(err.name +': ' + err.message); }
Response(Request request);
readonly Request request
the request, that server responded.
var response = new tizen.Response(request);
ResponseResult result
the result indicates the detailed information about the result of the response to request.
var result = "SUCCESS"; var response = new tizen.Response(request); response.result = result;
Representation representation
the representation indicates the information of the resource.
var uriPath = "/door"; var representation = new tizen.Representation(uriPath) representation.resourceTypes = ["core.door"]; representation.resourceInterfaces = ["oic.if.b"]; representation.attributes = {openstate : "open"}; var response = new tizen.Response(request); response.representation = representation;
IotconOption[] options [nullable]
the options indicates the vendor specific options of COAP packet.
send
Sends the response.
void send();
try { var uriPath = "/door"; var representation = new tizen.Representation(uriPath); representation.resourceTypes = ["core.door"]; representation.resourceInterfaces = ["oic.if.b"]; representation.attributes = {"openstate": "open"}; var response = new tizen.Response(request); response.representation = representation; response.result = "SUCCESS"; } catch(err) { console.log(err.name + ': ' + err.message); response.result = "ERROR"; } response.send();
The RemoteResponse Interface holds response from server for specified request of client, this is client-side version of Response object.
[NoInterfaceObject] interface RemoteResponse { readonly attribute ResponseResult result; readonly attribute Representation representation; readonly attribute IotconOption[]? options; };
readonly ResponseResult result
readonly Representationrepresentation
readonly IotconOption[] options [nullable]
The DeviceInfo interface describes device properties.
[NoInterfaceObject] interface DeviceInfo { readonly attribute DOMString? deviceName; readonly attribute DOMString? specVersion; readonly attribute DOMString? oicDeviceId; readonly attribute DOMString? dataModelVersion; };
readonly DOMString deviceName [nullable]
The device name
readonly DOMString specVersion [nullable]
The version of core specification.
readonly DOMString oicDeviceId [nullable]
The unique identifier for OIC device.
readonly DOMString dataModelVersion [nullable]
The version of specification which the device's data model is implemented
The PlatformInfo interface describes platform properties.
[NoInterfaceObject] interface PlatformInfo { readonly attribute DOMString? platformId; readonly attribute DOMString? manufacturerName; readonly attribute DOMString? manufacturerUrl; readonly attribute DOMString? modelNumber; readonly attribute DOMString? manufactureDate; readonly attribute DOMString? platformVersion; readonly attribute DOMString? operatingSystemVersion; readonly attribute DOMString? hardwareVersion; readonly attribute DOMString? firmwareVersion; readonly attribute DOMString? supportUrl; readonly attribute DOMString? systemTime; };
readonly DOMString platformId [nullable]
The platform identifier
readonly DOMString manufacturerName [nullable]
The name of manufacturer.
readonly DOMString manufacturerUrl [nullable]
The URL of manufacturer.
readonly DOMString modelNumber [nullable]
The model number is designated by manufacturer.
readonly DOMString manufactureDate [nullable]
The manufacture date of device.
readonly DOMString platformVersion [nullable]
The platform version is defined by manufacturer.
readonly DOMString operatingSystemVersion [nullable]
The operating system version.
readonly DOMString hardwareVersion [nullable]
The hardware version.
readonly DOMString firmwareVersion [nullable]
The firmware version.
readonly DOMString supportUrl [nullable]
The URL that points to support information from manufacturer.
readonly DOMString systemTime [nullable]
The System time.
The RequestCallback interface that defines the success method to be invoked when a client request is received.
[Callback=FunctionOnly, NoInterfaceObject] interface RequestCallback { void onget(Request request); void onput(Request request); void onpost(Request request); void ondelete(Request request); void onobserving(Request request, ObserveType observeType, unsigned long observeId); };
onget
Called when GET request was received.
void onget(Request request);
onput
Called when PUT request was received.
void onput(Request request);
onpost
Called when POST request was received.
void onpost(Request request);
ondelete
Called when DELETE request was received.
void ondelete(Request request);
onobserving
Called when OBSERVE request was received.
void onobserving(Request request, ObserveType observeType, unsigned long observeId);
boolean true, if the OBSERVE request is successfully handled.
The FoundResourceSuccessCallback interface that defines the success method for Client.findResource().
[Callback=FunctionOnly, NoInterfaceObject] interface FoundResourceSuccessCallback { void onfound(RemoteResource remoteResource); };
Remark : Example of using can be find at findResource code example.
onfound
Called when request was received.
void onfound(RemoteResource remoteResource);
The PresenceEventCallback interface defines the success method to be invoked when client receive presence events from the server.
[Callback=FunctionOnly, NoInterfaceObject] interface PresenceEventCallback { void onreceived(PresenceResponse presenceResponse); };
onreceived
Called when client receive presence events.
void onreceived(PresenceResponse presenceResponse);
The FoundDeviceInfoSuccessCallback interface defines the success method to be invoked when getting the device information is successful.
[Callback=FunctionOnly, NoInterfaceObject] interface FoundDeviceInfoSuccessCallback { void onsuccess(DeviceInfo info); };
Remark : Example of using can be find at findDeviceInfo code example.
onsuccess
Called when the device information is received.
void onsuccess(DeviceInfo info);
The FoundPlatformInfoSuccessCallback interface defines the success method to be invoked when getting the platform information is successful.
[Callback=FunctionOnly, NoInterfaceObject] interface FoundPlatformInfoSuccessCallback { void onsuccess(PlatformInfo info); };
Remark : Example of using can be find at findPlatformInfo code example.
Called when the platform information is received.
void onsuccess(PlatformInfo info);
The RemoteResourceResponseCallback interface defines the success method to be invoked when a client received response.
[Callback=FunctionOnly, NoInterfaceObject] interface RemoteResourceResponseCallback { void onsuccess(RemoteResponse response); };
Remark : Example of using can be find at methodGet code example.
Called when the response is received.
void onsuccess(RemoteResponse response);
The ResourceStateChangeCallback interface defines the success method to be invoked when remote resource's state is changed.
[Callback=FunctionOnly, NoInterfaceObject] interface ResourceStateChangeCallback { void onchanged(boolean isAlive); };
onchanged
Called when connection change appeared.
void onchanged(boolean isAlive);
The CacheUpdatedCallback interface defines the success method to be invoked when remote resource is changed.
[Callback=FunctionOnly, NoInterfaceObject] interface CacheUpdatedCallback { void onupdated(Representation representation); };
onupdated
Called when caching is successfully started.
void onupdated(Representation representation);
The GeneratedPinCallback interface defines the success method to be invoked when random pin is generated.
[Callback=FunctionOnly, NoInterfaceObject] interface GeneratedPinCallback { void onsuccess(DOMString pin); };
Called when random pin is successfully generated.
void onsuccess(DOMString pin);
You can check if this API is supported with tizen.systeminfo.getCapability() and decide enable/disable codes that need this API.
To guarantee this application will run on a device with a iotcon, add the below feature declaration to the config file
For more information, see Application Filtering.
module Iotcon { typedef DOMString ResourceType; enum QosLevel{ "HIGH", "LOW" }; enum ResponseResult { "SUCCESS", "ERROR", "RESOURCE_CREATED", "RESOURCE_DELETED", "RESOURCE_CHANGED", "SLOW", "FORBIDDEN" }; enum PresenceResponseResultType { "OK", "STOPPED", "TIMEOUT" }; enum PresenceTriggerType { "CREATED", "UPDATED", "DESTROYED" }; enum ConnectivityType { "IP", "PREFER_UDP", "PREFER_TCP", "IPV4_ONLY", "IPV6_ONLY", "ALL" }; typedef DOMString ResourceInterface; enum ObservePolicy { "IGNORE_OUT_OF_ORDER", "ACCEPT_OUT_OF_ORDER" }; enum ObserveType { "NO_TYPE", "REGISTER", "DEREGISTER" }; [NoInterfaceObject] interface IotconObject { readonly attribute Iotcon iotcon; }; Tizen implements IotconObject; [NoInterfaceObject] interface Iotcon { attribute DOMString deviceName; void initialize(DOMString filePath) raises(WebAPIException); Client getClient(); Server getServer(); long getTimeout(); void setTimeout(long timeout) raises(WebAPIException); long addGeneratedPinListener(GeneratedPinCallback successCallback) raises(WebAPIException); void removeGeneratedPinListener(long watchId) raises(WebAPIException); }; [NoInterfaceObject] interface Client { void findResource(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundResourceSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); long addPresenceEventListener(DOMString? hostAddress, ResourceType? resourceType, ConnectivityType connectivityType, PresenceEventCallback successCallback) raises(WebAPIException); void removePresenceEventListener(long watchId) raises(WebAPIException); void findDeviceInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundDeviceInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void findPlatformInfo(DOMString? hostAddress, Query? query, ConnectivityType connectivityType, FoundPlatformInfoSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); }; [NoInterfaceObject] interface Server { Resource[] getResources() raises(WebAPIException); Resource createResource(DOMString uriPath, ResourceType[] resourceTypes, ResourceInterface[] resourceInterfaces, RequestCallback listener, optional ResourcePolicy policy) raises(WebAPIException); void removeResource(Resource resource) raises(WebAPIException); void startPresence(unsigned long timeToLive) raises(WebAPIException); void stopPresence() raises(WebAPIException); }; interface RemoteResource { readonly attribute DOMString uriPath; readonly attribute ConnectivityType connectivityType; readonly attribute DOMString hostAddress; readonly attribute ResourceType[] resourceTypes; readonly attribute ResourceInterface[] resourceInterfaces; readonly attribute boolean isObservable; readonly attribute boolean isDiscoverable; readonly attribute boolean isActive; readonly attribute boolean isSlow; readonly attribute boolean isSecure; readonly attribute boolean isExplicitDiscoverable; readonly attribute DOMString deviceId; readonly attribute DOMString deviceName; attribute IotconOption[]? options; readonly attribute Representation? cachedRepresentation; attribute long timeInterval; void methodGet(RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodPut(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodPost(Representation representation, RemoteResourceResponseCallback responseCallback, optional Query? query, optional ErrorCallback? errorCallback) raises(WebAPIException); void methodDelete(RemoteResourceResponseCallback responseCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void startObserving(ObservePolicy observePolicy, RemoteResourceResponseCallback successCallback, optional Query? query) raises(WebAPIException); void stopObserving() raises(WebAPIException); void startCaching(optional CacheUpdatedCallback? updatedCallback) raises(WebAPIException); void stopCaching() raises(WebAPIException); void setResourceStateChangeListener(ResourceStateChangeCallback successCallback) raises(WebAPIException); void unsetResourceStateChangeListener() raises(WebAPIException); }; dictionary ResourcePolicy { boolean isObservable; boolean isDiscoverable; boolean isActive; boolean isSlow; boolean isSecure; boolean isExplicitDiscoverable; }; [NoInterfaceObject] interface Resource { readonly attribute DOMString uriPath; readonly attribute ResourceType[] resourceTypes; readonly attribute ResourceInterface[] resourceInterfaces; readonly attribute boolean isObservable; readonly attribute boolean isDiscoverable; readonly attribute boolean isActive; readonly attribute boolean isSlow; readonly attribute boolean isSecure; readonly attribute boolean isExplicitDiscoverable; readonly attribute Resource[] resources; readonly attribute long[] observerIds; attribute object? attributes; void notify(QosLevel qosLevel, optional long[]? observerIds) raises(WebAPIException); void addResourceTypes(ResourceType[] types) raises(WebAPIException); void addResourceInterface(ResourceInterface interface) raises(WebAPIException); void addChildResource(Resource resource) raises(WebAPIException); void removeChildResource(Resource resource) raises(WebAPIException); void setRequestListener(RequestCallback listener) raises(WebAPIException); void unsetRequestListener(); }; [Constructor(DOMString uriPath)] interface Representation { attribute DOMString uriPath; attribute ResourceType[] resourceTypes; attribute ResourceInterface[] resourceInterfaces; attribute object? attributes; attribute Representation[]? children; }; [NoInterfaceObject] interface PresenceResponse { readonly attribute DOMString hostAddress; readonly attribute ConnectivityType connectivityType; readonly attribute ResourceType? resourceType; readonly attribute PresenceResponseResultType resultType; readonly attribute PresenceTriggerType? triggerType; }; dictionary Query { ResourceType? resourceType; ResourceInterface? resourceInterface; object? filter; }; [Constructor(unsigned long id, DOMString data)] interface IotconOption { attribute unsigned long id; attribute DOMString data; }; [NoInterfaceObject] interface Request { readonly attribute DOMString hostAddress; readonly attribute ConnectivityType connectivityType; readonly attribute Representation? representation; readonly attribute IotconOption[] options; readonly attribute Query query; }; [Constructor(Request request)] interface Response { readonly attribute Request request; attribute ResponseResult result; attribute Representation representation; attribute IotconOption[]? options; void send() raises(WebAPIException); }; [NoInterfaceObject] interface RemoteResponse { readonly attribute ResponseResult result; readonly attribute Representation representation; readonly attribute IotconOption[]? options; }; [NoInterfaceObject] interface DeviceInfo { readonly attribute DOMString? deviceName; readonly attribute DOMString? specVersion; readonly attribute DOMString? oicDeviceId; readonly attribute DOMString? dataModelVersion; }; [NoInterfaceObject] interface PlatformInfo { readonly attribute DOMString? platformId; readonly attribute DOMString? manufacturerName; readonly attribute DOMString? manufacturerUrl; readonly attribute DOMString? modelNumber; readonly attribute DOMString? manufactureDate; readonly attribute DOMString? platformVersion; readonly attribute DOMString? operatingSystemVersion; readonly attribute DOMString? hardwareVersion; readonly attribute DOMString? firmwareVersion; readonly attribute DOMString? supportUrl; readonly attribute DOMString? systemTime; }; [Callback=FunctionOnly, NoInterfaceObject] interface RequestCallback { void onget(Request request); void onput(Request request); void onpost(Request request); void ondelete(Request request); void onobserving(Request request, ObserveType observeType, unsigned long observeId); }; [Callback=FunctionOnly, NoInterfaceObject] interface FoundResourceSuccessCallback { void onfound(RemoteResource remoteResource); }; [Callback=FunctionOnly, NoInterfaceObject] interface PresenceEventCallback { void onreceived(PresenceResponse presenceResponse); }; [Callback=FunctionOnly, NoInterfaceObject] interface FoundDeviceInfoSuccessCallback { void onsuccess(DeviceInfo info); }; [Callback=FunctionOnly, NoInterfaceObject] interface FoundPlatformInfoSuccessCallback { void onsuccess(PlatformInfo info); }; [Callback=FunctionOnly, NoInterfaceObject] interface RemoteResourceResponseCallback { void onsuccess(RemoteResponse response); }; [Callback=FunctionOnly, NoInterfaceObject] interface ResourceStateChangeCallback { void onchanged(boolean isAlive); }; [Callback=FunctionOnly, NoInterfaceObject] interface CacheUpdatedCallback { void onupdated(Representation representation); }; [Callback=FunctionOnly, NoInterfaceObject] interface GeneratedPinCallback { void onsuccess(DOMString pin); }; };