Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
spotted
Advanced tools
Readme
$ npm install spotted
Библиотека для быстрого и простого создания ботов для сообществ ВКонтакте.
Включает в себя сервер для обработки приходящих от ВКонтакте запросов и клиент для вызова методов API ВКонтакте.
Клиент позволяет вызывать открытые методы и методы, доступные с ключом доступа сообщества, а также загружать файлы в сообщество: обложку, документы и фотографии.
Application
Возвращает экземпляр класса Application
.
Application
options<Object>
Параметры запускаvoid
Запускает сервер для обработки входящих запросов.
Свойства объекта options
и их значения по умолчанию.
{
port: 8080 // <Number> Порт
}
community<Object>
Данные сообществаvoid
Устанавливает данные сообщества.
Свойства объекта community
.
{
accessToken, // <String> Ключ доступа сообщества
confirmationCode, // <String> Код подтверждения адреса сервера из настроек сообщества
secretKey // <String> Секретный ключ сообщества (если используется)
}
Client
При установке данных сообщества (app.setCommunity) экземпляр Client
создаётся автоматически, а после хранится в переменной app.client
.
method<String>
Название методаparams<Object>
Параметры методаPromise<Any>
Вызывает методы API ВКонтакте.
При этом, метод не вызывается сразу, а помещается в очередь. Методы, находящиеся в очереди, отправляются на сервер ВКонтакте «пачками» и вызываются через execute
.
method<String>
Название методаparams<Object>
Параметры методаPromise<Any>
В отличие от client.call
вызывает методы в обход очереди.
type<String>
Тип загрузкиfile<Any>
Файл к загрузкеparams<Object>
Параметры запроса на получение URL для загрузки. ПодробнееafterUploadParams<Object>
Параметры запроса на сохранение загруженного файла. ПодробнееPromise<Any>
Выполняет загрузку файлов во ВКонтакте.
cover
Обложка сообществаdocument
Документ в личное сообщениеdocument_wall
Документ на стенуphoto
Фотография в личное сообщениеФайл должен представлять собой FS Stream либо объект, который содержит следующие свойства:
Свойство | Тип | |
---|---|---|
content | Buffer | Содержимое файла |
name | String | Имя файла |
Для того, чтобы загрузить граффити или аудио-сообщение, нужно указать document
как тип загрузки, а в параметрах запроса params
указать тип загружаемого документа: для граффити — это graffiti
, для аудио-сообщения — audio_message
.
Message
Для событий message_new
и message_reply
возвращается экземпляр класса Message
, который имеет расширенный список методов.
params<Number/Object>
Параметры запроса. По умолчанию равен ID текущего сообщенияPromise<Any>
Позволяет быстро удалить сообщение.
params
может быть как ID сообщения, которое нужно удалить, так и объектом, содержащим параметры для метода messages.delete
.
Boolean
Вернёт true
, если первое прикрепление к сообщению является аудиозаписью.
Boolean
Вернёт true
, если было получено аудио-сообщение.
Boolean
Вернёт true
, если было получено сообщение с граффити.
Boolean
Вернёт true
, если первое прикрепление к сообщению является фотографией.
Boolean
Вернёт true
, если был получен стикер.
Boolean
Вернёт true
, если было получено сообщение без прикреплений.
answer<String/Object>
Сообщение-ответPromise<Any>
Позволяет быстро отправить ответ на сообщение в текущий диалог.
answer
может быть как строкой-ответом, так и объектом, содержащим параметры для метода messages.send
.
photo<String/Stream/Object>
ФотографияPromise<Any>
Позволяет быстро отправить фотографию в текущий диалог.
photo
принимается в таком же формате, как и второй аргумент (file
) для метода client.upload
.
Однако, можно просто передать URL фотографии, которую нужно загрузить, и всё будет работать.
messageId<Number>
ID сообщения. По умолчанию ID текущего сообщенияPromise<Any>
Восстанавливает сообщение по его ID.
params<Object>
Параметры для метода messages.send
Promise<Any>
Отправляет сообщение.
userId<Number>
ID пользователя (= ID диалога). По умолчанию ID автора текущего сообщенияPromise<Any>
Изменяет статус набора текста сообществом в диалоге.
FAQs
Library for creating Vkontakte bots with ease.
The npm package spotted receives a total of 1 weekly downloads. As such, spotted popularity was classified as not popular.
We found that spotted demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.