Item

Properties#

groups: Group#

Item group.

id: number#

Item unique identifier.

name: string#

Item name.

values: Object#

Columns values as json.

Methods#

archive#

archive(): Promise<void>

Archive this item.

Returns: Promise<void>

clearUpdates#

clearUpdates(): Promise<void>

Clear item updates.

Returns: Promise<void>

createNewUpdate#

createNewUpdate(message): Promise<Update>

Create new update.

Parameters:#

NameTypeDescription
messagestringThe update message

Returns: Promise<Update>

delete#

delete(): Promise<void>

Delete this item.

Returns: Promise<void>

duplicate#

duplicate(withUpdate): Promise<void>

Duplicate this item.

Parameters:#

NameTypeDescriptionOptional
withUpdatebooleanduplicate item with updates.Yes

Returns: Promise<void>

getUpdates#

getUpdates(): Promise<Array<Update>>

Get item updates.

Returns: Promise<Array<Update>>

moveToGroup#

moveToGroup(gropeOrGroupId): Promise<void>

Move item to group.

Parameters:#

NameTypeDescription
gropeOrGroupIdany | Groupthe group or group id to move the item to

Returns: Promise<void>

open#

open(): Promise<void>

Open this item.

Returns: Promise<void>

updateValues#

updateValues(values): Promise<void>

Update item values.

Parameters:#

NameTypeDescription
valuesanyColumns values object. Object key is column name or id. Value can be simple string or json.

Returns: Promise<void>