CupThread React Native & Expo SDK - v0.1.0
    Preparing search index...

    Interface CupThreadContextValue

    Context value provided by CupThreadProvider to descendant SDK components.

    interface CupThreadContextValue {
        appConfig: PublicAppConfig | null;
        client: FeedbackClient;
        colors: ThemeColors;
        configError: Error | null;
        isLoadingConfig: boolean;
        isTokenReady: boolean;
        locale: string;
        refreshConfig: () => Promise<void>;
        strings: CupThreadStrings;
        themeName: SdkTheme;
        userToken: string;
    }
    Index
    appConfig client colors configError isLoadingConfig isTokenReady locale refreshConfig strings themeName userToken
    appConfig: PublicAppConfig | null

    Remote application settings and feature flags, or null while loading or after failure.

    client: FeedbackClient

    Configured FeedbackClient instance for executing API operations.

    colors: ThemeColors

    Resolved color tokens currently applied to components.

    configError: Error | null

    Last configuration fetch failure, or null when the last attempt succeeded (or is in flight).

    isLoadingConfig: boolean

    True while remote configuration is actively being retrieved.

    isTokenReady: boolean

    True once CupThreadContextValue.userToken reflects the persisted token (or the explicit prop). Token-dependent fetches should wait for this to avoid attributing early requests to a throwaway identity.

    locale: string

    Active locale string (e.g. 'en', 'zh-Hans', 'pt-BR') — the resolved result of the provider's locale prop: 'auto' resolves to the detected device locale, or 'en' when none is detectable.

    refreshConfig: () => Promise<void>

    Re-fetches remote application configuration from the server.

    Clears any previous configError, resets loading state, and retrieves fresh application settings and branding from the server.

    strings: CupThreadStrings

    Resolved localized strings used by CupThread UI components.

    themeName: SdkTheme

    Resolved theme name (e.g. 'system', 'midnight', 'ocean').

    userToken: string

    Current active anonymous or user authentication token.

    When no explicit userToken prop is provided and an async storage adapter (AsyncStorage / SecureStore) is configured, this is an empty string until the persisted token has been recovered — see CupThreadContextValue.isTokenReady. The provider also follows later identity switches made through UserTokenStore.setToken / UserTokenStore.resetToken (e.g. login/logout), so this value stays in sync with the store.

    Settings
    Member Visibility

    On This Page
    Properties