src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsBigPictureStyle.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 BigPicture style notification
  26         /// </summary>
  27         public class BigPictureStyleArgs : StyleArgs
  28         {
  29             /// <summary>
  30             /// Gets the path of the image file to display on the image of BigPicture style.
  31             /// </summary>
  32             /// <example>
  33             /// <code>
  34             /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
  35             /// string imagePath = style.ImagePath;
  36             /// </code>
  37             /// </example>
  38             public string ImagePath { get; internal set; }
  39
  40             /// <summary>
  41             /// Gets the size image to display on the image of BigPicture style.
  42             /// </summary>
  43             /// <example>
  44             /// <code>
  45             /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
  46             /// int imagesize = imagePath = style.ImageSize;
  47             /// </code>
  48             /// </example>
  49             public int ImageSize { get; internal set; }
  50
  51             /// <summary>
  52             /// Gets the content to display BigPicture style.
  53             /// </summary>
  54             /// <example>
  55             /// <code>
  56             /// NotificationEventArgs.BigPictureStyleArgs style = NotificationEventArgs.GetStyle<NotificationEventArgs.BigPictureStyleArgs>();
  57             /// string content = imagePath = style.Content;
  58             /// </code>
  59             /// </example>
  60             public string Content { get; internal set; }
  61
  62             internal override string Key
  63             {
  64                 get
  65                 {
  66                     return "BigPicture";
  67                 }
  68             }
  69         }
  70     }
  71 }