@kustomer/chat-react-native/lib/typescript/src/types/KustomerOptions.d.ts

Kustomer Chat SDK wrapper for React Native

import type { KustomerLanguage } from './KustomerLanguage';
import type { Package } from './util/util.types';
export interface KustomerOptions {
    /**
     * Enables the Kustomer UI. Defaults to`true`. If you want to use any of the Kustomer UI this must be `true`. To build your own UI, set to `false`.
     * @unsupported
     */
    enableUI?: boolean;
    /**
     * Show in-app notifications for new messages.
     * @default false
     */
    showInAppNotifications?: boolean;
    /**
     * The language to show volume control, automated messages, snippets, and KB for. If blank, uses the device's language.
     */
    language?: KustomerLanguage;
    /**
     * If supplied, always uses this chat assistant ID when pressing new conversation button in the UI. No effect on the core sdk.
     */
    activeAssistant?: KusActiveAssistant;
    /**
     * Do not use push notifications. Push is automatically turned on when you configure push on the Kustomer website. Use this flag to disable.
     * Once a device registers for Kustomer push notifications, settings `disablePush` to `true` will not prevent pushes from being sent.
     * This flag can only set whether or not the SDK registers this device for Kustomer push notifications.
     */
    disablePush?: boolean;
    pushBundleId?: String;
    pushEnvironment?: PushEnvironment;
    /** Never show the "New Conversation" button. Defaults to `false`. */
    hideNewConversationButton?: boolean;
    /**
     * Show animation when customer selects the highest CSAT rating
     * @ios
     */
    iosAnimate5Star?: boolean;
    /**
     * Override the API host domain. Optional.
     */
    hostDomain?: string;
    /**
     * The business schedule ID you want the app to use. Optional.
     */
    businessScheduleId?: string;
    /**
     * The brand ID for the brand settings you'd like to present. Optional.
     */
    brandId?: string;
    /**
     * A `KustomerLogType` you want to have printed to the console. Defaults to all `KustomerLogType`s: `info, error, debug, all`.
     * @default `all`
     */
    logLevel?: KustomerLogType;
    /**
     * Don't show the KB Article Share button.
     * @default false
     */
    hideKbArticleShare?: boolean;
    /**
     * Hides back button on conversation detail screen leading to chat history screen.
     * @default false
     */
    hideHistoryNavigation?: boolean;
    /**
     * Prevents the SDK from registering the device for push notifications with Firebase Cloud Messaging automatically.
     * Use this to register the device for push notifications yourself.
     */
    skipFCMPushRegistration?: boolean;
}
export declare enum KustomerConfigurationError {
    notEnoughDiskSpace = "notEnoughDiskSpace"
}
export type KusActiveAssistant = Package<'none'> | Package<'orgDefault'> | Package<'withId', string>;
export declare enum PresenceType {
    online = "online",
    offline = "offline"
}
export declare enum PushEnvironment {
    development = "development",
    production = "production"
}
export declare enum KustomerLogType {
    all = "all",
    info = "info",
    error = "error",
    debug = "debug",
    warning = "warning",
    /** @ignore this is always logged */
    fatal = "fatal"
}
//# sourceMappingURL=KustomerOptions.d.ts.map