Class OAuthProvider

Index

Accessors

Constructors

Methods

addScope credential getCustomParameters getScopes setCustomParameters credentialFromError credentialFromJSON credentialFromResult

Accessors

PROVIDER_ID

get PROVIDER_ID(): string
Returns string
- Defined in auth/lib/providers/OAuthProvider.ts:118

Constructors

constructor

new OAuthProvider(providerId: string): OAuthProvider
Parameters
- providerId: string
Returns OAuthProvider
- Defined in auth/lib/providers/OAuthProvider.ts:78

Methods

addScope

addScope(scope: string): OAuthProvider
Parameters
- scope: string
Returns OAuthProvider
- Defined in auth/lib/providers/OAuthProvider.ts:131

credential

credential(params: OAuthCredentialOptions): OAuthCredential
Parameters
- params: OAuthCredentialOptions
Returns OAuthCredential
- Defined in auth/lib/providers/OAuthProvider.ts:110

getCustomParameters

getCustomParameters(): CustomParameters
Returns CustomParameters
- Defined in auth/lib/providers/OAuthProvider.ts:127

getScopes

getScopes(): string[]
Returns string[]
- Defined in auth/lib/providers/OAuthProvider.ts:138

setCustomParameters

setCustomParameters(customOAuthParameters: CustomParameters): OAuthProvider
Parameters
- customOAuthParameters: CustomParameters
Returns OAuthProvider
- Defined in auth/lib/providers/OAuthProvider.ts:122

`Static`credentialFromError

credentialFromError(_error: AuthError): OAuthCredential | null
Parameters
- _error: AuthError
Returns OAuthCredential | null
Remarks
Always returns null on React Native Firebase.
- Defined in auth/lib/providers/OAuthProvider.ts:106

`Static`credentialFromJSON

credentialFromJSON(json: string | object): OAuthCredential
Parameters
- json: string | object
Returns OAuthCredential
- Defined in auth/lib/providers/OAuthProvider.ts:90

`Static`credentialFromResult

credentialFromResult(_userCredential: UserCredential): OAuthCredential | null
Parameters
- _userCredential: UserCredential
Returns OAuthCredential | null
Remarks
Always returns null on React Native Firebase.
- Defined in auth/lib/providers/OAuthProvider.ts:101