Class CheckOutDocumentRequest

Request body for checking out a document.

Implements

ICheckOutDocumentRequest

Index

Constructors

Properties

Methods

init toJSON fromJS

Constructors

constructor

new CheckOutDocumentRequest(
data?: ICheckOutDocumentRequest,
): CheckOutDocumentRequest
Parameters
- Optionaldata: ICheckOutDocumentRequest
Returns CheckOutDocumentRequest
- Defined in packages/lf-repository-api-client-v2/index.ts:13281

Properties

`Optional`comment

comment?: string

An optional comment for the check-out.

`Optional`lock

lock?: boolean

Whether to automatically acquire a persistent lock as part of the check-out. Defaults to true.

Methods

init

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

toJSON

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

`Static`fromJS

fromJS(data: any): CheckOutDocumentRequest
Parameters
- data: any
Returns CheckOutDocumentRequest
- Defined in packages/lf-repository-api-client-v2/index.ts:13300