Interface: ServiceActionInfo

The description of a service action.

Extends

• BaseActionInfo

Properties

acl

readonly acl: boolean

Whether the action is checked by the access control rules (its acl option).

Inherited from

BaseActionInfo.acl

---

controller

readonly controller: string

The class name of the controller serving the action.

Inherited from

BaseActionInfo.controller

---

description

readonly description: string

The action's description: its description option, empty by default.

Inherited from

BaseActionInfo.description

---

groups

readonly groups: string[]

The ids of the action's groups (its groups option).

Inherited from

BaseActionInfo.groups

---

id

readonly id: string

The action's id: a UUID derived from the controller, the method and the address, stable across restarts.

Inherited from

BaseActionInfo.id

---

jsonSchema

readonly jsonSchema: JSONSchema

The JSON schema of the action's input (its DTO).

Inherited from

BaseActionInfo.jsonSchema

---

method

readonly method: string

The name of the controller method running the action.

Inherited from

BaseActionInfo.method

---

name

readonly name: string

The action's name: its name option, ControllerClass:method by default. It is unique within a channel among the controller methods (the addresses of one method share its name).

Inherited from

BaseActionInfo.name

---

pattern

readonly pattern: ActionPattern

The pattern the requests' input matches, with its controller prefix.