Class ActionInstanceAccessor

Deprecated

Hierarchy (View Summary)

ElementInstanceAccessor<
    ActionInstance,
    ActionInstanceSelector,
    CreateActionInstanceRequest,
    UpdateActionInstanceRequest,
>
- ActionInstanceAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get getId create put patch archive delete restore getPath setup reset run open

Constructors

constructor

new ActionInstanceAccessor(
client: IntegrationAppApiClient,
selector: string | ActionInstanceSelector,
): ActionInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | ActionInstanceSelector
Returns ActionInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in actions/accessors.ts:76

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    instancePath: string;
    selector: string | ActionInstanceSelector;
    type?: WorkspaceElementType;
}

client

client: IntegrationAppApiClient

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors.ts:151

get

get(): Promise<ActionInstance>
Returns Promise<ActionInstance>
Inherited from ElementInstanceAccessor.get
- Defined in accessors.ts:155

getId

getId(): Promise<string>
Returns Promise<string>
Inherited from ElementInstanceAccessor.getId
- Defined in accessors.ts:159

create

create(data?: CreateActionInstanceRequest): Promise<ActionInstance>
Parameters
- Optionaldata: CreateActionInstanceRequest
Returns Promise<ActionInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:174

put

put(data: CreateActionInstanceRequest): Promise<ActionInstance>
Parameters
- data: CreateActionInstanceRequest
Returns Promise<ActionInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:193

patch

patch(data: UpdateActionInstanceRequest): Promise<ActionInstance>
Parameters
- data: UpdateActionInstanceRequest
Returns Promise<ActionInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors.ts:203

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementInstanceAccessor.archive
- Defined in accessors.ts:213

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
Inherited from ElementInstanceAccessor.delete
- Defined in accessors.ts:220

restore

restore(): Promise<ActionInstance>
Returns Promise<ActionInstance>
Inherited from ElementInstanceAccessor.restore
- Defined in accessors.ts:224

`Protected`getPath

getPath(operation?: string): string
Parameters
- operation: string = ''
Returns string
Inherited from ElementInstanceAccessor.getPath
- Defined in accessors.ts:228

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in actions/accessors.ts:87

reset

reset(): Promise<void>
Returns Promise<void>
- Defined in actions/accessors.ts:91

run

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

open

open(__namedParameters?: OpenActionConfigurationOptions): Promise<void>
Parameters
- __namedParameters: OpenActionConfigurationOptions = {}
Returns Promise<void>
- Defined in actions/accessors.ts:99