innovaphone App SDK

https://sdk.innovaphone.com/15r1/doc/sdk.htm
Admin
The innovaphone App SDK provides tools, sample code, and documentation for developing applications...
Tokens:163,497
Snippets:1,041
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### C++: Initialize Database on Connection Complete

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Replicator

This snippet shows how to initialize the database by creating and starting an 'AppTaskDatabaseInit' object when the 'DatabaseConnectComplete' callback is invoked, ensuring database setup proceeds after a successful connection.

```C++
void NewApp1::DatabaseConnectComplete(IDatabase * const database)
{
    this->tableSetup = new AppTaskDatabaseInit(database);
    this->tableSetup->Start(&taskDatabaseInit);
}
```

--------------------------------

### Example JSON for App Platform Configuration

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/howto/AppStore

Provides a sample linux.json structure, illustrating how app platforms and their associated files (install, update, zip) are defined, along with how devices are linked to compatible platforms.

```json
{ "platforms": [{
    "id": "arm",
    "text": "App Platform",
    "file": "app-platform/10001/app-platform-armel.img",
    "update": "app-platform/10001/update-armel.img",
    "version": "10001"
    }],
    "devices": [{
    "id": "IP0011",
    "platforms": ["arm"]
    },
    {
    "id": "IP811",
    "platforms": ["arm"]
    }]
}
```

--------------------------------

### C++ AppTaskDatabaseInit Class for User Table Setup

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Replicator

Defines the AppTaskDatabaseInit class, a C++ component responsible for initializing the 'users' table in a database. Its constructor sets up columns ('id' as primary key, 'username', 'cn') and a unique constraint on 'username'. The class includes methods for starting the initialization task and handling its completion or failure, including database errors.

```C++
AppTaskDatabaseInit::AppTaskDatabaseInit(IDatabase * database) :
initUsers(database, "users")
{
    this->database = database;
    initUsers.AddColumn("id", "BIGSERIAL PRIMARY KEY NOT NULL");
    initUsers.AddColumn("username", "VARCHAR");
    initUsers.AddColumn("cn", "VARCHAR");
    initUsers.AddConstraint("const_username", "UNIQUE (username)");
}
AppTaskDatabaseInit::~AppTaskDatabaseInit()
{
}
void AppTaskDatabaseInit::Start(class UTask * user)
{
    this->user = user;
    initUsers.Start(this);
}
void AppTaskDatabaseInit::TaskComplete(class ITask * const task)
{
    user->TaskComplete(this);
}
void AppTaskDatabaseInit::TaskFailed(class ITask * const task)
{
    user->TaskFailed(this);
}
void AppTaskDatabaseInit::DatabaseError(IDatabase * const database, db_error_t error)
{
    user->TaskFailed(this);
}
void AppTaskDatabaseInit::DatabaseExecSQLResult(IDatabase * const database, IDataSet * dataset)
{
    delete dataset;
    dataset = 0;
}
```

--------------------------------

### JavaScript Examples for Network.server

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Network

Illustrates the usage of the `Network.server` function in JavaScript to set up TCP and TLS servers. The examples show how to create a server listening on a specific port and immediately close any incoming connections.

```JavaScript
// TCP server listening on port 80 that rejects incoming connections right away
Network.server("tcp", null, 80)
    .onsocket(function(server, socket, addr, port) {
        socket.close();
    });
```

```JavaScript
// TLS server listening on port 443 that rejects incoming connections right away
Network.server("tls", null, 443)
    .onsocket(function(server, socket, addr, port) {
        socket.close();
    });
```

--------------------------------

### App Configuration: Example Application URL

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Replicator

This snippet provides an example URL format for an application instance, typically found in the App Platform Manager, which is used when configuring the App Object on the PBX to link the application.

```Configuration
http://XXX.XX.XXX.XXX/domain.com/newapp1/helloworld
```

--------------------------------

### Innovaphone App Store Example Application File Tree

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appstoreguide

Provides a concrete example of the Innovaphone App Store's expected file tree structure, demonstrating how multiple build versions and platform-specific binaries are organized for a 'demoapp'.

```plaintext
+-- 1001
|   +-- innovaphone-demoapp_files
|   +-- arm
|       +-- innovaphone-demoapp
|           +-- innovaphone-demoapp
|           +-- innovaphone-demoapp.png
|           +-- innovaphone-demoapp.debug
|   +-- arm64
|       +-- innovaphone-demoapp
|           +-- innovaphone-demoapp
|           +-- innovaphone-demoapp.png
|           +-- innovaphone-demoapp.debug
|   +-- x86_64
|       +-- innovaphone-demoapp
|           +-- innovaphone-demoapp
|           +-- innovaphone-demoapp.png
|           +-- innovaphone-demoapp.debug
+-- 1002
|   +-- innovaphone-demoapp_files
|   +-- arm
|       +-- innovaphone-demoapp
|           +-- innovaphone-demoapp
|           +-- innovaphone-demoapp.png
|           +-- innovaphone-demoapp.debug
...
```

--------------------------------

