Streaming API Редактировано: 28.08.2020 в 04:16

streamingAPI.connect()

Данный метод подключается к серверу по протоколу WebSocket'ов. И возвращает в resolve функцию следующий объект:

{
  vk: EasyVK,
  connection: StreamingApiConnection
}

Переменная connection - это переменная подключения, будем называть ее просто переменной stream

Так как Streaming API нуждается в данных вашего приложения, вам необходимо создать Standalone-приложение и получить от туда appId, и secret для подключения. Дальнейшие примеры рассматривают этот вопрос.

easyvk(/*данные авторизации*/).then(vk => {
  return vk.streamingAPI.connect({
    clientId: 'id_вашего_приложения',
    clientSecret: 'секретный_ключ_вашего_приложения'
  })
}).then(({connection: stream, vk}) => {

  // Дальнейшие действия ... stream.on()

}).catch(console.error)

Также вы можете не инициализировать объект EasyVK, а просто создать подлючение по статическому свойству.

easyvk.streamingAPI.connect({
  clientId: 'id_вашего_приложения',
  clientSecret: 'секретный_ключ_вашего_приложения'
}).then(({connection: stream}) => {

  // Дальнейшие действия ... stream.on()

}).catch(console.error)

stream.addRule(tag, rule)

Данный метод добавляет правило, одно правило, в стрим.

const streamingAPI = vk.streamingAPI

streamingAPI.connect(/*данные*/).then(({connection: stream}) => {

  //При условии, что в стриме не было правил вообще
  return stream.addRule('rule_1', 'кошка -собака')
  .then(() => {
    return stream.getRules() 
  }).then(({vkr: rules}) => {
    console.log(rules)
  })

}).catch(console.error)

stream.deleteRule(tag)

Данный методы удаляет одно правило по заданному ключю.

const streamingAPI = vk.streamingAPI

streamingAPI.connect(/*данные*/).then(({connection: stream}) => {

  //При условии, что в стриме не было правил вообще
  return stream.addRule('rule_1', 'кошка -собака')
  .then(() => {
    return stream.deleteRule('rule_1') 
  }).then(() => {
    return stream.getRules()
  }).then(rules => {
    console.log(rules) //Ничего
  })

}).catch(console.error)

stream.deleteAllRules()

Удаление всех правила из стрима.

stream.addRule('rule_1', 'кошка -собака')
.then(() => {
  return stream.deleteAllRules()
})

stream.close()

Прервать подключение и закрыть соединение с сервером.

stream.close().then(() => {/*...*/})

stream.initRules()

Данный метод - это что-то вроде менеджера ваших правил, он всегда знает, что вы удалили, а что добавили. Вместо кучи тех методов выше вы можете использовать только один - initRules, потому как, вызывая его, вы передаете в него один объект - список ваших правил. И если он как-то отличается от тех, что уже есть в вашем стриме, эти изменения вступят в силу, и из стрима, на пример, будут удалены те правила, которых нету в этом объекте. Ну или, если вы что-то изменили, этот менеджер сам автоматически применит изменения.

stream.initRules({
  rule_1: 'кошка -собака',
  rule_2: 'попугай'
}).then(({log}) => {
  console.log(log.changedRules, log.addedRules, log.deletedRules)
})

stream.getRules()

Данный метод добавляет возвращает список правил, которые сейчас есть на стриме.

stream.getRules().then(({rules, vk}) => {
  console.log(rules)
})

События стрима

В Streaming API имеются события, со списком которых вы можете познакомиться тут. Эти события имеются и в EasyVK, то есть вы можете прослушивать событие и получать данные от события, соответственно. Таким образом и будет происходить сбор информации.

Список событий на момент написания это документации

stream.on('error', console.error)
.on('failure', console.error)
.on('serviceMessage', console.log)
.on('post', console.log)