akiles-react-native
    Preparing search index...

    Class AkilesError

    Hierarchy

    • Error
      • AkilesError
    Index

    Constructors

    constructor

    Properties

    cause? code distance? endsAt? message name reason? schedule? siteGeo? stack? startsAt? timezone? waitTime?

    Methods

    isError

    Constructors

    • Parameters

      Returns AkilesError

    Properties

    cause?: unknown
    code: ErrorCode = ErrorCode.INTERNAL
    distance?: number

    Actual distance to the site, in meters. Only present if code is INTERNET_LOCATION_OUT_OF_RADIUS.

    endsAt?: string

    Member end date, RFC3339 timestamp. Only present if reason is MEMBER_ENDED.

    message: string
    name: string
    reason?: PermissionDeniedReason

    Reason for permission denied errors. Only present if code is PERMISSION_DENIED.

    schedule?: Schedule

    Member's schedule. Only present if reason is OUT_OF_SCHEDULE.

    siteGeo?: SiteGeo

    Geolocation restriction of the site. Only present if code is INTERNET_LOCATION_OUT_OF_RADIUS.

    stack?: string
    startsAt?: string

    Member start date, RFC3339 timestamp. Only present if reason is MEMBER_NOT_STARTED.

    timezone?: string

    Timezone the schedule is interpreted in. TZDB name, example Europe/Madrid. Only present if reason is OUT_OF_SCHEDULE.

    waitTime?: number

    Time needed to wait to be in schedule, in seconds. Only present if reason is OUT_OF_SCHEDULE.

    Methods

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods