Classes

The following classes are available globally.

  • HSBeacon provides the APIs necessary to display the Beacon SDK. It allows you to open the Beacon from the current view controller on screen, or a specific view controller of your choice.

    Opening the Beacon From The Current View Controller

    The Beacon SDK requires an HSBeaconSettings object, which can be initialized using your Beacon ID.

    HSBeaconSettings *settings = [[HSBeaconSettings alloc] initWithBeaconId:@"beacon-id"];
[HSBeacon openBeacon:settings];

    Authenticating Users

    Authenticating with Beacon is optional, but if you have information you’d like to associate with users, you can do so using HSBeaconUser and the login: method before showing the Beacon.

    HSBeaconUser *user = [[HSBeaconUser alloc] init];
user.email = self.emailTextField.text;
user.name = self.nameTextField.text;

[HSBeacon login:user];

HSBeaconSettings *settings = [[HSBeaconSettings alloc] initWithBeaconId:@"beacon-id"];
[HSBeacon openBeacon:settings];
    See more

    Declaration

    Objective-C

    @interface HSBeacon : NSObject

    Swift

    class HSBeacon : NSObject

  • A model object representing a new conversation. Values set on this are prepopulated in the new conversation contact form.

    See more

    Declaration

    Objective-C

    @interface HSBeaconContactForm : NSObject

    Swift

    class HSBeaconContactForm : 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.

    See more

    Declaration

    Objective-C

    @interface HSBeaconMessagingSettings : NSObject

    Swift

    class HSBeaconMessagingSettings : 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;
    See more

    Declaration

    Objective-C

    @interface HSBeaconSettings : NSObject

    Swift

    class HSBeaconSettings : NSObject

  • Provide an article id for suggestion overrides. The article title and url is looked up from Help Scout before rendering the suggestion.

    See more

    Declaration

    Objective-C

    @interface HSBeaconArticleSuggestion : NSObject <HSBeaconSuggestionItem>

    Swift

    class HSBeaconArticleSuggestion : NSObject, HSBeaconSuggestionItem

  • Provide an title and url for suggestion overrides. The url is opened in a modal using SFSafariViewController.

    See more

    Declaration

    Objective-C

    @interface HSBeaconLinkSuggestion : NSObject <HSBeaconSuggestionItem>

    Swift

    class HSBeaconLinkSuggestion : NSObject, HSBeaconSuggestionItem

  • HSBeaconUser represents a user identified with Help Scout, allowing you to match up support requests to your customer base.

    The current user may be identified by creating an HSBeaconUser object, configuring its properties, and then identifying them using [HSBeacon identify:].

    See more

    Declaration

    Objective-C

    @interface HSBeaconUser : NSObject

    Swift

    class HSBeaconUser : NSObject