Class DominoBasisSession

constructor

• new DominoBasisSession(
      dominoAccess: DominoRestAccess,
      dominoConnector: DominoRestConnector,
  ): DominoBasisSession

  Parameters

  • dominoAccess: DominoRestAccess
  • dominoConnector: DominoRestConnector

  Returns DominoBasisSession

dominoAccess

dominoConnector

bulkCreateDocuments

• bulkCreateDocuments(
      dataSource: string,
      docs: DocumentJSON[],
      richTextAs?: string,
  ): Promise<DominoDocument[]>

  Parameters

  • dataSource: string

    the scope name
  • docs: DocumentJSON[]

    an array of JSON containing document data to be saved
  • OptionalrichTextAs: string

    the format which richtext fields will be returned as (defaults to mime if not given)

  Returns Promise<DominoDocument[]>

  a promise that resolves to an array of created documents.

bulkDeleteDocuments

• bulkDeleteDocuments(
      dataSource: string,
      docs: DominoDocument[],
      mode?: string,
  ): Promise<DocumentStatusResponse[]>

  Parameters

  • dataSource: string

    the scope name
  • docs: DominoDocument[]

    n array of DominoDocument to be deleted
  • Optionalmode: string

    the mode to perform the document access in. Defaults to default if missing

  Returns Promise<DocumentStatusResponse[]>

  a promise that resolves to an array of document status response.

bulkDeleteDocumentsByUNID

• bulkDeleteDocumentsByUNID(
      dataSource: string,
      unids: string[],
      mode?: string,
  ): Promise<DocumentStatusResponse[]>

  Parameters

  • dataSource: string

    the scope name
  • unids: string[]

    an array of UNIDs of the documents to be deleted.
  • Optionalmode: string

    the mode to perform the document access in. Defaults to default if missing

  Returns Promise<DocumentStatusResponse[]>

  a promise that resolves to an array of document status response.

bulkGetDocuments

• bulkGetDocuments(
      dataSource: string,
      unids: string[],
      options?: BulkGetDocumentsOptions,
  ): Promise<(DominoDocument | BulkGetErrorResponse)[]>

  Parameters

  • dataSource: string

    the scope name
  • unids: string[]

    an array of UNIDs of the documents to get
  • Optionaloptions: BulkGetDocumentsOptions

    options for bulk get documents operation

  Returns Promise<(DominoDocument | BulkGetErrorResponse)[]>

  a promise that resolves to an array of documents.

bulkUpdateDocumentsByQuery

• bulkUpdateDocumentsByQuery(
      dataSource: string,
      request: BulkUpdateDocumentsByQueryRequest,
      richTextAs?: string,
  ): Promise<DominoDocument[] | DocumentStatusResponse[]>

  Parameters

  • dataSource: string

    the scope name
  • request: BulkUpdateDocumentsByQueryRequest

    request body for bulk update documents by query operation
  • OptionalrichTextAs: string

    the format which richtext fields will be returned as (defaults to mime if not given)

  Returns Promise<DominoDocument[] | DocumentStatusResponse[]>

  a promise that resolves to an array of documents updated or an array of document operation response.

createDocument

• createDocument(
      dataSource: string,
      doc: DocumentJSON,
      options?: CreateDocumentOptions,
  ): Promise<DominoDocument>

  Parameters

  • dataSource: string

    the scope name
  • doc: DocumentJSON

    JSON containing the document data to be saved
  • Optionaloptions: CreateDocumentOptions

    options for create document operation

  Returns Promise<DominoDocument>

  a promise that resolves to the document created.

deleteDocument

• deleteDocument(
      dataSource: string,
      doc: DominoRestDocument,
      mode?: string,
  ): Promise<DocumentStatusResponse>

  Parameters

  • dataSource: string

    the scope name
  • doc: DominoRestDocument

    DominoDocument to be deleted
  • Optionalmode: string

    the mode to perform the document access in. Defaults to default if not given.

  Returns Promise<DocumentStatusResponse>

  a promise that resolves to a document status response.

deleteDocumentByUNID

• deleteDocumentByUNID(
      dataSource: string,
      unid: string,
      mode?: string,
  ): Promise<DocumentStatusResponse>

  Parameters

  • dataSource: string

    the scope name
  • unid: string

    the UNID of the document to be deleted
  • Optionalmode: string

    the mode to perform the document access in. Defaults to default if not given

  Returns Promise<DocumentStatusResponse>

  a promise that resolves to a document status response.

getDocument

• getDocument(
      dataSource: string,
      unid: string,
      options?: GetDocumentOptions,
  ): Promise<DominoDocument>

  Parameters

  • dataSource: string

    the scope name
  • unid: string

    the UNID of the document to get
  • Optionaloptions: GetDocumentOptions

    options for get document operation

  Returns Promise<DominoDocument>

  a promise that resolves to the document fetched.

