Class DominoDocument

Holds Domino document information and utility functions.

Author

stephan.wissel@hcl.software

Author

emmanuelryan.gamla@hcl.software

Author

alecvincent.bardiano@hcl.software

Implements

DominoRestDocument

Index

Constructors

Properties

@meta? @warnings? fields Form

Methods

getRevision getUNID setUNID toDocJson toJson

Constructors

constructor

new DominoDocument(_doc: DocumentBody): DominoDocument
Parameters
- _doc: DocumentBody
Returns DominoDocument
- Defined in src/DominoDocument.ts:120

Properties

`Optional`@meta

"@meta"?: DominoDocumentMeta

Document metadata.

`Optional`@warnings

"@warnings"?: string[]

List of warnings (if any) when document operation is done.

fields

fields: Map<string, any> = ...

Maps document fields and values where field names are stored as keys with value as the field value.

Form

Form: string

Form value of document.

Methods

getRevision

getRevision(): undefined | string
Returns undefined | string
the document's revision if present, else returns undefined.
Implementation of DominoRestDocument.getRevision
- Defined in src/DominoDocument.ts:154

getUNID

getUNID(): undefined | string
Returns undefined | string
the document's UNID if present, else returns undefined.
Implementation of DominoRestDocument.getUNID
- Defined in src/DominoDocument.ts:142

setUNID

setUNID(unid: string): void
Parameters
- unid: string
Returns void
Implementation of DominoRestDocument.setUNID
- Defined in src/DominoDocument.ts:146

toDocJson

toDocJson(): DocumentJSON
Returns DocumentJSON
the form value and fields in JSON format.
Implementation of DominoRestDocument.toDocJson
- Defined in src/DominoDocument.ts:158

toJson

toJson(): Partial<DocumentBody>
Returns Partial<DocumentBody>
all properties of document in JSON format.
Implementation of DominoRestDocument.toJson
- Defined in src/DominoDocument.ts:169