Class ProximitySensor

Definition

Namespace:: Tizen.Sensor

Assembly:: Tizen.Sensor.dll

API Level:: 3

The ProximitySensor class is used for registering callbacks for the proximity sensor and getting the proximity data.


                C#
                
                    Copy
                    
                
            
public sealed class ProximitySensor : Sensor, IDisposable

Inheritance: System.Object

Sensor

ProximitySensor

Implements: System.IDisposable

Constructors

View Source

ProximitySensor(UInt32)

Initializes a new instance of the ProximitySensor class.

Declaration


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

Parameters

Type	Name	Description
System.UInt32	index	Index. Default value for this is 0. Index refers to a particular proximity sensor 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.
System.InvalidOperationException	Thrown when the operation is invalid for the current state.

API Level: 3

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

Properties

View Source

Count

Returns the number of proximity sensors available on the device.

Declaration


                C#
                
                    Copy
                    
                
            
public static int Count { get; }

Property Value

Type	Description
System.Int32	The count of proximity sensors.

API Level: 3

View Source

IsSupported

Returns true or false based on whether the proximity sensor is supported by the device.

Declaration


                C#
                
                    Copy
                    
                
            
public static bool IsSupported { get; }

Property Value

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

API Level: 3

View Source

Proximity

Gets the proximity state.

Declaration


                C#
                
                    Copy
                    
                
            
public ProximitySensorState Proximity { get; }

Property Value

Type	Description
ProximitySensorState	The proximity 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 proximity sensor data.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler<ProximitySensorDataUpdatedEventArgs> DataUpdated

Event Type

Type	Description
System.EventHandler<ProximitySensorDataUpdatedEventArgs>

API Level: 3

Implements

System.IDisposable