Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Messaging.Push.xml
index 533e900..83fa71a 100644 (file)
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>Tizen.Messaging.Push</name>
-    </assembly>
-    <members>
-        <!-- Badly formed XML comment ignored for member "T:Tizen.Messaging.Push.PushClient" -->
-        <member name="E:Tizen.Messaging.Push.PushClient.NotificationReceived">
-            <summary>
-            Event Handler for receiving the notifications.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="E:Tizen.Messaging.Push.PushClient.StateChanged">
-            <summary>
-            Event Handler for receiving changes in States of the connection.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.PushServiceConnect(System.String)">
-            <summary>
-            API to connect with the push service.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <privilege>http://tizen.org/privilege/push</privilege>
-            <exception cref="T:System.InvalidOperationException"> In case of privilege not defined. </exception>
-            <param name="pushAppId"> The Push Application ID Registered with the server.</param>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.PushServiceDisconnect">
-            <summary>
-            API to disconnect from the push service.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.PushServerRegister">
-            <summary>
-            API to Register the application with the push server.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <returns>
-            The method returns a task, which on completion will give a ServerResponse Object.
-            </returns>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.PushServerUnregister">
-            <summary>
-            API to Deregister the application from the push server.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <returns>
-            The method returns a task, which on completion will give a ServerResponse Object.
-            </returns>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.GetUnreadNotifications">
-            <summary>
-            Gets the unread notifications for the application.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="M:Tizen.Messaging.Push.PushClient.GetRegistrationId">
-            <summary>
-            registration ID received from server. </summary>
-            <since_tizen> 3 </since_tizen>
-            <returns>
-            It is the string, which is the ID received from the server.
-            </returns>
-        </member>
-        <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs">
-            <summary>
-            An extended EventArgs class, which contains the State Information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState">
-            <summary>
-            Enumeration for the different states.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Registered">
-            <summary>
-            Registered with the Server.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Unregistered">
-            <summary>
-            Unregistered.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.ProvisioningIPChanged">
-            <summary>
-            To change the provisioning server IP.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.PingChanged">
-            <summary>
-            Ping interval is changing.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.StateError">
-            <summary>
-            Error Occured in Changing State.
-            </summary>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.State">
-            <summary>
-            Gives the current state.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the current state.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.Error">
-            <summary>
-            Gives information about the error if set.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the string, which contains the error string if set.</value>
-        </member>
-        <member name="T:Tizen.Messaging.Push.PushMessageEventArgs">
-            <summary>
-            An extended EventArgs class, which contains the message received.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.AppData">
-            <summary>
-            Gives the Application Data recieved. </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the string, which stores the application data.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Message">
-            <summary>
-            Gives the Message Received Field.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the string, which stores the message field.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.ReceivedAt">
-            <summary>
-            Gives the time at which the Notification was received.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the DateTime field representing the time at which the Notification was received.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Sender">
-            <summary>
-            Gives the Sender of the notification.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is a string value representing the Sender of the Notification.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.SessionInfo">
-            <summary>
-            Gives the session ID of the notification.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is a string value representing the session ID of the Notification.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.RequestId">
-            <summary>
-            Gives the request ID of the notification.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is a string value representing the request ID of the Notification.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Type">
-            <summary>
-            Gives the value in the type field of the notification.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is an integer value representing the type field of the notification.</value>
-        </member>
-        <member name="T:Tizen.Messaging.Push.ServerResponse">
-            <summary>
-            The ServerResponse structure provides the result and the server response if any.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.Messaging.Push.ServerResponse.Result">
-            <summary>
-            Enumeration for the Result from the server.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Success">
-            <summary>
-            Successful.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Timeout">
-            <summary>
-            Time Out Occured.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.ServerError">
-            <summary>
-            Server Error Occured.
-            </summary>
-        </member>
-        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.SystemError">
-            <summary>
-            System Error Occured.
-            </summary>
-        </member>
-        <member name="P:Tizen.Messaging.Push.ServerResponse.ServerResult">
-            <summary>
-            Gives the Result of the opeartion.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the Result state of the operation performed.</value>
-        </member>
-        <member name="P:Tizen.Messaging.Push.ServerResponse.ServerMessage">
-            <summary>
-            Gives the Message from the server.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <value>
-            It is the Message sent by the server.</value>
-        </member>
-    </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+    <assembly>\r
+        <name>Tizen.Messaging.Push</name>\r
+    </assembly>\r
+    <members>\r
+        <!-- "T:Tizen.Messaging.Push.PushClient" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
+        <member name="E:Tizen.Messaging.Push.PushClient.NotificationReceived">\r
+            <summary>\r
+            Event Handler for receiving the notifications.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="E:Tizen.Messaging.Push.PushClient.StateChanged">\r
+            <summary>\r
+            Event Handler for receiving changes in States of the connection.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.PushServiceConnect(System.String)">\r
+            <summary>\r
+            API to connect with the push service.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <privilege>http://tizen.org/privilege/push</privilege>\r
+            <exception cref="T:System.InvalidOperationException"> In case of privilege not defined. </exception>\r
+            <param name="pushAppId"> The Push Application ID Registered with the server.</param>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.PushServiceDisconnect">\r
+            <summary>\r
+            API to disconnect from the push service.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.PushServerRegister">\r
+            <summary>\r
+            API to Register the application with the push server.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <returns>\r
+            The method returns a task, which on completion will give a ServerResponse Object.\r
+            </returns>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.PushServerUnregister">\r
+            <summary>\r
+            API to Deregister the application from the push server.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <returns>\r
+            The method returns a task, which on completion will give a ServerResponse Object.\r
+            </returns>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.GetUnreadNotifications">\r
+            <summary>\r
+            Gets the unread notifications for the application.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="M:Tizen.Messaging.Push.PushClient.GetRegistrationId">\r
+            <summary>\r
+            registration ID received from server. </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <returns>\r
+            It is the string, which is the ID received from the server.\r
+            </returns>\r
+        </member>\r
+        <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs">\r
+            <summary>\r
+            An extended EventArgs class, which contains the State Information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState">\r
+            <summary>\r
+            Enumeration for the different states.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Registered">\r
+            <summary>\r
+            Registered with the Server.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.Unregistered">\r
+            <summary>\r
+            Unregistered.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.ProvisioningIPChanged">\r
+            <summary>\r
+            To change the provisioning server IP.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.PingChanged">\r
+            <summary>\r
+            Ping interval is changing.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.PushConnectionStateEventArgs.PushState.StateError">\r
+            <summary>\r
+            Error Occured in Changing State.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.State">\r
+            <summary>\r
+            Gives the current state.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the current state.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushConnectionStateEventArgs.Error">\r
+            <summary>\r
+            Gives information about the error if set.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the string, which contains the error string if set.</value>\r
+        </member>\r
+        <member name="T:Tizen.Messaging.Push.PushMessageEventArgs">\r
+            <summary>\r
+            An extended EventArgs class, which contains the message received.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.AppData">\r
+            <summary>\r
+            Gives the Application Data recieved. </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the string, which stores the application data.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Message">\r
+            <summary>\r
+            Gives the Message Received Field.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the string, which stores the message field.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.ReceivedAt">\r
+            <summary>\r
+            Gives the time at which the Notification was received.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the DateTime field representing the time at which the Notification was received.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Sender">\r
+            <summary>\r
+            Gives the Sender of the notification.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is a string value representing the Sender of the Notification.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.SessionInfo">\r
+            <summary>\r
+            Gives the session ID of the notification.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is a string value representing the session ID of the Notification.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.RequestId">\r
+            <summary>\r
+            Gives the request ID of the notification.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is a string value representing the request ID of the Notification.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.PushMessageEventArgs.Type">\r
+            <summary>\r
+            Gives the value in the type field of the notification.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is an integer value representing the type field of the notification.</value>\r
+        </member>\r
+        <member name="T:Tizen.Messaging.Push.ServerResponse">\r
+            <summary>\r
+            The ServerResponse structure provides the result and the server response if any.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.Messaging.Push.ServerResponse.Result">\r
+            <summary>\r
+            Enumeration for the Result from the server.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Success">\r
+            <summary>\r
+            Successful.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.Timeout">\r
+            <summary>\r
+            Time Out Occured.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.ServerError">\r
+            <summary>\r
+            Server Error Occured.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Messaging.Push.ServerResponse.Result.SystemError">\r
+            <summary>\r
+            System Error Occured.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.ServerResponse.ServerResult">\r
+            <summary>\r
+            Gives the Result of the opeartion.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the Result state of the operation performed.</value>\r
+        </member>\r
+        <member name="P:Tizen.Messaging.Push.ServerResponse.ServerMessage">\r
+            <summary>\r
+            Gives the Message from the server.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <value>\r
+            It is the Message sent by the server.</value>\r
+        </member>\r
+    </members>\r
+</doc>\r