Artifacts/bin/public/Tizen.Messaging.Push.xml

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