HSBeaconMessagingSettings

Objective-C

@interface HSBeaconMessagingSettings : NSObject

Swift

class HSBeaconMessagingSettings : NSObject

HSBeaconMessagingSettings contains settings specific to the messaging portions of Beacon. After creating and configuring a messaging settings object, you can set messagingSettings on HSBeaconSettings with it.

  • Disable contact form custom fields if enabled in the Beacon config.

    This will not enable custom fields if disabled in the config.

    Declaration

    Objective-C

    @property (nonatomic) BOOL contactFormCustomFieldsEnabled;

    Swift

    var contactFormCustomFieldsEnabled: Bool { get set }

  • Display an editable Name field.

    Declaration

    Objective-C

    @property (nonatomic) BOOL contactFormShowNameField;

    Swift

    var contactFormShowNameField: Bool { get set }

  • Was contactFormShowNameField set with a local override.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL contactFormShowNameFieldSet;

    Swift

    var contactFormShowNameFieldSet: Bool { get }

  • Display an editable Subject field.

    Declaration

    Objective-C

    @property (nonatomic) BOOL contactFormShowSubjectField;

    Swift

    var contactFormShowSubjectField: Bool { get set }

  • Was contactFormShowSubjectField set with a local override.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL contactFormShowSubjectFieldSet;

    Swift

    var contactFormShowSubjectFieldSet: Bool { get }

  • Enable or disable file attachments.

    Declaration

    Objective-C

    @property (nonatomic) BOOL contactFormAllowAttachments;

    Swift

    var contactFormAllowAttachments: Bool { get set }

  • Returns whether contactFormAllowAttachments was set with a local override.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL contactFormAllowAttachmentsSet;

    Swift

    var contactFormAllowAttachmentsSet: Bool { get }

  • Deprecated

    Beacon 2.1 no longer shows contact links on the home screen. To customize the home screen experience take a look at HSBeaconSettings.focusModeOverride

    Show a contact link on the Beacon home screen.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showGetInTouch;

    Swift

    var showGetInTouch: Bool { get set }

  • Deprecated

    Beacon 2.1 no longer shows contact links on the home screen. To customize the home screen experience take a look at HSBeaconSettings.focusModeOverride

    Returns whether showGetInTouch was set with a local override.

    Declaration

    Objective-C

    @property (nonatomic, readonly) BOOL showGetInTouchSet;

    Swift

    var showGetInTouchSet: Bool { get }

  • By default, prefilled custom fields will be hidden so that the prefilled values cannot be edited. Set this to true to display them and make them editable.

    Note

    If a draft has been entered into the contact form, the prefill process will be skipped in favor of using the draft values. Draft messages can be cleared by calling the reset function on HSBeacon.

    Declaration

    Objective-C

    @property (nonatomic) BOOL showPrefilledCustomFields;

    Swift

    var showPrefilledCustomFields: Bool { get set }