Class DominoDocumentOperations

API call helper functions for document operations.

Hierarchy

DominoRestOperations
- DominoDocumentOperations

Index

Constructors

constructor

Methods

_executeOperation bulkCreateDocuments bulkDeleteDocuments bulkDeleteDocumentsByUNID bulkGetDocuments bulkUpdateDocumentsByQuery createDocument deleteDocument deleteDocumentByUNID getDocument getDocumentsByQuery getRichtext patchDocument updateDocument

Constructors

constructor

new DominoDocumentOperations(): DominoDocumentOperations
Returns DominoDocumentOperations
Inherited from DominoRestOperations.constructor

Methods

`Protected` `Static`_executeOperation

_executeOperation<T = any>(
    dominoConnector: DominoRestConnector,
    dominoAccess: DominoRestAccess,
    operationId: string,
    options: DominoRequestOptions,
    streamDecoder: (dataStream: ReadableStream<any>) => Promise<T>,
): Promise<T>
Executes a Domino REST operation.
Type Parameters
- T = any
Parameters
- dominoConnector: DominoRestConnector
  {@code DominoConnector} class
- dominoAccess: DominoRestAccess
  {@code DominoAccess} class
- operationId: string
  ID of operation to execute
- options: DominoRequestOptions
  Parameters to execute operation with
- streamDecoder: (dataStream: ReadableStream<any>) => Promise<T>
  Function to decode the response stream
Returns Promise<T>
A generic response T base on the REST reply.
Inherited from DominoRestOperations._executeOperation
- Defined in src/DominoRestOperations.ts:23

`Static`bulkCreateDocuments

bulkCreateDocuments(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    docs: DocumentJSON[],
    richTextAs?: string,
): Promise<DominoDocument[]>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- docs: DocumentJSON[]
- OptionalrichTextAs: string
Returns Promise<DominoDocument[]>
- Defined in src/DominoDocumentOperations.ts:599

`Static`bulkDeleteDocuments

bulkDeleteDocuments(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    docs: DominoRestDocument[],
    mode?: string,
): Promise<DocumentStatusResponse[]>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- docs: DominoRestDocument[]
- Optionalmode: string
Returns Promise<DocumentStatusResponse[]>
- Defined in src/DominoDocumentOperations.ts:681

`Static`bulkDeleteDocumentsByUNID

bulkDeleteDocumentsByUNID(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unids: string[],
    mode?: string,
): Promise<DocumentStatusResponse[]>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unids: string[]
- Optionalmode: string
Returns Promise<DocumentStatusResponse[]>
- Defined in src/DominoDocumentOperations.ts:726

`Static`bulkGetDocuments

bulkGetDocuments(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unids: string[],
    options?: BulkGetDocumentsOptions,
): Promise<(DominoDocument | BulkGetErrorResponse)[]>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unids: string[]
- Optionaloptions: BulkGetDocumentsOptions
Returns Promise<(DominoDocument | BulkGetErrorResponse)[]>
- Defined in src/DominoDocumentOperations.ts:489

`Static`bulkUpdateDocumentsByQuery

bulkUpdateDocumentsByQuery(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    request: BulkUpdateDocumentsByQueryRequest,
    richTextAs?: string,
): Promise<DominoDocument[] | DocumentStatusResponse[]>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- request: BulkUpdateDocumentsByQueryRequest
- OptionalrichTextAs: string
Returns Promise<DominoDocument[] | DocumentStatusResponse[]>
- Defined in src/DominoDocumentOperations.ts:633

`Static`createDocument

createDocument(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    doc: DocumentJSON,
    options?: CreateDocumentOptions,
): Promise<DominoDocument>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- doc: DocumentJSON
- Optionaloptions: CreateDocumentOptions
Returns Promise<DominoDocument>
- Defined in src/DominoDocumentOperations.ts:313

`Static`deleteDocument

deleteDocument(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    doc: DominoRestDocument,
    mode?: string,
): Promise<DocumentStatusResponse>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- doc: DominoRestDocument
- Optionalmode: string
Returns Promise<DocumentStatusResponse>
- Defined in src/DominoDocumentOperations.ts:423

`Static`deleteDocumentByUNID

deleteDocumentByUNID(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unid: string,
    mode?: string,
): Promise<DocumentStatusResponse>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unid: string
- Optionalmode: string
Returns Promise<DocumentStatusResponse>
- Defined in src/DominoDocumentOperations.ts:458

