Review Push API cs files
[platform/core/csapi/tizenfx.git] / src / Tizen.Messaging.Push / Tizen.Messaging.Push / PushMessageEventArgs.cs
1  /*
2  * Copyright (c) 2016 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 using System;
18
19 namespace Tizen.Messaging.Push
20 {
21     /// <summary>
22     /// An extended EventArgs class, which contains the message received.
23     /// </summary>
24     /// <since_tizen> 3 </since_tizen>
25     public class PushMessageEventArgs : EventArgs
26     {
27         /// <summary>
28         /// Gives the Application Data recieved. </summary>
29         /// <since_tizen> 3 </since_tizen>
30         /// <value>
31         /// It is the string, which stores the application data.</value>
32         public string AppData
33         {
34             get;
35             internal set;
36         }
37
38         /// <summary>
39         /// Gives the Message Received Field.
40         /// </summary>
41         /// <since_tizen> 3 </since_tizen>
42         /// <value>
43         /// It is the string, which stores the message field.</value>
44         public string Message
45         {
46             get;
47             internal set;
48         }
49
50         /// <summary>
51         /// Gives the time at which the Notification was received.
52         /// </summary>
53         /// <since_tizen> 3 </since_tizen>
54         /// <value>
55         /// It is the DateTime field representing the time at which the Notification was received.</value>
56         public DateTime ReceivedAt
57         {
58             get;
59             internal set;
60         }
61
62         /// <summary>
63         /// Gives the Sender of the notification.
64         /// </summary>
65         /// <since_tizen> 3 </since_tizen>
66         /// <value>
67         /// It is a string value representing the Sender of the Notification.</value>
68         public string Sender
69         {
70             get;
71             internal set;
72         }
73
74         /// <summary>
75         /// Gives the session ID of the notification.
76         /// </summary>
77         /// <since_tizen> 3 </since_tizen>
78         /// <value>
79         /// It is a string value representing the session ID of the Notification.</value>
80         public string SessionInfo
81         {
82             get;
83             internal set;
84         }
85
86         /// <summary>
87         /// Gives the request ID of the notification.
88         /// </summary>
89         /// <since_tizen> 3 </since_tizen>
90         /// <value>
91         /// It is a string value representing the request ID of the Notification.</value>
92         public string RequestId
93         {
94             get;
95             internal set;
96         }
97
98         /// <summary>
99         /// Gives the value in the type field of the notification.
100         /// </summary>
101         /// <since_tizen> 3 </since_tizen>
102         /// <value>
103         /// It is an integer value representing the type field of the notification.</value>
104         public int Type
105         {
106             get;
107             internal set;
108         }
109
110         internal PushMessageEventArgs()
111         {
112             // Giving Default Values
113             AppData = "";
114             Message = "";
115             ReceivedAt = new DateTime();
116             Sender = "";
117             SessionInfo= "";
118             RequestId = "";
119         }
120     }
121 }