Interface: IItem

An interface representing an Item object, extending the IEntity interface.

Interface

IItem

Hierarchy

• IEntity

  ↳ IItem

Implemented by

• SDKItem

Table of contents

Properties

• id
• clientId
• creator
• updatedAt
• updatedBy
• filename
• name
• url
• type
• datasetId
• dir
• hidden
• createdAt
• thumbnail
• stream
• annotations
• metadata
• annotated

Properties

id

• id: string

A globally unique identifier for the Entity.

Inherited from

IEntity.id

clientId

• Optional clientId: string

A local identifier for the Entity, unique within the client.

Inherited from

IEntity.clientId

creator

• Optional creator: string

The creator of the Entity.

Inherited from

IEntity.creator

updatedAt

• Optional updatedAt: IDate

The date and time when the Entity was last updated.

Inherited from

IEntity.updatedAt

updatedBy

• Optional updatedBy: string

The user who last updated the Entity.

Inherited from

IEntity.updatedBy

filename

• filename: string

The filename of the Item.

name

• name: string

The display name of the Item.

url

• url: string

The URL of the Item.

type

• type: "file" | "dir"

The type of the Item, either 'file' or 'dir'.

datasetId

• datasetId: string

The identifier of the dataset to which the Item belongs.

dir

• dir: string

The directory path of the Item.

hidden

• Optional hidden: boolean

A flag indicating whether the Item should be hidden.

createdAt

• createdAt: IDate

The date and time when the Item was created.

Overrides

IEntity.createdAt

thumbnail

• thumbnail: string

The URL of the Item's thumbnail image.

stream

• stream: string

The URL of the Item's stream.

annotations

• annotations: string

The URL of the Item's annotations.

metadata

• Optional metadata: Dictionary

Additional metadata for the Item, represented as a dictionary.

annotated

• annotated: boolean | "discarded"

A flag indicating whether the Item has been annotated, or 'discarded' if the annotations were discarded.