Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApexRemoteInput

Class that defines input for ApexRemoteInput .

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional cacheExpiration

cacheExpiration: Date

Expiration Date time of the cached item. Default is current time plus 5 minutes.

Optional cacheType

cacheType: CacheType

cacheType defines where the response data should be stored. Default is IndexedBB. set cacheType storageType.INDEXEDDB/storageType.LOCALSTORAGE/storageType.SESSIONSTORAGE

Optional cacheable

cacheable: boolean

Flag to indicate if this datasource call should be cached.

className

className: string

className of the Apex Remote service

Optional config

config: object

config as an object

Optional inputMap

inputMap: any

input params as an object- format: {"name": "vlocity", "state":"ca"}

methodName

methodName: string

methodName of the Apex Remote Request

Optional optionsMap

optionsMap: any = {}

Optional paramsArray

paramsArray: any[]

Array of parameters for the Apex Remote Request

Optional reload

reload: boolean

reload defines if the data should be retrive from the cache or not. Default is false. set reload to true when fresh data needs to fetched from the API

Optional retryCount

retryCount: number

retryCount defines the number of retry for datasource.execute() to be called if a failure is encountered.

Optional timeoutInMillis

timeoutInMillis: number

timeoutInMillis defines the timeout for API requests.

Methods

digest

  • digest(): Promise<string>

  • This function generates a unique digest value for this input. Subclass needs to provide the unique data to be digested to ensure the uniqueness.

    Returns Promise<string>

    Promise filled with hex string representation of the digested value. This hex string can be used for comparison and display.

Protected digestData

  • digestData(...data: string[]): Promise<string>

  • This function generates a unique digest value for this input. Subclass needs to provide the unique data to be digested to ensure the uniqueness.

    Parameters

    • Rest ...data: string[]

      unique data to be digested.

    Returns Promise<string>

    Promise filled with hex string representation of the digested value. This hex string can be used for comparison and display.

Generated using TypeDoc