Skip to main content

IWorkflowCode Methods

An object defining methods for the IWorkflowCode class.

GetServiceAPI<T>()​

Retrieves a service API object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the service API object to retrieve.

Returns:​

Type: T
The service API object of the specified type.

This is a sync method. Method runs synchronously.


GetWebNotificationSender<T>()​

Retrieves a web notification sender object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the web notification sender object to retrieve.

Returns:​

Type: T

This is a sync method. Method runs synchronously.


GetUserMembersResolver()​

Retrieves the user members resolver object for resolving user memberships.

Returns:​

Type: object

This is a sync method. Method runs synchronously.


GetServiceAPI()​

Retrieves the service API object for interacting with workflow-related services.

Returns:​

Type: object
The service API object.

This is a sync method. Method runs synchronously.


GetPositionMembersResolver<T>()​

Retrieves a position members resolver object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the position members resolver object to retrieve.

Returns:​

Type: T

This is a sync method. Method runs synchronously.


GetMailAttachmentResolver()​

Retrieves the mail attachment resolver object for resolving attachments.

Returns:​

Type: object

This is a sync method. Method runs synchronously.


GetLiquidRenderer()​

Retrieves the Liquid renderer object for rendering templates.

Returns:​

Type: object

This is a sync method. Method runs synchronously.


GetWebNotificationSender()​

Retrieves the web notification sender object for sending notifications.

Returns:​

Type: object

This is a sync method. Method runs synchronously.


GetWorkflowObject<T>(name)​

Retrieves a workflow object of the specified type by its name.

Parameters:​

name (required): string
The name of the workflow object to retrieve.

Generics:​

Type: T
A generic type parameter representing the type of the workflow object to retrieve.

Returns:​

Type: T
The workflow object of the specified type.

This is a sync method. Method runs synchronously.


GetMailAttachmentResolver<T>()​

Retrieves a mail attachment resolver object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the mail attachment resolver object to retrieve.

Returns:​

Type: T

This is a sync method. Method runs synchronously.


GetUserMembersResolver<T>()​

Retrieves a user members resolver object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the user members resolver object to retrieve.

Returns:​

Type: T

This is a sync method. Method runs synchronously.


GetPositionMembersResolver()​

Retrieves the position members resolver object for resolving position memberships.

Returns:​

Type: object

This is a sync method. Method runs synchronously.


GetLiquidRenderer<T>()​

Retrieves a Liquid renderer object of the specified type.

Generics:​

Type: T
A generic type parameter representing the type of the Liquid renderer object to retrieve.

Returns:​

Type: T

This is a sync method. Method runs synchronously.