src/Tizen.Messaging.Push/Tizen.Messaging.Push/ServerResponse.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 namespace Tizen.Messaging.Push
  18 {
  19     /// <summary>
  20     /// The ServerResponse structure provides the result and the server response if any.
  21     /// </summary>
  22     /// <since_tizen> 3 </since_tizen>
  23     public struct ServerResponse
  24     {
  25         /// <summary>
  26         /// Enumeration for the Result from the server.
  27         /// </summary>
  28         /// <since_tizen> 3 </since_tizen>
  29         public enum Result
  30         {
  31             /// <summary>
  32             /// Successful.
  33             /// </summary>
  34             Success = 0,
  35             /// <summary>
  36             /// Time Out Occured.
  37             /// </summary>
  38             Timeout = 1,
  39             /// <summary>
  40             /// Server Error Occured.
  41             /// </summary>
  42             ServerError = 2,
  43             /// <summary>
  44             /// System Error Occured.
  45             /// </summary>
  46             SystemError = 3
  47         }
  48
  49         /// <summary>
  50         /// Gives the Result of the opeartion.
  51         /// </summary>
  52         /// <since_tizen> 3 </since_tizen>
  53         /// <value>
  54         /// It is the Result state of the operation performed.</value>
  55         public Result ServerResult
  56         {
  57             get;
  58             internal set;
  59         }
  60
  61         /// <summary>
  62         /// Gives the Message from the server.
  63         /// </summary>
  64         /// <since_tizen> 3 </since_tizen>
  65         /// <value>
  66         /// It is the Message sent by the server.</value>
  67         public string ServerMessage
  68         {
  69             get;
  70             internal set;
  71         }
  72     }
  73 }