Release 4.0.0-preview1-00051
[platform/core/csapi/tizenfx.git] / src / Tizen.Applications.NotificationEventListener / Tizen.Applications.NotificationEventListener / NotificationEventArgsAccessory.cs
1 /*
2  * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 namespace Tizen.Applications.NotificationEventListener
18 {
19     using Tizen.Common;
20
21     /// <summary>
22     /// This class provides the methods and properties to get information about the posted or updated notification.
23     /// </summary>
24     public partial class NotificationEventArgs
25     {
26         /// <summary>
27         /// Class to get infomation about Notification accessory.
28         /// </summary>
29         public class AccessoryArgs
30         {
31             /// <summary>
32             /// Gets the sound option.
33             /// </summary>
34             public AccessoryOption SoundOption { get; internal set; }
35
36             /// <summary>
37             /// Gets the sound path.
38             /// </summary>
39             public string SoundPath { get; internal set; }
40
41             /// <summary>
42             /// Gets the vibration option.
43             /// </summary>
44             public bool CanVibrate { get; internal set; }
45
46             /// <summary>
47             /// Gets the led option.
48             /// </summary>
49             public AccessoryOption LedOption { get; internal set; }
50
51             /// <summary>
52             /// Gets led on time period that you would like the LED on the device to blink. as well as the rate.
53             /// </summary>
54             /// <value>
55             /// Default value of LedOnMilliseconds is 0.
56             /// The rate is specified in terms of the number of milliseconds to be on.
57             /// </value>
58             public int LedOnMillisecond { get; internal set; }
59
60             /// <summary>
61             /// Gets led on time period that you would like the LED on the device to blink. as well as the rate.
62             /// </summary>
63             /// <value>
64             /// Default value of LedOffMillisecond is 0.
65             /// The rate is specified in terms of the number of millisecond to be off.
66             /// </value>
67             public int LedOffMillisecond { get; internal set; }
68
69             /// <summary>
70             /// Gets led color that you would like the LED on the device to blink.
71             /// </summary>
72             public Color LedColor { get; internal set; }
73         }
74     }
75 }