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         /// Type none.
 186         /// </summary>
 187         None = -1,
 188
 189         /// <summary>
 190         /// Notification type.
 191         /// </summary>
 192         Notification = 0,
 193
 194         /// <summary>
 195         /// Ongoing type.
 196         /// </summary>
 197         Ongoing,
 198     }
 199
 200     /// <summary>
 201     /// Enumeration for notification text type.
 202     /// </summary>
 203     internal enum NotificationText
 204     {
 205         /// <summary>
 206         /// Title.
 207         /// </summary>
 208         Title = 0,
 209
 210         /// <summary>
 211         /// Content.
 212         /// </summary>
 213         Content,
 214
 215         /// <summary>
 216         /// Text to display the event count.
 217         /// </summary>
 218         EventCount = 3,
 219
 220         /// <summary>
 221         /// Box contents 1.
 222         /// </summary>
 223         FirstMainText,
 224
 225         /// <summary>
 226         /// Box contents 1-1.
 227         /// </summary>
 228         FirstSubText,
 229
 230         /// <summary>
 231         /// Box contents 2.
 232         /// </summary>
 233         SecondMainText,
 234
 235         /// <summary>
 236         /// Box contents 2-1.
 237         /// </summary>
 238         SecondSubText,
 239
 240         /// <summary>
 241         /// Text on button 1.
 242         /// </summary>
 243         FirstButton = 13,
 244
 245         /// <summary>
 246         /// Text on button 2.
 247         /// </summary>
 248         SecondButton,
 249
 250         /// <summary>
 251         /// Text on button 3.
 252         /// </summary>
 253         ThirdButton,
 254
 255         /// <summary>
 256         /// Guide text on the message reply box.
 257         /// </summary>
 258         PlaceHolder = 19,
 259
 260         /// <summary>
 261         /// Text on button on the message reply box.
 262         /// </summary>
 263         InputButton = 20,
 264     }
 265
 266     /// <summary>
 267     /// Enumeration for the image type.
 268     /// </summary>
 269     internal enum NotificationImage
 270     {
 271         /// <summary>
 272         /// Icon.
 273         /// </summary>
 274         Icon = 0,
 275
 276         /// <summary>
 277         /// Indicator icon.
 278         /// </summary>
 279         Indicator,
 280
 281         /// <summary>
 282         ///  Lock screen icon.
 283         /// </summary>
 284         Lockscreen,
 285
 286         /// <summary>
 287         /// Thumbnail.
 288         /// </summary>
 289         Thumbnail,
 290
 291         /// <summary>
 292         /// Lock screen thumbnail.
 293         /// </summary>
 294         ThumbnailLockscreen,
 295
 296         /// <summary>
 297         /// Icon.
 298         /// </summary>
 299         SubIcon,
 300
 301         /// <summary>
 302         /// Image displayed on background.
 303         /// </summary>
 304         Background,
 305
 306         /// <summary>
 307         /// Image for button 1.
 308         /// </summary>
 309         Button_1 = 12,
 310
 311         /// <summary>
 312         /// Image for button 2.
 313         /// </summary>
 314         Button_2,
 315
 316         /// <summary>
 317         /// Image for button 3.
 318         /// </summary>
 319         Button_3,
 320
 321         /// <summary>
 322         /// Image for message reply.
 323         /// </summary>
 324         TextInputButton = 18,
 325     }
 326
 327     /// <summary>
 328     /// Enumeration for notification layout type.
 329     /// </summary>
 330     internal enum NotificationLayout
 331     {
 332         /// <summary>
 333         /// Default.
 334         /// </summary>
 335         None = 0,
 336
 337         /// <summary>
 338         /// Layout for notification. Used to inform single event.
 339         /// </summary>
 340         SingleEvent = 1,
 341
 342         /// <summary>
 343         /// Layout for notification. Used to display images.
 344         /// </summary>
 345         Thumbnail = 3,
 346
 347         /// <summary>
 348         /// Layout for ongoing notification. Used to display text message.
 349         /// </summary>
 350         OngoingEvent = 4,
 351
 352         /// <summary>
 353         /// Layout for ongoing notification. Used to display progress.
 354         /// </summary>
 355         OngoingProgress = 5,
 356     }
 357
 358     /// <summary>
 359     /// Enumeration for notification launch option type.
 360     /// </summary>
 361     internal enum LaunchOption
 362     {
 363         /// <summary>
 364         /// Launching with application control.
 365         /// </summary>
 366         AppControl = 1
 367     }
 368
 369     /// <summary>
 370     /// Enumeration for notification operation data code.
 371     /// </summary>
 372     internal enum NotificationOperationDataType
 373     {
 374         /// <summary>
 375         /// Default.
 376         /// </summary>
 377         Min = 0,
 378
 379         /// <summary>
 380         /// Operation type.
 381         /// </summary>
 382         Type,
 383
 384         /// <summary>
 385         /// Private ID.
 386         /// </summary>
 387         UniqueNumber,
 388
 389         /// <summary>
 390         /// Notification handler.
 391         /// </summary>
 392         Notification,
 393
 394         /// <summary>
 395         /// Reserved.
 396         /// </summary>
 397         ExtraInformation1,
 398
 399         /// <summary>
 400         /// Reserved.
 401         /// </summary>
 402         ExtraInformation2,
 403     }
 404
 405     /// <summary>
 406     /// Enumeration for notification operation code.
 407     /// </summary>
 408     internal enum NotificationOperationType
 409     {
 410         /// <summary>
 411         /// Default.
 412         /// </summary>
 413         None = 0,
 414
 415         /// <summary>
 416         /// Notification inserted.
 417         /// </summary>
 418         Insert,
 419
 420         /// <summary>
 421         /// Notification updated.
 422         /// </summary>
 423         Update,
 424
 425         /// <summary>
 426         /// Notification deleted.
 427         /// </summary>
 428         Delete,
 429     }
 430
 431     /// <summary>
 432     /// Enumeration for event type on notification.
 433     /// </summary>
 434     internal enum ClickEventType
 435     {
 436         /// <summary>
 437         /// Event type : Click on button 1.
 438         /// </summary>
 439         FirstButton = 0,
 440
 441         /// <summary>
 442         /// Event type : Click on button 2.
 443         /// </summary>
 444         SecondButton = 1,
 445
 446         /// <summary>
 447         /// Event type : Click on button 3.
 448         /// </summary>
 449         ThirdButton = 2,
 450
 451         /// <summary>
 452         /// Event type : Click on icon.
 453         /// </summary>
 454         Icon = 6,
 455
 456         /// <summary>
 457         /// Event type : Click on thumbnail.
 458         /// </summary>
 459         Thumbnail = 7,
 460
 461         /// <summary>
 462         /// Event type : Click on text_input button.
 463         /// </summary>
 464         InputButton = 8,
 465     }
 466
 467     /// <summary>
 468     /// Enumeration for display application list.
 469     /// </summary>
 470     [Flags]
 471     internal enum NotificationDisplayApplist
 472     {
 473         /// <summary>
 474         /// Notification Tray(Quickpanel).
 475         /// </summary>
 476         Tray = 0x00000001,
 477
 478         /// <summary>
 479         /// Ticker notification.
 480         /// </summary>
 481         Ticker = 0x00000002,
 482
 483         /// <summary>
 484         /// Lock screen.
 485         /// </summary>
 486         Lock = 0x00000004,
 487
 488         /// <summary>
 489         /// Indicator.
 490         /// </summary>
 491         Indicator = 0x00000008,
 492
 493         /// <summary>
 494         /// Active notification.
 495         /// </summary>
 496         Active = 0x00000010,
 497
 498         /// <summary>
 499         /// All display application except active notification.
 500         /// </summary>
 501         All = 0x0000000f,
 502     }
 503 }