Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceRequest

Data object that encapsulates all informations about an HTTP Request

Hierarchy

  • ServiceRequest

Index

Constructors

Methods

Constructors

constructor

  • Returns ServiceRequest

  • Parameters

    Returns ServiceRequest

Methods

getExtra

  • getExtra(): {}

  • Get extra payload

    Returns {}

    • [key: string]: any

getHeaders

  • getHeaders(): MultiMap

  • Get request headers

    Returns MultiMap

getParams

  • getParams(): {}

  • Get request parsedParameters as JSON

    Returns {}

    • [key: string]: any

getUser

  • getUser(): {}

  • Get request principal user as routingContext.user().principal(), null if no user is authenticated

    Returns {}

    • [key: string]: any

setExtra

  • Get extra payload

    Parameters

    • extra: {}
      • [key: string]: any

    Returns ServiceRequest

setHeaders

  • Get request headers

    Parameters

    • headers: MultiMap

    Returns ServiceRequest

setParams

  • Get request parsedParameters as JSON

    Parameters

    • params: {}
      • [key: string]: any

    Returns ServiceRequest

setUser

  • Get request principal user as routingContext.user().principal(), null if no user is authenticated

    Parameters

    • user: {}
      • [key: string]: any

    Returns ServiceRequest

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc