HSBeaconSettings

Objective-C

@interface HSBeaconSettings : NSObject

Swift

class HSBeaconSettings : NSObject

HSBeaconSettings allows you to customize the Beacon SDK and provide the Beacon identifier to use.

Initialization

HSBeaconSettings *settings = [[HSBeaconSettings alloc] initWithBeaconId:@"beacon-id"];
settings.useNavigationBarAppearance = NO;

  • The Beacon ID to use.

    Note

    This can be found during Beacon creation.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nonnull) NSString *beaconId;

    Swift

    var beaconId: String { get }

  • Deprecated

    This property is deprecated and has no effect. It will be removed in a future release. The Beacon title is controlled by the Beacon Builder configuration.

    The title used in the main Beacon interface. This is Support by default.

    @deprecated This property is deprecated and has no effect. It will be removed in a future release. The Beacon title is controlled by the Beacon Builder configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong) DEPRECATED_MSG_ATTRIBUTE NSString *beaconTitle;

    Swift

    var beaconTitle: String { get set }

  • Display strings from BeaconLocalizable.strings instead of those setup in the Beacon Web UI

    Declaration

    Objective-C

    @property BOOL useLocalTranslationOverrides;

    Swift

    var useLocalTranslationOverrides: Bool { get set }

  • Provide custom localized labels directly as a dictionary.

    When set, this dictionary takes precedence over BeaconLocalizable.strings for translation overrides. Keys must match the Beacon JS API label keys as documented at: https://developer.helpscout.com/beacon-2/web/javascript-api/#translate-options

    This is useful when your app manages translations programmatically or uses a different localization system than .strings files.

    Note

    Each label value will be truncated to 160 characters per Beacon JS API constraints.

    Note

    If nil (default), translations will be loaded from BeaconLocalizable.strings when useLocalTranslationOverrides is enabled.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) NSDictionary<NSString *, NSString *> *localizationOverrides;

    Swift

    var localizationOverrides: [String : String]? { get set }

  • Deprecated

    This property is deprecated and has no effect. It will be removed in a future release. Customize your Beacon’s appearance via the Beacon Builder.

    Allows the Beacon SDK to use the UIAppearance settings for UINavigationController. This is false by default, and will instead use the Beacon color defined in the Beacon Builder.

    @deprecated This property is deprecated and has no effect. It will be removed in a future release. Customize your Beacon’s appearance via the Beacon Builder.

    Declaration

    Objective-C

    @property BOOL useNavigationBarAppearance;

    Swift

    var useNavigationBarAppearance: Bool { get set }

  • Disable the contact options manually if it’s enabled in the Beacon config.

    This will not enable the contact options if it’s disabled in the config.

    Declaration

    Objective-C

    @property BOOL messagingEnabled;

    Swift

    var messagingEnabled: Bool { get set }

  • Disable previous messages manually if messaging is enabled in the Beacon config.

    Declaration

    Objective-C

    @property BOOL enablePreviousMessages;

    Swift

    var enablePreviousMessages: Bool { get set }

  • Disable the Docs integration manually if it’s enabled in the Beacon config.

    This will not enable Docs if it’s disabled in the config.

    Declaration

    Objective-C

    @property BOOL docsEnabled;

    Swift

    var docsEnabled: Bool { get set }

  • Disable the Chat integration manually if it’s enabled in the Beacon config.

    This will not enable Chat if it’s disabled in the config.

    Declaration

    Objective-C

    @property BOOL chatEnabled;

    Swift

    var chatEnabled: Bool { get set }

  • Override the focusMode configured on the Beacon config.

    Declaration

    Objective-C

    @property (nonatomic) HSBeaconFocusMode focusModeOverride;

    Swift

    var focusModeOverride: HSBeaconFocusMode { get set }

  • Was focusModeOverride set with a local override.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL focusModeOverrideSet;

    Swift

    var focusModeOverrideSet: Bool { get }

  • Deprecated

    This property is deprecated and has no effect. It will be removed in a future release. Use the color property to customize your Beacon’s brand color, or configure appearance via the Beacon Builder.

    This replaces the default blue color used for clickable text throughout Beacon. For example, you may want to set this to the tintColor of your window to match the look and feel of the rest of your app.

    @deprecated This property is deprecated and has no effect. It will be removed in a future release. Use the color property to customize your Beacon’s brand color, or configure appearance via the Beacon Builder.

    Declaration

    Objective-C

    @property DEPRECATED_MSG_ATTRIBUTE UIColor *tintColorOverride;

    Swift

    var tintColorOverride: UIColor { get set }

  • Used for customizing the runtime behavior of the Beacon SDK

    Declaration

    Objective-C

    @property (nonatomic, weak, nullable) id<HSBeaconDelegate> delegate;

    Swift

    weak var delegate: (any HSBeaconDelegate)? { get set }

  • Override the color from the Beacon Builder. This color affects the Beacon’s brand color throughout the interface.

    Declaration

    Objective-C

    @property (nonatomic, strong, nullable) UIColor *color;

    Swift

    var color: UIColor? { get set }

  • Set different display options for messaging.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) HSBeaconMessagingSettings *messagingSettings;

    Swift

    var messagingSettings: HSBeaconMessagingSettings { get }

  • Initialize Beacon settings with a given Beacon ID.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithBeaconId:(NSString *_Nonnull)beaconId;

    Swift

    init(beaconId: String)

  • Unavailable

    HSBeaconSettings must be initialized with a beaconId

    -[HSBeaconSettings init] is not available because HSBeaconSettings must be initialized with a beaconId Use the initWithBeaconId: method to display the Beacon SDK.

    Declaration

    Objective-C

    - (nonnull instancetype)init;