Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DigitalCommerceInput

Base class that defines an input

Hierarchy

Index

Constructors

Properties

Methods

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.

Optional callSecureServer

callSecureServer: boolean = false

boolean value to decide if secure server needs to be called.

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.

Optional fields

fields: string[]

List of fields to be returned.

Optional inputMap

inputMap: any = {}

Input Map values for the dataraptor procedure.

Optional integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

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

Remote method that handles this request.

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 secureServerEndPointUrl

secureServerEndPointUrl: string

optional input param used as secure Server rest URL end point when Proxy SDK is used

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Methods

Abstract getAPIPath

  • getAPIPath(): string

  • Function that constructs the API path for ApexRest Handles scenerio when namespace is null

    Returns string

Abstract getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

  • Function that constructs the Anonymous API path for Rest

    Returns string

getAuthToken

  • getAuthToken(context?: default): Promise<string>

  • Function to return authorization token

    Parameters

    • Optional context: default

      optional param.

    Returns Promise<string>

getAuthorisationType

  • getAuthorisationType(): string

  • content type of the resource.

    Returns string

Protected Abstract getEncodedQueryString

  • getEncodedQueryString(): string

  • Function that constructs the query string for API

    Returns string

Abstract 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

Abstract getRequestPayload

  • getRequestPayload(): any

  • Function to create request body for API POST.

    Returns any

Abstract getSecureServerRestUrl

  • getSecureServerRestUrl(): string

  • Function that constructs the API path for secure server

    Returns string

Generated using TypeDoc