Skip to content

Commit 16ed620

Browse files
Daniel HochleitnerDaniel Hochleitner
authored andcommitted
readme changes
1 parent 5b2e432 commit 16ed620

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ Just import these 3 files to your application and you are ready to go.
218218
- **Send Websocket Notify** - dynamic_action_plugin_de_danielh_sendwsnotify.sql
219219
- **Show Websocket Notify** - dynamic_action_plugin_de_danielh_showwsnotify.sql
220220

221-
For a detailed description of the plugins, read further under "Usage Section" or import the demo app sql file to you workspace.
221+
For a detailed description of the plugins, read further under "Usage Section" or import the demo app sql file to your workspace.
222222

223223

224224
## Usage
@@ -229,15 +229,15 @@ As mentioned in the installation steps, the node notification server component c
229229

230230
- **REST-Interface**
231231

232-
Sending messages and notifications to users which are connected over the websocket interface.
232+
Sending messages and notifications to users which are connected to the websocket interface.
233233

234234
- **Websocket-Interface**
235235

236236
Connecting and authenticating users against the node server and still more to receive live messages on client browser from server part.
237237
There exists 2 rooms/namespaces which users can subscribe to:
238238

239-
- **private** - For single user messages to all instances of one user (e.g. one user is logged in with 3 browsers)
240-
- **public** - For single user messages to all instances of one user *AND* broadcasting messages to all connected clients
239+
- **private** - For single user messages to all instances of one user (e.g. one user is logged in with 3 browsers)
240+
- **public** - For single user messages to all instances of one user *AND* broadcasting messages to all connected clients
241241

242242
- **Helper pages**
243243

@@ -251,22 +251,22 @@ General settings of the node server like IP, port, authentication, SSL support a
251251

252252
### REST-Service
253253

254-
The REST-Service is designed to send messages to connected websocket users. Base-URL scheme with looks like this:
254+
The REST-Service is designed to send messages to connected websocket users. Base-URL scheme looks like this:
255255

256256
```
257257
Type: GET
258258
http://[host-ip-of-server]:[port]/notifyuser
259259
```
260260

261261
- **URL-Parameter**
262-
- userid (required) - User-ID of connected user, **in APEX APP_USER is used**
263-
- room (required) - Websocket room - valid values: private,public
264-
- type (required) - Notification type - valid values: info,success,warn,error
265-
- optparam (optional) - Optional Parameter string to send any kind of information tp the websocket client
262+
- **userid** (required) - User-ID of connected user, *in APEX APP_USER is used*
263+
- **room** (required) - Websocket room - *valid values: private,public*
264+
- **type** (required) - Notification type - *valid values: info,success,warn,error*
265+
- **optparam** (optional) - Optional Parameter string to send any kind of information to the websocket client
266266

267267
- **HTTP Header-Variables**
268-
- notify-title (required) - Title of notification
269-
- notify-message (required) - Message content of notification
268+
- **notify-title** (required) - Title of notification
269+
- **notify-message** (required) - Message content of notification
270270

271271
A demo call using curl could look like this:
272272

0 commit comments

Comments
 (0)