### JavaScript Examples for Network.localAddresses

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Network

Provides JavaScript examples demonstrating the use of `Network.localAddresses` to retrieve and utilize local IP address information. Examples include logging all local addresses and binding a TLS server to the first available network interface.

```JavaScript
// Write the addresses of the local network interfaces to the log
var addrs = Network.localAddresses();
log("local addresses:");
addrs.forEach(function(a) {
    log("   " + a.addr);
});
```

```JavaScript
// Bind a TLS server on the first interface
var addrs = Network.localAddresses();

if (addrs.length) {
    Network.server("tls", addrs[0].addr, 443, addrs[0].ipv6)
        .onsocket(function(server, socket, addr, port) {
            // handle connection using the socket object
        });
}
```

--------------------------------

### Example: Send HTTP Response

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/WebServer

Provides examples of sending an HTTP response with different status codes and custom text using `sendResponse`.

```JavaScript
req.sendResponse(200);
```

```JavaScript
req.sendResponse(418, "I'm a teapot");
```

--------------------------------

### Example ProvisioningPhone JSON Message

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Provisioning API

An example JSON payload for the 'ProvisioningPhone' message, illustrating the structure and typical values for parameters like MAC, code, hardware ID, username, and encrypted password during device provisioning.

```JSON
{"mt":"ProvisioningPhone","mac":"112233445566","code":"562822784750","hwid":"112233445566","usename":"test_user","cn":"Test User","seed1":"10046478319880090512700","password":"ddfc00","domain":"test.com","dns":"172.16.0.255"}
```

--------------------------------

### Innovaphone SDK Info Object Example

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/AppWebsocket

An example JSON payload demonstrating the structure and typical values for the 'info' object. This object provides contextual information about the user and the app's environment.

```json
{
    "appobj": "sampleapp",
    "appdn": "sampleapp",
    "appurl": "https://ap.example.com/sampleapp/acme-sampleapp",
    "pbx": "master",
    "cn": "sampleapp",
    "testmode": true,
    "apps": [
        {
            "name": "otherapp",
            "dn": "otherapp"
        }
    ]
}
```

--------------------------------

### Innovaphone Client API Full Example Application

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/ClientAPIs

This comprehensive JavaScript example demonstrates the core functionalities of an Innovaphone application. It initializes UI components, manages themes and languages, establishes an app websocket connection, and consumes `com.innovaphone.phone` and `com.innovaphone.client` APIs. The code illustrates how to handle user input for SIP addresses, dynamically update user avatars, initiate calls, and subscribe to presence updates, visually indicating user status.

```JavaScript
var innovaphone = innovaphone || {};
innovaphone.NewApp1 = innovaphone.NewApp1 || function (start, args) {
    this.createNode("body");
    var that = this;
    var colorSchemes = {
        dark: {
            "--bg": "#191919",
            "--button": "#303030",
            "--text-standard": "#f2f5f6"
        },
        light: {
            "--bg": "white",
            "--button": "#e0e0e0",
            "--text-standard": "#4a4a49"
        }
    };

    var schemes = new innovaphone.ui1.CssVariables(colorSchemes, start.scheme);
    start.onschemechanged.attach(function () { schemes.activate(start.scheme) });

    var texts = new innovaphone.lib1.Languages(innovaphone.NewApp1Texts, start.lang);
    start.onlangchanged.attach(function () { texts.activate(start.lang) });

    var app = new innovaphone.appwebsocket.Connection(start.url, start.name);
    app.checkBuild = true;
    app.onconnected = app_connected;

    var avatarApi;

    function app_connected(domain, user, dn, appdomain) {
        if (!avatarApi) avatarApi = new innovaphone.Avatar(start, user, domain, appdomain);
    }

    var phoneApi = start.consumeApi("com.innovaphone.phone");
    var clientApi = start.consumeApi("com.innovaphone.client");
    var sip;

    var input = this.add(new innovaphone.ui1.Input("margin: 5px; background-color: var(--button); color: var(--text-standard); font-size: 16px; border: none;"));
    var avatar = this.add(new innovaphone.ui1.Div("width: 150px; height: 150px; margin: 10px; background-size: cover;"));

    input.addEvent("change", function () {
        if (sip) clientApi.send({ mt: "UnsubscribePresence", sip: sip });
        sip = input.getValue();
        avatar.container.style.backgroundImage = "url('" + avatarApi.url(sip, 150, sip) + "')";
        clientApi.send({ mt: "SubscribePresence", sip: sip });
    });

    avatar.addEvent("click", function () {
        if (sip) phoneApi.send({ mt: "StartCall", sip: sip });
    });

    var presenceColors = { "": "#badb8c", "away": "#ffd063", "busy": "#ff918f", "dnd": "#cb8cdb" };

    clientApi.onmessage.attach(function (sender, obj) {
        if (obj.msg.mt == "PresenceUpdated" && obj.msg.sip == sip) {
            avatar.container.style.borderRight = "10px solid " + presenceColors[obj.msg.presence[0].activity];
        }
    });
}
innovaphone.NewApp1.prototype = innovaphone.ui1.nodePrototype;
```

--------------------------------

### Console Output of C++ Debug Trace

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/HttpRequests

Example console output generated by the `debug->printf` statement within the `WebserverPluginHttpListenResult` function, demonstrating the trace for an incoming GET request.

```Text
06-14 15:28:13.351 GET /value
```

--------------------------------

### C++: Start Webserver Listeners and Update Replicator

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Replicator

This snippet shows how to start the webserver's HTTP and WebSocket listeners and update the replicator with the application domain and PBX name after the replicator has successfully initialized, making the application accessible and synchronized.

```C++
void NewApp1::ReplicatorInitialized()
{
    this->webserverPlugin->HttpListen(0, 0, 0, 0, _BUILD_STRING_);
    this->webserverPlugin->WebsocketListen();
    replicator->Update(args.appDomain, pbxName);
}
```

--------------------------------

### Example ProvisioningPhoneResult JSON Message

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Provisioning API

An example JSON payload for the 'ProvisioningPhoneResult' message, indicating the successful completion of a provisioning operation. This message is sent back to the Users App Service.

```JSON
{"mt":"ProvisioningPhoneResult","result":"ok"}
```

--------------------------------

### Example Application API Definitions (JSON)

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appgeneric

Illustrates how to define multiple APIs for different applications, showing configurations for presence, hidden status, and custom API definitions. This example demonstrates publishing both a standard Innovaphone API and a custom API.

```JSON
"apis": {
    "manufacturer-appname": {
        "com.innovaphone.phoneinfo": {
            "info": {}
        },
        "presence": true,
        "hidden": true
    },
    "manufacturer-appname-admin": {
        "com.manufacturer.someapi": {
            "info": {}
        }
    }
}
```

--------------------------------

### JavaScript Configuration Example with Specific Files

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appgeneric

An example demonstrating how to list specific JavaScript files ('service1.js', 'service2.js', 'service3.js') within the 'eval' array for execution. This ensures only the specified scripts are loaded.

```json
"javascript": {
    "eval": [
        "service1.js",
        "service2.js",
        "service3.js"
    ]
}
```

--------------------------------

### JavaScript Example: Configure SmtpClient

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/SmtpClient

Illustrates how to configure the SmtpClient in JavaScript using a configuration object. This example sets up the sender's email, display name, SMTP host, server, username, and password.

```JavaScript
var cfg = {
    from: "appservice@example.com",
    fromName: "The App Service",
    host: "localhost",
    server: "mail.example.com",
    username: "appservice@example.com",
    password: "pwd"
};

SmtpClient.config(cfg.from, cfg.fromName, cfg.host, cfg.server, cfg.username, cfg.password);
```

--------------------------------

### Example Service API Definition (JSON)

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appgeneric

Provides an example of how to define a service API, including the service name, API name, and its title. This demonstrates a practical application of the service API definition structure.

```JSON
"serviceApis": {
    "acme-provisioning-service": {
        "com.innovaphone.provisioning": {
            "title": "ACME"
        }
    }
}
```

--------------------------------

### Example Valgrind Memory Error Log Output

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/gettingstarted

A synthetic example of Valgrind's output when memory-related errors or still reachable memory are detected. This log helps developers identify issues such as memory leaks, uninitialized reads, and invalid memory access, providing detailed stack traces to pinpoint the source of the problem.

```Valgrind Log
        ==1506== HEAP SUMMARY:
        ==1506==     in use at exit: 20,601 bytes in 4 blocks
        ==1506==   total heap usage: 422 allocs, 418 frees, 174,870 bytes allocated
        ==1506==
        ==1506== 9 bytes in 1 blocks are still reachable in loss record 1 of 4
        ==1506==    at 0x4835474: malloc (vg_replace_malloc.c:299)
        ==1506==    by 0x4B2A8D3: strdup (in /lib/libc-2.22.so)
        ==1506==
        ==1506== 16 bytes in 1 blocks are still reachable in loss record 2 of 4
        ==1506==    at 0x4835C58: operator new(unsigned int) (vg_replace_malloc.c:328)
        ==1506==    by 0x2AF8B: IDebug::Create() (debug.cpp:371)
        ==1506==    by 0x2AFF3: __static_initialization_and_destruction_0(int, int) (debug.cpp:51)
        ==1506==    by 0x2B02B: _GLOBAL__sub_I_debug (debug.cpp:372)
        ==1506==    by 0x5961F: __libc_csu_init (in /mnt/sda2/apps/sysadmin)
        ==1506==
        ==1506== 352 bytes in 1 blocks are still reachable in loss record 3 of 4
        ==1506==    at 0x4835474: malloc (vg_replace_malloc.c:299)
        ==1506==    by 0x4B1021F: ??? (in /lib/libc-2.22.so)
        ==1506==    by 0x2A61F: Debug::OpenFile() (debug.cpp:208)
        ==1506==    by 0x2990B: Debug::Debug() (debug.cpp:69)
        ==1506==    by 0x2AF9B: IDebug::Create() (debug.cpp:371)
        ==1506==    by 0x2AFF3: __static_initialization_and_destruction_0(int, int) (debug.cpp:51)
        ==1506==    by 0x2B02B: _GLOBAL__sub_I_debug (debug.cpp:372)
        ==1506==    by 0x5961F: __libc_csu_init (in /mnt/sda2/apps/sysadmin)
        ==1506==
        ==1506== 20,224 bytes in 1 blocks are still reachable in loss record 4 of 4
        ==1506==    at 0x4835474: malloc (vg_replace_malloc.c:299)
        ==1506==    by 0x490EE2F: ??? (in /usr/lib/libstdc++.so.6.0.21)
        ==1506==
        ==1506== LEAK SUMMARY:
        ==1506==    definitely lost: 0 bytes in 0 blocks
        ==1506==    indirectly lost: 0 bytes in 0 blocks
        ==1506==      possibly lost: 0 bytes in 0 blocks
        ==1506==    still reachable: 20,601 bytes in 4 blocks
        ==1506==         suppressed: 0 bytes in 0 blocks
        ==1506==
        ==1506== For counts of detected and suppressed errors, rerun with: -v
        ==1506== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0
```

