Interface AirshipFeatureFlagManager

Airship feature flag manager.

Hierarchy

  • AirshipFeatureFlagManager

Methods

flag onStatusChanged status trackInteraction waitRefresh

Methods

flag

  • Retrieve a given flag's status and associated data by its name.

    Parameters

    • flagName: string

      The flag name

    • success: ((flag: FeatureFlag) => void)

      Success callback.

    • Optional error: ((err: string) => void)

      Error callback.

        • (err: string): void

        • Parameters

          • err: string

          Returns void

    Returns void

onStatusChanged

status

  • Retrieves the freshness of the feature flag data used to resolve flags.

    Parameters

    • success: ((status: FeatureFlagStatus) => void)

      Success callback.

    • Optional error: ((err: string) => void)

      Error callback.

        • (err: string): void

        • Parameters

          • err: string

          Returns void

    Returns void

trackInteraction

  • Tracks a feature flag interaction event.

    Parameters

    • flag: FeatureFlag

      The flag

    • Optional success: (() => void)

      Success callback.

        • (): void

        • Returns void

    • Optional error: ((err: string) => void)

      Error callback.

        • (err: string): void

        • Parameters

          • err: string

          Returns void

    Returns void

waitRefresh

  • Suspends until the feature flag data is refreshed, or the given time elapses.

    Parameters

    • Optional maxTimeMs: number

      The max time to wait, in milliseconds. If not provided, waits until the data is refreshed with no timeout.

    • Optional success: (() => void)

      Success callback.

        • (): void

        • Returns void

    • Optional error: ((err: string) => void)

      Error callback.

        • (err: string): void

        • Parameters

          • err: string

          Returns void

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc