HSBeaconUser

@interface HSBeaconUser : NSObject

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:].

  • The email address for the current user.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *email;
  • The name of the current user.

    Declaration

    Objective-C

    @property (readwrite, strong, nonatomic, nullable) NSString *name;
  • The attributes for the current user. These are arbitrary key/value pairs that will be sent to Help Scout to help identify the current user. You may add up to 30 different attributes.

    Declaration

    Objective-C

    @property (readonly, strong, nonatomic) NSDictionary *_Nonnull attributes;
  • Adds an attribute with a given key to the attributes dictionary. The attributes dictionary is limited to 30 entries.

    @returns True if the attribute was added; false if the attribute limit has been reached.

    Declaration

    Objective-C

    - (BOOL)addAttributeWithKey:(nonnull NSString *)key
                          value:(nonnull NSString *)value;
  • Removes an attribute with a given key from the attributes dictionary.

    Declaration

    Objective-C

    - (void)removeAttributeWithKey:(nonnull NSString *)key;
  • Clears the current attributes dictionary.

    Declaration

    Objective-C

    - (void)clearAttributes;
  • Check if two users are equal

    Declaration

    Objective-C

    - (BOOL)isEqualToBeaconUser:(nonnull HSBeaconUser *)user;