Options
All
  • Public
  • Public/Protected
  • All
Menu

Class tickerSocket

class
classdesc

Consists of socket requests related to the users' component

extends

realTimeBase

Hierarchy

  • realTimeBase
    • tickerSocket

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns tickerSocket

Properties

Protected request

request: any

Protected resHeaders

resHeaders: any[] = []

Methods

addUserInTickerList

  • addUserInTickerList($user: any, $data: any): Promise<void>
  • function

    addUserInTickerList

    description

    A user has contacts with different users. A list is maintained for each of the users that he has had a conversation with. The api allows a user to add a particular user to your list.

    Parameters

    • $user: any

      User details of the sender

    • $data: any

      Data of user to be added into the list

    Returns Promise<void>

broadcast

  • broadcast(data: any): void

  • Parameters

    • data: any

    Returns void

broadcastAll

  • broadcastAll(data: any): void

  • Parameters

    • data: any

    Returns void

broadcastToSockets

  • broadcastToSockets(sockets: Array<string>, data: any): void

  • Parameters

    • sockets: Array<string>
    • data: any

    Returns void

emit

  • emit(data: any): void

  • Parameters

    • data: any

    Returns void

emitToGroup

  • emitToGroup(groupId: any, data: any): void

  • Parameters

    • groupId: any
    • data: any

    Returns void

Protected emitToRequest

  • emitToRequest(data: any): void

  • Parameters

    • data: any

    Returns void

Protected log

  • log(message: string): void

  • Parameters

    • message: string

    Returns void

ticker

  • ticker($data: any, $user: any): Promise<void>
  • function

    ticker

    description

    Whenever user goes out of focus or focusses in, other user(s) are informed about his status either online, away or offline.

    Parameters

    • $data: any
    • $user: any

      User details of the sender

    Returns Promise<void>

tickerAllUsers

  • tickerAllUsers($user: any, $data: any): Promise<void>
  • function

    tickerAllUsers

    description

    A user has contacts with different users. A list is maintained for each of the users that he has a contact with. The api gives all the users added into a particular user's list.

    Parameters

    • $user: any

      User details of the sender

    • $data: any

      User details

    Returns Promise<void>

Generated using TypeDoc