DocumentBuilder | @coveo/shovel

Utility class to build a Document.

Hierarchy

DocumentBuilder

Constructors

constructor

new DocumentBuilder(uri: string, title: string): DocumentBuilder

- Defined in src/documentBuilder.ts:10
Parameters
- uri: string
  
  The URI of the document. See Document.uri
- title: string
  
  The title of the document. See Document.title
Returns DocumentBuilder

Properties

Private doc

doc: Document

Methods

build

build(): Document

- Defined in src/documentBuilder.ts:203
Returns Document

Private generatePermanentId

generatePermanentId(): string

- Defined in src/documentBuilder.ts:270
Returns string

marshal

marshal(): { author?: string; clickableUri?: string; compressedBinaryData?: { compressionType: CompressionType; data: string }; compressionType: undefined; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: undefined; title: string } | { author?: string; clickableUri?: string; compressedBinaryData?: { compressionType: CompressionType; data: string }; compressionType: undefined; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[]; title: string } | { author?: string; clickableUri?: string; compressedBinaryData: string; compressionType: CompressionType; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: undefined; title: string } | { author?: string; clickableUri?: string; compressedBinaryData: string; compressionType: CompressionType; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[]; title: string }

- Defined in src/documentBuilder.ts:211
Marshal the document into a JSON format accepted by the push API.

Returns { author?: string; clickableUri?: string; compressedBinaryData?: { compressionType: CompressionType; data: string }; compressionType: undefined; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: undefined; title: string } | { author?: string; clickableUri?: string; compressedBinaryData?: { compressionType: CompressionType; data: string }; compressionType: undefined; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[]; title: string } | { author?: string; clickableUri?: string; compressedBinaryData: string; compressionType: CompressionType; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: undefined; title: string } | { author?: string; clickableUri?: string; compressedBinaryData: string; compressionType: CompressionType; data?: string; date?: string; documentId: string; fileExtension?: string; modifiedDate?: string; parentId?: string; permanentId?: string; permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[]; title: string }

Private marshalCompressedBinaryData

marshalCompressedBinaryData(): { compressedBinaryData: undefined; compressionType: undefined } | { compressedBinaryData: string; compressionType: CompressionType }

- Defined in src/documentBuilder.ts:235
Returns { compressedBinaryData: undefined; compressionType: undefined } | { compressedBinaryData: string; compressionType: CompressionType }

Private marshalMetadata

marshalMetadata(): Metadata

- Defined in src/documentBuilder.ts:224
Returns Metadata

Private marshalPermissions

marshalPermissions(): { permissions: undefined } | { permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[] }

- Defined in src/documentBuilder.ts:245
Returns { permissions: undefined } | { permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[] }

Private setPermission

setPermission(securityIdentityBuilder: SecurityIdentityBuilder, permissionSection: "allowedPermissions" | "deniedPermissions"): void

- Defined in src/documentBuilder.ts:286
Parameters
- securityIdentityBuilder: SecurityIdentityBuilder
- permissionSection: "allowedPermissions" | "deniedPermissions"
Returns void

Private validateAndFillMissing

validateAndFillMissing(): void

- Defined in src/documentBuilder.ts:260
Returns void

Private validateCompressedBinaryData

validateCompressedBinaryData(data: string): void

- Defined in src/documentBuilder.ts:279
Parameters
- data: string
Returns void

Private validateDateAndReturnValidDate

validateDateAndReturnValidDate(d: string | number | Date): string

- Defined in src/documentBuilder.ts:274
Parameters
- d: string | number | Date
Returns string

withAllowAnonymousUsers

withAllowAnonymousUsers(allowAnonymous: boolean): DocumentBuilder

- Defined in src/documentBuilder.ts:198
Set allowAnonymous for permissions on the document. See Document.permissions

Parameters
- allowAnonymous: boolean
Returns DocumentBuilder

withAllowedPermissions

withAllowedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): DocumentBuilder

- Defined in src/documentBuilder.ts:174
Set allowed identities on the document. See Document.permissions

Parameters
- securityIdentityBuilder: SecurityIdentityBuilder
Returns DocumentBuilder

withAuthor

withAuthor(author: string): DocumentBuilder

- Defined in src/documentBuilder.ts:123
Set the author on the document. See Document.author

Parameters
- author: string
Returns DocumentBuilder

withClickableUri

withClickableUri(clickURI: string): DocumentBuilder

