Skip to content
This repository was archived by the owner on Dec 5, 2019. It is now read-only.

Commit 967f52e

Browse files
lholmquistlfryc
authored andcommitted
Notifier - Add Deprecation Notice for notifier - AGJS-281
1 parent 63723bf commit 967f52e

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ See the [DataManager API docs](http://aerogear.org/docs/specs/aerogear-js/AeroGe
3838
## Notifier
3939
- - -
4040

41+
_This api has been deprecated as of 2.1.0 and will be removed in a future version_
42+
4143
Notifier is a collection of adapters which provide a unified or similar API for interacting with different messaging services and protocols.
4244

4345
See the [Notifier API docs](http://aerogear.org/docs/specs/aerogear-js/AeroGear.Notifier.html) for more info.

src/notifier/adapters/mqttws.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
*/
1616
/**
1717
The mqttws adapter uses MQTT over WebSockets for messaging.
18-
@status Experimental
18+
@deprecated since 2.1.0 and will be removed in a future release.
19+
@status Deprecated
1920
@constructs AeroGear.Notifier.adapters.mqttws
2021
@param {String} clientName - The name used to reference this particular notifier client
2122
@param {Object} [settings={}] - The settings to be passed to the adapter

src/notifier/adapters/stompws.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
*/
1616
/**
1717
The stomp adapter uses an underlying stomp.js implementation for messaging.
18-
@status Stable
18+
@deprecated since 2.1.0 and will be removed in a future release.
19+
@status Deprecated
1920
@constructs AeroGear.Notifier.adapters.stompws
2021
@param {String} clientName - the name used to reference this particular notifier client
2122
@param {Object} [settings={}] - the settings to be passed to the adapter

src/notifier/adapters/vertx.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
*/
1616
/**
1717
The vertx adapter is the default type used when creating a new notifier client. It uses the vert.x bus and underlying SockJS implementation for messaging.
18-
@status Stable
18+
@deprecated since 2.1.0 and will be removed in a future release.
19+
@status Deprecated
1920
@constructs AeroGear.Notifier.adapters.vertx
2021
@param {String} clientName - the name used to reference this particular notifier client
2122
@param {Object} [settings={}] - the settings to be passed to the adapter

src/notifier/aerogear.notifier.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
*/
1616
/**
1717
The AeroGear.Notifier namespace provides a messaging API. Through the use of adapters, this library provides common methods like connect, disconnect, subscribe, unsubscribe and publish.
18-
@status Stable
18+
@deprecated since 2.1.0 and will be removed in a future release.
19+
@status Deprecated
1920
@class
2021
@augments AeroGear.Core
2122
@param {String|Array|Object} [config] - A configuration for the client(s) being created along with the notifier. If an object or array containing objects is used, the objects can have the following properties:

0 commit comments

Comments
 (0)