firebase

package

v0.0.0-...-40b5090 Latest Latest Go to latest Published: May 14, 2023 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/inczero/token-janitor

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func InitClient(databaseURL string, credentialsJSON []byte) (*Client, error)
type RegistrationToken
type User

Constants ¶

View Source

const (
	PathToRegistrationTokens          = "/users/%s/fcmRegistrationTokens"               // %s - user's id
	PathToRegistrationTokenDeprecated = "/users/%s/fcmRegistrationTokens/%s/deprecated" // %s - user's id, %s - number of token
	PathToRegistrationTokenRotated    = "/users/%s/fcmRegistrationTokens/%s/rotated"    // %s - user's id, %s - number of token
	PathToRegistrationToken           = "/users/%s/fcmRegistrationTokens/%s"            // %s - user's id, %s - number of token
)

View Source

const (
	// Firebase Cloud Messaging messages
	FCMTokenActive               = "FCM registration token is active"
	FCMTokenUnregisteredError    = "FCM registration token was unregistered"
	FCMTokenInvalidArgumentError = "FCM registration token is invalid"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

func InitClient ¶

func InitClient(databaseURL string, credentialsJSON []byte) (*Client, error)

func (*Client) DeleteUserRT ¶

func (c *Client) DeleteUserRT(uid string, id string) error

DeleteUserRT function deletes the Firebase Cloud Messaging Registration Token entry from the database.

func (*Client) DetectInvalidToken ¶

func (c *Client) DetectInvalidToken(token string) error

DetectInvalidToken function determines if a Firebase Cloud Messaging Registration Token is still valid by sending a message in dry run mode.

func (*Client) GetAllUsers ¶

func (c *Client) GetAllUsers() ([]User, error)

func (*Client) GetUserRTs ¶

func (c *Client) GetUserRTs(uid string) (map[string]RegistrationToken, error)

GetUserRTs function returns a map which contains the Firebase Cloud Messaging Registration Tokens that belong to a user along with other metadata. The keys are UUIDs generated when the tokens are added to the database.

func (*Client) SetUserRTDeprecated ¶

func (c *Client) SetUserRTDeprecated(uid string, id string, deprecated bool) error

SetUserRTDeprecated function sets the deprecated field of a user's Firebase Cloud Messaging Registration Token. By setting this to true, it marks the token for rotation which will be done by application on the user's smartphone.

func (*Client) SetUserRTRotated ¶

func (c *Client) SetUserRTRotated(uid string, id string, rotated bool) error

SetUserRTRotated function sets the rotated field of a user's Firebase Cloud Messaging Registration Token.

type RegistrationToken ¶

type RegistrationToken struct {
	CreatedOn  int64  `json:"createdOn"`
	Deprecated bool   `json:"deprecated"`
	Rotated    bool   `json:"rotated"`
	Token      string `json:"token"`
}

type User ¶

type User struct {
	UID string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL