Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

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

Index

Constructors

constructor

new AppDataSchemaInstanceAccessor(
client: MembraneApiClient,
selector: string | AppDataSchemaInstanceSelector,
): AppDataSchemaInstanceAccessor
Parameters
- client: MembraneApiClient
- selector: string | AppDataSchemaInstanceSelector
Returns AppDataSchemaInstanceAccessor
Overrides ElementInstanceAccessor.constructor
- Defined in accessors/app-data-schema-instances-accessors.ts:26

Properties

`Protected`options

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

Methods

setup

setup(): Promise<void>
Returns Promise<void>
- Defined in accessors/app-data-schema-instances-accessors.ts:37

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementInstanceAccessor.getUniqueIdentifier
- Defined in accessors/base-accessors.ts:152

get

get(): Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Returns Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.get
- Defined in accessors/base-accessors.ts:156

getId

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

create

create(
    data?: UpdateAppDataSchemaInstanceRequest,
): Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- Optionaldata: UpdateAppDataSchemaInstanceRequest
Returns Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.create
- Defined in accessors/base-accessors.ts:175

put

put(
    data: UpdateAppDataSchemaInstanceRequest,
): Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- data: UpdateAppDataSchemaInstanceRequest
Returns Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.put
- Defined in accessors/base-accessors.ts:195

patch

patch(
    data: CreateAppDataSchemaInstanceRequest,
): Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Parameters
- data: CreateAppDataSchemaInstanceRequest
Returns Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.patch
- Defined in accessors/base-accessors.ts:206

delete

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

restore

restore(): Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Returns Promise<
    {
        user?: any;
        appDataSchema?: any;
        instanceKey?: string;
        appDataSchemaId?: string;
        schema?: any;
        code?: string;
        appDataSchemaRevision?: string;
        archivedAt?: string;
        isCustomized?: boolean;
        error?: ErrorDataSchema;
        id: string;
        uuid?: string;
        key?: string;
        description?: string;
        meta?: Record<string, any>;
        name: string;
        state?:
            | BUILDING
            | CLIENT_ACTION_REQUIRED
            | CONFIGURATION_ERROR
            | SETUP_FAILED
            | READY
            | DISCONNECTING;
        errors?: ErrorDataSchema[];
        revision?: string;
        createdAt?: string;
        updatedAt?: string;
        isDeactivated?: boolean;
        isReadOnly?: boolean;
        userId?: string;
        tenantId?: string;
    },
>
Inherited from ElementInstanceAccessor.restore
- Defined in accessors/base-accessors.ts:228

`Protected`getPath

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

Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AppDataSchemaInstanceAccessor

Properties

`Protected`options

Methods

setup

Returns Promise<void>

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

Deprecated

restore

`Protected`getPath

Parameters

Returns string

Settings

On This Page

Class AppDataSchemaInstanceAccessor

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AppDataSchemaInstanceAccessor

Properties

Protectedoptions

Methods

setup

Returns Promise<void>

getUniqueIdentifier

Returns string

get

getId

Returns Promise<string>

create

Parameters

put

Parameters

patch

Parameters

archive

Returns Promise<void>

delete

Returns Promise<void>

Deprecated

restore

ProtectedgetPath

Parameters

Returns string

Settings

On This Page

`Protected`options

`Protected`getPath