@thotnr-aws-accl/custom-app-api / Exports
@thotnr-aws-accl/custom-app-api
Table of contents
▸ cacheContext(callContexts): Promise<void>
Caches provided call contexts.
Parameters
An array of call context objects to be cached.
Returns
Promise<void>
A promise that resolves once all call contexts have been processed and cached.
▸ enterAsOfDate(asOfDate): void
Set the as of date for the context
Parameters
Returns
void
▸ enterContext(callContext, bypassCache?): Promise<void>
Initializes the application context with the given session code, effective date and as of date
Parameters
Returns
Promise<void>
A promise that resolves when the context is entered
▸ getAsOfDate(): string
Get as of date
Returns
string
getEffectiveDate
▸ getEffectiveDate(): string
Get effective date
Returns
string
▸ initAPI(base64EncodedTokenOrBaseUrl): void
Initialize the API
Parameters
base64EncodedTokenOrBaseUrl
The base64 encoded token or the base url of the application
Returns
void
▸ initAPIV2(base64EncodedTokenOrBaseUrl): Promise<any>
Initialize the API
Parameters
base64EncodedTokenOrBaseUrl
The base64 encoded token or the base url of the application
base64EncodedTokenOrBaseUrl.base64EncodedToken
Returns
Promise<any>
isAWSEMRServerlessBackedHost
▸ isAWSEMRServerlessBackedHost(host): host is AWSEMRServerlessBackedHost
Determines if the background service host is of type AWS_EMR_SERVERLESS_BACKED
Parameters
The background service host to check.
Returns
host is AWSEMRServerlessBackedHost
True if the host is of type AWS_EMR_SERVERLESS_BACKED, false otherwise.
▸ isLocalDevHost(host): host is LocalDevHost
Determines if the background service host is of type LOCAL_DEV
Parameters
The background service host to check.
Returns
host is LocalDevHost
True if the host is of type LOCAL_DEV, false otherwise.
setContextAsOfDate
▸ setContextAsOfDate(asOfDate): void
Set the as of date for the context
Parameters
Returns
void
setContextEffectiveDate
▸ setContextEffectiveDate(effectiveDate): void
Set the effective date for the context
Parameters
Returns
void
setContextScenario
▸ setContextScenario(scenarioId): void
Set the scenario for the context
Parameters
Returns
void
BackgroundServiceHost
Ƭ BackgroundServiceHost: AWSEMRServerlessBackedHost | LocalDevHost
Represents a background service host, which can be of type AWS_EMR_SERVERLESS_BACKED or LOCAL_DEV
RecordWithErrors
Ƭ RecordWithErrors: { recordErrors: [{ errorMessage: string ; errorType: ObjectFieldErrorType ; fieldId: string }] } & { [key: string]: any; }
Represents an error in a field value.