@launchdarkly/react-native-client-sdk/dist/src/ReactNativeLDClient.d.ts

React Native LaunchDarkly SDK

import { AutoEnvAttributes, ConnectionMode, FDv2ConnectionMode, LDClientImpl } from '@launchdarkly/js-client-sdk-common';
import LDOptions from './RNOptions';
export default class ReactNativeLDClient extends LDClientImpl {
    private _connectionManager?;
    private _stateDetector?;
    /**
     * Creates an instance of the LaunchDarkly client.
     *
     * @param sdkKey The LaunchDarkly mobile key.
     * @param autoEnvAttributes Enable / disable Auto environment attributes. When enabled, the SDK will automatically
     * provide data about the mobile environment where the application is running. To learn more,
     * read [Automatic environment attributes](https://docs.launchdarkly.com/sdk/features/environment-attributes).
     * for more documentation.
     * @param options {@link LDOptions} to initialize the client with.
     */
    constructor(sdkKey: string, autoEnvAttributes: AutoEnvAttributes, options?: LDOptions);
    close(): Promise<void>;
    /**
     * Sets the SDK connection mode.
     *
     * @param mode The connection mode to use (`'streaming'`, `'polling'`, or `'offline'`).
     */
    setConnectionMode(mode: ConnectionMode): Promise<void>;
    /**
     * Sets the connection mode for the FDv2 data system.
     *
     * When the FDv2 data system is enabled (`dataSystem` option), this method
     * additionally accepts `'one-shot'` and `'background'` modes. Pass
     * `undefined` to clear an explicit override and return to automatic mode
     * selection.
     *
     * This overload is not stable, and not subject to any backwards compatibility
     * guarantees or semantic versioning. It is in early access. If you want access
     * to this feature please join the EAP.
     * https://launchdarkly.com/docs/sdk/features/data-saving-mode
     *
     * @param mode The connection mode to use, or `undefined` to clear the
     *   override (FDv2 only).
     */
    setConnectionMode(mode?: FDv2ConnectionMode): Promise<void>;
    /**
     * Gets the SDK connection mode.
     */
    getConnectionMode(): ConnectionMode;
    /**
     * Gets the SDK connection mode.
     *
     * When the FDv2 data system is enabled (`dataSystem` option), the connection
     * mode may also be `'one-shot'` or `'background'`.
     *
     * This overload is not stable, and not subject to any backwards compatibility
     * guarantees or semantic versioning. It is in early access. If you want access
     * to this feature please join the EAP.
     * https://launchdarkly.com/docs/sdk/features/data-saving-mode
     */
    getConnectionMode(): FDv2ConnectionMode;
    isOffline(): boolean;
}
//# sourceMappingURL=ReactNativeLDClient.d.ts.map