Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MessageSendResult

typedef

{Object} Session.messages.MessageSendResult

property

{String} path - topic path

property

{String} recipient - session filter or SessionID of the recipient

property

{Number} [sent] - the number of sessions the message has been sent to using a filter string

property

{Array} [errors] - errors from sending to sessions using a filter string

deprecated

since 6.2

One-way messaging is deprecated in favor of request-response messaging. See sendRequest and sendRequestToFilter. This interface will be removed in a future release.

Hierarchy

  • MessageSendResult

Index

Properties

Properties

Optional errors

errors: ErrorReport[]

Any errors from sending to sessions using a filter string

path

path: string

The topic path as specified in the call to Messages.send

Optional recipient

recipient: string | SessionId

The recipient as specified in the call to Messages.send

Optional sent

sent: undefined | number

If a filter was passed for the recipient, this contains the number of sessions the message has been sent to.