Options
All
  • Public
  • Public/Protected
  • All
Menu

Class middleware

class
classdesc

Performs validation checks prior to socket api calls

extends

realTimeMiddlewareBase

Hierarchy

  • realTimeMiddlewareBase
    • middleware

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns middleware

Properties

Protected request

request: any

Protected resHeaders

resHeaders: any[] = []

Methods

authorizeUser

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

    authorizeUser

    description

    Authorizes a particular user

    Parameters

    • $data: any

      Token for a particular user

    • $user: any

      User details of the request sender

    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 fail

  • fail(message: string): Promise<Object>

  • Parameters

    • message: string

    Returns Promise<Object>

Protected log

  • log(message: string): void

  • Parameters

    • message: string

    Returns void

Protected next

  • next(): Promise<Object>

  • Returns Promise<Object>

userActivity

  • userActivity($user: any, $method: any): Promise<void>
  • function

    userActivity

    description

    Changes the status of the user according to his activity

    Parameters

    • $user: any

      User details of the request sender

    • $method: any

      Method name

    Returns Promise<void>

Generated using TypeDoc