internal

type AuthConfig ¶

type AuthConfig struct {
	Opts      []option.ClientOption
	Creds     *google.DefaultCredentials
	ProjectID string
	Version   string
}

AuthConfig represents the configuration of Firebase Auth service.

type DatabaseConfig ¶

type DatabaseConfig struct {
	Opts         []option.ClientOption
	URL          string
	Version      string
	AuthOverride map[string]interface{}
}

DatabaseConfig represents the configuration of Firebase Database service.

type ErrorParser ¶

type ErrorParser func([]byte) string

ErrorParser is a function that is used to construct custom error messages.

type FirebaseError ¶

type FirebaseError struct {
	Code   string
	String string
}

FirebaseError is an error type containing an error code string.

func Error(code string, msg string) *FirebaseError

func Errorf(code string, msg string, args ...interface{}) *FirebaseError

func (fe *FirebaseError) Error() string

type HTTPClient ¶

type HTTPClient struct {
	Client    *http.Client
	ErrParser ErrorParser
}

HTTPClient is a convenient API to make HTTP calls.

This API handles some of the repetitive tasks such as entity serialization and deserialization involved in making HTTP calls. It provides a convenient mechanism to set headers and query parameters on outgoing requests, while enforcing that an explicit context is used per request. Responses returned by HTTPClient can be easily parsed as JSON, and provide a simple mechanism to extract error details.

func (c *HTTPClient) Do(ctx context.Context, r *Request) (*Response, error)

type HTTPEntity ¶

type HTTPEntity interface {
	Bytes() ([]byte, error)
	Mime() string
}

HTTPEntity represents a payload that can be included in an outgoing HTTP request.

func NewJSONEntity(v interface{}) HTTPEntity

type HTTPOption ¶

type HTTPOption func(*http.Request)

HTTPOption is an additional parameter that can be specified to customize an outgoing request.

func WithHeader(key, value string) HTTPOption

func WithQueryParam(key, value string) HTTPOption

func WithQueryParams(qp map[string]string) HTTPOption

type HashConfig ¶

type HashConfig struct {
	HashAlgorithm    string
	MemoryCost       int64
	Rounds           int64
	SaltSeparator    string
	SignerKey        string
	BlockSize        int64
	DerivedKeyLength int64
	Parallelization  int64
	ForceSendFields  []string
}

HashConfig represents a hash algorithm configuration used to generate password hashes.

type InstanceIDConfig ¶

type InstanceIDConfig struct {
	Opts      []option.ClientOption
	ProjectID string
}

InstanceIDConfig represents the configuration of Firebase Instance ID service.

type MessagingConfig ¶

type MessagingConfig struct {
	Opts      []option.ClientOption
	ProjectID string
	Version   string
}

MessagingConfig represents the configuration of Firebase Cloud Messaging service.

type MockTokenSource ¶

type MockTokenSource struct {
	AccessToken string
}

MockTokenSource is a TokenSource implementation that can be used for testing.

func (ts *MockTokenSource) Token() (*oauth2.Token, error)

type Request ¶

type Request struct {
	Method string
	URL    string
	Body   HTTPEntity
	Opts   []HTTPOption
}

Request contains all the parameters required to construct an outgoing HTTP request.

type Response ¶

type Response struct {
	Status int
	Header http.Header
	Body   []byte
	// contains filtered or unexported fields
}

Response contains information extracted from an HTTP response.

func (r *Response) CheckStatus(want int) error

func (r *Response) Unmarshal(want int, v interface{}) error

type StorageConfig ¶

type StorageConfig struct {
	Opts   []option.ClientOption
	Bucket string
}

StorageConfig represents the configuration of Google Cloud Storage service.