Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

PricingVariableCode

PricingVariableCode: any

Pricing variable code associated with the price field

Optional accountId

accountId: string = ""

User accountId for checkout api calls - optional

actionObj

actionObj: Action

Action object json.

anonymousSiteUrl

anonymousSiteUrl: string

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

apiNamespace

apiNamespace: string

API namespace.

Optional cacheExpiration

cacheExpiration: Date

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

Optional cacheType

cacheType: string

Flag to indicate where the data to be cached. Supported types are "INDEXEDDB, SESSIONSTORAGE and LOCALSTORAGE"

Optional cacheable

cacheable: boolean = false

Flag to indicate if the sdk call should be cached.

cartId

cartId: string

Cart Id (Salesforce Id).Opportunity, Quote or Order Id. Required for fetching AdjustmentCodes only

Optional chainable

chainable: boolean

execute Integration Procedure as chainable.

Optional contentType

contentType: string = "application/json"

Optional customFields

customFields: string[] = []

List of custom fields to be returned.

fields

fields: string[]

List of fields for which to retrieve adjustment codes

fieldsToInclude

fieldsToInclude: string[] = ...

id

id: string

Line Item Id under the cart Required for fetching AdjustmentCodes only

Optional inputMap

inputMap: any

Input Map values for the dataraptor procedure.

Optional integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional ipMethod

ipMethod: string = ""

integration procedure name - optional

listkeys

listkeys: string

The list of types for which to retrieve values - AdjustmentCodes,TimePlans,TimePolicies

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.

remoteMethod

remoteMethod: string = "getListsOfValues"

Remote method in the above Remote Class to handle get products.

Optional requestCredentials

requestCredentials: boolean

value indicating whether the user agent should send cookies from the other domain in the case of cross-origin requests

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Methods

getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when input parameters are not provided

    Returns string

getAnonymousSiteRestUrl

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

    Returns string

Protected getEncodedQueryString

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

    Returns string

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

getRequestCredentials

  • getRequestCredentials(): RequestCredentials
  • The credentials read-only property of the Request interface indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests.

    Returns RequestCredentials

getRequestPayload

  • getRequestPayload(): object
  • Function that constructs the Request body json for ApexRest Handles scenerio when input parameters are not provided

    Returns object

Generated using TypeDoc