Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AddProductToCartInput

Class that defines input to add product to the cart.

Hierarchy

Index

Constructors

Properties

Methods

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

cartId as part of the POST body of the API for adding product to the working cart. Optional when adding child product to the parent.

Optional chainable

chainable: boolean

execute Integration Procedure as chainable.

childProductId

childProductId: string

childProductId as part of the POST body of the API for adding product to the working cart. childProductId - the offer Id which needs to be added to the cart.

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 parentId

parentId: string

parentId as part of the POST body of the API for adding product to the working cart.

Optional parentObject

parentObject: {}

The parent object of addon to be added to the cart.

Type declaration

  • [key: string]: any

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 in the above Remote Class to handle add cart items.

rootBundleId

rootBundleId: string

rootBundleId as part of the POST body of the API for adding product to the working cart.

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

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

prepareAddToCartActionObject

  • prepareAddToCartActionObject(): { client: { params: {} }; link: string; remote: { methodName: string; params: {} }; rest: { link: string; method: string; params: { cartId: string; hierarchy: number; includeAttachment: boolean; items: { itemId: string }[]; lastRecordId: any; methodName: string; pagesize: number; price: boolean; query: any; validate: boolean } } }

  • Returns { client: { params: {} }; link: string; remote: { methodName: string; params: {} }; rest: { link: string; method: string; params: { cartId: string; hierarchy: number; includeAttachment: boolean; items: { itemId: string }[]; lastRecordId: any; methodName: string; pagesize: number; price: boolean; query: any; validate: boolean } } }

    • client: { params: {} }
      • params: {}
    • link: string
    • remote: { methodName: string; params: {} }
      • methodName: string
      • params: {}
    • rest: { link: string; method: string; params: { cartId: string; hierarchy: number; includeAttachment: boolean; items: { itemId: string }[]; lastRecordId: any; methodName: string; pagesize: number; price: boolean; query: any; validate: boolean } }
      • link: string
      • method: string
      • params: { cartId: string; hierarchy: number; includeAttachment: boolean; items: { itemId: string }[]; lastRecordId: any; methodName: string; pagesize: number; price: boolean; query: any; validate: boolean }
        • cartId: string
        • hierarchy: number
        • includeAttachment: boolean
        • items: { itemId: string }[]
        • lastRecordId: any
        • methodName: string
        • pagesize: number
        • price: boolean
        • query: any
        • validate: boolean

Generated using TypeDoc