qtc

Qt Cloud Services SDK for Node.js

The official Qt Cloud Services SDK for Node.js.

• The Qt Cloud Services home page is at https://www.qtc.io
• The Developer Documentation page is at https://developer.qtc.io

Installing

The preferred way to install the SDK for Node.js is to use the npm package manager for Node.js. Simply type the following into a terminal window:

npm install qtc

Getting Started

You can find a getting started guide for Qt Cloud Services at:

http://developer.qtc.io/qtc/getting-started?snippets=node

If you are looking for service specific guides, please see:

• Enginio Data Storage
• Managed WebSocket

Quick Start

Qt Cloud Services SDK is designed to be the most easy way possible to use any of the services of Qt Cloud Services. It supports all the latest APIs by default. The following example shows how to access Enginio Data Storage (EDS) with the Node.js SDK.

var qtc = require("qtc");
var eds = new qtc.Eds({ address: "YOUR_EDS_ADDRESS", backendId: "YOUR_BACKEND_ID"});

// Define collection used in this example
var contacts = eds.collection("contacts");

// Insert object to EDS
contacts.insert({
   name: "John",
   age: 31,
   likes: ["pizza", "coke"],
   address: {
      city: "Springfield",
      country: "USA",
   }
}, function(e, result){
   if(!e){
      console.log(result);
   } else {
      console.log("Ooops! Something went wrong!", e);
   }
});

SDK API Reference

Enginio Data Storage (EDS)

Qtc.Eds()

var eds = new Qtc.Eds( options );

The constructor for EDS instance. The options is an object with following parameters:

• address - An address of this EDS instance
• backendId - A backend id of this EDS instance
• secret - (optional) A security token for this EDS instance

// The typical constructor may look something like this...
var eds = new Qtc.Eds({
   address: "",     // enter your EDS instance address
   backendId: "",   // enter your EDS instance backend id
   secret: ""       // enter your EDS instance secret token
});

Qtc.Eds.collection()

var collection = eds.collection( name, useInternals );

The constructor for EDS instance collection. Arguments:

• name - A name of the collection.
• useInternals - (optional) This boolean value applies only if the collection name is "users" or "usergroups". If set to true, the collection points to EDS users and usergroups collection. If not set, the collection points to custom user defined objects.

Qtc.Eds.rest()

eds.rest( verb, path, options, callback );

The custom rest request to EDS instance. Arguments:

• verb - A HTTP request verb: GET, POST, PUT, DELETE
• path - A path for the request. Please see http://developer.qtc.io/eds/rest/reference
• options - (optional) An options for the request
• callback - A callback function to be called when request is completed.