@@ -270,8 +270,8 @@ http://[host-ip-of-server]:[port]/notifyuser
270
270
271
271
- ** URL-Parameter**
272
272
- ** userid** (required) - User-ID of connected user, * in APEX APP_USER is used*
273
- - ** room** (required) - Websocket room - * valid values: private,public*
274
- - ** type** (required) - Notification type - * valid values: info,success,warn,error*
273
+ - ** room** (required) - Websocket room - * valid values: private, public*
274
+ - ** type** (required) - Notification type - * valid values: info, success, warn, error*
275
275
- ** optparam** (optional) - Optional Parameter string to send any kind of information to the websocket client
276
276
277
277
- ** HTTP Header-Variables**
@@ -286,7 +286,149 @@ curl -H "notify-title: Test Title Text" -H "notify-message: Test Message Text" "
286
286
287
287
### PL/SQL API
288
288
289
+ The PL/SQL API includes many procedures to send any kind of possible notifications over the REST-Interface.
289
290
291
+ Here is a list of all procedures with all parameters.
292
+
293
+ ** Procedure:** do_rest_notify_user
294
+
295
+ ** Purpose:** Send Websocket Notifications over REST to connected users (General sending procedure with all parameters)
296
+
297
+ ** Parameter:**
298
+ - ** i_userid** (required)
299
+ - ** i_room** (required) - ("private" or "public")
300
+ - ** i_type** (required) - (info, success, warn, error)
301
+ - ** i_title** (required)
302
+ - ** i_message** (required)
303
+ - ** i_optparam** (optional) - (Optional Parameter String)
304
+ ----
305
+
306
+ ** Procedure:** do_notify_user_private_info
307
+
308
+ ** Purpose:** Send Websocket Notification to User / Room: Private / Type: Info
309
+
310
+ ** Parameter:**
311
+ - ** i_userid** (required)
312
+ - ** i_title** (required)
313
+ - ** i_message** (required)
314
+ - ** i_optparam** (optional) - (Optional Parameter String)
315
+ ----
316
+
317
+ ** Procedure:** do_notify_user_private_success
318
+
319
+ ** Purpose:** Send Websocket Notification to User / Room: Private / Type: Success
320
+
321
+ ** Parameter:**
322
+ - ** i_userid** (required)
323
+ - ** i_title** (required)
324
+ - ** i_message** (required)
325
+ - ** i_optparam** (optional) - (Optional Parameter String)
326
+ ----
327
+
328
+ ** Procedure:** do_notify_user_private_warn
329
+
330
+ ** Purpose:** Send Websocket Notification to User / Room: Private / Type: Warn
331
+
332
+ ** Parameter:**
333
+ - ** i_userid** (required)
334
+ - ** i_title** (required)
335
+ - ** i_message** (required)
336
+ - ** i_optparam** (optional) - (Optional Parameter String)
337
+ ----
338
+
339
+ ** Procedure:** do_notify_user_private_error
340
+
341
+ ** Purpose:** Send Websocket Notification to User / Room: Private / Type: Error
342
+
343
+ ** Parameter:**
344
+ - ** i_userid** (required)
345
+ - ** i_title** (required)
346
+ - ** i_message** (required)
347
+ - ** i_optparam** (optional) - (Optional Parameter String)
348
+ ----
349
+
350
+ ** Procedure:** do_notify_user_public_info
351
+
352
+ ** Purpose:** Send Websocket Notification to User / Room: Public / Type: Info
353
+
354
+ ** Parameter:**
355
+ - ** i_userid** (required)
356
+ - ** i_title** (required)
357
+ - ** i_message** (required)
358
+ - ** i_optparam** (optional) - (Optional Parameter String)
359
+ ----
360
+
361
+ ** Procedure:** do_notify_user_public_success
362
+
363
+ ** Purpose:** Send Websocket Notification to User / Room: Public / Type: Success
364
+
365
+ ** Parameter:**
366
+ - ** i_userid** (required)
367
+ - ** i_title** (required)
368
+ - ** i_message** (required)
369
+ - ** i_optparam** (optional) - (Optional Parameter String)
370
+ ----
371
+
372
+ ** Procedure:** do_notify_user_public_warn
373
+
374
+ ** Purpose:** Send Websocket Notification to User / Room: Public / Type: Warn
375
+
376
+ ** Parameter:**
377
+ - ** i_userid** (required)
378
+ - ** i_title** (required)
379
+ - ** i_message** (required)
380
+ - ** i_optparam** (optional) - (Optional Parameter String)
381
+ ----
382
+
383
+ ** Procedure:** do_notify_user_public_error
384
+
385
+ ** Purpose:** Send Websocket Notification to User / Room: Public / Type: Error
386
+
387
+ ** Parameter:**
388
+ - ** i_userid** (required)
389
+ - ** i_title** (required)
390
+ - ** i_message** (required)
391
+ - ** i_optparam** (optional) - (Optional Parameter String)
392
+ ----
393
+
394
+ ** Procedure:** do_notify_all_public_info
395
+
396
+ ** Purpose:** Send Websocket Notification to all Users / Room: Public / Type: Info
397
+
398
+ ** Parameter:**
399
+ - ** i_title** (required)
400
+ - ** i_message** (required)
401
+ - ** i_optparam** (optional) - (Optional Parameter String)
402
+ ----
403
+
404
+ ** Procedure:** do_notify_all_public_success
405
+
406
+ ** Purpose:** Send Websocket Notification to all Users / Room: Public / Type: Success
407
+
408
+ ** Parameter:**
409
+ - ** i_title** (required)
410
+ - ** i_message** (required)
411
+ - ** i_optparam** (optional) - (Optional Parameter String)
412
+ ----
413
+
414
+ ** Procedure:** do_notify_all_public_warn
415
+
416
+ ** Purpose:** Send Websocket Notification to all Users / Room: Public / Type: Warn
417
+
418
+ ** Parameter:**
419
+ - ** i_title** (required)
420
+ - ** i_message** (required)
421
+ - ** i_optparam** (optional) - (Optional Parameter String)
422
+ ----
423
+
424
+ ** Procedure:** do_notify_all_public_error
425
+
426
+ ** Purpose:** Send Websocket Notification to all Users / Room: Public / Type: Error
427
+
428
+ ** Parameter:**
429
+ - ** i_title** (required)
430
+ - ** i_message** (required)
431
+ - ** i_optparam** (optional) - (Optional Parameter String)
290
432
291
433
### APEX
292
434
0 commit comments