Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to get catalogs.

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 attributes

attributes: string

Attribute filters. For example, for the attribute memory (attributecode=attr1) with selected values 16gb and 32gb and attribute color (attr2) with red selected, the format will be as shown in the example.

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.

cartId

cartId: string

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

Optional category

category: string

Fetch Products by Catalog Category

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 return in the response, separated by commas.

fieldsToInclude

fieldsToInclude: string[] = ...

Optional filters

filters: string

Filter field values.

Optional hierarchy

hierarchy: number = 0

hierarchy depth returned for list of products

Optional includeAttachment

includeAttachment: boolean

Whether product attachments are returned

Optional includeAttributes

includeAttributes: boolean

Specifies whether to return a list of attributes and their values for the product.

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

The last record ID from the previous search result, if available

Optional offsetSize

offsetSize: number

Offset from which to start reading products, for pagination.

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional pageSize

pageSize: number

Number of records to be returned

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 cart products.

remoteMethod

remoteMethod: string = "getCartsProducts"

Remote method in the boave Remote Class to handle get cart products.

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

Generated using TypeDoc