0
mirror of https://github.com/valentineus/iii-client.git synced 2025-04-28 01:41:25 +03:00
iii-client/README.md

2.0 KiB

III Client

npm

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

Attention! At the moment there are difficulties with the iii.ru service, there is a possibility that the service will not be restored. All information on the company's forum.

Features

  • A small and light library.
  • Receiving and sending messages.
  • Installation and processing of sessions.

Installation

npm install --save iii-client

Using

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

import client from 'iii-client';

const uuid = '109cd867-0ef3-4473-af71-7543a9b2fccd';
const text = 'Hello, World!';

// We connect to the system and get a session
client.connect(uuid).then(session => {
    // Send the message and process the response
    client.send(session.cuid, text).then(answer => {
        console.info(answer);
    });
}).catch(error => console.error(error.message));

API

Functions

connect(uuid)

Connects to the server and returns the connection data.

Promise: Object Answer from the server.

Rejects: Error If there are errors in operation.

Param Type Description
uuid String The bot ID.

send(cuid, text)

Send a message to the server and return a response.

Promise: Object Answer from the server.

Rejects: Error If there are errors in operation.

Param Type Description
cuid String Session identifier.
text String Message text.

Found out a mistake or feel a lack of functionality? issues

License

JavaScript Style Guide

MIT. Copyright (c) Valentin Popov.