Class Agent

A client side representation of an agent within an org. Also provides utilities such as creating agents, listing agents, and creating agent specs.

Examples

Create a new instance and get the ID (uses the Bot ID):

const id = new Agent({connection, name}).getId();

Create a new agent in the org:

const myAgent = await Agent.create(connection, project, options);

List all agents in the local project:

const agentList = await Agent.list(project);

Index

Constructors

constructor

Methods

activate deactivate getBotMetadata getId getLatestBotVersionMetadata compileAgent create createAgent createSpec list listRemote publishAgentJson

Constructors

constructor

new Agent(options: AgentOptions): Agent
Create an instance of an agent in an org. Must provide a connection to an org and the agent (Bot) API name or ID as part of AgentOptions.
Parameters
- options: AgentOptions
Returns Agent
- Defined in agent.ts:101

Methods

activate

activate(): Promise<void>
Activates the agent.

Returns Promise<void>
void
- Defined in agent.ts:508

deactivate

deactivate(): Promise<void>
Deactivates the agent.

Returns Promise<void>
void
- Defined in agent.ts:517

getBotMetadata

getBotMetadata(): Promise<BotMetadata>
Queries BotDefinition and BotVersions (limited to 10) for the bot metadata and assigns:
1. this.id
2. this.name
3. this.botMetadata
4. this.botVersionMetadata
Returns Promise<BotMetadata>
- Defined in agent.ts:479

getId

getId(): Promise<string>
Returns the ID for this agent.

Returns Promise<string>
The ID of the agent (The Bot ID).
- Defined in agent.ts:465

getLatestBotVersionMetadata

getLatestBotVersionMetadata(): Promise<BotVersionMetadata>
Returns the latest bot version metadata.

Returns Promise<BotVersionMetadata>
the latest bot version metadata
- Defined in agent.ts:495

`Static`compileAgent

compileAgent(connection: Connection, agentString: string): Promise<AgentJson>
Beta
Creates agent JSON from compiling the Agent as a string on the server.
Parameters
- connection: Connection
  The connection to the org
- agentString: string
Returns Promise<AgentJson>
Promise The generated Agent JSON as a string
- Defined in agent.ts:326

`Static`create

create(
    connection: Connection,
    project: SfProject,
    config: AgentCreateConfig,
): Promise<AgentCreateResponse>
Creates an agent from a configuration, optionally saving the agent in an org.
Parameters
- connection: Connection
  a Connection to an org.
- project: SfProject
  a SfProject for a local DX project.
- config: AgentCreateConfig
  a configuration for creating or previewing an agent.
Returns Promise<AgentCreateResponse>
the agent definition
- Defined in agent.ts:166

`Static`createAgent

createAgent(connection: Connection, agentJobSpec: AgentJobSpec): Promise<string>
Beta
Creates Agent as string using agent job spec data.
Parameters
- connection: Connection
  The connection to the org
- agentJobSpec: AgentJobSpec
  The agent specification data
Returns Promise<string>
Promise The generated Agent as a string
- Defined in agent.ts:300

`Static`createSpec

createSpec(
connection: Connection,
config: AgentJobSpecCreateConfig,
): Promise<AgentJobSpec>
Create an agent spec from provided data.
Parameters
- connection: Connection
  a Connection to an org.
- config: AgentJobSpecCreateConfig
  The configuration used to generate an agent spec.
Returns Promise<AgentJobSpec>
the agent job spec
- Defined in agent.ts:249

`Static`list

list(project: SfProject): Promise<string[]>
List all agents in the current project.
Parameters
- project: SfProject
  a SfProject for a local DX project.
Returns Promise<string[]>
- Defined in agent.ts:118

`Static`listRemote

listRemote(connection: Connection): Promise<BotMetadata[]>
Lists all agents in the org.
Parameters
- connection: Connection
  a Connection to an org.
Returns Promise<BotMetadata[]>
the list of agents
- Defined in agent.ts:151

`Static`publishAgentJson

publishAgentJson(
    connection: Connection,
    project: SfProject,
    agentJson: AgentJson,
): Promise<PublishAgent>
Beta
Publish an AgentJson representation to the org
Parameters
- connection: Connection
  The connection to the org
- project: SfProject
  The Salesforce project
- agentJson: AgentJson
  The agent JSON with name
Returns Promise<PublishAgent>
The publish response
- Defined in agent.ts:356

Class Agent

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Agent

Methods

activate

Returns Promise<void>

deactivate

Returns Promise<void>

getBotMetadata

Returns Promise<BotMetadata>

getId

Returns Promise<string>

getLatestBotVersionMetadata

Returns Promise<BotVersionMetadata>

StaticcompileAgent

Parameters

Returns Promise<AgentJson>

Staticcreate

Parameters

Returns Promise<AgentCreateResponse>

StaticcreateAgent

Parameters

Returns Promise<string>

StaticcreateSpec

Parameters

Returns Promise<AgentJobSpec>

Staticlist

Parameters

Returns Promise<string[]>

StaticlistRemote

Parameters

Returns Promise<BotMetadata[]>

StaticpublishAgentJson

Parameters

Returns Promise<PublishAgent>

Settings

On This Page

`Static`compileAgent

`Static`create

`Static`createAgent

`Static`createSpec

`Static`list

`Static`listRemote

`Static`publishAgentJson