Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "geocortex/essentials/documents/BatchRequestBuilder"

Index

Functions

Functions

Private cloneDocument

  • cloneDocument(id: string, document: Document, createOnly: boolean): BatchRequest

  • Builds batch requests for the document store REST endpoints.

    Parameters

    • id: string
    • document: Document
    • createOnly: boolean

    Returns BatchRequest

createDocument

  • createDocument(document: Document, streamId: string): BatchRequest

  • Parameters

    Returns BatchRequest

createMoniker

  • createMoniker(moniker: Moniker, createOnly: boolean): BatchRequest

  • Parameters

    • moniker: Moniker
    • createOnly: boolean

    Returns BatchRequest

deleteDocument

  • deleteDocument(id: string): BatchRequest

  • Parameters

    • id: string

    Returns BatchRequest

deleteMoniker

  • deleteMoniker(id: string): BatchRequest

  • Parameters

    • id: string

    Returns BatchRequest

describe

  • describe(streamId: string): BatchRequest

  • Parameters

    • streamId: string

    Returns BatchRequest

generateLinks

  • generateLinks(count: number): BatchRequest

  • Parameters

    • count: number

    Returns BatchRequest

modifyDocument

  • modifyDocument(document: Document, streamId: string): BatchRequest

  • Parameters

    Returns BatchRequest

openDocument

  • openDocument(id: string, streamId: string, startPosition: number): BatchRequest

  • Parameters

    • id: string
    • streamId: string
    • startPosition: number

    Returns BatchRequest

peekDocument

  • peekDocument(id: string, throwIfMissing?: boolean): BatchRequest

  • Parameters

    • id: string
    • Optional throwIfMissing: boolean

    Returns BatchRequest

peekDocumentAccess

  • peekDocumentAccess(id: string): BatchRequest

  • Parameters

    • id: string

    Returns BatchRequest

peekMoniker

  • peekMoniker(id: string, throwIfMissing?: boolean): BatchRequest

  • Parameters

    • id: string
    • Optional throwIfMissing: boolean

    Returns BatchRequest

peekMonikerAccess

  • peekMonikerAccess(id: string): BatchRequest

  • Parameters

    • id: string

    Returns BatchRequest

previewDocument

  • previewDocument(id: string, streamId: string): BatchRequest

  • Parameters

    • id: string
    • streamId: string

    Returns BatchRequest

previewMoniker

  • previewMoniker(id: string, streamId: string): BatchRequest

  • Parameters

    • id: string
    • streamId: string

    Returns BatchRequest

readDocument

  • readDocument(id: string, format: string): BatchRequest

  • Parameters

    • id: string
    • format: string

    Returns BatchRequest

restoreDocument

  • restoreDocument(globalId: string): BatchRequest

  • Parameters

    • globalId: string

    Returns BatchRequest

restoreMoniker

  • restoreMoniker(globalId: string): BatchRequest

  • Parameters

    • globalId: string

    Returns BatchRequest

resumeDocument

  • resumeDocument(globalId: string, streamId: string): BatchRequest

  • Parameters

    • globalId: string
    • streamId: string

    Returns BatchRequest

scrub

  • scrub(scrubOptions: ScrubOptions): BatchRequest

  • Parameters

    • scrubOptions: ScrubOptions

    Returns BatchRequest

searchDocuments

  • searchDocuments(documentQuery: Query<Document>): BatchRequest

  • Parameters

    Returns BatchRequest

searchMonikers

  • searchMonikers(monikerQuery: Query<Moniker>): BatchRequest

  • Parameters

    • monikerQuery: Query<Moniker>

    Returns BatchRequest

searchRoles

  • searchRoles(searchClause: string): BatchRequest

  • Parameters

    • searchClause: string

    Returns BatchRequest

searchUsers

  • searchUsers(searchClause: string): BatchRequest

  • Parameters

    • searchClause: string

    Returns BatchRequest

self

  • self(): BatchRequest

  • Returns BatchRequest

touchDocument

  • touchDocument(id: string, modify: boolean, throwIfMissing: boolean): BatchRequest

  • Parameters

    • id: string
    • modify: boolean
    • throwIfMissing: boolean

    Returns BatchRequest

updateDocument

  • updateDocument(document: Document): BatchRequest

  • Parameters

    Returns BatchRequest

updateMoniker

  • updateMoniker(moniker: Moniker): BatchRequest

  • Parameters

    • moniker: Moniker

    Returns BatchRequest

writeDocument

  • writeDocument(content: DocumentContent): BatchRequest

  • Parameters

    • content: DocumentContent

    Returns BatchRequest