Class ProvisioningApi

The provisioning API serves two classes of clients:

  • Integration managers which provide a unique secret token, and a userId
  • Widget users which provide a openId token.

Constructors

constructor

Properties

baseRoute store

Methods

addRoute close onError start

Constructors

constructor

Properties

Protected baseRoute

baseRoute: Router

Protected store

store: ProvisioningStore

Methods

addRoute

  • addRoute(method, path, handler, fnName?): void

  • Parameters

    • method: Methods
    • path: string
    • handler: ((req, res, next?) => void | Promise<void>)
        • (req, res, next?): void | Promise<void>

        • Parameters

          • req: ProvisioningRequest<{
                [key: string]: string;
            }, any, any, ParsedQs>
          • res: Response<any, Record<string, any>>
          • Optional next: NextFunction

          Returns void | Promise<void>

    • Optional fnName: string

    Returns void

close

  • close(): Promise<void>

  • Returns Promise<void>

Protected onError

  • onError(err, _req, res, _next): void

  • Parameters

    • err: Error | IApiError | [Error | IApiError, Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>> | ProvisioningRequest<{
          [key: string]: string;
      }, any, any, ParsedQs>]
    • _req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
    • res: Response<any, Record<string, any>>
    • _next: NextFunction

    Returns void

start

  • start(port, hostname?, backlog?): Promise<void>

  • Parameters

    • port: number
    • hostname: string = "0.0.0.0"
    • backlog: number = 10

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc