summaryrefslogtreecommitdiff
path: root/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs
blob: 878f9ffbf20f45c083413c5f163dafa5a6e86b10 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an AS IS BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace Tizen.Applications.NotificationEventListener
{
    using Tizen.Common;

    /// <summary>
    /// This class provides the methods and properties to get information about the posted or updated notification.
    /// </summary>
    public partial class NotificationEventArgs
    {
        /// <summary>
        /// Class for Notification AccessorySet which is included vibration, led, sound option
        /// </summary>
        public class AccessoryArgs
        {
            /// <summary>
            /// Gets the sound option.
            /// </summary>
            /// <example>
            /// <code>
            /// AccessoryOption vibrationOption = NotificationEventArgs.Accessory.SoundOption;
            /// </code>
            /// </example>
            public AccessoryOption SoundOption { get; internal set; }

            /// <summary>
            /// Gets the sound path.
            /// </summary>
            /// <example>
            /// <code>
            /// string soundPath = NotificationEventArgs.Accessory.SountPath;
            /// </code>
            /// </example>
            public string SountPath { get; internal set; }

            /// <summary>
            /// Gets the vibration option.
            /// </summary>
            /// <example>
            /// <code>
            /// bool vibrationOption = NotificationEventArgs.Accessory.CanVibrate;
            /// </code>
            /// </example>
            public bool CanVibrate { get; internal set; }

            /// <summary>
            /// Gets the led option.
            /// </summary>
            /// <example>
            /// <code>
            /// AccessoryOption ledOption = NotificationEventArgs.Accessory.LedOption;
            /// </code>
            /// </example>
            public AccessoryOption LedOption { get; internal set; }

            /// <summary>
            /// Gets led on time period that you would like the LED on the device to blink. as well as the rate.
            /// </summary>
            /// <value>
            /// Default value of LedOnMilliseconds is 0.
            /// The rate is specified in terms of the number of milliseconds to be on.
            /// You should always set the LedOnMillisecond and LedOffMillisecond. Otherwise, it may not operate normally.
            /// </value>
            /// <example>
            /// <code>
            /// int ledOnMillisecond = NotificationEventArgs.Accessory.LedOnMillisecond;
            /// </code>
            /// </example>
            public int LedOnMillisecond { get; internal set; }

            /// <summary>
            /// Gets led on time period that you would like the LED on the device to blink. as well as the rate.
            /// </summary>
            /// <value>
            /// Default value of LedOffMillisecond is 0.
            /// The rate is specified in terms of the number of millisecond to be off.
            /// You should always set the LedOnMillisecond and LedOffMillisecond. Otherwise, it may not operate normally.
            /// </value>
            /// <example>
            /// <code>
            /// int ledOffMillisecond = NotificationEventArgs.Accessory.LedOffMillisecond;
            /// </code>
            /// </example>
            public int LedOffMillisecond { get; internal set; }

            /// <summary>
            /// Gets led color that you would like the LED on the device to blink.
            /// </summary>
            /// <example>
            /// <code>
            /// Color ledColor = NotificationEventArgs.Accessory.LedColor;
            /// </code>
            /// </example>
            public Color LedColor { get; internal set; }
        }
    }
}