firebase

package
v0.2.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2026 License: Apache-2.0 Imports: 15 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	MaxFCMTokens = 500
)

Variables

View Source 
var (
	TargetLanguageKey  = contract.ToPubSubKey("target_language")
	UserIDsKey         = contract.ToPubSubKey("user_ids")
	EnglishTitleKey    = contract.ToPubSubKey("english_title")
	EnglishBodyKey     = contract.ToPubSubKey("english_body")
	PathCustomImageKey = contract.ToPubSubKey("path_custom_image")
	URLCustomSoundKey  = contract.ToPubSubKey("url_custom_sound")
	CustomDataKey      = contract.ToPubSubKey("custom_data")
	NotifKKey          = contract.ToPubSubKey("notif_k")
)

Functions

This section is empty.

Types

type Blackbox 

type Blackbox interface {
	// contains filtered or unexported methods
}

type Client 

type Client interface {
	Blackbox
	contract.FirebaseOperator
}

func NewClient 

func NewClient(ctx context.Context, d Dependencies, opts ClientOptions) (Client, error)

func NewNoopClient added in v0.1.859 

func NewNoopClient() Client

type ClientOption added in v0.1.123 

type ClientOption = contract.Opt[ClientOptions]

func WithAPIKey added in v0.1.123 

func WithAPIKey(x string) ClientOption

func WithAPIKeyMod added in v0.1.124 

func WithAPIKeyMod(x string) ClientOption

func WithApp added in v0.1.175 

func WithApp(x *firebase.App) ClientOption

func WithCredentialsJSON added in v0.1.123 

func WithCredentialsJSON(x []byte) ClientOption

func WithCredentialsJSONMod added in v0.1.123 

func WithCredentialsJSONMod(x []byte) ClientOption

func WithInitialized added in v0.1.175 

func WithInitialized(x Initialized) ClientOption

func WithLoaded added in v0.1.163 

func WithLoaded(x Loaded) ClientOption

func WithModApp added in v0.1.175 

func WithModApp(x *firebase.App) ClientOption

type ClientOptions added in v0.1.123 

type ClientOptions struct {
	Loaded
	Initialized
}

func ApplyClientOptions added in v0.1.123 

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool added in v0.1.11 

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool 

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) AuthenticateFirebaseIDToken added in v0.1.178 

func (d *DefaultTool) AuthenticateFirebaseIDToken(ctx context.Context, opts contract.AuthenticateFirebaseIDTokenOptions) error

AuthenticateFirebaseIDToken authenticates a Firebase ID token.

func (*DefaultTool) BatchSendNotif added in v0.1.583 

func (d *DefaultTool) BatchSendNotif(ctx context.Context, opts contract.NotificationOptions) (*contract.BatchSendResult, error)

BatchSendNotif sends notifications. 

func (d *DefaultTool) CreateFirebaseEmailSignInLink(ctx context.Context, opts contract.CreateFirebaseEmailSignInLinkOptions) (string, error)

CreateFirebaseEmailSignInLink creates a Firebase email sign-in link. 

func (d *DefaultTool) CreateFirebaseEmailVerificationLink(ctx context.Context, opts contract.CreateFirebaseEmailVerificationLinkOptions) (string, error)

CreateFirebaseEmailVerificationLink creates a Firebase email verification link. 

func (d *DefaultTool) CreateFirebasePasswordResetLink(ctx context.Context, opts contract.CreateFirebasePasswordResetLinkOptions) (string, error)

CreateFirebasePasswordResetLink creates a Firebase password reset link.

func (*DefaultTool) CreateFirebaseTestUser added in v0.1.1131 

func (d *DefaultTool) CreateFirebaseTestUser(ctx context.Context) (*contract.FirebaseUserCredentials, error)

CreateFirebaseTestUser creates a Firebase test user.

func (*DefaultTool) CreateFirebaseUser added in v0.1.1131 

func (d *DefaultTool) CreateFirebaseUser(ctx context.Context, opts contract.CreateFirebaseUserOptions) (*contract.FirebaseUserRecord, error)

CreateFirebaseUser creates a Firebase user.

func (*DefaultTool) DeleteFirebaseUser added in v0.1.1131 

func (d *DefaultTool) DeleteFirebaseUser(ctx context.Context, opts contract.DeleteFirebaseUserOptions) error

DeleteFirebaseUser deletes a Firebase user.

func (*DefaultTool) DeleteFirebaseUserByEmail added in v0.1.1131 

func (d *DefaultTool) DeleteFirebaseUserByEmail(ctx context.Context, opts contract.DeleteFirebaseUserByEmailOptions) error

DeleteFirebaseUserByEmail deletes a Firebase user by email.

func (*DefaultTool) FirebaseAPIKey added in v0.1.1131 

func (d *DefaultTool) FirebaseAPIKey(ctx context.Context, opts contract.FirebaseAPIKeyOptions) (string, error)

FirebaseAPIKey returns the Firebase API key.

func (*DefaultTool) FirebaseIDToken added in v0.1.178 

func (d *DefaultTool) FirebaseIDToken(ctx context.Context, opts contract.FirebaseIDTokenOptions) (string, error)

FirebaseIDToken exchanges Firebase credentials for an ID token.

func (*DefaultTool) FirebaseUIDFromRequest added in v0.1.1131 

func (d *DefaultTool) FirebaseUIDFromRequest(ctx context.Context, opts contract.FirebaseUIDFromRequestOptions) (string, error)

FirebaseUIDFromRequest returns the Firebase uid from a request.

func (*DefaultTool) FirebaseUserByUID added in v0.1.1131 

func (d *DefaultTool) FirebaseUserByUID(ctx context.Context, opts contract.FirebaseUserByUIDOptions) (*contract.FirebaseUserRecord, error)

FirebaseUserByUID returns a Firebase user by uid.

func (*DefaultTool) FirebaseUserFromRequest added in v0.1.1131 

func (d *DefaultTool) FirebaseUserFromRequest(ctx context.Context, opts contract.FirebaseUserFromRequestOptions) (*contract.FirebaseUserRecord, error)

FirebaseUserFromRequest returns the Firebase user from a request.

func (*DefaultTool) GenerateFirebaseUID added in v0.1.1131 

func (d *DefaultTool) GenerateFirebaseUID(ctx context.Context, opts contract.GenerateFirebaseUIDOptions) (string, error)

GenerateFirebaseUID generates a Firebase uid.

func (*DefaultTool) NewFirebaseApp added in v0.1.1131 

func (d *DefaultTool) NewFirebaseApp(ctx context.Context, opts contract.NewFirebaseAppOptions) (*firebase.App, error)

NewFirebaseApp creates a Firebase app.

func (*DefaultTool) SendNotif added in v0.1.583 

func (d *DefaultTool) SendNotif(ctx context.Context, opts contract.NotificationOptions) (*contract.SendResult, error)

SendNotif sends a notification.

type Dependencies added in v0.1.8 

type Dependencies struct {
	HR  contract.HTTPRequester
	HD  contract.HTTPDoer
	M   contract.Marshaler
	U   contract.Unmarshaler
	R   contract.Reader
	ENV contract.EnvironmentOperator
}

type Initialized added in v0.1.175 

type Initialized struct {
	App    *firebase.App
	ModApp *firebase.App
}

type Loaded added in v0.1.123 

type Loaded struct {
	APIKey             string
	APIKeyMod          string
	CredentialsJSON    []byte
	CredentialsJSONMod []byte
}

type Tool added in v0.1.245 

type Tool interface {
	contract.FirebaseOperator
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.