Class CommandsAPI

Commands module

Hierarchy

AutomateBaseAPI
- CommandsAPI

Index

Methods

getCommand getCommandList request

Methods

getCommand

getCommand(
    entityId: string,
    params?: Automate.CommonParameters,
): Promise<
    { Description?: string; Id?: string; Level?: number; Name?: string },
>
Parameters
- entityId: string
- params: Automate.CommonParameters = {}
Returns Promise<{ Description?: string; Id?: string; Level?: number; Name?: string }>
- Defined in src/Automate/CommandsAPI.ts:22

getCommandList

getCommandList(
params?: Automate.CommonParameters,
): Promise<
{ Description?: string; Id?: string; Level?: number; Name?: string }[],
>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<{ Description?: string; Id?: string; Level?: number; Name?: string }[]>
- Defined in src/Automate/CommandsAPI.ts:14

`Protected`request

request<T = unknown>(args: RequestOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- args: RequestOptions
Returns Promise<T>
Inherited from AutomateBaseAPI.request
- Defined in src/BaseAPI.ts:52