- Defined in src/documentBuilder.ts:111
Set the clickableURI on the document. See Document.clickableUri

Parameters
- clickURI: string
Returns DocumentBuilder

withCompressedBinaryData

withCompressedBinaryData(data: string, compressionType: CompressionType): DocumentBuilder

- Defined in src/documentBuilder.ts:71
Set the base64 encoded, compressed binary data of the document. See Document.compressedBinaryData

Parameters
- data: string
- compressionType: CompressionType
Returns DocumentBuilder

withData

withData(data: string): DocumentBuilder

- Defined in src/documentBuilder.ts:30
Set the data of the document. See Document.data

Parameters
- data: string
Returns DocumentBuilder

withDate

withDate(date: string | number | Date): DocumentBuilder

- Defined in src/documentBuilder.ts:40
Set the date of the document. See Document.date

Parameters
- date: string | number | Date
Returns DocumentBuilder

withDeniedPermissions

withDeniedPermissions(securityIdentityBuilder: SecurityIdentityBuilder): DocumentBuilder

- Defined in src/documentBuilder.ts:186
Set denied identities on the document. See Document.permissions

Parameters
- securityIdentityBuilder: SecurityIdentityBuilder
Returns DocumentBuilder

withFileExtension

withFileExtension(extension: string): DocumentBuilder

- Defined in src/documentBuilder.ts:88
Set the file extension on the document. See Document.fileExtension

Parameters
- extension: string
Returns DocumentBuilder

withMetadata

withMetadata(metadata: Metadata): DocumentBuilder

- Defined in src/documentBuilder.ts:162
Set metadata on the document. See Document.metadata

Parameters
- metadata: Metadata
Returns DocumentBuilder

withMetadataValue

withMetadataValue(key: string, value: MetadataValue): DocumentBuilder

- Defined in src/documentBuilder.ts:134
Add a single metadata key and value pair on the document. See Document.metadata

Parameters
- key: string
- value: MetadataValue
Returns DocumentBuilder

withModifiedDate

withModifiedDate(date: string | number | Date): DocumentBuilder

- Defined in src/documentBuilder.ts:50
Set the modified date of the document. See Document.modifiedDate

Parameters
- date: string | number | Date
Returns DocumentBuilder

withParentID

withParentID(id: string): DocumentBuilder

- Defined in src/documentBuilder.ts:101
Set the parentID on the document. See Document.parentId

Parameters
- id: string
Returns DocumentBuilder

withPermanentId

withPermanentId(permanentID: string): DocumentBuilder

- Defined in src/documentBuilder.ts:60
Set the permanentID of the document. See Document.permanentId

Parameters
- permanentID: string
Returns DocumentBuilder

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

uri: string

title: string

Returns DocumentBuilder

Properties

Private doc

Methods

build

Returns Document

Private generatePermanentId

Returns string

marshal

Private marshalCompressedBinaryData

Returns { compressedBinaryData: undefined; compressionType: undefined } | { compressedBinaryData: string; compressionType: CompressionType }

Private marshalMetadata

Returns Metadata

Private marshalPermissions

Returns { permissions: undefined } | { permissions: { allowAnonymous: boolean; allowedPermissions: SecurityIdentity[]; deniedPermissions: SecurityIdentity[] }[] }

Private setPermission

Parameters

securityIdentityBuilder: SecurityIdentityBuilder

permissionSection: "allowedPermissions" | "deniedPermissions"

Returns void

Private validateAndFillMissing

Returns void

Private validateCompressedBinaryData

Parameters

data: string

Returns void

Private validateDateAndReturnValidDate

Parameters

d: string | number | Date

Returns string

withAllowAnonymousUsers

Parameters

allowAnonymous: boolean

Returns DocumentBuilder

withAllowedPermissions

Parameters

securityIdentityBuilder: SecurityIdentityBuilder

Returns DocumentBuilder

withAuthor

Parameters

author: string

Returns DocumentBuilder

withClickableUri

Parameters

clickURI: string

Returns DocumentBuilder

withCompressedBinaryData

Parameters

data: string

compressionType: CompressionType

Returns DocumentBuilder

withData

Parameters

data: string

Returns DocumentBuilder

withDate

Parameters

date: string | number | Date

Returns DocumentBuilder

withDeniedPermissions

Parameters

securityIdentityBuilder: SecurityIdentityBuilder

Returns DocumentBuilder

withFileExtension

Parameters

extension: string

Returns DocumentBuilder

withMetadata

Parameters

metadata: Metadata