Class TwitterUserAuth

A user authentication token manager.

Hierarchy

TwitterGuestAuth
- TwitterUserAuth

Constructors

constructor

new TwitterUserAuth(bearerToken, options?): TwitterUserAuth
Parameters
- bearerToken: string
- Optional options: Partial<TwitterAuthOptions>
Returns TwitterUserAuth
Overrides TwitterGuestAuth.constructor
- Defined in src/auth-user.ts:56

Properties

`Protected` bearerToken

bearerToken: string

fetch

fetch: {
(input, init?): Promise<Response>;
(input, init?): Promise<Response>;
}

Type declaration

- (input, init?): Promise<Response>
- MDN Reference
  Parameters
  - input: RequestInfo | URL
  - Optional init: RequestInit
  Returns Promise<Response>
- (input, init?): Promise<Response>
- Parameters
  - input: string | Request | URL
  - Optional init: RequestInit
  Returns Promise<Response>

`Protected` `Optional` guestCreatedAt

guestCreatedAt?: Date

`Protected` `Optional` guestToken

guestToken?: string

`Protected` jar

jar: CookieJar

`Protected` `Optional` `Readonly` options

options?: Partial<TwitterAuthOptions>

Methods

authenticatedAt

authenticatedAt(): null | Date
Returns the time that authentication was performed.

Returns null | Date
The time at which the authentication token was created, or null if it hasn't been created yet.
Inherited from TwitterGuestAuth.authenticatedAt
- Defined in src/auth.ts:138

cookieJar

cookieJar(): CookieJar
Returns the current cookie jar.

Returns CookieJar
Inherited from TwitterGuestAuth.cookieJar
- Defined in src/auth.ts:110

deleteToken

deleteToken(): void
Deletes the current guest token token.

Returns void
Inherited from TwitterGuestAuth.deleteToken
- Defined in src/auth.ts:129

`Private` executeFlowTask

executeFlowTask(data): Promise<FlowTokenResult>
Parameters
- data: TwitterUserAuthFlowRequest
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:318

`Protected` getCookieString

getCookieString(): Promise<string>
Returns Promise<string>
Inherited from TwitterGuestAuth.getCookieString
- Defined in src/auth.ts:172

`Protected` getCookies

getCookies(): Promise<Cookie[]>
Returns Promise<Cookie[]>
Inherited from TwitterGuestAuth.getCookies
- Defined in src/auth.ts:168

`Private` handleAccountDuplicationCheck

handleAccountDuplicationCheck(prev): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:251

`Private` handleAcid

handleAcid(prev, email): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
- email: undefined | string
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:293

`Private` handleEnterAlternateIdentifierSubtask

handleEnterAlternateIdentifierSubtask(prev, email): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
- email: string
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:190

`Private` handleEnterPassword

handleEnterPassword(prev, password): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
- password: string
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:233

`Private` handleEnterUserIdentifierSSO

handleEnterUserIdentifierSSO(prev, username): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
- username: string
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:208

`Private` handleJsInstrumentationSubtask

handleJsInstrumentationSubtask(prev): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:175

`Private` handleSuccessSubtask

handleSuccessSubtask(prev): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:311

`Private` handleTwoFactorAuthChallenge

handleTwoFactorAuthChallenge(prev, secret): Promise<FlowTokenResult>
Parameters
- prev: FlowTokenResultSuccess
- secret: string
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:265

hasToken

hasToken(): boolean
Returns if the authentication state has a token.

Returns boolean
true if the authentication state has a token; false otherwise.
Inherited from TwitterGuestAuth.hasToken
- Defined in src/auth.ts:134

`Private` initLogin

initLogin(): Promise<FlowTokenResult>
Returns Promise<FlowTokenResult>
- Defined in src/auth-user.ts:147

installCsrfToken

installCsrfToken(headers): Promise<void>
Parameters
- headers: Headers$1
Returns Promise<void>
- Defined in src/auth-user.ts:133

installTo

installTo(headers): Promise<void>
Installs the authentication information into a headers-like object. If needed, the authentication token will be updated from the API automatically.
Parameters
- headers: Headers$1
  
  A Headers instance representing a request's headers.
Returns Promise<void>
Overrides TwitterGuestAuth.installTo
- Defined in src/auth-user.ts:141

isLoggedIn

isLoggedIn(): Promise<boolean>
Returns if a user is logged-in to Twitter through this instance.

Returns Promise<boolean>
true if a user is logged-in; otherwise false.
Overrides TwitterGuestAuth.isLoggedIn
- Defined in src/auth-user.ts:60

login

login(username, password, email?, twoFactorSecret?): Promise<void>
Logs into a Twitter account.
Parameters
- username: string
  
  The username to log in with.
- password: string
  
  The password to log in with.
- Optional email: string
  
  The email to log in with, if you have email confirmation enabled.
- Optional twoFactorSecret: string
Returns Promise<void>
Overrides TwitterGuestAuth.login
- Defined in src/auth-user.ts:73

logout

logout(): Promise<void>
Logs out of the current session.

Returns Promise<void>
Overrides TwitterGuestAuth.logout
- Defined in src/auth-user.ts:119

`Protected` removeCookie

removeCookie(key): Promise<void>
Parameters
- key: string
Returns Promise<void>
Inherited from TwitterGuestAuth.removeCookie
- Defined in src/auth.ts:176

`Protected` updateGuestToken

updateGuestToken(): Promise<void>
Updates the authentication state with a new guest token from the Twitter API.

Returns Promise<void>
Inherited from TwitterGuestAuth.updateGuestToken
- Defined in src/auth.ts:199