iid

Documentation

Overview

Package iid contains functions for deleting instance IDs from Firebase projects.

Index

• func IsAlreadyDeleted(err error) bool
• func IsInsufficientPermission(err error) bool
• func IsInternal(err error) bool
• func IsInvalidArgument(err error) bool
• func IsNotFound(err error) bool
• func IsServerUnavailable(err error) bool
• func IsTooManyRequests(err error) bool
• func IsUnknown(err error) bool
• type Client
  • func NewClient(ctx context.Context, c *internal.InstanceIDConfig) (*Client, error)
  • func (c *Client) DeleteInstanceID(ctx context.Context, iid string) error

Functions

func IsAlreadyDeleted

func IsAlreadyDeleted(err error) bool

IsAlreadyDeleted checks if the given error was due to the instance ID being already deleted from the project.

func IsInsufficientPermission

func IsInsufficientPermission(err error) bool

IsInsufficientPermission checks if the given error was due to the request not having the required authorization. This could be due to the client not having the required permission or the specified instance ID not matching the target Firebase project.

func IsInternal

func IsInternal(err error) bool

IsInternal checks if the given error was due to an internal server error.

func IsInvalidArgument

func IsInvalidArgument(err error) bool

IsInvalidArgument checks if the given error was due to an invalid instance ID argument.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound checks if the given error was due to a non existing instance ID.

func IsServerUnavailable

func IsServerUnavailable(err error) bool

IsServerUnavailable checks if the given error was due to the backend server being temporarily unavailable.

func IsTooManyRequests

func IsTooManyRequests(err error) bool

IsTooManyRequests checks if the given error was due to the client sending too many requests causing a server quota to exceed.

func IsUnknown

func IsUnknown(err error) bool

IsUnknown checks if the given error was due to unknown error returned by the backend server.

Types

type Client

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

Client is the interface for the Firebase Instance ID service.

func NewClient

func NewClient(ctx context.Context, c *internal.InstanceIDConfig) (*Client, error)

NewClient creates a new instance of the Firebase instance ID Client.

This function can only be invoked from within the SDK. Client applications should access the the instance ID service through firebase.App.

func (*Client) DeleteInstanceID

func (c *Client) DeleteInstanceID(ctx context.Context, iid string) error

DeleteInstanceID deletes an instance ID from Firebase.

This can be used to delete an instance ID and associated user data from a Firebase project, pursuant to the General Data protection Regulation (GDPR).