Interface: IUtilitiesApi

Helpful Utilities

Properties

text

readonlytext: ITextUtilities

Experimental

This API is in preivew and not ready for production use. Expect breaking changes in the future. Suite of text utilities

Methods

exportToCsv()

exportToCsv(fieldData, exportFileName): void

Convert field data to CSV format and call download endpoint

Parameters

fieldData: IDocumentObjectManagerData

data to export as CSV

exportFileName: string

The name to give the file download.

Returns

void


getCache()

getCache<T>(maxSize?, expirationTimeInSeconds?): IExpirationCache<T>

Experimental

This API is in preview and not ready for production use. Expect breaking changes in the future. Returns an instance of IExpirationCache to be used freely by caller.

Type Parameters

T

Parameters

maxSize?: number

Max size of the cache. Default is 0.

expirationTimeInSeconds?: number

The longest amount of time a cache item will stay in the cache. Default is 120 seconds.

Returns

IExpirationCache<T>


getHttpClient()

getHttpClient(baseUrl): IHttpClient

Experimental

This API is in preview and not ready for production use. Expect breaking changes in the future. Returns an instance of IHttpClient to be used freely by caller.

Parameters

baseUrl: string

The shared URL for HTTP Requests

Returns

IHttpClient