SyncUiEventDispatcher Class
This class is used to send eventIds to interested UI components so the component can determine if it needs to refresh its display by calling setState on itself.
Methods
| Name | Description | |
|---|---|---|
| constructor(): SyncUiEventDispatcher | ||
| clearConnectionEvents(iModelConnection: IModelConnection): void Static | This should be called by IModelApp when the active IModelConnection is closed. | |
| dispatchImmediateSyncUiEvent(eventId: string): void Static | Immediately trigger sync event processing. | |
| dispatchSyncUiEvent(eventId: string): void Static | Save eventId in Set for processing. | |
| dispatchSyncUiEvents(eventIds: string[]): void Static | Save multiple eventIds in Set for processing. | |
| hasEventOfInterest(eventIds: Set<string>, idsOfInterest: string[]): boolean Static | Checks to see if an eventId of interest is contained in the set of eventIds | |
| initialize(): void Static | Initializes the Monitoring of Events that trigger dispatching sync events | |
| initializeConnectionEvents(iModelConnection: IModelConnection): void Static | This should be called by IModelApp when the active IModelConnection is established. | |
| setTimeoutPeriod(period: number): void Static |
Properties
| Name | Type | Description | |
|---|---|---|---|
| onSyncUiEvent Accessor Static ReadOnly | UiSyncEvent | Return SyncUiEvent so callers can register an event callback. | |
| syncEventIds Accessor Static ReadOnly | Set<string> | Return set of event ids that will be sent to listeners/. |
Defined in
Last Updated: 14 November, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.