Artifacts/bin/public/Tizen.Convergence.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Convergence</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="F:Interop.Internal.ConvDiscoveryResult.Error">\r
   8             <summary>\r
   9             Discovery Error\r
  10             </summary>\r
  11         </member>\r
  12         <member name="F:Interop.Internal.ConvDiscoveryResult.Success">\r
  13             <summary>\r
  14             Discovery Success\r
  15             </summary>\r
  16         </member>\r
  17         <member name="F:Interop.Internal.ConvDiscoveryResult.Finished">\r
  18             <summary>\r
  19             Discovery finished\r
  20             </summary>\r
  21         </member>\r
  22         <member name="F:Interop.Internal.ConvDiscoveryResult.Lost">\r
  23             <summary>\r
  24             Discovery lost\r
  25             </summary>\r
  26         </member>\r
  27         <member name="F:Interop.Internal.ServiceType.None">\r
  28             <summary>\r
  29             Undefined service\r
  30             </summary>\r
  31         </member>\r
  32         <member name="F:Interop.Internal.ServiceType.AppCommunication">\r
  33             <summary>\r
  34             App-to-app communication service\r
  35             </summary>\r
  36         </member>\r
  37         <member name="F:Interop.Internal.ServiceType.RemoteAppControl">\r
  38             <summary>\r
  39             Remote app-control service\r
  40             </summary>\r
  41         </member>\r
  42         <member name="T:Interop.Libraries">\r
  43             <summary>\r
  44             Wrapper class for maintaining names of dependent native libraries.\r
  45             </summary>\r
  46         </member>\r
  47         <member name="T:Tizen.Convergence.InternalAppCommunicationService">\r
  48             <summary>\r
  49             The class provides APIs to support App to App communication service which relies on a remote server.\r
  50             The initialization and execution of a server app (the app on the side with the Remote Server, e.g. TV) and a client app (e.g. the app on the mobile or wearable device) are slightly different.\r
  51             On the server side an instance of the App Communication Service should be created and started by the app. Note, on the client side the service handle shouldn’t be created, but obtained during discovery.\r
  52             For more information, refer Tizen D2D convergence specification\r
  53             </summary>\r
  54         </member>\r
  55         <member name="M:Tizen.Convergence.InternalAppCommunicationService.#ctor">\r
  56             <summary>\r
  57             The constructor\r
  58             </summary>\r
  59             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
  60             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
  61         </member>\r
  62         <member name="M:Tizen.Convergence.InternalAppCommunicationService.Start(Tizen.Convergence.InternalChannel,Tizen.Convergence.InternalPayload)">\r
  63             <summary>\r
  64             Starts and initiates the service\r
  65             </summary>\r
  66             <param name="channel">Channel to specify a logical session for the service</param>\r
  67             <param name="payload">Contains additional data for start request. Refer D2D Convergence specification for more information</param>\r
  68             <privilege>http://tizen.org/privilege/internet</privilege>\r
  69             <privilege>http://tizen.org/privilege/bluetooth</privilege>\r
  70             <privilege>http://tizen.org/privilege/d2d.datasharing</privilege>\r
  71             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
  72             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
  73             <exception cref="T:System.InvalidOperationException">Thrown when the request is not supported as per Tizen D2D convergence specification </exception>\r
  74             <exception cref="T:System.ArgumentNullException">Thrown when any of the arugments are null</exception>\r
  75             <seealso cref="!:Service.ServiceEventOccurred"> The result of the request is delivered through this event</seealso>\r
  76         </member>\r
  77         <member name="M:Tizen.Convergence.InternalAppCommunicationService.Read(Tizen.Convergence.InternalChannel,Tizen.Convergence.InternalPayload)">\r
  78             <summary>\r
  79             Reads data from the channel opened on the service\r
  80             </summary>\r
  81             <param name="channel">Channel representing a logical session on the service</param>\r
  82             <param name="payload">Contains additional data for start request. Refer D2D Convergence specification for more information</param>\r
  83             <privilege>http://tizen.org/privilege/internet</privilege>\r
  84             <privilege>http://tizen.org/privilege/bluetooth</privilege>\r
  85             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
  86             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
  87             <exception cref="T:System.InvalidOperationException">Thrown when the request is not supported as per Tizen D2D convergence specification </exception>\r
  88             <exception cref="T:System.ArgumentNullException">Thrown when any of the arugments are null</exception>\r
  89             <seealso cref="!:Service.ServiceEventOccurred"> The result of the request is delivered through this event</seealso>\r
  90         </member>\r
  91         <member name="M:Tizen.Convergence.InternalAppCommunicationService.Publish(Tizen.Convergence.InternalChannel,Tizen.Convergence.InternalPayload)">\r
  92             <summary>\r
  93             Publishes a message to the remote server application\r
  94             </summary>\r
  95             <param name="channel">Channel representing a logical session on the service</param>\r
  96             <param name="payload">Contains additional data for start request. Refer D2D Convergence specification for more information</param>\r
  97             <privilege>http://tizen.org/privilege/internet</privilege>\r
  98             <privilege>http://tizen.org/privilege/bluetooth</privilege>\r
  99             <privilege>http://tizen.org/privilege/d2d.datasharing</privilege>\r
 100             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 101             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 102             <exception cref="T:System.InvalidOperationException">Thrown when the request is not supported as per Tizen D2D convergence specification </exception>\r
 103             <exception cref="T:System.ArgumentNullException">Thrown when any of the arugments are null</exception>\r
 104             <seealso cref="!:Service.ServiceEventOccurred"> The result of the request is delivered through this event</seealso>\r
 105         </member>\r
 106         <member name="M:Tizen.Convergence.InternalAppCommunicationService.Stop(Tizen.Convergence.InternalChannel,Tizen.Convergence.InternalPayload)">\r
 107             <summary>\r
 108             Stops the channel opened on the remote server application\r
 109             </summary>\r
 110             <param name="channel">Channel representing a logical session on the service</param>\r
 111             <param name="payload">Contains additional data for start request. Refer D2D Convergence specification for more information</param>\r
 112             <privilege>http://tizen.org/privilege/internet</privilege>\r
 113             <privilege>http://tizen.org/privilege/bluetooth</privilege>\r
 114             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 115             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 116             <exception cref="T:System.InvalidOperationException">Thrown when the request is not supported as per Tizen D2D convergence specification </exception>\r
 117             <exception cref="T:System.ArgumentNullException">Thrown when any of the arugments are null</exception>\r
 118             <seealso cref="!:Service.ServiceEventOccurred"> The result of the request is delivered through this event</seealso>\r
 119         </member>\r
 120         <member name="T:Tizen.Convergence.InternalChannel">\r
 121             <summary>\r
 122             The Channel class provies a logical session for communicating with AppCommunicationService.\r
 123             </summary>\r
 124         </member>\r
 125         <member name="M:Tizen.Convergence.InternalChannel.#ctor(System.String,System.String)">\r
 126             <summary>\r
 127             The constructor\r
 128             </summary>\r
 129             <param name="uri">Uri of the server side app</param>\r
 130             <param name="id">Unique identifier</param>\r
 131             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 132             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 133             <exception cref="T:System.ArgumentNullException">Throws when the arguments passed are null</exception>\r
 134         </member>\r
 135         <member name="P:Tizen.Convergence.InternalChannel.Uri">\r
 136             <summary>\r
 137             Uri of the server side app\r
 138             </summary>\r
 139         </member>\r
 140         <member name="P:Tizen.Convergence.InternalChannel.Id">\r
 141             <summary>\r
 142             Unique identifier\r
 143             </summary>\r
 144         </member>\r
 145         <member name="M:Tizen.Convergence.InternalChannel.Dispose">\r
 146             <summary>\r
 147             The dispose method\r
 148             </summary>\r
 149         </member>\r
 150         <member name="T:Tizen.Convergence.InternalDevice">\r
 151             <summary>\r
 152             The class encapsulates a D2D convergence compliant device information\r
 153             </summary>\r
 154         </member>\r
 155         <member name="P:Tizen.Convergence.InternalDevice.Id">\r
 156             <summary>\r
 157             The Unique ID of the device\r
 158             </summary>\r
 159         </member>\r
 160         <member name="P:Tizen.Convergence.InternalDevice.Name">\r
 161             <summary>\r
 162             Name of the device\r
 163             </summary>\r
 164         </member>\r
 165         <member name="P:Tizen.Convergence.InternalDevice.Type">\r
 166             <summary>\r
 167             The profile of the device\r
 168             </summary>\r
 169         </member>\r
 170         <member name="P:Tizen.Convergence.InternalDevice.Services">\r
 171             <summary>\r
 172             List of services supported by the device\r
 173             </summary>\r
 174         </member>\r
 175         <member name="M:Tizen.Convergence.InternalDevice.Dispose">\r
 176             <summary>\r
 177             The dispose method\r
 178             </summary>\r
 179         </member>\r
 180         <member name="T:Tizen.Convergence.InternalDeviceFinder">\r
 181             <summary>\r
 182             DeviceFinder provides API to find all nearby Tizen D2D convergence compliant devices\r
 183             </summary>\r
 184         </member>\r
 185         <member name="M:Tizen.Convergence.InternalDeviceFinder.#ctor">\r
 186             <summary>\r
 187             The constructor\r
 188             </summary>\r
 189             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 190             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 191         </member>\r
 192         <member name="E:Tizen.Convergence.InternalDeviceFinder.DeviceFound">\r
 193             <summary>\r
 194             DeviceFound event is triggered when a device is found during discovery procedure\r
 195             </summary>\r
 196         </member>\r
 197         <member name="M:Tizen.Convergence.InternalDeviceFinder.StartFindingAsync(System.Int32,System.Threading.CancellationToken)">\r
 198             <summary>\r
 199             Starts the discovery of nearby devices\r
 200             </summary>\r
 201             <param name="timeOut">Seconds for discovery timeout. 0 will use default timeout value</param>\r
 202             <param name="cancellationToken">Cancellation token required to cancel the current discovery</param>\r
 203             <privilege>http://tizen.org/privilege/internet</privilege>\r
 204             <privilege>http://tizen.org/privilege/bluetooth</privilege>\r
 205             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 206             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 207             <exception cref="T:System.InvalidOperationException">Thrown when the request is not supported as per Tizen D2D convergence specification </exception>\r
 208             <seealso cref="E:Tizen.Convergence.InternalDeviceFinder.DeviceFound"> Devices found are delivered through this event</seealso>\r
 209             <returns>Task with discovery result</returns>\r
 210         </member>\r
 211         <member name="M:Tizen.Convergence.InternalDeviceFinder.Dispose">\r
 212             <summary>\r
 213             The dispose method\r
 214             </summary>\r
 215         </member>\r
 216         <member name="T:Tizen.Convergence.InternalDeviceFoundEventArgs">\r
 217             <summary>\r
 218             Contains arguments for the event DeviceFound.\r
 219             </summary>\r
 220         </member>\r
 221         <member name="P:Tizen.Convergence.InternalDeviceFoundEventArgs.Device">\r
 222             <summary>\r
 223             The device found\r
 224             </summary>\r
 225         </member>\r
 226         <member name="T:Tizen.Convergence.InternalPayload">\r
 227             <summary>\r
 228             Represents a payload used in Tizen D2D convergence\r
 229             </summary>\r
 230         </member>\r
 231         <member name="M:Tizen.Convergence.InternalPayload.#ctor">\r
 232             <summary>\r
 233             The constructor\r
 234             </summary>\r
 235             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 236             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 237         </member>\r
 238         <member name="M:Tizen.Convergence.InternalPayload.Set(System.String,System.String)">\r
 239             <summary>\r
 240             Adds a key-value pair to payload\r
 241             </summary>\r
 242             <param name="key">The key of the attribute</param>\r
 243             <param name="value">The value of the attribute</param>\r
 244             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 245             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 246             <exception cref="T:System.ArgumentNullException">Thrown if the arguments passed are null </exception>\r
 247         </member>\r
 248         <member name="M:Tizen.Convergence.InternalPayload.Set(System.String,System.Byte[])">\r
 249             <summary>\r
 250             Adds a key-value pair to payload\r
 251             </summary>\r
 252             <param name="key">The key of the attribute</param>\r
 253             <param name="value">The value of the attribute</param>\r
 254             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 255             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 256             <exception cref="T:System.ArgumentNullException">Thrown if the arguments passed are null </exception>\r
 257         </member>\r
 258         <member name="M:Tizen.Convergence.InternalPayload.Set(System.Byte[])">\r
 259             <summary>\r
 260             Sets binary to payload.\r
 261             </summary>\r
 262             <param name="value">The binary to set</param>\r
 263             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 264             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 265             <exception cref="T:System.ArgumentNullException">Thrown if the arguments passed are null </exception>\r
 266         </member>\r
 267         <member name="M:Tizen.Convergence.InternalPayload.Get(System.String,System.String@)">\r
 268             <summary>\r
 269             Gets the value of the key from payload\r
 270             </summary>\r
 271             <param name="key">The key of the attribute</param>\r
 272             <param name="value">The value of the attribute</param>\r
 273             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 274             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 275             <exception cref="T:System.ArgumentNullException">Thrown if the arguments passed are null </exception>\r
 276             <exception cref="T:System.ArgumentException">Thrown if the key is not found </exception>\r
 277         </member>\r
 278         <member name="M:Tizen.Convergence.InternalPayload.Get(System.String,System.Byte[]@)">\r
 279             <summary>\r
 280             Gets the value of the key from payload\r
 281             </summary>\r
 282             <param name="key">The key of the attribute</param>\r
 283             <param name="value">The value of the attribute</param>\r
 284             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 285             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 286             <exception cref="T:System.ArgumentNullException">Thrown if the arguments passed are null </exception>\r
 287             <exception cref="T:System.ArgumentException">Thrown if the key is not found </exception>\r
 288         </member>\r
 289         <member name="M:Tizen.Convergence.InternalPayload.Get(System.Byte[]@)">\r
 290             <summary>\r
 291             Gets binary from payload\r
 292             </summary>\r
 293             <param name="value">The result value</param>\r
 294             <feature>http://tizen.org/feature/convergence.d2d</feature>\r
 295             <exception cref="T:System.NotSupportedException">Thrown if the required feature is not supported.</exception>\r
 296         </member>\r
 297         <member name="M:Tizen.Convergence.InternalPayload.Dispose">\r
 298             <summary>\r
 299             The dispose method\r
 300             </summary>\r
 301         </member>\r
 302         <member name="T:Tizen.Convergence.InternalService">\r
 303             <summary>\r
 304             The class abstracts the features provided by Tizen D2D Convergence.\r
 305             </summary>\r
 306             <seealso cref="!:AppCommunicationService"/>\r
 307         </member>\r
 308         <member name="P:Tizen.Convergence.InternalService.Id">\r
 309             <summary>\r
 310             The ID of the service\r
 311             </summary>\r
 312         </member>\r
 313         <member name="P:Tizen.Convergence.InternalService.Version">\r
 314             <summary>\r
 315             The Version of the service\r
 316             </summary>\r
 317         </member>\r
 318         <member name="E:Tizen.Convergence.InternalService.ServiceEventOccurred">\r
 319             <summary>\r
 320             The event handler for Service Events(Start/Publish/Read/Stop)\r
 321             </summary>\r
 322         </member>\r
 323         <member name="E:Tizen.Convergence.InternalService.ServiceErrorOccured">\r
 324             <summary>\r
 325             The event handler for service error events\r
 326             </summary>\r
 327         </member>\r
 328         <member name="M:Tizen.Convergence.InternalService.Dispose">\r
 329             <summary>\r
 330             The dispose method\r
 331             </summary>\r
 332         </member>\r
 333         <member name="T:Tizen.Convergence.InternalServiceErrorOccuredEventArgs">\r
 334             <summary>\r
 335             Contains arguments for the event ServiceErrorOccured.\r
 336             </summary>\r
 337         </member>\r
 338         <member name="P:Tizen.Convergence.InternalServiceErrorOccuredEventArgs.Exception">\r
 339             <summary>\r
 340             The exception\r
 341             </summary>\r
 342         </member>\r
 343         <member name="T:Tizen.Convergence.InternalServiceEventOccuredEventArgs">\r
 344             <summary>\r
 345             Contains arguments for ServiceEventOccured\r
 346             </summary>\r
 347         </member>\r
 348         <member name="P:Tizen.Convergence.InternalServiceEventOccuredEventArgs.Channel">\r
 349             <summary>\r
 350             The channel on which the event occured\r
 351             </summary>\r
 352         </member>\r
 353         <member name="P:Tizen.Convergence.InternalServiceEventOccuredEventArgs.Payload">\r
 354             <summary>\r
 355             The payload containing the result\r
 356             </summary>\r
 357         </member>\r
 358     </members>\r
 359 </doc>\r