JSDoc: Class: Client

new Client()

Source:

v1/client.js, line 3

Methods

(static) assignDialog(dialog_id, dialog) → {Promise}

Assign dialog

Parameters:

Name	Type	Description
`dialog_id`	Number	Dialog id
`dialog`	Object	Dialog object

Source:

v1/client.js, line 78

Throws:

Error

Returns:

Type: Promise

(static) closeDialog(dialog_id) → {Promise}

Close dialog

Parameters:

Name	Type	Description
`dialog_id`	Number	Dialog id

Source:

v1/client.js, line 108

Throws:

Error

Returns:

Type: Promise

(static) deleteCommand(command_name) → {Promise}

Delete bot command

Parameters:

Name	Type	Description
`command_name`	string	Command name

Source:

v1/client.js, line 200

Throws:

Error

Returns:

Type: Promise

(static) deleteMessage(message_id) → {Promise}

Delete message

Parameters:

Name	Type	Description
`message_id`	Number	Message id

Source:

v1/client.js, line 143

Throws:

Error

Returns:

Type: Promise

(static) editCommand(command_name, command) → {Promise}

Edit bot command

Parameters:

Name	Type	Description
`command_name`	string	Command name
`command`	Object	Command object

Source:

v1/client.js, line 185

Throws:

Error

Returns:

Type: Promise

(static) editMessage(message_id, message) → {Promise}

Edit message

Parameters:

Name	Type	Description
`message_id`	Number	Message id
`message`	Object	Message object

Source:

v1/client.js, line 159

Throws:

Error

Returns:

Type: Promise

(static) filesUpload(data) → {Promise}

Upload file

Parameters:

Name	Type	Description
`data`	string	Binary data

Source:

v1/client.js, line 251

Throws:

Error

Returns:

Type: Promise

(static) filesUploadByUrl(url) → {Promise}

Upload file by url

Parameters:

Name	Type	Description
`url`	string	File url address

Source:

v1/client.js, line 263

Throws:

Error

Returns:

Type: Promise

(static) getBots(params) → {Promise}

Get bots

Parameters:

Name	Type	Description
`params`	Object	Filter's object for bots

Source:

v1/client.js, line 16

Returns:

Type: Promise

(static) getChannels(params) → {Promise}

Get channels

Parameters:

Name	Type	Description
`params`	Object	Filter's object for channels

Source:

v1/client.js, line 26

Returns:

Type: Promise

(static) getChats(params) → {Promise}

Get chats

Parameters:

Name	Type	Description
`params`	Object	Filter's object for chats

Source:

v1/client.js, line 36

Returns:

Type: Promise

(static) getCommands(params) → {Promise}

Get bot commands

Parameters:

Name	Type	Description
`params`	Object	Filter's object for commands

Source:

v1/client.js, line 173

Returns:

Type: Promise

(static) getCustomers(params) → {Promise}

Get customers

Parameters:

Name	Type	Description
`params`	Object	Filter's object for customers

Source:

v1/client.js, line 46

Returns:

Type: Promise

(static) getDialogs(params) → {Promise}

Get dialogs

Parameters:

Name	Type	Description
`params`	Object	Filter's object for dialogs

Source:

v1/client.js, line 56

Returns:

Type: Promise

(static) getFile(file_id) → {Promise}

Get file information

Parameters:

Name	Type	Description
`file_id`	string	File identifier

Source:

v1/client.js, line 235

Throws:

Error

Returns:

Type: Promise

(static) getMembers(params) → {Promise}

Get members

Parameters:

Name	Type	Description
`params`	Object	Filter's object for members

Source:

v1/client.js, line 66

Returns:

Type: Promise

(static) getMessages(params) → {Promise}

Get messages

Parameters:

Name	Type	Description
`params`	Object	Filter's object for messages

Source:

v1/client.js, line 132

Returns:

Type: Promise

(static) getUsers(params) → {Promise}

Get users

Parameters:

Name	Type	Description
`params`	Object	Filter's object for users

Source:

v1/client.js, line 224

Returns:

Type: Promise

(static) getWebsocketData(events) → {Map}

Get websocket url

Parameters:

Name	Type	Description
`events`	array.<string>	Array of strings with websocket events

Source:

v1/client.js, line 278

Throws:

Error

Returns:

Type: Map

(static) info(data) → {Promise}

Bot information update

Parameters:

Name	Type	Description
`data`	Object	Bot data

Source:

v1/client.js, line 214

Returns:

Type: Promise

(static) sendMessage(message) → {Promise}

Send message

Parameters:

Name	Type	Description
`message`	Object	Message object

Source:

v1/client.js, line 122

Returns:

Type: Promise

(static) unassignDialog(dialog_id) → {Promise}

Unassign dialog

Parameters:

Name	Type	Description
`dialog_id`	Number	Dialog id

Source:

v1/client.js, line 93

Throws:

Error

Returns:

Type: Promise