Class DigitalEventSyncService

Class to handle synchronous control flow between the DigitalContactService and the DigitalContactManager.

Hierarchy

DigitalEventSyncService

Index

Constructors

constructor

Properties

Accessors

instance

Methods

Constructors

constructor

new DigitalEventSyncService(): DigitalEventSyncService

Returns DigitalEventSyncService

Properties

Protected logger

logger: CcfLogger = ...

Static Private handleDigitalSync

handleDigitalSync: ((digitalEventSync: DigitalEventSync) => Promise<boolean>)

Type declaration

- (digitalEventSync: DigitalEventSync): Promise<boolean>
- Parameters
  - digitalEventSync: DigitalEventSync
  Returns Promise<boolean>

Static Private singleton

singleton: DigitalEventSyncService

Accessors

Static instance

get instance(): DigitalEventSyncService

- Defined in digital-sdk/src/lib/digital/service/digital-event-sync-service.ts:18
Retrieves the singleton instance of the DigitalEventSyncService. If the instance does not exist, it creates one.

example
const instance = DigitalEventSyncService.instance();

Returns DigitalEventSyncService
DigitalEventSyncService singleton instance.

Methods

handleDigitalEventSync

handleDigitalEventSync(digitalEventSync: DigitalEventSync): Promise<boolean>

- Defined in digital-sdk/src/lib/digital/service/digital-event-sync-service.ts:40
Handles the digital event synchronization by invoking the registered handler.

example
const result = digitalEventSyncService.handleDigitalEventSync(args);

Parameters
- digitalEventSync: DigitalEventSync
  
  The arguments required for digital event synchronization.
Returns Promise<boolean>
A boolean based on the result of the handler.

initDigitalEventSync

initDigitalEventSync(handler: ((digitalEventSync: DigitalEventSync) => Promise<boolean>)): void

- Defined in digital-sdk/src/lib/digital/service/digital-event-sync-service.ts:30
Initializes the digital event synchronization service with a custom handler.

example
digitalEventSyncService.initDigitalEventSync((args));

Parameters
- handler: ((digitalEventSync: DigitalEventSync) => Promise<boolean>)
  
  A callback function that processes digital event synchronization.
  - - (digitalEventSync: DigitalEventSync): Promise<boolean>
    - Parameters
      - digitalEventSync: DigitalEventSync
      Returns Promise<boolean>
Returns void

Generated using TypeDoc