getDocumentsByQuery

• getDocumentsByQuery(
      dataSource: string,
      request: GetDocumentsByQueryRequest,
      action: QueryActions,
      options?: GetDocumentsByQueryOptions,
  ): Promise<
      | DominoDocument[]
      | QueryDocumentExplainResponse[]
      | QueryDocumentParseResponse[],
  >

  Parameters

  • dataSource: string

    the scope name
  • request: GetDocumentsByQueryRequest

    request body for query operation
  • action: QueryActions

    actions to be done on the query. (eg. execute, explain and parse)
  • Optionaloptions: GetDocumentsByQueryOptions

    options for /query operation

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

  a promise that resolves to an array of documents when execute, an object containing the explainresult or an object containing the parseResult depending on the action provided.

getListViewEntry

• getListViewEntry(
      dataSource: string,
      listViewName: string,
      options?: GetListViewEntryOptions,
  ): Promise<ListViewEntryJSON[]>

  Parameters

  • dataSource: string

    the scope name
  • listViewName: string

    name of the view or folder
  • Optionaloptions: GetListViewEntryOptions

    parameters that we want to use for the endpoint GET /lists/{name} in a specific format

  Returns Promise<ListViewEntryJSON[]>

  a promise that resolves to an array of DominoListViewEntry of entries/data.

getListViewPivotEntry

• getListViewPivotEntry(
      dataSource: string,
      listViewName: string,
      pivotColumn: string,
      options?: GetListPivotViewEntryOptions,
  ): Promise<PivotListViewResponse>

  Parameters

  • dataSource: string

    the scope name
  • listViewName: string

    name of the view or folder
  • pivotColumn: string

    name of the column to provide the data for the pivot aggregator
  • Optionaloptions: GetListPivotViewEntryOptions

    parameters that we want to use for the endpoint GET /listspivot/{name} in a specific format

  Returns Promise<PivotListViewResponse>

  A promise that resolves to a PivotListViewResponse.

getListViews

• getListViews(
      dataSource: string,
      options?: GetListViewOptions,
  ): Promise<GetListViewJSON[]>

  Parameters

  • dataSource: string

    the scope name
  • Optionaloptions: GetListViewOptions

    parameters that we want to use for the endpoint GET /lists in a specific format

  Returns Promise<GetListViewJSON[]>

  A promise that resolves to an array of GetListViewJSON.

getRichtext

• getRichtext(
      dataSource: string,
      unid: string,
      richTextAs: string,
      options?: GetRichtextOptions,
  ): Promise<string>

  Parameters

  • dataSource: string

    the scope name
  • unid: string

    the UNID of the document to be deleted
  • richTextAs: string

    the format to return richtext field value
  • Optionaloptions: GetRichtextOptions

    optional parameters for GET /richtext/{richTextAs}/{unid} endpoint

  Returns Promise<string>

  A promise that resolves to a string of the richtext field value.

getScope

• getScope(dataSource: string): Promise<DominoScope>

  Parameters

  • dataSource: string

    the scope name

  Returns Promise<DominoScope>

  configuration for the specified scope.

patchDocument

• patchDocument(
      dataSource: string,
      unid: string,
      docJsonPatch: DocumentBody,
      options?: PatchDocumentOptions,
  ): Promise<DominoDocument>

  Parameters

  • dataSource: string

    the scope name
  • unid: string

    the document's UNID where the patch will be made
  • docJsonPatch: DocumentBody

    JSON that contains what to patch on a document
  • Optionaloptions: PatchDocumentOptions

    options for update document operation

  Returns Promise<DominoDocument>

  a promise that resolves to the updated document.

updateDocument

• updateDocument(
      dataSource: string,
      doc: DominoRestDocument,
      options?: UpdateDocumentOptions,
  ): Promise<DominoDocument>

  Parameters

  • dataSource: string

    the scope name
  • doc: DominoRestDocument

    DominoDocument to update
  • Optionaloptions: UpdateDocumentOptions

    options for update document operation

  Returns Promise<DominoDocument>

  a promise that resolves to the updated document.

Static ReadonlygetBasisSession

• getBasisSession(
      dominoAccess: DominoRestAccess,
      dominoServer: DominoRestServer,
  ): Promise<DominoBasisSession>

  Static factory method to get DominoBasisSession.

  Parameters

  • dominoAccess: DominoRestAccess

    DominoAccess to use
  • dominoServer: DominoRestServer

    DominoServer to use

  Returns Promise<DominoBasisSession>

  DominoBasisSession class