Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

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

cartId: Order/Opportunity/Quote Id.

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.

Optional fields

fields: string[]

List of fields to be returned.

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

Optional itemObject

itemObject: {}

itemObject: JSON Record of Line Item which is updated

Type declaration

  • [key: string]: any

items

items: any

items: JSONRecord that is being updated

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional parentObject

parentObject: {}

parentObject: JSON Record of Parent Item which has updated child line item

Type declaration

  • [key: string]: any

price

price: string = "true"

price: Pricing evaluation

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 = "putCartsItems"

Remote method in the CpqAppHandler class that updates cart items.

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.

validate

validate: string = "true"

validate: Specifies the filter field values

Methods

Private checkForRequiredParams

  • checkForRequiredParams(): void
  • Convenience method that checks for required params.

    Returns void

getAPIPath

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

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

Protected getEncodedQueryString

  • getEncodedQueryString(): string

getInputMap

  • getInputMap(): any
  • Constructs the input map object containing all the 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(): any
  • Constructs the Request body json for ApexRest Handles scenerio when input parameters are not provided

    Returns any

Generated using TypeDoc