[Applications.Cion] Fix namespace, ServerBase.DisplayName property, docfx (#3553)
[platform/core/csapi/tizenfx.git] / src / Tizen.Applications.Cion / Tizen.Applications.Cion / Payload.cs
1 /*
2  * Copyright (c) 2021 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.Cion
18 {
19     /// <summary>
20     /// An abstract class to represent payload.
21     /// </summary>
22     /// <since_tizen> 9 </since_tizen>
23     public abstract class Payload
24     {
25         private readonly string LogTag = "Tizen.Applications.Cion";
26         internal PayloadSafeHandle _handle;
27
28         /// <summary>
29         /// Gets type of the payload.
30         /// </summary>
31         /// <since_tizen> 9 </since_tizen>
32         public abstract PayloadType PayloadType { get; }
33
34         /// <summary>
35         /// Gets Id of the payload.
36         /// </summary>
37         /// <since_tizen> 9 </since_tizen>
38         public string Id
39         {
40             get
41             {
42                 Interop.Cion.ErrorCode ret = Interop.CionPayload.CionPayloadGetPayloadID(_handle, out string id);
43                 if (ret != Interop.Cion.ErrorCode.None)
44                 {
45                     Log.Error(LogTag, "Failed to get id of payload.");
46                     return "";
47                 }
48                 return id;
49             }            
50         }
51     }
52 }