From 76cfc93c9bb90038988b2945e1b9854a669b1978 Mon Sep 17 00:00:00 2001 From: DotnetBuild Date: Wed, 11 Oct 2017 17:11:16 +0900 Subject: [PATCH] Release 4.0.0-preview1-00285 --- packaging/csapi-tizenfx.spec | 4 +- .../ElmSharp.Wearable/CircleDatetimeSelector.cs | 5 + .../ElmSharp.Wearable/CircleGenList.cs | 5 + .../ElmSharp.Wearable/CircleScroller.cs | 5 + .../ElmSharp.Wearable/CircleSlider.cs | 5 + .../ElmSharp.Wearable/CircleSpinner.cs | 5 + .../ElmSharp.Wearable/MoreOption.cs | 17 +++ .../ElmSharp.Wearable/MoreOptionList.cs | 2 +- .../ElmSharp.Wearable/RotarySelector.cs | 5 + .../Tizen.Applications/RemoteView.cs | 2 +- .../Tizen.CallManager/CmClientHandle.cs | 3 + .../Tizen.Content.MediaContent/NamespaceDoc.cs | 26 ---- .../doc/api/Tizen.Content.MediaContent.md | 25 ++++ .../Tizen.Context.AppHistory/NamespaceDoc.cs | 24 ---- .../doc/api/Tizen.Context.AppHistory.md | 19 +++ .../Tizen.Location.Geofence/NamespaceDoc.cs | 38 ------ .../doc/api/Tizen.Location.Geofence.md | 29 +++++ src/Tizen.Location/Tizen.Location/NamespaceDoc.cs | 21 ---- src/Tizen.Location/doc/api/Tizen.Location.md | 15 +++ src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs | 132 --------------------- src/Tizen.Maps/doc/api/Tizen.Maps.md | 107 +++++++++++++++++ .../Tizen.Messaging.Email/NamespaceDoc.cs | 26 ---- .../Tizen.Messaging.Messages/NamespaceDoc.cs | 25 ---- .../doc/api/Tizen.Messaging.Email.md | 18 +++ .../doc/api/Tizen.Messaging.Messages.md | 18 +++ src/Tizen.Multimedia.Remoting/NamespaceDoc.cs | 22 ---- .../doc/api/Tizen.Multimedia.Remoting.md | 18 +++ src/Tizen.Multimedia.Vision/NamespaceDoc.cs | 25 ---- .../doc/api/Tizen.Multimedia.Vision.md | 22 ++++ .../Tizen.Network.Bluetooth/BluetoothAdapter.cs | 2 +- .../Tizen.Network.Bluetooth/BluetoothAudio.cs | 4 +- .../Tizen.Network.Bluetooth/BluetoothAvrcp.cs | 2 +- .../Tizen.Network.Bluetooth/BluetoothDevice.cs | 2 +- .../Tizen.Network.Bluetooth/BluetoothEventArgs.cs | 3 + .../Tizen.Network.Bluetooth/BluetoothGatt.cs | 10 +- .../Tizen.Network.Bluetooth/BluetoothLeAdapter.cs | 9 ++ .../Tizen.Network.Bluetooth/BluetoothOpp.cs | 3 + .../Tizen.Network.Bluetooth/BluetoothProfile.cs | 2 +- .../BluetoothServerSocket.cs | 6 + .../Tizen.Network.Bluetooth/BluetoothSocket.cs | 26 ++++ .../Tizen.Network.Bluetooth/BluetoothStructs.cs | 1 - .../Tizen.Network.IoTConnectivity/NamespaceDoc.cs | 12 -- .../doc/api/Tizen.Network.IoTConnectivity.md | 6 + .../Tizen.Network.Mtp/NamespaceDoc.cs | 44 ------- src/Tizen.Network.Mtp/doc/api/Tizen.Network.Mtp.md | 26 ++++ .../Tizen.Network.Nsd/NamespaceDoc.cs | 30 ----- src/Tizen.Network.Nsd/doc/api/Tizen.Network.Nsd.md | 25 ++++ .../Tizen.Network.WiFiDirect/NamespaceDoc.cs | 5 - .../doc/api/Tizen.Network.WiFiDirect.md | 6 + .../Tizen.PhonenumberUtils/NamespaceDoc.cs | 26 ---- .../doc/api/Tizen.PhonenumberUtils.md | 19 +++ .../Tizen.Pims.Calendar/NamespaceDoc.cs | 27 ----- .../doc/api/Tizen.Pims.Calendar.md | 19 +++ .../Tizen.Pims.Contacts/NamespaceDoc.cs | 26 ---- .../doc/api/Tizen.Pims.Contacts.md | 19 +++ .../NamespaceDoc.cs | 41 ------- .../doc/api/Tizen.Security.SecureRepository.md | 30 +++++ .../api/Tizen.Security.TEEC.md} | 77 ++++-------- .../Tizen.Sensor/Plugins/ActivityDetector.cs | 26 +++- .../Tizen.Sensor/Plugins/ProximitySensor.cs | 2 +- src/Tizen.Sensor/Tizen.Sensor/Sensor.cs | 13 ++ .../Tizen.Sensor/SensorEnumerations.cs | 8 +- src/Tizen.Tapi/Tizen.Tapi/CallData.cs | 6 + src/Tizen.Tapi/Tizen.Tapi/SsEnumerations.cs | 6 +- .../Tizen.WebView/JavaScriptMessage.cs | 4 + src/Tizen.WebView/Tizen.WebView/WebView.cs | 5 + 66 files changed, 624 insertions(+), 622 deletions(-) delete mode 100644 src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/NamespaceDoc.cs create mode 100644 src/Tizen.Content.MediaContent/doc/api/Tizen.Content.MediaContent.md delete mode 100644 src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs create mode 100644 src/Tizen.Context/doc/api/Tizen.Context.AppHistory.md delete mode 100755 src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs create mode 100755 src/Tizen.Location.Geofence/doc/api/Tizen.Location.Geofence.md delete mode 100755 src/Tizen.Location/Tizen.Location/NamespaceDoc.cs create mode 100755 src/Tizen.Location/doc/api/Tizen.Location.md delete mode 100755 src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs create mode 100644 src/Tizen.Maps/doc/api/Tizen.Maps.md delete mode 100644 src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs delete mode 100644 src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs create mode 100644 src/Tizen.Messaging/doc/api/Tizen.Messaging.Email.md create mode 100644 src/Tizen.Messaging/doc/api/Tizen.Messaging.Messages.md delete mode 100644 src/Tizen.Multimedia.Remoting/NamespaceDoc.cs create mode 100644 src/Tizen.Multimedia.Remoting/doc/api/Tizen.Multimedia.Remoting.md delete mode 100644 src/Tizen.Multimedia.Vision/NamespaceDoc.cs create mode 100644 src/Tizen.Multimedia.Vision/doc/api/Tizen.Multimedia.Vision.md delete mode 100755 src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs create mode 100755 src/Tizen.Network.IoTConnectivity/doc/api/Tizen.Network.IoTConnectivity.md delete mode 100644 src/Tizen.Network.Mtp/Tizen.Network.Mtp/NamespaceDoc.cs create mode 100644 src/Tizen.Network.Mtp/doc/api/Tizen.Network.Mtp.md delete mode 100644 src/Tizen.Network.Nsd/Tizen.Network.Nsd/NamespaceDoc.cs create mode 100644 src/Tizen.Network.Nsd/doc/api/Tizen.Network.Nsd.md delete mode 100644 src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs create mode 100644 src/Tizen.Network.WiFiDirect/doc/api/Tizen.Network.WiFiDirect.md delete mode 100644 src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs create mode 100644 src/Tizen.PhonenumberUtils/doc/api/Tizen.PhonenumberUtils.md delete mode 100644 src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/NamespaceDoc.cs create mode 100644 src/Tizen.Pims.Calendar/doc/api/Tizen.Pims.Calendar.md delete mode 100644 src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NamespaceDoc.cs create mode 100644 src/Tizen.Pims.Contacts/doc/api/Tizen.Pims.Contacts.md delete mode 100644 src/Tizen.Security.SecureRepository/NamespaceDoc.cs create mode 100644 src/Tizen.Security.SecureRepository/doc/api/Tizen.Security.SecureRepository.md rename src/Tizen.Security.TEEC/{Tizen.Security.TEEC/NamespaceDoc.cs => doc/api/Tizen.Security.TEEC.md} (66%) diff --git a/packaging/csapi-tizenfx.spec b/packaging/csapi-tizenfx.spec index 8887dfa..63703bc 100644 --- a/packaging/csapi-tizenfx.spec +++ b/packaging/csapi-tizenfx.spec @@ -9,7 +9,7 @@ Name: csapi-tizenfx Summary: Assemblies of Tizen .NET -Version: 4.0.0.279 +Version: 4.0.0.285 Release: 1 Group: Development/Libraries License: Apache-2.0 @@ -144,7 +144,7 @@ rm -fr %{_tizenfx_bin_path} export DOTNET_SKIP_FIRST_TIME_EXPERIENCE=true ./build.sh --full ./build.sh --dummy -./build.sh --pack 4.0.0-preview1-00279 +./build.sh --pack 4.0.0-preview1-00285 %install mkdir -p %{buildroot}%{DOTNET_ASSEMBLY_PATH} diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs index 7834970..6623984 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleDatetimeSelector.cs @@ -94,6 +94,11 @@ namespace ElmSharp.Wearable } } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { var handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs index c987009..d5c31e3 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleGenList.cs @@ -164,6 +164,11 @@ namespace ElmSharp.Wearable } } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { var handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs index c786615..cd3a3c3 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleScroller.cs @@ -292,6 +292,11 @@ namespace ElmSharp.Wearable } } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs index 5347948..48f86a1 100755 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs @@ -342,6 +342,11 @@ namespace ElmSharp.Wearable } } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { IntPtr surface = IntPtr.Zero; diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs index e85d589..fbc84d7 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSpinner.cs @@ -114,6 +114,11 @@ namespace ElmSharp.Wearable } } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { IntPtr handle = base.CreateHandle(parent); diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs index 002a7a6..7395c08 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOption.cs @@ -68,6 +68,11 @@ namespace ElmSharp.Wearable } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { return Interop.Eext.eext_more_option_add(parent); @@ -112,9 +117,21 @@ namespace ElmSharp.Wearable /// public enum MoreOptionDirection { + /// + /// Top direction + /// Top, + /// + /// Bottom direction + /// Bottom, + /// + /// Left direction + /// Left, + /// + /// Right direction + /// Right } } diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionList.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionList.cs index 95510d0..c5dbf32 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionList.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/MoreOptionList.cs @@ -168,7 +168,7 @@ namespace ElmSharp.Wearable } /// - /// Return an enumerator that iterates through IEnumerator + /// Return an enumerator that iterates through IEnumerator /// /// public IEnumerator GetEnumerator() diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs index 48a2c80..5f56be9 100644 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/RotarySelector.cs @@ -120,6 +120,11 @@ namespace ElmSharp.Wearable /// public Image BackgroundImage { set => setPart(ref _normalBgImage, BgPartName, State.Normal, value); get => _normalBgImage; } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// Handle IntPtr protected override IntPtr CreateHandle(EvasObject parent) { IntPtr ptr = Interop.Eext.eext_rotary_selector_add(parent); diff --git a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs index f20e8bb..333cb38 100755 --- a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs +++ b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs @@ -150,7 +150,7 @@ namespace Tizen.Applications /// http://tizen.org/privilege/widget.viewer /// Thrown when this operation failed. /// Thrown when this operation is denied. - /// Thrown when this operation is not supported for this device<./exception> + /// Thrown when this operation is not supported for this device. public static void ResumeAll() { CheckException(Interop.WidgetViewerEvas.NotifyResumedStatusOfViewer()); diff --git a/src/Tizen.CallManager/Tizen.CallManager/CmClientHandle.cs b/src/Tizen.CallManager/Tizen.CallManager/CmClientHandle.cs index 38b4292..72eb620 100755 --- a/src/Tizen.CallManager/Tizen.CallManager/CmClientHandle.cs +++ b/src/Tizen.CallManager/Tizen.CallManager/CmClientHandle.cs @@ -442,6 +442,9 @@ namespace Tizen.CallManager } } + /// + /// Gets the status of the current call. + /// public CallStatus CallStatus { get diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/NamespaceDoc.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/NamespaceDoc.cs deleted file mode 100644 index 817c9b7..0000000 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/NamespaceDoc.cs +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/// -/// The Tizen.Content.MediaContent namespace provides types used in the entire content service. -/// The information about media items (i.e. image, audio, and video) are managed in the content database -/// and operations that involve database require an active connection with the media content service. -/// During media scanning, the media content service extracts the media information automatically. The media information -/// includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF, -/// thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage. -/// -/// The media content service does not manage hidden files. -namespace Tizen.Content.MediaContent { } \ No newline at end of file diff --git a/src/Tizen.Content.MediaContent/doc/api/Tizen.Content.MediaContent.md b/src/Tizen.Content.MediaContent/doc/api/Tizen.Content.MediaContent.md new file mode 100644 index 0000000..6159c34 --- /dev/null +++ b/src/Tizen.Content.MediaContent/doc/api/Tizen.Content.MediaContent.md @@ -0,0 +1,25 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Content.MediaContent +summary: *content +remarks: The media content service does not manage hidden files. +--- +The Tizen.Content.MediaContent namespace provides types used in the entire content service. +The information about media items (i.e. image, audio, and video) are managed in the content database +and operations that involve database require an active connection with the media content service. +During media scanning, the media content service extracts the media information automatically. The media information +includes basic file information like path, size, modified time, etc. and some metadata like ID3 tag, EXIF, +thumbnail, etc. (thumbnail extracted only in the internal and the SD card storage. diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs b/src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs deleted file mode 100644 index 8989d3f..0000000 --- a/src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs +++ /dev/null @@ -1,24 +0,0 @@ -/* - * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/// -/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns. -/// -/// -/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns. -/// -/// 4 -namespace Tizen.Context.AppHistory {} diff --git a/src/Tizen.Context/doc/api/Tizen.Context.AppHistory.md b/src/Tizen.Context/doc/api/Tizen.Context.AppHistory.md new file mode 100644 index 0000000..e3ac8ec --- /dev/null +++ b/src/Tizen.Context/doc/api/Tizen.Context.AppHistory.md @@ -0,0 +1,19 @@ +--- +# Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Context.AppHistory +summary: The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns. +sinceTizen: 4 +--- diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs deleted file mode 100755 index 5d4315a..0000000 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/NamespaceDoc.cs +++ /dev/null @@ -1,38 +0,0 @@ -/** - -The Tizen.Location.Geofence namespace provides classes for virtual perimeter. - - - - -

Overview

- -This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address. -Also, notifications on events like changing in service status are provided.

- -There are two kinds of places and fences:
-- Public places and fences that are created by the MyPlace application can be used by all applications.
-- Private places and fences that are created by the specified application can be used by the same application.

- -Notifications can be received about the following events:
-- Zone in when a device enters a specific area.
-- Zone out when a device exits a specific area.
-- Results and errors for each event requested to geofence module.

- -The Geofence manager has the following properties:
-- The geofence type.
-- The status.
-- 'Service state change' callback - - -

Related Features

-To guarantee that the geofence application runs on a device with the geofence profile feature, -declare the following feature requirements in the config file:
-http://tizen.org/feature/location
-http://tizen.org/feature/location.Geofence
-http://tizen.org/feature/location.wps - - - -*/ -namespace Tizen.Location.Geofence {} diff --git a/src/Tizen.Location.Geofence/doc/api/Tizen.Location.Geofence.md b/src/Tizen.Location.Geofence/doc/api/Tizen.Location.Geofence.md new file mode 100755 index 0000000..6d992ae --- /dev/null +++ b/src/Tizen.Location.Geofence/doc/api/Tizen.Location.Geofence.md @@ -0,0 +1,29 @@ +--- +uid: Tizen.Location.Geofence +summary: The Tizen.Location.Geofence namespace provides classes for virtual perimeter. +remarks: *content +--- +## Overview +This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address. +Also, notifications on events like changing in service status are provided. + +There are two kinds of places and fences: +- Public places and fences that are created by the MyPlace application can be used by all applications. +- Private places and fences that are created by the specified application can be used by the same application. + +Notifications can be received about the following events: +- Zone in when a device enters a specific area. +- Zone out when a device exits a specific area. +- Results and errors for each event requested to geofence module. + +The Geofence manager has the following properties: +- The geofence type. +- The status. +- 'Service state change' callback + +## Related Features +To guarantee that the geofence application runs on a device with the geofence profile feature, +declare the following feature requirements in the config file: +* http://tizen.org/feature/location +* http://tizen.org/feature/location.Geofence +* http://tizen.org/feature/location.wps diff --git a/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs b/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs deleted file mode 100755 index 697cfd1..0000000 --- a/src/Tizen.Location/Tizen.Location/NamespaceDoc.cs +++ /dev/null @@ -1,21 +0,0 @@ -/** - -The Tizen.Location namespace provides classes for obtaining information related to the geographical location. -Notifications on events like service becoming enabled or disabled, -new position data being available, and others can also be acquired. - - -

Overview

-The Tizen.Location namespace provides classes for obtaining information related to the geographical location. -Notifications on events like service becoming enabled or disabled, -new position data being available, and others can also be acquired. -

Related Features

-To guarantee that the location application runs on a device with the location profile feature, -declare the following feature requirements in the config file:
-http://tizen.org/feature/location
-http://tizen.org/feature/location.gps
-http://tizen.org/feature/location.wps - - -*/ -namespace Tizen.Location {} diff --git a/src/Tizen.Location/doc/api/Tizen.Location.md b/src/Tizen.Location/doc/api/Tizen.Location.md new file mode 100755 index 0000000..6045bea --- /dev/null +++ b/src/Tizen.Location/doc/api/Tizen.Location.md @@ -0,0 +1,15 @@ +--- +uid: Tizen.Location +remarks: *content +--- +## Overview +The Tizen.Location namespace provides classes for obtaining information related to the geographical location. +Notifications on events like service becoming enabled or disabled, +new position data being available, and others can also be acquired. + +## Related Features +To guarantee that the location application runs on a device with the location profile feature, +declare the following feature requirements in the config file: +* http://tizen.org/feature/location +* http://tizen.org/feature/location.gps +* http://tizen.org/feature/location.wps diff --git a/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs b/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs deleted file mode 100755 index ff35212..0000000 --- a/src/Tizen.Maps/Tizen.Maps/NamespaceDoc.cs +++ /dev/null @@ -1,132 +0,0 @@ -/** - -The Tizen.Maps namespace provides classes to get the information of Place, Geocoding, Route by querying, -or to show them on the map view with interactive gestural interface. - - - - - - -

Overview

- -Maps API provides a developer with a set of functions, helping to create Maps aware applications.

- -Maps API comprises of following features:
-- Geocoding and reverse Geocoding
-- Discoverying Place information
-- Calculating Route
-- View - - - - -Maps API allows a Developer to choose one of Map Providers which are being included as plugins.

- - -

Geocoding

-The Maps Geocoding API allows translating an address to its geographical -location defined in terms of latitude and longitude; the input can be a -qualified and structured address or a free-formed search text with full or -partial address information.

- -The example below shows a structured address:
- - housenumber=117,
- - street=Invaliden street
- - city=Berlin,
- - postalcode=10115,
- - country=Germany,
- - state=Berlin - - - - -

Reverse Geocoding

-The Maps Reverse Geocoding API allows to inverse translating a geographical -location (longitude, latitude) to an address; it can be used to answer the -question "Where am I?". - - - - -

Route

-The Maps Route API provides ways to calculate a route that defines a path -between a start and a destination and may, optionally, pass through specific -intermediate locations.

- -Route Preferences:
- - Travel Mode (car, pedestrian, public transit, truck),
- - Optimization (fastest, shortest),
- - Avoid/Prefer Preferences (toll road, motorway, ferry, public transit, - tunnel, dirt road, parks, car-pool lane).
- - Route Calculations
- - Way points and preferences as input values,
- - Route geometry and maneuver (instructions for guidance) as result values: - Geometry consists of points that visually represent the determined route, - Maneuver contains turn-by-turn instruction and position. - - - - -

Places

-The Maps Place API allows you to find place information.

- -Place search
- - Depending on the location context, the number of relevant places might - be large. Therefore this query may not only return places, but also - suggestions for additional filter criteria that allow users to interactively - refine the classes of places they are interested in.
- - Nearby Search: search for places within a specified area. - You can refine your search request by supplying keywords, Name of Points - of Interests, or Proximity.
- - Category Search: search for popular places for the given location context and matching the category filter criteria. - You can refine your search request by specifying the categories of place you are searching for.
-Result item type of searching
- - ID, name, location, distance, URI, rating, category.
-Place information allows to fetch details about a place. The following place content is supported:
- - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path, - image content, review content, and editorial content.
- - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access. - - - - -

View

-The Maps View API provides a developer with a set of functions, bringing -basic interactive visual user interface in maps applications.

- -View widget: Drawing a map image on the map port, the specified rectangular -area of the maps application GUI.

- -Zoom and rotation: Changing zoom and orientation of the view in response -to user gestures, such as scrolling, tapping, zooming, rotating, etc.

- -Conversion of screen coordinates to geographical and vice versa.

- -User's gesture support:
- - Receive the event of the user gesture.
- - Enable or disable the specified gesture.
- - Re-assign the action, which should be taken in response to the user's gesture.

- -Various Properties:
- - Visibility and size on the screen.
- - Theme: Day, satellite, or terrain.
- - Language: English, Russian, Chinese, Italian, German, Spanish, etc. - - - - - -

Related Features

- -To guarantee that the Maps application runs on a device with Maps profile feature, -declare the following feature requirements in the config file:
-http://tizen.org/feature/maps
-http://tizen.org/feature/internet - - - -*/ - -namespace Tizen.Maps {} - diff --git a/src/Tizen.Maps/doc/api/Tizen.Maps.md b/src/Tizen.Maps/doc/api/Tizen.Maps.md new file mode 100644 index 0000000..d898af7 --- /dev/null +++ b/src/Tizen.Maps/doc/api/Tizen.Maps.md @@ -0,0 +1,107 @@ +--- +uid: Tizen.Maps +remarks: *content +--- +## Overview + +Maps API provides a developer with a set of functions, helping to create Maps aware applications. + +Maps API comprises of following features: +- [Geocoding](#geocoding) and [reverse Geocoding](#reverse-geocoding) +- Discoverying [place](#places) information +- Calculating [route](#route) +- [View](#view) + +Maps API allows a Developer to choose one of Map Providers which are being included as plugins. + +### Geocoding + +The [Maps Geocoding](xref:Tizen.Maps.GeocodeRequest) API allows translating an address to its geographical +location defined in terms of latitude and longitude; the input can be a +qualified and structured address or a free-formed search text with full or +partial address information. + +The example below shows a structured address: + - housenumber=117, + - street=Invaliden street + - city=Berlin, + - postalcode=10115, + - country=Germany, + - state=Berlin + + +### Reverse Geocoding + +The [Maps Reverse Geocoding](xref:Tizen.Maps.ReverseGeocodeRequest) API allows to inverse translating a geographical +location (longitude, latitude) to an address; it can be used to answer the +question "Where am I?". + + +### Route + +The [Maps Route](xref:Tizen.Maps.Route) API provides ways to calculate a route that defines a path +between a start and a destination and may, optionally, pass through specific +intermediate locations. + +Route Preferences: + - Travel Mode (car, pedestrian, public transit, truck), + - Optimization (fastest, shortest), + - Avoid/Prefer Preferences (toll road, motorway, ferry, public transit, + tunnel, dirt road, parks, car-pool lane). + - Route Calculations + - Way points and preferences as input values, + - Route geometry and maneuver (instructions for guidance) as result values: + Geometry consists of points that visually represent the determined route, + Maneuver contains turn-by-turn instruction and position. + + +### Places + +The [Maps Place](xref:Tizen.Maps.Place) API allows you to find place information. + +Place search + - Depending on the location context, the number of relevant places might + be large. Therefore this query may not only return places, but also + suggestions for additional filter criteria that allow users to interactively + refine the classes of places they are interested in. + - Nearby Search: search for places within a specified area. + You can refine your search request by supplying keywords, Name of Points + of Interests, or Proximity. + - Category Search: search for popular places for the given location context and matching the category filter criteria. + You can refine your search request by specifying the categories of place you are searching for. +Result item type of searching + - ID, name, location, distance, URI, rating, category. +Place information allows to fetch details about a place. The following place content is supported: + - Base Attribute includes name, location, categories, contacts, ID, ratings, icon path, + image content, review content, and editorial content. + - Extended Attribute refers to opening hours, payment methods, annual closings, disabled access. + + +### View +The [Maps View](xref:Tizen.Maps.MapView) API provides a developer with a set of functions, bringing +basic interactive visual user interface in maps applications. + +View widget: Drawing a map image on the map port, the specified rectangular +area of the maps application GUI. + +Zoom and rotation: Changing zoom and orientation of the view in response +to user gestures, such as scrolling, tapping, zooming, rotating, etc. + +Conversion of screen coordinates to geographical and vice versa. + +User's gesture support: + - Receive the event of the user gesture. + - Enable or disable the specified gesture. + - Re-assign the action, which should be taken in response to the user's gesture. + +Various Properties: + - Visibility and size on the screen. + - Theme: Day, satellite, or terrain. + - Language: English, Russian, Chinese, Italian, German, Spanish, etc. + + +### Related Features +To guarantee that the Maps application runs on a device with Maps profile feature, +declare the following feature requirements in the config file: +* http://tizen.org/feature/maps +* http://tizen.org/feature/internet diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs deleted file mode 100644 index 3a072c5..0000000 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - - -namespace Tizen.Messaging.Email -{ - /// - /// The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails. - /// - /// - /// The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails. - /// -} diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs deleted file mode 100644 index b540106..0000000 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace Tizen.Messaging.Messages -{ - /// - /// The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages. - /// - /// - /// The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages. - /// -} \ No newline at end of file diff --git a/src/Tizen.Messaging/doc/api/Tizen.Messaging.Email.md b/src/Tizen.Messaging/doc/api/Tizen.Messaging.Email.md new file mode 100644 index 0000000..def7ad1 --- /dev/null +++ b/src/Tizen.Messaging/doc/api/Tizen.Messaging.Email.md @@ -0,0 +1,18 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Messaging.Email +summary: The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails. +--- diff --git a/src/Tizen.Messaging/doc/api/Tizen.Messaging.Messages.md b/src/Tizen.Messaging/doc/api/Tizen.Messaging.Messages.md new file mode 100644 index 0000000..4036a10 --- /dev/null +++ b/src/Tizen.Messaging/doc/api/Tizen.Messaging.Messages.md @@ -0,0 +1,18 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Messaging.Messages +summary: The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages. +--- diff --git a/src/Tizen.Multimedia.Remoting/NamespaceDoc.cs b/src/Tizen.Multimedia.Remoting/NamespaceDoc.cs deleted file mode 100644 index c5931e53..0000000 --- a/src/Tizen.Multimedia.Remoting/NamespaceDoc.cs +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/// -/// The System.Runtime.Remoting namespace provides classes and interfaces that work with remote process or device. -/// -namespace Tizen.Multimedia.Remoting -{ -} \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/doc/api/Tizen.Multimedia.Remoting.md b/src/Tizen.Multimedia.Remoting/doc/api/Tizen.Multimedia.Remoting.md new file mode 100644 index 0000000..d9c377a --- /dev/null +++ b/src/Tizen.Multimedia.Remoting/doc/api/Tizen.Multimedia.Remoting.md @@ -0,0 +1,18 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Multimedia.Remoting +summary: The System.Runtime.Remoting namespace provides classes and interfaces that work with remote process or device. +--- diff --git a/src/Tizen.Multimedia.Vision/NamespaceDoc.cs b/src/Tizen.Multimedia.Vision/NamespaceDoc.cs deleted file mode 100644 index e66f453..0000000 --- a/src/Tizen.Multimedia.Vision/NamespaceDoc.cs +++ /dev/null @@ -1,25 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -/// -/// The Tizen.Multimedia.Vision namespace contains classes and interfaces that support vision processing including -/// face detection, face recognition, face tracking, barcode detection, barcode generation, flat image detection, -/// flat image recognition, flat image tracking, flat image features extraction, movement detection, -/// person appearance/disappearance detection and person recognition. -/// -namespace Tizen.Multimedia.Vision -{ -} diff --git a/src/Tizen.Multimedia.Vision/doc/api/Tizen.Multimedia.Vision.md b/src/Tizen.Multimedia.Vision/doc/api/Tizen.Multimedia.Vision.md new file mode 100644 index 0000000..3f3be66 --- /dev/null +++ b/src/Tizen.Multimedia.Vision/doc/api/Tizen.Multimedia.Vision.md @@ -0,0 +1,22 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Multimedia.Vision +summary: *content +--- +The Tizen.Multimedia.Vision namespace contains classes and interfaces that support vision processing including +face detection, face recognition, face tracking, barcode detection, barcode generation, flat image detection, +flat image recognition, flat image tracking, flat image features extraction, movement detection, +person appearance/disappearance detection and person recognition. diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs index 667dc78..8566810 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Network.Bluetooth { /// - /// This class is used to control the Bluetooth adapter and get the list of bonded devices.
+ /// This class is used to control the Bluetooth adapter and get the list of bonded devices.
/// The BluetoothAdapter class is used to discover neighbouring bluetooth devices. /// /// http://tizen.org/privilege/bluetooth diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs index 5b4a1c8..640ff7b 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs @@ -49,7 +49,7 @@ namespace Tizen.Network.Bluetooth /// /// /// The device must be bonded with the remote device by CreateBond(). If connection request succeeds, the AudioConnectionStateChanged event will be invoked. - /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp
/// and AdvancedAudioDistribution is connected. /// /// The type of the audio profile. @@ -78,7 +78,7 @@ namespace Tizen.Network.Bluetooth /// /// /// The device must be connected by Connect(). If the disconnection request succeeds, the AudioConnectionStateChanged event will be invoked. - /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp
/// and AdvancedAudioDistribution is disconnected. /// /// The type of the audio profile. diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs index 169cb16..09ae692 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs @@ -134,7 +134,7 @@ namespace Tizen.Network.Bluetooth /// The repeat mode. /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled - /// or when notifying the repeat mode state to the remote device fails. + /// or when notifying the repeat mode state to the remote device fails. /// public void NotifyRepeatMode(RepeatMode mode) { diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs index 33adb66..75c4c40 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs @@ -24,7 +24,7 @@ using System.Collections.Specialized; namespace Tizen.Network.Bluetooth { /// - /// This class is used to handle the connection with other devices and set authorization of other devices.
+ /// This class is used to handle the connection with other devices and set authorization of other devices.
/// The BluetoothDevice class is used to search for services available on remote devices. /// /// http://tizen.org/privilege/bluetooth diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs index c1a979b..df91d91 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs @@ -457,6 +457,9 @@ namespace Tizen.Network.Bluetooth } } + /// + /// The AcceptStateChanged event is raised when the socket connection state is changed. + /// public class AcceptStateChangedEventArgs : EventArgs { private BluetoothError _result; diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs index 25328d7..aa2077a 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs @@ -209,6 +209,9 @@ namespace Tizen.Network.Bluetooth return client.Isvalid() ? client : null; } + /// + /// Destroy Bluetooth GATT client + /// public void DestroyClient() { _impl.GetHandle().Dispose(); @@ -503,7 +506,7 @@ namespace Tizen.Network.Bluetooth /// /// The constructor. /// - /// The UUID of the characterstic.param> + /// The UUID of the characterstic. /// Permissions for the characterstic. /// Properties set for the characterstic. /// The value associated with the characterstic. @@ -789,6 +792,11 @@ namespace Tizen.Network.Bluetooth private EventHandler _readValueRequested; private EventHandler _writeValueRequested; + /// + /// The constructor. + /// + /// The UUID of the GATT attribute. + /// Permission for the GATT attribute. public BluetoothGattAttribute(string uuid, BluetoothGattPermission permission) { Uuid = uuid; diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs index 3034d6c..30183d2 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs @@ -165,6 +165,9 @@ namespace Tizen.Network.Bluetooth { } } + /// + /// BluetoothLeDevice destructor. + /// ~BluetoothLeDevice() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -483,6 +486,9 @@ namespace Tizen.Network.Bluetooth { } } + /// + /// BluetoothLeAdvertiseData destructor. + /// ~BluetoothLeAdvertiseData() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -558,6 +564,9 @@ namespace Tizen.Network.Bluetooth { } } + /// + /// Dispose + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs index 30d649e..4723987 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs @@ -28,6 +28,9 @@ namespace Tizen.Network.Bluetooth private static BluetoothOppServerImpl _impl; private static BluetoothOppServer _instance; + /// + /// The constructor + /// public BluetoothOppServer() { _impl = BluetoothOppServerImpl.Instance; diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs index 6be950a..c7cfad2 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs @@ -17,7 +17,7 @@ namespace Tizen.Network.Bluetooth { /// - /// This generic class represents all Bluetooth profiles.
+ /// This generic class represents all Bluetooth profiles.
/// Any common properties/functions can be added in this class in future. /// /// http://tizen.org/privilege/bluetooth diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs index e84193f..d2390f9 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs @@ -112,11 +112,17 @@ namespace Tizen.Network.Bluetooth } } + /// + /// BluetoothServerSocket distructor. + /// ~BluetoothServerSocket() { Dispose(false); } + /// + /// Dispose + /// public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs index 14cc730..c5198cb 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs @@ -25,8 +25,27 @@ namespace Tizen.Network.Bluetooth /// public interface IBluetoothServerSocket { + /// + /// Event handler to receive data over bluetooth socket. + /// This event occurs when the socket server receives data from the client. + /// event EventHandler DataReceived; + + /// + /// Event handler method to receive bluetooth socket connection state changed events. + /// This event occurs when the connection state between two devices is changed. + /// event EventHandler ConnectionStateChanged; + + /// + /// Method to send data over bluetooth socket + /// + /// The number of bytes written (zero indicates nothing was written). + /// + /// The connection must be established. + /// + /// The data to be sent. + /// int SendData(string data); } @@ -35,7 +54,14 @@ namespace Tizen.Network.Bluetooth /// public interface IBluetoothClientSocket : IBluetoothServerSocket { + /// + /// Connect client socket to server socket on remote device. + /// void Connect(); + + /// + /// Disconnect client socket from server socket. + /// void Disconnect(); } diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothStructs.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothStructs.cs index 754cba1..44475aa 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothStructs.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothStructs.cs @@ -170,7 +170,6 @@ namespace Tizen.Network.Bluetooth internal string ServiceUuid; } - /// [StructLayout(LayoutKind.Sequential)] internal struct BluetoothLeScanDataStruct { diff --git a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs b/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs deleted file mode 100755 index 6c4b38f..0000000 --- a/src/Tizen.Network.IoTConnectivity/Tizen.Network.IoTConnectivity/NamespaceDoc.cs +++ /dev/null @@ -1,12 +0,0 @@ -/** - -The Tizen.Network.IoTConnectivity namespace provides classes to manage -Resource, RemoteResource, Request, Response and so on which are based on IoTivity project. - - -The Tizen.Network.IoTConnectivity namespace provides classes to manage -Resource, RemoteResource, Request, Response and so on which are based on IoTivity project. - -*/ -namespace Tizen.Network.IoTConnectivity {} - diff --git a/src/Tizen.Network.IoTConnectivity/doc/api/Tizen.Network.IoTConnectivity.md b/src/Tizen.Network.IoTConnectivity/doc/api/Tizen.Network.IoTConnectivity.md new file mode 100755 index 0000000..7218696 --- /dev/null +++ b/src/Tizen.Network.IoTConnectivity/doc/api/Tizen.Network.IoTConnectivity.md @@ -0,0 +1,6 @@ +--- +uid: Tizen.Network.IoTConnectivity +summary: *content +--- +The Tizen.Network.IoTConnectivity namespace provides classes to manage +Resource, RemoteResource, Request, Response and so on which are based on IoTivity project. diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/NamespaceDoc.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/NamespaceDoc.cs deleted file mode 100644 index c8c3c3a..0000000 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/NamespaceDoc.cs +++ /dev/null @@ -1,44 +0,0 @@ -/** - -The Tizen.Network.Mtp namespace provides classes to manage the MTP(Media Transfer Protocol) initiator. - - - - -

Overview

- -MTP API provides functions for support PTP(Picture Transfer Protocol) subset of MTP(Media Transfer Protocol). - - - -

Manager

-Provide functions to establish connection to access MTP responder device, and to Get/Delete files. - - - -

Device

-Provide functions to gets the device information of MTP responder device. - - - -

Storage

-Provide functions to gets the storage information of MTP responder storage. - - - -

Object

-Provide functions to gets the object information of certain file in MTP responder. - - -

Related Features

- -To guarantee that if input or output path are relevant to internal and external storage, -declare the following feature requirements in the config file:
-http://tizen.org/privilege/mediastorage -http://tizen.org/privilege/externalstorage - - - -*/ - -namespace Tizen.Network.Mtp { } \ No newline at end of file diff --git a/src/Tizen.Network.Mtp/doc/api/Tizen.Network.Mtp.md b/src/Tizen.Network.Mtp/doc/api/Tizen.Network.Mtp.md new file mode 100644 index 0000000..d6cdea8 --- /dev/null +++ b/src/Tizen.Network.Mtp/doc/api/Tizen.Network.Mtp.md @@ -0,0 +1,26 @@ +--- +uid: Tizen.Network.Mtp +summary: The Tizen.Network.Mtp namespace provides classes to manage the MTP(Media Transfer Protocol) initiator. +remarks: *content +--- +## Overview +MTP API provides functions for support PTP(Picture Transfer Protocol) subset of MTP(Media Transfer Protocol). + +### Manager +Provide functions to establish connection to access MTP responder device, and to Get/Delete files. + +### Device +Provide functions to gets the device information of MTP responder device. + +### Storage +Provide functions to gets the storage information of MTP responder storage. + +### Object +Provide functions to gets the object information of certain file in MTP responder. + + +## Related Features +To guarantee that if input or output path are relevant to internal and external storage, +declare the following feature requirements in the config file: +* http://tizen.org/privilege/mediastorage +* http://tizen.org/privilege/externalstorage diff --git a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NamespaceDoc.cs b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NamespaceDoc.cs deleted file mode 100644 index e1e4b61..0000000 --- a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NamespaceDoc.cs +++ /dev/null @@ -1,30 +0,0 @@ -/** - -The Tizen.Network.Nsd namespace provides classes to manage the network service discovery protocols. - - -

Overview

-The Nsd API handles two network service discovery protocols: DNS-SD (DNS Service Discovery) and SSDP (Simple Service Discovery Protocol). They allows application to announce local services and search for remote services on a network. - -

Related Features

-To use DNS-SD, declare the following feature requirements in the config file:
-http://tizen.org/feature/network.service_discovery.dnssd - -To use SSDP, declare the following feature requirements in the config file:
-http://tizen.org/feature/network.service_discovery.ssdp - - - - - -The following example demonstrates how to register a DNS-SD local service. - -DnssdService service = new DnssdService("_http._tcp"); -service.Name = "TestService"; -service.Port = "1234"; -service.RegisterService(); - - - -*/ -namespace Tizen.Network.Nsd {} diff --git a/src/Tizen.Network.Nsd/doc/api/Tizen.Network.Nsd.md b/src/Tizen.Network.Nsd/doc/api/Tizen.Network.Nsd.md new file mode 100644 index 0000000..0676626 --- /dev/null +++ b/src/Tizen.Network.Nsd/doc/api/Tizen.Network.Nsd.md @@ -0,0 +1,25 @@ +--- +uid: Tizen.Network.Nsd +summary: The Tizen.Network.Nsd namespace provides classes to manage the network service discovery protocols. +remarks: *content +--- +## Overview +The Nsd API handles two network service discovery protocols: DNS-SD (DNS Service Discovery) and SSDP (Simple Service Discovery Protocol). They allows application to announce local services and search for remote services on a network. + + +## Example +The following example demonstrates how to register a DNS-SD local service. +```cs +DnssdService service = new DnssdService("_http._tcp"); +service.Name = "TestService"; +service.Port = "1234"; +service.RegisterService(); +``` + + +## Related Features +To use DNS-SD, declare the following feature requirements in the config file: +http://tizen.org/feature/network.service_discovery.dnssd + +To use SSDP, declare the following feature requirements in the config file: +http://tizen.org/feature/network.service_discovery.ssdp diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs deleted file mode 100644 index 9421c3b..0000000 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/NamespaceDoc.cs +++ /dev/null @@ -1,5 +0,0 @@ -/// -/// 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/src/Tizen.Network.WiFiDirect/doc/api/Tizen.Network.WiFiDirect.md b/src/Tizen.Network.WiFiDirect/doc/api/Tizen.Network.WiFiDirect.md new file mode 100644 index 0000000..56255ee --- /dev/null +++ b/src/Tizen.Network.WiFiDirect/doc/api/Tizen.Network.WiFiDirect.md @@ -0,0 +1,6 @@ +--- +uid: Tizen.Network.WiFiDirect +summary: *content +--- +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. diff --git a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs b/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs deleted file mode 100644 index e5845ac..0000000 --- a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/NamespaceDoc.cs +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace Tizen.PhonenumberUtils -{ - /// - /// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers. - /// - /// - /// The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers. - /// - /// 4 -} diff --git a/src/Tizen.PhonenumberUtils/doc/api/Tizen.PhonenumberUtils.md b/src/Tizen.PhonenumberUtils/doc/api/Tizen.PhonenumberUtils.md new file mode 100644 index 0000000..e5a51de --- /dev/null +++ b/src/Tizen.PhonenumberUtils/doc/api/Tizen.PhonenumberUtils.md @@ -0,0 +1,19 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.PhonenumberUtils +summary: The Tizen.PhonenumberUtils namespace provides a class for parsing, formatting and normalizing phone numbers. +sinceTizen: 4 +--- diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/NamespaceDoc.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/NamespaceDoc.cs deleted file mode 100644 index 1e072ca..0000000 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/NamespaceDoc.cs +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace Tizen.Pims.Calendar -{ - /// - /// The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule. - /// - /// - /// The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule. - /// - /// 4 -} - diff --git a/src/Tizen.Pims.Calendar/doc/api/Tizen.Pims.Calendar.md b/src/Tizen.Pims.Calendar/doc/api/Tizen.Pims.Calendar.md new file mode 100644 index 0000000..3c19ec6 --- /dev/null +++ b/src/Tizen.Pims.Calendar/doc/api/Tizen.Pims.Calendar.md @@ -0,0 +1,19 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Pims.Calendar +summary: The Tizen.Pims.Calendar namespace provides classes for managing calendar information for schedule. +sinceTizen: 4 +--- diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NamespaceDoc.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NamespaceDoc.cs deleted file mode 100644 index 66a19b7..0000000 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/NamespaceDoc.cs +++ /dev/null @@ -1,26 +0,0 @@ -/* - * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved - * - * Licensed under the Apache License, Version 2.0 (the License); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an AS IS BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ - -namespace Tizen.Pims.Contacts -{ - /// - /// The Tizen.Pims.Contacts namespace provides classes for managing contact information for people. - /// - /// - /// The Tizen.Pims.Contacts namespace provides classes for managing contact information for people. - /// - /// 4 -} \ No newline at end of file diff --git a/src/Tizen.Pims.Contacts/doc/api/Tizen.Pims.Contacts.md b/src/Tizen.Pims.Contacts/doc/api/Tizen.Pims.Contacts.md new file mode 100644 index 0000000..3c5c40b --- /dev/null +++ b/src/Tizen.Pims.Contacts/doc/api/Tizen.Pims.Contacts.md @@ -0,0 +1,19 @@ +--- +# Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved +# +# Licensed under the Apache License, Version 2.0 (the License); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an AS IS BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +uid: Tizen.Pims.Contacts +summary: The Tizen.Pims.Contacts namespace provides classes for managing contact information for people. +sinceTizen: 4 +--- diff --git a/src/Tizen.Security.SecureRepository/NamespaceDoc.cs b/src/Tizen.Security.SecureRepository/NamespaceDoc.cs deleted file mode 100644 index c14b195..0000000 --- a/src/Tizen.Security.SecureRepository/NamespaceDoc.cs +++ /dev/null @@ -1,41 +0,0 @@ -/** - -Secure Repository function is provided by key-manager module in Tizen. The key manager provides a secure repository for keys, certificates, and sensitive data related to users and their password-protected APPs. Additionally, it provides secure cryptographic operations for non-exportable keys without revealing the key values to clients. - - - -

Overview

- -Secure Repository stores keys, certificates, and sensitive user data in a central secure repository. The central secure repository is protected by a password. - - - -Data Store Policy -A client can specify simple access rules when storing data in the key manager: - Extractable or non-extractable - - Only for data tagged as extractable, the key manager returns the raw value of the data. - - If data is tagged as non-extractable, the key manager does not return its raw value. In that case, the key manager provides secure cryptographic operations for non-exportable keys without revealing the key values to the clients. - Per key password - - All data in the key manager is protected by a user password. - - A client can encrypt its data using their own password additionally. - - If a client provides a password when storing data, the data is encrypted with the password. This password must be provided when getting the data from the key manager. - - - -Data Access Control - By default, only the owner of a data can access to the data. - If the owner grants the access to other applications, those applications can read or delete the data from key-manager DB. - When an application is deleted, the data and access control information granted by the application are also removed. - - - -Alias Format - The format of alias is "package_id name" and the name should not contain any white space characters. - If package_id is not provided by a client, the key-manager will add the package_id of the client to the name internally. - The client can specify only its own pacakge id in the alias when storing a key, certificate, or data. - A client should specify the pacakge id of the owner in the alias to retrieve a a key, certificate, or data shared by other applications. - Aliases are returned from the key-manager as the format of package_id name. - - -*/ -namespace Tizen.Security.SecureRepository {} diff --git a/src/Tizen.Security.SecureRepository/doc/api/Tizen.Security.SecureRepository.md b/src/Tizen.Security.SecureRepository/doc/api/Tizen.Security.SecureRepository.md new file mode 100644 index 0000000..050f8fd --- /dev/null +++ b/src/Tizen.Security.SecureRepository/doc/api/Tizen.Security.SecureRepository.md @@ -0,0 +1,30 @@ +--- +uid: Tizen.Security.SecureRepository +summary: Secure Repository function is provided by key-manager module in Tizen. The key manager provides a secure repository for keys, certificates, and sensitive data related to users and their password-protected APPs. Additionally, it provides secure cryptographic operations for non-exportable keys without revealing the key values to clients. +remarks: *content +--- +## Overview +Secure Repository stores keys, certificates, and sensitive user data in a central secure repository. The central secure repository is protected by a password. + +### Data Store Policy +A client can specify simple access rules when storing data in the key manager: + +* Extractable or non-extractable + - Only for data tagged as extractable, the key manager returns the raw value of the data. + - If data is tagged as non-extractable, the key manager does not return its raw value. In that case, the key manager provides secure cryptographic operations for non-exportable keys without revealing the key values to the clients. +* Per key password + - All data in the key manager is protected by a user password. + - A client can encrypt its data using their own password additionally. + - If a client provides a password when storing data, the data is encrypted with the password. This password must be provided when getting the data from the key manager. + +### Data Access Control + - By default, only the owner of a data can access to the data. + - If the owner grants the access to other applications, those applications can read or delete the data from key-manager DB. + - When an application is deleted, the data and access control information granted by the application are also removed. + +### Alias Format + - The format of alias is "package_id name" and the name should not contain any white space characters. + - If package_id is not provided by a client, the key-manager will add the package_id of the client to the name internally. + - The client can specify only its own pacakge id in the alias when storing a key, certificate, or data. + - A client should specify the pacakge id of the owner in the alias to retrieve a a key, certificate, or data shared by other applications. + - Aliases are returned from the key-manager as the format of package_id name. diff --git a/src/Tizen.Security.TEEC/Tizen.Security.TEEC/NamespaceDoc.cs b/src/Tizen.Security.TEEC/doc/api/Tizen.Security.TEEC.md similarity index 66% rename from src/Tizen.Security.TEEC/Tizen.Security.TEEC/NamespaceDoc.cs rename to src/Tizen.Security.TEEC/doc/api/Tizen.Security.TEEC.md index 4edd144..f6da610 100644 --- a/src/Tizen.Security.TEEC/Tizen.Security.TEEC/NamespaceDoc.cs +++ b/src/Tizen.Security.TEEC/doc/api/Tizen.Security.TEEC.md @@ -1,12 +1,10 @@ -/** - -The communication API for connecting Client Applications running in a rich operating environment -with security related Trusted Applications running inside a Trusted Execution Environment (TEE). - - - -

Overview

- +--- +uid: Tizen.Security.TEEC +summary: The communication API for connecting Client Applications running in a rich operating environment + with security related Trusted Applications running inside a Trusted Execution Environment (TEE). +remarks: *content +--- +## Overview A TEE provides an execution environment with security capabilities, which are either available to Trusted Applications running inside the TEE or exposed externally to Client Applications. The TEE Client API concentrates on the interface to enable efficient communications between @@ -15,64 +13,41 @@ Higher level standards and protocol layers may be built on top of the foundation provided by the TEE Client API – for example, to cover common tasks, such as secure storage, cryptography, and run-time installation of new Trusted Applications. The separation between the rich environment and the TEE is guaranted. - - + The key design principles of the TEE Client API are: - - - Client-side memory allocations - + * Client-side memory allocations Where possible the design of the TEE Client API has placed the responsibility for memory allocation on the calling Client Application code. This gives the Client developer choice of memory allocation locations, enabling simple optimizations, such as stack-based allocation - or enhanced flexibility using placements in static global memory or thread-local storage.
+ or enhanced flexibility using placements in static global memory or thread-local storage. + This design choice is evident in the API by the use of pointers to structures rather than opaque handles to represent any manipulated objects. - - - - Aim for zero-copy data transfer - + * Aim for zero-copy data transfer The features of the TEE Client API are chosen to maximize the possibility of zero-copy - data transfer between the Client Application and the Trusted Application.
+ data transfer between the Client Application and the Trusted Application. However, short messages can also be passed by copy, which avoids the overhead of sharing memory. - - - - Support memory sharing by pointers - + * Support memory sharing by pointers The TEE Client API will be used to implement higher-level APIs, such as cryptography or secure storage, where the caller will often provide memory buffers for input or output data using simple C pointers. The TEE Client API must allow efficient sharing of this type of memory, and as such does not rely on the Client Application being able to use bulk memory buffers allocated by the TEE Client API. - - - - Specify only communication mechanisms - + * Specify only communication mechanisms This API focuses on defining the underlying communications channel. It does not define the format of the messages which pass over the channel, or the protocols used by specific Trusted Applications. - - - - - - - +## Example The following example demonstrates how to invoke command on Trused Application. - - Guid ta_uuid = new Guid("TA-guid-put-here"); - Context ctx = new Context(null); - Session ses = ctx.OpenSession(ta_uuid); - Parameter[] p = { new Value(1,2,TEFValueType.In) }; - ses.InvokeCommand(1, p); - ses.Close(); - ctx.Dispose(); - - -*/ -namespace Tizen.Security.TEEC {} + +```cs +Guid ta_uuid = new Guid("TA-guid-put-here"); +Context ctx = new Context(null); +Session ses = ctx.OpenSession(ta_uuid); +Parameter[] p = { new Value(1,2,TEFValueType.In) }; +ses.InvokeCommand(1, p); +ses.Close(); +ctx.Dispose(); +``` diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs index 061557d..7ada88d 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs @@ -23,15 +23,39 @@ namespace Tizen.Sensor /// public abstract class ActivityDetector : Sensor { - protected const int ActivityAttribute = (((int)SensorType.InVehicleActivityDetector << 8) | 0x80 | 0x1); + /// + /// Attribute key for a activity detector. + /// + protected const int ActivityAttribute = (((int)SensorType.StationaryActivityDetector << 8) | 0x80 | 0x1); + /// + /// Activity types. + /// protected enum ActivityType { + /// + /// Unknown. + /// Unknown = 1, + /// + /// Stationary. + /// Stationary = 2, + /// + /// Walking. + /// Walking = 4, + /// + /// Running. + /// Running = 8, + /// + /// In vehicle. + /// InVehicle = 16, + /// + /// On bicycle. + /// OnBicycle = 32, }; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs index 9d2d8f8..7ed55e5 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs @@ -67,7 +67,7 @@ namespace Tizen.Sensor /// http://tizen.org/feature/sensor.proximity /// Thrown when an invalid argument is used. /// Thrown when the sensor is not supported. - /// Thrown when the operation is invalid for the current state.exception> + /// Thrown when the operation is invalid for the current state. /// /// Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors. /// diff --git a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs index 2210fd3..e514f3e 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs @@ -61,6 +61,9 @@ namespace Tizen.Sensor } } + /// + /// Destroy the Sensor object. + /// ~Sensor() { Dispose(false); @@ -351,12 +354,22 @@ namespace Tizen.Sensor } } + /// + /// Destroy the current object. + /// public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } + /// + /// Releases all resources currently used by this instance. + /// + /// + /// true if managed resources should be disposed + /// otherwise, false. + /// protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs index dc1c7d1..de65873 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/SensorEnumerations.cs @@ -108,6 +108,10 @@ namespace Tizen.Sensor /// SleepMonitor = 0x301, /// + /// Stationary activity detector. + /// + StationaryActivityDetector = 0x1A00, + /// /// Walking activity detector. /// WalkingActivityDetector = 0x1A00, @@ -116,10 +120,6 @@ namespace Tizen.Sensor /// RunningActivityDetector = 0x1A00, /// - /// Stationary activity detector. - /// - StationaryActivityDetector = 0x1A00, - /// /// InVehicle activity detector. /// InVehicleActivityDetector = 0x1A00, diff --git a/src/Tizen.Tapi/Tizen.Tapi/CallData.cs b/src/Tizen.Tapi/Tizen.Tapi/CallData.cs index a47b120..0ce86ec 100755 --- a/src/Tizen.Tapi/Tizen.Tapi/CallData.cs +++ b/src/Tizen.Tapi/Tizen.Tapi/CallData.cs @@ -909,6 +909,9 @@ namespace Tizen.Tapi _status = status; } + /// + /// Gets the sound mute path. + /// public SoundMutePath Path { get @@ -917,6 +920,9 @@ namespace Tizen.Tapi } } + /// + /// Gets the sound mute status. + /// public SoundMuteStatus Status { get diff --git a/src/Tizen.Tapi/Tizen.Tapi/SsEnumerations.cs b/src/Tizen.Tapi/Tizen.Tapi/SsEnumerations.cs index 9d9e4ac..0403fce 100755 --- a/src/Tizen.Tapi/Tizen.Tapi/SsEnumerations.cs +++ b/src/Tizen.Tapi/Tizen.Tapi/SsEnumerations.cs @@ -399,7 +399,7 @@ namespace Tizen.Tapi public enum SsStatus { /// - /// Provisioned & registered (but not active/active-quiescent). + /// Provisioned and registered (but not active/active-quiescent). /// Registered = 0x01, /// @@ -407,11 +407,11 @@ namespace Tizen.Tapi /// Provisioned, /// - /// Provisioned & registered & active. + /// Provisioned and registered and active. /// Active, /// - /// Provisioned & registered & active but quiescent. + /// Provisioned and registered and active but quiescent. /// Quiescent, /// diff --git a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs index 07454ed..8165700 100644 --- a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs +++ b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs @@ -20,6 +20,10 @@ using System.Text; namespace Tizen.WebView { + /// + /// The callback function that is invoked when the message is received from the script. + /// + /// The JavaScriptMessage returned by the script public delegate void JavaScriptMessageHandler(JavaScriptMessage message); /// diff --git a/src/Tizen.WebView/Tizen.WebView/WebView.cs b/src/Tizen.WebView/Tizen.WebView/WebView.cs index 3b30cd8..71d93f2 100644 --- a/src/Tizen.WebView/Tizen.WebView/WebView.cs +++ b/src/Tizen.WebView/Tizen.WebView/WebView.cs @@ -303,6 +303,11 @@ namespace Tizen.WebView Interop.ChromiumEwk.ewk_view_focus_set(_realHandle, focused); } + /// + /// Creates a widget handle. + /// + /// Parent EvasObject + /// IntPtr of the widget handle protected override IntPtr CreateHandle(EvasObject parent) { // focus dummy -- 2.7.4