Class LockDocumentRequest

Request body for creating a persistent lock on a document.

Implements

LfRepositoryClientV2.ILockDocumentRequest

Index

Constructors

Properties

comment? extent?

Methods

init toJSON fromJS

Constructors

constructor

new LockDocumentRequest(
data?: LfRepositoryClientV2.ILockDocumentRequest,
): LfRepositoryClientV2.LockDocumentRequest
Parameters
- Optionaldata: LfRepositoryClientV2.ILockDocumentRequest
Returns LfRepositoryClientV2.LockDocumentRequest
- Defined in packages/lf-repository-api-client-v2/dist/index.d.ts:8658

Properties

`Optional`comment

comment?: string

An optional comment for the persistent lock.

`Optional`extent

extent?: string

The lock extent. One of: Page, Edoc, Metadata, All. Defaults to All when omitted.

Methods

init

init(_data?: any): void
Parameters
- Optional_data: any
Returns void
- Defined in packages/lf-repository-api-client-v2/dist/index.d.ts:8659

toJSON

toJSON(data?: any): any
Parameters
- Optionaldata: any
Returns any
- Defined in packages/lf-repository-api-client-v2/dist/index.d.ts:8661

`Static`fromJS

fromJS(data: any): LfRepositoryClientV2.LockDocumentRequest
Parameters
- data: any
Returns LfRepositoryClientV2.LockDocumentRequest
- Defined in packages/lf-repository-api-client-v2/dist/index.d.ts:8660