HSBeaconSettings

@interface 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 (readwrite, strong, nonatomic) NSString *_Nonnull beaconId;
  • The title used in the main Beacon interface. This is Support by default.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic) NSString *_Nonnull beaconTitle;
  • Display strings from BeaconLocalizable.strings instead of those setup in the Beacon Web UI

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL useLocalTranslationOverrides;
  • 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.

    Declaration

    Objective-C

    @property (assign, readwrite, atomic) BOOL useNavigationBarAppearance;
  • 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 (assign, readwrite, atomic) BOOL messagingEnabled;
  • 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 (assign, readwrite, atomic) BOOL docsEnabled;
  • Used for customizing the runtime behavior of the Beacon SDK

    Declaration

    Objective-C

    @property (readwrite, nonatomic, nullable) id<HSBeaconDelegate> delegate;
  • Override the color from the Beacon Builder. The useNavigationBarAppearance option will override this value.

    Declaration

    Objective-C

    @property (readwrite, nonatomic, nullable) UIColor *color;
  • Set different display options for messaging.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nonnull)
        HSBeaconMessagingSettings *messagingSettings;
  • Initialize Beacon settings with a given Beacon ID.

    Declaration

    Objective-C

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