zendesk-messaging-client
    Preparing search index...

    Type Alias AppSettings

    Customizable app settings.

    type AppSettings = {
        appLocalizationEnabled?: boolean;
        conversationRetentionSeconds?: number;
        echoPostback?: boolean;
        ignoreAutoConversationStart?: boolean;
        maskCreditCardNumbers?: boolean;
        multiConvoEnabled?: boolean;
        useAnimalNames?: boolean;
    }
    Index

    Properties

    appLocalizationEnabled? conversationRetentionSeconds? echoPostback? ignoreAutoConversationStart? maskCreditCardNumbers? multiConvoEnabled? useAnimalNames?

    Properties

    appLocalizationEnabled?: boolean

    A boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized.

    conversationRetentionSeconds?: number

    Number of seconds of inactivity before a conversation’s messages will be automatically deleted. See Conversation Retention Seconds for more information.

    echoPostback?: boolean

    A boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See Echo Postbacks for more information.

    ignoreAutoConversationStart?: boolean

    A boolean specifying whether a non message event coming from a channel will trigger a start conversation event and count as a monthly active user (MAU).

    maskCreditCardNumbers?: boolean

    A boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.

    multiConvoEnabled?: boolean

    A boolean specifying whether users are allowed to be part of several conversations. Enabling multiConvo is irreversible.

    useAnimalNames?: boolean

    A boolean specifying whether animal names should be used for unnamed users. See the user naming guide for details.

    Settings

    Member Visibility

    On This Page

    Properties