Class ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>

Type Parameters

ElementInstance extends BaseElementInstance
Selector extends {
id?: string;
}
CreateRequest
UpdateRequest

Hierarchy (view full)

ElementInstanceAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get getId create put patch archive delete getPath

Constructors

constructor

new ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>(options): ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>
Type Parameters
- ElementInstance extends BaseElementInstance
- Selector extends {
  id?: string;
  }
- CreateRequest
- UpdateRequest
Parameters
- options: {
      client: IntegrationAppApiClient;
      instancePath: string;
      selector: string | Selector;
      type?: WorkspaceElementType;
  }
  - client: IntegrationAppApiClient
  - instancePath: string
  - selector: string | Selector
  - Optionaltype?: WorkspaceElementType
Returns ElementInstanceAccessor<ElementInstance, Selector, CreateRequest, UpdateRequest>
- Defined in accessors.ts:145

Properties

`Protected`options

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

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
- Defined in accessors.ts:154

get

get(): Promise<ElementInstance>
Returns Promise<ElementInstance>
- Defined in accessors.ts:158

getId

getId(): Promise<string>
Returns Promise<string>
- Defined in accessors.ts:162

create

create(data?): Promise<ElementInstance>
Parameters
- Optionaldata: CreateRequest
Returns Promise<ElementInstance>
- Defined in accessors.ts:181

put

put(data): Promise<ElementInstance>
Parameters
- data: CreateRequest
Returns Promise<ElementInstance>
- Defined in accessors.ts:200

patch

patch(data): Promise<ElementInstance>
Parameters
- data: UpdateRequest
Returns Promise<ElementInstance>
- Defined in accessors.ts:210

archive

archive(): Promise<void>
Returns Promise<void>
- Defined in accessors.ts:220

delete

delete(): Promise<void>
Returns Promise<void>
Deprecated
- use archive instead
- Defined in accessors.ts:227

`Protected`getPath

getPath(operation?): string
Parameters
- operation: string = ''
Returns string
- Defined in accessors.ts:231