Skip to content

Commit

Permalink
[System.Feedback] Add feedback theme index range description
Browse files Browse the repository at this point in the history
The index of sound theme range is 1 ~ N according to conf file.
This index range should be considered when using feedback theme index getter/setter.

Signed-off-by: Yunhee Seo <[email protected]>
  • Loading branch information
Yunhee Seo authored and chanwoochoi committed Oct 19, 2023
1 parent 93887a3 commit 191b467
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/Tizen.System.Feedback/Feedback/Feedback.cs
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,7 @@ public void Stop()
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
/// Counts of theme range will be 1 ~ N according to conf file.
/// </remarks>
/// <since_tizen> 10 </since_tizen>
/// <param name="type">The feedback type.</param>
Expand Down Expand Up @@ -598,6 +599,7 @@ public uint GetCountOfThemeInternal(FeedbackType type)
/// </summary>
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
/// Index of theme range will be 1 ~ N according to conf file.
/// </remarks>
/// <since_tizen> 10 </since_tizen>
/// <param name="type">The feedback type.</param>
Expand Down Expand Up @@ -642,6 +644,7 @@ public uint GetThemeIndexInternal(FeedbackType type)
/// <remarks>
/// Now this internal API works for FeedbackType.Sound only, FeedbackType.Vibration is not supported.
/// To set the index of theme for Sound type, the application should have http://tizen.org/privilege/systemsettings.admin privilege.
/// Index of theme range is 1 ~ N according to conf file. If you put the wrong index, operation cannot be guaranteed.
/// </remarks>
/// <since_tizen> 10 </since_tizen>
/// <param name="type">The feedback type.</param>
Expand All @@ -653,7 +656,7 @@ public uint GetThemeIndexInternal(FeedbackType type)
/// <example>
/// <code>
/// Feedback feedback = new Feedback();
/// uint indexOfTheme = 0;
/// uint indexOfTheme = 1;
/// feedback.SetThemeIndexInternal(FeedbackType.Sound, indexOfTheme);
/// </code>
/// </example>
Expand Down

0 comments on commit 191b467

Please sign in to comment.