Class SleepMonitor

Definition

Namespace:: Tizen.Sensor

Assembly:: Tizen.Sensor.dll

API Level:: 3

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


                C#
                
                    Copy
                    
                
            
public sealed class SleepMonitor : Sensor, IDisposable

Inheritance: System.Object

Sensor

SleepMonitor

Implements: System.IDisposable

Constructors

View Source

SleepMonitor(UInt32)

Initializes a new instance of the SleepMonitor class.

Declaration


                C#
                
                    Copy
                    
                
            
public SleepMonitor(uint index = 0U)

Parameters

Type	Name	Description
System.UInt32	index	Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors.

Exceptions

Type	Condition
System.ArgumentException	Thrown when an invalid argument is used.
System.NotSupportedException	Thrown when the sensor is not supported.
UnauthorizedAccessException	Thrown when the application has no privilege to use the sensor.
System.InvalidOperationException	Thrown when the operation is invalid for the current state.

API Level: 3

Privilege Level: public

Privilege: http://tizen.org/privilege/healthinfo

Feature: http://tizen.org/feature/sensor.sleep_monitor

Properties

View Source

Count

Returns the number of sleep monitors available on the device.

Declaration


                C#
                
                    Copy
                    
                
            
public static int Count { get; }

Property Value

Type	Description
Int32	The count of sleep monitors.

API Level: 3

View Source

IsSupported

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

Declaration


                C#
                
                    Copy
                    
                
            
public static bool IsSupported { get; }

Property Value

Type	Description
Boolean	`true` if supported; otherwise `false`.

API Level: 3

View Source

SleepState

Gets the value of the sleep state.

Declaration


                C#
                
                    Copy
                    
                
            
public SleepMonitorState SleepState { get; }

Property Value

Type	Description
SleepMonitorState	The sleep state.

API Level: 3

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


                C#
                
                    Copy
                    
                
            
public event EventHandler<SleepMonitorDataUpdatedEventArgs> DataUpdated

Event Type

Type	Description
System.EventHandler<SleepMonitorDataUpdatedEventArgs>

API Level: 3

Implements

System.IDisposable