Class AppDataSchemaInstanceAccessor

Hierarchy (view full)

ElementInstanceAccessor<AppDataSchemaInstance, AppDataSchemaInstanceSelector, UpdateAppDataSchemaInstanceRequest, CreateAppDataSchemaInstanceRequest>
- AppDataSchemaInstanceAccessor

Index

Constructors

Properties

Methods

getUniqueIdentifier get getId create put patch archive delete getPath setup

Constructors

constructor

new AppDataSchemaInstanceAccessor(client, selector): AppDataSchemaInstanceAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | AppDataSchemaInstanceSelector
Returns AppDataSchemaInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in app-data-schemas/accessors.ts:61

Properties

`Protected`options

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

Methods

getUniqueIdentifier

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

get

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

getId

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

create

create(data?): Promise<AppDataSchemaInstance>
Parameters
- Optionaldata: UpdateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.create
- Defined in accessors.ts:181

put

put(data): Promise<AppDataSchemaInstance>
Parameters
- data: UpdateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.put
- Defined in accessors.ts:200

patch

patch(data): Promise<AppDataSchemaInstance>
Parameters
- data: CreateAppDataSchemaInstanceRequest
Returns Promise<AppDataSchemaInstance>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors.ts:210

archive

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

delete

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

`Protected`getPath

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

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in app-data-schemas/accessors.ts:72