Class ServerEventsClient

Hierarchy

ServerEventsClient

Constructors

constructor

new ServerEventsClient(baseUrl: string, channels: string[], options?: IEventSourceOptions, eventSource?: IEventSourceStatic): ServerEventsClient

- Defined in client.d.ts:310
Parameters
- baseUrl: string
- channels: string[]
- Optional options: IEventSourceOptions
- Optional eventSource: IEventSourceStatic
Returns ServerEventsClient

Properties

EventSource

EventSource: IEventSourceStatic

_onMessage

_onMessage: ((e: IOnMessageEvent) => void)

Type declaration

- (e: IOnMessageEvent): void
- Parameters
  - e: IOnMessageEvent
  Returns void

channels

channels: string[]

connectionInfo

connectionInfo: ServerEventConnect

eventSource

eventSource: IEventSourceStatic

eventStreamUri

eventStreamUri: string

listeners

listeners: {}

Type declaration

[index: string]: ((e: ServerEventMessage) => void)[]

onError

onError: ((error?: any) => void)

Type declaration

- (error?: any): void
- Parameters
  - Optional error: any
  Returns void

onMessage

onMessage: ((e: IOnMessageEvent) => void)

Type declaration

- (e: IOnMessageEvent): void
- Parameters
  - e: IOnMessageEvent
  Returns void

options

options: IEventSourceOptions

resolver

resolver: IResolver

serviceClient

serviceClient: JsonServiceClient

stopped

stopped: boolean

updateSubscriberUrl

updateSubscriberUrl: string

withCredentials

withCredentials: boolean

Static UnknownChannel

UnknownChannel: string

Methods

addListener

addListener(eventName: string, handler: ((e: ServerEventMessage) => void)): ServerEventsClient

- Defined in client.d.ts:329
Parameters
- eventName: string
- handler: ((e: ServerEventMessage) => void)
  - - (e: ServerEventMessage): void
    - Parameters
      - e: ServerEventMessage
      Returns void
Returns ServerEventsClient

getChannelSubscribers

getChannelSubscribers(): Promise<ServerEventUser[]>

- Defined in client.d.ts:337
Returns Promise<ServerEventUser[]>

getConnectionInfo

getConnectionInfo(): ServerEventConnect

- Defined in client.d.ts:332
Returns ServerEventConnect

getEventSourceOptions

getEventSourceOptions(): { withCredentials: boolean }

- Defined in client.d.ts:314
Returns { withCredentials: boolean }
- withCredentials: boolean

getSubscriptionId

getSubscriptionId(): string

- Defined in client.d.ts:333
Returns string

hasConnected

hasConnected(): boolean

- Defined in client.d.ts:321
Returns boolean

invokeReceiver

invokeReceiver(r: any, cmd: string, el: Element, request: ServerEventMessage, name: string): void

- Defined in client.d.ts:320
Parameters
- r: any
- cmd: string
- el: Element
- request: ServerEventMessage
- name: string
Returns void

raiseEvent

raiseEvent(eventName: string, msg: ServerEventMessage): void

- Defined in client.d.ts:331
Parameters
- eventName: string
- msg: ServerEventMessage
Returns void

reconnectServerEvents

reconnectServerEvents(opt?: IReconnectServerEventsOptions): IEventSourceStatic

- Defined in client.d.ts:317
Parameters
- Optional opt: IReconnectServerEventsOptions
Returns IEventSourceStatic

registerHandler

registerHandler(name: string, fn: Function): ServerEventsClient

- Defined in client.d.ts:322
Parameters
- name: string
- fn: Function
Returns ServerEventsClient

registerNamedReceiver

registerNamedReceiver(name: string, receiver: any): ServerEventsClient

- Defined in client.d.ts:325
Parameters
- name: string
- receiver: any
Returns ServerEventsClient

registerReceiver

registerReceiver(receiver: any): ServerEventsClient

- Defined in client.d.ts:324
Parameters
- receiver: any
Returns ServerEventsClient

removeListener

removeListener(eventName: string, handler: ((e: ServerEventMessage) => void)): ServerEventsClient

- Defined in client.d.ts:330
Parameters
- eventName: string
- handler: ((e: ServerEventMessage) => void)
  - - (e: ServerEventMessage): void
    - Parameters
      - e: ServerEventMessage
      Returns void
Returns ServerEventsClient

setResolver

setResolver(resolver: IResolver): ServerEventsClient

- Defined in client.d.ts:323
Parameters
- resolver: IResolver
Returns ServerEventsClient

start

start(): ServerEventsClient

- Defined in client.d.ts:318
Returns ServerEventsClient

stop

stop(): Promise<void>

- Defined in client.d.ts:319
Returns Promise<void>

subscribeToChannels

subscribeToChannels(...channels: string[]): Promise<void>

- Defined in client.d.ts:335
Parameters
- Rest ...channels: string[]
Returns Promise<void>

toServerEventUser

toServerEventUser(map: {}): ServerEventUser

- Defined in client.d.ts:338
Parameters
- map: {}
  - [id: string]: string
Returns ServerEventUser

unregisterReceiver

unregisterReceiver(name?: string): ServerEventsClient

- Defined in client.d.ts:326
Parameters
- Optional name: string
Returns ServerEventsClient

unsubscribeFromChannels

unsubscribeFromChannels(...channels: string[]): Promise<void>

- Defined in client.d.ts:336
Parameters
- Rest ...channels: string[]
Returns Promise<void>

update

update(subscribe: string | string[], unsubscribe: string | string[]): void

- Defined in client.d.ts:328
Parameters
- subscribe: string | string[]
- unsubscribe: string | string[]
Returns void

updateChannels

updateChannels(channels: string[]): void

- Defined in client.d.ts:327
Parameters
- channels: string[]
Returns void

updateSubscriber

updateSubscriber(request: UpdateEventSubscriber): Promise<void>

- Defined in client.d.ts:334
Parameters
- request: UpdateEventSubscriber
Returns Promise<void>

Generated using TypeDoc