Class SleepMonitor

    Definition

    Namespace:
    Tizen.Sensor
    Assembly:
    Tizen.Sensor.dll

    The SleepMonitor class is used for registering callbacks for the sleep monitor and getting the sleep data.

    public sealed class SleepMonitor : Sensor, IDisposable
    Inheritance
    object
    Sensor
    SleepMonitor
    Implements
    System.IDisposable

    Constructors

    View Source

    SleepMonitor(uint)

    Initialize a new instance of the SleepMonitor class.

    Declaration
    public SleepMonitor(uint index = 0)
    Parameters
    Type Name Description
    uint index

    Index refers to a particular sleep monitor in case of multiple sensors. Default value is 0.

    Exceptions
    Type Condition
    System.ArgumentException

    Thrown when an invalid argument is used.

    System.NotSupportedException

    Thrown when the sensor is not supported.

    System.UnauthorizedAccessException

    Thrown when the application has no privilege to use the sensor.

    System.InvalidOperationException

    Thrown when the operation is invalid for the current state.

    Properties

    View Source

    Count

    Return the number of sleep monitors available on the system.

    Declaration
    public static int Count { get; }
    Property Value
    Type Description
    int

    The count of sleep monitors.

    View Source

    IsSupported

    Return true or false based on whether the sleep monitor is supported by the device.

    Declaration
    public static bool IsSupported { get; }
    Property Value
    Type Description
    bool

    true if supported; otherwise false.

    View Source

    SleepState

    Get the value of the sleep state as enum SleepMonitorState type.

    Declaration
    public SleepMonitorState SleepState { get; }
    Property Value
    Type Description
    SleepMonitorState

    The sleep state, SleepMonitorState.

    Events

    View Source

    DataUpdated

    An event handler for storing the callback functions for the event corresponding to the change in the sleep monitor data.

    Declaration
    public event EventHandler<SleepMonitorDataUpdatedEventArgs> DataUpdated
    Event Type
    Type Description
    System.EventHandler<TEventArgs><SleepMonitorDataUpdatedEventArgs>

    Implements

    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX