AttentionTimerDelegate.swift

/*
* Copyright (c) 2025, Nordic Semiconductor
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
*    list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this
*    list of conditions and the following disclaimer in the documentation and/or
*    other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its contributors may
*    be used to endorse or promote products derived from this software without
*    specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
* INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import Foundation

/// An Attention Timer Delegate is used to notify the app about the Attention Timer state.
///
/// The Attention Timer is used to attract the user's attention to the device.
///
/// It may only be started and stopped by sending a ``HealthAttentionSet`` or
/// ``HealthAttentionSetUnacknowledged`` message to the main Element
/// of the local Node.
public protocol AttentionTimerDelegate: AnyObject {
    
    /// A callback called when the Attention Timer state has been started..
    ///
    /// The app should start attracting the user's attention.
    ///
    /// - parameter duration: The time after which the Attention Timer will time out, in range 1-255 seconds.
    func attentionTimerDidStart(duration: TimeInterval)
    
    /// A callback called when the Attention Timer state has been stopped.
    ///
    /// This callback is called when the Attention Timer times out, or is stopped
    /// remotely by a remote user.
    func attentionTimerDidStop()
}