Interface DominoRestDocument

Domino REST API document interface.

interface DominoRestDocument {
    "@meta"?: DominoDocumentMeta;
    "@warnings"?: string[];
    fields: Map<string, any>;
    Form: string;
    getRevision: () => undefined | string;
    getUNID: () => undefined | string;
    setUNID: (unid: string) => void;
    toDocJson: () => DocumentJSON;
    toJson: () => Partial<DocumentBody>;
}

Hierarchy (View Summary)

Implemented by

Properties

@meta? @warnings? fields Form getRevision getUNID setUNID toDocJson toJson

Properties

Optional@meta

"@meta"?: DominoDocumentMeta

Document metadata.

Optional Readonly@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.

getRevision

getRevision: () => undefined | string

Get document revision if present.

Type declaration

    • (): undefined | string

    • Returns undefined | string

      the document's revision if present, else returns undefined.

getUNID

getUNID: () => undefined | string

Get document UNID if present.

Type declaration

    • (): undefined | string

    • Returns undefined | string

      the document's UNID if present, else returns undefined.

setUNID

setUNID: (unid: string) => void

Set the UNID of document.

Type declaration

    • (unid: string): void

    • Parameters

      • unid: string

        the UNID to set

      Returns void

toDocJson

toDocJson: () => DocumentJSON

Get the form value and the document's fields and its values in JSON format.

Type declaration

toJson

toJson: () => Partial<DocumentBody>

Get all of documents properties in JSON format.

Type declaration

Settings

Member Visibility

On This Page

Properties