Braze React Native SDK - v23.1.0
    Preparing search index...

    Class BrazePushUnregistrationError

    Thrown when unregisterPush or logout fails. The SDK does not retry on its own; inspect isRetriable to decide whether calling again may succeed.

    Hierarchy

    • Error
      • BrazePushUnregistrationError
    Index

    Constructors

    constructor

    Properties

    httpStatusCode isRetriable message name stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    Properties

    httpStatusCode: number | null

    The HTTP status code when the failure came from an HTTP response, or null otherwise (e.g. a local rate limit or the SDK being disabled). For logout on iOS, prefers the unregisterPush status, then falls back to the push-to-start status when that step failed with an HTTP response.

    isRetriable: boolean

    Whether calling the failed operation again may succeed. The SDK does not retry on its own.

    For logout on iOS, this is for retrying logout as a whole.

    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void