--------------------------------

### Integrating TaskGetHistory with NewApp1Session Usage Guide

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/DatabaseTutorial

Step-by-step guide on how to integrate and use the `TaskGetHistory` class within the `NewApp1Session` for handling 'GetHistory' message types. This involves adding members, initializing tasks, handling message types, and implementing callbacks.

```APIDOC
Integration Steps:
1. Add UTaskTemplate<NewApp1Session, TaskGetHistory> taskGetHistory member to NewApp1Session.
2. Add task callback functions:
   - void TaskGetHistoryProgress(class TaskGetHistory * task, dword progress = 0);
   - void TaskGetHistoryFinished(class TaskGetHistory * task);
3. Initialize taskGetHistory in NewApp1Session constructor with these callback functions.
4. In NewApp1Session::AppWebsocketMessage, add strcmp for "GetHistory" message type.
5. Inside the "GetHistory" block:
   - Set currentTask to a new instance of TaskGetHistory.
   - Start this task using the taskGetHistory member.
6. Implement TaskGetHistoryProgress: Send a JSON message (e.g., "GetHistoryResult") with data from one row.
7. Implement TaskGetHistoryFinished: Handle task completion.
```

--------------------------------

### Example JSON Response for C++ GET Login Handler

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/RCCfromExternalWebPage

This JSON snippet illustrates the expected output format from the WebserviceLogin GET handler upon a successful login request. It includes fields such as mt (message type), app, domain, sip, guid, dn, challenge, and the calculated digest, representing the authenticated login details.

```JSON
{"mt":"AppGetLoginResult","app":"test","domain":"test.com","sip":"","guid":"","dn":"","challenge":"0","digest":"66ee3f52256a8eed034603b98cbaf98890bab6f42adb4a34de928e1885d68293"}
```

--------------------------------

### JavaScript Example: Creating an HTTP GET Request

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/HttpClient

Demonstrates how to create a new HttpClientRequest object using the `HttpClient.request` method for a GET request to a specified URI. This initiates an asynchronous HTTP request.

```JavaScript
var req = HttpClient.request("GET", "https://www.innovaphone.com");
```

--------------------------------

### DBFiles Start Properties (APIDOC)

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appgeneric

Detailed properties for starting a dbfiles instance, including its name and a reference to a folder in the database. The 'folder' property uses an SQL type to link files to specific database entries.

```APIDOC
DBFiles Start Object:
  cmd: "start" (string)
  name: string - The name of the dbfiles instance.
  folder: string - An SQL type, which references another database row, which is used as a folder for the files. Example: "BIGINT REFERENCES reports(id) ON DELETE CASCADE"
```

--------------------------------

### Example: Set oncomplete Callback

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/WebServer

Demonstrates how to set the `oncomplete` callback to log the success or failure of a `WebServerRequest`.

```JavaScript
req.oncomplete(function(req, success) {
    log("WebServerRequest " + (success ? "succeeded" : "failed"));
});
```

--------------------------------

### JavaScript: Perform a GET Request with HttpClient

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/HttpClient

This example demonstrates how to perform a GET request to retrieve a text file in chunks. It uses `onrecv` to process data incrementally and `oncomplete` to log the final status and content.

```javascript
var text = "";

HttpClient.request("GET", "https://www.example.com/file.txt")
    .onrecv(function (req, data, last) {
        text += new TextDecoder("utf-8").decode(data);
        if (!last) req.recv();
    }, 2048)
    .oncomplete(function(req, success) {
        if (success) log("GET OK\n" + text);
        else log("GET ERROR");
    });
```

--------------------------------

### Send HTTP Request over TCP with Socket.send

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Network

Example demonstrating how to construct and send a simple HTTP GET request over an established TCP connection using `socket.send` and `Encoding.stringToBin`.

