tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > LockType

LockType enum

Defines the state (lock) of an item.

Members: * None - The item is not locked. * CheckedOut - The item is checked-out. This can mean either a temporary (edit) lock, a permanent lock (explicit check-out performed by user) or a workflow lock. * Permanent - The item is permanently locked, that is using an explicit lock (check-out) action. Can be applied to versioned items (permanent check-out) and to organizational items. * NewItem - The item is a new item, that is it has been created, but not checked-in for the first time yet. * InWorkflow - The item is in a workflow. * Reserved - The item is reserved by the system. This means it is checked-out/locked, but nobody owns the lock.

* UnknownByClient - Special reserved value used to notify an older API version client about the presence of an enumeration member added in a later API version. Explicitly setting this value by a client is not allowed, but client code should check it and be able to handle such cases.

Signature:

export declare enum LockType

Enumeration Members

Member Value Description
CHECKED_OUT "CheckedOut"  
IN_WORKFLOW "InWorkflow"  
NEW_ITEM "NewItem"  
NONE "None"  
PERMANENT "Permanent"  
RESERVED "Reserved"  
UNKNOWN_BY_CLIENT "UnknownByClient"