APIAuthor

Aggregate history states of specified target.

Delete a specified trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.deleteTrigger(targetID, "Trigger ID").then(function(deletedTriggerID) {
  // Do something
}).catch(function(err){
  // Error handling
});

Enable/Disable a specified trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.enableTrigger(targetID, "Trigger ID", true).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Retrieve command with specified ID.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.getCommand(targetID, "CommandID").then(function(command) {
  // Do something
}).catch(function(err){
  // Error handling
});

Get firmware version of specified target thing. If firmware versoin is not set, then null is resolved.

Get State of specified target.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.getState(targetID).then(function(state) {
  // Do something
}).catch(function(err){
  // Error handling
});

Get thingType to use trait for specified target thing. If thing type is not set, then null is resolved.

Retrieve trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.getTrigger(targetID, "TriggerID").then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Get vendorThingID of specified target

author.getVendorThingID("Thing ID for target").then(function(vendorThingID) {
  // Do something
}).catch(function(err){
  // Error handling
});

Query grouped history states of specified target based on data grouping intervals.

Install Firebase Cloud Message(FCM) notification to receive notification from IoT Cloud. IoT Cloud will send notification when the Target replies to the Command. Application can receive the notification and check the result of Command fired by Application or registered Trigger.

author.installFCM("Registration ID", false).then(function(installationID) {
  // Do something
}).catch(function(err){
  // Error handling
});

Retrieve commands.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.listCommands(targetID).then(function(queryResult) {
  if (queryResult.hasNext) {
    // Handle more results
  }
  // Do something
  var commands = queryResult.results;
}).catch(function(err){
  // Error handling
});

Retrieve execution results of server code trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.listServerCodeExecutionResults(targetID, "Trigger ID").then(function(queryResult) {
  if (queryResult.hasNext) {
    // Handle more results
  }
  // Do something
  var executionResults = queryResult.results;
}).catch(function(err){
  // Error handling
});

Retrive triggers.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
author.listTriggers(targetID).then(function(queryResult) {
  if (queryResult.hasNext) {
    // Handle more results
  }
  // Do something
  var triggers = queryResult.results;
}).catch(function(err){
  // Error handling
});

Onboard Thing by thingID for the things already registered on Kii Cloud.

Onboard Thing by vendorThingID

// Assume user is already exist and you have User ID and Access token.
var app = new ThingIF.App("Your AppID", "Your AppKey", ThingIF.Site.US);
var author = new ThingIF.APIAuthor("Your user's acess token", app);
var vendorThingID = "Your thing's vendor thing ID";
var password = "Your thing's password";
var owner = new ThingIF.TypedID(ThingIF.Types.User, "Your UserID");
var request = new ThingIF.OnboardWithVendorThingIDRequest(vendorThingID, password, owner);
author.onboardWithVendorThingID(request).then(function(result){
  // Do something
}).catch(function(err){
  // Error handling
});

Update a command trigger. When condition described by predicate is met, a registered command sends to thing related to target. `target` property and commandTarget in requestObject must belong to same owner.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
// if commandTargetID can be different with targetID
var commandTargetID = new ThingIF.TypedID(ThingIF.Types.Thing, "another thing to receive command");
var issuerID = new ThingIF.TypedID(ThingIF.Types.User, "Your UserID");
var condition = new ThingIF.Condition(new ThingIF.Equals("power", "false"));
var statePredicate = new ThingIF.StatePredicate(condition, ThingIF.TriggersWhen.CONDITION_CHANGED);
var triggerCommandObject = new ThingIF.TriggerCommandObject("led2", 2, [{setBrightness: {brightness:50}}], commandTargetID, issuerID);
var request = new ThingIF.PatchCommandTriggerRequest(triggerCommandObject, statePredicate);
author.patchCommandTrigger(targetID, "Trigger ID", request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Update a servercode trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
var serverCode = new ThingIF.ServerCode("function_name", null, null, {param1: "hoge"});
var condition = new ThingIF.Condition(new ThingIF.Equals("power", "false"));
var statePredicate = new ThingIF.StatePredicate(condition, ThingIF.TriggersWhen.CONDITION_CHANGED);
var request = new ThingIF.PatchServerCodeTriggerRequest(serverCode, statePredicate);
author.patchServerCodeTrigger(targetID, "Trigger ID", request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new command trigger. When condition described by predicate is met, a registered command sends to thing related to target. `target` property and commandTarget in requestObject must belong to same owner.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
// commandTargetID can be different with targetID.
var commandTargetID = new ThingIF.TypedID(ThingIF.Types.Thing, "another thing to receive command");
var issuerID = new ThingIF.TypedID(ThingIF.Types.User, "Your UserID");
var condition = new ThingIF.Condition(new ThingIF.Equals("power", "false"));
var statePredicate = new ThingIF.StatePredicate(condition, ThingIF.TriggersWhen.CONDITION_CHANGED);
var triggerCommandObject = new ThingIF.TriggerCommandObject("Schema name", 1, [{turnPower: {power:true}}], commandTargetID, issuerID);
var request = new ThingIF.PostCommandTriggerRequest(triggerCommandObject, statePredicate);
author.postCommandTrigger(targetID, request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new command.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
var issuerID = new ThingIF.TypedID(ThingIF.Types.User, "Your UserID");
var request = new ThingIF.PostCommandRequest("led", 1, [{turnPower: {power:true}}], issuerID);
author.postNewCommand(targetID, request).then(function(command) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new servercode trigger.

var targetID = new ThingIF.TypedID(ThingIF.Types.Thing, "Thing ID for target");
var serverCode = new ThingIF.ServerCode("function_name", null, null, {param1: "hoge"});
var condition = new ThingIF.Condition(new ThingIF.Equals("power", "false"));
var statePredicate = new ThingIF.StatePredicate(condition, ThingIF.TriggersWhen.CONDITION_CHANGED);
var request = new ThingIF.ServerCodeTriggerRequest(serverCode, statePredicate);
author.postServerCodeTrigger(targetID, request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Query history states of specified target.

Unregister the push settings by the id(issued by KiiCloud) that is used for installation.

author.uninstallPush("Installation ID").then(function() {
  // Do something
}).catch(function(err){
  // Error handling
});

Update firmware version of specified target thing.

Update thingType to use trait for a specified target thing.

Update vendorThingID of specified target

author.updateVendorThingID("Thing ID for target", "New vendor thing ID", "New Password").then(function() {
  // Do something
}).catch(function(err){
  // Error handling
});