Options
All
  • Public
  • Public/Protected
  • All
Menu

Class socketService

class
classdesc

Consists of methods related to sockets

Hierarchy

  • realTimeBase
    • socketService

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns socketService

Properties

Protected request

request: any

Protected resHeaders

resHeaders: any[] = []

Methods

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

emitToSelf

  • emitToSelf(userId: string, data: any): Promise<void>
  • function

    emitToSelf

    description

    Emits to all socketIDs of a particular user

    Parameters

    • userId: string

      UserID of the user

    • data: any

      Data that is to be transmitted

    Returns Promise<void>

groupBroadcast

  • groupBroadcast(groupId: string, userId: string): Promise<any>
  • function

    groupBroadcast

    description

    Emits to all socketIDs of a particular group except the requestor

    Parameters

    • groupId: string

      ID of the conversation group

    • userId: string

      UserID of the user

    Returns Promise<any>

    Returns an array of socket IDs

Protected log

  • log(message: string): void

  • Parameters

    • message: string

    Returns void

Generated using TypeDoc