iii-client

3.2.2 • Public • Published

III Client

GitHub Release NPM Build Status Codacy Badge Codacy Coverage Badge Gitter Badge

Simple API for communicating with the bot of the "iii.ru" service.

Features

  • Multiplatform library.
  • A small and light library.
  • Getting session ID.
  • Sending and receiving messages.

Installation

NodeJS:

npm install --save iii-client

Browser:

<script src="https://unpkg.com/iii-client@latest/dist/bundle.js">
    /* iiiClient - This is the global name for accessing the package */
</script> 

Using

An example of a connection, receiving session identification and sending a bot message:

import { connect, send } from 'iii-client';
 
var uuid = '109cd867-0ef3-4473-af71-7543a9b2fccd';
var cuid = '0340feab-b09e-4960-96e9-c9518b1fb157';
var text = 'Hello, World!';
 
/* We connect to the system and get a session */
connect(uuid, (request) => {
    console.info(`Session: ${request.result.cuid}`);
});
 
/* Send the message and process the response */
send(cuid, text, (answer) => {
    console.info(`Answer: ${answer.result.text.value}`);
});

API

Functions

connect(uuid, callback)

Connection to the service and retrieves the session identifier.

send(cuid, text, callback)

Sends a message to bot and returns a response.

connect(uuid, callback)

Connection to the service and retrieves the session identifier.

Param Type Description
uuid String Bot ID
callback function Function handler

send(uuid, text, callback)

Sends a message to bot and returns a response.

Param Type Description
uuid String Session ID
text String The message you are sending
callback function Function handler

License

JavaScript Style Guide

MIT. Copyright (c) Valentin Popov.

Readme

Keywords

Package Sidebar

Install

npm i iii-client

Weekly Downloads

1

Version

3.2.2

License

MIT

Last publish

Collaborators

  • valentineus