Class BatteryStatistics

View Source

Definition

Namespace:
Tizen.Context.AppHistory
Assembly:
Tizen.Context.dll

This class provides APIs to query the battery consumption per application.


                
C#

                

                    
Copy

                    

                

            
public class BatteryStatistics : AppStatistics
Inheritance
object
AppStatistics
BatteryStatistics

Constructors

View Source

BatteryStatistics()

The default constructor of BatteryStatistics class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BatteryStatistics()
Exceptions
Type Condition
System.InvalidOperationException

Thrown when the method failed due to an internal error.
System.NotSupportedException

Thrown when the features are not supported.
View Source

BatteryStatistics(SortOrderType)

The constructor of BatteryStatistics class.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BatteryStatistics(BatteryStatistics.SortOrderType order)
Parameters
Type Name Description
BatteryStatistics.SortOrderType order

The criteria of the battery statistics sorted by.
Exceptions
Type Condition
System.ArgumentException

Thrown when an invalid argument is used.
System.InvalidOperationException

Thrown when the method failed due to an internal error.
System.NotSupportedException

Thrown when the features are not supported.

Properties

View Source

SortOrder

Gets the criteria of battery statistics sorted by.

Declaration

                
C#

                

                    
Copy

                    

                

            
public BatteryStatistics.SortOrderType SortOrder { get; }
Property Value
Type Description
BatteryStatistics.SortOrderType

The criteria of battery statistics sorted by.

Methods

View Source

GetLastFullyChargedTime()

Gets the last time when the device was fully charged.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static DateTime GetLastFullyChargedTime()
Returns
Type Description
System.DateTime

The last time when the device was fully charged.
Exceptions
Type Condition
System.NotSupportedException

Thrown when the statistics is not supported.
View Source

Query(DateTime, DateTime, uint)

Retrieves a given type of battery statistics.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IReadOnlyList<BatteryStatisticsData> Query(DateTime startTime, DateTime endTime, uint resultSize)
Parameters
Type Name Description
System.DateTime startTime

The start time of the data to be aggregated.
System.DateTime endTime

The end time of the data to be aggregated.
uint resultSize

The number of data records to be retrieved.
Returns
Type Description
System.Collections.Generic.IReadOnlyList<T><BatteryStatisticsData>

Battery statistics data retrieved.
Exceptions
Type Condition
System.ArgumentException

Thrown when an invalid argument is used.
System.InvalidOperationException

Thrown when an invalid operation occurs.
System.NotSupportedException

Thrown when the features are not supported.
System.UnauthorizedAccessException

Thrown when the application has no privilege to retrieve the application history.
View Source

Query(DateTime, DateTime)

Retrieves a given type of battery statistics.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IReadOnlyList<BatteryStatisticsData> Query(DateTime startTime, DateTime endTime)
Parameters
Type Name Description
System.DateTime startTime

The start time of the data to be aggregated.
System.DateTime endTime

The end time of the data to be aggregated.
Returns
Type Description
System.Collections.Generic.IReadOnlyList<T><BatteryStatisticsData>

Battery statistics data retrieved.
Exceptions
Type Condition
System.ArgumentException

Thrown when an invalid argument is used.
System.InvalidOperationException

Thrown when invalid operation occurs.
System.NotSupportedException

Thrown when the features are not supported.
System.UnauthorizedAccessException

Thrown when the application has no privilege to retrieve the application history.