Class VkRequest

Класс отвечающий за отправку запросов на Vk сервер.

Документация по ВК api.

See

(https://vk.com/dev/bots_docs) Смотри тут

Hierarchy

VkRequest
- MarusiaRequest

Index

Constructors

constructor

new VkRequest(): VkRequest
VkRequest constructor.

Returns VkRequest
- Defined in src/api/VkRequest.ts:63

Properties

`Protected` `Readonly` VK_API_ENDPOINT

VK_API_ENDPOINT: "https://api.vk.com/method/" = 'https://api.vk.com/method/'

Const

string Адрес, на который будут отправляться запросы.

`Protected` `Readonly` VK_API_VERSION

VK_API_VERSION: "5.103" = '5.103'

Const

string Стандартная версия Api.

`Protected` _error

_error: null | string

Текст ошибки.

`Protected` _request

_request: Request

Отправка запросов.

See

Request Смотри тут

`Protected` _vkApiVersion

_vkApiVersion: string

Используемая версия Api.

isAttachContent

isAttachContent: boolean

Тип контента файла. True, если передается содержимое файла. По умолчанию: false.

Default Value

false

token

token: null | string

Vk токен, необходимый для отправки запросов на сервер.

Methods

`Protected` _log

_log(error?: string): void
Сохранение логов.
Parameters
- error: string = ''
  
  Текст ошибки.
Returns void
- Defined in src/api/VkRequest.ts:421

call

call<T>(method: string): Promise<null | T>
Вызов методов vk.

Returns
Promise

Api
Type Parameters
- T extends IVkApi<{}, T>
Parameters
- method: string
  
  Название метода.
Returns Promise<null | T>
- Defined in src/api/VkRequest.ts:96

docsGetMessagesUploadServer

docsGetMessagesUploadServer(peerId: TVkPeerId, type: TVkDocType): Promise<null | IVkUploadServer>
Получение данные по загрузке файла на vk сервер.

Returns
Promise [
- 'upload_url' => url Адрес сервера для загрузки документа ]
Api
Parameters
- peerId: TVkPeerId
  
  Идентификатор места назначения.
- type: TVkDocType
  
  ('doc' - Обычный документ, 'audio_message' - Голосовое сообщение, 'graffiti' - Граффити).
Returns Promise<null | IVkUploadServer>
- Defined in src/api/VkRequest.ts:331

docsSave

docsSave(file: string, title: string, tags?: null | string): Promise<null | IVkDocSave>
Загрузка файла на vk сервер.

Returns
Promise [
- 'type' => string Тип загруженного документа
- 'graffiti' => [
  - 'id' => int Идентификатор документа
  - 'owner_id' => int Идентификатор пользователя, загрузившего документ
  - 'url' => string Адрес документа, по которому его можно загрузить
  - 'width' => int Ширина изображения в px
  - 'height' => int Высота изображения в px ] or
- 'audio_message' => [
  - 'id' => int Идентификатор документа
  - 'owner_id' => int Идентификатор пользователя, загрузившего документ
  - 'duration' => int Длительность аудио сообщения в секундах
  - 'waveform' => int[] Массив значений для визуального отображения звука
  - 'link_ogg' => url .ogg файла
  - 'link_mp3' => url .mp3 файла ] or
- 'doc' =>[
  - 'id' => int Идентификатор документа
  - 'owner_id' => int Идентификатор пользователя, загрузившего документ
  - 'url' => string Адрес документа, по которому его можно загрузить
  - 'title' => string Название документа
  - 'size' => int Размер документа в байтах
  - 'ext' => string Расширение документа
  - 'date' => int Дата добавления в формате unix time
  - 'type' => int Тип документа. (1 - текстовый документ; 2 - архивы; 3 - gif; 4 - изображения; 5 - аудио; 6 - видео; 7 - электронные книги; 8 - неизвестно)
  - 'preview' => [ Информация для предварительного просмотра документа.
    - 'photo' => [Изображения для предпросмотра.
      
      'sizes' => array Массив копий изображения в разных размерах. Подробное описание структуры (https://vk.com/dev/objects/photo_sizes) ] or
    - 'graffiti' => [ Данные о граффити
      
      'src' => string url Документа с граффити
      
      'width' => int Ширина изображения в px
      
      'height' => int Высота изображения в px ] or
    - 'audio_message' => [ Данные об аудиосообщении
      
      'duration' => int Длительность аудио сообщения в секундах
      
      'waveform' => int[] Массив значений для визуального отображения звука
      
      'link_ogg' => url .ogg файла
      
      'link_mp3' => url .mp3 файла ] ] ]
- 'id' => int Идентификатор документа
- 'owner_id' => int Идентификатор пользователя, загрузившего документ
- 'url' => string Адрес документа, по которому его можно загрузить (Для граффити и документа)
- 'width' => int Ширина изображения в px (Для граффити)
- 'height' => int Высота изображения в px (Для граффити)
- 'duration' => int Длительность аудио сообщения в секундах(Для Голосового сообщения)
- 'waleform' => int[] Массив значений для визуального отображения звука(Для Голосового сообщения)
- 'link_ogg' => url .ogg файла(Для Голосового сообщения)
- 'link_mp3' => url .mp3 файла(Для Голосового сообщения) ]
Api
Parameters
- file: string
  
  Сам файл.
- title: string
  
  Заголовок файла.
- tags: null | string = null
  
  Теги, по которым будет осуществляться поиск.
Returns Promise<null | IVkDocSave>
- Defined in src/api/VkRequest.ts:405

initToken

initToken(token: string): void
Установить vk токен.

Api
Parameters
- token: string
  
  Токен для загрузки данных на сервер.
Returns void
- Defined in src/api/VkRequest.ts:85

messagesSend

messagesSend(peerId: TVkPeerId, message: string, params?: null | IVkParams): Promise<null | IVKSendMessage>
Отправка сообщения пользователю.

Returns
Promise
- int: response or in user_ids
- 'peer_id' => int Идентификатор назначения
- 'message_id' => int Идентификатор сообщения
- 'error' => array
Api
Parameters
- peerId: TVkPeerId
  
  Идентификатор места назначения.
- message: string
  
  Текст сообщения.
- params: null | IVkParams = null
  Пользовательские параметры: [
  - integer user_id: User ID (by default — current user).
  - integer random_id: Unique identifier to avoid resending the message.
  - integer peer_id: Destination ID. "For user: 'User ID', e.g. '12345'. For chat: '2000000000' + 'chat_id', e.g. '2000000001'. For community: '- community ID', e.g. '-12345'. ".
  - string domain: User's short address (for example, 'illarionov').
  - integer chat_id: ID of conversation the message will relate to.
  - array[integer] user_ids: IDs of message recipients (if new conversation shall be started).
  - string message: (Required if 'attachments' is not set.) Text of the message.
  - number lat: Geographical latitude of a check-in, in degrees (from -90 to 90).
  - number long: Geographical longitude of a check-in, in degrees (from -180 to 180).
  - string attachment: (Required if 'message' is not set.) List of objects attached to the message, separated by commas, in the following format: "_", '' — Type of media attachment: 'photo' — photo, 'video' — video, 'audio' — audio, 'doc' — document, 'wall' — wall post, '' — ID of the media attachment owner. '' — media attachment ID. Example: "photo100172_166443618".
  - integer reply_to.
  - array[integer] forward_messages: ID of forwarded messages, separated with a comma. Listed messages of the sender will be shown in the message body at the recipient's. Example: "123,431,544".
  - string forward.
  - integer sticker_id: Sticker id.
  - integer group_id: Group ID (for group messages with group access token).
  - string keyboard.
  - string payload.
  - boolean dont_parse_links.
  - boolean disable_mentions. ]
Returns Promise<null | IVKSendMessage>
- Defined in src/api/VkRequest.ts:189

photosGetMessagesUploadServer

photosGetMessagesUploadServer(peerId: TVkPeerId): Promise<null | IVkUploadServer>
Получение данные по загрузке изображения на vk сервер.

Returns
Promise [
- 'upload_url' => string Адрес сервера для загрузки изображения
- 'album_id' => int Идентификатор альбома
- 'group_id' => int Идентификатор сообщества ]
Api
Parameters
- peerId: TVkPeerId
  
  Идентификатор места назначения.
Returns Promise<null | IVkUploadServer>
- Defined in src/api/VkRequest.ts:284

photosSaveMessagesPhoto

photosSaveMessagesPhoto(photo: string, server: string, hash: string): Promise<null | IVkPhotosSave>
Сохранение файла на vk сервер.

Returns
Promise [
- 'id' => int Идентификатор изображения
- 'pid' => int
- 'aid' => int
- 'owner_id' => int Идентификатор пользователя, загрузившего изображение
- 'src' => string Расположение изображения
- 'src_big' => string Расположение большой версии изображения
- 'src_small' => string Расположение маленькой версии изображения
- 'created' => int Дата загрузки изображения в unix time
- 'src_xbig' => string Для изображений с большим разрешением
- 'src_xxbig' => string Для изображений с большим разрешением ]
See
upload() Смотри тут

Api
Parameters
- photo: string
  
  Фотография.
- server: string
  
  Сервер.
- hash: string
  
  Хэш.
Returns Promise<null | IVkPhotosSave>
- Defined in src/api/VkRequest.ts:311

upload

upload(url: string, file: string): Promise<null | IVkUploadFile>
Загрузка файлов на vk сервер.

Returns
Promise [
- 'photo' => array
- 'server' => string
- 'hash' => string ] or [
- 'file' => array ]
Api
Parameters
- url: string
  
  Адрес, на который отправляется запрос.
- file: string
  
  Загружаемый файл(ссылка или содержимое файла).
Returns Promise<null | IVkUploadFile>
- Defined in src/api/VkRequest.ts:135

usersGet

usersGet(userId: string[] | TVkPeerId, params?: null | IVkParamsUsersGet): Promise<null | IVkUsersGet>
Получение данные о пользователе.

Returns
Promise [
- 'id' => int Идентификатор пользователя
- 'first_name' => string Имя пользователя
- 'last_name' => string Фамилия пользователя
- 'deactivated' => string Возвращается, если страница удалена или заблокирована
- 'is_closed' => bool Скрыт ли профиль настройками приватности
- 'can_access_closed' => bool Может ли текущий пользователь видеть профиль при is_closed = 1 (например, он есть в друзьях). ]
Api
Parameters
- userId: string[] | TVkPeerId
  
  Идентификатор пользователя.
- params: null | IVkParamsUsersGet = null
  Пользовательские параметры: [
  - array[string] user_ids: User IDs or screen names ('screen_name'). By default, current user ID.
  - array fields: Profile fields to return. Sample values: 'nickname', 'screen_name', 'sex', 'bdate' (birthdate), 'city', 'country', 'timezone', 'photo', 'photo_medium', 'photo_big', 'has_mobile', 'contacts', 'education', 'online', 'counters', 'relation', 'last_seen', 'activity', 'can_write_private_message', 'can_see_all_posts', 'can_post', 'universities'.
  - string name_case: Case for declension of user name and surname: 'nom' — nominative (default), 'gen' — genitive , 'dat' — dative, 'acc' — accusative , 'ins' — instrumental , 'abl' — prepositional. ]
Returns Promise<null | IVkUsersGet>
- Defined in src/api/VkRequest.ts:260

Class VkRequest

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns VkRequest

Properties

Protected Readonly VK_API_ENDPOINT

Const

Protected Readonly VK_API_VERSION

Const

Protected _error

Protected _request

See

Protected _vkApiVersion

isAttachContent

Default Value

token

Methods

Protected _log

Parameters

error: string = ''

Returns void

call

Returns

Api

Type Parameters

T extends IVkApi<{}, T>

Parameters

method: string

Returns Promise<null | T>

docsGetMessagesUploadServer

Returns

Api

Parameters

peerId: TVkPeerId

type: TVkDocType

Returns Promise<null | IVkUploadServer>

docsSave

Returns

Api

Parameters

file: string

title: string

tags: null | string = null

Returns Promise<null | IVkDocSave>

initToken

Api

Parameters

token: string

Returns void

messagesSend

Returns

Api

Parameters

peerId: TVkPeerId

message: string

params: null | IVkParams = null

Returns Promise<null | IVKSendMessage>

photosGetMessagesUploadServer

Returns

Api

Parameters

peerId: TVkPeerId

Returns Promise<null | IVkUploadServer>

photosSaveMessagesPhoto

Returns

See

Api

Parameters

photo: string

server: string

hash: string

Returns Promise<null | IVkPhotosSave>

upload

Returns

`Protected` `Readonly` VK_API_ENDPOINT

`Protected` `Readonly` VK_API_VERSION

`Protected` _error

`Protected` _request

`Protected` _vkApiVersion

`Protected` _log