Options
All
  • Public
  • Public/Protected
  • All
Menu

Base class that defines an input

Hierarchy

Index

Constructors

constructor

Properties

Optional actionObj

actionObj: Action

Action object json.

Optional anonymousSiteUrl

anonymousSiteUrl: string

anonymousSiteUrl as the prefix of the API url for Off-Platform deployments.

Optional apiNamespace

apiNamespace: string

API namespace.

Optional bundleName

bundleName: string = ""

dataRaptor bundle name - optional

Optional cacheExpiration

cacheExpiration: Date

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

Optional cacheable

cacheable: boolean = false

Flag to indicate if the sdk call should be cached.

Optional chainable

chainable: boolean

execute Integration Procedure as chainable.

Optional columns

columns: any[] = []

Returns list of custom columns to client.

Optional contentType

contentType: string = "application/json"

Optional customFields

customFields: string[] = []

List of custom fields to be returned.

Optional fields

fields: any

List of fields to be returned.

Optional inputMap

inputMap: any

Input Map values for the dataraptor procedure.

Optional inputParamsString

inputParamsString: string

inputParamsString for the dataraptor.

Optional ipMethod

ipMethod: string = ""

integration procedure name - optional

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional reload

reload: boolean = false

Boolean flag to discard cache and call the api again. Default is false.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

Optional remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Methods

cloneDeep

  • cloneDeep(obj: any): any
  • Parameters

    • obj: any

    Returns any

findLineItem

  • findLineItem(obj: any, value: any): any
  • Parameters

    • obj: any
    • value: any

    Returns any

Abstract getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when namespace is null

    Returns string

Abstract getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string
  • Function that constructs the Anonymous API path for Rest

    Returns string

getAuthorisationType

  • getAuthorisationType(): string
  • content type of the resource.

    Returns string

Protected Abstract getEncodedQueryString

  • getEncodedQueryString(): string
  • Function that constructs the query string for API

    Returns string

Abstract getInputMap

  • getInputMap(): any
  • Function that constructs the input map object containing all query parameters for API

    Returns any

getRemoteMethod

  • getRemoteMethod(): string
  • Function to return VF Remoting method name.

    Returns string

Abstract getRequestPayload

  • getRequestPayload(): any
  • Function to create request body for API POST.

    Returns any

Generated using TypeDoc