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.InvalidOperationException">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 invalid parameter, when out of memory, when there is an I/O error.</exception>\r
  69             <code>\r
  70             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  71             messagePort.MessageReceived += MessageReceivedCallback;\r
  72             messagePort.Listen();\r
  73             </code>\r
  74         </member>\r
  75         <member name="M:Tizen.Applications.Messages.MessagePort.StopListening">\r
  76             <summary>\r
  77             Unregisters the local message port.\r
  78             </summary>\r
  79             <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
  80             <code>\r
  81             MessagePort messagePort = new MessagePort("SenderPort", true);\r
  82             messagePort.MessageReceived += MessageReceivedCallback;\r
  83             messagePort.Listen();\r
  84             using (var message = new Tizen.Application.Bundle())\r
  85             {\r
  86                 message.AddItem("message", "a_string");\r
  87                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort");\r
  88             }\r
  89             messageProt.StopListening();\r
  90             </code>\r
  91         </member>\r
  92         <member name="M:Tizen.Applications.Messages.MessagePort.Send(Tizen.Applications.Bundle,System.String,System.String)">\r
  93             <summary>\r
  94             Sends an untrusted message to the message port of a remote application.\r
  95             </summary>\r
  96             <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param>\r
  97             <param name="remoteAppId">The ID of the remote application.</param>\r
  98             <param name="remotePortName">The name of the remote message port.</param>\r
  99             <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
 100             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
 101             <code>\r
 102             MessagePort messagePort = new MessagePort("SenderPort", true);\r
 103             messagePort.MessageReceived += MessageReceivedCallback;\r
 104             messagePort.Listen();\r
 105             using (var message = new Tizen.Application.Bundle())\r
 106             {\r
 107                 message.AddItem("message", "a_string");\r
 108                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort");\r
 109             }\r
 110             </code>\r
 111         </member>\r
 112         <member name="M:Tizen.Applications.Messages.MessagePort.Send(Tizen.Applications.Bundle,System.String,System.String,System.Boolean)">\r
 113             <summary>\r
 114             Sends a message to the message port of a remote application.\r
 115             </summary>\r
 116             <param name="message">The message to be passed to the remote application, the recommended message size is under 4KB.</param>\r
 117             <param name="remoteAppId">The ID of the remote application.</param>\r
 118             <param name="remotePortName">The name of the remote message port.</param>\r
 119             <param name="trusted">If true, it is the trusted message port of remote application, otherwise false.</param>\r
 120             <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
 121             <exception cref="T:System.ArgumentOutOfRangeException">Thrown when message has exceeded the maximum limit(4KB).</exception>\r
 122             <code>\r
 123             MessagePort messagePort = new MessagePort("SenderPort", true);\r
 124             messagePort.MessageReceived += MessageReceivedCallback;\r
 125             messagePort.Listen();\r
 126             using (var message = new Tizen.Application.Bundle())\r
 127             {\r
 128                 message.AddItem("message", "a_string");\r
 129                 messagePort.Send(message, "ReceiverAppID", "ReceiverPort", true);\r
 130             }\r
 131             </code>\r
 132         </member>\r
 133         <member name="M:Tizen.Applications.Messages.MessagePort.Dispose(System.Boolean)">\r
 134             <summary>\r
 135             Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation.\r
 136             </summary>\r
 137             <param name="disposing">true for a normal dispose operation; false to finalize the handle.</param>\r
 138         </member>\r
 139         <member name="M:Tizen.Applications.Messages.MessagePort.Dispose">\r
 140             <summary>\r
 141             Releases all resources used by the MessagePort class.\r
 142             </summary>\r
 143         </member>\r
 144         <member name="T:Tizen.Applications.Messages.MessageReceivedEventArgs">\r
 145             <summary>\r
 146             An extended EventArgs class, which contains remote message port information and message.\r
 147             </summary>\r
 148         </member>\r
 149         <member name="P:Tizen.Applications.Messages.MessageReceivedEventArgs.Remote">\r
 150             <summary>\r
 151             Contains AppId, port name, and trusted.\r
 152             </summary>\r
 153         </member>\r
 154         <member name="P:Tizen.Applications.Messages.MessageReceivedEventArgs.Message">\r
 155             <summary>\r
 156             The message passed from the remote application.\r
 157             </summary>\r
 158         </member>\r
 159         <member name="T:Tizen.Applications.Messages.RemoteValues">\r
 160             <summary>\r
 161             Contains AppId, port name, and trusted.\r
 162             </summary>\r
 163         </member>\r
 164         <member name="P:Tizen.Applications.Messages.RemoteValues.AppId">\r
 165             <summary>\r
 166             The ID of the remote application that sent this message.\r
 167             </summary>\r
 168         </member>\r
 169         <member name="P:Tizen.Applications.Messages.RemoteValues.PortName">\r
 170             <summary>\r
 171             The name of the remote message port.\r
 172             </summary>\r
 173         </member>\r
 174         <member name="P:Tizen.Applications.Messages.RemoteValues.Trusted">\r
 175             <summary>\r
 176             If true, the remote port is a trusted port, otherwise, if false, it is not.\r
 177             </summary>\r
 178         </member>\r
 179     </members>\r
 180 </doc>\r