Update the summary that describes the class
[platform/core/csapi/tizenfx.git] / src / Tizen.Applications.NotificationEventListener / Tizen.Applications.NotificationEventListener / NotificationEventArgsLockStyle.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     /// <summary>
20     /// This class provides the methods and properties to get information about the posted or updated notification.
21     /// </summary>
22     public partial class NotificationEventArgs
23     {
24         /// <summary>
25         ///  Class to generate the Lock style notification.
26         /// </summary>
27         public class LockStyleArgs : StyleArgs
28         {
29             /// <summary>
30             /// Gets the path of the image file to display on the icon of Lock style.
31             /// </summary>
32             /// <example>
33             /// <code>
34             /// string iconPath = NotificationEventArgs.LockStyleArgs.IconPath;
35             /// </code>
36             /// </example>
37             public string IconPath { get; internal set; }
38
39             /// <summary>
40             /// Gets the path of the thumbnail image file to display on the icon of Lock style.
41             /// </summary>
42             /// <example>
43             /// <code>
44             /// string thumbnail = NotificationEventArgs.LockStyleArgs.Thumbnail;
45             /// </code>
46             /// </example>
47             public string Thumbnail { get; internal set; }
48
49             internal override string Key
50             {
51                 get
52                 {
53                     return "Lock";
54                 }
55             }
56         }
57     }
58 }