src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.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 using System.Collections.Generic;
  19
  20 namespace Tizen.Applications
  21 {
  22     /// <summary>
  23     /// This class is a parameter of the GetInstalledApplicationsAsync method.
  24     /// </summary>
  25     /// <since_tizen> 3 </since_tizen>
  26     public class ApplicationInfoFilter
  27     {
  28         /// <summary>
  29         /// A constructor of ApplicationInfoFilter class.
  30         /// </summary>
  31         /// <since_tizen> 3 </since_tizen>
  32         public ApplicationInfoFilter()
  33         {
  34             Filter = new Dictionary<string, string>();
  35         }
  36
  37         /// <summary>
  38         /// This class is a possible value to use in the InstalledApplicationFilter.
  39         /// </summary>
  40         /// <since_tizen> 5 </since_tizen>
  41 #pragma warning disable CA1034
  42         public static class Values
  43 #pragma warning restore CA1034
  44         {
  45             /// <summary>
  46             /// A pre-defined value string for InstalledStorage key. This value indicates that the application is installed at internal storage.
  47             /// </summary>
  48             /// <since_tizen> 5 </since_tizen>
  49             public const string InstalledInternal = "installed_internal";
  50
  51             /// <summary>
  52             /// A pre-defined value string for InstalledStorage key. This value indicates that the application is installed at external storage.
  53             /// </summary>
  54             /// <since_tizen> 5 </since_tizen>
  55             public const string InstalledExternal = "installed_external";
  56
  57             /// <summary>
  58             /// A pre-defined value string for InstalledStorage key. This value indicates that the application is installed at extended storage.
  59             /// </summary>
  60             /// <since_tizen> 5 </since_tizen>
  61             public const string InstalledExtended = "installed_extended";
  62         }
  63
  64         /// <summary>
  65         /// This class is a possible key to use in the InstalledApplicationFilter.
  66         /// </summary>
  67         /// <since_tizen> 3 </since_tizen>
  68 #pragma warning disable CA1034
  69         public static class Keys
  70 #pragma warning restore CA1034
  71         {
  72             /// <summary>
  73             /// A key to filter by application id.
  74             /// </summary>
  75             /// <since_tizen> 3 </since_tizen>
  76             public const string Id = "PACKAGE_INFO_PROP_APP_ID";
  77             /// <summary>
  78             /// A key to filter by application type.
  79             /// </summary>
  80             /// <since_tizen> 3 </since_tizen>
  81             public const string Type = "PACKAGE_INFO_PROP_APP_TYPE";
  82             /// <summary>
  83             /// A key to filter by application category.
  84             /// </summary>
  85             /// <since_tizen> 3 </since_tizen>
  86             public const string Category = "PACKAGE_INFO_PROP_APP_CATEGORY";
  87             /// <summary>
  88             /// A key to filter by installed storage.
  89             /// </summary>
  90             /// <since_tizen> 5 </since_tizen>
  91             public const string InstalledStorage = "PACKAGE_INFO_PROP_APP_INSTALLED_STORAGE";
  92             /// <summary>
  93             /// A key to filter by nodisplay attribute.
  94             /// </summary>
  95             /// <since_tizen> 3 </since_tizen>
  96             public const string NoDisplay = "PACKAGE_INFO_PROP_APP_NODISPLAY";
  97             /// <summary>
  98             /// A key to filter by taskmanage attribute.
  99             /// </summary>
 100             /// <since_tizen> 3 </since_tizen>
 101             public const string TaskManage = "PACKAGE_INFO_PROP_APP_TASKMANAGE";
 102         }
 103
 104         /// <summary>
 105         /// A dictionary to store keys and values of filter.
 106         /// </summary>
 107         /// <since_tizen> 3 </since_tizen>
 108         public IDictionary<string, string> Filter
 109         {
 110             get; private set;
 111         }
 112     }
 113 }