Class Actions

Hierarchy

TagoIOModule<GenericModuleParams>
- Actions

Index

Constructors

constructor

Methods

Constructors

constructor

new Actions(params: GenericModuleParams): Actions

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Actions

Methods

create

create(actionObj: ActionCreateInfo): Promise<{ action: string }>

- Defined in src/modules/Account/Actions.ts:43
Generates and retrieves a new action from the account

Parameters
- actionObj: ActionCreateInfo
  
  Object data to create new TagoIO Action
Returns Promise<{ action: string }>

delete

delete(actionID: string): Promise<string>

- Defined in src/modules/Account/Actions.ts:72
Deletes an action from the account

Parameters
- actionID: string
  
  Action ID
Returns Promise<string>

edit

edit(actionID: string, actionObj: Partial<ActionCreateInfo>): Promise<string>

- Defined in src/modules/Account/Actions.ts:58
Modify any property of the action.

Parameters
- actionID: string
  
  Action ID
- actionObj: Partial<ActionCreateInfo>
  
  Action Object with data to be replaced
Returns Promise<string>

info

info(actionID: string): Promise<ActionInfo>

- Defined in src/modules/Account/Actions.ts:85
Gets information about the action

Parameters
- actionID: string
  
  Action ID
Returns Promise<ActionInfo>

list

list(queryObj?: ActionQuery): Promise<ActionInfo[]>

- Defined in src/modules/Account/Actions.ts:21
Retrieves a list with all actions from the account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: ActionQuery
  
  Search query params
Returns Promise<ActionInfo[]>