summaryrefslogtreecommitdiff
path: root/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs
blob: 10af32431bd87c9c9c4c313e863a1b175f204707 (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
113
114
115
116
117
118
119
120
/*
 * 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 System.Collections.Generic;

    /// <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 generate the Active style notification
        /// </summary>
        public class ActiveStyleArgs : StyleArgs
        {
            /// <summary>
            /// Initializes a new instance of the <see cref="ActiveStyleArgs"/> class.
            /// </summary>
            public ActiveStyleArgs()
            {
                Button = new List<ButtonActionArgs>();
            }

            /// <summary>
            /// Gets the IsAutoRemove option of the active notification.
            /// IsAutoRemove option lets the active notification be removed several seconds after it shows.
            /// </summary>
            /// <value>
            /// When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes
            /// the active notification or the app which posted the active notification removes the active notification.
            /// </value>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// bool isAutoRemove = style.IsAutoRemove;
            /// </code>
            /// </example>
            public bool IsAutoRemove { get; internal set; }

            /// <summary>
            /// Gets an absolute path for an image file to display on the background of active notification.
            /// </summary>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// string path = style.BackgroundImage;
            /// </code>
            /// </example>
            public string BackgroundImage { get; internal set; }

            /// <summary>
            /// Gets timeout value in second when the notification can be hidden from the viewer.
            /// </summary>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// int hideTimeout = style.HideTimeout;
            /// </code>
            /// </example>
            public int HideTimeout { get; internal set; }

            /// <summary>
            /// Gets timeout value in second when the notification can be deleted from the viewer.
            /// </summary>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// int deleteTimeout = style.DeleteTimeout;
            /// </code>
            /// </example>
            public int DeleteTimeout { get; internal set; }

            /// <summary>
            /// Gets a button to this active notification style.
            /// Buttons are displayed in the notification content.
            /// </summary>
            /// <example>
            /// <code>
            /// IList<ButtonActionArgs> button = NotificationEventArgs.ActiveStyleArgs.Button;
            /// </code>
            /// </example>
            public IList<ButtonActionArgs> Button { get; internal set; }

            /// <summary>
            /// Gets a button to this active notification style.
            /// Buttons are displayed in the notification content.
            /// </summary>
            /// <example>
            /// <code>
            /// NotificationEventArgs.ActiveStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.ActiveStyleArgs>();
            /// ReplyActionArgs reply = style.Replay;
            /// </code>
            /// </example>
            public ReplyActionArgs Reply { get; internal set; }

            internal override string Key
            {
                get
                {
                    return "Active";
                }
            }
        }
    }
}