@hcl-software/domino-rest-sdk-node
    Preparing search index...

    Type Alias DocumentOptions

    Options to use for document operations.

    type DocumentOptions = {
        computeWithForm?: boolean;
        markRead?: boolean;
        markUnread?: boolean;
        meta?: boolean;
        mode?: string;
        parentUnid?: string;
        revision?: string;
        richTextAs?: string;
    }
    Index

    Properties

    computeWithForm? markRead? markUnread? meta? mode? parentUnid? revision? richTextAs?

    Properties

    computeWithForm?: boolean

    If true, compute with document's form formula before performing operation

    markRead?: boolean

    Mark the document as read by the current user when the operation completes.

    markUnread?: boolean

    Mark the document as unread by the current user when the operation completes.

    meta?: boolean

    If true, also return meta data of the document.

    mode?: string

    Mode to perform the document access in. Defaults to 'default' if missing.

    parentUnid?: string

    UNID of an existing document, to make this a response document.

    revision?: string

    This field records the current revision version of document. It's a 32-character hex-encoded string of date. If DB config 'requireRevisionToUpdate' is enabled, then revision is required when updating the document and only updates document when revision version is right.

    richTextAs?: string

    The string the RichText fields will be returned.

    Settings

    Member Visibility

    On This Page

    Properties