Notifications
 

The notifications commands allow you to communicate with any other QuickEAMS user in the system.

 

Start Receive

Syntax: notification.start "msg id"(LF)

Starts the receipt of notifications. Notifications are received whenever available and generate a special response message.

Results:

  • OK "msg id"(LF)
    Recipt thread started.
  • FAIL "msg id"(LF)
    Unable to open receipt thread. Can occur if the thread is already open.
  • notification - "notification id"(LF)
    This is the format of the special response message. The notification can then be retrieved using the notification.get command.

 

Stop receive

Syntax: notification.stop "msg id"(LF)

Stops the receipt of notifications.

Results:

  • OK "msg id"(LF)
    No other notifications will be received.
  • FAIL "msg id"(LF)
    Unable to stop.

 

Send notification

Syntax: notification.send "msg id" to message locator(LF)

Sends a notification to the to login. The notification will be geneated using a msg group which is the sender's account name. The locator is optional.

Results:

  • OK "msg id"(LF)
    Notification sent.
  • FAIL "msg id"(LF)
    Unable to deliver notification.

 

Get notification groups

Syntax: notification.groups "msg id"(LF)

Retrieves a list of notification groups.

Results:

  • OK "msg id" "sent on" "group #1" "group #2" ... "group #n"(LF)
    Notification group list retrieved.
  • FAIL "msg id"(LF)
    Unable to retrieve list.

 

Get notification list

Syntax: notification.groups "msg id" group(LF)

Retrieves a list of notifications in a group.

Results:

  • OK "msg id" "sent on" "notification #1" "notification #2" ... "notification #n"(LF)
    Notification list retrieved.
  • FAIL "msg id"(LF)
    Unable to retrieve list.

 

Get notification

Syntax: notification.get "msg id" "notification id"(LF)

Retrieves a notification.

Results:

  • OK "msg id" "sent on" "msg group" message from locator(LF)
    Notification retrieved. Note that the locator is optional and only included if a file was attached.
  • FAIL "msg id"(LF)
    Unable to retrieve notification.

 

Delete notification

Syntax: notification.delete "msg id" "notification id"(LF)

Deletes a notification.

Results:

  • OK "msg id"(LF)
    Notification deleted.
  • FAIL "msg id"(LF)
    Unable to retrieve notification.

 

Next: Queues