Release 4.0.0-preview1-00165
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.MessagePort.xml
index b55ef18..beaaf7c 100644 (file)
@@ -20,7 +20,7 @@
             </summary>\r
             <param name="portName">The name of the local message port.</param>\r
             <param name="trusted">If true, it is the trusted message port of application, otherwise false.</param>\r
-            <exception cref="T:System.InvalidOperationException">Thrown when portName is null or empty.</exception>\r
+            <exception cref="T:System.ArgumentException">Thrown when portName is null or empty.</exception>\r
             <code>\r
             MessagePort messagePort = new MessagePort("SenderPort", true);\r
             </code>\r
@@ -65,7 +65,9 @@
             <summary>\r
             Register the local message port.\r
             </summary>\r
-            <exception cref="T:System.InvalidOperationException">Thrown when portName is already used, when there is an invalid parameter, when out of memory, when there is an I/O error.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when portName is already used, when there is an I/O error.</exception>\r
+            <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
             <code>\r
             MessagePort messagePort = new MessagePort("SenderPort", true);\r
             messagePort.MessageReceived += MessageReceivedCallback;\r
@@ -76,7 +78,9 @@
             <summary>\r
             Unregisters the local message port.\r
             </summary>\r
-            <exception cref="T:System.InvalidOperationException">Thrown when messageport is already stopped, when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when messageport is already stopped, when there is an I/O error, when the port is not found.</exception>\r
+            <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
             <code>\r
             MessagePort messagePort = new MessagePort("SenderPort", true);\r
             messagePort.MessageReceived += MessageReceivedCallback;\r
@@ -86,7 +90,7 @@
                 message.AddItem("message", "a_string");\r
                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort");\r
             }\r
-            messageProt.StopListening();\r
+            messagePort.StopListening();\r
             </code>\r
         </member>\r
         <member name="M:Tizen.Applications.Messages.MessagePort.Send(Tizen.Applications.Bundle,System.String,System.String)">\r
             <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param>\r
             <param name="remoteAppId">The ID of the remote application.</param>\r
             <param name="remotePortName">The name of the remote message port.</param>\r
-            <exception cref="T:System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error, when the port is not found.</exception>\r
+            <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
             <code>\r
             MessagePort messagePort = new MessagePort("SenderPort", true);\r
             <param name="remoteAppId">The ID of the remote application.</param>\r
             <param name="remotePortName">The name of the remote message port.</param>\r
             <param name="trusted">If true, it is the trusted message port of remote application, otherwise false.</param>\r
-            <exception cref="T:System.InvalidOperationException">Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error, when the port is not found.</exception>\r
+            <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when the remote application is not signed with the same certificate.</exception>\r
             <code>\r
             MessagePort messagePort = new MessagePort("SenderPort", true);\r
             messagePort.MessageReceived += MessageReceivedCallback;\r
         </member>\r
         <member name="M:Tizen.Applications.Messages.MessagePort.Dispose(System.Boolean)">\r
             <summary>\r
-            Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation.\r
+            Releases the unmanaged resources used by the MessagePort class specifying whether to perform a normal dispose operation.\r
             </summary>\r
             <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>\r
         </member>\r
             The message passed from the remote application.\r
             </summary>\r
         </member>\r
+        <member name="T:Tizen.Applications.Messages.RemotePort">\r
+            <summary>\r
+            The RemotePort Class provides functions to get if the remote port is running and to get whether the remote port is registered or unregistered.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Messages.RemotePort.#ctor(System.String,System.String,System.Boolean)">\r
+            <summary>\r
+            Constructor of the RemotePort class.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+            <param name="appId">The Id of the remote application</param>\r
+            <param name="portName">The name of the remote message port</param>\r
+            <param name="trusted">If true is the trusted message port of application, otherwise false</param>\r
+            <exception cref="T:System.ArgumentException">Thrown when appId is null or empty, when portName is null or empty</exception>\r
+            <code>\r
+            RemotePort remotePort = new RemotePort("org.tizen.example.messageport", "SenderPort", false);\r
+            </code>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Messages.RemotePort.Finalize">\r
+            <summary>\r
+            Destructor of the RemotePort class.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Messages.RemotePort.AppId">\r
+            <summary>\r
+            The AppId of the remote port\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+            <returns> Return appid of RemotePort </returns>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Messages.RemotePort.PortName">\r
+            <summary>\r
+            The name of the remote message port\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+            <returns> Return name of RemotePort </returns>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Messages.RemotePort.Trusted">\r
+            <summary>\r
+            If true the remote port is a trusted port, otherwise if false it is not\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+             <returns> Return true if RemotePort is trusted </returns>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Messages.RemotePort.IsRunning">\r
+            <summary>\r
+            Check if the remote message port is running.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
+            <code>\r
+            Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);\r
+            bool isRunning = remotePort.isRunning();\r
+            </code>\r
+            <returns> Return true if Remote Port is running </returns>\r
+        </member>\r
+        <member name="E:Tizen.Applications.Messages.RemotePort.RemotePortStateChanged">\r
+            <summary>\r
+            Called when the remote port is registered or unregistered.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+            <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error</exception>\r
+            <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
+            <code>\r
+            Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);\r
+            remotePort.RemotePortStateChanged += RemotePortStateChangedCallback;\r
+            static void RemotePortStateChangedCallback(object sender, MessageReceivedEventArgs e)\r
+            {\r
+                switch (e.Status)\r
+                {\r
+                case State.Registered :\r
+                    Console.WriteLine("Remote Port Registered ");\r
+                    break;\r
+                case State.Unregistered :\r
+                    Console.WriteLine("Remote Port Unregistered ");\r
+                    break;\r
+                default :\r
+                    break;\r
+                }\r
+            }\r
+            </code>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Messages.RemotePort.Dispose(System.Boolean)">\r
+            <summary>\r
+            Releases the unmanaged resources used by the RemotePort class specifying whether to perform a normal dispose operation.\r
+            </summary>\r
+            <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Messages.RemotePort.Dispose">\r
+            <summary>\r
+            Releases all resources used by the RemotePort class.\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.Applications.Messages.State">\r
+            <summary>\r
+            Enumeration for Remote Message Port state type\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.Applications.Messages.State.Unregistered">\r
+            <summary>\r
+            Value representing Remote Port state is unregistered\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Applications.Messages.State.Registered">\r
+            <summary>\r
+            Value representing Remote Port state is registered\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Applications.Messages.RemotePortStateChangedEventArgs">\r
+            <summary>\r
+            An extended EventArgs class which contains state of remote message port\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Messages.RemotePortStateChangedEventArgs.Status">\r
+            <summary>\r
+            The State of remote port\r
+            </summary>\r
+            <since_tizen> 4 </since_tizen>\r
+        </member>\r
         <member name="T:Tizen.Applications.Messages.RemoteValues">\r
             <summary>\r
             Contains AppId, port name, and trusted.\r