Artifacts/bin/public/Tizen.Applications.MessagePort.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Applications.MessagePort</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.Applications.Messages.MessagePort">\r
   8             <summary>\r
   9             The message port API provides functions to send and receive messages between applications.\r
  10             </summary>\r
  11             <remarks>\r
  12             The message port API provides functions for passing messages between applications. An application should register its own local port to receive messages from remote applications.\r
  13             If a remote application sends a message, the registered callback function of the local port is called.\r
  14             The trusted message-port API allows communications between applications that are signed by the same developer(author) certificate.\r
  15             </remarks>\r
  16         </member>\r
  17         <member name="M:Tizen.Applications.Messages.MessagePort.#ctor(System.String,System.Boolean)">\r
  18             <summary>\r
  19             Initializes the instance of the MessagePort class.\r
  20             </summary>\r
  21             <param name="portName">The name of the local message port.</param>\r
  22             <param name="trusted">If true, it is the trusted message port of application, otherwise false.</param>\r
  23             <exception cref="T:System.ArgumentException">Thrown when portName is null or empty.</exception>\r
  24             <code>\r
  25             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  26             </code>\r
  27         </member>\r
  28         <member name="M:Tizen.Applications.Messages.MessagePort.Finalize">\r
  29             <summary>\r
  30             Destructor of the MessagePort class.\r
  31             </summary>\r
  32         </member>\r
  33         <member name="E:Tizen.Applications.Messages.MessagePort.MessageReceived">\r
  34             <summary>\r
  35             Called when a message is received.\r
  36             </summary>\r
  37             <code>\r
  38             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  39             messagePort.MessageReceived += MessageReceivedCallback;\r
  40             static void MessageReceivedCallback(object sender, MessageReceivedEventArgs e)\r
  41             {\r
  42                 Console.WriteLine("Message Received ");\r
  43                 if (e.Remote.AppId != null) {\r
  44                     Console.WriteLine("from :"+e.Remote.AppId);\r
  45                 }\r
  46             }\r
  47             </code>\r
  48         </member>\r
  49         <member name="P:Tizen.Applications.Messages.MessagePort.PortName">\r
  50             <summary>\r
  51             The name of the local message port.\r
  52             </summary>\r
  53         </member>\r
  54         <member name="P:Tizen.Applications.Messages.MessagePort.Trusted">\r
  55             <summary>\r
  56             If true, the message port is a trusted port, otherwise false.\r
  57             </summary>\r
  58         </member>\r
  59         <member name="P:Tizen.Applications.Messages.MessagePort.Listening">\r
  60             <summary>\r
  61             If true, the message port is listening, otherwise false.\r
  62             </summary>\r
  63         </member>\r
  64         <member name="M:Tizen.Applications.Messages.MessagePort.Listen">\r
  65             <summary>\r
  66             Register the local message port.\r
  67             </summary>\r
  68             <exception cref="T:System.InvalidOperationException">Thrown when portName is already used, when there is an I/O error.</exception>\r
  69             <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
  70             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
  71             <code>\r
  72             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  73             messagePort.MessageReceived += MessageReceivedCallback;\r
  74             messagePort.Listen();\r
  75             </code>\r
  76         </member>\r
  77         <member name="M:Tizen.Applications.Messages.MessagePort.StopListening">\r
  78             <summary>\r
  79             Unregisters the local message port.\r
  80             </summary>\r
  81             <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
  82             <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
  83             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
  84             <code>\r
  85             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  86             messagePort.MessageReceived += MessageReceivedCallback;\r
  87             messagePort.Listen();\r
  88             using (var message = new Tizen.Application.Bundle())\r
  89             {\r
  90                 message.AddItem("message", "a_string");\r
  91                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort");\r
  92             }\r
  93             messagePort.StopListening();\r
  94             </code>\r
  95         </member>\r
  96         <member name="M:Tizen.Applications.Messages.MessagePort.Send(Tizen.Applications.Bundle,System.String,System.String)">\r
  97             <summary>\r
  98             Sends an untrusted message to the message port of a remote application.\r
  99             </summary>\r
 100             <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param>\r
 101             <param name="remoteAppId">The ID of the remote application.</param>\r
 102             <param name="remotePortName">The name of the remote message port.</param>\r
 103             <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error, when the port is not found.</exception>\r
 104             <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
 105             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
 106             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
 107             <code>\r
 108             MessagePort messagePort = new MessagePort("SenderPort", true);\r
 109             messagePort.MessageReceived += MessageReceivedCallback;\r
 110             messagePort.Listen();\r
 111             using (var message = new Tizen.Application.Bundle())\r
 112             {\r
 113                 message.AddItem("message", "a_string");\r
 114                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort");\r
 115             }\r
 116             </code>\r
 117         </member>\r
 118         <member name="M:Tizen.Applications.Messages.MessagePort.Send(Tizen.Applications.Bundle,System.String,System.String,System.Boolean)">\r
 119             <summary>\r
 120             Sends a message to the message port of a remote application.\r
 121             </summary>\r
 122             <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param>\r
 123             <param name="remoteAppId">The ID of the remote application.</param>\r
 124             <param name="remotePortName">The name of the remote message port.</param>\r
 125             <param name="trusted">If true, it is the trusted message port of remote application, otherwise false.</param>\r
 126             <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error, when the port is not found.</exception>\r
 127             <exception cref="T:System.ArgumentException">Thrown when there is an invalid parameter.</exception>\r
 128             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
 129             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
 130             <exception cref="T:System.UnauthorizedAccessException">Thrown when the remote application is not signed with the same certificate.</exception>\r
 131             <code>\r
 132             MessagePort messagePort = new MessagePort("SenderPort", true);\r
 133             messagePort.MessageReceived += MessageReceivedCallback;\r
 134             messagePort.Listen();\r
 135             using (var message = new Tizen.Application.Bundle())\r
 136             {\r
 137                 message.AddItem("message", "a_string");\r
 138                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort", true);\r
 139             }\r
 140             </code>\r
 141         </member>\r
 142         <member name="M:Tizen.Applications.Messages.MessagePort.Dispose(System.Boolean)">\r
 143             <summary>\r
 144             Releases the unmanaged resources used by the MessagePort class specifying whether to perform a normal dispose operation.\r
 145             </summary>\r
 146             <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>\r
 147         </member>\r
 148         <member name="M:Tizen.Applications.Messages.MessagePort.Dispose">\r
 149             <summary>\r
 150             Releases all resources used by the MessagePort class.\r
 151             </summary>\r
 152         </member>\r
 153         <member name="T:Tizen.Applications.Messages.MessageReceivedEventArgs">\r
 154             <summary>\r
 155             An extended EventArgs class, which contains remote message port information and message.\r
 156             </summary>\r
 157         </member>\r
 158         <member name="P:Tizen.Applications.Messages.MessageReceivedEventArgs.Remote">\r
 159             <summary>\r
 160             Contains AppId, port name, and trusted.\r
 161             </summary>\r
 162         </member>\r
 163         <member name="P:Tizen.Applications.Messages.MessageReceivedEventArgs.Message">\r
 164             <summary>\r
 165             The message passed from the remote application.\r
 166             </summary>\r
 167         </member>\r
 168         <member name="T:Tizen.Applications.Messages.RemotePort">\r
 169             <summary>\r
 170             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
 171             </summary>\r
 172             <since_tizen> 4 </since_tizen>\r
 173         </member>\r
 174         <member name="M:Tizen.Applications.Messages.RemotePort.#ctor(System.String,System.String,System.Boolean)">\r
 175             <summary>\r
 176             Constructor of the RemotePort class.\r
 177             </summary>\r
 178             <since_tizen> 4 </since_tizen>\r
 179             <param name="appId">The Id of the remote application</param>\r
 180             <param name="portName">The name of the remote message port</param>\r
 181             <param name="trusted">If true is the trusted message port of application, otherwise false</param>\r
 182             <exception cref="T:System.ArgumentException">Thrown when appId is null or empty, when portName is null or empty</exception>\r
 183             <code>\r
 184             RemotePort remotePort = new RemotePort("org.tizen.example.messageport", "SenderPort", false);\r
 185             </code>\r
 186         </member>\r
 187         <member name="M:Tizen.Applications.Messages.RemotePort.Finalize">\r
 188             <summary>\r
 189             Destructor of the RemotePort class.\r
 190             </summary>\r
 191             <since_tizen> 4 </since_tizen>\r
 192         </member>\r
 193         <member name="P:Tizen.Applications.Messages.RemotePort.AppId">\r
 194             <summary>\r
 195             The AppId of the remote port\r
 196             </summary>\r
 197             <since_tizen> 4 </since_tizen>\r
 198             <returns> Return appid of RemotePort </returns>\r
 199         </member>\r
 200         <member name="P:Tizen.Applications.Messages.RemotePort.PortName">\r
 201             <summary>\r
 202             The name of the remote message port\r
 203             </summary>\r
 204             <since_tizen> 4 </since_tizen>\r
 205             <returns> Return name of RemotePort </returns>\r
 206         </member>\r
 207         <member name="P:Tizen.Applications.Messages.RemotePort.Trusted">\r
 208             <summary>\r
 209             If true the remote port is a trusted port, otherwise if false it is not\r
 210             </summary>\r
 211             <since_tizen> 4 </since_tizen>\r
 212              <returns> Return true if RemotePort is trusted </returns>\r
 213         </member>\r
 214         <member name="M:Tizen.Applications.Messages.RemotePort.IsRunning">\r
 215             <summary>\r
 216             Check if the remote message port is running.\r
 217             </summary>\r
 218             <since_tizen> 4 </since_tizen>\r
 219             <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error</exception>\r
 220             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
 221             <code>\r
 222             Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);\r
 223             bool isRunning = remotePort.isRunning();\r
 224             </code>\r
 225             <returns> Return true if Remote Port is running </returns>\r
 226         </member>\r
 227         <member name="E:Tizen.Applications.Messages.RemotePort.RemotePortStateChanged">\r
 228             <summary>\r
 229             Called when the remote port is registered or unregistered.\r
 230             </summary>\r
 231             <since_tizen> 4 </since_tizen>\r
 232             <exception cref="T:System.InvalidOperationException">Thrown when there is an I/O error</exception>\r
 233             <exception cref="T:System.OutOfMemoryException">Thrown when out of memory.</exception>\r
 234             <code>\r
 235             Remote remotePort = new RemotePort("org.tizen.example", "SenderPort", true);\r
 236             remotePort.RemotePortStateChanged += RemotePortStateChangedCallback;\r
 237             static void RemotePortStateChangedCallback(object sender, MessageReceivedEventArgs e)\r
 238             {\r
 239                 switch (e.Status)\r
 240                 {\r
 241                 case State.Registered :\r
 242                     Console.WriteLine("Remote Port Registered ");\r
 243                     break;\r
 244                 case State.Unregistered :\r
 245                     Console.WriteLine("Remote Port Unregistered ");\r
 246                     break;\r
 247                 default :\r
 248                     break;\r
 249                 }\r
 250             }\r
 251             </code>\r
 252         </member>\r
 253         <member name="M:Tizen.Applications.Messages.RemotePort.Dispose(System.Boolean)">\r
 254             <summary>\r
 255             Releases the unmanaged resources used by the RemotePort class specifying whether to perform a normal dispose operation.\r
 256             </summary>\r
 257             <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>\r
 258         </member>\r
 259         <member name="M:Tizen.Applications.Messages.RemotePort.Dispose">\r
 260             <summary>\r
 261             Releases all resources used by the RemotePort class.\r
 262             </summary>\r
 263             <since_tizen> 4 </since_tizen>\r
 264         </member>\r
 265         <member name="T:Tizen.Applications.Messages.State">\r
 266             <summary>\r
 267             Enumeration for Remote Message Port state type\r
 268             </summary>\r
 269             <since_tizen> 4 </since_tizen>\r
 270         </member>\r
 271         <member name="F:Tizen.Applications.Messages.State.Unregistered">\r
 272             <summary>\r
 273             Value representing Remote Port state is unregistered\r
 274             </summary>\r
 275         </member>\r
 276         <member name="F:Tizen.Applications.Messages.State.Registered">\r
 277             <summary>\r
 278             Value representing Remote Port state is registered\r
 279             </summary>\r
 280         </member>\r
 281         <member name="T:Tizen.Applications.Messages.RemotePortStateChangedEventArgs">\r
 282             <summary>\r
 283             An extended EventArgs class which contains state of remote message port\r
 284             </summary>\r
 285             <since_tizen> 4 </since_tizen>\r
 286         </member>\r
 287         <member name="P:Tizen.Applications.Messages.RemotePortStateChangedEventArgs.Status">\r
 288             <summary>\r
 289             The State of remote port\r
 290             </summary>\r
 291             <since_tizen> 4 </since_tizen>\r
 292         </member>\r
 293         <member name="T:Tizen.Applications.Messages.RemoteValues">\r
 294             <summary>\r
 295             Contains AppId, port name, and trusted.\r
 296             </summary>\r
 297         </member>\r
 298         <member name="P:Tizen.Applications.Messages.RemoteValues.AppId">\r
 299             <summary>\r
 300             The ID of the remote application that sent this message.\r
 301             </summary>\r
 302         </member>\r
 303         <member name="P:Tizen.Applications.Messages.RemoteValues.PortName">\r
 304             <summary>\r
 305             The name of the remote message port.\r
 306             </summary>\r
 307         </member>\r
 308         <member name="P:Tizen.Applications.Messages.RemoteValues.Trusted">\r
 309             <summary>\r
 310             If true, the remote port is a trusted port, otherwise, if false, it is not.\r
 311             </summary>\r
 312         </member>\r
 313     </members>\r
 314 </doc>\r