Class VlocityNamespaceService

Hierarchy (View Summary)

NamespaceService
- VlocityNamespaceService

Index

Constructors

Properties

isInitialized logger vlocityNamespace vlocityNamespaceCache

Methods

checkInitialized getConnectionNamespace getNamespace initialize replaceNamespace updateNamespace updateObjectNamespace

Constructors

constructor

new VlocityNamespaceService(
vlocityNamespace?: string | null,
): VlocityNamespaceService
Parameters
- vlocityNamespace: string | null = null
Returns VlocityNamespaceService
Overrides NamespaceService.constructor
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:14

Properties

`Private`isInitialized

isInitialized: boolean = false

`Private` `Readonly`logger

logger: Logger

`Private`vlocityNamespace

vlocityNamespace: string | null = null

`Private` `Readonly`vlocityNamespaceCache

vlocityNamespaceCache: Map<string, string | Promise<string | null> | null> = ...

Methods

`Private`checkInitialized

checkInitialized(): void
Returns void
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:78

`Private`getConnectionNamespace

getConnectionNamespace(connection: SalesforceConnection): Promise<string | null>
Parameters
- connection: SalesforceConnection
Returns Promise<string | null>
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:57

getNamespace

getNamespace(): string
Get the vlocity namespace for the specified

Returns string
Overrides NamespaceService.getNamespace
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:21

initialize

initialize(
connectionProvider: SalesforceConnectionProvider,
): Promise<VlocityNamespaceService>
Get the namespace of the current connection
Parameters
- connectionProvider: SalesforceConnectionProvider
  Connection provider to use to initialize the namespace
Returns Promise<VlocityNamespaceService>
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:50

replaceNamespace

replaceNamespace(name: string): string
Replace the name space with a placeholder string
Parameters
- name: string
  text to update
Returns string
Overrides NamespaceService.replaceNamespace
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:30

updateNamespace

updateNamespace(name: string): string
Update the text replacing all namespace placeholders
Parameters
- name: string
  text to update
Returns string
Overrides NamespaceService.updateNamespace
- Defined in packages/vlocity/src/vlocityNamespaceService.ts:39

updateObjectNamespace

updateObjectNamespace<T extends object>(obj: T): T
Generic object property replacer for updating source or target namespaces on objects and arrays
Type Parameters
- T extends object
Parameters
- obj: T
  Object
Returns T
Inherited from NamespaceService.updateObjectNamespace
- Defined in packages/salesforce/src/namespaceService.ts:29