src/Tizen.Applications.WatchfaceComplication/Tizen.Applications/ImageData.cs

   1 /*
   2  * Copyright (c) 2018 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 using System.Collections.Generic;
  19 using System.Text;
  20
  21 namespace Tizen.Applications.WatchfaceComplication
  22 {
  23     /// <summary>
  24     /// Represents the image data for a complication.
  25     /// </summary>
  26     /// <since_tizen> 6 </since_tizen>
  27     public class ImageData : ComplicationData
  28     {
  29         /// <summary>
  30         /// Initializes the ImageData class.
  31         /// </summary>
  32         /// <param name="imagePath">The image path.</param>
  33         /// <param name="extraData">The extra data.</param>
  34         /// <exception cref="ArgumentException">Thrown when parameter is invalid.</exception>
  35         /// <example>
  36         /// <code>
  37         ///     protected override ComplicationData OnDataUpdateRequested(string reqestAppId, ComplicationTypes type, Bundle contextData)
  38         ///     {
  39         ///         if (type == ComplicationTypes.Image)
  40         ///         {
  41         ///             return new ImageData("Image path", "extra");
  42         ///         }
  43         ///         else if (type == ComplicationTypes.LongText)
  44         ///         {
  45         ///             return new LongTextData("longlong", "icon path", "title", null);
  46         ///         }
  47         ///     }
  48         /// </code>
  49         /// </example>
  50         /// <since_tizen> 6 </since_tizen>
  51         public ImageData(string imagePath, string extraData)
  52         {
  53             if (imagePath == null)
  54                 ErrorFactory.ThrowException(ComplicationError.InvalidParam, "image path can not be null");
  55             Type = ComplicationTypes.Image;
  56             ImagePath = imagePath;
  57             ExtraData = extraData;
  58         }
  59
  60         /// <summary>
  61         /// The image path data.
  62         /// </summary>
  63         /// <exception cref="ArgumentException">Thrown when try to set invalid value.</exception>
  64         /// <since_tizen> 6 </since_tizen>
  65         public new string ImagePath
  66         {
  67             get
  68             {
  69                 return base.ImagePath;
  70             }
  71             set
  72             {
  73                 if (value == null)
  74                     ErrorFactory.ThrowException(ComplicationError.InvalidParam, "image path can not be null");
  75                 base.ImagePath = value;
  76             }
  77         }
  78
  79         /// <summary>
  80         /// The extra data.
  81         /// </summary>
  82         /// <since_tizen> 6 </since_tizen>
  83         public new string ExtraData
  84         {
  85             get
  86             {
  87                 return base.ExtraData;
  88             }
  89             set
  90             {
  91                 base.ExtraData = value;
  92             }
  93         }
  94
  95         /// <summary>
  96         /// The information about the screen reader text of complication data.
  97         /// </summary>
  98         /// <since_tizen> 6 </since_tizen>
  99         public new string ScreenReaderText
 100         {
 101             get
 102             {
 103                 return base.ScreenReaderText;
 104             }
 105             set
 106             {
 107                 base.ScreenReaderText = value;
 108             }
 109         }
 110     }
 111 }