```JavaScript
// Send a HTTP request on a TCP connection
var request = Encoding.stringToBin(
    "GET / HTTP/1.1\r\n" +
    "Host: www.example.com\r\n" +
    "Connection: close\r\n" +
    "\r\n"
);

socket.send(request);
```

--------------------------------

### Example JSON for Software Configuration

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/howto/AppStore

Presents a sample software.json structure, showcasing how software details like ID, folder, binary, versions, manufacturer, title, and description are organized within the configuration file.

```json
{ "software": [{
    "id": "manufacturer_toolbox",
    "folder": "toolbox",
    "binary": "toolbox",
    "versions": [
    {"id": "13r1","build": "130001","label": "sr01"},
    {"id": "13r1","build": "130003","label": "sr02"}
    ],
    "manufacturer": "manufacturer",
    "title": "Toolbox",
    "description": "This is a demo software."
    }]
}
```

--------------------------------

### JavaScript: Get HTTP Response Header Value

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/HttpClient

Example showing how to retrieve the value of a specific HTTP response header field, such as 'X-Token', using `req.responseHeader()`. The method returns an array of strings.

```javascript
var arr = req.responseHeader("X-Token");
```

--------------------------------

### Example JSON for Firmware Configuration

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/howto/AppStore

Illustrates the structure of firmware.json with sample data for devices and their associated firmware versions. It shows how device IDs are linked to available releases and how each release's build, text label, and wiki link are defined.

```json
{ "devices": [{
		"id": "IP0010",
		"versions": ["10.00","13r1"]
	},
	{
		"id": "IP0011",
		"versions": ["10.00","13r1"]
	}],
	"versions": [{
		"id": "10.00",
		"build": "100017",
		"text": "10.00 sr01 [100017]",
		"wiki": "http://wiki.innovaphone.com/index.php?title=Howto:Firmware_Upgrade_V9_V10"
	},
	{
		"id": "13r1",
		"build": "130001",
		"text": "13r1 sr01 [130001]",
		"wiki": "https://wiki.innovaphone.com/index.php?title=Howto:Firmware_Upgrade"
	}]
}
```

--------------------------------

### JavaScript: Get HTTP Response Status Code

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/HttpClient

Example showing how to retrieve the HTTP status code of a completed request using `req.responseCode()`. The returned value is an integer representing the status code.

```javascript
var code = req.responseCode();
```

--------------------------------

### Innovaphone SDK: Implement REST API with GET, PUT, DELETE

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/WebServer

This JavaScript example showcases the implementation of a simple REST API using WebServer.onrequest in the Innovaphone SDK. It handles GET requests to retrieve a stored UTF-8 string, PUT requests to update it, and DELETE requests to clear it. The snippet demonstrates response handling, content type setting, and asynchronous data reception.

```javascript
// the variable containing the string value
var value = null;

WebServer.onrequest("value", function(req) {
    if (req.method == "GET") {
        if (value) {
            // value exists, send it back as text/plain
            req.responseContentType("txt")
                .sendResponse()
                .onsend(function(req) {
                    req.send(new TextEncoder("utf-8").encode(value), true);
                });
        }
        else {
            // value does not exist, send 404 Not Found
            req.cancel();
        }
    }
    else if (req.method == "PUT") {
        // overwrite existing value with newValue

        var newValue = "";
        req.onrecv(function(req, data) {
            if (data) {
                newValue += (new TextDecoder("utf-8").decode(data));
                req.recv();
            }
            else {
                value = newValue;
                req.sendResponse();
            }
        });
    }
    else if (req.method == "DELETE") {
        // delete value
        value = null;
        req.sendResponse();
    }
    else {
        req.cancel();
    }
});
```

--------------------------------

### Example JSON for Apps Configuration

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/howto/AppStore

Provides a sample apps.json structure demonstrating how application details are represented, including ID, folder, binary, version array, manufacturer, title, and optional fields like description, support, and licensing information.

```json
{ "apps": [{
	"id": "manufacturer_apidemo",
	"folder": "apidemo",
	"binary": "apidemo",
	"versions": [
			{"id": "13r1","build": "130001","label": "sr01"},
			{"id": "13r2","build": "134003","label": "sr01"}
	],
	"manufacturer": "manufacturer",
	"title": "Apidemo",
	"description": "This is a demo app.",
	"support": "support@manufacturer.com",
	"impressum": "https://www.manufacturer.com/impressum.html",
	"license_type": "free",
	"license_info": "",
	"eula": "https://www.manufacturer.com/eula.html",
	"langs": ["cs","nl","en","fr","de","it","pl","pt","ru","sl","es"],
	"categories": ["administration","tools"]
	}]
}
```

--------------------------------

### JavaScript Example for Network.macAddress

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Network

Demonstrates how to use the `Network.macAddress` function in JavaScript to retrieve and log the MAC address of the application platform.

```JavaScript
// Write the MAC address of the AP to the log
var mac = Network.macAddress();
log("mac address: " + mac);
```

--------------------------------

### JavaScript: Get HTTP Response Status Description

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/HttpClient

