Modify documentation of APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / Tizen.Maps / PlaceImage.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
19 namespace Tizen.Maps
20 {
21     /// <summary>
22     /// Place Image information, used in Place Discovery and Search requests
23     /// </summary>
24     public class PlaceImage
25     {
26         private string _id;
27         private string _url;
28         private int _width;
29         private int _height;
30         private PlaceLink _userLink;
31         private PlaceMedia _media;
32
33         internal PlaceImage(Interop.PlaceImageHandle handle)
34         {
35             _id = handle.Id;
36             _url = handle.Url;
37             _width = handle.Width;
38             _height = handle.Height;
39             _userLink = new PlaceLink(handle.User);
40             _media = new PlaceMedia(handle.Media);
41         }
42
43         /// <summary>
44         /// Gets an ID for this place image.
45         /// </summary>
46         public string Id { get { return _id; } }
47
48         /// <summary>
49         /// Gets an URL for this place image.
50         /// </summary>
51         public string Url { get { return _url; } }
52
53         /// <summary>
54         /// Gets width for this place image.
55         /// </summary>
56         public int Width { get { return _width; } }
57
58         /// <summary>
59         /// Gets height for this place image.
60         /// </summary>
61         public int Height { get { return _height; } }
62
63         /// <summary>
64         /// Gets an object which representing user link for this place image.
65         /// </summary>
66         public PlaceLink UserLink { get { return _userLink; } }
67
68         /// <summary>
69         /// Gets an object which representing image media for this place image.
70         /// </summary>
71         public PlaceMedia ImageMedia { get { return _media; } }
72     }
73 }