`Static`getDocument

getDocument(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unid: string,
    options?: GetDocumentOptions,
): Promise<DominoDocument>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unid: string
- Optionaloptions: GetDocumentOptions
Returns Promise<DominoDocument>
- Defined in src/DominoDocumentOperations.ts:282

`Static`getDocumentsByQuery

getDocumentsByQuery(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    request: GetDocumentsByQueryRequest,
    qaction: QueryActions,
    options?: GetDocumentsByQueryOptions,
): Promise<
    | DominoDocument[]
    | QueryDocumentExplainResponse[]
    | QueryDocumentParseResponse[],
>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- request: GetDocumentsByQueryRequest
- qaction: QueryActions
- Optionaloptions: GetDocumentsByQueryOptions
Returns Promise<
    | DominoDocument[]
    | QueryDocumentExplainResponse[]
    | QueryDocumentParseResponse[],
>
- Defined in src/DominoDocumentOperations.ts:546

`Static`getRichtext

getRichtext(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unid: string,
    richTextAs: string,
    options?: GetRichtextOptions,
): Promise<string>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unid: string
- richTextAs: string
- Optionaloptions: GetRichtextOptions
Returns Promise<string>
- Defined in src/DominoDocumentOperations.ts:768

`Static`patchDocument

patchDocument(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    unid: string,
    docJsonPatch: DocumentJSON,
    options?: UpdateDocumentOptions,
): Promise<DominoDocument>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- unid: string
- docJsonPatch: DocumentJSON
- Optionaloptions: UpdateDocumentOptions
Returns Promise<DominoDocument>
- Defined in src/DominoDocumentOperations.ts:384

`Static`updateDocument

updateDocument(
    dataSource: string,
    dominoAccess: DominoRestAccess,
    dominoConnector: DominoRestConnector,
    doc: DominoRestDocument,
    options?: UpdateDocumentOptions,
): Promise<DominoDocument>
Parameters
- dataSource: string
- dominoAccess: DominoRestAccess
- dominoConnector: DominoRestConnector
- doc: DominoRestDocument
- Optionaloptions: UpdateDocumentOptions
Returns Promise<DominoDocument>
- Defined in src/DominoDocumentOperations.ts:346

Class DominoDocumentOperations

Author

Author

Author

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns DominoDocumentOperations

Methods

Protected Static_executeOperation

Type Parameters

Parameters

Returns Promise<T>

StaticbulkCreateDocuments

Parameters

Returns Promise<DominoDocument[]>

StaticbulkDeleteDocuments

Parameters

Returns Promise<DocumentStatusResponse[]>

StaticbulkDeleteDocumentsByUNID

Parameters

Returns Promise<DocumentStatusResponse[]>

StaticbulkGetDocuments

Parameters

Returns Promise<(DominoDocument | BulkGetErrorResponse)[]>

StaticbulkUpdateDocumentsByQuery

Parameters

Returns Promise<DominoDocument[] | DocumentStatusResponse[]>

StaticcreateDocument

Parameters

Returns Promise<DominoDocument>

StaticdeleteDocument

Parameters

Returns Promise<DocumentStatusResponse>

StaticdeleteDocumentByUNID

Parameters

Returns Promise<DocumentStatusResponse>

StaticgetDocument

Parameters

Returns Promise<DominoDocument>

StaticgetDocumentsByQuery

Parameters

Returns Promise< | DominoDocument[] | QueryDocumentExplainResponse[] | QueryDocumentParseResponse[],>

StaticgetRichtext

Parameters

Returns Promise<string>

StaticpatchDocument

Parameters

Returns Promise<DominoDocument>

StaticupdateDocument

Parameters

Returns Promise<DominoDocument>

Settings

On This Page

`Protected` `Static`_executeOperation

`Static`bulkCreateDocuments

`Static`bulkDeleteDocuments

`Static`bulkDeleteDocumentsByUNID

`Static`bulkGetDocuments

`Static`bulkUpdateDocumentsByQuery

`Static`createDocument

`Static`deleteDocument

`Static`deleteDocumentByUNID

`Static`getDocument

`Static`getDocumentsByQuery

Returns Promise<
| DominoDocument[]
| QueryDocumentExplainResponse[]
| QueryDocumentParseResponse[],
>

`Static`getRichtext

`Static`patchDocument

`Static`updateDocument