Class VlocityInterfaceInvoker

Class to invoke methods on APEX classes that implement a VlocityObjectInterface in Salesforce using the Salesforce REST API.

Index

Constructors

Properties

connectionProvider endPoint logger namespaceProvider

Methods

invoke parseMethod

Constructors

constructor

new VlocityInterfaceInvoker(
    logger: Logger,
    namespaceProvider: NamespaceService,
    connectionProvider: SalesforceConnectionProvider,
): VlocityInterfaceInvoker
Parameters
- logger: Logger
- namespaceProvider: NamespaceService
- connectionProvider: SalesforceConnectionProvider
Returns VlocityInterfaceInvoker
- Defined in packages/vlocity/src/vlocityInterfaceInvoker.ts:13

Properties

`Private` `Readonly`connectionProvider

connectionProvider: SalesforceConnectionProvider

`Private` `Readonly`endPoint

endPoint: "/services/apexrest/{vlocity_namespace}/v1/invoke" = '/services/apexrest/{vlocity_namespace}/v1/invoke'

`Private` `Readonly`logger

logger: Logger

`Private` `Readonly`namespaceProvider

namespaceProvider: NamespaceService

Methods

invoke

invoke<T = any>(
    methodSpec: string | { className: string; methodName: string },
    input?: string | object,
    options?: string | object,
): Promise<T>
Invoke a Vlocity interface method in Salesforce with the specified input and options. If the method invocation results in an exception this method will throw an error.
Type Parameters
- T = any
Parameters
- methodSpec: string | { className: string; methodName: string }
  The method to invoke. Can be a string in the format 'class.method' or an object with className and methodName properties.
- Optionalinput: string | object
  Input to pass to the method
- Optionaloptions: string | object
  Options to pass to the method
Returns Promise<T>
The result of the method invocation
Example
```
// Invoke a method with a string
const result = await invoker.invoke('MyClass.myMethod', { input: 'value' });
```
- Defined in packages/vlocity/src/vlocityInterfaceInvoker.ts:30

`Private`parseMethod

parseMethod(methodSpec: string): { className: string; methodName: string }
Parameters
- methodSpec: string
Returns { className: string; methodName: string }
- Defined in packages/vlocity/src/vlocityInterfaceInvoker.ts:66