summaryrefslogtreecommitdiff
path: root/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs
blob: e5fb8736ac5e0c4845bcfd0406e75a300c648869 (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
/*
 * 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
{
    /// <summary>
    /// This class provides the methods and properties to get information about the posted or updated notification.
    /// </summary>
    public partial class NotificationEventArgs
    {
        /// <summary>
        ///  Class to display the buttons on the active notification.
        /// </summary>
        public class ButtonActionArgs
        {
            /// <summary>
            /// Gets the Index of the Button which is appeared at Notification.
            /// </summary>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
            /// ButtonIndex index = button.Index;
            /// </code>
            /// </example>
            public ButtonIndex Index { get; internal set; }

            /// <summary>
            /// Gets the text that describes the button.
            /// </summary>
            /// <value>
            /// Default value is null.
            /// </value>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
            /// string text = button.Text;
            /// </code>
            /// </example>
            public string Text { get; internal set; }

            /// <summary>
            /// Gets the image's path that represent the button.
            /// </summary>
            /// <value>
            /// Default value is null.
            /// </value>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
            /// string imagePath = button.ImagePath;
            /// </code>
            /// </example>
            public string ImagePath { get; internal set; }

            /// <summary>
            /// Gets the AppControl that is invoked when the button is clicked.
            /// </summary>
            /// <value>
            /// Default value is null.
            /// </value>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = args.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// NotificationEventArgs.ButtonActionArgs button = style.Button;
            /// AppControl action = button.Action;
            /// </code>
            /// </example>
            public AppControl Action { get; internal set; }
        }
    }
}