CharacteristicNewAlert

@available(swift 3.1)
@available(iOS 10.0, tvOS 10.0, watchOS 3.0, macOS 10.12, *)
final public class CharacteristicNewAlert : Characteristic
extension CharacteristicNewAlert: Hashable
extension CharacteristicNewAlert: Equatable

BLE New Alert Characteristic

This characteristic defines the category of the alert and how many new alerts of that category have occurred in the server device. Brief text information may also be included for the last alert in the category

  • Characteristic Name

    Declaration

    Swift

    public static var name: String { get }

  • Characteristic UUID

    Declaration

    Swift

    public static var uuidString: String { get }

  • Name of the Characteristic

    Declaration

    Swift

    public var name: String { get }

  • Characteristic UUID String

    Declaration

    Swift

    public var uuidString: String { get }

  • Alert Type

    Category of the new alert

    Declaration

    Swift

    private(set) public var alertType: AlertCategory { get }

  • Number of New Alerts

    Provides the number of new alerts in the server

    Declaration

    Swift

    private(set) public var numberOfAlerts: UInt8 { get }

  • Alert Information

    Brief text information for the last alert

    Declaration

    Swift

    private(set) public var alertInformation: String? { get }

  • Creates New Alert Characteristic

    Declaration

    Swift

    public init(alertType: AlertCategory, numberOfAlerts: UInt8, alertInformation: String?)

    Parameters

    alertType

    Category of the new alert
    numberOfAlerts

    Number of New Alerts
    alertInformation

    Brief text information for the last alert

  • Decodes Characteristic Data into Characteristic

    Declaration

    Swift

    public class func decode<C>(with data: Data) -> Result<C, BluetoothDecodeError> where C : Characteristic

    Parameters

    data

    Characteristic Data

    Return Value

    Characteristic Result

  • Encodes the Characteristic into Data

    Declaration

    Swift

    public func encode() -> Result<Data, BluetoothEncodeError>

    Return Value

    Characteristic Data Result

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    Never call finalize() on hasher. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    public func hash(into hasher: inout Hasher)

    Parameters

    hasher

    The hasher to use when combining the components of this instance.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    public static func == (lhs: CharacteristicNewAlert, rhs: CharacteristicNewAlert) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.