ThingIFAPI

Aggregate history states of thing.

Delete a specified trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.deleteTrigger("Trigger ID").then(function(deletedTriggerID) {
  // Do something
}).catch(function(err){
  // Error handling
});

Enable/Disable a specified trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.enableTrigger("Trigger ID", true).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Retrieve command with specified ID. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.getCommand("CommandID").then(function(command) {
  // Do something
}).catch(function(err){
  // Error handling
});

Get firmware version of the thing. If firmware version is not set, then null is resolved.

Get State of specified target. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.getState().then(function(state) {
  // Do something
}).catch(function(err){
  // Error handling
});

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

Retrieve trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.getTrigger("TriggerID").then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Get vendorThingID of specified target **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.getVendorThingID().then(function(vendorThingID) {
  // Do something
}).catch(function(err){
  // Error handling
});

Query grouped history states of thing based on data grouping intervals.

Register the id issued by Firebase Cloud Message to Kii cloud for kii user.

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

Retrieve commands. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.listCommands().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. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.listServerCodeExecutionResults("Trigger ID").then(function(queryResult) {
  if (queryResult.hasNext) {
    // Handle more results
  }
  // Do something
  var executionResults = queryResult.results;
}).catch(function(err){
  // Error handling
});

Retrive triggers. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

api.listTriggers().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.

var owner = new ThingIF.TypedID(ThingIF.Types.User, "Your UserID");
var app = new ThingIF.App("Your AppID", "Your AppKey", ThingIF.Site.US);
var api = new ThingIF.ThingIFAPI(owner, "Your user's acess token", app);
var thingID = "Your thing's ID";
var password = "Your thing's password";
var request = new ThingIF.OnboardWithThingIDRequest(thingID, password, owner);
api.onboardWithThingID(request).then(function(result){
  // Do something
}).catch(function(err){
  // Error handling
});

Onboard Thing by vendorThingID

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

Update a command trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned. When thing related to this ThingIFAPI instance meets condition described by predicate, A registered command sends to thing related to target. `target` property and commandTarget in requestObject must belong to same owner.

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

Update a servercode trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

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);
api.patchServerCodeTrigger("Trigger ID", request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new command trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned. When thing related to this ThingIFAPI instance meets condition described by predicate, A registered command sends to thing related to target. `target` property and commandTarget in requestObject must belong to same owner.

// commandTargetID can be different with api.target.
var commandTargetID = new ThingIF.TypedID(ThingIF.Types.Thing, "another thing to receive command");
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);
var request = new ThingIF.PostCommandTriggerRequest(triggerCommandObject, statePredicate);
api.postCommandTrigger(request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new command. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

var request = new ThingIF.PostCommandRequest("led", 1, [{turnPower: {power:true}}]);
api.postNewCommand(request).then(function(command) {
  // Do something
}).catch(function(err){
  // Error handling
});

Post a new servercode trigger. **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

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);
api.postServerCodeTrigger(request).then(function(trigger) {
  // Do something
}).catch(function(err){
  // Error handling
});

Query history states of thing.

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

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

Update firmware version of the thing

Update thingType to use trait for the thing.

Update vendorThingID of specified target **Note**: Please onboard first, or provide a target when constructor ThingIFAPI. Otherwise, error will be returned.

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