Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CvEventRegistry

The CvEventRegistry handles decoupled communication between components. Any component may subscribe to and publish CvEvents. See also CvListener and CvEventType. It also provides resource caching (i.e. caching of some server provided objects to allow retrieval by 'id')

Hierarchy

  • CvEventRegistry

Index

Constructors

constructor

Properties

Private _cache

_cache: object = null

Type declaration

Private _listenerMap

_listenerMap: object = []

Type declaration

Methods

cacheObjectAt

  • cacheObjectAt(id: string, obj: any): void
  • Parameters

    • id: string
    • obj: any

    Returns void

clearAll

  • clearAll(): void
  • Returns void

clearCache

  • clearCache(): void
  • Returns void

disableCache

  • disableCache(): void
  • Returns void

enableCache

  • enableCache(): void
  • Returns void

getEventByKey

  • getEventByKey<T>(key: string): CvEvent<T>
  • Type parameters

    • T

    Parameters

    • key: string

    Returns CvEvent<T>

isCacheEnabled

  • isCacheEnabled(): boolean
  • Returns boolean

publish

  • publish<T>(event: CvEvent<T>, shouldCache?: boolean): void
  • Type parameters

    • T

    Parameters

    • event: CvEvent<T>
    • Default value shouldCache: boolean = false

    Returns void

publishError

  • publishError(message: string, messageObj?: string): void
  • Parameters

    • message: string
    • Optional messageObj: string

    Returns void

removeAllListeners

  • removeAllListeners(): void
  • Returns void

removeFromCache

  • removeFromCache(key: string): void
  • Parameters

    • key: string

    Returns void

subscribe

  • Type parameters

    • T

    Parameters

    Returns void

unsubscribe

  • Parameters

    Returns void

Generated using TypeDoc