Class ConnectionLevelElementAccessor<Element, UpdateElement>

Type Parameters

Element
UpdateElement

Hierarchy (View Summary)

ConnectionLevelElementAccessor

Index

Constructors

Properties

endpoint client connectionSelector selector elementKey query

Methods

uri getUniqueIdentifier get create patch put archive reset setup

Constructors

constructor

new ConnectionLevelElementAccessor<Element, UpdateElement>(
    client: IntegrationAppApiClient,
    connectionSelector: string,
    selector: string,
    elementKey: string,
    query: Record<string, any>,
): ConnectionLevelElementAccessor<Element, UpdateElement>
Type Parameters
- Element
- UpdateElement
Parameters
- client: IntegrationAppApiClient
- connectionSelector: string
- selector: string
- elementKey: string
- query: Record<string, any>
Returns ConnectionLevelElementAccessor<Element, UpdateElement>
- Defined in integration-elements/connection-level-element.accessor.ts:9

Properties

`Protected`endpoint

endpoint: string

`Protected`client

client: IntegrationAppApiClient

`Protected`connectionSelector

connectionSelector: string

`Protected`selector

selector: string

`Protected`elementKey

elementKey: string

`Protected`query

query: Record<string, any>

Methods

`Protected`uri

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

getUniqueIdentifier

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

get

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

create

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

patch

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

put

put(data: UpdateElement): Promise<Element>
Parameters
- data: UpdateElement
Returns Promise<Element>
- Defined in integration-elements/connection-level-element.accessor.ts:39

archive

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

reset

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

setup

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