Example showing how to retrieve the HTTP status code and reason phrase of a completed request using `req.responseCodeDescription()`. The returned value is a string like '200 OK' or '404 Not Found'.

```javascript
var description = req.responseCodeDescription();
```

--------------------------------

### Publish App as Provisioning Provider in C++

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Provisioning API

This C++ code snippet demonstrates how to publish your application as a provisioning provider using the `AppWebsocketServiceInfo` function within the session class. It registers a service named 'com.innovaphone.provisioning' with a title 'SDKProvisioning'.

```C++
void SDKProvisioningSession::AppWebsocketServiceInfo(const char * app, class json_io & msg, word base)
    {
    sdkprovisioning->Log("SDKProvisioningSession(%p)::AppWebsocketServiceInfo", this);
    word apis = msg.add_object(base, "apis");
    word api = msg.add_object(apis, "com.innovaphone.provisioning");
    msg.add_string(api, "title", "SDKProvisioning");
    }

```

--------------------------------

### Initial C++ HTTP Request Dispatch in Innovaphone SDK Webserver Plugin

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/HttpRequests

This C++ function, RestApi::WebserverPluginHttpListenResult, serves as the central dispatch point for incoming HTTP requests (GET, PUT, DELETE) within the Innovaphone SDK. It identifies the request type and accepts a new RestApiGet instance for GET requests, RestApiPut for PUT, or cancels for others, demonstrating the initial request handling setup.

```C++
void RestApi::WebserverPluginHttpListenResult(IWebserverPlugin * plugin, ws_request_type_t requestType, char * resourceName, const char * registeredPathForRequest, size_t dataSize)
{
    if (requestType == WS_REQUEST_GET) {
        debug->printf("RestApi GET");
        plugin->Accept(new RestApiGet(this));  // changed this line
    }
    else if (requestType == WS_REQUEST_PUT) {
        debug->printf("RestApi PUT");
        plugin->Accept(new RestApiPut(this));
    }
    else if (requestType == WS_REQUEST_DELETE) {
        debug->printf("RestApi DELETE");
        plugin->Cancel(WSP_CANCEL_NOT_FOUND);
    }
    else {
        plugin->Cancel(WSP_CANCEL_NOT_FOUND);
    }
}
```

--------------------------------

### Example: Set Custom Response Header

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/WebServer

Demonstrates how to set a custom HTTP header for the response using `responseHeader`.

```JavaScript
req.responseHeader("X-Token","c29tZXRva2Vu");
```

--------------------------------

### tasks_postgresql

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/reference

Initialization of database tables.

```APIDOC
tasks_postgresql
```

--------------------------------

### JavaScript AES-128 CTR Encryption and Decryption

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Crypto

Example demonstrating how to use the `Crypto.cipher` object for AES-128 encryption and decryption in CTR mode. It shows key and IV setup, encryption of plaintext, and subsequent decryption of the ciphertext back to the original plaintext.

```JavaScript
var key = "73757065727375706572736563726574";
var iv = "00000000000000000000000000000000";
var plaintext = "This is the secret text to be encrypted";

// encryption using AES-128 in CTR mode
var ciphertext = Crypto.cipher("AES", "CTR", key, true).iv(iv).crypt(plaintext);

// decryption using AES-128 in CTR mode
var decrypted = Crypto.cipher("AES", "CTR", key, false).iv(iv).crypt(ciphertext);

// now decrypted contains the plain text again
```

--------------------------------

### Initialize Innovaphone App Template

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/ClientAPIs

Initializes the basic structure of an Innovaphone app, setting up UI variables for color schemes and language, and establishing a connection via `appwebsocket`.

```JavaScript
var innovaphone = innovaphone || {};
innovaphone.NewApp1 = innovaphone.NewApp1 || function (start, args) {
    this.createNode("body");

    var that = this;
    var colorSchemes = {
        dark: {
            "--bg": "#191919",
            "--button": "#303030",
            "--text-standard": "#f2f5f6"
        },
        light: {
            "--bg": "white",
            "--button": "#e0e0e0",
            "--text-standard": "#4a4a49"
        }
    };

    var schemes = new innovaphone.ui1.CssVariables(colorSchemes, start.scheme);
    start.onschemechanged.attach(function () { schemes.activate(start.scheme) });

    var texts = new innovaphone.lib1.Languages(innovaphone.NewApp1Texts, start.lang);
    start.onlangchanged.attach(function () { texts.activate(start.lang) });

    var app = new innovaphone.appwebsocket.Connection(start.url, start.name);
    app.checkBuild = true;
    app.onconnected = app_connected;

    function app_connected(domain, user, dn, appdomain) {

    }
}
```

--------------------------------

### Example JSON for ReplicateUpdate Message

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/PbxTableUsers

Demonstrates the structure of a ReplicateUpdate message sent from the PBX to an app instance after a user object has been edited. It includes various user-related data such as GUID, H323, email, allowances, groups, devices, call diversions (cds), and forks.

