Skip to content

Commit

Permalink
[Tizen.System.PowerUsage] Update the description of APIs
Browse files Browse the repository at this point in the history
Update the description of Tizen.System.PowerUsage APIs

Signed-off-by: Unsung Lee <[email protected]>
  • Loading branch information
Unsung Lee authored and chanwoochoi committed Sep 30, 2024
1 parent 40120a6 commit 724a619
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions src/Tizen.System.PowerUsage/PowerUsage/PowerUsage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,18 @@ public static double GetPowerUsage(PowerUsageResourceType rtype, DateTime start,
return batteryUsage;
}

/// <summary>
/// Gets the battery consumption in mAh (milli-Ampere hour) for specific resource from available data usage handle.
/// </summary>
/// <since_tizen> 7 </since_tizen>
/// <param name="dataHandle">Battery consumption data usage handle.</param>
/// <param name="rtype">Identifier of resource type. BLE, WiFi, CPU etc.</param>
/// <returns>Returns the battery usage in mAh(milli-Ampere hour) by a resource.</returns>
/// <feature>http://tizen.org/feature/battery</feature>
/// <privilege>http://tizen.org/privilege/systemmonitor</privilege>
/// <exception cref="ArgumentException">When an invalid parameter value is set.</exception>
/// <exception cref="UnauthorizedAccessException">If the privilege is not set.</exception>
/// <exception cref="NotSupportedException">In case power usage is not supported</exception>
private static double GetPowerUsage(IntPtr dataHandle, PowerUsageResourceType rtype)
{
double batteryUsage = 0;
Expand Down

0 comments on commit 724a619

Please sign in to comment.