Instantiate bucket belongs to this thing.
name of the bucket.
bucket instance.
Delete registered thing in Kii Cloud.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
It will delete bucket, topic which belongs to this thing, entity belongs to the bucket/topic and all ownership information of thing. This operation can not be reverted. Please carefully use this.
return promise object.
Disable the thing.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own Thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
After succeeded, access token published for thing is disabled. In a result, only the app administrator and owners of thing can access the thing. Used when user lost the thing and avoid using by unknown users. It doesn't throw error when the thing is already disabled.
return promise object.
Enable the thing.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own Thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
After succeeded, If thing is registered with "persistentToken" option, token should be recovered (Access token which is used before disabling can be available). Otherwise, it does not recovered. It doesn't throw error when the thing is already enabled.
return promise object.
Creates a reference to a encrypted bucket for this thing
The bucket will be created/accessed within this thing's scope
The name of the bucket the user should create/access
A working KiiEncryptedBucket object
Get access token of this thing.
access token of this thing.
Get created time of this thing.
created time of this thing.
Get disabled status of this thing.
true if thing is disabled, false otherwise.
Get online status modified date of the thing.
online status modified time of this thing. The date will be null initially until the thing is connected for the first time.
Get thing ID.
thing id
Get vendor thing ID.
vendor thing id
Get online status of the thing.
true if the thing is online, false otherwise. The return value will be null initially until the thing is connected for the first time.
Check if user/ group is owner of the thing.
This API is authorized by owner of thing.
Need user login before execute this API.
To let users to own Thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
whether the instance is owner of thing or not.
return promise object.
Gets a list of topics in this thing scope
return promise object.
Instantiate push subscription for this thing.
push subscription object.
Retrieve the latest thing information from KiiCloud.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
return promise object.
Register user/group as owner of this thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
to be registered as owner.
return promise object.
Register user/group as owner of this thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
to be registered as owner.
return promise object.
Instantiate topic belongs to this thing.
name of the topic. Must be a not empty string.
topic instance.
Remove ownership of thing from specified user/group.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
to be unregistered.
return promise object.
Update registered thing information in Kii Cloud
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
return promise object.
Updates thing password. This method can be used only by app admin.
new password
return promise object.
Perform a query to get the owned things.
The query will be executed against the server, returning a result set.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Load thing with thing id given by Kii Cloud.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own Thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
thing id can be obtained by getThingID
registered thing id.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Load thing with given vendor thing id.
This API is authorized by owner of thing.
Need user login who owns this thing before execute this API.
To let users to own Thing, please call KiiThing.registerOwner
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
registered vendor thing id.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Register thing in KiiCloud.
This API doesnt require users login Anonymous user can register thing.
Propertis started with '' in the fields is reserved by Kii Cloud.
Those properties are indexed in Kii Cloud storage.
Properties not started with '' is custom properties defined by developer.
Custom properties are not indexed in KiiCloud storage.
Following properties are readonly and ignored on creation/update of thing.
'_thingID', '_created', '_accessToken'
Following properties are readonly after creation and will be ignored on update of thing.
'_vendorThingID', 'password'
As Property prefixed with '' is reserved by Kii Cloud,
properties other than ones described in the parameter secion
and '_layoutPosition' are ignored on creation/update of thing.
Those ignored properties won't be removed from fields object passed as argument.
However it won't be reflected to fields object property of created/updated Thing.
of the thing to be registered.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Register user/group as owner of specified thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
The ID of thing
instance of KiiUser/KiiGroup to be registered as owner.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Register user/group as owner of specified thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
The ID of thing
instance of KiiUser/KiiGroup to be registered as owner.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Register user/group as owner of specified thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
The vendor thing ID of thing
instance of KiiUser/KiiGroup to be registered as owner.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Register user/group as owner of specified thing.
Need user login before execute this API.
Note: if you obtain thing instance from KiiAppAdminContext,
API is authorized by app admin.
The vendor thing ID of thing
instance of KiiUser/KiiGroup to be registered as owner.
KiiApplication instance. When omitted, KiiApplication.globalApp is used.
return promise object.
Generated using TypeDoc
KiiThing does not support removal of fields from Server.
{Object} fields of this thing. For details refer to KiiThing.register