Class HMSException

Represents an exception specific to the HMS SDK in a React Native context.

This class encapsulates detailed information about errors that can occur while interacting with the HMS SDK. It includes a numeric code to identify the type of error, a human-readable description, and optionally, a message, name, and action that are primarily available on Android. Additionally, it indicates whether the error is terminal (i.e., cannot be recovered from) and whether a retry might be possible.

Hierarchy

  • HMSException

Constructors

constructor

Properties

action? canRetry? code description isTerminal message? name?

Constructors

constructor

  • Parameters

    • params: {
          action?: string;
          canRetry?: boolean;
          code: number;
          description: string;
          isTerminal: boolean;
          message?: string;
          name?: string;
      }
      • Optional action?: string
      • Optional canRetry?: boolean
      • code: number
      • description: string
      • isTerminal: boolean
      • Optional message?: string
      • Optional name?: string

    Returns HMSException

Properties

Optional action

action?: string

The action during which the error occurred (Android only).

Optional canRetry

canRetry?: boolean

Indicates whether the operation that caused the error can be retried (Android only).

code

code: number

Numeric error code representing the type of error.

description

description: string

A brief, human-readable description of the error.

isTerminal

isTerminal: boolean

Indicates whether the error is terminal.

Optional message

message?: string

Additional message information about the error (Android only).

Optional name

name?: string

The name of the error (Android only).

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc