Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SalesForceNamespace

This class returns the current package namespace, prefix for sobjects, fields and SF REST API prefix as follows:

  1. vlocity_cmt with namespace() (for use in vlocity_cmt.CpqAppHandler)
  2. vlocity_cmt__ with prefix() (for use in custom sobject or fields e.g. vlocity_cmt__OrderProvisioningStatus__c)
  3. /vlocity_cmt with restAPIPrefix() (for use in sf rest API - /vlocity_cmt/v1/proudcts)

Hierarchy

  • SalesForceNamespace

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

Static Private internalNamespace

internalNamespace: string = ...

Static Private internalPrefix

internalPrefix: string = ...

Static Private internalRestAPIPrefix

internalRestAPIPrefix: string = ...

Accessors

Static namespace

  • get namespace(): string
  • set namespace(customNamespace: string): void

  • This function returns the namespace that is being used in SDK.

    Returns string

    namespace.

  • This function provides a way to override the default or build time set up of namespace.

    Parameters

    • customNamespace: string

    Returns void

    namespace.

Static prefix

  • get prefix(): string

  • This returns the namespace prefix for sobject and fields. If namespace is defined and not an empty string, this will return {namespace}. e.g. vlocity_cmt If namespace is empty, this will return an empty string.

    example
    `${SalesForceNamespace.prefix}OrderLineItemProvisioningStatus__c`

    Returns string

Static restAPIPrefix

  • get restAPIPrefix(): string

  • This returns the SalesForce Rest URL prefix with the preceding /. If namespace is defined and not an empty string, this will return /{namespace}. e.g. /vlocity_cmt If namespace is empty, this will return an empty string.

    example
    `/services/apexrest${SalesForceNamespace.restAPIPrefix}/v2/carts/items`

    Returns string

Generated using TypeDoc