Skip to main content

Item

Datalayer Core

Datalayer Core / Item

Abstract Class: Item<TData>

Defined in: tech/datalayer/core/src/client/models/Item.ts:22

Abstract base class for all Datalayer content items. Provides common functionality for content management including lifecycle tracking.

Template​

Update request type for API

Extended by​

Type Parameters​

TData​

TData

Raw data type from API

Constructors​

Constructor​

new Item<TData>(data, sdk): Item<TData>

Defined in: tech/datalayer/core/src/client/models/Item.ts:32

Create an Item instance.

Parameters​

data​

TData

Item data from API

sdk​

DatalayerClient

SDK instance

Returns​

Item<TData>

Properties​

_data​

protected _data: TData

Defined in: tech/datalayer/core/src/client/models/Item.ts:23

Accessors​

content​

Get Signature​

get abstract content(): any

Defined in: tech/datalayer/core/src/client/models/Item.ts:147

The cached content.

Returns​

any

createdAt​

Get Signature​

get createdAt(): Date

Defined in: tech/datalayer/core/src/client/models/Item.ts:105

When the item was created.

Returns​

Date

id​

Get Signature​

get id(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:63

Item ID.

Returns​

string

isDeleted​

Get Signature​

get isDeleted(): boolean

Defined in: tech/datalayer/core/src/client/models/Item.ts:42

Check if this item has been deleted.

Returns​

boolean

name​

Get Signature​

get abstract name(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:141

The cached name.

Returns​

string

ownerId​

Get Signature​

get ownerId(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:97

Owner user ID.

Returns​

string

spaceId​

Get Signature​

get spaceId(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:75

Parent space ID.

Returns​

string

type​

Get Signature​

get abstract type(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:138

Get the item type identifier.

Returns​

string

uid​

Get Signature​

get uid(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:69

Unique identifier for the item.

Returns​

string

updatedAt​

Get Signature​

get updatedAt(): Date

Defined in: tech/datalayer/core/src/client/models/Item.ts:118

The cached update time.

Returns​

Date

Methods​

_checkDeleted()​

protected _checkDeleted(): void

Defined in: tech/datalayer/core/src/client/models/Item.ts:50

Check if this item has been deleted and throw error if so.

Returns​

void

Throws​

Error if deleted

_getSpacerRunUrl()​

protected _getSpacerRunUrl(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:251

Get spacer API URL for API calls.

Returns​

string

_getToken()​

protected _getToken(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:246

Get SDK token for API calls.

Returns​

string

_updateData()​

protected _updateData(newData): void

Defined in: tech/datalayer/core/src/client/models/Item.ts:256

Update internal data after API call.

Parameters​

newData​

TData

Returns​

void

delete()​

delete(): Promise<void>

Defined in: tech/datalayer/core/src/client/models/Item.ts:163

Delete this item permanently. After deletion, all subsequent method calls will throw errors.

Returns​

Promise<void>

getContent()​

getContent(): Promise<any>

Defined in: tech/datalayer/core/src/client/models/Item.ts:172

Get the document content from API.

Returns​

Promise<any>

getName()​

abstract getName(): Promise<string>

Defined in: tech/datalayer/core/src/client/models/Item.ts:144

Get the current name from API.

Returns​

Promise<string>

getUpdatedAt()​

abstract getUpdatedAt(): Promise<Date>

Defined in: tech/datalayer/core/src/client/models/Item.ts:150

Get when the item was last updated from API.

Returns​

Promise<Date>

rawData()​

rawData(): TData

Defined in: tech/datalayer/core/src/client/models/Item.ts:226

Get raw item data object.

Returns​

TData

toJSON()​

abstract toJSON(): any

Defined in: tech/datalayer/core/src/client/models/Item.ts:232

Convert to JSON representation - must be implemented by subclasses.

Returns​

any

toString()​

toString(): string

Defined in: tech/datalayer/core/src/client/models/Item.ts:235

String representation of the item.

Returns​

string

update()​

abstract update(...args): Promise<Item<TData>>

Defined in: tech/datalayer/core/src/client/models/Item.ts:153

Update the item.

Parameters​

args​

...any[]

Returns​

Promise<Item<TData>>