SKTSettings

Objective-C

@interface SKTSettings : NSObject

Swift

class SKTSettings : NSObject

A class that exposes options to customise the SDK.

  • @abstract Initializes a settings object with the given integrationId.

    Declaration

    Objective-C

    + (nonnull instancetype)settingsWithIntegrationId:
    (nonnull NSString *)integrationId;

    Swift

    convenience init(integrationId: String)

    Parameters

    integrationId

    A valid integration id retrieved from the Smooch web portal.

  • @abstract Initializes a settings object with the given integration id and auth code.

    Declaration

    Objective-C

    + (nonnull instancetype)settingsWithIntegrationId:
                            (nonnull NSString *)integrationId
                                      andAuthCode:(nonnull NSString *)authCode;

    Swift

    convenience init(integrationId: String, andAuthCode authCode: String)

    Parameters

    integrationId

    A valid integration id retrieved from the Smooch web portal.
    authCode

    A valid auth code generated from the Smooch API.

  • @abstract The app id corresponding to your application.

    @discussion App id can be retrieved from the Smooch web portal

    This value may only be set once, and must be set at init time.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull appId;

    Swift

    var appId: String { get set }

  • @abstract The integration id corresponding to your application.

    @discussion integration id can be retrieved from the Smooch web portal

    This value may only be set once, and must be set at init time.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull integrationId;

    Swift

    var integrationId: String { get set }

  • Undocumented

    Declaration

    Objective-C

    @property(nonatomic, copy) NSString *serviceBaseUrl

    Swift

    var serviceBaseUrl: String { get set }

  • @abstract The auth code being used to authenticate as an existing user.

    @discussion Auth code can be retrieved from the Smooch API

    This value may only be set once, and must be set at init time.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull authCode;

    Swift

    var authCode: String { get set }

  • @abstract The Smooch region for this account.

    @discussion Leave unspecified to use the default region (US). Set to “eu-1” to use the EU region.

    Declaration

    Objective-C

    @property (nonatomic, copy) NSString *_Nonnull region;

    Swift

    var region: String { get set }

  • @abstract The accent color for the conversation screen.

    @discussion Used as the color of user message bubbles, as well as the color of the send button and text input caret.

    The default value is #00B0FF.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *conversationAccentColor

  • @abstract The accent color for the conversation screen in Dark Mode.

    @discussion Used as the color of user message bubbles, as well as the color of the send button and text input caret.

    The default value is #00B0FF.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *conversationAccentColorDarkMode

  • @abstract The accent color for the conversation list screen.

    @discussion Used as the color of the create conversation button

    The default value is #00B0FF.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *conversationListAccentColor

  • @abstract The text color for carousels that appear in the conversation screen.

    @discussion Used as the text color of the carousel text.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *carouselTextColor

  • @abstract The text color for user messages.

    @discussion Used as the text color of user message bubbles.

    The default value is #FFFFFF.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *userMessageTextColor

  • @abstract The text color for user messages in Dark Mode.

    @discussion Used as the text color of user message bubbles.

    The default value is #FFFFFF.

    Declaration

    Objective-C

    @property(nonatomic, strong) UIColor *userMessageTextColorDarkMode

  • @abstract The status bar style to use on the conversation screen.

    @discussion You should use this property if your app uses UIAppearance to style UINavigationBar, and your styling requires a specific status bar color.

    The default value is UIStatusBarStyleDefault.

    Declaration

    Objective-C

    @property int conversationStatusBarStyle;

    Swift

    var conversationStatusBarStyle: Int32 { get set }

  • @abstract The status bar style to use on the conversation screen in Dark Mode.

    @discussion You should use this property if your app uses UIAppearance to style UINavigationBar, and your styling requires a specific status bar color.

    The default value is UIStatusBarStyleDefault.

    Declaration

    Objective-C

    @property int conversationStatusBarStyleDarkMode;

    Swift

    var conversationStatusBarStyleDarkMode: Int32 { get set }

  • @abstract The items to display in the conversation menu

    @discussion Valid values are SKTMenuItemCamera, SKTMenuItemGallery, SKTMenuItemDocument and SKTMenuItemLocation

    All options are displayed by default. Setting this value to nil or an empty array will hide the menu button

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSArray<NSString *> *allowedMenuItems;

    Swift

    var allowedMenuItems: [String]? { get set }

  • @abstract Allow sending messages from the conversation view when offline

    @discussion Setting this to YES allows the user to send messages even when the device is offline. It also prevents an network error banner from showing when offline. This setting only applies to the conversation view.

    Note that messages that are sent while offline will fail to send and the message will display an option for the user to retry

    Declaration

    Objective-C

    @property BOOL allowOfflineUsage;

    Swift

    var allowOfflineUsage: Bool { get set }

  • @abstract Maximum number of seconds to display in-app notifications before dismissing.

    @discussion Setting this value to 0 will cause notications to stay on-screen until the user acts on them.

    The default value is 8.

    Declaration

    Objective-C

    @property NSUInteger notificationDisplayTime;

    Swift

    var notificationDisplayTime: UInt { get set }

  • @abstract Whether or not to swizzle app delegate methods for handling push notifications.

    @discussion When set to YES, Smooch will swizzle the following methods of your UIApplicationDelegate in order to automatically handle push notification receiving and registering, as well as user notification handling.

    1. -application:didRegisterForRemoteNotificationsWithDeviceToken:
    2. -application:didFailToRegisterForRemoteNotificationsWithError:
    3. -application:didReceiveRemoteNotification:
    4. -application:didReceiveRemoteNotification:fetchCompletionHandler:
    5. -application:handleActionWithIdentifier:forRemoteNotification:withResponseInfo:completionHandler:

    If set to NO, Smooch will not perform swizzling. It is up to the app to handle Smooch push notifications by doing the following:

    1. When a new push token is received in -application:didRegisterForRemoteNotificationsWithDeviceToken:, you must call Smooch +setPushToken.
    2. In your -application:didReceiveRemoteNotification: or -application:didReceiveRemoteNotification:fetchCompletionHandler: callback, you must call Smooch +handlePushNotification: with the passed userInfo dictionary.
    3. In your -application:handleActionWithIdentifier:forRemoteNotification:withResponseInfo:completionHandler: callback, you must call Smooch +handleUserNotificationActionWithIdentifier:withResponseInfo:completionHandler: with the correct parameters.

    The default value is YES.

    See

    Smooch

    Declaration

    Objective-C

    @property BOOL enableAppDelegateSwizzling;

    Swift

    var enableAppDelegateSwizzling: Bool { get set }

  • @abstract Whether or not to automatically replace the application’s UNUserNotificationCenterDelegate at init time.

    @discussion For more information, see the +userNotificationCenterDelegate method of the Smooch class.

    If set to NO, the application must forward calls from its own UNUserNotificationCenterDelegate to Smooch to ensure proper handling of notifications on iOS 10.

    The default value is YES.

    See

    Smooch

    Declaration

    Objective-C

    @property BOOL enableUserNotificationCenterDelegateOverride;

    Swift

    var enableUserNotificationCenterDelegateOverride: Bool { get set }

  • @abstract Whether or not to request user notification privileges after the user sends their first message.

    @discussion If your app has a preferred time to request user notification privileges, set this to NO.

    If set to NO, the application must make sure to register the Smooch user notification category settings. For more information, see the +userNotificationCategories method of the Smooch class.

    The default value is YES.

    See

    Smooch

    Declaration

    Objective-C

    @property BOOL requestPushPermissionOnFirstMessage;

    Swift

    var requestPushPermissionOnFirstMessage: Bool { get set }

  • @abstract Delegate that will be notified of authentication related events

    @discussion This delegate is useful if your app uses expiring tokens for your users. This way you can renew an invalid jwt when needed without having to call +login:jwt:completionHandler. May be nil

    This value may only be set once, and must be set at init time.

    See

    SKTAuthenticationDelegate

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<SKTAuthenticationDelegate> authenticationDelegate;

    Swift

    weak var authenticationDelegate: SKTAuthenticationDelegate? { get set }