src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.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     using System;
  20     using System.ComponentModel;
  21
  22     /// <summary>
  23     /// Enumeration for the progress category.
  24     /// </summary>
  25     /// <since_tizen> 4 </since_tizen>
  26     public enum ProgressCategory
  27     {
  28         /// <summary>
  29         /// Value for the percent type.
  30         /// </summary>
  31         Percent,
  32
  33         /// <summary>
  34         /// Value for the time type.
  35         /// </summary>
  36         Time,
  37
  38         /// <summary>
  39         /// Value for the pending type, which is not the updated progress current value.
  40         /// </summary>
  41         PendingBar
  42     }
  43
  44     /// <summary>
  45     /// Enumeration for the accessory option.
  46     /// </summary>
  47     /// <since_tizen> 4 </since_tizen>
  48     public enum AccessoryOption
  49     {
  50         /// <summary>
  51         /// Value for off accessory option.
  52         /// </summary>
  53         Off = -1,
  54
  55         /// <summary>
  56         /// Value for on accessory option.
  57         /// </summary>
  58         On,
  59
  60         /// <summary>
  61         /// Value for the custom accessory option.
  62         /// </summary>
  63         Custom
  64     }
  65
  66     /// <summary>
  67     /// Enumeration for the button index.
  68     /// </summary>
  69     /// <since_tizen> 4 </since_tizen>
  70     public enum ButtonIndex
  71     {
  72         /// <summary>
  73         /// Value for the default button index.
  74         /// </summary>
  75         None = -1,
  76
  77         /// <summary>
  78         /// Value for the first button index.
  79         /// </summary>
  80         First,
  81
  82         /// <summary>
  83         /// Value for the second button index.
  84         /// </summary>
  85         Second,
  86
  87         /// <summary>
  88         /// Value for the third button index.
  89         /// </summary>
  90         Third
  91     }
  92
  93     /// <summary>
  94     /// Enumeration for the notification particular property.
  95     /// </summary>
  96     /// <since_tizen> 4 </since_tizen>
  97     [Flags]
  98     public enum NotificationProperty
  99     {
 100         /// <summary>
 101         /// Value for the adjust nothing.
 102         /// </summary>
 103         None = 0x00,
 104
 105         /// <summary>
 106         /// Value for display only when SIM card inserted.
 107         /// </summary>
 108         DisplayOnlySimMode = 0x01,
 109
 110         /// <summary>
 111         /// Value for disable application launch when it is selected.
 112         /// </summary>
 113         DisableAppLaunch = 0x02,
 114
 115         /// <summary>
 116         /// Value for disable auto delete when it is selected.
 117         /// </summary>
 118         DisableAutoDelete = 0x04,
 119
 120         /// <summary>
 121         /// Value for deleted when device is rebooted even though notification is not set OngoingType.
 122         /// </summary>
 123         VolatileDisplay = 0x100,
 124     }
 125
 126     /// <summary>
 127     /// Enumeration for event type on notification.
 128     /// </summary>
 129     /// <since_tizen> 4 </since_tizen>
 130     [EditorBrowsable(EditorBrowsableState.Never)]
 131     public enum UserEventType
 132     {
 133         /// <summary>
 134         /// Event type : Click on button 1.
 135         /// </summary>
 136         ClickOnButton1 = 0,
 137
 138         /// <summary>
 139         /// Event type : Click on button 2.
 140         /// </summary>
 141         ClickOnButton2,
 142
 143         /// <summary>
 144         /// Event type : Click on button 3.
 145         /// </summary>
 146         ClickOnButton3,
 147
 148         /// <summary>
 149         /// Event type : Click on text_input button.
 150         /// </summary>
 151         ClickOnReplyButton = 8,
 152
 153         /// <summary>
 154         /// Event type : Hidden by user.
 155         /// </summary>
 156         HiddenByUser = 100,
 157
 158         /// <summary>
 159         /// Event type : Deleted by timer.
 160         /// </summary>
 161         HiddenByTimeout = 101,
 162
 163         /// <summary>
 164         /// Event type : Deleted by timer.
 165         /// </summary>
 166         HiddenByExternal = 102,
 167
 168         /// <summary>
 169         /// Event type : Clicked by user.
 170         /// </summary>
 171         ClickOnNotification = 200,
 172
 173         /// <summary>
 174         /// Event type : Deleted by user.
 175         /// </summary>
 176         DeleteNotification = 201,
 177     }
 178
 179     /// <summary>
 180     /// Enumeration for notification type.
 181     /// </summary>
 182     internal enum NotificationType
 183     {
 184         /// <summary>
 185         /// Notification type.
 186         /// </summary>
 187         Notification = 0,
 188
 189         /// <summary>
 190         /// Ongoing type.
 191         /// </summary>
 192         Ongoing,
 193     }
 194
 195     /// <summary>
 196     /// Enumeration for notification text type.
 197     /// </summary>
 198     internal enum NotificationText
 199     {
 200         /// <summary>
 201         /// Title.
 202         /// </summary>
 203         Title = 0,
 204
 205         /// <summary>
 206         /// Content.
 207         /// </summary>
 208         Content,
 209
 210         /// <summary>
 211         /// Text to display the event count.
 212         /// </summary>
 213         EventCount = 3,
 214
 215         /// <summary>
 216         /// Box contents 1.
 217         /// </summary>
 218         FirstMainText,
 219
 220         /// <summary>
 221         /// Box contents 1-1.
 222         /// </summary>
 223         FirstSubText,
 224
 225         /// <summary>
 226         /// Box contents 2.
 227         /// </summary>
 228         SecondMainText,
 229
 230         /// <summary>
 231         /// Box contents 2-1.
 232         /// </summary>
 233         SecondSubText,
 234
 235         /// <summary>
 236         /// Text on button 1.
 237         /// </summary>
 238         FirstButton = 13,
 239
 240         /// <summary>
 241         /// Text on button 2.
 242         /// </summary>
 243         SecondButton,
 244
 245         /// <summary>
 246         /// Text on button 3.
 247         /// </summary>
 248         ThirdButton,
 249
 250         /// <summary>
 251         /// Guide text on the message reply box.
 252         /// </summary>
 253         PlaceHolder = 19,
 254
 255         /// <summary>
 256         /// Text on button on the message reply box.
 257         /// </summary>
 258         InputButton = 20,
 259     }
 260
 261     /// <summary>
 262     /// Enumeration for the image type.
 263     /// </summary>
 264     internal enum NotificationImage
 265     {
 266         /// <summary>
 267         /// Icon.
 268         /// </summary>
 269         Icon = 0,
 270
 271         /// <summary>
 272         /// Indicator icon.
 273         /// </summary>
 274         Indicator,
 275
 276         /// <summary>
 277         ///  Lock screen icon.
 278         /// </summary>
 279         Lockscreen,
 280
 281         /// <summary>
 282         /// Thumbnail.
 283         /// </summary>
 284         Thumbnail,
 285
 286         /// <summary>
 287         /// Lock screen thumbnail.
 288         /// </summary>
 289         ThumbnailLockscreen,
 290
 291         /// <summary>
 292         /// Icon.
 293         /// </summary>
 294         SubIcon,
 295
 296         /// <summary>
 297         /// Image displayed on background.
 298         /// </summary>
 299         Background,
 300
 301         /// <summary>
 302         /// Image for button 1.
 303         /// </summary>
 304         Button_1 = 12,
 305
 306         /// <summary>
 307         /// Image for button 2.
 308         /// </summary>
 309         Button_2,
 310
 311         /// <summary>
 312         /// Image for button 3.
 313         /// </summary>
 314         Button_3,
 315
 316         /// <summary>
 317         /// Image for message reply.
 318         /// </summary>
 319         TextInputButton = 18,
 320     }
 321
 322     /// <summary>
 323     /// Enumeration for notification layout type.
 324     /// </summary>
 325     internal enum NotificationLayout
 326     {
 327         /// <summary>
 328         /// Default.
 329         /// </summary>
 330         None = 0,
 331
 332         /// <summary>
 333         /// Layout for notification. Used to inform single event.
 334         /// </summary>
 335         SingleEvent = 1,
 336
 337         /// <summary>
 338         /// Layout for notification. Used to display images.
 339         /// </summary>
 340         Thumbnail = 3,
 341
 342         /// <summary>
 343         /// Layout for ongoing notification. Used to display text message.
 344         /// </summary>
 345         OngoingEvent = 4,
 346
 347         /// <summary>
 348         /// Layout for ongoing notification. Used to display progress.
 349         /// </summary>
 350         OngoingProgress = 5,
 351     }
 352
 353     /// <summary>
 354     /// Enumeration for notification launch option type.
 355     /// </summary>
 356     internal enum LaunchOption
 357     {
 358         /// <summary>
 359         /// Launching with application control.
 360         /// </summary>
 361         AppControl = 1
 362     }
 363
 364     /// <summary>
 365     /// Enumeration for notification operation data code.
 366     /// </summary>
 367     internal enum NotificationOperationDataType
 368     {
 369         /// <summary>
 370         /// Default.
 371         /// </summary>
 372         Min = 0,
 373
 374         /// <summary>
 375         /// Operation type.
 376         /// </summary>
 377         Type,
 378
 379         /// <summary>
 380         /// Private ID.
 381         /// </summary>
 382         UniqueNumber,
 383
 384         /// <summary>
 385         /// Notification handler.
 386         /// </summary>
 387         Notification,
 388
 389         /// <summary>
 390         /// Reserved.
 391         /// </summary>
 392         ExtraInformation1,
 393
 394         /// <summary>
 395         /// Reserved.
 396         /// </summary>
 397         ExtraInformation2,
 398     }
 399
 400     /// <summary>
 401     /// Enumeration for notification operation code.
 402     /// </summary>
 403     internal enum NotificationOperationType
 404     {
 405         /// <summary>
 406         /// Default.
 407         /// </summary>
 408         None = 0,
 409
 410         /// <summary>
 411         /// Notification inserted.
 412         /// </summary>
 413         Insert,
 414
 415         /// <summary>
 416         /// Notification updated.
 417         /// </summary>
 418         Update,
 419
 420         /// <summary>
 421         /// Notification deleted.
 422         /// </summary>
 423         Delete,
 424     }
 425
 426     /// <summary>
 427     /// Enumeration for event type on notification.
 428     /// </summary>
 429     internal enum ClickEventType
 430     {
 431         /// <summary>
 432         /// Event type : Click on button 1.
 433         /// </summary>
 434         FirstButton = 0,
 435
 436         /// <summary>
 437         /// Event type : Click on button 2.
 438         /// </summary>
 439         SecondButton = 1,
 440
 441         /// <summary>
 442         /// Event type : Click on button 3.
 443         /// </summary>
 444         ThirdButton = 2,
 445
 446         /// <summary>
 447         /// Event type : Click on icon.
 448         /// </summary>
 449         Icon = 6,
 450
 451         /// <summary>
 452         /// Event type : Click on thumbnail.
 453         /// </summary>
 454         Thumbnail = 7,
 455
 456         /// <summary>
 457         /// Event type : Click on text_input button.
 458         /// </summary>
 459         InputButton = 8,
 460     }
 461
 462     /// <summary>
 463     /// Enumeration for display application list.
 464     /// </summary>
 465     [Flags]
 466     internal enum NotificationDisplayApplist
 467     {
 468         /// <summary>
 469         /// Notification Tray(Quickpanel).
 470         /// </summary>
 471         Tray = 0x00000001,
 472
 473         /// <summary>
 474         /// Ticker notification.
 475         /// </summary>
 476         Ticker = 0x00000002,
 477
 478         /// <summary>
 479         /// Lock screen.
 480         /// </summary>
 481         Lock = 0x00000004,
 482
 483         /// <summary>
 484         /// Indicator.
 485         /// </summary>
 486         Indicator = 0x00000008,
 487
 488         /// <summary>
 489         /// Active notification.
 490         /// </summary>
 491         Active = 0x00000010,
 492
 493         /// <summary>
 494         /// All display application except active notification.
 495         /// </summary>
 496         All = 0x0000000f,
 497     }
 498 }