React Native Firebase
    Preparing search index...

    Interface OAuthProvider

    Interface that represents an OAuth provider. Implemented by other providers.

    interface OAuthProvider {
        new OAuthProvider(providerId: string): FirebaseAuthTypes.OAuthProvider;
        addScope: (scope: string) => AuthProvider;
        credential: (token: string | null, secret?: string) => AuthCredential;
        getCustomParameters: () => Record<string, string>;
        getScopes: () => string[];
        PROVIDER_ID: string;
        setCustomParameters: (
            customOAuthParameters: Record<string, string>,
        ) => AuthProvider;
    }

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    addScope credential getCustomParameters getScopes PROVIDER_ID setCustomParameters

    Constructors

    Properties

    addScope: (scope: string) => AuthProvider

    Add an OAuth scope to the credential.

    Type Declaration

    credential: (token: string | null, secret?: string) => AuthCredential

    Creates a new AuthCredential.

    Type Declaration

    getCustomParameters: () => Record<string, string>

    Retrieve the current list of custom parameters.

    Type Declaration

      • (): Record<string, string>

      • Returns Record<string, string>

        The current map of OAuth custom parameters.

    getScopes: () => string[]

    Retrieve the current list of OAuth scopes.

    PROVIDER_ID: string

    The provider ID of the provider.

    setCustomParameters: (
        customOAuthParameters: Record<string, string>,
    ) => AuthProvider

    Sets the OAuth custom parameters to pass in an OAuth request for sign-in operations.

    Type Declaration

      • (customOAuthParameters: Record<string, string>): AuthProvider

      • Parameters

        • customOAuthParameters: Record<string, string>

          The custom OAuth parameters to pass in the OAuth request.

        Returns AuthProvider

    For a detailed list, check the reserved required OAuth 2.0 parameters such as client_id, redirect_uri, scope, response_type, and state are not allowed and will be ignored.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties