Class TwitterServerAuthenticator

Hierarchy

TwitterServerAuthenticator

Implements

ServerAuthenticator<never, TwitterAuthData, TwitterAuthContext>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TwitterServerAuthenticator(bot: TwitterBot, basicAuthenticator: BasicAuthenticator): TwitterServerAuthenticator

- Defined in packages/twitter/src/webview/ServerAuthenticator.ts:30
Parameters
- bot: TwitterBot
- basicAuthenticator: BasicAuthenticator
Returns TwitterServerAuthenticator

Properties

basicAuthenticator

basicAuthenticator: BasicAuthenticator

bot

bot: TwitterBot

delegateAuthRequest

delegateAuthRequest: (req: IncomingMessage, res: ServerResponse, routingInfo: Required<RoutingInfo>) => Promise<void>

Type declaration

- (req: IncomingMessage, res: ServerResponse, routingInfo: Required<RoutingInfo>): Promise<void>
- Handle requests required in the auth flow, for the most of time, it's used for redirecting user-agent from/to other identity provider (IdP). Any request match route "/{platform}/*" would be delegated to this method, and it's responsible to close the the server response.
  
  Parameters
  - req: IncomingMessage
  - res: ServerResponse
  - routingInfo: Required<RoutingInfo>
  Returns Promise<void>

platform

platform: "twitter" = TWITTER

Methods

checkAuthData

checkAuthData(data: TwitterAuthData): CheckDataResult<TwitterAuthContext>

Implementation of ServerAuthenticator.checkAuthData
- Defined in packages/twitter/src/webview/ServerAuthenticator.ts:86
Called before the authorization finish, you can make some simple non-async final checks. Return the auth context supplement if success.

Parameters
- data: TwitterAuthData
Returns CheckDataResult<TwitterAuthContext>

getAuthUrl

getAuthUrl(userId: string, redirectUrl?: string): string

- Defined in packages/twitter/src/webview/ServerAuthenticator.ts:60
Parameters
- userId: string
- Optional redirectUrl: string
Returns string

verifyCredential

verifyCredential(): Promise<VerifyResult<TwitterAuthData>>

Implementation of ServerAuthenticator.verifyCredential
- Defined in packages/twitter/src/webview/ServerAuthenticator.ts:69
Called when sign requests from client side are received, controller would sign in the user by issuing a token to client and signing a signature wihtin cookie if it resolve success.

Returns Promise<VerifyResult<TwitterAuthData>>

verifyRefreshment

verifyRefreshment(data: TwitterAuthData): Promise<VerifyResult<TwitterAuthData>>

Implementation of ServerAuthenticator.verifyRefreshment
- Defined in packages/twitter/src/webview/ServerAuthenticator.ts:77
Called when refresh requests from client side are received, controller would refresh token and signature if it resolve success.

Parameters
- data: TwitterAuthData
Returns Promise<VerifyResult<TwitterAuthData>>

Generated using TypeDoc