Interface Index

See: relevant section in reference guide

interface Index {
    $CreationOptions?: unknown;
    $ID: string;
    $Type: "DomainModels$Index";
    attributes: IndexedAttribute[];
    dataStorageGuid: string;
    includeInOffline: boolean;
    addIndexedAttribute(): Promise<IndexedAttribute>;
    delete(): void;
    getContainer(): Entity;
}

Hierarchy (View Summary)

ElementBase
- Index

Index

Properties

$CreationOptions? $ID $Type attributes dataStorageGuid includeInOffline

Methods

addIndexedAttribute delete getContainer

Properties

`Optional`$CreationOptions

$CreationOptions?: unknown

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type: "DomainModels$Index"

The type of the element.

attributes

attributes: IndexedAttribute[]

dataStorageGuid

dataStorageGuid: string

includeInOffline

includeInOffline: boolean

Methods

addIndexedAttribute

addIndexedAttribute(): Promise<IndexedAttribute>
Returns Promise<IndexedAttribute>

delete

delete(): void
Returns void

getContainer

getContainer(): Entity
Returns Entity