binaries/frameworks/Tizen.Messaging.Push.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Messaging.Push</name>
   5     </assembly>
   6     <members>
   7         <!-- Badly formed XML comment ignored for member "T:Tizen.Messaging.Push.PushClient" -->
   8         <member name="E:Tizen.Messaging.Push.PushClient.NotificationReceived">
   9             <summary>
  10             Event Handler for receiving the notifications.
  11             </summary>
  12             <since_tizen> 3 </since_tizen>
  13         </member>
  14         <member name="E:Tizen.Messaging.Push.PushClient.StateChanged">
  15             <summary>
  16             Event Handler for receiving changes in States of the connection.
  17             </summary>
  18             <since_tizen> 3 </since_tizen>
  19         </member>
  20         <member name="M:Tizen.Messaging.Push.PushClient.PushServiceConnect(System.String)">
  21             <summary>
  22             API to connect with the push service.
  23             </summary>
  24             <since_tizen> 3 </since_tizen>
  25             <privilege>http://tizen.org/privilege/push</privilege>
  26             <exception cref="T:System.InvalidOperationException"> In case of privilege not defined. </exception>
  27             <param name="pushAppId"> The Push Application ID Registered with the server.</param>
  28         </member>
  29         <member name="M:Tizen.Messaging.Push.PushClient.PushServiceDisconnect">
  30             <summary>
  31             API to disconnect from the push service.
  32             </summary>
  33             <since_tizen> 3 </since_tizen>
  34         </member>
  35         <member name="M:Tizen.Messaging.Push.PushClient.PushServerRegister">
  36             <summary>
  37             API to Register the application with the push server.
  38             </summary>
  39             <since_tizen> 3 </since_tizen>
  40             <returns>
  41             The method returns a task, which on completion will give a ServerResponse Object.
  42             </returns>
  43         </member>
  44         <member name="M:Tizen.Messaging.Push.PushClient.PushServerUnregister">
  45             <summary>
  46             API to Deregister the application from the push server.
  47             </summary>
  48             <since_tizen> 3 </since_tizen>
  49             <returns>
  50             The method returns a task, which on completion will give a ServerResponse Object.
  51             </returns>
  52         </member>
  53         <member name="M:Tizen.Messaging.Push.PushClient.GetUnreadNotifications">
  54             <summary>
  55             Gets the unread notifications for the application.
  56             </summary>
  57             <since_tizen> 3 </since_tizen>
  58         </member>
  59         <member name="M:Tizen.Messaging.Push.PushClient.GetRegistrationId">
  60             <summary>
  61             registration ID received from server. </summary>
  62             <since_tizen> 3 </since_tizen>
  63             <returns>
  64             It is the string, which is the ID received from the server.
  65             </returns>
  66         </member>
  67         <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs">
  68             <summary>
  69             An extended EventArgs class, which contains the State Information.
  70             </summary>
  71             <since_tizen> 3 </since_tizen>
  72         </member>
  73         <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState">
  74             <summary>
  75             Enumeration for the different states.
  76             </summary>
  77             <since_tizen> 3 </since_tizen>
  78         </member>
  79         <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Registered">
  80             <summary>
  81             Registered with the Server.
  82             </summary>
  83         </member>
  84         <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Unregistered">
  85             <summary>
  86             Unregistered.
  87             </summary>
  88         </member>
  89         <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.ProvisioningIPChanged">
  90             <summary>
  91             To change the provisioning server IP.
  92             </summary>
  93         </member>
  94         <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.PingChanged">
  95             <summary>
  96             Ping interval is changing.
  97             </summary>
  98         </member>
  99         <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.StateError">
 100             <summary>
 101             Error Occured in Changing State.
 102             </summary>
 103         </member>
 104         <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.State">
 105             <summary>
 106             Gives the current state.
 107             </summary>
 108             <since_tizen> 3 </since_tizen>
 109             <value>
 110             It is the current state.</value>
 111         </member>
 112         <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.Error">
 113             <summary>
 114             Gives information about the error if set.
 115             </summary>
 116             <since_tizen> 3 </since_tizen>
 117             <value>
 118             It is the string, which contains the error string if set.</value>
 119         </member>
 120         <member name="T:Tizen.Messaging.Push.PushMessageEventArgs">
 121             <summary>
 122             An extended EventArgs class, which contains the message received.
 123             </summary>
 124             <since_tizen> 3 </since_tizen>
 125         </member>
 126         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.AppData">
 127             <summary>
 128             Gives the Application Data recieved. </summary>
 129             <since_tizen> 3 </since_tizen>
 130             <value>
 131             It is the string, which stores the application data.</value>
 132         </member>
 133         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Message">
 134             <summary>
 135             Gives the Message Received Field.
 136             </summary>
 137             <since_tizen> 3 </since_tizen>
 138             <value>
 139             It is the string, which stores the message field.</value>
 140         </member>
 141         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.ReceivedAt">
 142             <summary>
 143             Gives the time at which the Notification was received.
 144             </summary>
 145             <since_tizen> 3 </since_tizen>
 146             <value>
 147             It is the DateTime field representing the time at which the Notification was received.</value>
 148         </member>
 149         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Sender">
 150             <summary>
 151             Gives the Sender of the notification.
 152             </summary>
 153             <since_tizen> 3 </since_tizen>
 154             <value>
 155             It is a string value representing the Sender of the Notification.</value>
 156         </member>
 157         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.SessionInfo">
 158             <summary>
 159             Gives the session ID of the notification.
 160             </summary>
 161             <since_tizen> 3 </since_tizen>
 162             <value>
 163             It is a string value representing the session ID of the Notification.</value>
 164         </member>
 165         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.RequestId">
 166             <summary>
 167             Gives the request ID of the notification.
 168             </summary>
 169             <since_tizen> 3 </since_tizen>
 170             <value>
 171             It is a string value representing the request ID of the Notification.</value>
 172         </member>
 173         <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Type">
 174             <summary>
 175             Gives the value in the type field of the notification.
 176             </summary>
 177             <since_tizen> 3 </since_tizen>
 178             <value>
 179             It is an integer value representing the type field of the notification.</value>
 180         </member>
 181         <member name="T:Tizen.Messaging.Push.ServerResponse">
 182             <summary>
 183             The ServerResponse structure provides the result and the server response if any.
 184             </summary>
 185             <since_tizen> 3 </since_tizen>
 186         </member>
 187         <member name="T:Tizen.Messaging.Push.ServerResponse.Result">
 188             <summary>
 189             Enumeration for the Result from the server.
 190             </summary>
 191             <since_tizen> 3 </since_tizen>
 192         </member>
 193         <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Success">
 194             <summary>
 195             Successful.
 196             </summary>
 197         </member>
 198         <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Timeout">
 199             <summary>
 200             Time Out Occured.
 201             </summary>
 202         </member>
 203         <member name="F:Tizen.Messaging.Push.ServerResponse.Result.ServerError">
 204             <summary>
 205             Server Error Occured.
 206             </summary>
 207         </member>
 208         <member name="F:Tizen.Messaging.Push.ServerResponse.Result.SystemError">
 209             <summary>
 210             System Error Occured.
 211             </summary>
 212         </member>
 213         <member name="P:Tizen.Messaging.Push.ServerResponse.ServerResult">
 214             <summary>
 215             Gives the Result of the opeartion.
 216             </summary>
 217             <since_tizen> 3 </since_tizen>
 218             <value>
 219             It is the Result state of the operation performed.</value>
 220         </member>
 221         <member name="P:Tizen.Messaging.Push.ServerResponse.ServerMessage">
 222             <summary>
 223             Gives the Message from the server.
 224             </summary>
 225             <since_tizen> 3 </since_tizen>
 226             <value>
 227             It is the Message sent by the server.</value>
 228         </member>
 229     </members>
 230 </doc>