Class ProximitySensor

View Source

Definition

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

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
object
Sensor
ProximitySensor
Implements
System.IDisposable

Constructors

View Source

ProximitySensor(uint)

Initialize a new instance of the ProximitySensor class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ProximitySensor(uint index = 0)
Parameters
Type Name Description
uint index

Index refers to a particular proximity sensor 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.InvalidOperationException

Thrown when the operation is invalid for the current state.

Properties

View Source

Count

Return the number of proximity sensors available on the system.

Declaration

                
C#

                

                    
Copy

                    

                

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

The count of proximity sensors.
View Source

IsSupported

Return 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
bool

true if supported; otherwise false.
View Source

Proximity

Get the proximity state as enum ProximitySensorState type.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ProximitySensorState Proximity { get; }
Property Value
Type Description
ProximitySensorState

The proximity state, ProximitySensorState.

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<TEventArgs><ProximitySensorDataUpdatedEventArgs>

Implements

System.IDisposable