```JSON
{
    "mt":"ReplicateUpdate",
    "api":"PbxTableUsers",
    "columns":
    {
        "guid":"c9ebcc5914bd5e01c8020090334106ee",
        "h323":"user0",
        "pwd":"05a14fa93ec663b04deaf54277b1eb874612793587f0b287",
        "cn":"User0",
        "apps-my":"apps,usersadmin,profile,phone,users,users2,softphone,devices,pbxmanager",
        "config":"Config",
        "node":"root",
        "loc":"master",
        "hide":false,
        "e164":"201",
        "emails":[
            {
                "email":"user0@example.com"
            }
        ],
        "allows":[
            {
                "name":"@test1.com",
                "presence":true,
                "visible":true
            },
            {
                "name":"@test2.com",
                "presence":true,
                "visible":true
            }
        ],
        "t-allows":[
            {
                "name":"@test1.com",
                "online":true,
                "presence":true,
                "visible":true
            }
        ],
        "grps":[
            {
                "name":"group1",
                "mode":"active",
                "dyn":"in"
            }
        ],
        "devices":[
            {
                "hw":"Swphone_user0",
                "text":"softphone",
                "app":"softphone",
                "tls":true,
                "sreg":true
            }
        ],
        "cds":[
            {
                "type":"cfnr",
                "bool":"booltest",
                "e164":"203"
            },
            {
                "type":"cfb",
                "h323":"test",
                "src":"<src type=\"do\"><ep ext=\"false\" fwd=\"fwd\" /></src>"
            }
        ],
        "forks":[
            {
                "e164":"9999",
                "bool":"booltest",
                "bool-not":true,
                "mobility":"Mobility",
                "delay":30,
                "hw":"Smartphone",
                "app":"rcc",
                "cw":true,
                "min":1,
                "max":10
            }
        ]
    }
}
```

--------------------------------

### C++: Process PbxInfo and Discover Services API

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Provisioning API

This C++ code block handles incoming 'PbxInfo' messages. It verifies the application name, initializes a JsonApi for communication, and then iterates through the available APIs to locate and activate the 'Services' API. This is crucial for enabling subsequent connections to Innovaphone devices and retrieving their configurations. It also adds the current session to a list of Pbx sessions.

```C++
else if (!strcmp(mt, "PbxInfo")) {
    if (!strcmp(app, "innovaphone-sdkprovisioning")){  //Here it must be checked the name of the javascript file of your app, where Websocket flag has been selected
    class JsonApi * jsonApi = sdkprovisioning->CreateJsonApi("PbxAdminApi", this, msg, base);
    if (jsonApi) jsonApi->JsonApiStart();
    }
    word apis = msg.get_array(base, "apis");
    if (apis != JSON_ID_NONE) {
    word last = 0;
    const char * apiName = NULL;
    while ((apiName = msg.get_string(apis, last)) != NULL) {
    if (!strcmp(apiName, "Services")) {
    services = CreateServicesApi(this, this);
    sdkprovisioning->ReopenSysclient();
    break;
    }
    }
    }
    sdkprovisioning->pbxSessions.push_back(this);
    if (rcv) AppWebsocketMessageComplete();
    rcv = false;
    }
    {
    }
```

--------------------------------

### PBX Triggers Application Wake-up Event

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/myApps

Sent by the PBX, this message signals the client to start specific applications due to an external event, such as an incoming phone call or chat message. It specifies the wake type, hardware identifier, and whether the event is incoming, guiding the client on which app to launch.

```APIDOC
{
    "mt": "Wake",
    "type": string,
    "hw": string,
    "incoming": boolean
}
```

--------------------------------

### Handle AppWebsocket Connection for JsonApiContext in C++

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Replicator

Demonstrates how to create and start a `JsonApi` instance when an `AppWebsocket` connection is established and a 'PbxInfo' message is received. This links the websocket to the `JsonApiContext` for `PbxTableUsers`, facilitating real-time data updates.

```C++
class NewApp1Session : ..., public AppWebsocket, ... {
...
}
void NewApp1Session::AppWebsocketMessage(class json_io& msg, word base, const char* mt, const char* src)
{
...
    if (!strcmp(mt, "PbxInfo")) {
        class JsonApi * jsonApi = newapp1->CreateJsonApi("PbxTableUsers", this, msg, base);
        if (jsonApi) jsonApi->JsonApiStart();
    }
}
```

--------------------------------

### Channels Object API Definition

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/Signal

Defines the comprehensive structure of the Channels object, which encapsulates a complete media description for a call. It is used as a media offer (proposal) when accompanied by channels_cmd 'PROPOSAL', or as a media answer (select) with channels_cmd 'SELECT'. It includes properties for source, ID, GUID, key, RTCP multiplexing, setup roles, ICE parameters, and an array of individual channel descriptions.

```APIDOC
{
    "source": Source,
    "id": Id,
    "guid": GUID,
    "key":Key,

    "audio_rtcp_mux":Audio RTCP multiplxing,
    "t38_rtcp_mux":T.38 RTCP multiplxing,
    "video_rtcp_mux":Video RTCP multiplxing,
    "collab_rtcp_mux":Collab RTCP multiplxing,

    "audio_setup_role":Audio Setup Role,
    "t38_setup_role":T.38 Setup Role,
    "video_setup_role":Video Setup Role,
    "collab_setup_role":Collab Setup Role,

    "audio_ice":Audio ICE,
    "t38_ice":T.38 ICE,
    "video_ice":Video ICE,
    "collab_ice":Collab ICE,

    "ch":[Channel,...]
}
```

