Module "geocortex/essentials/documents/BatchRequestBuilder"
Functions
Private cloneDocument
- cloneDocument(id: string, document: Document, createOnly: boolean): BatchRequest
-
Parameters
-
id: string
-
-
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
Returns BatchRequest
deleteMoniker
- deleteMoniker(id: string): BatchRequest
-
Parameters
Returns BatchRequest
describe
- describe(streamId: string): BatchRequest
-
Parameters
Returns BatchRequest
generateLinks
- generateLinks(count: number): BatchRequest
-
Parameters
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
Returns BatchRequest
peekMoniker
- peekMoniker(id: string, throwIfMissing?: boolean): BatchRequest
-
Parameters
-
id: string
-
Optional throwIfMissing: boolean
Returns BatchRequest
peekMonikerAccess
- peekMonikerAccess(id: string): BatchRequest
-
Parameters
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
Returns BatchRequest
restoreMoniker
- restoreMoniker(globalId: string): BatchRequest
-
Parameters
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
Returns BatchRequest
searchUsers
- searchUsers(searchClause: string): BatchRequest
-
Parameters
Returns BatchRequest
self
-
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
Returns BatchRequest
writeDocument
- writeDocument(content: DocumentContent): BatchRequest
-
Parameters
Returns BatchRequest
Builds batch requests for the document store REST endpoints.