From: Jiung Yu Date: Tue, 25 Apr 2017 07:21:30 +0000 (+0900) Subject: Apply API Doc. guide X-Git-Tag: accepted/tizen/unified/20170426.200059~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F54%2F126854%2F1;p=platform%2Fcore%2Fcsapi%2Fwifi-direct.git Apply API Doc. guide Change-Id: Id13ab70499887fc2108f549ba34ff408b89a7f9b Signed-off-by: Yu jiung --- diff --git a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs new file mode 100644 index 0000000..3052502 --- /dev/null +++ b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs @@ -0,0 +1,7 @@ +/** + +The Tizen.Network.WiFiDirect namespace provides classes to manage the settings of Wi-Fi Direct. +In addition, this namespace provides classes to connect and disconnect remote devices using Wi-Fi Direct. + +*/ +namespace Tizen.Network.WiFiDirect {} diff --git a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectData.cs b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectData.cs index 6112ce4..a40a808 100644 --- a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectData.cs +++ b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectData.cs @@ -56,7 +56,6 @@ namespace Tizen.Network.WiFiDirect [MarshalAsAttribute(UnmanagedType.I1)] internal bool _isMiracast; } - [StructLayout(LayoutKind.Sequential)] internal struct ConnectedPeerStruct { diff --git a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs index e15f92e..341cfd9 100644 --- a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs +++ b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs @@ -197,7 +197,6 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for Wi-Fi Direct secondary device type. /// - /// public enum WiFiDirectSecondaryDeviceType { /// diff --git a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectError.cs b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectError.cs index 325a5c9..80e929e 100644 --- a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectError.cs +++ b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectError.cs @@ -52,7 +52,7 @@ namespace Tizen.Network.WiFiDirect case WiFiDirectError.OutOfMemory: throw new InvalidOperationException("Out of memory"); case WiFiDirectError.PermissionDenied: - throw new InvalidOperationException("Permission denied"); + throw new UnauthorizedAccessException("Permission denied (http://tizen.org/privilege/wifidirect)"); case WiFiDirectError.ResourceBusy: throw new InvalidOperationException("Resource is busy"); case WiFiDirectError.TooManyClient: diff --git a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs index 2bf795e..40132c6 100644 --- a/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs +++ b/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs @@ -23,16 +23,22 @@ namespace Tizen.Network.WiFiDirect /// A class which is used to manage settings of Wi-Fi Direct.
/// This class is used to discover peer devices and manage settings of Wi-Fi Direct. /// - /// http://tizen.org/privilege/wifidirect public static class WiFiDirectManager { /// - /// A property to check whether the Wifidirect is initialized or not. + /// Gets the IsInitialized. /// + /// + /// A property to check whether the Wifidirect is initialized or not. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If it is not initialized, false will be returned. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. [EditorBrowsable(EditorBrowsableState.Never)] public static bool IsInitialized { @@ -42,12 +48,20 @@ namespace Tizen.Network.WiFiDirect } } /// - /// A property to check whether the device is group owner or not. + /// Gets the IsGroupOwner. /// + /// + /// A property to check whether the device is group owner or not. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, false will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool IsGroupOwner { get @@ -65,12 +79,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// A property to check whether the current group is the autonomous group or not. + /// Gets the IsAutonomousGroup. /// + /// + /// A property to check whether the current group is the autonomous group or not. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, false will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool IsAutonomousGroup { get @@ -88,12 +110,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// SSID of local device. + /// Gets the Ssid. /// + /// + /// SSID of local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, null will be returned. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string Ssid { get @@ -111,12 +140,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// Name of network interface. + /// Gets the NetworkInterface. /// + /// + /// Name of network interface. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string NetworkInterface { get @@ -134,12 +171,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// IP address of a local device. + /// Gets the IpAddress. /// + /// + /// IP address of a local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string IpAddress { get @@ -157,12 +202,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// Subnet mask. + /// Gets the SubnetMask. /// + /// + /// Subnet mask. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string SubnetMask { get @@ -180,12 +233,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// Gateway address. + /// Gets the GatewayAddress. /// + /// + /// Gateway address. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string GatewayAddress { get @@ -203,12 +264,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// Mac address of a local device. + /// Gets the MacAddress. /// + /// + /// Mac address of a local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, null will be returned. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string MacAddress { get @@ -226,8 +294,16 @@ namespace Tizen.Network.WiFiDirect } /// - /// State of Wi-Fi direct service. + /// Gets the State. /// + /// + /// State of Wi-Fi direct service. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static WiFiDirectState State { get @@ -239,6 +315,14 @@ namespace Tizen.Network.WiFiDirect /// /// A property to check whether the device is discoverable or not by P2P discovery. /// + /// + /// + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool IsDiscoverable { get @@ -256,12 +340,20 @@ namespace Tizen.Network.WiFiDirect } /// - /// A property to check whether the local device is listening only. + /// Gets the IsListenOnly. /// + /// + /// A property to check whether the local device is listening only. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, false will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool IsListenOnly { get @@ -279,11 +371,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// Primary device type of local device. + /// Gets the PrimaryType. /// + /// + /// Primary device type of local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, 0 will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static WiFiDirectPrimaryDeviceType PrimaryType { get @@ -301,11 +401,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// Secondary device type of local device. + /// Gets the SecondaryType. /// + /// + /// Secondary device type of local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, 0 will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static WiFiDirectSecondaryDeviceType SecondaryType { get @@ -323,12 +431,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// Supported WPS (Wi-Fi Protected Setup) types at local device. + /// Gets the WpsMode. /// + /// + /// Supported WPS (Wi-Fi Protected Setup) types at local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, -1 will be returned. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static int WpsMode { get @@ -346,8 +461,16 @@ namespace Tizen.Network.WiFiDirect } /// - /// WPS (Wi-Fi Protected Setup) type. + /// Gets the Wps. /// + /// + /// WPS (Wi-Fi Protected Setup) type. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static WiFiDirectWpsType Wps { get @@ -365,11 +488,19 @@ namespace Tizen.Network.WiFiDirect } /// - /// Channel number on which the P2P Device is operating as the P2P Group. + /// Gets the OperatingChannel. /// + /// + /// Channel number on which the P2P Device is operating as the P2P Group. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// If there is any error, -1 will be returned. /// + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static int OperatingChannel { get @@ -387,9 +518,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// A property to check whether persistent group is enabled. + /// Gets and sets the PersistentGroupEnabled. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// A property to check whether persistent group is enabled. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool PersistentGroupEnabled { get @@ -415,9 +554,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// Autoconnection mode status. + /// Gets and sets the AutoConnect. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// Autoconnection mode status. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static bool AutoConnect { get @@ -443,13 +590,21 @@ namespace Tizen.Network.WiFiDirect } /// - /// WPS PIN number. + /// Gets and sets the WpsPin. /// + /// + /// WPS PIN number. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned during get and Not permitted exception message will be returned during set. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string WpsPin { get @@ -481,9 +636,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// Name of local device. + /// Gets and sets the Name. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// Name of local device. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string Name { get @@ -509,9 +672,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// Requested WPS (Wi-Fi Protected Setup) type. + /// Gets and sets the RequestedWps. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// Requested WPS (Wi-Fi Protected Setup) type. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static WiFiDirectWpsType RequestedWps { get @@ -537,9 +708,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// Intent of the group owner. + /// Gets and sets the GroupOwnerIntent. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// Intent of the group owner. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static int GroupOwnerIntent { get @@ -565,9 +744,17 @@ namespace Tizen.Network.WiFiDirect } /// - /// Max number of clients. + /// Gets and sets the MaxClients. /// - /// Thrown while setting this property when the wifidirect is not supported + /// + /// Max number of clients. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static int MaxClients { get @@ -593,14 +780,22 @@ namespace Tizen.Network.WiFiDirect } /// - /// Wi-Fi Protected Access (WPA) password. + /// Gets and sets the Passphrase. /// It is used during Wi-Fi Direct Group creation. /// + /// + /// Wi-Fi Protected Access (WPA) password. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, null will be returned during get and Not permitted exception message will be returned during set. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static string Passphrase { get @@ -632,13 +827,21 @@ namespace Tizen.Network.WiFiDirect } /// - /// Connection session timer value in second. + /// Gets and sets the SessionTimer. /// + /// + /// Connection session timer value in second. + /// + /// + /// http://tizen.org/privilege/wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If it is deactivated, -1 will be returned during get and Not permitted exception message will be returned during set. /// - /// Thrown while setting this property when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static int SessionTimer { get @@ -779,7 +982,9 @@ namespace Tizen.Network.WiFiDirect /// /// If this succeeds, DeviceStateChanged event will be invoked. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void Activate() { if (Globals.IsInitialize) @@ -797,11 +1002,19 @@ namespace Tizen.Network.WiFiDirect /// /// Deactivates the Wi-Fi Direct service. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If this succeeds, DeviceStateChanged event will be invoked. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void Deactivate() { if (Globals.IsActivated) @@ -819,14 +1032,22 @@ namespace Tizen.Network.WiFiDirect /// /// Starts discovery to find all P2P capable devices. /// + /// Listen status.If False, then cycle between Scan and Listen.If True, then skip the initial 802.11 Scan and enter Listen state. + /// Duration of discovery period, in seconds. + /// Discovery channel.It is optional, default enum value FullScan is assigned. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If this succeeds, DiscoveryStateChanged and PeerFound event will be invoked. /// - /// Thrown when the wifidirect is not supported - /// Listen status.If False, then cycle between Scan and Listen.If True, then skip the initial 802.11 Scan and enter Listen state. - /// Duration of discovery period, in seconds. - /// Discovery channel.It is optional, default enum value FullScan is assigned. + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void StartDiscovery(bool listenOnly, int duration, WiFiDirectDiscoveryChannel channel = WiFiDirectDiscoveryChannel.FullScan) { if (Globals.IsActivated) @@ -844,11 +1065,19 @@ namespace Tizen.Network.WiFiDirect /// /// Cancels discovery process. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Discovery must be started by StartDiscovery. /// If this succeeds, DiscoveryStateChanged and PeerFound event will be invoked. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void CancelDiscovery() { if (WiFiDirectManager.State == WiFiDirectState.Discovering) @@ -866,11 +1095,19 @@ namespace Tizen.Network.WiFiDirect /// /// Gets the information of discovered peers. /// + /// List of discovered peer objects. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// - /// Thrown when the wifidirect is not supported - /// List of discovered peer objects. + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static IEnumerable GetDiscoveredPeers() { if (Globals.IsActivated) @@ -887,11 +1124,19 @@ namespace Tizen.Network.WiFiDirect /// /// Gets the information of connected peers. /// + /// List of connected peer objects. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// - /// Thrown when the wifidirect is not supported - /// List of connected peer objects. + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static IEnumerable GetConnectedPeers() { if (Globals.IsActivated) @@ -908,11 +1153,19 @@ namespace Tizen.Network.WiFiDirect /// /// Disconnects all connected links to peers. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If this succeeds, ConnectionStatusChanged event will be invoked. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void DisconnectAll() { if (Globals.IsActivated) @@ -930,11 +1183,19 @@ namespace Tizen.Network.WiFiDirect /// /// Creates a Wi-Fi Direct group and sets up device as the group owner. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If this succeeds, ConnectionStatusChanged event will be invoked with GroupCreated. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void CreateGroup() { if (Globals.IsActivated) @@ -952,11 +1213,19 @@ namespace Tizen.Network.WiFiDirect /// /// Destroys the Wi-Fi Direct group owned by a local device.If creating a group is in progress, this API cancels that process. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// If this succeeds, ConnectionStatusChanged event will be invoked with GroupDestroyed. /// - /// Thrown when the wifidirect is not supported + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void DestroyGroup() { if (Globals.IsActivated) @@ -974,7 +1243,15 @@ namespace Tizen.Network.WiFiDirect /// /// Set the WPS config PBC as preferred method for connection. /// - /// Thrown when the wifidirect is not supported + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void ActivatePushButton() { if (Globals.IsActivated) @@ -992,8 +1269,16 @@ namespace Tizen.Network.WiFiDirect /// /// Gets the supported WPS types. /// - /// Thrown when the wifidirect is not supported /// The list of supported wps types. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static IEnumerable GetSupportedWpsTypes() { if (Globals.IsInitialize) @@ -1010,8 +1295,16 @@ namespace Tizen.Network.WiFiDirect /// /// Gets the persistent groups. /// - /// Thrown when the wifidirect is not supported /// List of the persistent group objects. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static IEnumerable GetPersistentGroups() { if (Globals.IsInitialize) @@ -1028,8 +1321,16 @@ namespace Tizen.Network.WiFiDirect /// /// Removes a persistent group. /// - /// Thrown when the wifidirect is not supported /// Persistent group owner. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void RemovePersistentGroup(WiFiDirectPersistentGroup group) { if (Globals.IsInitialize) @@ -1047,6 +1348,14 @@ namespace Tizen.Network.WiFiDirect /// /// Initializes or Deintializes the WiFi-Direct Display(MIRACAST) service. /// + /// Enables/Disables service. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.display + /// /// /// Wi-Fi Direct must be activated. /// @@ -1055,7 +1364,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect display feature is not supported /// - /// Enables/Disables service. + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void InitMiracast(bool enable) { if (Globals.IsActivated) @@ -1073,6 +1383,13 @@ namespace Tizen.Network.WiFiDirect /// /// Enables Wi-Fi Display functionality. /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.display + /// /// /// Wi-Fi Direct must be activated. /// @@ -1081,6 +1398,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect display feature is not supported /// + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void InitDisplay() { if (Globals.IsActivated) @@ -1098,6 +1417,13 @@ namespace Tizen.Network.WiFiDirect /// /// Disable Wi-Fi Display(WFD) functionality and disable the support of WFD Information Element(IE). /// + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.display + /// /// /// Wi-Fi Direct must be activated and WFD must be enabled. /// @@ -1106,6 +1432,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect display feature is not supported /// + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void DeinitDisplay() { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1123,6 +1451,16 @@ namespace Tizen.Network.WiFiDirect /// /// Sets the Wi-Fi Display parameters for the WFD IE of local device. /// + /// WFD Device Type: define the Role of WFD device like source or sink. + /// Specifies Session Management Control Port number. It should be 2 bytes(0~65535). + /// CP support bit: (1 = enable the hdcp support, 0 = disable the hdcp support). + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.display + /// /// /// Wi-Fi Direct must be activated and WFD must be enabled. /// @@ -1131,9 +1469,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect display feature is not supported /// - /// WFD Device Type: define the Role of WFD device like source or sink. - /// Specifies Session Management Control Port number. It should be 2 bytes(0~65535). - /// CP support bit: (1 = enable the hdcp support, 0 = disable the hdcp support). + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void SetDisplay(WiFiDirectDisplayType type, int port, int hdcp) { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1151,6 +1488,14 @@ namespace Tizen.Network.WiFiDirect /// /// Sets the Wi-Fi Display session availability. /// + /// Wi-Fi Display session availability. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.display + /// /// /// Wi-Fi Direct must be activated and WFD must be enabled. /// @@ -1159,7 +1504,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect display feature is not supported /// - /// Wi-Fi Display session availability. + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void SetDisplayAvailability(bool availability) { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1177,12 +1523,20 @@ namespace Tizen.Network.WiFiDirect /// /// Sets the automatic group removal feature when all peers are disconnected. /// + /// Enables/Disables group removal feature. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// /// /// Wi-Fi Direct must be activated. /// ConnectionStatusChanged event will be invoked with GroupDestroyed when this feature is enabled and there's no connected group client and if device is group owner. /// - /// Thrown when the wifidirect is not supported - /// Enables/Disables group removal feature. + /// The object is in invalid state. + /// The required feature is not supported. + /// Thrown when application does not have privilege to access this method. public static void SetAutoGroupRemove(bool enable) { if (Globals.IsActivated) @@ -1200,6 +1554,17 @@ namespace Tizen.Network.WiFiDirect /// /// Registers the service. /// + /// The service Id of service getting registered. + /// Type of Wi-Fi Direct Service. + /// Service specific information. + /// Service information. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.service_discovery + /// /// /// Wi-Fi Direct must be activated. /// If there is any error while registering service, 0 will be returned. @@ -1209,10 +1574,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect service discovery is not supported /// - /// The service Id of service getting registered. - /// Type of Wi-Fi Direct Service. - /// Service specific information. - /// Service information. + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static uint RegisterService(WiFiDirectServiceType type, string info, string serviceInfo) { if (Globals.IsActivated) @@ -1229,6 +1592,14 @@ namespace Tizen.Network.WiFiDirect /// /// Deregisters for a service used for WiFi Direct Service Discovery. /// + /// Service ID for which service has to be deregistered. + /// + /// http://tizen.org/privilege/wifidirect + /// + /// + /// http://tizen.org/feature/network.wifidirect + /// http://tizen.org/feature/network.wifi.direct.service_discovery + /// /// /// Wi-Fi Direct must be activated. /// @@ -1237,7 +1608,8 @@ namespace Tizen.Network.WiFiDirect /// 1. When the wifidirect is not supported /// 2. When the wifidirect service discovery is not supported /// - /// Service ID for which service has to be deregistered. + /// The object is in invalid state. + /// Thrown when application does not have privilege to access this method. public static void DeregisterService(uint serviceId) { if (Globals.IsActivated)