--------------------------------

### C++: Initiate Provisioning Devices Closure

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/Provisioning API

This function initiates the closure of the provisioning device management. It sets a cancellation flag and then calls TryClose to perform the actual cleanup and shutdown logic.

```C++
void ProvisioningDevices::Close(bool cancel)
{
    this->cancel = cancel;
    TryClose();
    }
```

--------------------------------

### Innovaphone Local App Store Instance Configuration Parameters

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appstoreguide

Details the required parameters for configuring a new Innovaphone App Store instance, including naming conventions, domain settings, and database credentials.

```APIDOC
App Store Instance Parameters:
  Name: string (lowercase, no spaces, URL safe characters)
  Domain: string (same as PBX domain or URL safe value, e.g., 'company-name.com')
  Password: string
  Database name: string (unchanged)
  Database user: string (unchanged)
```

--------------------------------

### IM Setup Object (JSON)

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/Signal

This JSON object is included in the setup message of a no-media call to indicate that the call is for instant messaging (chat).

```JSON
{
    "type": "im_setup"
}
```

--------------------------------

### NewApp1Session Class API Reference

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/tutorials/DatabaseTutorial

API documentation for the `NewApp1Session` class, outlining its members and methods related to websocket communication, task management, and application state.

```APIDOC
class NewApp1Session : public AppUpdatesSession
  Members:
    UTaskTemplate<NewApp1Session, TaskGetHistory> taskGetHistory: Member for managing TaskGetHistory instances.
    NewApp1 * instance: Pointer to the NewApp1 application instance.
    char * currentSrc: Current source identifier.
    ITask * currentTask: Pointer to the currently active task.
    bool closed: Flag indicating if the session is closed.
    bool closing: Flag indicating if the session is in the process of closing.
    bool admin: Flag for admin status.
    bool adminApp: Flag for admin application status.
    BadgeCountSignaling * badgecount: Pointer to badge count signaling object.
  Constructor:
    NewApp1Session(NewApp1 * instance)
      instance: Pointer to the NewApp1 application instance.
  Destructor:
    ~NewApp1Session()
  Methods:
    void AppWebsocketAccept(UWebsocket * uwebsocket)
      uwebsocket: Pointer to the websocket object.
      Description: Accepts an incoming websocket connection.
    char * AppWebsocketPassword() override
      Returns: Application websocket password.
    void AppWebsocketMessage(json_io & msg, word base, const char * mt, const char * src) override
      msg: JSON message object.
      base: Base index for JSON object.
      mt: Message type.
      src: Source identifier.
      Description: Handles incoming websocket messages.
    void AppWebsocketAppInfo(const char * app, json_io & msg, word base) override
      app: Application name.
      msg: JSON message object.
      base: Base index for JSON object.
      Description: Provides application information via websocket.
    bool AppWebsocketConnectComplete(json_io & msg, word info) override
      msg: JSON message object.
      info: Connection information.
      Returns: True if connection is complete.
    void AppWebsocketClosed() override
      Description: Callback for when the websocket connection is closed.
    void TaskGetHistoryProgress(TaskGetHistory * task, dword progress = 0)
      task: Pointer to the TaskGetHistory instance.
      progress: Current progress (optional).
      Description: Callback for progress updates from TaskGetHistory.
    void TaskGetHistoryFinished(TaskGetHistory * task)
      task: Pointer to the TaskGetHistory instance.
      Description: Callback for when TaskGetHistory completes.
    void ResponseSent() override
      Description: Callback for when a response has been sent.
    void TryClose()
      Description: Attempts to close the session.
    bool CheckSession()
      Returns: True if the session is valid.
    void Close()
      Description: Closes the session.
```

--------------------------------

### Establish TCP Connection with Socket.connect

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/javascript/Network

Example demonstrating how to establish a TCP connection to a specified IP address and port using `Network.socket` and `connect`, then handling the connection with an `onconnect` callback.

```JavaScript
// Establish a TCP connection to 10.0.0.1:80
Network.socket("tcp")
    .connect("10.0.0.1", 80)
    .onconnect(function(socket) {
        // do something with the connection
    });
```

--------------------------------

### info Object Definition and Example

Source: https://sdk.innovaphone.com/15r1/doc/sdk.htm/appwebsocket/RCC

Defines additional call information, specifying its type, integer value, and string value, along with a JSON example.

```APIDOC
info:
  type:
    type: string
    description: The info type: cause, uui
  vali:
    type: integer
    description: Integer value
  vals:
    type: string
    description: String value
```

```JSON
{
    "info":[
        {"type":"cause","vali":1,"vals":"Unallocated (unassigned) number"}
    ]
}
```
Tokens:
Raw