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.

Index

Constructors

Properties

baseRoute store

Methods

addRoute close onError start

Constructors

constructor

new ProvisioningApi(
store: ProvisioningStore,
opts?: ProvisioningApiOpts,
): ProvisioningApi
Parameters
- store: ProvisioningStore
- opts: ProvisioningApiOpts = {}
Returns ProvisioningApi
- Defined in src/provisioning/api.ts:132

Properties

`Protected`baseRoute

baseRoute: Router

`Protected`store

store: ProvisioningStore

Methods

addRoute

addRoute(
    method: Methods,
    path: string,
    handler: (
        req: ProvisioningRequest,
        res: Response,
        next?: NextFunction,
    ) => void | Promise<void>,
    fnName?: string,
): void
Parameters
- method: Methods
- path: string
- handler: (
      req: ProvisioningRequest,
      res: Response,
      next?: NextFunction,
  ) => void | Promise<void>
- OptionalfnName: string
Returns void
- Defined in src/provisioning/api.ts:217

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/provisioning/api.ts:213

`Protected`onError

onError(
    err:
        | Error
        | IApiError
        | [
            Error
            | IApiError,

                | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
                | ProvisioningRequest<{ [key: string]: string }, any, any, ParsedQs>,
        ],
    _req: Request,
    res: Response,
    _next: NextFunction,
): void
Parameters
- err:
      | Error
      | IApiError
      | [
          Error
          | IApiError,
  
              | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
              | ProvisioningRequest<{ [key: string]: string }, any, any, ParsedQs>,
      ]
- _req: Request
- res: Response
- _next: NextFunction
Returns void
- Defined in src/provisioning/api.ts:425

start

start(port: number, hostname?: string, backlog?: number): Promise<void>
Parameters
- port: number
- hostname: string = "0.0.0.0"
- backlog: number = 10
Returns Promise<void>
- Defined in src/provisioning/api.ts:202