Options
All
  • Public
  • Public/Protected
  • All
Menu

PushChannel is an abstraction over a websocket connection that provides an easy way to observe updates for events and tasks within the authenticated user's environment. Channels can be scoped to a single company or to all companies that the authenticated user has access to. You must close the channel when you've finished using it in order to close and clean up the underlying websocket.

Hierarchy

  • PushChannel

Index

Methods

close

  • close(): void
  • Closes the underlying websocket connection. This method should always be called when the channel is no longer in use.

    Returns void

getObservable

  • Gets an observable for push updates. Updates will be emitted for all entities that the authenticated user has access to.

    Returns Observable<Event | Task>

    push update observable

Static open

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc