Class ConnectionLevelActionAccessor

Hierarchy (View Summary)

ConnectionLevelElementAccessor<ActionInstance, UpdateActionInstanceRequest>
- ConnectionLevelActionAccessor

Index

Constructors

Properties

client connectionSelector actionSelector query endpoint selector elementKey

Methods

run uri getUniqueIdentifier get create patch put archive reset setup

Constructors

constructor

new ConnectionLevelActionAccessor(
    client: IntegrationAppApiClient,
    connectionSelector: string,
    actionSelector: string,
    query: InstanceKeyQuery,
): ConnectionLevelActionAccessor
Parameters
- client: IntegrationAppApiClient
- connectionSelector: string
- actionSelector: string
- query: InstanceKeyQuery
Returns ConnectionLevelActionAccessor
Overrides ConnectionLevelElementAccessor.constructor
- Defined in actions/accessors.ts:135

Properties

client

client: IntegrationAppApiClient

connectionSelector

connectionSelector: string

actionSelector

actionSelector: string

query

query: InstanceKeyQuery

`Protected`endpoint

endpoint: string

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

Methods

run

run(input?: any): Promise<ActionRunResponse>
Parameters
- Optionalinput: any
Returns Promise<ActionRunResponse>
- Defined in actions/accessors.ts:144

`Protected`uri

uri(path?: string, query?: {}): string
Parameters
- path: string = ''
- query: {} = {}
Returns string
Inherited from ConnectionLevelElementAccessor.uri
- Defined in integration-elements/connection-level-element.accessor.ts:19

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ConnectionLevelElementAccessor.getUniqueIdentifier
- Defined in integration-elements/connection-level-element.accessor.ts:23

get

get(query?: { autoCreate?: boolean }): Promise<ActionInstance>
Parameters
- query: { autoCreate?: boolean } = {}
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.get
- Defined in integration-elements/connection-level-element.accessor.ts:27

create

create(): Promise<ActionInstance>
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.create
- Defined in integration-elements/connection-level-element.accessor.ts:31

patch

patch(data: Partial<UpdateElement>): Promise<ActionInstance>
Parameters
- data: Partial<UpdateElement>
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.patch
- Defined in integration-elements/connection-level-element.accessor.ts:35

put

put(data: UpdateActionInstanceRequest): Promise<ActionInstance>
Parameters
- data: UpdateActionInstanceRequest
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.put
- Defined in integration-elements/connection-level-element.accessor.ts:39

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ConnectionLevelElementAccessor.archive
- Defined in integration-elements/connection-level-element.accessor.ts:43

reset

reset(): Promise<ActionInstance>
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.reset
- Defined in integration-elements/connection-level-element.accessor.ts:47

setup

setup(): Promise<ActionInstance>
Returns Promise<ActionInstance>
Inherited from ConnectionLevelElementAccessor.setup
- Defined in integration-elements/connection-level-element.accessor.ts:51