Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for getting offers.

extends

AccountInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetOfferInput class

    Returns GetOfferInput

Properties

actionObj

actionObj: Action

Action object json.

apiNamespace

apiNamespace: string

API namespace.

Optional contextId

contextId: string

contextId to be used in part of the path of the API to get offers.

Optional fields

fields: string[]

List of fields to be returned in the response.

Optional machineResourceName

machineResourceName: string

machineResourceName to be used in part of the path of the API to get offers.

Optional pageSize

pageSize: number

pageSize as part of the query string of the API for pagination.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional secureServerEndPointUrl

secureServerEndPointUrl: string

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

Methods

getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when namespace is null

    Returns 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(): any
  • Function that constructs the Request body json for ApexRest and Rest when we are using HTTP methods of POST or PUT.

    Returns any

Generated using TypeDoc