Class MarusiaRequest

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

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

See

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

Class MarusiaRequest

Hierarchy

Constructors

Properties

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

Const

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

VK_API_VERSION: "5.103" = '5.103'

Const

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

_error: null | string

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

_request: Request

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

See

Request Смотри тут

_vkApiVersion: string

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

isAttachContent: boolean

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

Default Value

false

token: null | string

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

Methods

  • Вызов методов vk.

    Returns

    Promise

    Api

    Type Parameters

    Parameters

    • method: string

      Название метода.

    Returns Promise<null | T>

  • Получение данные по загрузке файла на vk сервер.

    Returns

    Promise [

    • 'upload_url' => url Адрес сервера для загрузки документа ]

    Api

    Parameters

    • peerId: TVkPeerId

      Идентификатор места назначения.

    • type: TVkDocType

      ('doc' - Обычный документ, 'audio_message' - Голосовое сообщение, 'graffiti' - Граффити).

    Returns Promise<null | IVkUploadServer>

  • Загрузка файла на 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>

  • Установить vk токен.

    Api

    Parameters

    • token: string

      Токен для загрузки данных на сервер.

    Returns void

  • Сохранение аудиио на сервер Маруси.

    Returns

    See

    upload() Смотри тут

    Api

    Parameters

    • audio_meta: object

      анные полученные после загрузки аудио.

    Returns Promise<null | IMarusiaApiCreateAudio>

  • Получение всех загруженных изображений

    Returns

    Returns Promise<any>

  • Сохранение картинки на сервер Маруси.

    Returns

    See

    upload() Смотри тут

    Api

    Parameters

    • photo: string

      Фотография.

    • server: string

      Сервер.

    • hash: string

      Хэш.

    Returns Promise<null | IMarusiaApiSavePicture>

  • Отправка сообщения пользователю.

    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>

  • Получение данные по загрузке изображения на vk сервер.

    Returns

    Promise [

    • 'upload_url' => string Адрес сервера для загрузки изображения
    • 'album_id' => int Идентификатор альбома
    • 'group_id' => int Идентификатор сообщества ]

    Api

    Parameters

    • peerId: TVkPeerId

      Идентификатор места назначения.

    Returns Promise<null | IVkUploadServer>

  • Сохранение файла на 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>

  • Загрузка файлов на vk сервер.

    Returns

    Promise [

    • 'photo' => array
    • 'server' => string
    • 'hash' => string ] or [
    • 'file' => array ]

    Api

    Parameters

    • url: string

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

    • file: string

      Загружаемый файл(ссылка или содержимое файла).

    Returns Promise<null | IVkUploadFile>

  • Получение данные о пользователе.

    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>

Generated using TypeDoc