Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetCartItemsInput

Hierarchy

  • GetCartItemsInput

Implements

Index

Properties

Methods

Properties

actionObj

actionObj: Action

action object.

anonymousSiteUrl

anonymousSiteUrl: string = ""

Anonymous site URL. e.g. https://guidedselling102-developer-edition.na35.force.com

apiNamespace

apiNamespace: string = SalesForceNamespace.namespace

API Namespace to be used in Rest API call. e.g. h_cpq_promotion

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 columns

columns: any[] = []

Returns list of custom columsn to client.

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.

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

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class to handle get products.

remoteMethod

remoteMethod: string = "getCartsItems"

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

validate

validate: boolean = false

Flag to indicate if validation rules should be run.

Static Private CustomProcessQueryNames

CustomProcessQueryNames: Set<string> = new Set(["offset","fields","remoteClass","remoteMethod","loginUserRestPath","anonymousRestUrl","defaultApiNamespace","apiNamespace","defaultAnonymousSiteUrl","anonymousSiteUrl","cartId","actionObj","customFields"])

Query Names that needs to be skipped and may require custom processing. If custom processing is needed, these query names will be flattened out into URL Get parameters.

Methods

anonymousRestUrl

  • anonymousRestUrl(urlparams: any): string

getAnonymousRestUrl

  • getAnonymousRestUrl(params?: object): string

  • Apply the given params value of matching in rest URL.

    Parameters

    • Optional params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

getInputMap

  • getInputMap(fieldsToInclude: any): any

  • Parameters

    • fieldsToInclude: any

    Returns any

getLoginUserRestPath

  • getLoginUserRestPath(params?: object): string

  • Apply the given params value of matching in rest path.

    Parameters

    • Optional params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

inputMap

  • inputMap(): object

  • Returns object

loginUserRestPath

  • loginUserRestPath(urlparams: any): string

  • Rest URL for login user to get products.

    Parameters

    • urlparams: any

    Returns string

urlEncodedQuery

  • urlEncodedQuery(): string

  • Return the encoded query of a URI that contains the properties in this class. Undefined properties will not be included in the encoded query.

    scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]

    Returns string

Generated using TypeDoc