FirebaseAdmin

Summary

Enumerations

ErrorCode{
  InvalidArgument,
  FailedPrecondition,
  OutOfRange,
  Unauthenticated,
  PermissionDenied,
  NotFound,
  Conflict,
  Aborted,
  AlreadyExists,
  ResourceExhausted,
  Cancelled,
  DataLoss,
  Unknown,
  Internal,
  Unavailable,
  DeadlineExceeded
}
enum
Platform-wide error codes that can be raised by Admin SDK APIs.

Classes

FirebaseAdmin.AppOptions

Configurable options that can be specified when creating a FirebaseApp.

FirebaseAdmin.FirebaseApp

This is the entry point to the Firebase Admin SDK.

FirebaseAdmin.FirebaseException

Common error type for all exceptions raised by Firebase APIs.

Namespaces

FirebaseAdmin.Auth
FirebaseAdmin.Messaging
FirebaseAdmin.Util

Enumerations

ErrorCode

 ErrorCode

Platform-wide error codes that can be raised by Admin SDK APIs.

Properties
Aborted

Concurrency conflict, such as read-modify-write conflict.

AlreadyExists

The resource that a client tried to create already exists.

Cancelled

Request cancelled by the client.

Conflict

Concurrency conflict, such as read-modify-write conflict.

DataLoss

Unrecoverable data loss or data corruption.

DeadlineExceeded

Request deadline exceeded.

This will happen only if the caller sets a deadline that is shorter than the method's default deadline (i.e. requested deadline is not enough for the server to process the request) and the request did not finish within the deadline.

FailedPrecondition

Request can not be executed in the current system state, such as deleting a non-empty directory.

Internal

Internal server error.

InvalidArgument

Client specified an invalid argument.

NotFound

A specified resource is not found, or the request is rejected due to undisclosed reasons, such as whitelisting.

OutOfRange

Client specified an invalid range.

PermissionDenied

Client does not have sufficient permission.

This can happen because the OAuth token does not have the right scopes, the client doesn't have permission, or the API has not been enabled for the client project.

ResourceExhausted

Either out of resource quota or reaching rate limiting.

Unauthenticated

Request not authenticated due to missing, invalid, or expired OAuth token.

Unavailable

Service unavailable.

Typically the server is down.

Unknown

Unknown server error.