BotResponse

This class defines a Bot Response associated to an [[Event]].

Constructors

Constructor

new BotResponse(event, payload?): BotResponse;

Parameters

Parameter	Type
event	Event
payload?	BotResponse

Returns

BotResponse

Properties

payload

payload: BotResponse;

Methods

getAgentId()

getAgentId(): string | undefined;

Gets the agent id of this Bot Response.

Returns

string | undefined

The agent id of this Bot Response

---

getCreatedAt()

getCreatedAt(): Date | undefined;

Gets the date this Bot Response was created.

Returns

Date | undefined

The date this Bot Response was created

---

getEvent()

getEvent(): Event;

Gets the Event this Bot Response is associated to.

Returns

Event

The Event this Bot Response is associated to

---

getMessage()

getMessage(): string | undefined;

Gets the message of this Bot Response.

Returns

string | undefined

The message of this Bot Response

---

getType()

getType():
  | BotResponseType
  | undefined;

Gets the type of this Bot Response.

Returns

| BotResponseType | undefined

The type of this Bot Response

---

remove()

remove(): Promise<BotResponse>;

Delete this Bot Response.

Returns

Promise<BotResponse>

The deleted Bot Response

---

replay()

replay(): Promise<BotResponse>;

Replay this Bot Response.

Returns

Promise<BotResponse>

The updated Bot Response