Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to delete cart Item from the cart.

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 cartId

cartId: string = ""

The cart Id to be used for getting a list of line items. It may be the regular cart id or the anonymous cart id.

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: string

List of fields to be returned. Supported Product2 and Pricebook fields.

fieldsToInclude

fieldsToInclude: string[] = ...

Optional filter

filter: string

Filter field values.

Optional hierarchy

hierarchy: number

The hierarchy level to be retrieved. For only the current level of products, hierarchy will be 0. For retrieving current level of products with children, hierarchy will be 1.

Optional id

id: string

List of comma separated itemIds to return only the corresponding cart Items

includeAttachment

includeAttachment: boolean

Whether product attachments are 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 lastRecordId

lastRecordId: string

When doing pagination, provide the last record ID that was previously return. If last record ID is not provided, get products will start from the beginning.

Optional offsetSize

offsetSize: number

The offset to start the product list from. If we are using pagesize of 20, the offset for next page will be 21.

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional pagesize

pagesize: number

The number of top level products or offers to be returned. Default is 20.

price

price: boolean = false

Flag to indicate if pricing rules should be run.

Optional priceDetailsFields

priceDetailsFields: string

Price Detail fields.

Optional query

query: string

Search Text

Optional reload

reload: boolean = false

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

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class to handle get products.

remoteMethod

remoteMethod: string = "getCartsItems"

Remote method in the above Remote Class to handle get cart items.

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

validate

validate: boolean = false

Flag to indicate if validation rules should be run.

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

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

getAuthorisationType

  • getAuthorisationType(): 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

getRequestPayload

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

    Parameters

    • Optional cartItems: any

    Returns any

Generated using TypeDoc