package
3.13.0+incompatible
Repository: https://github.com/firebase/firebase-admin-go.git
Documentation: pkg.go.dev

# Functions

CreatePlatformError parses the response payload as a GCP error response and create an error from the details extracted.
Error creates a new FirebaseError from the specified error code and message.
Errorf creates a new FirebaseError from the specified error code and message.
HasErrorCode checks if the given error contain a specific error code.
HasSuccessStatus returns true if the response status code is in the 2xx range.
NewHTTPClient creates a new HTTPClient using the provided client options and the default RetryConfig.
NewJSONEntity creates a new HTTPEntity that will be serialized into JSON.
WithDefaultRetryConfig creates a new HTTPClient using the provided client and the default RetryConfig.
WithHeader creates an HTTPOption that will set an HTTP header on the request.
WithQueryParam creates an HTTPOption that will set a query parameter on the request.
WithQueryParams creates an HTTPOption that will set all the entries of qp as query parameters on the request.

# Variables

FirebaseScopes is the set of OAuth2 scopes used by the Admin SDK.
SystemClock is a clock that returns local time of the system.

# Structs

AuthConfig represents the configuration of Firebase Auth service.
DatabaseConfig represents the configuration of Firebase Database service.
FirebaseError is an error type containing an error code string.
HTTPClient is a convenient API to make HTTP calls.
InstanceIDConfig represents the configuration of Firebase Instance ID service.
MessagingConfig represents the configuration of Firebase Cloud Messaging service.
MockClock can be used to mock current time during tests.
MockTokenSource is a TokenSource implementation that can be used for testing.
Request contains all the parameters required to construct an outgoing HTTP request.
Response contains information extracted from an HTTP response.
RetryConfig specifies how the HTTPClient should retry failing HTTP requests.
StorageConfig represents the configuration of Google Cloud Storage service.

# Interfaces

Clock is used to query the current local time.
HTTPEntity represents a payload that can be included in an outgoing HTTP request.

# Type aliases

CreateErrFn is a function that creates an error from a given Response.
ErrorParser is a function that is used to construct custom error messages.
HashConfig represents a hash algorithm configuration used to generate password hashes.
HTTPOption is an additional parameter that can be specified to customize an outgoing request.
RetryCondition determines if an HTTP request should be retried depending on its last outcome.
SuccessFn is a function that checks if a Response indicates success.