Class QueryStringAuthenticator

Hierarchy-Diagram

UML class diagram of QueryStringAuthenticator

Legend

icon for a class in the UML class diagram

class

icon for an interface in the UML class diagram

interface

icon for a protected property in the UML class diagram

protected property

icon for a public method in the UML class diagram

public method

Hierarchy

QueryStringAuthenticator

Implements

TapjawAuthenticator<QueryParameters>

Index

Constructors

constructor

Properties

queryParameters

Methods

Constructors

constructor

new QueryStringAuthenticator(queryParameters: QueryParameters): QueryStringAuthenticator

- Defined in src/authenticators/query-string-authenticator.ts:6
Parameters
- queryParameters: QueryParameters
Returns QueryStringAuthenticator

Properties

Protected Readonly queryParameters

queryParameters: QueryParameters

Methods

authenticate

authenticate(): Promise<QueryParameters>

Implementation of TapjawAuthenticator.authenticate
- Defined in src/authenticators/query-string-authenticator.ts:12
Run authentication routine and pass the authentication data into the connector.

Returns Promise<QueryParameters>

isAuthenticated

isAuthenticated(): boolean

Implementation of TapjawAuthenticator.isAuthenticated
- Defined in src/authenticators/query-string-authenticator.ts:8
Whether the authentication has occurred.

Returns boolean
boolean

Generated using TypeDoc