Agent

Defines an Agent on Bkper.

An Agent represents an entity (such as an App or Bot) that interacts with Bkper, executing actions on behalf of users.

Constructors

Constructor

new Agent(payload?): Agent;

Parameters

Parameter	Type
payload?	Agent

Returns

Agent

Properties

payload

payload: Agent;

Methods

getId()

getId(): string | undefined;

Gets the Agent universal identifier.

Returns

string | undefined

The Agent universal identifier

---

getLogoUrl()

getLogoUrl(): string | undefined;

Gets the Agent logo URL.

Returns

string | undefined

The Agent logo url

---

getLogoUrlDark()

getLogoUrlDark(): string | undefined;

Gets the Agent logo URL in dark mode.

Returns

string | undefined

The Agent logo url in dark mode

---

getName()

getName(): string | undefined;

Gets the Agent name.

Returns

string | undefined

The Agent name

---

json()

json(): Agent;

Gets the wrapped plain JSON object.

Returns

Agent

The wrapped plain json object