The following classes are available globally.
HSBeaconprovides 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
HSBeaconSettingsobject, which can be initialized using your Beacon ID.
HSBeaconSettings *settings = [[HSBeaconSettings alloc] initWithBeaconId:@"beacon-id"]; [HSBeacon openBeacon:settings];
Authenticating with Beacon is optional, but if you have information you’d like to associate with users, you can do so using
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];
@interface HSBeacon : NSObject
A model object representing a new conversation. Values set on this are prepopulated in the new conversation contact form.See more
@interface HSBeaconContactForm : NSObject
HSBeaconSettingsallows you to customize the Beacon SDK and provide the Beacon identifier to use.
HSBeaconSettings *settings = [[HSBeaconSettings alloc] initWithBeaconId:@"beacon-id"]; settings.useNavigationBarAppearance = NO;
@interface HSBeaconSettings : NSObject
HSBeaconUserrepresents 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 anSee more
HSBeaconUserobject, configuring its properties, and then identifying them using
@interface HSBeaconUser : NSObject