Type Alias DocumentOptions

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

Options to use for document operations.

Type declaration

  • OptionalcomputeWithForm?: boolean

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

  • OptionalmarkRead?: boolean

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

  • OptionalmarkUnread?: boolean

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

  • Optionalmeta?: boolean

    If true, also return meta data of the document.

  • Optionalmode?: string

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

  • OptionalparentUnid?: string

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

  • Optionalrevision?: 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.

  • OptionalrichTextAs?: string

    The string the RichText fields will be returned.

Settings

Member Visibility