Skip to content

Latest commit

 

History

History
92 lines (74 loc) · 3.11 KB

Event.md

File metadata and controls

92 lines (74 loc) · 3.11 KB
Raw

Properties

thread_id

Unique ID of the thread that received this event.

sender_id

Unique ID of the sender who sent the message that this event represents.

sender_name

Name of the sender who sent the message that this event represents.

body

The full text of the message that has been received.

event_source

The name of the integration that sent this message.

arguments

Arguments split up as they would be if they were being passed from a command line interpreter.

arguments_body

Same as body, except excludes the first element of arguments.

thread_id ⇒ string

Kind: Object property

Unique ID of the thread that received this event.
The formatting of this string is not guaranteed, and will be specific to each integration. It is only guaranteed to be specific within an integration.

sender_id ⇒ string

Kind: Object property

Unique ID of the sender who sent the message that this event represents.
The formatting of this string is not guaranteed, and will be specific to each integration. It is only guaranteed to be specific within an integration.

sender_name ⇒ string

Kind: Object property
See: Api.md#getUsers, api.getUsers for further details on users.

Name of the sender who sent the message that this event represents. This is very unlikely to be unique, and in the case of some integrations will only be a nickname or username. If an integration provides additional detail about a user, this should be provided via the api.getUsers method.

body ⇒ string

Kind: Object property

The full text of the message that has been received.

event_source ⇒ string

Kind: Object property

The name of the integration that sent this message.

arguments ⇒ Array

Kind: Object property
See: body

The body split up into arguments as they would be if they were being passed from a command line interpreter. This means that the body is split on spaces, except where enclosed in double quotes that have not been escaped.

Example

'/foo bar hello world'     ⇒ ["/foo", "bar", "hello", "world"]
'/foo bar "hello world"'   ⇒ ["/foo", "bar", "hello world"]
'/foo bar \"hello world\"' ⇒ ["/foo", "bar", "hello", "world"]

arguments_body ⇒ string

Kind: Object property
See: body
See: arguments

Same as body, except excludes the first element of arguments.

Example
If the body text was:

/foo bar hello world

arguments_body would be:

bar hello world