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

Cart Id (Salesforce Id).Opportunity, Quote or Order Id. - Required

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 to return in the response If not provided or is empty array, all fields are returned

fieldsToInclude

fieldsToInclude: string[] = ...

hierarchy

hierarchy: number

Product Hierarchy

includeAttachment

includeAttachment: boolean = false

Flag to indicate whether product attachments are 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

items

items: any[]

Array of items in the format [{ // Comma separated list of ids of products / child products / add-ons to be added to the cart itemId: "01uf400000HY8YGAA1,01uf400000HY8YuAAL,01uf400000HY8YkAAL", // Hierarchy of parent product (in case of add-on or child product) parentHierarchyPath: "01tf4000004ULpJAAW<01tf4000004ULpOAAW<01tf4000004ULpYAAW<01tf4000004ULpiAAG", // Id of parent item (in case of add-on or child product) parentId: "802f400000YzH8WAAV" }]

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional parentObject

parentObject: {}

Parent record object (in case of adding add-on or child product)

Type declaration

  • [key: string]: any

price

price: boolean = true

Flag to decide, whether to run pricing engine or not If price = false, it will not run pricing engine.

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

Remote method used to add product to cart

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: boolean = true

Flag to decide, whether to run validation rules or not

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(): any
  • Function that constructs the Request body json for ApexRest Handles scenerio when input parameters are not provided

    Returns any

Private validateParameters

  • validateParameters(): void
  • Function to validate all the required params

    Returns void

Generated using TypeDoc