Introduction

aio-sf-streaming is a simple client library allowing to connect to the Force.com Streaming API and receive push event from Salesforce.

Salesforce can push two kind of events:

  • PushTopics allow you to monitor object and receive notification when the provided SOQL query match after an object creation, update or deletion.
  • Generic streaming allow to create custom events not linked to Saleforce object. Apex or API call allow you to trigger the event and receive notification in your streaming client.

aio-sf-streaming allow you to connect to Salesforce, subscribe for some events and receive event when a change in a PushTopics is detected or when a generic streaming event is trigged.

License

aio-sf-streaming was created at papernest and is distribued under the MIT license.


The MIT License

Copyright (c) 2018 papernest. http://www.papernest.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.