HYPInstance

@interface HYPInstance : NSObject

@abstract Hype network instance.

@discussion Instances map to devices participating on the network. Instances are advertised on the network and, when found, a notification is issued indicating that the instance is available for communication purposes. Usually, there’s no need to instantiate objects of this type at all, as the framework handles that automatically. Hype uses 96 bit identifiers (which added with the realm adds up to 128 bits). 64 of those, 96 bits can be used for a custom identifier, which is called the vendor identifier. Vendor identifiers can be set when starting Hype’s services with HYPOptionIdentifierKey, and are queried back using -vendorIdentifier on each instance. This should be useful to help map instances with some useful entity, such as users. The -identifier property returns the instance’s full identifier, including the bytes generated by the SDK.

  • @abstract

    @discussion

    Declaration

    Objective-C

    @property (readonly, atomic) NSData *realm;

    Swift

    var realm: Data! { get }

  • @abstract

    @discussion

    Declaration

    Objective-C

    @property (readwrite, copy, atomic) NSString *realmStringIdentifier;

    Swift

    var realmStringIdentifier: String! { get set }

  • @abstract Instance identifier.

    @discussion This property yields an identifier that is unique for each instance on the network.

    Declaration

    Objective-C

    @property (readonly, atomic) NSData *identifier;

    Swift

    var identifier: Data! { get }

  • @abstract Instance string identifier.

    @discussion This property yields the instance’s identifier in string form. The string is the data object written using hexadecimal notation.

    Declaration

    Objective-C

    @property (readwrite, copy, atomic) NSString *stringIdentifier;

    Swift

    var stringIdentifier: String! { get set }

  • @abstract Vendor identifier.

    @discussion This property yields an identifier that was given by the vendor of the mapped device.

    Declaration

    Objective-C

    @property (readwrite, copy, atomic) NSData *vendorIdentifier;

    Swift

    var vendorIdentifier: Data! { get set }

  • @abstract Vendro string identifier.

    @discussion This property yields the vendor’s identifier in string form. The string is the data object written using hexadecimal notation.

    Declaration

    Objective-C

    @property (readwrite, copy, atomic) NSString *vendorStringIdentifier;

    Swift

    var vendorStringIdentifier: String! { get set }

  • @abstract Initializer.

    @discussion Initializes an instance object with the given identifier.

    Declaration

    Objective-C

    - (instancetype)initWithIdentifier:(NSData *)identifier;

    Swift

    init!(identifier: Data!)

    Parameters

    identifier

    Instance identifier.