src/Tizen.Maps/Tizen.Maps/IPlaceSearchPreference.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
  18 using System.Collections.Generic;
  19
  20 namespace Tizen.Maps
  21 {
  22     /// <summary>
  23     /// Preferences for place searches
  24     /// </summary>
  25     /// <since_tizen>3</since_tizen>
  26     public interface IPlaceSearchPreference
  27     {
  28         /// <summary>
  29         /// Gets or sets distance unit.
  30         /// </summary>
  31         /// <since_tizen>3</since_tizen>
  32         DistanceUnit Unit { get; set; }
  33
  34         /// <summary>
  35         /// Gets or sets preferred language.
  36         /// </summary>
  37         /// <since_tizen>3</since_tizen>
  38         /// <remarks>Language should be specified as an ISO 3166 alpha-2 two letter country-code
  39         /// followed by ISO 639-1 for the two-letter language code.<br/>e.g. "ko-KR", "en-US".</remarks>
  40         string Language { get; set; }
  41
  42         /// <summary>
  43         /// Gets or sets the maximum number of results.
  44         /// </summary>
  45         /// <since_tizen>3</since_tizen>
  46         int MaxResults { get; set; }
  47
  48         /// <summary>
  49         /// Gets or sets a string that represents code of preferred country.
  50         /// </summary>
  51         /// <since_tizen>3</since_tizen>
  52         string CountryCode { get; set; }
  53
  54         /// <summary>
  55         /// Gets or sets search properties as key value pair.
  56         /// </summary>
  57         /// <since_tizen>3</since_tizen>
  58         IReadOnlyDictionary<string, string> Properties { get; set; }
  59     }
  60 }