Getting started

Ceci est la documentation en rapport avec QCore.

How to Build

The generated SDK relies on Node Package Manager (NPM) being available to resolve dependencies. If you don't already have NPM installed, please go ahead and follow instructions to install NPM from here. The SDK also requires Node to be installed. If Node isn't already installed, please install it from here

NPM is installed by default when Node is installed

To check if node and npm have been successfully installed, write the following commands in command prompt:

• node --version
• npm -version

Now use npm to resolve all dependencies by running the following command in the root directory (of the SDK folder):

npm install

This will install all dependencies in the node_modules folder.

Once dependencies are resolved, you will need to move the folder QCOREApiLib in to your node_modules folder.

How to Use

The following section explains how to use the library in a new project.

1. Open Project Folder

Open an IDE/Text Editor for JavaScript like Sublime Text. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on File and select Open Folder.

Select the folder of your SDK and click on Select Folder to open it up in Sublime Text. The folder will become visible in the bar on the left.

2. Creating a Test File

Now right click on the folder name and select the New File option to create a new test file. Save it as index.js Now import the generated NodeJS library using the following lines of code:

var lib = require('lib');

Save changes.

3. Running The Test File

To run the index.js file, open up the command prompt and navigate to the Path where the SDK folder resides. Type the following command to run the file:

node index.js

How to Test

These tests use Mocha framework for testing, coupled with Chai for assertions. These dependencies need to be installed for tests to run. Tests can be run in a number of ways:

Method 1 (Run all tests)

1. Navigate to the root directory of the SDK folder from command prompt.
2. Type mocha --recursive to run all the tests.

Method 2 (Run all tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha * to run all the tests.

Method 3 (Run specific controller's tests)

1. Navigate to the ../test/Controllers/ directory from command prompt.
2. Type mocha QCORE ApiController to run all the tests in that controller file.

To increase mocha's default timeout, you can change the TEST_TIMEOUT parameter's value in TestBootstrap.js.

Initialization

API client can be initialized as following:

const lib = require('lib');

Class Reference

List of Controllers

• MiscController

MiscController

Get singleton instance

The singleton instance of the MiscController class can be accessed from the API Client.

var controller = lib.MiscController;

getServersLists

Tags: Skips Authentication

Retournes une liste qui contient les serveurs actuellements achetés par l'utilisateur.

function getServersLists(authorization, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | L'id de l'utilisateur |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';

    controller.getServersLists(authorization, function(error, response, context) {

    
    });

getStartServer

Tags: Skips Authentication

Cette commande allume un serveur, retourne un message d'erreur si la machine est déjà lancé ou affiche simplement 200 si le lancement et ok.

function getStartServer(id, authorization, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | id | Required | L'id du serveur à lancé | | authorization | Required | TODO: Add a parameter description |

Example Usage

    var id = 21945158;
    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';

    controller.getStartServer(id, authorization, function(error, response, context) {

    
    });

getShowServer

Tags: Skips Authentication

show info for an linode server

function getShowServer(id, authorization, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | id | Required | TODO: Add a parameter description | | authorization | Required | TODO: Add a parameter description |

Example Usage

    var id = 21945288;
    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';

    controller.getShowServer(id, authorization, function(error, response, context) {

    
    });

getStopUnServeur

Tags: Skips Authentication

stop a linode server

function getStopUnServeur(id, authorization, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | id | Required | L'id du serveur | | authorization | Required | TODO: Add a parameter description |

Example Usage

    var id = 21945288;
    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';

    controller.getStopUnServeur(id, authorization, function(error, response, context) {

    
    });

getBaseLinode

Tags: Skips Authentication

Base url, return personal linode info

function getBaseLinode(authorization, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | L'id de l'utilisateur, pour le développement: 7ljr0lDUETeCWbPDJLOuFUkPmr42 |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';

    controller.getBaseLinode(authorization, function(error, response, context) {

    
    });

createMcStart

Tags: Skips Authentication

Launch a minecraft server

function createMcStart(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createMcStart(authorization, serverId, function(error, response, context) {

    
    });

createGmodStart

Tags: Skips Authentication

Launch a gmod server

function createGmodStart(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createGmodStart(authorization, serverId, function(error, response, context) {

    
    });

createGmodStop

Tags: Skips Authentication

Stop a gmod server

function createGmodStop(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createGmodStop(authorization, serverId, function(error, response, context) {

    
    });

createGmodDetails

Tags: Skips Authentication

Details a gmod server

function createGmodDetails(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createGmodDetails(authorization, serverId, function(error, response, context) {

    
    });

createMcStop

Tags: Skips Authentication

Stop a minecraft server

function createMcStop(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createMcStop(authorization, serverId, function(error, response, context) {

    
    });

createMcDetails

Tags: Skips Authentication

get details about a minecraft

function createMcDetails(authorization, serverId, callback)

Parameters

| Parameter | Tags | Description | |-----------|------|-------------| | authorization | Required | TODO: Add a parameter description | | serverId | Required | TODO: Add a parameter description |

Example Usage

    var authorization = '7ljr0lDUETeCWbPDJLOuFUkPmr42';
    var serverId = 21945504;

    controller.createMcDetails(authorization, serverId, function(error, response, context) {

    
    });

Back to List of Controllers