From: DotnetBuild Date: Wed, 30 Aug 2017 15:00:16 +0000 (+0900) Subject: Release 4.0.0-preview1-00138 X-Git-Tag: accepted/tizen/unified/20170901.030006~1 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e0128bb3498f96d291e94162cc540b847e957ce2;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Release 4.0.0-preview1-00138 --- diff --git a/Artifacts/Tizen.NET.4.0.0-preview1-00134.nupkg b/Artifacts/Tizen.NET.4.0.0-preview1-00134.nupkg deleted file mode 100644 index bc5a182..0000000 Binary files a/Artifacts/Tizen.NET.4.0.0-preview1-00134.nupkg and /dev/null differ diff --git a/Artifacts/Tizen.NET.4.0.0-preview1-00134.symbols.nupkg b/Artifacts/Tizen.NET.4.0.0-preview1-00134.symbols.nupkg deleted file mode 100644 index ccfcff7..0000000 Binary files a/Artifacts/Tizen.NET.4.0.0-preview1-00134.symbols.nupkg and /dev/null differ diff --git a/Artifacts/Tizen.NET.4.0.0-preview1-00138.nupkg b/Artifacts/Tizen.NET.4.0.0-preview1-00138.nupkg new file mode 100644 index 0000000..75dac7d Binary files /dev/null and b/Artifacts/Tizen.NET.4.0.0-preview1-00138.nupkg differ diff --git a/Artifacts/Tizen.NET.4.0.0-preview1-00138.symbols.nupkg b/Artifacts/Tizen.NET.4.0.0-preview1-00138.symbols.nupkg new file mode 100644 index 0000000..e4c2d39 Binary files /dev/null and b/Artifacts/Tizen.NET.4.0.0-preview1-00138.symbols.nupkg differ diff --git a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.nupkg b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.nupkg deleted file mode 100644 index b3ecd2d..0000000 Binary files a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.nupkg and /dev/null differ diff --git a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.symbols.nupkg b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.symbols.nupkg deleted file mode 100644 index 913650d..0000000 Binary files a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00134.symbols.nupkg and /dev/null differ diff --git a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.nupkg b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.nupkg new file mode 100644 index 0000000..f69db6c Binary files /dev/null and b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.nupkg differ diff --git a/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.symbols.nupkg b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.symbols.nupkg new file mode 100644 index 0000000..35b5818 Binary files /dev/null and b/Artifacts/Tizen.NET.Private.4.0.0-preview1-00138.symbols.nupkg differ diff --git a/Artifacts/Version.txt b/Artifacts/Version.txt index d7bc5c0..367dc44 100644 --- a/Artifacts/Version.txt +++ b/Artifacts/Version.txt @@ -1,4 +1,4 @@ -Prefix:4.0.0 -Suffix:preview1-00134 -Number:134 -VCS:7210769dfdd2efb2866f15bcbc656a097f0f1a74 +Prefix:4.0.0 +Suffix:preview1-00138 +Number:138 +VCS:322b9b5f73c1deba9c3476d2806a0fbb64fe149c diff --git a/Artifacts/bin/ElmSharp.Wearable.dll b/Artifacts/bin/ElmSharp.Wearable.dll index 204abfd..e4d6c14 100644 Binary files a/Artifacts/bin/ElmSharp.Wearable.dll and b/Artifacts/bin/ElmSharp.Wearable.dll differ diff --git a/Artifacts/bin/ElmSharp.Wearable.pdb b/Artifacts/bin/ElmSharp.Wearable.pdb index 9ce1b81..4441cf1 100644 Binary files a/Artifacts/bin/ElmSharp.Wearable.pdb and b/Artifacts/bin/ElmSharp.Wearable.pdb differ diff --git a/Artifacts/bin/ElmSharp.Wearable.xml b/Artifacts/bin/ElmSharp.Wearable.xml index 8fa7d29..d6b90da 100644 --- a/Artifacts/bin/ElmSharp.Wearable.xml +++ b/Artifacts/bin/ElmSharp.Wearable.xml @@ -1,759 +1,764 @@ - - - - ElmSharp.Wearable - - - - - The Circle DateTime Selector is a widget to display and handle datetime value by rotary event - Inherits - - - - - Creates and initializes a new instance of the Circle DateTime class - - The parent of new Circle DateTime instance - - - - Sets or gets the disabled state of the Circle DateTime Selector - - - - - Sets or gets the color of the marker - - - - - Sets or gets the line width of the marker - - - - - Sets or gets the radius at which the center of the marker lies - - - - - The Circle GenList Selector is a widget to display and handle genlist items by rotary event - Inherits - - - - - Creates and initializes a new instance of the Circle GenList class - - The parent of new Circle GenList instance - - - - Sets or gets the disabled state of the Circle GenList Selector - - - - - Sets or gets the color of the scroll background - - - - - Sets or gets the line width of the scroll background - - - - - Sets or gets the redius of the scroll background - - - - - Sets or gets the color of the scroll bar - - - - - Sets or gets the line width of the scroll bar - - - - - Sets or gets the redius of the scroll bar - - - - - Sets or gets the policy if the scroll bar is visible - - - ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - The Circle ProgressBar is a widget for visually representing the progress status of a given job/task with the circular design. - - - - - Creates and initializes a new instance of the Circle Progressbar class. - - The parent of new Circle Progressbar instance - - - - Sets or gets the value of ProgressBar. - - - - - Sets or gets the maximum value of ProgressBar. - - - - - Sets or gets the minimum value of ProgressBar. - - - - - Sets or gets the angle value of ProgressBar. - - - - - Sets or gets the angle value of Background ProgressBar. - - - - - Sets or gets the angle offset value of ProgressBar. - - - - - Sets or gets the angle offset value of Background ProgressBar. - - - - - Sets or gets the maximum angle value of ProgressBar. - - - - - Sets or gets the minimum angle value of ProgressBar. - - - - - Sets or gets disable status of Circle ProgressBar. - - - - - Sets or gets color of ProgressBar. - - - - - Sets or gets color of Background ProgressBar. - - - - - Sets or gets line width of ProgressBar. - - - - - Sets or gets line width of Background ProgressBar. - - - - - Sets or gets radius of ProgressBar. - - - - - Sets or gets radius of Background ProgressBar. - - - - - Circle scroller provides scrollbar with circular movement and is scrolled by rotary event. - - - - - Creates and initializes a new instance of the CircleScroller class. - - The to which the new CircleScroller will be attached as a child. - - - - Sets or gets disabled state of the circle scroller object. - - - - - Sets or gets the value of HorizontalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Sets or gets the value of VerticalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Sets or gets color of the vertical scroll bar. - - - - - Sets or gets color of the horizontal scroll bar. - - - - - Sets or gets color of the vertical scroll background. - - - - - Sets or gets color of the horizontal scroll background. - - - - - Sets or gets line width of the vertical scroll bar. - - - - - Sets or gets line width of the horizontal scroll bar. - - - - - Sets or gets line width of the vertical scroll background. - - - - - Sets or gets line width of the horizontal scroll background. - - - - - Sets or gets radius of the vertical scroll bar. - - - - - Sets or gets radius of the horizontal scroll bar. - - - - - Sets or gets radius of the vertical scroll background. - - - - - Sets or gets radius of the horizontal scroll background. - - - - - Circle slider is circular designed widget to select a value in a range by rotary event. - - - - - Creates and initializes a new instance of the CircleSlider class. - - The EvasObject to which the new CircleSlider will be attached as a child. - - - - Sets or gets the step by which the circle slider bar moves. - - - This value is used when circle slider value is changed by an drag or rotary event - The value of the slider is increased/decreased by the step value. - - - - - Sets or gets disabled state of the circle slider object. - - - - - Sets or gets color of the circle slider bar. - - - - - Sets or gets color of the circle slider background. - - - - - Sets or gets the line with of the circle slider bar. - - - - - Sets or gets the line with of the circle slider background. - - - - - Sets or gets the angle in degree of the circle slider bar. - - - - - Sets or gets the angle in degree of the circle slider background. - - - - - Sets or gets the angle offset for the slider bar. - offset value means start position of the slider bar. - - - - - Sets or gets the angle offset for the circle slider background. - offset value means start position of the slider background. - - - - - Sets or gets the minimum angle of the circle slider bar. - - - - - Sets or gets the maximum angle of the circle slider bar. - - - - - Sets or gets the minimum values for the circle slider. - - - This defines the allowed minimum values to be selected by the user. - If the actual value is less than min, it is updated to min. - Actual value can be obtained with Value.By default, min is equal to 0.0. - - - - - Sets or gets the maximum values for the circle slider. - - - This defines the allowed maximum values to be selected by the user. - If the actual value is bigger then max, it is updated to max. - Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. - Maximum must be greater than minimum, otherwise the behavior is undefined. - - - - - Gets or sets the value displayed by the circle slider. - - - The value must to be between Minimum and Maximum values. - - - - - Gets or sets the radius value for the circle slider bar. - - - - - Gets or sets the radius value for the circle slider background. - - - - - The Circle Spinner is a widget to display and handle spinner value by rotary event - Inherits . - - - - - Creates and initializes a new instance of the Circle Spinner class. - - The parent of new Circle Spinner instance - - - - Sets or gets the circle spinner angle per each spinner value. - - - - - Sets or gets disabled state of the circle spinner object. - - - - - Sets or gets the line width of the marker - - - - - Sets or gets the color of the marker - - - - - Sets or gets the radius at which the center of the marker lies - - - - - The MoreOption is a widget composed of the toggle(cue button) and more option view, and MoreOption can change a visibility through the toggle. - Inherits Layout - - - - - Sets or gets the list of more option item - - - - - Selected will be triggered when the user selects an item. - - - - - Clicked will be triggered when the user selects the already selected item again or selects a selector. - - - - - Opened will be triggered when more option view is shown. - - - - - Closed will be triggered when more option view is hidden. - - - - - Creates and initializes a new instance of MoreOption class. - - The parent is a given container which will be attached by MoreOption as a child. It's type. - - - - Sets or gets the direction of more option. - - - - - Sets or gets the visibility of more option view. - - - - - Enumeration for More Option Direction type. - - - - - The MoreOptionItem is a item of MoreOption widget. - - - - - Sets or gets the more option item handle. - - - - - Set the icon to null - - - - - Sets or gets the main text of a more option object. - - - - - Sets or gets the sub text of a more option object. - - - - - Sets or gets the icon image - - - - - The MoreOptionItemEventArgs is a event args class for MoreOptionItem. - Inherits EventArgs - - - - - Sets or gets the more option item - - - - - Sets or gets the count of Items - - - - - Sets or gets whether it is read only - - - - - Sets or gets the item with the index - - the position of item in items - - - - - Creates and initializes a new instance of MoreOptionList class. - - the object of more option - - - - Append a new item to a more option. - - The more option item - - - - add a new item to a more option at the first. - - The more option item - - - - add a new item to a more option at the last. - - The more option item - - - - Get the index of item - - The more option item - the index of item - - - - Insert a new item into the more option after more option item with the index. - - the index of item which is insert after - The more option item - - - - Delete an item which is the given item index - - the item index which will be deleted - - - - Remove all items from a given more option list object. - - - - - Check the item whether is contained - - The more option item - If contain return true, otherwise false - - - - Copy Items - - the target array - which index the item will copy to - - - - Remove a item - - the item will be removed - if remove success return true, otherwise false - - - - - The Rotary Selector is a widget to display a selector and multiple items surrounding the selector. - And an item can be selected by rotary event or user item click. - Inherits . - - - - - Selected will be triggered when selected an item. - - - - - Clicked will be triggered when selecting again the alredy selected item or selecting a selector. - - - - - Gets the rotary selector item list of a rotary selector object. - - - - - Creates and initializes a new instance of the Rotary Selector class. - - The parent of new Rotary Selector instance - - - - Sets or gets the selected item of a rotary selector object. - - - - - Sets or gets the background image of a rotary selector object. - - - - - A instance to the Rotary Selector Item added. And an item can be selected by rotary event or user item click. - - - - - Sets or gets the handle of a rotary selector item object. - - - - - Sets or gets the main text of a rotary selector item object. - - - - - Sets or gets the sub text of a rotary selector item object. - - - - - Sets or gets the sub text color of a rotary selector item object. - - - - - Sets or gets the sub text color of a rotary selector item object. - - - - - Sets or gets the normal icon image of a rotary selector item object. - - - - - Sets or gets the press icon image of a rotary selector item object. - - - - - Sets or gets the disable icon image of a rotary selector item object. - - - - - Sets or gets the selected icon image of a rotary selector item object. - - - - - Sets or gets the normal background image of a rotary selector item object. - - - - - Sets or gets the pressed background image of a rotary selector item object. - - - - - Sets or gets the disabled background image of a rotary selector item object. - - - - - Sets or gets the selected background image of a rotary selector item object. - - - - - Sets or gets the normal background color of a rotary selector item object. - - - - - Sets or gets the pressed background color of a rotary selector item object. - - - - - Sets or gets the disabled background color of a rotary selector item object. - - - - - Sets or gets the selected background color of a rotary selector item object. - - - - - Sets or gets the selector icon image of a rotary selector item object. - - - - - and events of RotarySelector contain RotarySelectorItemEventArgs as a parameter. - Inherits . - - - - - Sets or gets the rotary selector item. - - - - + + + + ElmSharp.Wearable + + + + + The Circle DateTime Selector is a widget to display and handle datetime value by rotary event + Inherits + + + + + Creates and initializes a new instance of the Circle DateTime class + + The parent of new Circle DateTime instance + + + + Sets or gets the disabled state of the Circle DateTime Selector + + + + + Sets or gets the color of the marker + + + + + Sets or gets the line width of the marker + + + + + Sets or gets the radius at which the center of the marker lies + + + + + The Circle GenList Selector is a widget to display and handle genlist items by rotary event + Inherits + + + + + Creates and initializes a new instance of the Circle GenList class + + The parent of new Circle GenList instance + + + + Sets or gets the disabled state of the Circle GenList Selector + + + + + Sets or gets the color of the scroll background + + + + + Sets or gets the line width of the scroll background + + + + + Sets or gets the redius of the scroll background + + + + + Sets or gets the color of the scroll bar + + + + + Sets or gets the line width of the scroll bar + + + + + Sets or gets the redius of the scroll bar + + + + + Sets or gets the policy if the scroll bar is visible + + + ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + The Circle ProgressBar is a widget for visually representing the progress status of a given job/task with the circular design. + + + + + Creates and initializes a new instance of the Circle Progressbar class. + + The parent of new Circle Progressbar instance + + + + Sets or gets the value of ProgressBar. + + + + + Sets or gets the maximum value of ProgressBar. + + + + + Sets or gets the minimum value of ProgressBar. + + + + + Sets or gets the angle value of ProgressBar. + + + + + Sets or gets the angle value of Background ProgressBar. + + + + + Sets or gets the angle offset value of ProgressBar. + + + + + Sets or gets the angle offset value of Background ProgressBar. + + + + + Sets or gets the maximum angle value of ProgressBar. + + + + + Sets or gets the minimum angle value of ProgressBar. + + + + + Sets or gets disable status of Circle ProgressBar. + + + + + Sets or gets color of ProgressBar. + + + + + Sets or gets color of Background ProgressBar. + + + + + Sets or gets line width of ProgressBar. + + + + + Sets or gets line width of Background ProgressBar. + + + + + Sets or gets radius of ProgressBar. + + + + + Sets or gets radius of Background ProgressBar. + + + + + Circle scroller provides scrollbar with circular movement and is scrolled by rotary event. + + + + + Creates and initializes a new instance of the CircleScroller class. + + The to which the new CircleScroller will be attached as a child. + + + + Sets or gets disabled state of the circle scroller object. + + + + + Sets or gets the value of HorizontalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Sets or gets the value of VerticalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Sets or gets color of the vertical scroll bar. + + + + + Sets or gets color of the horizontal scroll bar. + + + + + Sets or gets color of the vertical scroll background. + + + + + Sets or gets color of the horizontal scroll background. + + + + + Sets or gets line width of the vertical scroll bar. + + + + + Sets or gets line width of the horizontal scroll bar. + + + + + Sets or gets line width of the vertical scroll background. + + + + + Sets or gets line width of the horizontal scroll background. + + + + + Sets or gets radius of the vertical scroll bar. + + + + + Sets or gets radius of the horizontal scroll bar. + + + + + Sets or gets radius of the vertical scroll background. + + + + + Sets or gets radius of the horizontal scroll background. + + + + + Circle slider is circular designed widget to select a value in a range by rotary event. + + + + + Changed will be triggered when the circle slider value changes. + + + + + Creates and initializes a new instance of the CircleSlider class. + + The EvasObject to which the new CircleSlider will be attached as a child. + + + + Sets or gets the step by which the circle slider bar moves. + + + This value is used when circle slider value is changed by an drag or rotary event + The value of the slider is increased/decreased by the step value. + + + + + Sets or gets disabled state of the circle slider object. + + + + + Sets or gets color of the circle slider bar. + + + + + Sets or gets color of the circle slider background. + + + + + Sets or gets the line with of the circle slider bar. + + + + + Sets or gets the line with of the circle slider background. + + + + + Sets or gets the angle in degree of the circle slider bar. + + + + + Sets or gets the angle in degree of the circle slider background. + + + + + Sets or gets the angle offset for the slider bar. + offset value means start position of the slider bar. + + + + + Sets or gets the angle offset for the circle slider background. + offset value means start position of the slider background. + + + + + Sets or gets the minimum angle of the circle slider bar. + + + + + Sets or gets the maximum angle of the circle slider bar. + + + + + Sets or gets the minimum values for the circle slider. + + + This defines the allowed minimum values to be selected by the user. + If the actual value is less than min, it is updated to min. + Actual value can be obtained with Value.By default, min is equal to 0.0. + + + + + Sets or gets the maximum values for the circle slider. + + + This defines the allowed maximum values to be selected by the user. + If the actual value is bigger then max, it is updated to max. + Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. + Maximum must be greater than minimum, otherwise the behavior is undefined. + + + + + Gets or sets the value displayed by the circle slider. + + + The value must to be between Minimum and Maximum values. + + + + + Gets or sets the radius value for the circle slider bar. + + + + + Gets or sets the radius value for the circle slider background. + + + + + The Circle Spinner is a widget to display and handle spinner value by rotary event + Inherits . + + + + + Creates and initializes a new instance of the Circle Spinner class. + + The parent of new Circle Spinner instance + + + + Sets or gets the circle spinner angle per each spinner value. + + + + + Sets or gets disabled state of the circle spinner object. + + + + + Sets or gets the line width of the marker + + + + + Sets or gets the color of the marker + + + + + Sets or gets the radius at which the center of the marker lies + + + + + The MoreOption is a widget composed of the toggle(cue button) and more option view, and MoreOption can change a visibility through the toggle. + Inherits Layout + + + + + Sets or gets the list of more option item + + + + + Selected will be triggered when the user selects an item. + + + + + Clicked will be triggered when the user selects the already selected item again or selects a selector. + + + + + Opened will be triggered when more option view is shown. + + + + + Closed will be triggered when more option view is hidden. + + + + + Creates and initializes a new instance of MoreOption class. + + The parent is a given container which will be attached by MoreOption as a child. It's type. + + + + Sets or gets the direction of more option. + + + + + Sets or gets the visibility of more option view. + + + + + Enumeration for More Option Direction type. + + + + + The MoreOptionItem is a item of MoreOption widget. + + + + + Sets or gets the more option item handle. + + + + + Set the icon to null + + + + + Sets or gets the main text of a more option object. + + + + + Sets or gets the sub text of a more option object. + + + + + Sets or gets the icon image + + + + + The MoreOptionItemEventArgs is a event args class for MoreOptionItem. + Inherits EventArgs + + + + + Sets or gets the more option item + + + + + Sets or gets the count of Items + + + + + Sets or gets whether it is read only + + + + + Sets or gets the item with the index + + the position of item in items + + + + + Creates and initializes a new instance of MoreOptionList class. + + the object of more option + + + + Append a new item to a more option. + + The more option item + + + + add a new item to a more option at the first. + + The more option item + + + + add a new item to a more option at the last. + + The more option item + + + + Get the index of item + + The more option item + the index of item + + + + Insert a new item into the more option after more option item with the index. + + the index of item which is insert after + The more option item + + + + Delete an item which is the given item index + + the item index which will be deleted + + + + Remove all items from a given more option list object. + + + + + Check the item whether is contained + + The more option item + If contain return true, otherwise false + + + + Copy Items + + the target array + which index the item will copy to + + + + Remove a item + + the item will be removed + if remove success return true, otherwise false + + + + + The Rotary Selector is a widget to display a selector and multiple items surrounding the selector. + And an item can be selected by rotary event or user item click. + Inherits . + + + + + Selected will be triggered when selected an item. + + + + + Clicked will be triggered when selecting again the alredy selected item or selecting a selector. + + + + + Gets the rotary selector item list of a rotary selector object. + + + + + Creates and initializes a new instance of the Rotary Selector class. + + The parent of new Rotary Selector instance + + + + Sets or gets the selected item of a rotary selector object. + + + + + Sets or gets the background image of a rotary selector object. + + + + + A instance to the Rotary Selector Item added. And an item can be selected by rotary event or user item click. + + + + + Sets or gets the handle of a rotary selector item object. + + + + + Sets or gets the main text of a rotary selector item object. + + + + + Sets or gets the sub text of a rotary selector item object. + + + + + Sets or gets the sub text color of a rotary selector item object. + + + + + Sets or gets the sub text color of a rotary selector item object. + + + + + Sets or gets the normal icon image of a rotary selector item object. + + + + + Sets or gets the press icon image of a rotary selector item object. + + + + + Sets or gets the disable icon image of a rotary selector item object. + + + + + Sets or gets the selected icon image of a rotary selector item object. + + + + + Sets or gets the normal background image of a rotary selector item object. + + + + + Sets or gets the pressed background image of a rotary selector item object. + + + + + Sets or gets the disabled background image of a rotary selector item object. + + + + + Sets or gets the selected background image of a rotary selector item object. + + + + + Sets or gets the normal background color of a rotary selector item object. + + + + + Sets or gets the pressed background color of a rotary selector item object. + + + + + Sets or gets the disabled background color of a rotary selector item object. + + + + + Sets or gets the selected background color of a rotary selector item object. + + + + + Sets or gets the selector icon image of a rotary selector item object. + + + + + and events of RotarySelector contain RotarySelectorItemEventArgs as a parameter. + Inherits . + + + + + Sets or gets the rotary selector item. + + + + diff --git a/Artifacts/bin/ElmSharp.dll b/Artifacts/bin/ElmSharp.dll index bbfeb42..32228fa 100644 Binary files a/Artifacts/bin/ElmSharp.dll and b/Artifacts/bin/ElmSharp.dll differ diff --git a/Artifacts/bin/ElmSharp.pdb b/Artifacts/bin/ElmSharp.pdb index 1d0e8c5..d5cea83 100644 Binary files a/Artifacts/bin/ElmSharp.pdb and b/Artifacts/bin/ElmSharp.pdb differ diff --git a/Artifacts/bin/ElmSharp.xml b/Artifacts/bin/ElmSharp.xml index 4fa0bb1..7a7fe9a 100644 --- a/Artifacts/bin/ElmSharp.xml +++ b/Artifacts/bin/ElmSharp.xml @@ -1,10355 +1,10355 @@ - - - - ElmSharp - - - - - The delegate to define how to provide informations for or . - - The sender obj. - Return information for Name or Description. - - - - It's a base abstract class for . - It provides available definitions for the screen reader, such as , , , etc. - There's many the relationship between two accessible objects, like , , , , etc. - - - - - Gets or sets the reading information types of an accessible object. - - - - - Gets or sets the role of the object in accessibility domain. - - - - - Gets or sets highlightable of given widget. - - - - - Gets or sets the translation domain of "name" and "description" properties. - Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties. - When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter. - It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled. - - - - - Gets or sets an accessible name of the object. - - - - - Gets or sets contextual information about object. - - - - - Gets or sets the delegate for . - - - - - Gets or sets the delegate for . - - - - - Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter. - - Parent EvasObject class - - - - Creates and initializes a new instance of the AccessibleObject class. - - - - - Defines the relationship between two accessible objects. - Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. - AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, do not append relation from object B to object A. - - The relationship between source object and target object of a given type. - - - - Removes the relationship between two accessible objects. - - The relationship between source object and target object of a given type. - - - - Highlights accessible widget. - - - - - Clears highlight of accessible widget. - - - - - IAccessibleRelation is a interface which defines the relationship between two accessible objects. - - - - - To define label info for accessible object. - - - - - Gets or sets the target object which is LabelledBy. - - - - - Gets the LabelledBy type. - - - - - To define label info for accessible object. - - - - - Gets or sets the target object which is LabelFor. - - - - - Gets the LabelFor type. - - - - - To define control relationship for accessible object. - - - - - Gets or sets the target object which is ControllerFor. - - - - - Gets the ControllerFor type. - - - - - To define control relationship for accessible object. - - - - - Gets or sets the target object which is ControlledBy. - - - - - Gets the ControlledBy type. - - - - - To define member relationship for accessible object. - - - - - Gets or sets the target object which is MemberOf. - - - - - Gets the MemberOf type. - - - - - To define tooltip for accessible object. - - - - - Gets or sets the target object which is TooltipFor. - - - - - Gets the TooltipFor type. - - - - - To define child for accessible object. - - - - - Gets or sets the target object which is ChildOf. - - - - - Gets the ChildOf type. - - - - - To define parent for accessible object. - - - - - Gets or sets the target object which is ParentOf. - - - - - Gets the ParentOf type. - - - - - To define extend for accessible object. - - - - - Gets or sets the target object which is Extended. - - - - - Gets the Extended type. - - - - - To define the custom reading order. - - - - - Gets or sets the target object which is FlowsTo. - - - - - Gets the FlowsTo type. - - - - - To define the custom reading order. - - - - - Gets or sets the target object which is FlowsFrom. - - - - - Gets the FlowsFrom type. - - - - - To define subwindow for accessible object. - - - - - Gets or sets the target object which is SubwindowOf. - - - - - Gets the SubwindowOf type. - - - - - To define embed for accessible object. - - - - - Gets or sets the target object which is Embeds. - - - - - Gets the Embeds type. - - - - - To define embed for accessible object. - - - - - Gets or sets the target object which is EmbeddedBy. - - - - - Gets the EmbeddedBy type. - - - - - To define popup for accessible object. - - - - - Gets or sets the target object which is PopupFor. - - - - - Gets the PopupFor type. - - - - - To define parent window for accessible object. - - - - - Gets or sets the target object which is ParentWindowOf. - - - - - Gets the ParentWindowOf type. - - - - - To define description for accessible object. - - - - - Gets or sets the target object which is DescriptionFor. - - - - - Gets the DescriptionFor type. - - - - - To define description for accessible object. - - - - - Gets or sets the target object which is DescribedBy. - - - - - Gets the DescribedBy type. - - - - - Enumeration for ReadingStatus. - - - - - Unknown status - - - - - Cancelled status - - - - - Stopped status - - - - - Skipped status - - - - - AccessibleUtil provides a method to set the reading information. - - - - - Reads given text by screen reader. - - The reading text. - If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started. - Return a task with reading status. - - - - Enumeration for AccessRole. - - - - - Invalid - - - - - AcceleratorLabel role - - - - - Alert role - - - - - Animation role - - - - - Arrow role - - - - - Calendar role - - - - - Canvas role - - - - - CheckBox role - - - - - CheckMenuItem role - - - - - ColorChooser role - - - - - ColumnHeader role - - - - - ComboBox role - - - - - DateEditor role - - - - - DesktopIcon role - - - - - DesktopFrame role - - - - - Dial role - - - - - Dialog role - - - - - DirectoryPane role - - - - - DrawingArea role - - - - - FileChooser role - - - - - Filler role - - - - - FocusTraversable role - - - - - FontChooser role - - - - - Frame role - - - - - GlassPane role - - - - - HtmlContainer role - - - - - Icon role - - - - - Image role - - - - - InternalFrame role - - - - - Label role - - - - - LayeredPane role - - - - - List role - - - - - ListItem role - - - - - Menu role - - - - - MenuBar role - - - - - MenuItem role - - - - - OptionPane role - - - - - PageTab role - - - - - PageTabList role - - - - - Panel role - - - - - PasswordText role - - - - - PopupMenu role - - - - - ProgressBar role - - - - - PushButton role - - - - - RadioButton role - - - - - RadioMenuItem role - - - - - RootPane role - - - - - RowHeader role - - - - - ScrollBar role - - - - - ScrollPane role - - - - - Separator role - - - - - Slider role - - - - - SpinButton role - - - - - SplitPane role - - - - - StatusBar role - - - - - Table role - - - - - TableCell role - - - - - TableColumnHeader role - - - - - TableRowHeader role - - - - - TearoffMenuItem role - - - - - Terminal role - - - - - Text role - - - - - ToggleButton role - - - - - ToolBar role - - - - - ToolTip role - - - - - Tree role - - - - - TreeTable role - - - - - Unknown - - - - - Viewport role - - - - - Window role - - - - - Extended role - - - - - Header role - - - - - Footer role - - - - - Paragraph - - - - - Ruler role - - - - - Application role - - - - - Autocomplete role - - - - - Editbar role - - - - - Embedded role - - - - - Entry role - - - - - Chart role - - - - - Caption role - - - - - DocumentFrame role - - - - - Heading role - - - - - Page role - - - - - Section role - - - - - RedundantObject role - - - - - Form role - - - - - Link role - - - - - InputMethodWindow role - - - - - TableRow role - - - - - TreeItem role - - - - - DocumentSpreadsheet role - - - - - DocumentPresentation role - - - - - DocumentText role - - - - - DocumentWeb role - - - - - DocumentEmail role - - - - - Comment role - - - - - ListBox role - - - - - Grouping role - - - - - ImageMap role - - - - - Notification role - - - - - InfoBar role - - - - - IAccessibleObject is a interface which defines properties and methods of accessible object. - - - - - Enumeration for ReadingInfoType. - - - - - None - - - - - Name for reading info type - - - - - Role for reading info type - - - - - Description for reading info type - - - - - State for reading info type - - - - - The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) - or to any container object. - - - - - Creates and initializes a new instance of the Background class. - - The EvasObject to which the new Background will be attached as a child. - - - - Sets or gets color to Background. - - - - - Sets or gets image to Background. - - - - - Sets or gets the mode of display for a given background widget's image. - - - This sets how the background widget will display its image. - This will only work if the File was previously set with an image file on obj. - The image can be display tiled, scaled, centered or stretched. scaled by default. - - - - - Set the size of the pixmap representation of the image set on a given background widget. - This method just makes sense if an image file was set. - This is just a hint for the underlying system. - The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested. - - The new width of the image pixmap representation. - The new height of the image pixmap representation. - - - - Enumeration for the background type. - - - - - Centers the background image - - - - - Scales the background image, retaining the aspect ratio - - - - - Stretches the background image to fill the UI component's area. - - - - - Tiles the background image at its original size - - - - - The Box is a container used to arranges UI components in a linear order. - - - - - Creates and initializes a new instance of the Box class. - - The EvasObject to which the new Box will be attached as a child. - - - - Sets or gets IsHorizontal value which describe pack direction, vertical is default. - - - - - Sets or gets whether the box to arrange its children homogeneously. - - - - - Adds an object at the end of the pack list. - - - Packs "content" object into the Box, placing it last in the list of children objects. - The actual position the object will get on screen depends on the layout used. - If no custom layout is set, it will be at the bottom or right, - depending if the Box is vertical or horizontal, respectively. - - The oject be packed - - - - Adds an "content" object to the beginning of the pack list. - - - Pack "content" object into the Box obj, placing it first in the list of children objects. - The actual position the object will get on screen depends on the layout used. - If no custom layout is set, it will be at the top or left, - depending if the Box is vertical or horizontal, respectively. - - The object to be packed. - - - - Adds an "content "object to the Box after the "after" object. - - - This will add the "content" to the Box indicated after the object indicated with "after". - If "after" is not already in the Box, results are undefined. - After means either to the right of the "after" object or below it depending on orientation. - - The object will be added in Box - The object has been added in Box - - - - Adds an "content "object to the Box before the "before" object. - - - This will add the "content" to the Box indicated before the object indicated with "before". - If "before" is not already in the Box, results are undefined. - before means either to the left of the "before" object or below it depending on orientation. - - The object will be added in Box - The object has been added in Box - - - - Remove the "content" oject from Box without deleting it. - - The object to unpack - - - - Removes all objects from Box container. - - - - - Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements, - the function cb will be called to determine what the layout of the children will be. - - The callback function used for layout - - - - Sets the color of exact part to Box's layout parent. - - The name of part class, it could be 'bg', 'elm.swllow.content'. - The color value. - - - - Gets the color of exact part of Box's layout parent. - - The name of part class, it could be 'bg', 'elm.swllow.content'. - - - - - Force the box to recalculate its children packing. - If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. - While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. - - - - - Clear the box of all children. - Remove all the elements contained by the box, deleting the respective objects. - - - - - Sets or gets the alignment of the whole bounding box of contents. - - Horizontal alignment - Vertical alignment - - - - Sets or gets the space(padding) between the box's elements. - - Horizontal padding - vertical padding - - - - The Button is a widget works as a clickable input element to trigger events. - - - - - Creates and initializes a new instance of the Button class. - - - The EvasObject to which the new Button will be attached as a child. - - - - - Clicked will be triggered when Button is clicked. - - - - - Repeated will be triggered when Button is pressed without releasing it. - - - - - Pressed will be triggered when the Button is pressed. - - - - - Released will be triggered when the Button is released after being pressed. - - - - - Sets or gets the autorepeat feature of a given Button. - - - Autorepeat feature means autorepeat event generated when the button is kept pressed. - When set AutoRepeat to false, no autorepeat is performed and buttons will trigger Clicked event when they are clicked. - When set to true, keeping a button pressed continuously trigger Repeated event until the button is released. - The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime, - and the time between each new emission is given by AutoRepeatGapTimeout. - - - - - Sets or gets the initial timeout before the Repeat event is generated. - - - - - Sets or gets the interval between each generated Repeat event. - - - - - Sets or gets the BackgroundColor of a given Button in normal and pressed status. - - - - - Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. - - - - - Default value. Marks will be displayed only on event day. - - - - - Marks will be displayed every day after event day. - - - - - Marks will be displayed every week after event day. - - - - - Marks will be displayed every month day that coincides to event day. - - - - - Marks will be displayed every year that coincides to event day. - - - - - Marks will be displayed every last day of month after event day. - - - - - Enumeration for the mode, which determine how user could select a day. - - - - - Default value. a day is always selected. - - - - - A day is always selected. - - - - - None of the days can be selected. - - - - - User may have selected a day or not. - - - - - Enumeration used to define which fields of a tm struct will be taken into account - - - - - None will be taken into account - - - - - Year will be taken into account - - - - - Month will be taken into account - - - - - Day will be taken into account - - - - - The CalendarMark is a Item for marking a Calendar's type,date and repeat type. - - - - - A string used to define the type of mark. - - - - - A time struct to represent the date of inclusion of the mark. - - - - - Repeat the event following this periodicity. - - - - - Creates and initializes a new instance of the CalendarMark class. - - Type of mark - Date of inclusion of the mark - Repeat type - - - - The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month. - - - - - Creates and initializes a new instance of the Calendar class. - - - The EvasObject to which the new Calendar will be attached as a child. - - - - - DateChanged will be triggered when the date in the calendar is changed. - - - - - DisplayedMonthChanged will be triggered when the current month displayed in the calendar is changed. - - - - - This delegate type is used to format the string that will be used to display month and year. - - DateTime - - - - - Sets or gets the minimum for year. - - - - - Sets or gets the maximum for the year. - - - - - Sets or gets the first day of week, who are used on Calendar. - - - - - Sets or gets the first day of week, who are used on Calendar. - - - - - - Sets or gets the selected date. - - - Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar. - - - - - Sets or gets the interval on time updates for an user mouse button - hold on calendar widgets' month/year selection. - - - - - Gets or sets the select day mode used. - - - - - Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked. - - - - - Gets or sets date format the string that will be used to display month and year. - - - - - Add a new mark to the calendar. - - A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation. - A time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar. - Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually. - Item for a calendar mark. - - - - Delete mark from the calendar. - - Item for a calendar mark - - - - Draw calendar marks. - - - - - Remove all calendar's marks. - - - - - The check is a widget allows for toggling a value between true and false. - - - - - Creates and initializes a new instance of the Check class. - - - The EvasObject to which the new Check will be attached as a child. - - - - - StateChanged will be triggered when the IsChecked in the Check is changed. - - - - - Sets or gets whether the given Check is checked or not. - - - When object is checked, the value will set to true, Conversely will set to false. - - - - - It inherits System.EventArgs. - The CheckStateChangedEventArgs is EventArgs to record Check's state. - Include old state and new state. - - - - - Gets the OldState property.The return type is bool. - - - - - Gets the NewState property.The return type is bool. - - - - - Creates and initializes a new instance of the CheckStateChangedEventArgs class. - - Old state of Check which to use this CheckStateChangedEventArgs. - New state of Check which to use this CheckStateChangedEventArgs. - - - - The Color is a struct to record Check's state. - - - - - Gets a default Color instance. - - - In default Color instance,Mode type is Default,RGBA all set as -1. - - - - - Gets whether the Color instance's mode is default or not. - Return type is bool. - - - - - Gets A value of RGBA. - A means the Alpha in color. - - - - - Gets R value of RGBA. - R means the Red in color. - - - - - Gets G value of RGBA. - G means the Green in color. - - - - - Gets B value of RGBA. - B means the Blue in color. - - - - - Creates and initializes a new instance of the Color class. - With RGB parameters. - - Red of RGB - Green of RGB - Blue of RGB - - - - - Compare whether two Color instance is same or not. - - A Color instance. - A Color instance. - The result whether two instance is same or not. - Return type is bool.If they are same, return true. - - - - - Compare whether two Color instance is different or not. - - A Color instance. - A Color instance. - The result whether two instance is different or not. - Return type is bool.If they are different, return true. - - - - - Gets a Color instance with a hexadecimal string parameter. - - Hexadecimal string. - New instance of Color struct. - - - - Gets a Color instance with a Unsigned integer parameter. - - Unsigned integer indicates RGBA. - New instance of Color struct. - - - - Gets a Color instance with R,G,B,A parameters. - - Red in RGBA. - Green in RGBA. - Blue in RGBA. - Alpha in RGBA. - New instance of Color struct. - - - - Gets a Color instance with R,G,B,A parameters. - - Red in RGB. - Green in RGB. - Blue in RGB. - New instance of Color struct. - - - - The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0). - - - - - The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255). - - - - - The Black is a predefined Color instance, it's rgb value is (0, 0, 0). - - - - - The Blue is a predefined Color instance, it's rgb value is (0, 0, 255). - - - - - The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255). - - - - - The Gray is a predefined Color instance, it's rgb value is (128, 128, 128). - - - - - The Green is a predefined Color instance, it's rgb value is (0, 128, 0). - - - - - The Lime is a predefined Color instance, it's rgb value is (0, 255, 0). - - - - - The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0). - - - - - The Navy is a predefined Color instance, it's rgb value is (0, 0, 128). - - - - - The Olive is a predefined Color instance, it's rgb value is (128, 128, 0). - - - - - The Orange is a predefined Color instance, it's rgb value is (255, 165, 0). - - - - - The Purple is a predefined Color instance, it's rgb value is (128, 0, 128). - - - - - The Pink is a predefined Color instance, it's rgb value is (255, 102, 255). - - - - - The Red is a predefined Color instance, it's rgb value is (255, 0, 0). - - - - - The Silver is a predefined Color instance, it's rgb value is (192, 192, 192). - - - - - The Teal is a predefined Color instance, it's rgb value is (0, 128, 128). - - - - - The White is a predefined Color instance, it's rgb value is (255, 255, 255). - - - - - The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0). - - - - - It inherits System.EventArgs. - Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter. - Refer to type. - - - - - Gets old color in color changed event. - - - - - Gets new color in color changed event. - - - - - Creates and initializes a new instance of the ColorChangedEventArgs class. - - old color - new color - - - - Enumeration for mode of ColorSelector - - - - - Only color palette is displayed, default - - - - - Only color selector is displayed - - - - - Both Palette and selector is displayed - - - - - Only color picker is displayed - - - - - This mode is not supported. If you use this, nothing will be shown - - - - - This mode is not supported. If you use this, it will be shown same with Palette mode - - - - - This mode is not supported. If you use this, it will be shown same with Palette mode - - - - - The ColorSelector is a widget to set a series of colors. - It also allows to load/save colors from/to config with a unique identifier. - - - By default, the colors are loaded/saved from/to config using "default" identifier. - The colors can be picked by user from the color set by clicking on individual - color item on the palette or by selecting it from selector. - - - - - Creates and initializes a new instance of the ColorSelector class. - - - - - - ColorChanged will be triggered when the SelectedColor changed. - - - - - Gets or sets color of colorselector. - - - - - Gets Alpha of a default Color Class(Value is -1). - - - - - Gets or sets Colorselector's mode. - - - - - Get or set current palette's name. - - - - - Adds a new color item to palette. - - Color item to add - A new color palette Item. - - - - Clear the palette items. - - - - - A instance to the ColorSelector item added. - - - - - Gets or sets the Palette item's color - - - - - - Creates and initializes a new instance of the Conformant class. - - The parent is a given container which will be attached by Conformant - as a child.It's type. - - - - It inherits . - The Container is a abstract class. - Other class inherits it to Elementary is about displaying - its widgets in a nice layout. - - - - - Creates and initializes a new instance of class which inherit from Container. - - The parent is a given object which will be attached by Container - as a child.It's type. - - - - Sets the background color of a given Container. - - - - - Enumeration of ContextPopup direction type. - - - - - ContextPopup show appear below clicked area - /// - - - - ContextPopup show appear to the right of the clicked area - - - - - ContextPopup show appear to the left of the clicked area - - - - - ContextPopup show appear above the clicked area - - - - - ContextPopup does not determine it's direction yet - - - - - It inherits . - The ContextPopup is a widget that when it shown, pops up a list of items. - - - - - Creates and initializes a new instance of the ContextPopup class. - - The parent is a given container which will be attached by ContextPopup - as a child.It's type. - - - - Dismissed is raised when the ContextPopup item is dismissed. - - - Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed. - - - - - Gets the current direction of a ContextPopup. - - - Once the ContextPopup showed up, the direction would be determined. - - - - - Gets or sets the value of current ContextPopup object's orientation. - True for horizontal mode, False for vertical mode (or errors) - - - - - Gets or sets whether ContextPopup hide automatically - or not when parent of ContextPopup is resized. - - - Default value of AutoHide is False. - - - - - Clears all items in the given ContextPopup object. - - - - - Sets the direction priority of a ContextPopup. - - 1st priority of direction - 2nd priority of direction - 3th priority of direction - 4th priority of direction - - - - Gets the direction priority of a ContextPopup. - - 1st priority of direction to be returned - 2nd priority of direction to be returned - 2nd priority of direction to be returned - 4th priority of direction to be returned - - - - Adds a new item to a ContextPopup object with label. - - The Label of the new item - - A ContextPopupItem added or NULL, on errors - - - - - Adds a new item to a ContextPopup object with label and icon. - - The Label of the new item - Icon to be set on new item - A ContextPopupItem added or NULL, on errors - - - - Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted. - - - - - Gets the possibility that the direction would be available - - A direction user wants to check - - Get false if you cannot put it in the direction. Gets true if it's possible. - - - - - Gets Alpha of a default Color Class. - - - - - It inherits . - A instance to the ContextPopup item added. - - - - - Gets the Text property of the given ContextPopupItem. - - - - - Gets the Icon(type is ) property of the given ContextPopupItem. - - - - - Selected will be triggered when the ContextPopupItem is Selected. - - - - - It inherits System.EventArgs. - The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector. - contain DateChangedEventArgs as a parameter. - - - - - Gets the OldDate property of the given DateChangedEventArgs. - - - - - Gets the NewDate property of the given DateChangedEventArgs. - - - - - Creates and initializes a new instance of the DateChangedEventArgs class. - - - Old date when DateChanged event or DateTimeChanged event triggered - - - New date when DateChanged event or DateTimeChanged event triggered - - - - - Enumeration of datetime field types for DateTimeSelector. - - - - - - Creates and initializes a new instance of the DateTimeSelector class. - - The parent is a given container which will be attached by DateTimeSelector - as a child.It's type. - - - - ItemSelected is raised when Datetime field value changed. - - - - - Gets or sets the datetime format. - - - format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p". - - - - - Gets or sets the upper boundary of DateTime field. - - - - - Gets or sets the lower boundary of DateTime field. - - - - - Gets or sets the current value of DateTime field. - - - - - Gets whether a field can be visible. - - Enumeration - - The field is visible or not. - Type is bool.If visible, return true. - - - - - Sets the field limits of a field. - - Enumeration - minimum limit - maximum limit - - - - Gets whether a field can be visible. - - Enumeration - When set as true, the field type visible. - - - - It inherits System.EventArgs. - The DisplayedMonthChangedEvent in Calendar contain - DisplayedMonthChangedEventArgs as a parameter. - - - - - Gets the OldMonth property of the given DisplayedMonthChangedEventArgs. - - - - - Gets the NewMonth property of the given DisplayedMonthChangedEventArgs. - - - - - Creates and initializes a new instance of the DisplayedMonthChangedEventArgs class. - - - old month of date when DisplayedMonthChangedEvent triggered. - - - new month of date when DisplayedMonthChangedEvent triggered. - - - - - EcoreAnimator is a helper class, it provides functions to manager animations. - - - - - Gets current system time as a floating point value in seconds. - - Current system time - - - - Adds an animator to call at every animation tick during main loop execution. - - The function to call when it ticks off - A handle to the new animator - - - - Removes the specified animator from the animator list. - - The specified animator handle - - - - The EcoreEventType is type of EcoreEvent. - It includes some predefined instance. - - - - - Key down Ecore event type. - - - - - Key Up Ecore event type. - - - - - Mouse Button Down Ecore event type. - - - - - Mouse Button Up Ecore event type. - - - - - Mouse Button Cancel Ecore event type. - - - - - Mouse Move Ecore event type. - - - - - Mouse Wheel Ecore event type. - - - - - Mouse In Ecore event type. - - - - - Mouse Out Ecore event type. - - - - - Gets the value associated with the specified type. - - The value of type. - - - - The EcoreEvent is a class to help to create events are being notified of events. - - Kinds of EventArgs - - - - Creates and initializes a new instance of the EcoreEvent class. - - EcoreEventType - - - - Creates and initializes a new instance of the EcoreEvent class. - - EcoreEventType - EventInfoParser - - - - On Event Handler of EcoreEvent. - - - - - Event class for EcoreEvent - - - - - Creates and initializes a new instance of the EcoreEvent class. - - EcoreEventType - - - - It inherits System.EventArgs. - The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code. - - - - - Gets the KeyName property.The return type is string. - - - - - Gets the KeyCode property.The return type is int. - - - - - Creates and initializes a new instance of the EcoreKeyEventArgs class. - - data - type - information - new instance of the EcoreKeyEventArgs class - - - - EcoreMainloop is a helper class, it provide functions relative Ecore's main loop. - - - - - Checks if you are calling this function from the main thread. - - True is the calling function is the same thread, false otherwise. - - - - Runs the application main loop. - - - - - Quits the main loop once all the events currently on the queue have been processed. - - - - - Adds an idler handler. - - The action to call when idling - - - - Calls callback asynchronously in the main loop. - - The action wanted to be called - - - - Calls callback synchronously in the main loop. - - The action wanted to be called - - - - Creates a timer to call the given function in the given period of time. - - The interval in seconds. - The given function. - A timer object handler on success, NULL on failure. - - - - Removes the specified timer from the timer list. - - The specified timer handler - - - - Provides a synchronization context for the efl application. - - - - - Initializes a new instance of the EcoreSynchronizationContext class. - - - - - Initilizes a new EcoreSynchronizationContext and install into current thread - - - It is equivalent - - SetSynchronizationContext(new EcoreSynchronizationContext()); - - - - - - Dispatches an asynchronous message to a Ecore main loop. - - The SendOrPostCallback delegate to call. - The object passed to the delegate. - The Post method starts an asynchronous request to post a message. - - - - Dispatches a synchronous message to a Ecore main loop - - The SendOrPostCallback delegate to call. - The object passed to the delegate. - - The Send method starts a synchronous request to send a message. - - - - The EdjeObject is a class that evas object exist in - - - - - Checks whether an edje part exists in a given edje object's group definition. - This function returns if a given part exists in the edje group bound to object obj - - This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj. - The part's name to check for existence in obj's group - TRUE, if the edje part exists in obj's group, otherwise FALSE - - - - Sends/emits an edje signal to a given edje object. - - The signal's "emission" string - The signal's "source" string - - - - Deletes the object color class. - This function deletes any values at the object level for the specified object and color class. - - Deleting the color class defined in the theme file. - The color class to be deleted - - - - Sets the object color class. - - The color class name. - The object Red value. - The object Green value. - The object Blue value. - The object Alpha value. - The outline Red value. - The outline Green value. - The outline Blue value. - The outline Alpha value. - The shadow Red value. - The shadow Green value. - The shadow Blue value. - The shadow Alpha value. - True if succeed, otherwise False - - - - Gets the object color class. - - The color class name. - The object Red value. - The object Green value. - The object Blue value. - The object Alpha value. - The outline Red value. - The outline Green value. - The outline Blue value. - The outline Alpha value. - The shadow Red value. - The shadow Green value. - The shadow Blue value. - The shadow Alpha value. - True if succeed, otherwise False - - - - Sets Edje text class. - - The text class name. - Font name. - Font size. - True if succeed, otherwise False - - - - Gets Edje text class. - - The text class name. - Font name. - Font size. - True if succeed, otherwise False - - - - Adds Action for an arriving edje signal, emitted by a given Ejde object. - - The signal's "emission" string - The signal's "source" string - The action to be executed when the signal is emitted - - - - Deletes a signal-triggered action from an object. - - The signal's "emission" string - The signal's "source" string - The action to be executed when the signal is emitted - - - - An EdjeTextPartObject is a class dealing with parts of type text. - - - - - Gets the name of the EdjeTextPartObject - - - - - Gets or sets the text for an object part. - - - - - Sets or gets the style of the object part. - - - - - Gets the geometry of a given edje part, in a given edje object's group definition, relative to the object's area. - - - - - Gets the native width and height. - - - - - Gets the formatted width and height. - - - - - EffectBase class for the TransitEffect - - - - - EffectEneded event will be triggered when be effect ended. - - - - - Focus Autoscroll Mode - - - - - Directly show the focused region or item automatically - - - - - Do not show the focused region or item automatically - - - - - Bring in the focused region or item automatically which might invole the scrolling - - - - - The Elementary is a General Elementary,a VERY SIMPLE toolkit. - - - - - Gets or sets the configured finger size. - - - - - Gets or sets the enable status of the focus highlight animation - - - - - Gets or sets the system mirrored mode. - This determines the default mirrored mode of widgets. - - - - - Gets or sets the enable status of the focus highlight. - - - - - Gets or sets the base scale of the application. - - - - - Gets or sets the global scaling factor. - - - - - Gets or sets the amount of inertia a scroller imposes during region bring animations. - - - - - Gets of sets focus auto scroll mode. - - - - - Initializes Elementary. - - - - - Shuts down Elementary. - - - - - Runs Elementary's main loop. - - - - - Prepends a theme overlay to the list of overlays - - The Edje file path to be used. - - - - Delete a theme overlay from the list of overlays - - The name of the theme overlay. - - - - Free a theme - - - - - Set the theme search order for the given theme - - Theme search string - This sets the search string for the theme in path-notation from first theme to search, to last, delimited by the : character. Example:"shiny:/path/to/file.edj:default" - - - - Flush the current theme. - - - - - This flushes all themes (default and specific ones). - - - - - Deletes a theme extension from the list of extensions. - - The name of the theme extension. - - - - Flush all caches. - Frees all data that was in cache and is not currently being used to reduce memory usage. This frees Edje's, Evas' and Eet's cache. - - - - - Changes the language of the current application. - - The language to set, must be the full name of the locale. - - - - Sets a new policy's value (for a given policy group/identifier). - - The policy identifier - The policy value, which depends on the identifier - - - - - Reloads Elementary's configuration, bounded to the current selected profile. - - - - - Flushes all config settings and then applies those settings to all applications using elementary on the current display. - - - - - The ElmScrollConfig is a scrollable views's config - - - - - Enumeration for describing InputPanel layout type. - - - - - InputPanel layout type default. - - - - - InputPanel layout type number. - - - - - InputPanel layout type email. - - - - - InputPanel layout type url. - - - - - InputPanel layout type phone. - - - - - InputPanel layout type ip. - - - - - InputPanel layout type month. - - - - - InputPanel layout type number. - - - - - InputPanel layout type error type. Do not use it directly! - - - - - InputPanel layout type hexadecimal. - - - - - InputPanel layout type terminal type, esc, alt, ctrl, etc. - - - - - InputPanel layout type password. - - - - - Keyboard layout type date and time. - - - - - InputPanel layout type emoticons. - - - - - Enumeration that defines the "Return" key types on the input panel (virtual keyboard). - - - - - Default key type - - - - - Done key type - - - - - Go key type - - - - - Join key type - - - - - Login key type - - - - - Next key type - - - - - Search string or magnifier icon key type - - - - - Send key type - - - - - Sign-in key type - - - - - Enumeration that defines the autocapitalization types. - - - - - No autocapitalization when typing - - - - - Autocapitalize each typed word - - - - - Autocapitalize the start of each sentence - - - - - Autocapitalize all letters - - - - - - - - - Enumeration that defines the text format types. - - - - - Plain type - - - - - Markup type - - - - - Enumeration that defines the types of Input Hints. - - - - - No active hints - - - - - suggest word auto completion - - - - - typed text should not be stored. - - - - - Enumeration that defines the input panel (virtual keyboard) language modes. - - - - - Automatic language mode - - - - - Alphabet language mode - - - - - The entry is a convenience widget that shows a box in which the user can enter text. - - - - - Creates and initializes a new instance of the Entry class. - - The EvasObject to which the new Entry will be attached as a child. - - - - Activated will be triggered when the entry in Activated stated. - - - - - Clicked will be triggered when the entry is clicked. - - - - - ChangedByUser will be triggered when the entry changed by user. - - - - - CursorChanged will be triggered when the Cursor in the entry is changed. - - - - - Sets or gets the entry to the single line mode. - - - - - Sets or gets the entry to the password mode. - - - - - Sets or gets whether the entry is editable. - - - - - Sets or gets whether the entry is empty. - - - - - Sets or gets text currently shown in the object entry. - - - - - Sets or gets the style on the top of the user style stack. - - If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold'). - - - - Sets or gets the current position of the cursor in the entry. - - - - - Sets or gets the scrollable state of the entry. - - - - - Sets or Gets the autocapitalization type on the immodule. - - - - - Sets or Gets the entry object's 'autosave' status. - - - - - Sets or Gets entry text paste/drop mode. - - - - - Gets the geometry of the cursor. - - - - - Gets whether a format node exists at the current cursor position. - - - - - Gets if the current cursor position holds a visible format node. - - - - - Sets or Gets the value of input hint. - - - - - Sets or gets the language mode of the input panel. - - - - - Sets or gets the input panel layout variation of the entry. - - - - - Sets or gets the line wrap type to use on multi-line entries. - - - - - Sets or gets whether the entry should allow to use the text prediction. - - - - - Sets or gets whether the return key on the input panel should be disabled or not. - - - - - Sets or gets the attribute to show the input panel in case of only an user's explicit Mouse Up event. - It doesn't request to show the input panel even though it has focus. - If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) - - - - - Sets the file (and implicitly loads it) for the text to display and then edit. - - The path to the file to load and save - The file format - - - - Converts a markup (HTML-like) string into UTF-8. - - The string (in markup) to be converted - The converted string (in UTF-8) - - - - Moves the cursor by one position to the right within the entry. - - - - - - Moves the cursor one place to the left within the entry. - - TRUE on success, otherwise FALSE on failure - - - - Moves the cursor one line up within the entry. - - TRUE on success, otherwise FALSE on failure - - - - Moves the cursor one line down within the entry. - - TRUE on success, otherwise FALSE on failure - - - - Moves the cursor to the beginning of the entry. - - - - - Moves the cursor to the end of the entry. - - - - - Moves the cursor to the beginning of the current line. - - - - - Moves the cursor to the end of the current line. - - - - - Sets the input panel layout of the entry. - - The layout type - - - - Sets the attribute to show the input panel automatically. - - If true the input panel appears when the entry is clicked or has focus, otherwise false - - - - Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel. - - The type of "return" key on the input panel - - - - Hides the input panel (virtual keyboard). - - - Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. - This API can be used in case of manually controlling by using SetInputPanelEnabled(false). - - - - - Selects all the text within the entry. - - - - - Drops any existing text selection within the entry. - - - - - Forces calculation of the entry size and text layouting. - - - - - Gets the string by the cursor at its current position. - - - - - - Begins a selection within the entry as though the user were holding down the mouse button to make a selection. - - - - - Appends the text of the entry. - - The text to be displayed - - - - Inserts the given text into the entry at the current cursor position. - - - - - - Ends a selection within the entry as though the user had just released the mouse button while making a selection. - - - - - Writes any changes made to the file that is set by File. - - - - - Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on. - - - Note that input panel is shown or hidden automatically according to the focus state of entry widget. - This API can be used in the case of manually controlling by using SetInputPanelEnabled(false). - - - - - This appends a custom item provider to the list for that entry. - - This function is used to provide items. - - - - This prepends a custom item provider to the list for that entry. - - This function is used to provide items. - - - - This removes a custom item provider to the list for that entry. - - This function is used to provide items. - - - - Append a markup filter function for text inserted in the entry. - - This function type is used by entry filters to modify text. - - - - Prepend a markup filter function for text inserted in the entry. - - This function type is used by entry filters to modify text. - - - - Remove a markup filter - - This function type is used by entry filters to modify text. - - - - This executes a "copy" action on the selected text in the entry. - - - - - This executes a "cut" action on the selected text in the entry. - - - - - This executes a "paste" action in the entry. - - - - - This disabled the entry's selection. - - If true, the selection are disabled. - - - - Get any selected text within the entry. - - Selection's value - - - - This selects a region of text within the entry. - - The starting position. - The end position. - - - - Sets the visibility of the left-side widget of the entry - - true if the object should be displayed, false if not. - - - - Set whether the return key on the input panel is disabled automatically when entry has no text. - - If enabled is true, the return key is automatically disabled when the entry has no text. - - - - Low level Evas canvas functions. Sub groups will present more high level ones, though. - Most of these functions deal with low level Evas actions, like: - create/destroy raw canvases, not bound to any displaying engine - tell a canvas i got focused(in a windowing context, for example) - tell a canvas a region should not be calculated anymore in rendering - tell a canvas to render its contents, immediately - Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff. - The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas. - - - - - Gets the current known default pointer coordinates. - This function returns the current known canvas unit coordinates of the mouse pointer. - - - - - Gets or sets the image cache. - This function returns the image cache size of canvas in bytes. - - - - - Flush the image cache of the canvas. - - - - - Add a damage rectangle. - - The rectangle's top left corner's horizontal coordinate. - The rectangle's top left corner's vertical coordinate. - The rectangle's width. - The rectangle's height. - - - - Add an "obscured region" to an Evas canvas. - - The rectangle's top left corner's horizontal coordinate. - The rectangle's top left corner's vertical coordinate. - The rectangle's width. - The rectangle's height. - - - - Remove all "obscured regions" from an Evas canvas. - - - - - Adds or registers a event to a given canvas event. - - The type of event that triggers - The action to be called when the event is triggered - - - - Deletes a event to a given canvas event. - - The type of event that triggers - The action to be called when the event is triggered - - - - The EvasKeyEventArgs is an EvasKey EventArgs - - - - - BackButton name in Platform - - - - - MenuButton name in Platform - - - - - HomeButton name in Platform - - - - - Gets the name of Key - - - - - Creates and initializes a new instance of the EvasKeyEventArgs class. - - data info - object - information - EvasKey eventArgs - - - - Event structure for Key Down event callbacks. - - - - - Name string of the key pressed - - - - - Data to be passed to the event - - - - - Modifier keys pressed during the event - - - - - Locks info - - - - - Logical key: (example, shift+1 == exclamation) - - - - - UTF8 string if this keystroke has produced a visible string to be ADDED - - - - - UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one - - - - - Event_flags - - - - - - - - - - Keycode - - - - - Flags for Events - - - - - No fancy flags set - - - - - This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything - - - - - The EvasMap is an opaque handle to map points. - - - - - Creates and initializes a new instance of the EvasMap class. - - The number of points in the map - - - - Gets or sets the flag of the object move synchronization for map rendering. - - - - - Populates source and destination map points to exactly match the object. - - The object to use unmapped geometry to populate map coordinates - - The point Z coordinate hint (pre-perspective transform)This value is used for all four points. - - - - - Populates the source and destination map points to match the given geometry. - - The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points - The Z coordinate hint (pre-perspective transform) This value is used for all four points. - - - - Rotates the map around 3 axes in 3D. - - The amount of degrees from 0.0 to 360.0 to rotate around X axis - The amount of degrees from 0.0 to 360.0 to rotate around Y axis - The amount of degrees from 0.0 to 360.0 to rotate around Z axis - The rotation's center horizontal position - The rotation's center vertical position - The rotation's center vertical position - - - - Changes the map point's coordinate. - - The index of point to change ,this must be smaller than map size. - 3D Point coordinate - - - - Gets the map point's coordinate. - - The index of point to change ,this must be smaller than map size. - The coordinates of the given point in the map. - - - - Changes the map to apply the given zooming. - - The horizontal zoom to use - The vertical zoom to use - The zooming center horizontal position - The zooming center vertical position - - - - The EcasObject is a base class for other widget class - - - - - Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter. - - Parent EvasObject class - - - - Creates and initializes a new instance of the EvasObject class. - - - - - Deleted will be triggered when widght is deleted - - - - - KeyUp will be triggered when key is loose - - - - - KeyDown will be triggered when key is preesd down - - - - - BackButtonPressed will be triggered when Back button is pressed - - - - - MoreButtonPressed will be triggered when More button is pressed - - - - - Moved will be triggered when widght is moved - - - - - Current widget's size Resized Event Handler - - - - - Current widget RenderPost Event Handler - - - - - Called back when a widget's tooltip is activated and needs content. - - - - - - Get widget's status of Realized or not. - - - - - Gets EvasCanvas - - - - - Gets the current class's Name. - - - - - Sets or gets the horizontal pointer hints for an object's weight. - - - - - Sets or gets the vertical pointer hints for an object's weight. - - - - - Sets or gets the horizontal alignment hint of an object's alignment. - - - - - Sets or gets the vertical alignment hint of an object's alignment. - - - - - Sets or gets the Width hints for an object's minimum size. - - - - - Sets or gets the Height hints for an object's minimum size. - - - - - Gets the visible state of the given Evas object. - - - - - Sets or gets the position and (rectangular) size of the given Evas object. - - - - - Sets or gets the general or main color of the given Evas object. - - - - - Sets or gets the map enabled state. - - - - - Sets or gets current object transformation map. - - - - - Sets or gets whether an object is to repeat events. - - - - - Sets or gets whether events on a smart object's member should get propagated up to its parent. - - - - - Sets or gets whether an object is set to pass (ignore) events. - - - - - Sets or Gets style for this object tooltip. - - - - - Sets or gets the orientation of Tooltip. - - - - - Sets or gets size restriction state of an object's tooltip. - - - - - Sets the content to be shown in the tooltip object. - - - - - Gets the movement freeze by 1 - This gets the movement freeze count by one. - - - - - Sets or gets whether an Evas object is to freeze (discard) events. - - - - - Sets or gets the layer of its canvas that the given object will be part of. - - - - - Clips one object to another. - - The object to clip object by - - - - Sets the hints for an object's alignment. - - The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 - The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 - - - - Sets the hints for an object's weight. - - The non-negative double value to use as horizontal weight hint - The non-negative double value to use as vertical weight hint - - - - Sets the text for an object's tooltip. - - The text value to display inside the tooltip - - - - Unsets an object's tooltip. - - - - - This increments the tooltip movement freeze count by one. - If the count is more than 0, the tooltip position will be fixed. - - - - - This decrements the tooltip freeze count by one. - - - - - Force hide tooltip of object. - - - - - Force show tooltip of object. - - - - - Makes the current object visible. - - - - - Makes the current object invisible. - - - - - Changes the size of the current object. - - The new width - The new height - - - - Moves the current object to the given location. - - The X position to move the object to. - The Y position to move the object to. - - - - Lowers obj to the bottom of its layer. - - - - - Define IntPtr operator - - Parent object - - - - Requests keyname key events be directed to current obj. - - The key to request events for - Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE - If the call succeeded is true,otherwise is false - - - - Removes the grab on keyname key events. - - The key the grab is set for - - - - Mark smart object as changed. - - - - - Call the calculate smart function immediately. - This will force immediate calculations needed for renderization of this object. - - - - - Sets the hints for an object's aspect ratio. - - The policy or type of aspect ratio to apply to object - The integer to use as aspect width ratio term - The integer to use as aspect height ratio term - - - - Gets the hints for an object's aspect ratio. - - The policy or type of aspect ratio to apply to object - The integer to use as aspect width ratio term - The integer to use as aspect height ratio term - - - - Stack immediately below anchor. - - The object below which to stack. - - - - Stack immediately above anchor. - - The object above which to stack. - - - - Raise to the top of its layer. - - - - - Get the geometry of a line number. - - the line number. - x coord of the line. - y coord of the line. - w coord of the line. - h coord of the line. - - - - - The callback of Invalidate Event - - - - - The callback of Instantiated Event - - - - - The callback of Realized Event - - - - - The callback of Unrealize Event - - - - - Creates a widget handle. - - Parent EvasObject - Handle IntPtr - - - - For this object bind Parent object.Init handle and all kinds of EvasObjectEvent. - - Parent object - - - - Removes current object relationship with others. - - - - - IInvalidatable is a interface which can be overrided by its children class. - Inherits IDisposable - - - - - Enumeration for EvasObjectCallbackType - - - - - Mouse In Event CallbackType. - - - - - Mouse Out Event CallbackType - - - - - Mouse Button Down Event CallbackType - - - - - Mouse Button Up Event CallbackType - - - - - Mouse Move Event CallbackType - - - - - Mouse Wheel Event CallbackType - - - - - Multi-touch Down Event CallbackType - - - - - Multi-touch Up Event CallbackType - - - - - Multi-touch Move Event CallbackType - - - - - Object Being Freed (Called after Del) - - - - - Key Press Event CallbackType - - - - - Key Release Event CallbackType - - - - - Focus In Event CallbackType - - - - - Focus Out Event CallbackType - - - - - Show Event CallbackType - - - - - Hide Event CallbackType - - - - - Move Event CallbackType - - - - - Resize Event CallbackType - - - - - Restack Event CallbackType - - - - - Object Being Deleted (called before Free) - - - - - Hold Event CallbackType, Informational purpose event to indicate something - - - - - Size hints changed Event CallbackType - - - - - Image has been preloaded - - - - - Canvas got focus as a whole - - - - - Canvas lost focus as a whole - - - - - Called just before rendering is updated on the canvas target - - - - - Called just after rendering is updated on the canvas target - - - - - Canvas object got focus - - - - - Canvas object lost focus - - - - - Image data has been unloaded (by some mechanism in Evas that throw out original image data) - - - - - Called just before rendering starts on the canvas target - - - - - Called just after rendering stops on the canvas target - - - - - Image size is changed - - - - - Devices added, removed or changed on canvas - - - - - Axis is changed - - - - - Canvas Viewport size is changed - - - - - Event class for EvasObject - - Kinds of EventArgs - - - - SmartEventInfoParser delegate of EvasObjectEvent class - - data - obj - info - delegate handle - - - - Creates and initializes a new instance of the EvasObjectEvent. - - EvasObject class belong to - EvasObjectCallbackType - SmartEventInfoParser - - - - Creates and initializes a new instance of the EvasObjectEvent. - - EvasObject class belong with - SmartEventInfoParser - - - - On Event Handler of EvasObjectEvent - - - - - Destroy Current Obj - - - - - Make current instance invalidate - - - - - Event class for EvasObject - - - - - Creates and initializes a new instance of the EvasObjectEvent. - - EvasObject class belong to - EvasObjectCallbackType - - - - On Event Handler of EvasObjectEvent - - - - - Destroy Current Obj - - - - - Make current instance invalidate - - - - - A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet. - - - - - Creates and initializes a new instance of the FlipSelector. - - Parent EvasObject - - - - Selected will be triggered when be Selected - - - - - Overflowed will be triggered when Overflowed - - - - - Underflowed will be triggered when be Underflowed - - - - - Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget. - - - - - Gets the currently selected item in a flip selector widget. - - - - - Gets the first item in the given flip selector widget's list of items. - - - - - Gets the last item in the given flip selector widget's list of items. - - - - - Appends a (text) item to a flip selector widget. - - text value - - A handle to the item added or NULL, on errors - - - The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. - - - - - Prepend a (text) item to a flip selector widget. - - Prepend text - A handle to the item added or NULL, on errors - - The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. - - - - - To remove the given item. - - FlipSelector's item - - - - Programmatically select the next item of a flip selector widget. - - - The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards. - - - - - Programmatically select the previous item of a flip selector widget. - - - - - Iterm class of FlipSelector - - - - - Sets or gets the Text of FlipSelectorItem - - - - - Selected will be triggered when Selected - - - - - Creates and initializes a new instance of the FlipSelectorItem. - - FlipSelectorItem's text - - - - The FloatingButton is a widget that to add floating area for buttons. - - - - - Creates and initializes a new instance of the FloatingButton class. - - Created on this parent container.. - - - - Sets or gets floatingbutton mode. - - - - - Gets floatingbutton Position. - - - - - Sets or gets movability for a given floatingbutton widget. - - - - - Get Opacity's value of the given FloatingButton. - - - - - Set the floatingbutton position with animation or not. - - Button position - Animat flag - - - - Enumeration for FloatingButtonMode - - - - - Allows all positions - - - - - Allows LEFT and RIGHT positions only - - - - - Enumeration for FloatingButtonPosition - - - - - Hides in the left, but small handler will show only - - - - - Shows all of buttons, but lies on the left - - - - - Shows all of buttons, but lies on the center - - - - - Shows all of buttons, but lies on the right - - - - - Hides in the right, but small handler will show only - - - - - It inherits System.EventArgs. - It contains Item which is type. - All events of GenGrid contain GenGridItemEventArgs as a parameter. - - - - - Gets or sets GenGrid item.The return type is . - - - - - It inherits . - The GenGrid is a widget that aims to position objects in a grid layout while actually creating and rendering only the visible ones. - It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical. - The GenGrid items are represented through definition field details. - - - - - Creates and initializes a new instance of the GenGrid class. - - The parent is a given container which will be attached by GenGrid as a child. It's type. - - - - ItemSelected is raised when a new gengrid item is selected. - - - - - ItemUnselected is raised when the gengrid item is Unselected. - - - - - ItemPressed is raised when a new gengrid item is pressed. - - - - - ItemReleased is raised when a new gengrid item is released. - - - - - ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar). - - - - - ItemDoubleClicked is raised when a new gengrid item is double clicked. - - - - - ItemRealized is raised when a gengrid item is implementing through . - - - - - ItemUnrealized is raised when the gengrid item is deleted. - - - - - ItemLongPressed is raised when a gengrid item is pressed for a certain amount of time. By default it's 1 second. - - - - - Changed is raised when an item is added, removed, resized or moved and when the gengrid is resized or gets "horizontal" property changes. - - - - - Gets or sets the item's grid alignment along x-axis within a given gengrid widget. - Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. - By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along x-axis. - - - - - Gets or sets the item's grid alignment on y-axis within a given gengrid widget. - Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. - By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along y-axis. - - - - - Gets or sets the manner in which the items grid is filled within a given gengrid widget. - It is filled if true, otherwise false. - - - - - Gets or sets whether multi-selection is enabled or disabled for a given gengrid widget. - - - Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously. - When it is enabled, a sequence of clicks on different items makes them all selected, progressively. - A click on an already selected item unselects it. If interacting via the keyboard, multi-selection is enabled while holding the "Shift" key. - By default, multi-selection is disabled. - - - - - Gets or sets the width for the items of a given gengrid widget. - - - A gengrid, after creation, still has no information on the size to give to each of its cells. - The default width and height just have one finger wide. - Use this property to force a custom width for your items, making them as big as you wish. - - - - - Gets or sets the height for the items of a given gengrid widget. - - - A gengrid, after creation, still has no information on the size to give to each of its cells. - The default width and height just have one finger wide. - Use this property to force a custom height for your items, making them as big as you wish. - - - - - Gets or sets the gengrid select mode by . - - - - - Gets or sets the direction for which a given gengrid widget expands while placing its items. - - - If true, items are placed in columns from top to bottom and when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. - If false, items are placed in rows from left to right, and when the space for a row is filled, another one is started below, thus expanding the grid vertically. - - - - - Gets or sets whether the gengrid items should be highlighted when an item is selected. - - - - - Sets or gets the value of HorizontalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Sets or gets the value of VerticalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Gets the first item in a given gengrid widget. - - - - - Gets the last item in a given gengrid widget. - - - - - Gets the items count in a given gengrid widget. - - - - - Gets the selected item in a given gengrid widget. - - - - - Gets or sets whether a given gengrid widget is or not able have items reordered. - - - - - Appends a new item to a given gengrid widget. This adds an item to the end of the gengrid. - - The itemClass defines how to display the data. - The item data. - Return a gengrid item that contains data and itemClass. - - - - - - Prepends a new item to a given gengrid widget. This adds an item to the beginning of the gengrid. - - The itemClass defines how to display the data. - The item data. - Return a gengrid item that contains data and itemClass. - - - - - - Inserts an item before another in a gengrid widget. This inserts an item before another in the gengrid. - - The itemClass defines how to display the data. - The item data. - The item before which to place this new one. - Return a gengrid item that contains data and itemClass./> - - - - - - Inserts an item before another in a gengrid widget. This inserts an item after another in the gengrid. - - The itemClass defines how to display the data. - The item data. - The item after which to place this new one. - Return a gengrid item that contains data and itemClass. - - - - - - Insert an item in a gengrid widget using a user-defined sort function. - - The itemClass defines how to display the data. - The item data. - User defined comparison function that defines the sort order based on gengrid item and its data. - Return a gengrid item that contains data and itemClass. - - - - Shows a given item to the visible area of a gengrid. - - The gengrid item to display. - The position of the item in the viewport. - The type of how to show the item. - - If animated is true, the gengrid shows item by scrolling if it's not fully visible. - If animated is false, the gengrid shows item by jumping if it's not fully visible. - - - - - - Updates the contents of all the realized items. - This updates all realized items by calling all the again to get the content, text, and states. - Use this when the original item data has changed and the changes are desired to reflect. - - - to update just one item. - - - - - Removes all items from a given gengrid widget. - This removes(and deletes) all items in obj, making it empty. - - - to delete just one item. - - - - - Get the item that is at the x, y canvas coords. - - The input x coordinate - The input y coordinate - The position relative to the item returned here. - -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1). - - The position relative to the item returned here - -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1). - - - - - - It inherits . - A instance to the gengrid item added. - It contains Update() method to update a gengrid item which is given. - - - - - Gets or sets whether a given gengrid item is selected. - If one gengrid item is selected, any other previously selected items get unselected in favor of this new one. - - - If true, it is selected. - If false, it is unselected. - - - - - Gets or sets the style of given gengrid item's tooltip. - - - - - Gets or sets gengrid item's row position, relative to the whole gengrid's grid area. - - - - - Gets or sets gengrid item's column position, relative to the whole gengrid's grid area. - - - - - Updates the content of a given gengrid item. - This updates an item by calling all the genitem class functions again to get the content, text, and states. - Use this when the original item data has changed and you want the changes to reflect. - - - to update the contents of all the realized items. - - - - - Enumeration for select mode of GenItem. - - - - - Default select mode. - - - - - Always select mode. - - - - - No select mode. - - - - - No select mode with no finger size rule. - - - - - It inherits . - A base class for and . - It contains genitem class and data to display data. - - - - - The delegate returning the tooltip contents. - - - - - Gets the item class that defines how to display data. It returns type. - - - - - It's a abstract property. It's implemented by and . - - - - - Gets item data that is added through calling , or methods. - - - - - It's a abstract property. It's implemented by and . - - - - - It's a abstract property. It's implemented by and . - - - - - It's a abstract method. It's implemented by and . - - - - - The override method for delete item class and item data. It's called when the item is deleting. - - - - - It represents the GenGrid or GenList item class definition field details. - It has some display styles, such as "default", "full" and "group_index". - - - - - The delegate to define . - - The item data. - The part where the data should be shown. - Return string that should be shown. - - - - The delegate to define . - - The item data. - The part where the data should be shown. - Return content that should be shown. - - - - The delegate to define . - - The item data. - - - - The delegate to define . - - The item data. - The part where the data should be shown. - The content has been added in gengrid. - Return content that should be shown. - - - - Creates and initializes a new instance of the GenItemClass. - - The item display style. - - - - Gets the item style. - - - - - Gets or sets the callback that defines how to display item text. - If get, return . - - - - - Gets or sets the callback that defines how to display item content. - If get, return . - - - - - Gets or sets the callback that defines how to delete item text and content. - If get, return . - - - - - Gets or sets the callback that defines how to reuse item content. - If get, return . - - - - - Enumeration for setting genlist item type. - - - - - if Normal is set then this item is normal item. - - - - - If tree is set then this item is displayed as an item that is able to expand and have child items. - - - - - if Group is set then this item is group index item that is displayed at the top until the next group comes. - - - - - Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping. - - - - - The genlist won't set any of its size hints to inform how a possible container should resize it. - Then, if it's not created as a "resize object", it might end with zeroed dimensions. - The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. - - - - - This is the same as Compress, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction. - - - - - Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly). - More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. - This is naturally bound by the genlist object's maximum size hints, set externally. - - - - - Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. - This is naturally bound by the genlist object's maximum size hints, set externally. - - - - - It inherits System.EventArgs. - It contains Item which is type. - All events of GenList contain GenListItemEventArgs as a parameter. - - - - - Gets or sets GenList item. The return type is . - - - - - Enumeration that defines where to position the item in the genlist. - - - - - Scrolls to nowhere. - - - - - Scrolls to the nearest viewport. - - - - - Scrolls to the top of the viewport. - - - - - Scrolls to the middle of the viewport. - - - - - Scrolls to the bottom of the viewport. - - - - - It inherits . - The GenList is a widget that aims to have more expansive list than the simple in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage. - At the same time it was also made to be able to do tree structures. - But the price to pay is more complexity when it comes to usage. - If all you want is a simple list with icons and a single text, use the widget. - - - - - Creates and initializes a new instance of the GenList class. - - The parent is a given container which will be attached by GenList as a child. It's type. - - - - Gets or sets whether the homogeneous mode is enabled. - - - If true, the genlist items have same height and width. - - - - - Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally. - The default value is which means that if items are too wide to fit, the scroller scrolls horizontally. - If set which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it. - If set which means that items are expanded to the viewport width and limited to that size. - if set which means that genlist try to reserve space to all its items to be visible at a time. - - - Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes. - The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast. - However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK). - If so, then some dynamic resizable objects in the genlist would not be diplayed properly. - - - - - Gets the first item in the genlist. - - - - - Gets the last item in the genlist. - - - - - Gets or sets the reorder mode. - After turning on the reorder mode, longpress on a normal item triggers reordering of the item. - You can move the item up and down. However, reordering does not work with group items. - - - - - Gets or set the maximum number of items within an item block. - - - - - Gets or sets whether the genlist items should be highlighted when an item is selected. - - - - - Gets or sets the timeout in seconds for the longpress event. - - - - - Gets or sets whether enable multi-selection in the genlist. - - - - - Gets the selected item in a given genlist widget. - - - - - Gets or sets the genlist select mode by . - - - - - ItemSelected is raised when a new genlist item is selected. - - - - - ItemUnselected is raised when the genlist item is Unselected. - - - - - ItemPressed is raised when a new genlist item is pressed. - - - - - ItemReleased is raised when a new genlist item is released. - - - - - ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar). - - - - - ItemDoubleClicked is raised when a new genlist item is double clicked. - - - - - ItemExpanded is raised when a new genlist item is indicated to expand. - - - - - ItemRealized is raised when a new genlist item is created as a real object. - - - - - ItemUnrealized is raised when a new genlist item is unrealized. - After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache. - - - - - ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second. - - - - - ItemMoved is raised when a genlist item is moved in the reorder mode. - - - - - ItemMovedAfter is raised when a genlist item is moved after another item in the reorder mode. - To get the relative previous item, use . - - - - - ItemMovedBefore is raised when a genlist item is moved before another item in the reorder mode. - To get the relative next item, use . - - - - - Changed is raised when genlist is changed. - - - - - ScrollAnimationStarted is raised when scrolling animation has started. - - - - - ScrollAnimationStopped is raised when scrolling animation has stopped. - - - - - Appends a new item to the end of a given genlist widget. - - The itemClass defines how to display the data. - The item data. - Return a new added genlist item that contains data and itemClass. - - - - - - Appends a new item with to the end of a given genlist widget. - - The itemClass defines how to display the data. - The item data. - The genlist item type. - Return a new added genlist item that contains data and itemClass. - - - - Appends a new item with to the end of a given genlist widget or the end of the children list if the parent is given. - - The itemClass defines how to display the data. - The item data. - The genlist item type. - The parent item, otherwise null if there is no parent item. - Return a new added genlist item that contains data and itemClass. - - - - Prepends a new item to the beginning of a given genlist widget. - - The itemClass defines how to display the data. - The item data. - Return a new added genlist item that contains data and itemClass. - - - - Prepends a new item with to the beginning of a given genlist widget. - - The itemClass defines how to display the data. - The item data. - The genlist item type. - Return a new added genlist item that contains data and itemClass. - - - - Prepends a new item with to the beginning of a given genlist widget or the beginning of the children list if the parent is given. - - The itemClass defines how to display the data. - The item data. - The genlist item type. - The parent item, otherwise null if there is no parent item. - Return a new added genlist item that contains data and itemClass. - - - - Inserts an item before another item in a genlist widget. - It is the same tree level or group as the item before which it is inserted.???? - - The itemClass defines how to display the data. - The item data. - The item before which to place this new one. - Return a new added genlist item that contains data and itemClass. - - - - Inserts an item with before another item in a genlist widget. - It is the same tree level or group as the item before which it is inserted.???? - - The itemClass defines how to display the data. - The item data. - The item before which to place this new one. - The genlist item type. - Return a new added genlist item that contains data and itemClass. - - - - Inserts an item with before another item under a parent in a genlist widget. - - The itemClass defines how to display the data. - The item data. - The item before which to place this new one. - The genlist item type. - The parent item, otherwise null if there is no parent item. - Return a new added genlist item that contains data and itemClass. - - - - Inserts an item with after another item under a parent in a genlist widget. - - The itemClass defines how to display the data. - The item data. - The item after which to place this new one. - The genlist item type. - The parent item, otherwise null if there is no parent item. - Return a new added genlist item that contains data and itemClass. - - - - Insert an item in a genlist widget using a user-defined sort function. - - The itemClass defines how to display the data. - The item data. - User defined comparison function that defines the sort order based on genlist item and its data. - The genlist item type. - The parent item, otherwise null if there is no parent item. - Return a genlist item that contains data and itemClass. - - - - Shows the given item with position type in a genlist. - When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time. - When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible. - - The item to display. - The position to show the given item to . - The animated indicates how to display the item, by scrolling or by jumping. - - - - Updates the content of all the realized items. - This updates all the realized items by calling all the again to get the content, text and states. - Use this when the original item data has changed and the changes are desired to reflect. - To update just one item, use . - - - - - - Removes all items from a given genlist widget. - This removes (and deletes) all items in obj, making it empty. - To delete just one item, use . - - - - - - Get the item that is at the x, y canvas coords. - - The input x coordinate - The input y coordinate - The position relative to the item returned here - -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1). - - - - - - Gets the nth item in a given genlist widget, placed at position nth, in its internal items list. - - The number of the item to grab (0 being the first) - - - - - The type of item's part type. - - - - - All item's parts. - - - - - The text part type. - - - - - The Content part type. - - - - - The state of part. - - - - - No part type. - - - - - It inherits . - A instance to the genlist item added. - It contains Update() method to update a genlist item which is given. - - - - - Gets or sets whether a given genlist item is selected. - - - - - Gets or sets whether a given genlist item is expanded. - - - - - Updates the content of an item. - This updates an item by calling all the again to get the content, text, and states. - Use this when the original item data has changed and the changes are desired to reflect. - To update already realized items, use . - - - - - - Updates the part of an item. - This updates an item's part by calling item's fetching functions again to get the contents, texts and states. - Use this when the original item data has changed and the changes are desired to be reflected. - To update an item's all property, use . - - The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields. - The type of item's part type. - - - - - Demote an item to the end of the list. - - - - - Gets or sets the genlist item's select mode. - - - - - Gets the next item in a genlist widget's internal list of items. - - - - - - Get the previous item in a genlist widget's internal list of items. - - - - - - Gets or sets the style of given genlist item's tooltip. - - - - - Gets or sets whether disable size restrictions on an object's tooltip. - - - - - Gets the index of the item. It is only valid once displayed. - - - - - Gets the depth of expanded item. - - - - - Remove all sub-items (children) of the given item. - - - This removes all items that are children (and their descendants) of the given item it. - - - - - Update the item class of an item. - This sets another class of the item, changing the way that it is displayed. After changing the item class, is called on the item. - - The item class for the item. - The data for the item. - - - - The GestureLayer is used to detect gestures. - Inherits Widget - - - - - Creates and initializes a new instance of GestureLayer class. - - The parent is a given container which will be attached by GestureLayer as a child. It's type. - - - - Enumeration for supported gesture types. - - - - - N fingers single taps - - - - - N fingers single long-taps - - - - - N fingers double-single taps - - - - - N fingers triple-single taps - - - - - Reports momentum in the direction of move - - - - - N fingers line gesture - - - - - N fingers flick gesture - - - - - Zoom - - - - - Rotate - - - - - Enumeration for gesture states. - - - - - Gesture not started - - - - - Gesture started - - - - - Gesture is ongoing - - - - - Gesture completed - - - - - Ongoing gesture is aborted - - - - - Sets or gets the repeat-events setting. - - - - - Sets or gets the gesture layer continues enable of an object - - - - - Sets or gets the gesture layer finger-size for taps. - - - - - Sets or gets the gesture layer long tap start timeout of an object - - - - - Sets or gets the gesture layer double tap timeout of an object - - - - - Sets or gets the gesture layer flick time limit (in ms) of an object - - - - - Sets or gets the gesture layer line min length of an object - - - - - Sets or gets the gesture layer line angular tolerance of an object - - - - - Sets or gets the gesture layer line distance tolerance of an object - - - - - Sets or gets step-value for rotate action. - - - - - Sets or gets the gesture layer rotate angular tolerance of an object - - - - - Sets or gets control step value for zoom action. - - - - - Sets or gets the gesture layer zoom distance tolerance of an object - - - - - Sets or gets the gesture layer zoom finger factor of an object - - - - - Sets or gets the gesture layer zoom wheel factor of an object - - - - - Attach a gesture layer widget to an Evas object (setting the widget's target). - A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events. - - The object to attach. - - - - Set the gesture state change callback. - When all callbacks for the gesture are set to null, it means this gesture is disabled. - - The gesture you want to track state of. - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - clear the gesture state change callback. - - - - - Set the tap callback. - - The gesture you want to track state of. - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Set the gesture state change callback with Momentum Gesture Type - - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Set the gesture state change callback with Line Gesture Type - - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Set the gesture state change callback with Flick Gesture Type - - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Set the gesture state change callback with Zoom Gesture Type - - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Set the gesture state change callback with Rotate Gesture Type - - The event the callback tracks (START, MOVE, END, ABORT). - The callback itself. - - - - Call this function to construct a new gesture-layer object. - - The gesture layer's parent widget. - - - - - clear the gesture state change callback. - - - - - The struct of TapData - - - - - The x coordinate of the center point. - - - - - The y coordinate of the center point. - - - - - The number of fingers tapped. - - - - - The timestamp. - - - - - The struct of MomentumData - - - - - Final-swipe direction starting point on X. - - - - - Final-swipe direction starting point on Y. - - - - - Final-swipe direction ending point on X. - - - - - Final-swipe direction ending point on Y - - - - - Timestamp of start of final x-swipe. - - - - - Timestamp of start of final y-swipe. - - - - - Momentum on X. - - - - - Momentum on Y. - - - - - Number of fingers. - - - - - The struct of LineData - - - - - Final-swipe direction starting point on X. - - - - - Final-swipe direction starting point on Y. - - - - - Final-swipe direction ending point on X. - - - - - Final-swipe direction ending point on Y - - - - - Timestamp of start of final x-swipe. - - - - - Timestamp of start of final y-swipe. - - - - - Momentum on X. - - - - - Momentum on Y. - - - - - Number of fingers. - - - - - Angle (direction) of lines. - - - - - The struct of ZoomData - - - - - The x coordinate of zoom center point reported to user. - - - - - The y coordinate of zoom center point reported to user. - - - - - The radius (distance) between fingers reported to user. - - - - - The zoom value. 1.0 means no zoom. - - - - - Zoom momentum: zoom growth per second (NOT YET SUPPORTED). - - - - - The struct of RotateData - - - - - The x coordinate of rotation center point reported to user. - - - - - The y coordinate of rotation center point reported to user. - - - - - The radius (distance) between fingers reported to user. - - - - - The start-angle. - - - - - The rotation value. 0.0 means no rotation. - - - - - Rotation momentum: rotation done per second (NOT YET SUPPORTED). - - - - - Config is a static class, it provides gestureLayer's timeout information. - - - - - Sets or gets the duration for occurring long tap event of gesture layer. - - - - - Sets or gets the duration for occurring double tap event of gesture layer. - - - - - The HoverselItemEventArgs is an HoverselItem's EventArgs - - - - - Hoversel's Item - - - - - The hoversel is a button that pops up a list of items. - - - - - Creates and initializes a new instance of the Hoversel class. - - The parent is a given container which will be attached by Hoversel as a child. It's type. - - - - Clicked will be triggered when Hoversel is clicked - - - - - Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function - - - - - Dismissed will be triggered when Hoversel Dismissed - - - - - ItemSelected will be triggered when Hoversel's Item Selected - - - - - Gets or sets the status to control whether the hoversel should expand horizontally. - - - - - Gets or sets the hover parent. - - - - - Gets the flag of whether the hoversel is expanded. - - - - - Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically. - - - - - This triggers the hoversel popup from code, the same as if the user had clicked the button. - - - - - This dismisses the hoversel popup as if the user had clicked outside the hover. - - - - - This will remove all the children items from the hoversel. - - - - - Add an item to the hoversel button. - This adds an item to the hoversel to show when it is clicked. - - Item's label - A handle to the added item. - - - - The HoverselItem is the Item of Hoversel - - - - - HoverselItem's label - - - - - ItemSelected will be triggered when HoverselItem Selected - - - - - Enumeration for the icon lookup order. Should look for icons in the theme, FDO paths, or both. - - - - - Icon look up order: freedesktop, theme - - - - - Icon look up order: theme, freedesktop - - - - - Icon look up order: freedesktop - - - - - Icon look up order: theme - - - - - The Icon is a widget that displays standard icon images ("delete", "edit", "arrows", etc.) - or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context. - Inherits Image - - - - - Creates and initializes a new instance of Icon class. - - The parent is a given container which will be attached by Icon as a child. It's type. - - - - Sets or gets the standard icon name of a given Icon widget. - - - - - Sets or gets the icon lookup order of a given Icon widget. - - - - - Sets the file that is used, but uses a generated thumbnail. - - The path to the file that is used as an icon image - The group that the icon belongs to - - - - Adds a new icon object to the parent. - - EvasObject - The new object, otherwise NULL if it cannot be created - - - - The Image is a widget that allows one to load and display an image file on it, - be it from a disk file or from a memory region. - Inherits Widget - - - - - Creates and initializes a new instance of Image class. - - The parent is a given container which will be attached by Image as a child. It's type. - - - - Clicked will be triggered when the image is clicked. - - - - - LoadingCompleted will be triggered when the image is loaded completely. - - - - - Clicked will be triggered when the image is fail to load. - - - - - Gets the file that is used as an image. - - - - - Sets or gets the smooth effect for an image. - - - - - Sets or gets whether scaling is disabled on the object. - - - - - Sets or gets whether the object is down resizeable. - - - - - Sets or gets whether the object is up resizeable. - - - - - Sets or gets whether the image fills the entire object area, when keeping the aspect ratio. - - - - - Sets or gets the prescale size for the image. - - - - - Sets or gets whether the original aspect ratio of the image should be kept on resize. - - - - - Sets or gets whether an image object (which supports animation) is to animate itself. - - - - - Gets whether an image object supports animation. - - - - - Sets or gets whether an image object is under animation. - - - An image object, even if it supports animation, will be displayed by default without animation. - To actually start playing any image object's animation, should be TRUE before setting this property true. - - - - - Sets or gets whether the image is 'editable'. - - - - - Gets the current size of the image. - - - - - Sets or gets whether alpha channel data is being used on the given image object. - - - - - Sets or gets the image orientation. - - - - - Sets or gets the image color - - - - - Sets the background color - - - - - Sets the dimensions for an image object's border, a region which is not scaled together with its center ever. - - The border's left width - The border's right width - The border's top width - The border's bottom width - - - - Sets or gets if the center part of the given image object (not the border) should be drawn. - - - When rendering, the image may be scaled to fit the size of the image object. - This function sets if the center part of the scaled image is to be drawn or left completely blank, or forced to be solid. - Very useful for frames and decorations. - - - - - Sets the file that is used as the image's source. - - The path to the file that is used as an image source - (true = success, false = error) - - - - Sets the uri that is used as the image's source. - - The uri to the file that is used as an image source - (true = success, false = error) - - - - Sets a location in the memory to be used as an image object's source bitmap. - - - This function is handy when the contents of an image file are mapped into the memory, for example. - The format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary). - This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds. - - The binary data that is used as an image source - The size of the binary data blob img - (true = success, false = error) - - - - Sets the stream that is used as the image's source. - - The stream that is used as an image source - (true = success, false = error) - - - - Sets the file that is used as the image's source with async. - - The path to the file that is used as an image source - cancellation token - (true = success, false = error) - - - - Sets the uri that is used as the image's source with async. - - The uri to the file that is used as an image source - cancellation token - (true = success, false = error) - - - - Sets the stream that is used as the image's source with async. - - The stream that is used as an image source - cancellation token - (true = success, false = error) - - - - Sets the color of color class for a given widget. - - The name of color class. - The struct of color - - - - Gets the color of color class for a given widget. - - The name of color class. - color object - - - - Sets the content at a part of a given container widget. - - The parent is a given container which will be attached by Image as a child. It's type. - The new object, otherwise null if it cannot be created - - - - Enumeration for the fill mode of image border - - - - - None mode of image border - - - - - Default mode of image border - - - - - Solid mode of image border - - - - - Enumeration for the possible orientation options - - - - - No orientation change - - - - - Rotate 90 degrees clockwise - - - - - Rotate 180 degrees clockwise - - - - - Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) - - - - - Flip image horizontally - - - - - Flip image vertically - - - - - Flip the image along the y = (width - x) line (bottom-left to top-right) - - - - - Flip the image along the y = x line (top-left to bottom-right) - - - - - An index widget gives you an index for fast access to whichever group of other UI items one might have. - Inherits Layout - - - - - Creates and initializes a new instance of Index class. - - The parent is a given container which will be attached by Index as a child. It's type. - - - - Changed will be triggered when the selected index item is changed. - - - - - Sets or gets the auto hiding feature is enabled or not for a given index widget. - - - - - Sets or gets a value whether horizontal mode is enabled or not. - - - - - Sets or gets the value of indicator's disabled status. - - - - - Sets or gets the omit feature is enabled or not for a given index widget. - - - - - Set a delay change time for index object. - delay time is 0.2 sec by default. - - - - - Gets or sets the items level for a given index widget. - - - - - Control standard_priority group of index. - Priority group will be shown as many items as it can, and other group will be shown one character only. - - - - - Gets the last selected item, for a given index widget. - - - - - Append a new item on a given index widget. - - the label which the item should be indexed - A object to the IndexItem added or null, on errors - - - - Prepend a new item on a given index widget. - - the label which the item should be indexed - A handle to the item added or NULL, on errors - - - - Insert a new item into the index object before item before. - - the label which the item should be indexed - The index item to insert after. - A object to the IndexItem added or null, on errors - - - - Insert a new item into the index object after item after. - - the label which the item should be indexed - The index item to insert after. - A object to the IndexItem added or null, on errors - - - - Flush the changes made to the index items so they work correctly. - - The index level (one of 0 or 1) where changes were made - - - - Removes all items from a given index widget. - - - - - The IndexItem is used to manage index item - Inherits ItemObject - - - - - Creates and initializes a new instance of IndexItem class. - - the text is set to the Text. It's 'string' type. - - - - Selected will be triggered when the index item is selected - - - - - Gets the text - - - - - Sets the selected state of an item. - - The selected state - - - - The ItemObject is used to manage item object - - - - - Creates and initializes a new instance of ItemObject class. - - IntPtr - - - - Gets the id of item object - - - - - Sets or gets whether the item object is enabled - - - - - Gets track object of the item. - - - - - Deleted will be triggered when the item object is deleted - - - - - Delete the item object - - - - - Set a content of an object item and delete old content - - The content part name (null for the default content) - The content of the object item - - - - Set a content of an object item - - The content part name (null for the default content) - The content of the object item - judge whether delete old content - - - - Set a label of an object item - - The text part name (null for the default label) - Text of the label - - - - Gets a label of an object item - - The text part name (null for the default label) - - - - - Sets color of an object item - - The text part name (null for the default label) - the color - - - - Gets color of an object item - - The text part name (null for the default label) - the color of object item - - - - Deletes color of an object item - - The text part name - - - - Add a function for a signal emitted by object item edje. - - The signal's name. - The signal's source. - The function to be executed when the signal is emitted. - - - - Remove a signal-triggered function from a object item edje object. - - The signal's name. - The signal's source. - The function to be executed when the signal is emitted. - - - - Send a signal to the edje object of the widget item. - - The signal's name. - The signal's source. - - - - Gets the handle of object item - - ItemObject - - - - OnInvalidate of object item - - - - - The ItemObjectExtension is used to manage item object extension - - - - - Grab high light of item object - - the item object which is grabbed high light - - - - Clear high light of item object - - the item object which is cleared high light - - - - Label is a widget to display text, with simple html-like markup. - Inherits Layout - - - - - Creates and initializes a new instance of Label class. - - The parent is a given container which will be attached by Label as a child. It's type. - - - - SlideCompleted will be triggered when the slide is completed. - - - - - Sets or gets wrap width of the label. - - - - - Sets or gets the wrapping behavior of the label. - - - - - Sets or gets the slide mode of the label widget. - - - - - Sets or gets the slide duration of the label. - - - - - Sets or gets the slide Speed of the label. - - - The speed of the slide animation in px per seconds. - If you set the duration of the slide using elm_label_slide_duration_set() you cannot get the correct speed using this function until the label is actually rendered and resized. - - - - - - Sets or gets the ellipsis behavior of the label. - - - - - Sets or gets the style of the label text. - - - APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0. - - - - - - Start slide effect. - - - - - Sets the content at a part of a given container widget. - - EvasObject - The new object, otherwise null if it cannot be created - - - - Enumeration for slide mode of a label widget - - - - - no slide effect - - - - - slide only if the label area is bigger than the text width length - - - - - slide always - - - - - This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget. - Inherits Widget - - - - - Creates and initializes a new instance of Layout class. - - The parent is a given container which will be attached by Layout as a child. It's type. - - - - LanguageChanged will be triggered when the program's language is changed. - - - - - ThemeChanged will be triggered when the theme is changed. - - - - - Gets the edje layout. - - - - - Gets or sets accessibility state of texblock(text) parts in the layout object. - - - - - Freezes the Elementary layout object. - This function puts all changes on hold. - Successive freezes will nest, requiring an equal number of thaws. - - The frozen state or 0 if the object is not frozen or on error. - - - - Thaws the Elementary object. - If sucessives freezes were done, an equal number of thaws will be required. - - The frozen state or 0 if the object is not frozen or on error. - - - - Eval sizing. - Manually forces a sizing re-evaluation. - This is useful when the minimum size required by the edje theme of this layout has changed. - The change on the minimum size required by the edje theme is not immediately reported to the elementary layout, so one needs to call this function in order to tell the widget (layout) that it needs to reevaluate its own size. - The minimum size of the theme is calculated based on minimum size of parts, the size of elements inside containers like box and table, etc. - All of this can change due to state changes, and that's when this function should be called. - - - - - Request sizing reevaluation, restricted to current width and/or height. - Useful mostly when there are TEXTBLOCK parts defining the height of the object and nothing else restricting it to a minimum width.Calling this function will restrict the minimum size in the Edje calculation to whatever size it the layout has at the moment. - - Restrict minimum size ot the current width. - Restrict minimum size ot the current height. - - - - Get the edje data from the given layout. - This function fetches data specified inside the edje theme of this layout. - This function return NULL if data is not found. - - The data key - The data - - - - Gets the text set in the given part. - - The TEXT part to retrieve the text off. - - - - - Sets the text set in the given part. - - The TEXT part to retrieve the text off. - The text to set. - - - - - Append child to layout box part. - Once the object is appended, it will become child of the layout. - Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. - - The part - The Object to append - Sucess is true - - - - Prepend child to layout box part. - Once the object is prepended, it will become child of the layout. - Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. - - The part - The Object to prepend - Sucess is true - - - - Remove a child of the given part box. - The object will be removed from the box part and its lifetime will not be handled by the layout anymore. - - The part - The Object to remove - Sucess is true - - - - Remove all children of the given part box. - The objects will be removed from the box part and their lifetime will not be handled by the layout anymore. - - The part - If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas. - Sucess is true - - - - Insert child to layout box part at a given position. - Once the object is inserted, it will become child of the layout. - Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. - - The part - The child object to insert into box. - The numeric position >=0 to insert the child. - Sucess is true - - - - Insert child to layout box part before a reference object. - Once the object is inserted, it will become child of the layout. - Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. - - - The child object to insert into box. - Another reference object to insert before in box. - Sucess is true - - - - Sets the layout content. - - The swallow part name in the edje file - The child that will be added in this layout object. - TRUE on success, FALSE otherwise - - - - Sets the layout content. - - The name of particular part - The content - true, preserve old content will be unset. false, preserve old content will not be unset. - TRUE on success, FALSE otherwise - - - - Sets the edje group from the elementary theme that is used as a layout. - - The class of the group - The group - The style to use - - - - Sets the file that is used as a layout. - - The path to the file (edj) that is used as a layout - The group that the layout belongs to in the edje file - - - - Sets the back ground color of layout - - - - - Sets the vertical text alignment of layout's text part - - - API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0. - - - - - Gets the vertical text alignment of layout's text part - - - API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0. - - - - - Sets the content at a part of a given container widget. - - The parent is a given container which will be attached by Layout as a child. It's type. - The new object, otherwise null if it cannot be created - - - - Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping. - - - - - The list won't set any of its size hints to inform how a possible container should resize it. - Then, if it's not created as a "resize object", it might end with zeroed dimensions. - The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. - - - - - This is the same as Compress, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction. - - - - - Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly). - More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. - This is naturally bound by the list object's maximum size hints, set externally. - - - - - Besides setting a minimum size on the transverse axis, just like on Limit, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. - This is naturally bound by the list object's maximum size hints, set externally. - - - - - It inherits System.EventArgs. - It contains Item which is type. - All events of List contain ListItemEventArgs as a parameter. - - - - - Gets or sets List item. The return type is . - - - - - It inherits . - The List is a widget that aims to display simple list item which has 2 icons and 1 text, and can be selected. - For more robust lists, should probably be used. - - - - - - - Creates and initializes a new instance of the List class. - - The parent is a given container which will be attached by List as a child. It's type. - - - - Gets or sets which mode to use for the list. - - - - - Gets the selected item. - - - - - ItemSelected is raised when a new list item is selected. - - - - - ItemUnselected is raised when the list item is Unselected. - - - - - ItemDoubleClicked is raised when a new list item is double clicked. - - - - - ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second. - - - - - ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar). - - - - - Starts the list. - Call before running on the list object. - If not called, it won't display the list properly. - - - - - Appends a new item with a text to the end of a given list widget. - - The text for the item. - Return a new added list item that contains a text. - - - - - Appends a new item with a text and 2 icons to the end of a given list widget. - - The text for the item. - The left icon for the item. - The right icon for the item. - Return a new added list item that contains a text and 2 icons. - - - - - Prepends a new item with a text to the beginning of a given list widget. - - The text for the item. - Return a new added list item that contains a text. - - - - Prepends a new item with a text and 2 icons to the beginning of a given list widget. - - The text for the item. - The left icon for the item. - The right icon for the item. - Return a new added list item that contains a text and 2 icons. - - - - Removes all items from a given list widget. - To delete just one item, use . - - - - - It inherits . - A instance to the list item added. - It contains Text, LeftIcon and RightIcon properties to show a list item which is given. - - - - - Gets the text for the list item. - - - - - Gets the left icon for the list item. - - - - - Gets the right icon for the list item. - - - - - It inherits . - The MultiButtonEntry is a widget letting an user enter text and each chunk of text managed as a set of buttons. - Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. - When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. - The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions. - - - - - Creates and initializes a new instance of the MultiButtonEntry class. - - The parent is a given container which will be attached by MultiButtonEntry as a child. It's type. - - - - Clicked is raised when a MultiButtonEntry is clicked. - - - - - Expanded is raised when a MultiButtonEntry is expanded. - - - - - Contracted is raised when a MultiButtonEntry is contracted. - - - - - ExpandedStateChanged is raised when shrink mode state of MultiButtonEntry is changed. - - - - - ItemSelected is raised when an item is selected by api, user interaction, and etc. - This is also raised when a user press back space while cursor is on the first field of entry. - - - - - ItemClicked is raised when an item is clicked by user interaction. - - - - - ItemLongPressed is raised when MultiButtonEntry item is pressed for a long time. - - - - - ItemAdded is raised when a new MultiButtonEntry item is added. - - - - - ItemDeleted is raised when a MultiButtonEntry item is deleted. - - - - - Gets the selected item in the multibuttonentry. - - - - - Gets or sets whether the multibuttonentry is editable or not. - - - - - Gets or sets the multibuttonentry to expanded state. - If true, expanded state. - If false, single line state. - - - - - Gets the first item in the multibuttonentry. - - - - - Gets the last item in the multibuttonentry. - - - - - Gets the entry object int the multibuttonentry. - - - - - Append a new item to the multibuttonentry. - - The label of new item. - A MultiButtonEntryItem to the item added. - - - - Prepend a new item to the multibuttonentry. - - The label of new item. - A MultiButtonEntryItem to the item added. - - - - Add a new item to the multibuttonentry before the indicated object reference. - - The item before which to add it. - The label of new item. - A MultiButtonEntryItem to the item added. - - - - Add a new item to the multibuttonentry after the indicated object. - - The item after which to add it. - The label of new item. - A MultiButtonEntryItem to the item added. - - - - Remove all items in the multibuttonentry. - - - - - Append an item filter function for text inserted in the Multibuttonentry. - - The function to use as item filter. - - - - Prepend a filter function for text inserted in the Multibuttonentry. - - The function to use as text filter. - - - - Remove a filter from the list. - - The filter function to remove. - - - - Set a function to format the string that will be used to display the hidden items counter. - If func is NULL, the default format will be used, which is "+ 'the hidden items counter'". - - The function to return string to show - - - - It inherits System.EventArgs. - The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry. - It contains Item which is type. - - - - - Gets or sets MultiButtonEntryItem item. The return type is . - - - - - It inherits . - MutltiButtonEntryItem is a item which is added to MultiButtonEntry. - It contains Next and Prev properties to get next and previous item. - - - - - Creates and initializes a new instance of the MultiButtonEntryItem class. - - The text of MultiButtonEntryItem's Label name. - - - - Gets the label of this item. - - - - - Gets or sets the selected state of an item. - - - - - Get the next item in the multibuttonentry. - - - - - Get the previous item in the multibuttonentry. - - - - - The NaviframeEventArgs is a event args class for navi frame. - Inherits EventArgs - - - - - Sets or gets the content object. The name of content part is "elm.swallow.content". - - - - - Naviframe is a widget to stands for navigation frame. It's a views manager for applications. - Inherits Widget - - - - - Creates and initializes a new instance of Naviframe class. - - The parent is a given container which will be attached by Naviframe as a child. It's type. - - - - Popped will be triggered when NaviItem is removed. - - - It is always called when NaviItem was removed. - (even if removed by NaviItem.Delete()) - This event will be invoked in progress of Pop/Delete operation. - After called Popped event, Pop/Delete method will be returned - - - - - AnimationFinished will be triggered when animation is finished. - - - - - Gets the list of navi item - - - - - Sets or gets the the preserve content objects when items are popped. - - - - - Sets or gets whether the default back button is enabled - - - - - Push a new item to the top of the naviframe stack and show it. - The title and style are null. - - The main content object. The name of content part is "elm.swallow.content". - The created item or null upon failure. - - - - Push a new item to the top of the naviframe stack and show it. - The style are null. - - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - - - - - Push a new item to the top of the naviframe stack and show it. - - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - The current item style name. null would be default. - The created item or null upon failure. - - - - Insert a new item into the naviframe before item. - The title is "" and the style is null. - - The item which the new item is inserted before. - The main content object. The name of content part is "elm.swallow.content". - The created item or null upon failure. - - - - Insert a new item into the naviframe before item. - The style is null. - - The item which the new item is inserted before. - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - The created item or null upon failure. - - - - Insert a new item into the naviframe before item. - - The item which the new item is inserted before. - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - The current item style name. null would be default. - The created item or null upon failure. - - - - Insert a new item into the naviframe after item. - The title is "" and the style is null. - - The item which the new item is inserted after. - The main content object. The name of content part is "elm.swallow.content". - The created item or null upon failure. - - - - Insert a new item into the naviframe after item. - The style is null. - - The item which the new item is inserted after. - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - The created item or null upon failure. - - - - Insert a new item into the naviframe after item. - - The item which the new item is inserted after. - The main content object. The name of content part is "elm.swallow.content". - The current item title. null would be default. - The current item style name. null would be default. - The created item or null upon failure. - - - - Pop an item that is on top of the stack. - - - - - The NaviItem is a widget to contain the contents to show in Naviframe. - Inherits ItemObject - - - - - Popped will be triggered when NaviItem is removed. - - - - - Gets the content object. The name of content part is "elm.swallow.content". - - - - - Sets or gets a value whether title area is enabled or not. - - - - - Sets or gets the title bar background color - - - - - Sets or gets an item style. - - - - - Invalidate the EventArgs if _isPopped is false. - The method should be overridden in children class. - - - - - Enumeration for paneldirection type. - - - - - Top to bottom - - - - - Bottom to top - - - - - Left to right - - - - - Right to left - - - - - The Panel is a container that can contain subobjects. - - - - - Creates and initializes a new instance of Panel class. - - The EvasObject to which the new Panel will be attached as a child. - - - - Sets or gets the hidden status of a given Panel widget. - - - - - Sets or gets the direction of a given Panel widget. - - - - - Toggled will be triggered when toggles Panel. - - - - - Enable or disable scrolling in the Panel. - - - Bool value can be false or true. - - - - - Sets the scroll size of Panel. - - - The size of scroll area. - - - - - Toggles the hidden state of the Panel. - - - - - The Panes is a widget that adds a draggable bar between two contents. - When dragged this bar resizes contents' size. - - - - - Creates and initializes a new instance of the Panes class. - - The EvasObject to which the new Panes will be attached as a child. - - - - Pressed will be triggered when panes have been pressed (button isn't released yet). - - - - - Unpressed will be triggered when panes are released after being pressed. - - - - - Sets or gets resize mode of a given Panes widget. - True means the left and right panes resize homogeneously. - - - - - Sets or Gets the size proportion of the Panes widget's left side. - - - By default it's homogeneous, i.e., both sides have the same size.If something different is required, - it can be set with this function. For example, if the left content should be displayed over 75% of the panes size, - size should be passed as 0.75. This way, the right content is resized to 25% of the panes size. - If displayed vertically, left content is displayed at the top, and right content at the bottom. - This proportion changes when the user drags the panes bar. - - The value is float type and between 0.0 and 1.0 representing the size proportion of the left side. - - - - - Sets or gets the orientation of a given Panes widget. - - - Use this function to change how your panes is to be disposed: vertically or horizontally. - Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents. - By default panes is in a vertical mode. - - - - - Sets or gets the absolute minimum size of panes widget's left side. - If displayed vertically, left content is displayed at top. - value representing minimum size of left side in pixels. - - - - - Sets or gets the relative minimum size of panes widget's left side. - proportion of minimum size of left side. - If displayed vertically, left content is displayed at top. - value between 0.0 and 1.0 representing size proportion of minimum size of left side. - - - - - Sets or gets the absolute minimum size of panes widget's right side. - If displayed vertically, right content is displayed at top. - value representing minimum size of right side in pixels. - - - - - Sets or gets the relative minimum size of panes widget's right side. - proportion of minimum size of right side. - If displayed vertically, right content is displayed at top. - value between 0.0 and 1.0 representing size proportion of minimum size of right side. - - - - - The Point is a struct that defines a 2-D point as a pair of generic type. - - - - - Location along the horizontal axis. - - - - - Location along the vertical axis. - - - - - Whether the two s are equal. - - A on the left hand side. - A on the right hand side. - True if the two s have equal values. - - - - Whether two s are not equal. - - A on the left hand side. - A on the right hand side. - True if the two s do not have equal values. - - - - The Point3D is a Struct that defining a 3-D point. - - - - - The X coordinate of a 3D point. - - - - - The Y coordinate of a 3D point. - - - - - The Z coordinate of a 3D point. - - - - - Whether the two s are equal. - - A on the left hand side. - A on the right hand side. - True if the two s have equal values. - - - - Whether two s are not equal. - - A on the left hand side. - A on the right hand side. - True if the two s do not have equal values. - - - - The Polygon is a widget that used to draw a polygon (filled). - - - - - Creates and initializes a new instance of the Polygon class. - The EvasObject to which the new Polygon will be attached as a child. - - - - - Adds a new vertex to the Polygon. - The X coordinate of the new vertex. - The Y coordinate of the new vertex. - - - - - Adds a new vertex to the Polygon. - The coordinates of the new vertex. - - - - - Removes all the vertices of the Polygon, making it empty. - - - - - Enumeration for the popup orientation type. - - - - - Appears in the top of parent, default. - - - - - Appears in the center of parent. - - - - - Appears in the bottom of parent. - - - - - Appears in the left of parent. - - - - - Appears in the right of parent. - - - - - Appears in the top left of parent. - - - - - Appears in the top right of parent. - - - - - Appears in the bottom left of parent. - - - - - Appears in the bottom right of parent. - - - - - The Popup is a widget that is an enhancement of Notify. - In addition to content area, there are two optional sections, namely title area and action area. - - - - - Creates and initializes a new instance of the Popup class. - - The EvasObject to which the new Popup will be attached as a child. - - - - Dismissed will be triggered when Popup have been dismissed. - - - - - OutsideClicked will be triggered when users taps on the outside of Popup. - - - - - OutsideClicked will be triggered when Popup is closed as a result of timeout. - - - - - OutsideClicked will be triggered when the Popup transition is finished in showing. - - - - - Sets or gets the position in which Popup will appear in its parent. - - - - - Sets or gets the wrapping type of content text packed in content area of Popup widget. - - - - - - Sets or gets whether events should be passed to event blocked area by a click outside. - - - The visible region of popup is surrounded by a translucent region called Blocked Event area. - - - - - Sets or gets the AlignmentX in which the popup will appear in its parent. - - - - - Sets or gets the AlignmentY in which the popup will appear in its parent. - - - - - Gets the Opacity value of the Popup. - - - - - Adds label to a Popup widget. - - - The new PopupItem which contains label . - - - - Adds Label and icon to a Popup widget. - - The Label which will be added into a new PopupItem. - The icon which will be added into a new PopupItem. - The new PopupItem which contains label and icon. - - - - Uses this function to dismiss the popup in hide effect. - when the Popup is dismissed, the "dismissed" signal will be emitted. - - - - - The PopupItem is a class that including icon and text. - - - - - Gets the text label of popupitem.Return value is string. - - - - - Gets the icon EvasObject of popupitem. - - - - - The ProgressBar is a widget for visually representing the progress status of a given job/task. - - - - - Creates and initializes a new instance of the ProgressBar class. - - The EvasObject to which the new ProgressBar will be attached as a child. - - - - ValueChanged will be triggered when value of ProgressBar change. - - - - - Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode". - - - By default, progress bars display values from low to high value boundaries. - There are, though, contexts in which the progress of a given task is unknown. - For such cases, one can set a progress bar widget to a "pulsing state", - to give the user an idea that some computation is being held, - but without exact progress values. In the default theme, - it animates its bar with the contents filling in constantly and back to non-filled, in a loop. - - - - - Sets or gets the value of ProgressBar. - - - Use this property to set the progress bar levels. - If you pass a value out of the specified range(0.0~1.0), - it is interpreted as the closest of the boundary values in the range. - - - - - Sets or gets the span value of ProgressBar. - - - - - Sets or gets the value wheather a given ProgressBar widget is horizontal. - - - - - Sets or gets the value whether a given progress bar widget's displaying values are inverted. - - - - - Sets or gets format string for a given progress bar widget's units label. - - - If NULL is passed on format, it makes obj units area to be hidden completely. - If not, it sets the format string for the units label's text. - The units label is provided with a floating point value, so the units text displays at most one floating point value. - Note that the units label is optional. Use a format string such as "%1.2f meters" for example. - - - - - Starts a given progress bar "pulsing" animation, if its under that mode. - - - - - Stops a given progress bar "pulsing" animation, if its under that mode. - - - - - Gets the part value of the given part of the Progressbar. - - Part of the Progressbar. - Returns value range is from 0.0 to 1.0. - - - - Sets or gets the general or main color of the given Progressbar. - - - - - Sets the part value of the give part of the Progressbar. - - Part of the Progressbar. - Value range is from 0.0 to 1.0. - - - - The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them. - - - - - Creates and initializes a new instance of the Radio class. - - The EvasObject to which the new Radio will be attached as a child. - - - - ValueChanged will be triggered when value of Radio change. - - - - - Sets or gets a unique value to each Radio button. - - - - - Sets or gets the value of the radio group. - - - - - Adds this radio to a group of other radio objects. - - Group which add radio in. - - - - The Rect is a struct that represent rectangluar space. - - - - - Creates and initializes a new instance of the Rect class. - - X axis value. - Y axis value. - Width value. - Height value. - - - - Gets or sets the position of this Rectangle on the X axis. - - - - - Gets or sets the position of this Rectangle on the Y axis. - - - - - Gets or sets the width of this Rectangle. - - - - - Gets or sets the height of this Rectangle. - - - - - Gets the position of this Rectangle on the X axis. - - - - - Gets the extent along the X axis. - - - - - Gets the position of this Rectangle on the Y axis. - - - - - Gets the extent along the Y axis. - - - - - Gets the Point defined by Rectangle.Left and Rectangle.Top. - - - - - Gets the extent of the Rectangle along its X and Y axis. - - - - - Whether the two s are equal. - - A on the left hand side. - A on the right hand side. - True if the two s have equal values. - - - - Whether two s are not equal. - - A on the left hand side. - A on the right hand side. - True if the two s do not have equal values. - - - - The Rectangle is a class that used to draw a solid colored rectangle. - - - - - Creates and initializes a new instance of the Rectangle class. - - The to which the new Slider will be attached as a child. - - - - Enumeration for visible type of scrollbar. - - - - - Show scrollbars as needed - - - - - Always show scrollbars - - - - - Never show scrollbars - - - - - Enumeration for visible type of scrollbar. - - - - - Scrolling movement is allowed in both direction.(X axis and Y axis) - - - - - Scrolling movement is not allowed in Y axis direction. - - - - - Scrolling movement is not allowed in X axis direction. - - - - - Type that controls how the content is scrolled. - - - - - Scroll every direction. - - - - - Scroll single direction if the direction is certain. - - - - - Scroll only single direction. - - - - - The Scroller is a container that holds and clips a single object and allows you to scroll across it. - - - - - Creates and initializes a new instance of the Scroller class. - - The to which the new Scroller will be attached as a child. - - - - Scrolled will be triggered when the content has been scrolled. - - - - - DragStart will be triggered when dragging the contents around has started. - - - - - DragStop will be triggered when dragging the contents around has stopped. - - - - - PageScrolled will be triggered when the visible page has changed. - - - - - Gets the current region in the content object that is visible through the Scroller. - - - - - Sets or gets the value of HorizontalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Sets or gets the value of VerticalScrollBarVisiblePolicy - - - ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. - ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. - - - - - Sets or gets the value of ScrollBlock. - - - This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both. - The default value is ScrollBlock.None, where movements are allowed in both directions. - - - - - Sets or gets scroll current page number. - - - Current page means the page which meets the top of the viewport. - If there are two or more pages in the viewport, it returns the number of the page which meets the top of the viewport. - The page number starts from 0. 0 is the first page. - - - - - Sets or gets scroll current page number. - - - Current page means the page which meets the left of the viewport. - If there are two or more pages in the viewport, it returns the number of the page which meets the left of the viewport. - The page number starts from 0. 0 is the first page. - - - - - Sets or gets the maximum limit of the movable page at vertical direction. - - - - - Sets or gets the maximum limit of the movable page at horizontal direction. - - - - - Sets or gets the vertical bounce behaviour. - When scrolling, the scroller may "bounce" when reaching an edge of the content object. - This is a visual way to indicate the end has been reached. - This is enabled by default for both axis. - This API will set if it is enabled for the given axis with the boolean parameters for each axis. - - - - - Sets or gets the horizontal bounce behaviour. - When scrolling, the scroller may "bounce" when reaching an edge of the content object. - This is a visual way to indicate the end has been reached. - This is enabled by default for both axis. - This API will set if it is enabled for the given axis with the boolean parameters for each axis. - - - - - Gets the width of the content object of the scroller. - - - - - Gets the height of the content object of the scroller. - - - - - Set scrolling gravity values for a scroller. - The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. - The scroller will adjust the view to glue itself as follows. - x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content - Default values for x and y are 0.0 - - - - - Set scrolling gravity values for a scroller. - The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. - The scroller will adjust the view to glue itself as follows. - x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content - Default values for x and y are 0.0 - - - - - Get scroll last page number. - The page number starts from 0. 0 is the first page. This returns the last page number among the pages. - - - - - Get scroll last page number. - The page number starts from 0. 0 is the first page. This returns the last page number among the pages. - - - - - Set an infinite loop_ for a scroller. - This function sets the infinite loop vertically. - If the content is set, it will be shown repeatedly. - - - - - Set an infinite loop_ for a scroller. - This function sets the infinite loop horizontally. - If the content is set, it will be shown repeatedly. - - - - - Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. - - - - - Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. - - - - - Gets or Sets the page snapping behavior of a scroller. - - - When scrolling, if a scroller is paged (see VerticalRelativePageSize), - the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further, - it will stop at the next page boundaries. This is disabled, by default, for both axis. - This function will set if it that is enabled or not, for each axis. - - - - - Gets or Sets the page snapping behavior of a scroller. - - - When scrolling, if a scroller is paged (see HorizontalRelativePageSize), - the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further, - it will stop at the next page boundaries. This is disabled, by default, for both axis. - This function will set if it that is enabled or not, for each axis. - - - - - Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. - - - - - Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. - - - - - Gets or sets the event propagation for a scroller. - This enables or disables event propagation from the scroller content to the scroller and its parent. - By default event propagation is enabled. - - - - - Gets or sets the step size to move scroller by key event. - - - - - Gets or sets the step size to move scroller by key event. - - - - - Gets or sets a value whether mouse wheel is enabled or not over the scroller. - - - - - Gets or sets the type of single direction scroll. - - - - - Sets the scroller minimum size limited to the minimum size of the content. - By default the scroller will be as small as its design allows, irrespective of its content. - This will make the scroller minimum size the right size horizontally and/or vertically to perfectly fit its content in that direction. - - Enable limiting minimum size horizontally - Enable limiting minimum size vertically - - - - Sets the page size to an absolute fixed value, with 0 turning it off for that axis. - - The horizontal page size. - The vertical page size. - - - - Sets the scroll page size relative to the viewport size. - - - The scroller is capable of limiting scrolling by the user to "pages". - That is to jump by and only show a "whole page" at a time as if the continuous area of the scroller - content is split into page sized pieces. This sets the size of a page relative to the viewport of the scroller. - 1.0 is "1 viewport" which is the size (horizontally or vertically). 0.0 turns it off in that axis. - This is mutually exclusive with the page size (see elm_scroller_page_size_set() for more information). - Likewise 0.5 is "half a viewport". Usable values are normally between 0.0 and 1.0 including 1.0. - If you only want 1 axis to be page "limited", use 0.0 for the other axis. - - The horizontal page relative size. - The vertical page relative size. - - - - Shows a specific virtual region within the scroller content object by the page number. - (0, 0) of the indicated page is located at the top-left corner of the viewport. - - The horizontal page number. - The vertical page number. - True means slider with animation. - - - - Shows a specific virtual region within the scroller content object. - - - This ensures that all (or part, if it does not fit) of the designated region in the virtual content object ((0, 0) - starting at the top-left of the virtual content object) is shown within the scroller. - If set "animated" to true, it will allows the scroller to "smoothly slide" to this location - (if configuration in general calls for transitions). - It may not jump immediately to the new location and may take a while and show other content along the way. - - Rect struct of region. - True means allows the scroller to "smoothly slide" to this location. - - - - The Size is a struct that defining height and width as a pair of generic type. - - - - - Magnitude along the horizontal axis, in platform-defined units. - - - - - Magnitude along the vertical axis, in platform-specific units. - - - - - Initializes a new instance of the Size structure from the specified dimensions. - - The width to set - The height to set - - - - A human-readable representation of the . - - The string is formatted as "{{Width={0} Height={1}}}". - - - - Whether the two s are equal. - - A on the left hand side. - A on the right hand side. - True if the two s have equal values. - - - - Whether two s are not equal. - - A on the left hand side. - A on the right hand side. - True if the two s do not have equal values. - - - - Enumeration for the Slider's indicator visiblity mode. - - - - - Show indicator on mouse down or change in slider value. - - - - - Always show the indicator. - - - - - Show the indicator on focus. - - - - - Never show the indicator. - - - - - The Slider is a widget that adds a draggable slider widget for selecting the value of something within a range. - - - - - Creates and initializes a new instance of the Slider class. - - The to which the new Slider will be attached as a child. - - - - ValueChanged will be triggered when the Slider value is changed by the user. - - - - - DelayedValueChanged will be triggered when a short time after the value is changed by the user. - This will be called only when the user stops dragging for a very short period or when they release their finger/mouse, - so it avoids possibly expensive reactions to the value change. - - - - - DragStarted will be triggered when dragging the Slider indicator around has started. - - - - - DragStopped will be triggered when dragging the Slider indicator around has stopped. - - - - - Sets or gets the (exact) length of the bar region of a given Slider widget. - - - This sets the minimum width (when in the horizontal mode) or height (when in the vertical mode) - of the actual bar area of the slider obj. This in turn affects the object's minimum size. - Use this when you're not setting other size hints expanding on the given direction - (like weight and alignment hints), and you would like it to have a specific size. - - - - - Sets or gets the format string for the indicator label. - - - The slider may display its value somewhere other than the unit label, - for example, above the slider knob that is dragged around. This function sets the format string - used for this.If NULL, the indicator label won't be visible. If not, it sets the format string - for the label text. For the label text floating point value is provided, so the label text can - display up to 1 floating point value. Note that this is optional.Use a format string - such as "%1.2f meters" for example, and it displays values like: "3.14 meters" for a value - equal to 3.14159.By default, the indicator label is disabled. - - - - - Sets or gets the orientation of a given slider widget. - - - The orientation may be vertically or horizontally.By default, it's displayed horizontally. - - - - - Sets or gets the minimum values for the slider. - - - This defines the allowed minimum values to be selected by the user. - If the actual value is less than min, it is updated to min. - Actual value can be obtained with Value.By default, min is equal to 0.0. - - - - - Sets or gets the maximum values for the slider. - - - This defines the allowed maximum values to be selected by the user. - If the actual value is bigger then max, it is updated to max. - Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. - Maximum must be greater than minimum, otherwise the behavior is undefined. - - - - - Gets or sets the value displayed by the slider. - - - Value will be presented on the unit label following format specified with UnitFormat and - on indicator with IndicatorFormat.The value must to be between Minimum and Maximum values. - - - - - Sets or gets the step by which the slider indicator moves. - - - This value is used when the draggable object is moved automatically i.e., - in case of a key event when up/down/left/right key is pressed or in case accessibility - is set and the flick event is used to inc/dec slider values. - By default, the step value is equal to 0.05. - - - - - Gets or sets whether a given slider widget's displaying values are inverted. - - - A slider may be inverted, in which case it gets its values inverted, - with high values being on the left or top and low values on the right or bottom, - as opposed to normally have the low values on the former and high values on the latter, - respectively, for the horizontal and vertical modes. - - - - - Sets or gets whether to enlarge the slider indicator (augmented knob). - - - By default, the indicator is bigger when dragged by the user. - It won't display values set with IndicatorFormat if you disable the indicator. - - - - - Sets or gets the visible mode of slider indicator. - - - - - Sets or gets whether to Show the indicator of slider on focus. - - - - - It inherits . - The event with TEventArgs for . - EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. - This way, you can extend EvasObject's own . - They are defined by an event string, which identifies them uniquely. - - The parameter for the event. - - - - The delegate for creating smart event item args. - - The item data. - The sender obj. - The item sender obj. - Return smart event item args. - - - - Creates and initializes a new instance of the SmartEvent class. - - The source of the event. - The event name. - The event parameter. - - - - Creates and initializes a new instance of the SmartEvent class. - - The source of the event. - The event name. - - - - Adds or removes delegate for event. - - - - - Make current instance invalidate. - - - - - It inherits . - EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. - This way, you can extend EvasObject's own . - They are defined by an event string, which identifies them uniquely. - - The parameter for the event. - - - - Creates and initializes a new instance of the SmartEvent class. - - The source of the event. - The event name. - - - - Adds or removes delegate for event. - - - - - Make current instance invalidate. - - - - - The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly. - Inherits . - - - - - Creates and initializes a new instance of the Spinner class. - - The parent of new Spinner instance - - - - ValueChanged will be triggered whenever the spinner value is changed. - - - - - DelayedValueChanged will be triggered after a short time when the value is changed. - - - - - Sets or gets the label format of the spinner. - - - - - Sets or gets the minimum value for the spinner. - - - - - Sets or gets the maximum value for the spinner. - - - - - Sets or gets the step that used to increment or decrement the spinner value. - - - - - Sets or gets the value displayed by the spinner. - - - - - Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows. - - - - - Sets or gets the base for rounding. - - - - - Sets or gets the round value for rounding. - - - - - Sets or gets the wrap of a given spinner widget. - - - If wrap is disabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the maximum value. - If wrap is enabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the minimum value. - By default it's disabled. - - - - - Sets or gets whether the spinner can be directly edited by the user or not. - - By default it is enabled - - - - Set a special string to display in the place of the numerical value. - - The numerical value to be replaced - The label to be used - - - - Remove a previously added special value, After this, the spinner will display the value itself instead of a label. - - The replaced numerical value - - - - Get the special string display in the place of the numerical value. - - The replaced numerical value. - The value of the spinner which replaced numerical value with special string - - - - The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows . - Inherits . - - - - - Creates and initializes a new instance of the Table class. - - - A to which the new Table instance will be attached. - - - - - Sets or gets whether the layout of this table is homogeneous. - - True for homogeneous, False for no homogeneous - - - - Sets or gets the horizontal padding between the cells. - - - - - Sets or gets the vertical padding between the cells. - - - - - Adds a subobject on the table with the coordinates passed. - - The subobject to be added to the table - The column number - The row number - The column span - The row span - - - - Removes the child from the table. - - The subobject - - - - Removes all child objects from a table object. - - - - - Sets the color for particular part of the table. - - The name of part class - The color - - - - Gets the color of particular part of the table. - - The name of part class, it could be 'bg', 'elm.swllow.content' - The color of the particular part - - - - Enumeration for the selection mode of Toolbar. - - - - - Default select mode. - - - - - Always select mode. - - - - - No select mode. - - - - - No select mode with no finger size rule. - - - - - Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them. - - - - - Sets minimum toolbar size to fit all the items. - - - - - Hides exceeding items. - - - - - Allows accessing exceeding items through a scroller. - - - - - Inserts a button to pop up a menu with exceeding items. - - - - - Expands all items according to the size of the toolbar. - - - - - Enumeration for the icon lookup order of Toolbar. - - - - - Icon look up order: freedesktop, theme. - - - - - Icon look up order: theme, freedesktop. - - - - - Icon look up order: freedesktop. - - - - - Icon look up order: theme. - - - - - Event arguments for events of . - - - Inherits EventArgs. - - - - - Gets the ToolbarItem. - - - - - The Toolbar is a widget that displays a list of items inside a box. - - - - - Creates and initializes a new instance of the Toolbar class. - - - A EvasObject to which the new Table instance will be attached. - - - - - Selected will be triggered when toolbar have been selected. - - - - - Sets or gets whether the layout of this toolbar is homogeneous. - - True for homogeneous, False for no homogeneous - - - - Sets or gets the slection mode of a given Toolbar widget. - - - - - Sets or gets the shrink mode of a given Toolbar widget. - - - - - Sets or gets the icon lookup order, for toolbar items' icons. - The default lookup order is ToolbarIocnLookupOrder.ThemeFreedesktop. - Icons added before calling this function will not be affected. - - - - - Sets or gets the icon size of a given toolbar widget. - Default value is 32 pixels, to be used by toolbar items. - - - - - Gets the number of items in a toolbar widget. - - - - - Sets or gets the alignment of the items. - - The toolbar items alignment, a float between 0.0 and 1.0 - - - - Sets or gets the item's transverse expansion of a given toolbar widget. - - - The transverse expansion of the item, true for on and false for off. - By default it's false. - - - - - Appends ToolbarItem which just contains label to the toolbar. - - The label of the item - The new ToolbarItem which appended to the toolbar - - - - - - Appends ToolbarItem which contains label and icon to the toolbar. - - The label of the item - A string with the icon name or the absolute path of an image file - The new ToolbarItem which appended to the toolbar - - - - - - - Prepends ToolbarItem which just contains label to the toolbar. - - The label of the item - The new ToolbarItem which prepended to the toolbar - - - - - - - Prepends ToolbarItem which contains label and icon to the toolbar. - - The label of the item - A string with the icon name or the absolute path of an image file - The new which prepended to the toolbar - - - - - - - Inserts a new item which just contains label into the toolbar object before item . - - The toolbar item to insert before - The label of the item - The new which insert into the toolbar - - - - - Inserts a new item which contains label and icon into the toolbar object before item . - - The toolbar item to insert before - The label of the item - A string with the icon name or the absolute path of an image file - The new which insert into the toolbar - - - - - Inserts a new item which contains label and icon into the toolbar object after item . - - The toolbar item to insert after - The label of the item - A string with the icon name or the absolute path of an image file - The new which insert into the toolbar - - - - - Find the item with that label in the toolbar. - - The label of the item - The into the toolbar - - - - Gets the selected ToolbarItemItem of the toolbar. - - - - - Gets the first ToolbarItemItem of the toolbar. - - - - - Gets the last ToolbarItemItem of the toolbar. - - - - - The ToolbarItem is a item of Toolbar. - - - - - Sets or gets the icon path of the item. - - - - - Sets or gets the text string of the item. - - - - - Sets or gets the enable of the item. - - - - - Sets or gets whether displaying the item as a separator. - - Items aren't set as a separator by default. If set as a separator it displays a separator theme, so it won't display icons or labels. - - - - Sets or gets whether the item is selected. - - - - - Selected will be triggered when the item is selected. - - - - - LongPressed will be triggered when the item is pressed long time. - - - - - Clicked will be triggered when the item is clicked. - - - - - Transit is designed to apply various animated transition effects, such like translation, rotation, etc. - For using these effects, create an Transit and add the desired transition effects. - - Transit is not reusable. If the effect ends, the transit is destroyed automatically. - - - - A callback called when the transit is deleted. - - - - - Creates and initializes a new instance of Transit class. - - - - - Gets or sets the transit animation time - - - - - Gets or sets a value whether the objects states will be keep or not. - If it is not kept, the objects states will be reset when transition ends. - - - - - Gets or sets the transit animation acceleration type. - - - - - Gets or sets the transit repeat count. - If the repeat is a negative number, it will repeat infinite times. - - - - - Gets or sets if the auto reverse is on. - - - - - Gets or sets the event enabled when transit is operating. - - - - - Gets or sets the smooth scaling for transit map rendering - This gets smooth scaling for transit map rendering. - - - - - Get the time progression of the animation (a double value between 0.0 and 1.0). - The value returned is a fraction(current time / total time). - It represents the progression position relative to the total. - - - - - Gets or sets the transit animation tween mode acceleration factor. - - A factor value from 0.0 to 1.0. - - - - Gets or sets the transit animation tween mode acceleration factor. - - A factor value from 0.0 to 1.0. - - - - Starts the transition in given seconds. - Once this API is called, the transit begins to measure the time. - - The interval value in seconds - - - - Pause the transition. - - - - - Resume the transition. - - - - - Get the current chained transit list. - - Cannot add the duplicate transit. - - - - Get the objects list of the transit. - - Cannot add the duplicate object. - - - - Add the effect. - - EffectBase object. - - - - Add new object to apply the effects. - After the first addition of an object to transit, if its object list become empty again, the transit will be killed. - If the obj belongs to another transit, the obj will be removed from it and it will only belong to the other transit. - - It is not allowed to add a new object after transit begins. - Object to be animated. - - - - Removes an added object from the transit. - - Object to be removed from transit. - - - - Makes the chain relationship between two transits. - - The chain transit object. This transit will be operated after transit is done. - - - - Cut off the chain relationship between two transits. - - The chain transit object. - - - - The axis along which flip effect should be applied. - - - - - Flip on X axis - - - - - Flip on Y axis - - - - - The direction in which the wipe effect should occur. - - - - - Wipe to the left - - - - - Wipe to the right - - - - - Wipe to the up - - - - - Wipe to the down - - - - - Whether the wipe effect should show or hide the object. - - - - - Hide the object during the animation - - - - - Show the object during the animation - - - - - The type of acceleration used in the transition. - - - - - Constant speed - - - - - Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor - - - - - Starts fast and decrease speed over time, v1 being a power factor - - - - - Starts slow and increase speed over time, v1 being a power factor - - - - - Start at gradient v1, interpolated via power of v2 curve - - - - - Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1 - - - - - Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1 - - - - - Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2) - - - - - Blend effect class. - - - - - Creates and initializes a new instance of BlendEffect class. - - - - - Color effect class. - - - - - Creates and initializes a new instance of ColorEffect class. - - The begin color of the effect - The end color of the effect - - - - The begin color of the effect - - - - - The end color of the effect - - - - - Fade effect class. - - - - - Creates and initializes a new instance of FadeEffect class. - - - - - Flip effect class. - - - - - Creates and initializes a new instance of FlipEffect class. - - Flipping Axis(X or Y). - Flipping Direction. True is clock-wise. - Resizable effect with FlipEffect - - - - Flipping Axis(X or Y). - - - - - Flipping Direction. True is clock-wise. - - - - - Resizable FlipEffect. - - - - - Resizing effect class. - - - - - Creates and initializes a new instance of FlipEffect class. - - The begin Size of the effect - The end Size of the effect - - - - The begin Size of the effect - - - - - The end Size of the effect - - - - - Rotation effect class. - - - - - Creates and initializes a new instance of RotationEffect class. - - The begin degree of the effect - The end degree of the effect - - - - The begin degree of the effect - - - - - The end degree of the effect - - - - - Translation effect class. - - - - - Creates and initializes a new instance of FlipEffect class. - - The begin Point of the effect - The end Point of the effect - - - - The begin Point of the effect - - - - - The end Point of the effect - - - - - Wipe effect class. - - - - - Creates and initializes a new instance of WipeEffect class. - - Wipe type. Hide or show. - Wipe Direction. - - - - Wipe type. Hide or show. - - - - - Wipe Direction. - - - - - Zoom effect class. - - - - - Creates and initializes a new instance of ZoomEffect class. - - The begin rate of the effect - The end rate of the effect - - - - The begin rate of the effect - - - - - The end rate of the effect - - - - - Appends a font path to the list of font paths used by the application. - - The new font path. - - - - Prepends a font path to the list of font paths used by the application. - - The new font path. - - - - Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application. - - - - - Sets Edje color class. - - Color class - Object Red value - Object Red value - Object Red value - Object Red value - Outline Red value - Outline Green value - Outline Blue value - Outline Alpha value - Shadow Red value - Shadow Green value - Shadow Bluevalue - Shadow Alpha value - - - - - Gets Edje color class. - - Color class - Object Red value - Object Red value - Object Red value - Object Red value - Outline Red value - Outline Green value - Outline Blue value - Outline Alpha value - Shadow Red value - Shadow Green value - Shadow Bluevalue - Shadow Alpha value - - - - - Processes all queued up edje messages. - This function triggers the processing of messages addressed to any (alive) edje objects. - - - - - Sets the Edje text class. - - The text class name - The font name - The font size - True, on success or false, on error - - - - Gets the Edje text class. - - The text class name - The font name - The font size - True, on success or false, on error - - - - Delete the text class. - - - - - - Pre-multiplies a rgb triplet by an alpha factor. - - The alpha factor - The Red component of the color - The Green component of the color - The Blue component of the color - - - - Undoes pre-multiplies a rgb triplet by an alpha factor. - - The alpha factor - The Red component of the color - The Green component of the color - The Blue component of the color - - - - Enumeration for the focus direction. - - - - - Previous direction - - - - - Next direction - - - - - Up direction - - - - - Down direction - - - - - Right direction - - - - - Left direction - - - - - The Widget is abstract class, it is the parent of other widgets. - Inherits from . - - - - - Creates and initializes a new instance of the Widget class. - - The parent of new Widget instance - - - - Update the part contents - - The content which put to the part - The updated part - - - - Focused will be triggered when the widget is focused. - - - - - Unfocused will be triggered when the widget is unfocused. - - - - - Sets or gets the state of the widget, which might be enabled or disabled. - - - - - Sets or gets the style of the widget. - - - - - Gets whether this widget is focused. - - - - - Gets whether a widget is focusable or not. - - Widgets which are meant to be interacted with by input events are created able to be focused, by default - - - - Sets or gets the text of the widget. - - It could be override by special child class - - - - Sets or gets the background color of the widget. - - It could be override by special child class - - - - Sets or gets the opacity of the widget. - - It could be override by special child class - - - - Sets or gets whether a widget and its children are focusable or not. - - - - - Sets or gets the widget's mirrored mode. - - - - - Sets or gets the widget's mirrored mode setting. - When widget set automatic mode(true), it follows the system mirrored mode. - - - - - Sets the widget to be focused or not. - - Weather be focused - - - - Sets the ability for a widget to be focused. - - True if the object can be focused, false if not(and on errors) - - - - Gives focus to next widget in widget tree. - - Direction to move the focus - - - - Set next widget with specific focus direction. - - Focus next widget - Focus direction - - - - Sets content to particular part of the widget, and the preserve old content will not be unset. - - The name of particular part - The content - - - - - Sets content to particular part of the widget. - - The name of particular part - The content - true, preserve old content will be unset. false, preserve old content will not be unset. - - - - - Sets content to the widget, and the preserve old content will not be unset. - - The content - - - - - Sets content the widget. - - The content - true, preserve old content will be unset. false, preserve old content will not be unset. - - - - - Sets text to particular part of the widget. - - The name of particular part - The text - - - - Gets text of a particular part of the widget. - - The name of particular part - Text of the particular part of the widget - - - - Sets color of a particular part of the widget. - - The name of particular part - The color be set to widget - This method is a virtual method, it could be override by special child class - - - - Gets color of the particular part of the widget. - - The name of particular part - The color of the particular part - This method is a virtual method, it could be override by special child class - - - - Sets opacity of the particular part of the widget. - - The name of particular part - The opacity of the particular part - - - - Gets opacity of the particular part of the widget. - - The name of particular part - Opacity value of the particular part - - - - Enumeration for the display rotation of window. - - - - - Rotation value of window is 0 degree - - - - - Rotation value of window is 90 degree - - - - - Rotation value of window is 180 degree - - - - - Rotation value of window is 270 degree - - - - - Enumeration for the indicator opacity - - - - - Opacifies the status bar - - - - - Be translucent the status bar - - - Not supported. - - - - - Transparentizes the status bar - - - - - Enumeration for the indicator mode. - - - - - Unknown indicator state. - - - - - Hides the indicator. - - - - - Shows the indicator. - - - - - Enumeration for the keyboard mode - - - - - Unknown keyboard state - - - - - Request to deactivate the keyboard - - - - - Enable keyboard with default layout - - - - - Alpha (a-z) keyboard layout - - - - - Numeric keyboard layout - - - - - PIN keyboard layout - - - - - Phone keyboard layout - - - - - Hexadecimal numeric keyboard layout - - - - - Full (QWERTY) keyboard layout - - - - - Password keyboard layout - - - - - IP keyboard layout - - - - - Host keyboard layout - - - - - File keyboard layout - - - - - URL keyboard layout - - - - - Keypad layout - - - - - J2ME keyboard layout - - - - - Enumeration for the window type - - - - - Unknown - - - - - A normal window. Indicates a normal, top-level window. Almost every window will be created with this type. - - - - - Used for simple dialog windows. - - - - - For special desktop windows, like a background window holding desktop icons. - - - - - The window is used as a dock or panel. Usually would be kept on top of any other window by the Window Manager. - - - - - The window is used to hold a floating toolbar, or similar. - - - - - Similar to Toolbar. - - - - - A persistent utility window, like a toolbox or palette. - - - - - Splash window for a starting up application. - - - - - The window is a dropdown menu, as when an entry in a menubar is clicked. - - - - - Like DropdownMenu, but for the menu triggered by right-clicking an object. - - - - - The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while. - - - - - A notification window, like a warning about battery life or a new E-Mail received. - - - - - A window holding the contents of a combo box. - - - - - Used to indicate the window is a representation of an object being dragged across different windows, or even applications. - - - - - The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer. - This allows to have children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it. - - - - - The window is rendered onto an image buffer and can be shown other process's plug image object. - No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer and can be shown other process's plug image object. - - - - - This window was created using a pre-existing canvas. The window widget can be deleted, but the canvas must be managed externally. - - - - - The Window is container that contain the graphical user interface of a program. - - - - - Creates and initializes a new instance of the Window class. - - Window name. - - - - Creates and initializes a new instance of the Window class. - - - Parent widget which this widow created on. - - - Window name. - - - Window constructor.show window indicator,set callback - When closing the window in any way outside the program control, - and set callback when window rotation changed. - - - - - Creates and initializes a new instance of the Window class. - - - Parent widget which this widow created on. - - - Window name. - - - Window type - - - Window constructor.show window indicator,set callback - When closing the window in any way outside the program control, - and set callback when window rotation changed. - - - - - CloseRequested will be triggered when Window close. - - - - - RotationChanged will be triggered when Window do rotation. - - - - - Sets or gets Window name. - - - - - Gets the Window type. - - - - - Gets Window size with Size value(w,h) - - - - - Gets the screen dpi for the screen that a Window is on. - - - - - Gets the rotation of the Window.The rotation of the window in degrees (0-360). - - - - - Gets whether window manager supports window rotation or not. - - - - - Sets or gets available rotation degree. - - - - - Sets or gets whether auto deletion function is enable. - - - If you enable auto deletion, the window is automatically destroyed after the signal is emitted. - If auto deletion is disabled, the window is not destroyed and the program has to handle it. - - - - - Sets or gets the alpha channel state of a window. - - - True if the window alpha channel is enabled, false otherwise. - If alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent. - - - - - Sets or gets the role of the window. - - - The Role will be invalid if a new role is set or if the window is destroyed. - - - - - Sets or gets the mode of status bar. - - - - - Gets or sets the window's indicator mode. - - The indicator mode. - - - - Gets or sets the aspect ratio of a window. - - - - - Window's autohide state. - - - - - Get the borderless state of a window. - This function requests the Window Manager to not draw any decoration around the window. - - - - - Gets or sets the demand attention state of a window. - - - - - Gets or sets the floating mode of a window. - - - - - Gets or sets the animate status for the focus highlight for this window. - This function will enable or disable the animation of focus highlight only for the given window, regardless of the global setting for it. - - - - - Gets or sets the enabled status for the focus highlight in a window. - This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it. - - - - - Gets or sets the style for the focus highlight on this window. - Sets the style to use for theming the highlight of focused objects on the given window.If style is NULL, the default will be used. - - - - - Get the keyboard mode of the window. - - - - - Gets or sets the layer of the window. - What this means exactly will depend on the underlying engine used. - In the case of X11 backed engines, the value in layer has the following meanings - less than 3 means that the window will be placed below all others, - more than 5 means that the window will be placed above all others, - and anything else means that the window will be placed in the default layer. - - - - - Gets or sets the modal state of a window. - - - - - Gets or sets the noblank property of a window. - This is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window.It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen. - The noblank property may have no effect if the window is iconified/minimized or hidden. - - - - - Get the profile of a window. - - - - - Get the constraints on the maximum width and height of a window relative to the width and height of its screen. - When this function returns true, obj will never resize larger than the screen. - - - - - Gets or sets the base size of a window. - - - - - Gets or sets the step size of a window. - - - - - Get the screen position X of a window. - - - - - Get the screen position Y of a window. - - - - - Gets or sets the title of the window. - - - - - Gets or sets the urgent state of a window. - - - - - Gets or sets the withdrawn state of a window. - - - - - Create a socket to provide the service for Plug widget. - - A service name - A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. - A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. - If true, create successfull, otherwise false - - - - Set the rotation of the window. - - The rotation of the window, in degrees (0-360), counter-clockwise. - Resizes the window's contents so that they fit inside the current window geometry. - - - - Set the window to be skipped by focus. - This sets the window to be skipped by normal input. - This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc. - Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect. - Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input. - Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care. - - - - - Pull up the window object. - Places the window pointed by obj at the top of the stack, so that it's not covered by any other window. - - - - - Bring down the window object. - Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it. - - - - - This function sends a request to the Windows Manager to activate the Window. - If honored by the WM, the window receives the keyboard focus. - - - This is just a request that a Window Manager may ignore, so calling this function does not ensure - in any way that the window is going to be the active one after it. - - - - - Delete subobj as a resize object of window obj. - This function removes the object subobj from the resize objects of the window obj. - It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled or set as child of some other container. - - Resize object. - - - - Adds obj as a resize object of the Window. - - - Setting an object as a resize object of the window means that the obj child's size and - position is controlled by the window directly. That is, the obj is resized to match the window size - and should never be moved or resized manually by the developer.In addition, - resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user. - - - Resize object. - - - - - Set the keygrab of the window. - - keyname string to set keygrab - - - - Unset the keygrab of the window. - - keyname string to unset keygrab - - - - Enumeration for the wrap type. - - - - - No wrap. - - - - - Char wrap - wrap between characters. - - - - - Word wrap - wrap within the allowed wrapping points - (as defined in the unicode standard). - - - - - Mixed wrap - Word wrap, if that fails, char wrap. - - - - - Types of "Enter" keys available for different keyboards layout - - - - + + + + ElmSharp + + + + + The delegate to define how to provide informations for or . + + The sender obj. + Return information for Name or Description. + + + + It's a base abstract class for . + It provides available definitions for the screen reader, such as , , , etc. + There's many the relationship between two accessible objects, like , , , , etc. + + + + + Gets or sets the reading information types of an accessible object. + + + + + Gets or sets the role of the object in accessibility domain. + + + + + Gets or sets highlightable of given widget. + + + + + Gets or sets the translation domain of "name" and "description" properties. + Translation domain should be set if application wants to support i18n for accessibily "name" and "description" properties. + When translation domain is set values of "name" and "description" properties will be translated with dgettext function using current translation domain as "domainname" parameter. + It is application developer responsibility to ensure that translation files are loaded and binded to translation domain when accessibility is enabled. + + + + + Gets or sets an accessible name of the object. + + + + + Gets or sets contextual information about object. + + + + + Gets or sets the delegate for . + + + + + Gets or sets the delegate for . + + + + + Creates and initializes a new instance of the AccessibleObject class with parent EvasObject class parameter. + + Parent EvasObject class + + + + Creates and initializes a new instance of the AccessibleObject class. + + + + + Defines the relationship between two accessible objects. + Relationships can be queried by Assistive Technology clients to provide customized feedback, improving overall user experience. + AppendRelation API is asymmetric, which means that appending, for example, relation from object A to B, do not append relation from object B to object A. + + The relationship between source object and target object of a given type. + + + + Removes the relationship between two accessible objects. + + The relationship between source object and target object of a given type. + + + + Highlights accessible widget. + + + + + Clears highlight of accessible widget. + + + + + IAccessibleRelation is a interface which defines the relationship between two accessible objects. + + + + + To define label info for accessible object. + + + + + Gets or sets the target object which is LabelledBy. + + + + + Gets the LabelledBy type. + + + + + To define label info for accessible object. + + + + + Gets or sets the target object which is LabelFor. + + + + + Gets the LabelFor type. + + + + + To define control relationship for accessible object. + + + + + Gets or sets the target object which is ControllerFor. + + + + + Gets the ControllerFor type. + + + + + To define control relationship for accessible object. + + + + + Gets or sets the target object which is ControlledBy. + + + + + Gets the ControlledBy type. + + + + + To define member relationship for accessible object. + + + + + Gets or sets the target object which is MemberOf. + + + + + Gets the MemberOf type. + + + + + To define tooltip for accessible object. + + + + + Gets or sets the target object which is TooltipFor. + + + + + Gets the TooltipFor type. + + + + + To define child for accessible object. + + + + + Gets or sets the target object which is ChildOf. + + + + + Gets the ChildOf type. + + + + + To define parent for accessible object. + + + + + Gets or sets the target object which is ParentOf. + + + + + Gets the ParentOf type. + + + + + To define extend for accessible object. + + + + + Gets or sets the target object which is Extended. + + + + + Gets the Extended type. + + + + + To define the custom reading order. + + + + + Gets or sets the target object which is FlowsTo. + + + + + Gets the FlowsTo type. + + + + + To define the custom reading order. + + + + + Gets or sets the target object which is FlowsFrom. + + + + + Gets the FlowsFrom type. + + + + + To define subwindow for accessible object. + + + + + Gets or sets the target object which is SubwindowOf. + + + + + Gets the SubwindowOf type. + + + + + To define embed for accessible object. + + + + + Gets or sets the target object which is Embeds. + + + + + Gets the Embeds type. + + + + + To define embed for accessible object. + + + + + Gets or sets the target object which is EmbeddedBy. + + + + + Gets the EmbeddedBy type. + + + + + To define popup for accessible object. + + + + + Gets or sets the target object which is PopupFor. + + + + + Gets the PopupFor type. + + + + + To define parent window for accessible object. + + + + + Gets or sets the target object which is ParentWindowOf. + + + + + Gets the ParentWindowOf type. + + + + + To define description for accessible object. + + + + + Gets or sets the target object which is DescriptionFor. + + + + + Gets the DescriptionFor type. + + + + + To define description for accessible object. + + + + + Gets or sets the target object which is DescribedBy. + + + + + Gets the DescribedBy type. + + + + + Enumeration for ReadingStatus. + + + + + Unknown status + + + + + Cancelled status + + + + + Stopped status + + + + + Skipped status + + + + + AccessibleUtil provides a method to set the reading information. + + + + + Reads given text by screen reader. + + The reading text. + If true, reading can be discarded by subsequent reading requests, if false the reading must finish before next reading request can be started. + Return a task with reading status. + + + + Enumeration for AccessRole. + + + + + Invalid + + + + + AcceleratorLabel role + + + + + Alert role + + + + + Animation role + + + + + Arrow role + + + + + Calendar role + + + + + Canvas role + + + + + CheckBox role + + + + + CheckMenuItem role + + + + + ColorChooser role + + + + + ColumnHeader role + + + + + ComboBox role + + + + + DateEditor role + + + + + DesktopIcon role + + + + + DesktopFrame role + + + + + Dial role + + + + + Dialog role + + + + + DirectoryPane role + + + + + DrawingArea role + + + + + FileChooser role + + + + + Filler role + + + + + FocusTraversable role + + + + + FontChooser role + + + + + Frame role + + + + + GlassPane role + + + + + HtmlContainer role + + + + + Icon role + + + + + Image role + + + + + InternalFrame role + + + + + Label role + + + + + LayeredPane role + + + + + List role + + + + + ListItem role + + + + + Menu role + + + + + MenuBar role + + + + + MenuItem role + + + + + OptionPane role + + + + + PageTab role + + + + + PageTabList role + + + + + Panel role + + + + + PasswordText role + + + + + PopupMenu role + + + + + ProgressBar role + + + + + PushButton role + + + + + RadioButton role + + + + + RadioMenuItem role + + + + + RootPane role + + + + + RowHeader role + + + + + ScrollBar role + + + + + ScrollPane role + + + + + Separator role + + + + + Slider role + + + + + SpinButton role + + + + + SplitPane role + + + + + StatusBar role + + + + + Table role + + + + + TableCell role + + + + + TableColumnHeader role + + + + + TableRowHeader role + + + + + TearoffMenuItem role + + + + + Terminal role + + + + + Text role + + + + + ToggleButton role + + + + + ToolBar role + + + + + ToolTip role + + + + + Tree role + + + + + TreeTable role + + + + + Unknown + + + + + Viewport role + + + + + Window role + + + + + Extended role + + + + + Header role + + + + + Footer role + + + + + Paragraph + + + + + Ruler role + + + + + Application role + + + + + Autocomplete role + + + + + Editbar role + + + + + Embedded role + + + + + Entry role + + + + + Chart role + + + + + Caption role + + + + + DocumentFrame role + + + + + Heading role + + + + + Page role + + + + + Section role + + + + + RedundantObject role + + + + + Form role + + + + + Link role + + + + + InputMethodWindow role + + + + + TableRow role + + + + + TreeItem role + + + + + DocumentSpreadsheet role + + + + + DocumentPresentation role + + + + + DocumentText role + + + + + DocumentWeb role + + + + + DocumentEmail role + + + + + Comment role + + + + + ListBox role + + + + + Grouping role + + + + + ImageMap role + + + + + Notification role + + + + + InfoBar role + + + + + IAccessibleObject is a interface which defines properties and methods of accessible object. + + + + + Enumeration for ReadingInfoType. + + + + + None + + + + + Name for reading info type + + + + + Role for reading info type + + + + + Description for reading info type + + + + + State for reading info type + + + + + The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) + or to any container object. + + + + + Creates and initializes a new instance of the Background class. + + The EvasObject to which the new Background will be attached as a child. + + + + Sets or gets color to Background. + + + + + Sets or gets image to Background. + + + + + Sets or gets the mode of display for a given background widget's image. + + + This sets how the background widget will display its image. + This will only work if the File was previously set with an image file on obj. + The image can be display tiled, scaled, centered or stretched. scaled by default. + + + + + Set the size of the pixmap representation of the image set on a given background widget. + This method just makes sense if an image file was set. + This is just a hint for the underlying system. + The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested. + + The new width of the image pixmap representation. + The new height of the image pixmap representation. + + + + Enumeration for the background type. + + + + + Centers the background image + + + + + Scales the background image, retaining the aspect ratio + + + + + Stretches the background image to fill the UI component's area. + + + + + Tiles the background image at its original size + + + + + The Box is a container used to arranges UI components in a linear order. + + + + + Creates and initializes a new instance of the Box class. + + The EvasObject to which the new Box will be attached as a child. + + + + Sets or gets IsHorizontal value which describe pack direction, vertical is default. + + + + + Sets or gets whether the box to arrange its children homogeneously. + + + + + Adds an object at the end of the pack list. + + + Packs "content" object into the Box, placing it last in the list of children objects. + The actual position the object will get on screen depends on the layout used. + If no custom layout is set, it will be at the bottom or right, + depending if the Box is vertical or horizontal, respectively. + + The oject be packed + + + + Adds an "content" object to the beginning of the pack list. + + + Pack "content" object into the Box obj, placing it first in the list of children objects. + The actual position the object will get on screen depends on the layout used. + If no custom layout is set, it will be at the top or left, + depending if the Box is vertical or horizontal, respectively. + + The object to be packed. + + + + Adds an "content "object to the Box after the "after" object. + + + This will add the "content" to the Box indicated after the object indicated with "after". + If "after" is not already in the Box, results are undefined. + After means either to the right of the "after" object or below it depending on orientation. + + The object will be added in Box + The object has been added in Box + + + + Adds an "content "object to the Box before the "before" object. + + + This will add the "content" to the Box indicated before the object indicated with "before". + If "before" is not already in the Box, results are undefined. + before means either to the left of the "before" object or below it depending on orientation. + + The object will be added in Box + The object has been added in Box + + + + Remove the "content" oject from Box without deleting it. + + The object to unpack + + + + Removes all objects from Box container. + + + + + Whenever anything changes that requires the Box in obj to recalculate the size and position of its elements, + the function cb will be called to determine what the layout of the children will be. + + The callback function used for layout + + + + Sets the color of exact part to Box's layout parent. + + The name of part class, it could be 'bg', 'elm.swllow.content'. + The color value. + + + + Gets the color of exact part of Box's layout parent. + + The name of part class, it could be 'bg', 'elm.swllow.content'. + + + + + Force the box to recalculate its children packing. + If any children was added or removed, box will not calculate the values immediately rather leaving it to the next main loop iteration. + While this is great as it would save lots of recalculation, whenever you need to get the position of a just added item you must force recalculate before doing so. + + + + + Clear the box of all children. + Remove all the elements contained by the box, deleting the respective objects. + + + + + Sets or gets the alignment of the whole bounding box of contents. + + Horizontal alignment + Vertical alignment + + + + Sets or gets the space(padding) between the box's elements. + + Horizontal padding + vertical padding + + + + The Button is a widget works as a clickable input element to trigger events. + + + + + Creates and initializes a new instance of the Button class. + + + The EvasObject to which the new Button will be attached as a child. + + + + + Clicked will be triggered when Button is clicked. + + + + + Repeated will be triggered when Button is pressed without releasing it. + + + + + Pressed will be triggered when the Button is pressed. + + + + + Released will be triggered when the Button is released after being pressed. + + + + + Sets or gets the autorepeat feature of a given Button. + + + Autorepeat feature means autorepeat event generated when the button is kept pressed. + When set AutoRepeat to false, no autorepeat is performed and buttons will trigger Clicked event when they are clicked. + When set to true, keeping a button pressed continuously trigger Repeated event until the button is released. + The time it takes until it starts triggering Repeated is given by AutoRepeatInitialTime, + and the time between each new emission is given by AutoRepeatGapTimeout. + + + + + Sets or gets the initial timeout before the Repeat event is generated. + + + + + Sets or gets the interval between each generated Repeat event. + + + + + Sets or gets the BackgroundColor of a given Button in normal and pressed status. + + + + + Enumeration for event periodicity, used to define if a mark should be repeated beyond event's day. It's set when a mark is added. + + + + + Default value. Marks will be displayed only on event day. + + + + + Marks will be displayed every day after event day. + + + + + Marks will be displayed every week after event day. + + + + + Marks will be displayed every month day that coincides to event day. + + + + + Marks will be displayed every year that coincides to event day. + + + + + Marks will be displayed every last day of month after event day. + + + + + Enumeration for the mode, which determine how user could select a day. + + + + + Default value. a day is always selected. + + + + + A day is always selected. + + + + + None of the days can be selected. + + + + + User may have selected a day or not. + + + + + Enumeration used to define which fields of a tm struct will be taken into account + + + + + None will be taken into account + + + + + Year will be taken into account + + + + + Month will be taken into account + + + + + Day will be taken into account + + + + + The CalendarMark is a Item for marking a Calendar's type,date and repeat type. + + + + + A string used to define the type of mark. + + + + + A time struct to represent the date of inclusion of the mark. + + + + + Repeat the event following this periodicity. + + + + + Creates and initializes a new instance of the CalendarMark class. + + Type of mark + Date of inclusion of the mark + Repeat type + + + + The Calendar is a widget that helps applications to flexibly display a calender with day of the week, date, year and month. + + + + + Creates and initializes a new instance of the Calendar class. + + + The EvasObject to which the new Calendar will be attached as a child. + + + + + DateChanged will be triggered when the date in the calendar is changed. + + + + + DisplayedMonthChanged will be triggered when the current month displayed in the calendar is changed. + + + + + This delegate type is used to format the string that will be used to display month and year. + + DateTime + + + + + Sets or gets the minimum for year. + + + + + Sets or gets the maximum for the year. + + + + + Sets or gets the first day of week, who are used on Calendar. + + + + + Sets or gets the first day of week, who are used on Calendar. + + + + + + Sets or gets the selected date. + + + Selected date changes when the user goes to next/previous month or select a day pressing over it on calendar. + + + + + Sets or gets the interval on time updates for an user mouse button + hold on calendar widgets' month/year selection. + + + + + Gets or sets the select day mode used. + + + + + Gets or sets fields of a datetime will be taken into account, when SelectedDate set is invoked. + + + + + Gets or sets date format the string that will be used to display month and year. + + + + + Add a new mark to the calendar. + + A string used to define the type of mark. It will be emitted to the theme, that should display a related modification on these days representation. + A time struct to represent the date of inclusion of the mark. For marks that repeats it will just be displayed after the inclusion date in the calendar. + Repeat the event following this periodicity. Can be a unique mark (that don't repeat), daily, weekly, monthly or annually. + Item for a calendar mark. + + + + Delete mark from the calendar. + + Item for a calendar mark + + + + Draw calendar marks. + + + + + Remove all calendar's marks. + + + + + The check is a widget allows for toggling a value between true and false. + + + + + Creates and initializes a new instance of the Check class. + + + The EvasObject to which the new Check will be attached as a child. + + + + + StateChanged will be triggered when the IsChecked in the Check is changed. + + + + + Sets or gets whether the given Check is checked or not. + + + When object is checked, the value will set to true, Conversely will set to false. + + + + + It inherits System.EventArgs. + The CheckStateChangedEventArgs is EventArgs to record Check's state. + Include old state and new state. + + + + + Gets the OldState property.The return type is bool. + + + + + Gets the NewState property.The return type is bool. + + + + + Creates and initializes a new instance of the CheckStateChangedEventArgs class. + + Old state of Check which to use this CheckStateChangedEventArgs. + New state of Check which to use this CheckStateChangedEventArgs. + + + + The Color is a struct to record Check's state. + + + + + Gets a default Color instance. + + + In default Color instance,Mode type is Default,RGBA all set as -1. + + + + + Gets whether the Color instance's mode is default or not. + Return type is bool. + + + + + Gets A value of RGBA. + A means the Alpha in color. + + + + + Gets R value of RGBA. + R means the Red in color. + + + + + Gets G value of RGBA. + G means the Green in color. + + + + + Gets B value of RGBA. + B means the Blue in color. + + + + + Creates and initializes a new instance of the Color class. + With RGB parameters. + + Red of RGB + Green of RGB + Blue of RGB + + + + + Compare whether two Color instance is same or not. + + A Color instance. + A Color instance. + The result whether two instance is same or not. + Return type is bool.If they are same, return true. + + + + + Compare whether two Color instance is different or not. + + A Color instance. + A Color instance. + The result whether two instance is different or not. + Return type is bool.If they are different, return true. + + + + + Gets a Color instance with a hexadecimal string parameter. + + Hexadecimal string. + New instance of Color struct. + + + + Gets a Color instance with a Unsigned integer parameter. + + Unsigned integer indicates RGBA. + New instance of Color struct. + + + + Gets a Color instance with R,G,B,A parameters. + + Red in RGBA. + Green in RGBA. + Blue in RGBA. + Alpha in RGBA. + New instance of Color struct. + + + + Gets a Color instance with R,G,B,A parameters. + + Red in RGB. + Green in RGB. + Blue in RGB. + New instance of Color struct. + + + + The Tansparent is a predefined Color, it's rgba value is (0, 0, 0, 0). + + + + + The Aqua is a predefined Color instance, it's rgb value is (0, 255, 255). + + + + + The Black is a predefined Color instance, it's rgb value is (0, 0, 0). + + + + + The Blue is a predefined Color instance, it's rgb value is (0, 0, 255). + + + + + The Fuchsia is a predefined Color instance, it's rgb value is (255, 0, 255). + + + + + The Gray is a predefined Color instance, it's rgb value is (128, 128, 128). + + + + + The Green is a predefined Color instance, it's rgb value is (0, 128, 0). + + + + + The Lime is a predefined Color instance, it's rgb value is (0, 255, 0). + + + + + The Maroon is a predefined Color instance, it's rgb value is (128, 0, 0). + + + + + The Navy is a predefined Color instance, it's rgb value is (0, 0, 128). + + + + + The Olive is a predefined Color instance, it's rgb value is (128, 128, 0). + + + + + The Orange is a predefined Color instance, it's rgb value is (255, 165, 0). + + + + + The Purple is a predefined Color instance, it's rgb value is (128, 0, 128). + + + + + The Pink is a predefined Color instance, it's rgb value is (255, 102, 255). + + + + + The Red is a predefined Color instance, it's rgb value is (255, 0, 0). + + + + + The Silver is a predefined Color instance, it's rgb value is (192, 192, 192). + + + + + The Teal is a predefined Color instance, it's rgb value is (0, 128, 128). + + + + + The White is a predefined Color instance, it's rgb value is (255, 255, 255). + + + + + The Yellow is a predefined Color instance, it's rgb value is (255, 255, 0). + + + + + It inherits System.EventArgs. + Event ColorChanged of ColorSelector contain ColorChangedEventArgs as a parameter. + Refer to type. + + + + + Gets old color in color changed event. + + + + + Gets new color in color changed event. + + + + + Creates and initializes a new instance of the ColorChangedEventArgs class. + + old color + new color + + + + Enumeration for mode of ColorSelector + + + + + Only color palette is displayed, default + + + + + Only color selector is displayed + + + + + Both Palette and selector is displayed + + + + + Only color picker is displayed + + + + + This mode is not supported. If you use this, nothing will be shown + + + + + This mode is not supported. If you use this, it will be shown same with Palette mode + + + + + This mode is not supported. If you use this, it will be shown same with Palette mode + + + + + The ColorSelector is a widget to set a series of colors. + It also allows to load/save colors from/to config with a unique identifier. + + + By default, the colors are loaded/saved from/to config using "default" identifier. + The colors can be picked by user from the color set by clicking on individual + color item on the palette or by selecting it from selector. + + + + + Creates and initializes a new instance of the ColorSelector class. + + + + + + ColorChanged will be triggered when the SelectedColor changed. + + + + + Gets or sets color of colorselector. + + + + + Gets Alpha of a default Color Class(Value is -1). + + + + + Gets or sets Colorselector's mode. + + + + + Get or set current palette's name. + + + + + Adds a new color item to palette. + + Color item to add + A new color palette Item. + + + + Clear the palette items. + + + + + A instance to the ColorSelector item added. + + + + + Gets or sets the Palette item's color + + + + + + Creates and initializes a new instance of the Conformant class. + + The parent is a given container which will be attached by Conformant + as a child.It's type. + + + + It inherits . + The Container is a abstract class. + Other class inherits it to Elementary is about displaying + its widgets in a nice layout. + + + + + Creates and initializes a new instance of class which inherit from Container. + + The parent is a given object which will be attached by Container + as a child.It's type. + + + + Sets the background color of a given Container. + + + + + Enumeration of ContextPopup direction type. + + + + + ContextPopup show appear below clicked area + /// + + + + ContextPopup show appear to the right of the clicked area + + + + + ContextPopup show appear to the left of the clicked area + + + + + ContextPopup show appear above the clicked area + + + + + ContextPopup does not determine it's direction yet + + + + + It inherits . + The ContextPopup is a widget that when it shown, pops up a list of items. + + + + + Creates and initializes a new instance of the ContextPopup class. + + The parent is a given container which will be attached by ContextPopup + as a child.It's type. + + + + Dismissed is raised when the ContextPopup item is dismissed. + + + Outside of ContextPopup was clicked or it's parent area is changed or the language is changed. and then ContextPopup is dismissed. + + + + + Gets the current direction of a ContextPopup. + + + Once the ContextPopup showed up, the direction would be determined. + + + + + Gets or sets the value of current ContextPopup object's orientation. + True for horizontal mode, False for vertical mode (or errors) + + + + + Gets or sets whether ContextPopup hide automatically + or not when parent of ContextPopup is resized. + + + Default value of AutoHide is False. + + + + + Clears all items in the given ContextPopup object. + + + + + Sets the direction priority of a ContextPopup. + + 1st priority of direction + 2nd priority of direction + 3th priority of direction + 4th priority of direction + + + + Gets the direction priority of a ContextPopup. + + 1st priority of direction to be returned + 2nd priority of direction to be returned + 2nd priority of direction to be returned + 4th priority of direction to be returned + + + + Adds a new item to a ContextPopup object with label. + + The Label of the new item + + A ContextPopupItem added or NULL, on errors + + + + + Adds a new item to a ContextPopup object with label and icon. + + The Label of the new item + Icon to be set on new item + A ContextPopupItem added or NULL, on errors + + + + Dismiss a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted. + + + + + Gets the possibility that the direction would be available + + A direction user wants to check + + Get false if you cannot put it in the direction. Gets true if it's possible. + + + + + Gets Alpha of a default Color Class. + + + + + It inherits . + A instance to the ContextPopup item added. + + + + + Gets the Text property of the given ContextPopupItem. + + + + + Gets the Icon(type is ) property of the given ContextPopupItem. + + + + + Selected will be triggered when the ContextPopupItem is Selected. + + + + + It inherits System.EventArgs. + The DateChanged event in Calendar and DateTimeChanged event in DateTimeSelector. + contain DateChangedEventArgs as a parameter. + + + + + Gets the OldDate property of the given DateChangedEventArgs. + + + + + Gets the NewDate property of the given DateChangedEventArgs. + + + + + Creates and initializes a new instance of the DateChangedEventArgs class. + + + Old date when DateChanged event or DateTimeChanged event triggered + + + New date when DateChanged event or DateTimeChanged event triggered + + + + + Enumeration of datetime field types for DateTimeSelector. + + + + + + Creates and initializes a new instance of the DateTimeSelector class. + + The parent is a given container which will be attached by DateTimeSelector + as a child.It's type. + + + + ItemSelected is raised when Datetime field value changed. + + + + + Gets or sets the datetime format. + + + format is a combination of allowed LIBC date format specifiers like: "%b %d, %Y %I : %M %p". + + + + + Gets or sets the upper boundary of DateTime field. + + + + + Gets or sets the lower boundary of DateTime field. + + + + + Gets or sets the current value of DateTime field. + + + + + Gets whether a field can be visible. + + Enumeration + + The field is visible or not. + Type is bool.If visible, return true. + + + + + Sets the field limits of a field. + + Enumeration + minimum limit + maximum limit + + + + Gets whether a field can be visible. + + Enumeration + When set as true, the field type visible. + + + + It inherits System.EventArgs. + The DisplayedMonthChangedEvent in Calendar contain + DisplayedMonthChangedEventArgs as a parameter. + + + + + Gets the OldMonth property of the given DisplayedMonthChangedEventArgs. + + + + + Gets the NewMonth property of the given DisplayedMonthChangedEventArgs. + + + + + Creates and initializes a new instance of the DisplayedMonthChangedEventArgs class. + + + old month of date when DisplayedMonthChangedEvent triggered. + + + new month of date when DisplayedMonthChangedEvent triggered. + + + + + EcoreAnimator is a helper class, it provides functions to manager animations. + + + + + Gets current system time as a floating point value in seconds. + + Current system time + + + + Adds an animator to call at every animation tick during main loop execution. + + The function to call when it ticks off + A handle to the new animator + + + + Removes the specified animator from the animator list. + + The specified animator handle + + + + The EcoreEventType is type of EcoreEvent. + It includes some predefined instance. + + + + + Key down Ecore event type. + + + + + Key Up Ecore event type. + + + + + Mouse Button Down Ecore event type. + + + + + Mouse Button Up Ecore event type. + + + + + Mouse Button Cancel Ecore event type. + + + + + Mouse Move Ecore event type. + + + + + Mouse Wheel Ecore event type. + + + + + Mouse In Ecore event type. + + + + + Mouse Out Ecore event type. + + + + + Gets the value associated with the specified type. + + The value of type. + + + + The EcoreEvent is a class to help to create events are being notified of events. + + Kinds of EventArgs + + + + Creates and initializes a new instance of the EcoreEvent class. + + EcoreEventType + + + + Creates and initializes a new instance of the EcoreEvent class. + + EcoreEventType + EventInfoParser + + + + On Event Handler of EcoreEvent. + + + + + Event class for EcoreEvent + + + + + Creates and initializes a new instance of the EcoreEvent class. + + EcoreEventType + + + + It inherits System.EventArgs. + The EcoreKeyEventArgs is a EventArgs to record Ecore event's key name and key code. + + + + + Gets the KeyName property.The return type is string. + + + + + Gets the KeyCode property.The return type is int. + + + + + Creates and initializes a new instance of the EcoreKeyEventArgs class. + + data + type + information + new instance of the EcoreKeyEventArgs class + + + + EcoreMainloop is a helper class, it provide functions relative Ecore's main loop. + + + + + Checks if you are calling this function from the main thread. + + True is the calling function is the same thread, false otherwise. + + + + Runs the application main loop. + + + + + Quits the main loop once all the events currently on the queue have been processed. + + + + + Adds an idler handler. + + The action to call when idling + + + + Calls callback asynchronously in the main loop. + + The action wanted to be called + + + + Calls callback synchronously in the main loop. + + The action wanted to be called + + + + Creates a timer to call the given function in the given period of time. + + The interval in seconds. + The given function. + A timer object handler on success, NULL on failure. + + + + Removes the specified timer from the timer list. + + The specified timer handler + + + + Provides a synchronization context for the efl application. + + + + + Initializes a new instance of the EcoreSynchronizationContext class. + + + + + Initilizes a new EcoreSynchronizationContext and install into current thread + + + It is equivalent + + SetSynchronizationContext(new EcoreSynchronizationContext()); + + + + + + Dispatches an asynchronous message to a Ecore main loop. + + The SendOrPostCallback delegate to call. + The object passed to the delegate. + The Post method starts an asynchronous request to post a message. + + + + Dispatches a synchronous message to a Ecore main loop + + The SendOrPostCallback delegate to call. + The object passed to the delegate. + + The Send method starts a synchronous request to send a message. + + + + The EdjeObject is a class that evas object exist in + + + + + Checks whether an edje part exists in a given edje object's group definition. + This function returns if a given part exists in the edje group bound to object obj + + This call is useful, for example, when one could expect a given GUI element, depending on the theme applied to obj. + The part's name to check for existence in obj's group + TRUE, if the edje part exists in obj's group, otherwise FALSE + + + + Sends/emits an edje signal to a given edje object. + + The signal's "emission" string + The signal's "source" string + + + + Deletes the object color class. + This function deletes any values at the object level for the specified object and color class. + + Deleting the color class defined in the theme file. + The color class to be deleted + + + + Sets the object color class. + + The color class name. + The object Red value. + The object Green value. + The object Blue value. + The object Alpha value. + The outline Red value. + The outline Green value. + The outline Blue value. + The outline Alpha value. + The shadow Red value. + The shadow Green value. + The shadow Blue value. + The shadow Alpha value. + True if succeed, otherwise False + + + + Gets the object color class. + + The color class name. + The object Red value. + The object Green value. + The object Blue value. + The object Alpha value. + The outline Red value. + The outline Green value. + The outline Blue value. + The outline Alpha value. + The shadow Red value. + The shadow Green value. + The shadow Blue value. + The shadow Alpha value. + True if succeed, otherwise False + + + + Sets Edje text class. + + The text class name. + Font name. + Font size. + True if succeed, otherwise False + + + + Gets Edje text class. + + The text class name. + Font name. + Font size. + True if succeed, otherwise False + + + + Adds Action for an arriving edje signal, emitted by a given Ejde object. + + The signal's "emission" string + The signal's "source" string + The action to be executed when the signal is emitted + + + + Deletes a signal-triggered action from an object. + + The signal's "emission" string + The signal's "source" string + The action to be executed when the signal is emitted + + + + An EdjeTextPartObject is a class dealing with parts of type text. + + + + + Gets the name of the EdjeTextPartObject + + + + + Gets or sets the text for an object part. + + + + + Sets or gets the style of the object part. + + + + + Gets the geometry of a given edje part, in a given edje object's group definition, relative to the object's area. + + + + + Gets the native width and height. + + + + + Gets the formatted width and height. + + + + + EffectBase class for the TransitEffect + + + + + EffectEneded event will be triggered when be effect ended. + + + + + Focus Autoscroll Mode + + + + + Directly show the focused region or item automatically + + + + + Do not show the focused region or item automatically + + + + + Bring in the focused region or item automatically which might invole the scrolling + + + + + The Elementary is a General Elementary,a VERY SIMPLE toolkit. + + + + + Gets or sets the configured finger size. + + + + + Gets or sets the enable status of the focus highlight animation + + + + + Gets or sets the system mirrored mode. + This determines the default mirrored mode of widgets. + + + + + Gets or sets the enable status of the focus highlight. + + + + + Gets or sets the base scale of the application. + + + + + Gets or sets the global scaling factor. + + + + + Gets or sets the amount of inertia a scroller imposes during region bring animations. + + + + + Gets of sets focus auto scroll mode. + + + + + Initializes Elementary. + + + + + Shuts down Elementary. + + + + + Runs Elementary's main loop. + + + + + Prepends a theme overlay to the list of overlays + + The Edje file path to be used. + + + + Delete a theme overlay from the list of overlays + + The name of the theme overlay. + + + + Free a theme + + + + + Set the theme search order for the given theme + + Theme search string + This sets the search string for the theme in path-notation from first theme to search, to last, delimited by the : character. Example:"shiny:/path/to/file.edj:default" + + + + Flush the current theme. + + + + + This flushes all themes (default and specific ones). + + + + + Deletes a theme extension from the list of extensions. + + The name of the theme extension. + + + + Flush all caches. + Frees all data that was in cache and is not currently being used to reduce memory usage. This frees Edje's, Evas' and Eet's cache. + + + + + Changes the language of the current application. + + The language to set, must be the full name of the locale. + + + + Sets a new policy's value (for a given policy group/identifier). + + The policy identifier + The policy value, which depends on the identifier + + + + + Reloads Elementary's configuration, bounded to the current selected profile. + + + + + Flushes all config settings and then applies those settings to all applications using elementary on the current display. + + + + + The ElmScrollConfig is a scrollable views's config + + + + + Enumeration for describing InputPanel layout type. + + + + + InputPanel layout type default. + + + + + InputPanel layout type number. + + + + + InputPanel layout type email. + + + + + InputPanel layout type url. + + + + + InputPanel layout type phone. + + + + + InputPanel layout type ip. + + + + + InputPanel layout type month. + + + + + InputPanel layout type number. + + + + + InputPanel layout type error type. Do not use it directly! + + + + + InputPanel layout type hexadecimal. + + + + + InputPanel layout type terminal type, esc, alt, ctrl, etc. + + + + + InputPanel layout type password. + + + + + Keyboard layout type date and time. + + + + + InputPanel layout type emoticons. + + + + + Enumeration that defines the "Return" key types on the input panel (virtual keyboard). + + + + + Default key type + + + + + Done key type + + + + + Go key type + + + + + Join key type + + + + + Login key type + + + + + Next key type + + + + + Search string or magnifier icon key type + + + + + Send key type + + + + + Sign-in key type + + + + + Enumeration that defines the autocapitalization types. + + + + + No autocapitalization when typing + + + + + Autocapitalize each typed word + + + + + Autocapitalize the start of each sentence + + + + + Autocapitalize all letters + + + + + + + + + Enumeration that defines the text format types. + + + + + Plain type + + + + + Markup type + + + + + Enumeration that defines the types of Input Hints. + + + + + No active hints + + + + + suggest word auto completion + + + + + typed text should not be stored. + + + + + Enumeration that defines the input panel (virtual keyboard) language modes. + + + + + Automatic language mode + + + + + Alphabet language mode + + + + + The entry is a convenience widget that shows a box in which the user can enter text. + + + + + Creates and initializes a new instance of the Entry class. + + The EvasObject to which the new Entry will be attached as a child. + + + + Activated will be triggered when the entry in Activated stated. + + + + + Clicked will be triggered when the entry is clicked. + + + + + ChangedByUser will be triggered when the entry changed by user. + + + + + CursorChanged will be triggered when the Cursor in the entry is changed. + + + + + Sets or gets the entry to the single line mode. + + + + + Sets or gets the entry to the password mode. + + + + + Sets or gets whether the entry is editable. + + + + + Sets or gets whether the entry is empty. + + + + + Sets or gets text currently shown in the object entry. + + + + + Sets or gets the style on the top of the user style stack. + + If there is styles in the user style stack, the properties in the top style of user style stack will replace the properties in current theme. The input style is specified in format tag='property=value' (i.e. DEFAULT='font=Sans font_size=60'hilight=' + font_weight=Bold'). + + + + Sets or gets the current position of the cursor in the entry. + + + + + Sets or gets the scrollable state of the entry. + + + + + Sets or Gets the autocapitalization type on the immodule. + + + + + Sets or Gets the entry object's 'autosave' status. + + + + + Sets or Gets entry text paste/drop mode. + + + + + Gets the geometry of the cursor. + + + + + Gets whether a format node exists at the current cursor position. + + + + + Gets if the current cursor position holds a visible format node. + + + + + Sets or Gets the value of input hint. + + + + + Sets or gets the language mode of the input panel. + + + + + Sets or gets the input panel layout variation of the entry. + + + + + Sets or gets the line wrap type to use on multi-line entries. + + + + + Sets or gets whether the entry should allow to use the text prediction. + + + + + Sets or gets whether the return key on the input panel should be disabled or not. + + + + + Sets or gets the attribute to show the input panel in case of only an user's explicit Mouse Up event. + It doesn't request to show the input panel even though it has focus. + If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) + + + + + Sets the file (and implicitly loads it) for the text to display and then edit. + + The path to the file to load and save + The file format + + + + Converts a markup (HTML-like) string into UTF-8. + + The string (in markup) to be converted + The converted string (in UTF-8) + + + + Moves the cursor by one position to the right within the entry. + + + + + + Moves the cursor one place to the left within the entry. + + TRUE on success, otherwise FALSE on failure + + + + Moves the cursor one line up within the entry. + + TRUE on success, otherwise FALSE on failure + + + + Moves the cursor one line down within the entry. + + TRUE on success, otherwise FALSE on failure + + + + Moves the cursor to the beginning of the entry. + + + + + Moves the cursor to the end of the entry. + + + + + Moves the cursor to the beginning of the current line. + + + + + Moves the cursor to the end of the current line. + + + + + Sets the input panel layout of the entry. + + The layout type + + + + Sets the attribute to show the input panel automatically. + + If true the input panel appears when the entry is clicked or has focus, otherwise false + + + + Sets the "return" key type. This type is used to set the string or icon on the "return" key of the input panel. + + The type of "return" key on the input panel + + + + Hides the input panel (virtual keyboard). + + + Note that the input panel is shown or hidden automatically according to the focus state of the entry widget. + This API can be used in case of manually controlling by using SetInputPanelEnabled(false). + + + + + Selects all the text within the entry. + + + + + Drops any existing text selection within the entry. + + + + + Forces calculation of the entry size and text layouting. + + + + + Gets the string by the cursor at its current position. + + + + + + Begins a selection within the entry as though the user were holding down the mouse button to make a selection. + + + + + Appends the text of the entry. + + The text to be displayed + + + + Inserts the given text into the entry at the current cursor position. + + + + + + Ends a selection within the entry as though the user had just released the mouse button while making a selection. + + + + + Writes any changes made to the file that is set by File. + + + + + Show the input panel (virtual keyboard) based on the input panel property of entry such as layout, autocapital types, and so on. + + + Note that input panel is shown or hidden automatically according to the focus state of entry widget. + This API can be used in the case of manually controlling by using SetInputPanelEnabled(false). + + + + + This appends a custom item provider to the list for that entry. + + This function is used to provide items. + + + + This prepends a custom item provider to the list for that entry. + + This function is used to provide items. + + + + This removes a custom item provider to the list for that entry. + + This function is used to provide items. + + + + Append a markup filter function for text inserted in the entry. + + This function type is used by entry filters to modify text. + + + + Prepend a markup filter function for text inserted in the entry. + + This function type is used by entry filters to modify text. + + + + Remove a markup filter + + This function type is used by entry filters to modify text. + + + + This executes a "copy" action on the selected text in the entry. + + + + + This executes a "cut" action on the selected text in the entry. + + + + + This executes a "paste" action in the entry. + + + + + This disabled the entry's selection. + + If true, the selection are disabled. + + + + Get any selected text within the entry. + + Selection's value + + + + This selects a region of text within the entry. + + The starting position. + The end position. + + + + Sets the visibility of the left-side widget of the entry + + true if the object should be displayed, false if not. + + + + Set whether the return key on the input panel is disabled automatically when entry has no text. + + If enabled is true, the return key is automatically disabled when the entry has no text. + + + + Low level Evas canvas functions. Sub groups will present more high level ones, though. + Most of these functions deal with low level Evas actions, like: + create/destroy raw canvases, not bound to any displaying engine + tell a canvas i got focused(in a windowing context, for example) + tell a canvas a region should not be calculated anymore in rendering + tell a canvas to render its contents, immediately + Most users will be using Evas by means of the Ecore_Evas wrapper, which deals with all the above mentioned issues automatically for them.Thus, you'll be looking at this section only if you're building low level stuff. + The groups within present you functions that deal with the canvas directly, too, and not yet with its objects.They are the functions you need to use at a minimum to get a working canvas. + + + + + Gets the current known default pointer coordinates. + This function returns the current known canvas unit coordinates of the mouse pointer. + + + + + Gets or sets the image cache. + This function returns the image cache size of canvas in bytes. + + + + + Flush the image cache of the canvas. + + + + + Add a damage rectangle. + + The rectangle's top left corner's horizontal coordinate. + The rectangle's top left corner's vertical coordinate. + The rectangle's width. + The rectangle's height. + + + + Add an "obscured region" to an Evas canvas. + + The rectangle's top left corner's horizontal coordinate. + The rectangle's top left corner's vertical coordinate. + The rectangle's width. + The rectangle's height. + + + + Remove all "obscured regions" from an Evas canvas. + + + + + Adds or registers a event to a given canvas event. + + The type of event that triggers + The action to be called when the event is triggered + + + + Deletes a event to a given canvas event. + + The type of event that triggers + The action to be called when the event is triggered + + + + The EvasKeyEventArgs is an EvasKey EventArgs + + + + + BackButton name in Platform + + + + + MenuButton name in Platform + + + + + HomeButton name in Platform + + + + + Gets the name of Key + + + + + Creates and initializes a new instance of the EvasKeyEventArgs class. + + data info + object + information + EvasKey eventArgs + + + + Event structure for Key Down event callbacks. + + + + + Name string of the key pressed + + + + + Data to be passed to the event + + + + + Modifier keys pressed during the event + + + + + Locks info + + + + + Logical key: (example, shift+1 == exclamation) + + + + + UTF8 string if this keystroke has produced a visible string to be ADDED + + + + + UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one + + + + + Event_flags + + + + + + + + + + Keycode + + + + + Flags for Events + + + + + No fancy flags set + + + + + This event is being delivered but should be put "on hold" until the on hold flag is unset. the event should be used for informational purposes and maybe some indications visually, but not actually perform anything + + + + + The EvasMap is an opaque handle to map points. + + + + + Creates and initializes a new instance of the EvasMap class. + + The number of points in the map + + + + Gets or sets the flag of the object move synchronization for map rendering. + + + + + Populates source and destination map points to exactly match the object. + + The object to use unmapped geometry to populate map coordinates + + The point Z coordinate hint (pre-perspective transform)This value is used for all four points. + + + + + Populates the source and destination map points to match the given geometry. + + The geometry value contains X coordinate,Y coordinate,the width and height to use to calculate second and third points + The Z coordinate hint (pre-perspective transform) This value is used for all four points. + + + + Rotates the map around 3 axes in 3D. + + The amount of degrees from 0.0 to 360.0 to rotate around X axis + The amount of degrees from 0.0 to 360.0 to rotate around Y axis + The amount of degrees from 0.0 to 360.0 to rotate around Z axis + The rotation's center horizontal position + The rotation's center vertical position + The rotation's center vertical position + + + + Changes the map point's coordinate. + + The index of point to change ,this must be smaller than map size. + 3D Point coordinate + + + + Gets the map point's coordinate. + + The index of point to change ,this must be smaller than map size. + The coordinates of the given point in the map. + + + + Changes the map to apply the given zooming. + + The horizontal zoom to use + The vertical zoom to use + The zooming center horizontal position + The zooming center vertical position + + + + The EcasObject is a base class for other widget class + + + + + Creates and initializes a new instance of the EvasObject class with parent EvasObject class parameter. + + Parent EvasObject class + + + + Creates and initializes a new instance of the EvasObject class. + + + + + Deleted will be triggered when widght is deleted + + + + + KeyUp will be triggered when key is loose + + + + + KeyDown will be triggered when key is preesd down + + + + + BackButtonPressed will be triggered when Back button is pressed + + + + + MoreButtonPressed will be triggered when More button is pressed + + + + + Moved will be triggered when widght is moved + + + + + Current widget's size Resized Event Handler + + + + + Current widget RenderPost Event Handler + + + + + Called back when a widget's tooltip is activated and needs content. + + + + + + Get widget's status of Realized or not. + + + + + Gets EvasCanvas + + + + + Gets the current class's Name. + + + + + Sets or gets the horizontal pointer hints for an object's weight. + + + + + Sets or gets the vertical pointer hints for an object's weight. + + + + + Sets or gets the horizontal alignment hint of an object's alignment. + + + + + Sets or gets the vertical alignment hint of an object's alignment. + + + + + Sets or gets the Width hints for an object's minimum size. + + + + + Sets or gets the Height hints for an object's minimum size. + + + + + Gets the visible state of the given Evas object. + + + + + Sets or gets the position and (rectangular) size of the given Evas object. + + + + + Sets or gets the general or main color of the given Evas object. + + + + + Sets or gets the map enabled state. + + + + + Sets or gets current object transformation map. + + + + + Sets or gets whether an object is to repeat events. + + + + + Sets or gets whether events on a smart object's member should get propagated up to its parent. + + + + + Sets or gets whether an object is set to pass (ignore) events. + + + + + Sets or Gets style for this object tooltip. + + + + + Sets or gets the orientation of Tooltip. + + + + + Sets or gets size restriction state of an object's tooltip. + + + + + Sets the content to be shown in the tooltip object. + + + + + Gets the movement freeze by 1 + This gets the movement freeze count by one. + + + + + Sets or gets whether an Evas object is to freeze (discard) events. + + + + + Sets or gets the layer of its canvas that the given object will be part of. + + + + + Clips one object to another. + + The object to clip object by + + + + Sets the hints for an object's alignment. + + The horizontal alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 + The vertical alignment hint as double value ranging from 0.0 to 1.0,The default alignment hint value is 0.5 + + + + Sets the hints for an object's weight. + + The non-negative double value to use as horizontal weight hint + The non-negative double value to use as vertical weight hint + + + + Sets the text for an object's tooltip. + + The text value to display inside the tooltip + + + + Unsets an object's tooltip. + + + + + This increments the tooltip movement freeze count by one. + If the count is more than 0, the tooltip position will be fixed. + + + + + This decrements the tooltip freeze count by one. + + + + + Force hide tooltip of object. + + + + + Force show tooltip of object. + + + + + Makes the current object visible. + + + + + Makes the current object invisible. + + + + + Changes the size of the current object. + + The new width + The new height + + + + Moves the current object to the given location. + + The X position to move the object to. + The Y position to move the object to. + + + + Lowers obj to the bottom of its layer. + + + + + Define IntPtr operator + + Parent object + + + + Requests keyname key events be directed to current obj. + + The key to request events for + Set TRUE to request that the obj is the only object receiving the keyname events,otherwise set FALSE + If the call succeeded is true,otherwise is false + + + + Removes the grab on keyname key events. + + The key the grab is set for + + + + Mark smart object as changed. + + + + + Call the calculate smart function immediately. + This will force immediate calculations needed for renderization of this object. + + + + + Sets the hints for an object's aspect ratio. + + The policy or type of aspect ratio to apply to object + The integer to use as aspect width ratio term + The integer to use as aspect height ratio term + + + + Gets the hints for an object's aspect ratio. + + The policy or type of aspect ratio to apply to object + The integer to use as aspect width ratio term + The integer to use as aspect height ratio term + + + + Stack immediately below anchor. + + The object below which to stack. + + + + Stack immediately above anchor. + + The object above which to stack. + + + + Raise to the top of its layer. + + + + + Get the geometry of a line number. + + the line number. + x coord of the line. + y coord of the line. + w coord of the line. + h coord of the line. + + + + + The callback of Invalidate Event + + + + + The callback of Instantiated Event + + + + + The callback of Realized Event + + + + + The callback of Unrealize Event + + + + + Creates a widget handle. + + Parent EvasObject + Handle IntPtr + + + + For this object bind Parent object.Init handle and all kinds of EvasObjectEvent. + + Parent object + + + + Removes current object relationship with others. + + + + + IInvalidatable is a interface which can be overrided by its children class. + Inherits IDisposable + + + + + Enumeration for EvasObjectCallbackType + + + + + Mouse In Event CallbackType. + + + + + Mouse Out Event CallbackType + + + + + Mouse Button Down Event CallbackType + + + + + Mouse Button Up Event CallbackType + + + + + Mouse Move Event CallbackType + + + + + Mouse Wheel Event CallbackType + + + + + Multi-touch Down Event CallbackType + + + + + Multi-touch Up Event CallbackType + + + + + Multi-touch Move Event CallbackType + + + + + Object Being Freed (Called after Del) + + + + + Key Press Event CallbackType + + + + + Key Release Event CallbackType + + + + + Focus In Event CallbackType + + + + + Focus Out Event CallbackType + + + + + Show Event CallbackType + + + + + Hide Event CallbackType + + + + + Move Event CallbackType + + + + + Resize Event CallbackType + + + + + Restack Event CallbackType + + + + + Object Being Deleted (called before Free) + + + + + Hold Event CallbackType, Informational purpose event to indicate something + + + + + Size hints changed Event CallbackType + + + + + Image has been preloaded + + + + + Canvas got focus as a whole + + + + + Canvas lost focus as a whole + + + + + Called just before rendering is updated on the canvas target + + + + + Called just after rendering is updated on the canvas target + + + + + Canvas object got focus + + + + + Canvas object lost focus + + + + + Image data has been unloaded (by some mechanism in Evas that throw out original image data) + + + + + Called just before rendering starts on the canvas target + + + + + Called just after rendering stops on the canvas target + + + + + Image size is changed + + + + + Devices added, removed or changed on canvas + + + + + Axis is changed + + + + + Canvas Viewport size is changed + + + + + Event class for EvasObject + + Kinds of EventArgs + + + + SmartEventInfoParser delegate of EvasObjectEvent class + + data + obj + info + delegate handle + + + + Creates and initializes a new instance of the EvasObjectEvent. + + EvasObject class belong to + EvasObjectCallbackType + SmartEventInfoParser + + + + Creates and initializes a new instance of the EvasObjectEvent. + + EvasObject class belong with + SmartEventInfoParser + + + + On Event Handler of EvasObjectEvent + + + + + Destroy Current Obj + + + + + Make current instance invalidate + + + + + Event class for EvasObject + + + + + Creates and initializes a new instance of the EvasObjectEvent. + + EvasObject class belong to + EvasObjectCallbackType + + + + On Event Handler of EvasObjectEvent + + + + + Destroy Current Obj + + + + + Make current instance invalidate + + + + + A flip selector is a widget to show a set of text items,one at a time.with the same sheet switching style as the clock widget, when one changes the current displaying sheet. + + + + + Creates and initializes a new instance of the FlipSelector. + + Parent EvasObject + + + + Selected will be triggered when be Selected + + + + + Overflowed will be triggered when Overflowed + + + + + Underflowed will be triggered when be Underflowed + + + + + Sets or gets the interval on time updates for an user mouse button hold on a flip selector widget. + + + + + Gets the currently selected item in a flip selector widget. + + + + + Gets the first item in the given flip selector widget's list of items. + + + + + Gets the last item in the given flip selector widget's list of items. + + + + + Appends a (text) item to a flip selector widget. + + text value + + A handle to the item added or NULL, on errors + + + The widget's list of labels to show will be appended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + + + + + Prepend a (text) item to a flip selector widget. + + Prepend text + A handle to the item added or NULL, on errors + + The widget's list of labels to show will be prepended with the given value. If the user wishes so, a callback function pointer can be passed, which will get called when this same item is selected. + + + + + To remove the given item. + + FlipSelector's item + + + + Programmatically select the next item of a flip selector widget. + + + The selection will be animated. Also, if it reaches the beginning of its list of member items, it will continue with the last one backwards. + + + + + Programmatically select the previous item of a flip selector widget. + + + + + Iterm class of FlipSelector + + + + + Sets or gets the Text of FlipSelectorItem + + + + + Selected will be triggered when Selected + + + + + Creates and initializes a new instance of the FlipSelectorItem. + + FlipSelectorItem's text + + + + The FloatingButton is a widget that to add floating area for buttons. + + + + + Creates and initializes a new instance of the FloatingButton class. + + Created on this parent container.. + + + + Sets or gets floatingbutton mode. + + + + + Gets floatingbutton Position. + + + + + Sets or gets movability for a given floatingbutton widget. + + + + + Get Opacity's value of the given FloatingButton. + + + + + Set the floatingbutton position with animation or not. + + Button position + Animat flag + + + + Enumeration for FloatingButtonMode + + + + + Allows all positions + + + + + Allows LEFT and RIGHT positions only + + + + + Enumeration for FloatingButtonPosition + + + + + Hides in the left, but small handler will show only + + + + + Shows all of buttons, but lies on the left + + + + + Shows all of buttons, but lies on the center + + + + + Shows all of buttons, but lies on the right + + + + + Hides in the right, but small handler will show only + + + + + It inherits System.EventArgs. + It contains Item which is type. + All events of GenGrid contain GenGridItemEventArgs as a parameter. + + + + + Gets or sets GenGrid item.The return type is . + + + + + It inherits . + The GenGrid is a widget that aims to position objects in a grid layout while actually creating and rendering only the visible ones. + It has two direction in which a given GenGrid widget expands while placing its items, horizontal and vertical. + The GenGrid items are represented through definition field details. + + + + + Creates and initializes a new instance of the GenGrid class. + + The parent is a given container which will be attached by GenGrid as a child. It's type. + + + + ItemSelected is raised when a new gengrid item is selected. + + + + + ItemUnselected is raised when the gengrid item is Unselected. + + + + + ItemPressed is raised when a new gengrid item is pressed. + + + + + ItemReleased is raised when a new gengrid item is released. + + + + + ItemActivated is raised when a new gengrid item is double clicked or pressed (enter|return|spacebar). + + + + + ItemDoubleClicked is raised when a new gengrid item is double clicked. + + + + + ItemRealized is raised when a gengrid item is implementing through . + + + + + ItemUnrealized is raised when the gengrid item is deleted. + + + + + ItemLongPressed is raised when a gengrid item is pressed for a certain amount of time. By default it's 1 second. + + + + + Changed is raised when an item is added, removed, resized or moved and when the gengrid is resized or gets "horizontal" property changes. + + + + + Gets or sets the item's grid alignment along x-axis within a given gengrid widget. + Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. + By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the left along x-axis. + + + + + Gets or sets the item's grid alignment on y-axis within a given gengrid widget. + Accepted values are in the 0.0 to 1.0 range, with the special value -1.0 used to specify "justify" or "fill" by some users. + By default, value is 0.0, meaning that the gengrid has its items grid placed exactly in the top along y-axis. + + + + + Gets or sets the manner in which the items grid is filled within a given gengrid widget. + It is filled if true, otherwise false. + + + + + Gets or sets whether multi-selection is enabled or disabled for a given gengrid widget. + + + Multi-selection is the ability to have more than one item selected, on a given gengrid, simultaneously. + When it is enabled, a sequence of clicks on different items makes them all selected, progressively. + A click on an already selected item unselects it. If interacting via the keyboard, multi-selection is enabled while holding the "Shift" key. + By default, multi-selection is disabled. + + + + + Gets or sets the width for the items of a given gengrid widget. + + + A gengrid, after creation, still has no information on the size to give to each of its cells. + The default width and height just have one finger wide. + Use this property to force a custom width for your items, making them as big as you wish. + + + + + Gets or sets the height for the items of a given gengrid widget. + + + A gengrid, after creation, still has no information on the size to give to each of its cells. + The default width and height just have one finger wide. + Use this property to force a custom height for your items, making them as big as you wish. + + + + + Gets or sets the gengrid select mode by . + + + + + Gets or sets the direction for which a given gengrid widget expands while placing its items. + + + If true, items are placed in columns from top to bottom and when the space for a column is filled, another one is started on the right, thus expanding the grid horizontally. + If false, items are placed in rows from left to right, and when the space for a row is filled, another one is started below, thus expanding the grid vertically. + + + + + Gets or sets whether the gengrid items should be highlighted when an item is selected. + + + + + Sets or gets the value of HorizontalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Sets or gets the value of VerticalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Gets the first item in a given gengrid widget. + + + + + Gets the last item in a given gengrid widget. + + + + + Gets the items count in a given gengrid widget. + + + + + Gets the selected item in a given gengrid widget. + + + + + Gets or sets whether a given gengrid widget is or not able have items reordered. + + + + + Appends a new item to a given gengrid widget. This adds an item to the end of the gengrid. + + The itemClass defines how to display the data. + The item data. + Return a gengrid item that contains data and itemClass. + + + + + + Prepends a new item to a given gengrid widget. This adds an item to the beginning of the gengrid. + + The itemClass defines how to display the data. + The item data. + Return a gengrid item that contains data and itemClass. + + + + + + Inserts an item before another in a gengrid widget. This inserts an item before another in the gengrid. + + The itemClass defines how to display the data. + The item data. + The item before which to place this new one. + Return a gengrid item that contains data and itemClass./> + + + + + + Inserts an item before another in a gengrid widget. This inserts an item after another in the gengrid. + + The itemClass defines how to display the data. + The item data. + The item after which to place this new one. + Return a gengrid item that contains data and itemClass. + + + + + + Insert an item in a gengrid widget using a user-defined sort function. + + The itemClass defines how to display the data. + The item data. + User defined comparison function that defines the sort order based on gengrid item and its data. + Return a gengrid item that contains data and itemClass. + + + + Shows a given item to the visible area of a gengrid. + + The gengrid item to display. + The position of the item in the viewport. + The type of how to show the item. + + If animated is true, the gengrid shows item by scrolling if it's not fully visible. + If animated is false, the gengrid shows item by jumping if it's not fully visible. + + + + + + Updates the contents of all the realized items. + This updates all realized items by calling all the again to get the content, text, and states. + Use this when the original item data has changed and the changes are desired to reflect. + + + to update just one item. + + + + + Removes all items from a given gengrid widget. + This removes(and deletes) all items in obj, making it empty. + + + to delete just one item. + + + + + Get the item that is at the x, y canvas coords. + + The input x coordinate + The input y coordinate + The position relative to the item returned here. + -1, 0 or 1, depending if the coordinate is on the left portion of that item(-1), on the middle section(0) or on the right part(1). + + The position relative to the item returned here + -1, 0 or 1, depending if the coordinate is on the upper portion of that item (-1), on the middle section (0) or on the lower part (1). + + + + + + It inherits . + A instance to the gengrid item added. + It contains Update() method to update a gengrid item which is given. + + + + + Gets or sets whether a given gengrid item is selected. + If one gengrid item is selected, any other previously selected items get unselected in favor of this new one. + + + If true, it is selected. + If false, it is unselected. + + + + + Gets or sets the style of given gengrid item's tooltip. + + + + + Gets or sets gengrid item's row position, relative to the whole gengrid's grid area. + + + + + Gets or sets gengrid item's column position, relative to the whole gengrid's grid area. + + + + + Updates the content of a given gengrid item. + This updates an item by calling all the genitem class functions again to get the content, text, and states. + Use this when the original item data has changed and you want the changes to reflect. + + + to update the contents of all the realized items. + + + + + Enumeration for select mode of GenItem. + + + + + Default select mode. + + + + + Always select mode. + + + + + No select mode. + + + + + No select mode with no finger size rule. + + + + + It inherits . + A base class for and . + It contains genitem class and data to display data. + + + + + The delegate returning the tooltip contents. + + + + + Gets the item class that defines how to display data. It returns type. + + + + + It's a abstract property. It's implemented by and . + + + + + Gets item data that is added through calling , or methods. + + + + + It's a abstract property. It's implemented by and . + + + + + It's a abstract property. It's implemented by and . + + + + + It's a abstract method. It's implemented by and . + + + + + The override method for delete item class and item data. It's called when the item is deleting. + + + + + It represents the GenGrid or GenList item class definition field details. + It has some display styles, such as "default", "full" and "group_index". + + + + + The delegate to define . + + The item data. + The part where the data should be shown. + Return string that should be shown. + + + + The delegate to define . + + The item data. + The part where the data should be shown. + Return content that should be shown. + + + + The delegate to define . + + The item data. + + + + The delegate to define . + + The item data. + The part where the data should be shown. + The content has been added in gengrid. + Return content that should be shown. + + + + Creates and initializes a new instance of the GenItemClass. + + The item display style. + + + + Gets the item style. + + + + + Gets or sets the callback that defines how to display item text. + If get, return . + + + + + Gets or sets the callback that defines how to display item content. + If get, return . + + + + + Gets or sets the callback that defines how to delete item text and content. + If get, return . + + + + + Gets or sets the callback that defines how to reuse item content. + If get, return . + + + + + Enumeration for setting genlist item type. + + + + + if Normal is set then this item is normal item. + + + + + If tree is set then this item is displayed as an item that is able to expand and have child items. + + + + + if Group is set then this item is group index item that is displayed at the top until the next group comes. + + + + + Enumeration for setting genlist's resizing behavior, transverse axis scrolling and items cropping. + + + + + The genlist won't set any of its size hints to inform how a possible container should resize it. + Then, if it's not created as a "resize object", it might end with zeroed dimensions. + The genlist will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. + + + + + This is the same as Compress, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction. + + + + + Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly). + More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. + This is naturally bound by the genlist object's maximum size hints, set externally. + + + + + Besides setting a minimum size on the transverse axis, just like on Limit, the genlist will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. + This is naturally bound by the genlist object's maximum size hints, set externally. + + + + + It inherits System.EventArgs. + It contains Item which is type. + All events of GenList contain GenListItemEventArgs as a parameter. + + + + + Gets or sets GenList item. The return type is . + + + + + Enumeration that defines where to position the item in the genlist. + + + + + Scrolls to nowhere. + + + + + Scrolls to the nearest viewport. + + + + + Scrolls to the top of the viewport. + + + + + Scrolls to the middle of the viewport. + + + + + Scrolls to the bottom of the viewport. + + + + + It inherits . + The GenList is a widget that aims to have more expansive list than the simple in ElmSharp that could have more flexible items and allow many more entries while still being fast and low on memory usage. + At the same time it was also made to be able to do tree structures. + But the price to pay is more complexity when it comes to usage. + If all you want is a simple list with icons and a single text, use the widget. + + + + + Creates and initializes a new instance of the GenList class. + + The parent is a given container which will be attached by GenList as a child. It's type. + + + + Gets or sets whether the homogeneous mode is enabled. + + + If true, the genlist items have same height and width. + + + + + Gets or sets the horizontal stretching mode. This mode used for sizing items horizontally. + The default value is which means that if items are too wide to fit, the scroller scrolls horizontally. + If set which means that the item width is fixed (restricted to a minimum of) to the list width when calculating its size in order to allow the height to be calculated based on it. + If set which means that items are expanded to the viewport width and limited to that size. + if set which means that genlist try to reserve space to all its items to be visible at a time. + + + Compress makes genlist resize slower as it recalculates every item height again whenever the list width changes. + The homogeneous mode is so that all items in the genlist are of the same width/height. With Compress, genlist items are initialized fast. + However, there are no sub-objects in the genlist which can be on the flying resizable (such as TEXTBLOCK). + If so, then some dynamic resizable objects in the genlist would not be diplayed properly. + + + + + Gets the first item in the genlist. + + + + + Gets the last item in the genlist. + + + + + Gets or sets the reorder mode. + After turning on the reorder mode, longpress on a normal item triggers reordering of the item. + You can move the item up and down. However, reordering does not work with group items. + + + + + Gets or set the maximum number of items within an item block. + + + + + Gets or sets whether the genlist items should be highlighted when an item is selected. + + + + + Gets or sets the timeout in seconds for the longpress event. + + + + + Gets or sets whether enable multi-selection in the genlist. + + + + + Gets the selected item in a given genlist widget. + + + + + Gets or sets the genlist select mode by . + + + + + ItemSelected is raised when a new genlist item is selected. + + + + + ItemUnselected is raised when the genlist item is Unselected. + + + + + ItemPressed is raised when a new genlist item is pressed. + + + + + ItemReleased is raised when a new genlist item is released. + + + + + ItemActivated is raised when a new genlist item is double clicked or pressed (enter|return|spacebar). + + + + + ItemDoubleClicked is raised when a new genlist item is double clicked. + + + + + ItemExpanded is raised when a new genlist item is indicated to expand. + + + + + ItemRealized is raised when a new genlist item is created as a real object. + + + + + ItemUnrealized is raised when a new genlist item is unrealized. + After calling unrealize, the item's content objects are deleted and the item object itself is deleted or is put into a floating cache. + + + + + ItemLongPressed is raised when a genlist item is pressed for a certain amount of time. By default it's 1 second. + + + + + ItemMoved is raised when a genlist item is moved in the reorder mode. + + + + + ItemMovedAfter is raised when a genlist item is moved after another item in the reorder mode. + To get the relative previous item, use . + + + + + ItemMovedBefore is raised when a genlist item is moved before another item in the reorder mode. + To get the relative next item, use . + + + + + Changed is raised when genlist is changed. + + + + + ScrollAnimationStarted is raised when scrolling animation has started. + + + + + ScrollAnimationStopped is raised when scrolling animation has stopped. + + + + + Appends a new item to the end of a given genlist widget. + + The itemClass defines how to display the data. + The item data. + Return a new added genlist item that contains data and itemClass. + + + + + + Appends a new item with to the end of a given genlist widget. + + The itemClass defines how to display the data. + The item data. + The genlist item type. + Return a new added genlist item that contains data and itemClass. + + + + Appends a new item with to the end of a given genlist widget or the end of the children list if the parent is given. + + The itemClass defines how to display the data. + The item data. + The genlist item type. + The parent item, otherwise null if there is no parent item. + Return a new added genlist item that contains data and itemClass. + + + + Prepends a new item to the beginning of a given genlist widget. + + The itemClass defines how to display the data. + The item data. + Return a new added genlist item that contains data and itemClass. + + + + Prepends a new item with to the beginning of a given genlist widget. + + The itemClass defines how to display the data. + The item data. + The genlist item type. + Return a new added genlist item that contains data and itemClass. + + + + Prepends a new item with to the beginning of a given genlist widget or the beginning of the children list if the parent is given. + + The itemClass defines how to display the data. + The item data. + The genlist item type. + The parent item, otherwise null if there is no parent item. + Return a new added genlist item that contains data and itemClass. + + + + Inserts an item before another item in a genlist widget. + It is the same tree level or group as the item before which it is inserted.???? + + The itemClass defines how to display the data. + The item data. + The item before which to place this new one. + Return a new added genlist item that contains data and itemClass. + + + + Inserts an item with before another item in a genlist widget. + It is the same tree level or group as the item before which it is inserted.???? + + The itemClass defines how to display the data. + The item data. + The item before which to place this new one. + The genlist item type. + Return a new added genlist item that contains data and itemClass. + + + + Inserts an item with before another item under a parent in a genlist widget. + + The itemClass defines how to display the data. + The item data. + The item before which to place this new one. + The genlist item type. + The parent item, otherwise null if there is no parent item. + Return a new added genlist item that contains data and itemClass. + + + + Inserts an item with after another item under a parent in a genlist widget. + + The itemClass defines how to display the data. + The item data. + The item after which to place this new one. + The genlist item type. + The parent item, otherwise null if there is no parent item. + Return a new added genlist item that contains data and itemClass. + + + + Insert an item in a genlist widget using a user-defined sort function. + + The itemClass defines how to display the data. + The item data. + User defined comparison function that defines the sort order based on genlist item and its data. + The genlist item type. + The parent item, otherwise null if there is no parent item. + Return a genlist item that contains data and itemClass. + + + + Shows the given item with position type in a genlist. + When animated is true, genlist will jump to the given item and display it (by animatedly scrolling), if it is not fully visible. This may use animation and may take some time. + When animated is false, genlist will jump to the given item and display it (by jumping to that position), if it is not fully visible. + + The item to display. + The position to show the given item to . + The animated indicates how to display the item, by scrolling or by jumping. + + + + Updates the content of all the realized items. + This updates all the realized items by calling all the again to get the content, text and states. + Use this when the original item data has changed and the changes are desired to reflect. + To update just one item, use . + + + + + + Removes all items from a given genlist widget. + This removes (and deletes) all items in obj, making it empty. + To delete just one item, use . + + + + + + Get the item that is at the x, y canvas coords. + + The input x coordinate + The input y coordinate + The position relative to the item returned here + -1, 0, or 1, depending on whether the coordinate is on the upper portion of that item (-1), in the middle section (0), or on the lower part (1). + + + + + + Gets the nth item in a given genlist widget, placed at position nth, in its internal items list. + + The number of the item to grab (0 being the first) + + + + + The type of item's part type. + + + + + All item's parts. + + + + + The text part type. + + + + + The Content part type. + + + + + The state of part. + + + + + No part type. + + + + + It inherits . + A instance to the genlist item added. + It contains Update() method to update a genlist item which is given. + + + + + Gets or sets whether a given genlist item is selected. + + + + + Gets or sets whether a given genlist item is expanded. + + + + + Updates the content of an item. + This updates an item by calling all the again to get the content, text, and states. + Use this when the original item data has changed and the changes are desired to reflect. + To update already realized items, use . + + + + + + Updates the part of an item. + This updates an item's part by calling item's fetching functions again to get the contents, texts and states. + Use this when the original item data has changed and the changes are desired to be reflected. + To update an item's all property, use . + + The part could be "elm.text", "elm.swalllow.icon", "elm.swallow.end", "elm.swallow.content" and so on. It is also used for globbing to match '*', '?', and '.'. It can be used at updating multi fields. + The type of item's part type. + + + + + Demote an item to the end of the list. + + + + + Gets or sets the genlist item's select mode. + + + + + Gets the next item in a genlist widget's internal list of items. + + + + + + Get the previous item in a genlist widget's internal list of items. + + + + + + Gets or sets the style of given genlist item's tooltip. + + + + + Gets or sets whether disable size restrictions on an object's tooltip. + + + + + Gets the index of the item. It is only valid once displayed. + + + + + Gets the depth of expanded item. + + + + + Remove all sub-items (children) of the given item. + + + This removes all items that are children (and their descendants) of the given item it. + + + + + Update the item class of an item. + This sets another class of the item, changing the way that it is displayed. After changing the item class, is called on the item. + + The item class for the item. + The data for the item. + + + + The GestureLayer is used to detect gestures. + Inherits Widget + + + + + Creates and initializes a new instance of GestureLayer class. + + The parent is a given container which will be attached by GestureLayer as a child. It's type. + + + + Enumeration for supported gesture types. + + + + + N fingers single taps + + + + + N fingers single long-taps + + + + + N fingers double-single taps + + + + + N fingers triple-single taps + + + + + Reports momentum in the direction of move + + + + + N fingers line gesture + + + + + N fingers flick gesture + + + + + Zoom + + + + + Rotate + + + + + Enumeration for gesture states. + + + + + Gesture not started + + + + + Gesture started + + + + + Gesture is ongoing + + + + + Gesture completed + + + + + Ongoing gesture is aborted + + + + + Sets or gets the repeat-events setting. + + + + + Sets or gets the gesture layer continues enable of an object + + + + + Sets or gets the gesture layer finger-size for taps. + + + + + Sets or gets the gesture layer long tap start timeout of an object + + + + + Sets or gets the gesture layer double tap timeout of an object + + + + + Sets or gets the gesture layer flick time limit (in ms) of an object + + + + + Sets or gets the gesture layer line min length of an object + + + + + Sets or gets the gesture layer line angular tolerance of an object + + + + + Sets or gets the gesture layer line distance tolerance of an object + + + + + Sets or gets step-value for rotate action. + + + + + Sets or gets the gesture layer rotate angular tolerance of an object + + + + + Sets or gets control step value for zoom action. + + + + + Sets or gets the gesture layer zoom distance tolerance of an object + + + + + Sets or gets the gesture layer zoom finger factor of an object + + + + + Sets or gets the gesture layer zoom wheel factor of an object + + + + + Attach a gesture layer widget to an Evas object (setting the widget's target). + A gesture layer's target may be any Evas object. This object will be used to listen to mouse and key events. + + The object to attach. + + + + Set the gesture state change callback. + When all callbacks for the gesture are set to null, it means this gesture is disabled. + + The gesture you want to track state of. + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + clear the gesture state change callback. + + + + + Set the tap callback. + + The gesture you want to track state of. + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Set the gesture state change callback with Momentum Gesture Type + + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Set the gesture state change callback with Line Gesture Type + + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Set the gesture state change callback with Flick Gesture Type + + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Set the gesture state change callback with Zoom Gesture Type + + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Set the gesture state change callback with Rotate Gesture Type + + The event the callback tracks (START, MOVE, END, ABORT). + The callback itself. + + + + Call this function to construct a new gesture-layer object. + + The gesture layer's parent widget. + + + + + clear the gesture state change callback. + + + + + The struct of TapData + + + + + The x coordinate of the center point. + + + + + The y coordinate of the center point. + + + + + The number of fingers tapped. + + + + + The timestamp. + + + + + The struct of MomentumData + + + + + Final-swipe direction starting point on X. + + + + + Final-swipe direction starting point on Y. + + + + + Final-swipe direction ending point on X. + + + + + Final-swipe direction ending point on Y + + + + + Timestamp of start of final x-swipe. + + + + + Timestamp of start of final y-swipe. + + + + + Momentum on X. + + + + + Momentum on Y. + + + + + Number of fingers. + + + + + The struct of LineData + + + + + Final-swipe direction starting point on X. + + + + + Final-swipe direction starting point on Y. + + + + + Final-swipe direction ending point on X. + + + + + Final-swipe direction ending point on Y + + + + + Timestamp of start of final x-swipe. + + + + + Timestamp of start of final y-swipe. + + + + + Momentum on X. + + + + + Momentum on Y. + + + + + Number of fingers. + + + + + Angle (direction) of lines. + + + + + The struct of ZoomData + + + + + The x coordinate of zoom center point reported to user. + + + + + The y coordinate of zoom center point reported to user. + + + + + The radius (distance) between fingers reported to user. + + + + + The zoom value. 1.0 means no zoom. + + + + + Zoom momentum: zoom growth per second (NOT YET SUPPORTED). + + + + + The struct of RotateData + + + + + The x coordinate of rotation center point reported to user. + + + + + The y coordinate of rotation center point reported to user. + + + + + The radius (distance) between fingers reported to user. + + + + + The start-angle. + + + + + The rotation value. 0.0 means no rotation. + + + + + Rotation momentum: rotation done per second (NOT YET SUPPORTED). + + + + + Config is a static class, it provides gestureLayer's timeout information. + + + + + Sets or gets the duration for occurring long tap event of gesture layer. + + + + + Sets or gets the duration for occurring double tap event of gesture layer. + + + + + The HoverselItemEventArgs is an HoverselItem's EventArgs + + + + + Hoversel's Item + + + + + The hoversel is a button that pops up a list of items. + + + + + Creates and initializes a new instance of the Hoversel class. + + The parent is a given container which will be attached by Hoversel as a child. It's type. + + + + Clicked will be triggered when Hoversel is clicked + + + + + Expanded will be triggered when Hoversel is activated by clicking the hoversel or by a function + + + + + Dismissed will be triggered when Hoversel Dismissed + + + + + ItemSelected will be triggered when Hoversel's Item Selected + + + + + Gets or sets the status to control whether the hoversel should expand horizontally. + + + + + Gets or sets the hover parent. + + + + + Gets the flag of whether the hoversel is expanded. + + + + + Gets or sets the status of whether update icon and text of hoversel same to those of selected item automatically. + + + + + This triggers the hoversel popup from code, the same as if the user had clicked the button. + + + + + This dismisses the hoversel popup as if the user had clicked outside the hover. + + + + + This will remove all the children items from the hoversel. + + + + + Add an item to the hoversel button. + This adds an item to the hoversel to show when it is clicked. + + Item's label + A handle to the added item. + + + + The HoverselItem is the Item of Hoversel + + + + + HoverselItem's label + + + + + ItemSelected will be triggered when HoverselItem Selected + + + + + Enumeration for the icon lookup order. Should look for icons in the theme, FDO paths, or both. + + + + + Icon look up order: freedesktop, theme + + + + + Icon look up order: theme, freedesktop + + + + + Icon look up order: freedesktop + + + + + Icon look up order: theme + + + + + The Icon is a widget that displays standard icon images ("delete", "edit", "arrows", etc.) + or images coming from a custom file (PNG, JPG, EDJE, etc.), on icon context. + Inherits Image + + + + + Creates and initializes a new instance of Icon class. + + The parent is a given container which will be attached by Icon as a child. It's type. + + + + Sets or gets the standard icon name of a given Icon widget. + + + + + Sets or gets the icon lookup order of a given Icon widget. + + + + + Sets the file that is used, but uses a generated thumbnail. + + The path to the file that is used as an icon image + The group that the icon belongs to + + + + Adds a new icon object to the parent. + + EvasObject + The new object, otherwise NULL if it cannot be created + + + + The Image is a widget that allows one to load and display an image file on it, + be it from a disk file or from a memory region. + Inherits Widget + + + + + Creates and initializes a new instance of Image class. + + The parent is a given container which will be attached by Image as a child. It's type. + + + + Clicked will be triggered when the image is clicked. + + + + + LoadingCompleted will be triggered when the image is loaded completely. + + + + + Clicked will be triggered when the image is fail to load. + + + + + Gets the file that is used as an image. + + + + + Sets or gets the smooth effect for an image. + + + + + Sets or gets whether scaling is disabled on the object. + + + + + Sets or gets whether the object is down resizeable. + + + + + Sets or gets whether the object is up resizeable. + + + + + Sets or gets whether the image fills the entire object area, when keeping the aspect ratio. + + + + + Sets or gets the prescale size for the image. + + + + + Sets or gets whether the original aspect ratio of the image should be kept on resize. + + + + + Sets or gets whether an image object (which supports animation) is to animate itself. + + + + + Gets whether an image object supports animation. + + + + + Sets or gets whether an image object is under animation. + + + An image object, even if it supports animation, will be displayed by default without animation. + To actually start playing any image object's animation, should be TRUE before setting this property true. + + + + + Sets or gets whether the image is 'editable'. + + + + + Gets the current size of the image. + + + + + Sets or gets whether alpha channel data is being used on the given image object. + + + + + Sets or gets the image orientation. + + + + + Sets or gets the image color + + + + + Sets the background color + + + + + Sets the dimensions for an image object's border, a region which is not scaled together with its center ever. + + The border's left width + The border's right width + The border's top width + The border's bottom width + + + + Sets or gets if the center part of the given image object (not the border) should be drawn. + + + When rendering, the image may be scaled to fit the size of the image object. + This function sets if the center part of the scaled image is to be drawn or left completely blank, or forced to be solid. + Very useful for frames and decorations. + + + + + Sets the file that is used as the image's source. + + The path to the file that is used as an image source + (true = success, false = error) + + + + Sets the uri that is used as the image's source. + + The uri to the file that is used as an image source + (true = success, false = error) + + + + Sets a location in the memory to be used as an image object's source bitmap. + + + This function is handy when the contents of an image file are mapped into the memory, for example. + The format string should be something like "png", "jpg", "tga", "tiff", "bmp" etc, when provided (null, on the contrary). + This improves the loader performance as it tries the "correct" loader first, before trying a range of other possible loaders until one succeeds. + + The binary data that is used as an image source + The size of the binary data blob img + (true = success, false = error) + + + + Sets the stream that is used as the image's source. + + The stream that is used as an image source + (true = success, false = error) + + + + Sets the file that is used as the image's source with async. + + The path to the file that is used as an image source + cancellation token + (true = success, false = error) + + + + Sets the uri that is used as the image's source with async. + + The uri to the file that is used as an image source + cancellation token + (true = success, false = error) + + + + Sets the stream that is used as the image's source with async. + + The stream that is used as an image source + cancellation token + (true = success, false = error) + + + + Sets the color of color class for a given widget. + + The name of color class. + The struct of color + + + + Gets the color of color class for a given widget. + + The name of color class. + color object + + + + Sets the content at a part of a given container widget. + + The parent is a given container which will be attached by Image as a child. It's type. + The new object, otherwise null if it cannot be created + + + + Enumeration for the fill mode of image border + + + + + None mode of image border + + + + + Default mode of image border + + + + + Solid mode of image border + + + + + Enumeration for the possible orientation options + + + + + No orientation change + + + + + Rotate 90 degrees clockwise + + + + + Rotate 180 degrees clockwise + + + + + Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) + + + + + Flip image horizontally + + + + + Flip image vertically + + + + + Flip the image along the y = (width - x) line (bottom-left to top-right) + + + + + Flip the image along the y = x line (top-left to bottom-right) + + + + + An index widget gives you an index for fast access to whichever group of other UI items one might have. + Inherits Layout + + + + + Creates and initializes a new instance of Index class. + + The parent is a given container which will be attached by Index as a child. It's type. + + + + Changed will be triggered when the selected index item is changed. + + + + + Sets or gets the auto hiding feature is enabled or not for a given index widget. + + + + + Sets or gets a value whether horizontal mode is enabled or not. + + + + + Sets or gets the value of indicator's disabled status. + + + + + Sets or gets the omit feature is enabled or not for a given index widget. + + + + + Set a delay change time for index object. + delay time is 0.2 sec by default. + + + + + Gets or sets the items level for a given index widget. + + + + + Control standard_priority group of index. + Priority group will be shown as many items as it can, and other group will be shown one character only. + + + + + Gets the last selected item, for a given index widget. + + + + + Append a new item on a given index widget. + + the label which the item should be indexed + A object to the IndexItem added or null, on errors + + + + Prepend a new item on a given index widget. + + the label which the item should be indexed + A handle to the item added or NULL, on errors + + + + Insert a new item into the index object before item before. + + the label which the item should be indexed + The index item to insert after. + A object to the IndexItem added or null, on errors + + + + Insert a new item into the index object after item after. + + the label which the item should be indexed + The index item to insert after. + A object to the IndexItem added or null, on errors + + + + Flush the changes made to the index items so they work correctly. + + The index level (one of 0 or 1) where changes were made + + + + Removes all items from a given index widget. + + + + + The IndexItem is used to manage index item + Inherits ItemObject + + + + + Creates and initializes a new instance of IndexItem class. + + the text is set to the Text. It's 'string' type. + + + + Selected will be triggered when the index item is selected + + + + + Gets the text + + + + + Sets the selected state of an item. + + The selected state + + + + The ItemObject is used to manage item object + + + + + Creates and initializes a new instance of ItemObject class. + + IntPtr + + + + Gets the id of item object + + + + + Sets or gets whether the item object is enabled + + + + + Gets track object of the item. + + + + + Deleted will be triggered when the item object is deleted + + + + + Delete the item object + + + + + Set a content of an object item and delete old content + + The content part name (null for the default content) + The content of the object item + + + + Set a content of an object item + + The content part name (null for the default content) + The content of the object item + judge whether delete old content + + + + Set a label of an object item + + The text part name (null for the default label) + Text of the label + + + + Gets a label of an object item + + The text part name (null for the default label) + + + + + Sets color of an object item + + The text part name (null for the default label) + the color + + + + Gets color of an object item + + The text part name (null for the default label) + the color of object item + + + + Deletes color of an object item + + The text part name + + + + Add a function for a signal emitted by object item edje. + + The signal's name. + The signal's source. + The function to be executed when the signal is emitted. + + + + Remove a signal-triggered function from a object item edje object. + + The signal's name. + The signal's source. + The function to be executed when the signal is emitted. + + + + Send a signal to the edje object of the widget item. + + The signal's name. + The signal's source. + + + + Gets the handle of object item + + ItemObject + + + + OnInvalidate of object item + + + + + The ItemObjectExtension is used to manage item object extension + + + + + Grab high light of item object + + the item object which is grabbed high light + + + + Clear high light of item object + + the item object which is cleared high light + + + + Label is a widget to display text, with simple html-like markup. + Inherits Layout + + + + + Creates and initializes a new instance of Label class. + + The parent is a given container which will be attached by Label as a child. It's type. + + + + SlideCompleted will be triggered when the slide is completed. + + + + + Sets or gets wrap width of the label. + + + + + Sets or gets the wrapping behavior of the label. + + + + + Sets or gets the slide mode of the label widget. + + + + + Sets or gets the slide duration of the label. + + + + + Sets or gets the slide Speed of the label. + + + The speed of the slide animation in px per seconds. + If you set the duration of the slide using elm_label_slide_duration_set() you cannot get the correct speed using this function until the label is actually rendered and resized. + + + + + + Sets or gets the ellipsis behavior of the label. + + + + + Sets or gets the style of the label text. + + + APIs, elm_label_text_style_user_peek/pop/push, are internal APIs only in Tizen. Avalilable since Tizen_4.0. + + + + + + Start slide effect. + + + + + Sets the content at a part of a given container widget. + + EvasObject + The new object, otherwise null if it cannot be created + + + + Enumeration for slide mode of a label widget + + + + + no slide effect + + + + + slide only if the label area is bigger than the text width length + + + + + slide always + + + + + This is a container widget that takes a standard Edje design file and wraps it very thinly in a widget. + Inherits Widget + + + + + Creates and initializes a new instance of Layout class. + + The parent is a given container which will be attached by Layout as a child. It's type. + + + + LanguageChanged will be triggered when the program's language is changed. + + + + + ThemeChanged will be triggered when the theme is changed. + + + + + Gets the edje layout. + + + + + Gets or sets accessibility state of texblock(text) parts in the layout object. + + + + + Freezes the Elementary layout object. + This function puts all changes on hold. + Successive freezes will nest, requiring an equal number of thaws. + + The frozen state or 0 if the object is not frozen or on error. + + + + Thaws the Elementary object. + If sucessives freezes were done, an equal number of thaws will be required. + + The frozen state or 0 if the object is not frozen or on error. + + + + Eval sizing. + Manually forces a sizing re-evaluation. + This is useful when the minimum size required by the edje theme of this layout has changed. + The change on the minimum size required by the edje theme is not immediately reported to the elementary layout, so one needs to call this function in order to tell the widget (layout) that it needs to reevaluate its own size. + The minimum size of the theme is calculated based on minimum size of parts, the size of elements inside containers like box and table, etc. + All of this can change due to state changes, and that's when this function should be called. + + + + + Request sizing reevaluation, restricted to current width and/or height. + Useful mostly when there are TEXTBLOCK parts defining the height of the object and nothing else restricting it to a minimum width.Calling this function will restrict the minimum size in the Edje calculation to whatever size it the layout has at the moment. + + Restrict minimum size ot the current width. + Restrict minimum size ot the current height. + + + + Get the edje data from the given layout. + This function fetches data specified inside the edje theme of this layout. + This function return NULL if data is not found. + + The data key + The data + + + + Gets the text set in the given part. + + The TEXT part to retrieve the text off. + + + + + Sets the text set in the given part. + + The TEXT part to retrieve the text off. + The text to set. + + + + + Append child to layout box part. + Once the object is appended, it will become child of the layout. + Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + + The part + The Object to append + Sucess is true + + + + Prepend child to layout box part. + Once the object is prepended, it will become child of the layout. + Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + + The part + The Object to prepend + Sucess is true + + + + Remove a child of the given part box. + The object will be removed from the box part and its lifetime will not be handled by the layout anymore. + + The part + The Object to remove + Sucess is true + + + + Remove all children of the given part box. + The objects will be removed from the box part and their lifetime will not be handled by the layout anymore. + + The part + If true, then all objects will be deleted as well, otherwise they will just be removed and will be dangling on the canvas. + Sucess is true + + + + Insert child to layout box part at a given position. + Once the object is inserted, it will become child of the layout. + Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + + The part + The child object to insert into box. + The numeric position >=0 to insert the child. + Sucess is true + + + + Insert child to layout box part before a reference object. + Once the object is inserted, it will become child of the layout. + Its lifetime will be bound to the layout, whenever the layout dies the child will be deleted automatically. + + + The child object to insert into box. + Another reference object to insert before in box. + Sucess is true + + + + Sets the layout content. + + The swallow part name in the edje file + The child that will be added in this layout object. + TRUE on success, FALSE otherwise + + + + Sets the layout content. + + The name of particular part + The content + true, preserve old content will be unset. false, preserve old content will not be unset. + TRUE on success, FALSE otherwise + + + + Sets the edje group from the elementary theme that is used as a layout. + + The class of the group + The group + The style to use + + + + Sets the file that is used as a layout. + + The path to the file (edj) that is used as a layout + The group that the layout belongs to in the edje file + + + + Sets the back ground color of layout + + + + + Sets the vertical text alignment of layout's text part + + + API, elm_layout_text_valign_set, is an internal API only in Tizen. Avalilable since Tizen_4.0. + + + + + Gets the vertical text alignment of layout's text part + + + API, elm_layout_text_valign_get, is internal API only in Tizen. Avalilable since Tizen_4.0. + + + + + Sets the content at a part of a given container widget. + + The parent is a given container which will be attached by Layout as a child. It's type. + The new object, otherwise null if it cannot be created + + + + Enumeration for setting list's resizing behavior, transverse axis scrolling and items cropping. + + + + + The list won't set any of its size hints to inform how a possible container should resize it. + Then, if it's not created as a "resize object", it might end with zeroed dimensions. + The list will respect the container's geometry and, if any of its items won't fit into its transverse axis, one won't be able to scroll it in that direction. + + + + + This is the same as Compress, with the exception that if any of its items won't fit into its transverse axis, one will be able to scroll it in that direction. + + + + + Sets a minimum size hint on the genlist object, so that containers may respect it (and resize itself to fit the child properly). + More specifically, a minimum size hint will be set for its transverse axis, so that the largest item in that direction fits well. + This is naturally bound by the list object's maximum size hints, set externally. + + + + + Besides setting a minimum size on the transverse axis, just like on Limit, the list will set a minimum size on th longitudinal axis, trying to reserve space to all its children to be visible at a time. + This is naturally bound by the list object's maximum size hints, set externally. + + + + + It inherits System.EventArgs. + It contains Item which is type. + All events of List contain ListItemEventArgs as a parameter. + + + + + Gets or sets List item. The return type is . + + + + + It inherits . + The List is a widget that aims to display simple list item which has 2 icons and 1 text, and can be selected. + For more robust lists, should probably be used. + + + + + + + Creates and initializes a new instance of the List class. + + The parent is a given container which will be attached by List as a child. It's type. + + + + Gets or sets which mode to use for the list. + + + + + Gets the selected item. + + + + + ItemSelected is raised when a new list item is selected. + + + + + ItemUnselected is raised when the list item is Unselected. + + + + + ItemDoubleClicked is raised when a new list item is double clicked. + + + + + ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default it's 1 second. + + + + + ItemActivated is raised when a new list item is double clicked or pressed (enter|return|spacebar). + + + + + Starts the list. + Call before running on the list object. + If not called, it won't display the list properly. + + + + + Appends a new item with a text to the end of a given list widget. + + The text for the item. + Return a new added list item that contains a text. + + + + + Appends a new item with a text and 2 icons to the end of a given list widget. + + The text for the item. + The left icon for the item. + The right icon for the item. + Return a new added list item that contains a text and 2 icons. + + + + + Prepends a new item with a text to the beginning of a given list widget. + + The text for the item. + Return a new added list item that contains a text. + + + + Prepends a new item with a text and 2 icons to the beginning of a given list widget. + + The text for the item. + The left icon for the item. + The right icon for the item. + Return a new added list item that contains a text and 2 icons. + + + + Removes all items from a given list widget. + To delete just one item, use . + + + + + It inherits . + A instance to the list item added. + It contains Text, LeftIcon and RightIcon properties to show a list item which is given. + + + + + Gets the text for the list item. + + + + + Gets the left icon for the list item. + + + + + Gets the right icon for the list item. + + + + + It inherits . + The MultiButtonEntry is a widget letting an user enter text and each chunk of text managed as a set of buttons. + Each text button is inserted by pressing the "return" key. If there is no space in the current row, a new button is added to the next row. + When a text button is pressed, it will become focused. Backspace removes the focus. When the multi-button entry loses focus, items longer than one line are shrunk to one line. + The typical use case of multi-button entry is composing emails/messages to a group of addresses, each of which is an item that can be clicked for further actions. + + + + + Creates and initializes a new instance of the MultiButtonEntry class. + + The parent is a given container which will be attached by MultiButtonEntry as a child. It's type. + + + + Clicked is raised when a MultiButtonEntry is clicked. + + + + + Expanded is raised when a MultiButtonEntry is expanded. + + + + + Contracted is raised when a MultiButtonEntry is contracted. + + + + + ExpandedStateChanged is raised when shrink mode state of MultiButtonEntry is changed. + + + + + ItemSelected is raised when an item is selected by api, user interaction, and etc. + This is also raised when a user press back space while cursor is on the first field of entry. + + + + + ItemClicked is raised when an item is clicked by user interaction. + + + + + ItemLongPressed is raised when MultiButtonEntry item is pressed for a long time. + + + + + ItemAdded is raised when a new MultiButtonEntry item is added. + + + + + ItemDeleted is raised when a MultiButtonEntry item is deleted. + + + + + Gets the selected item in the multibuttonentry. + + + + + Gets or sets whether the multibuttonentry is editable or not. + + + + + Gets or sets the multibuttonentry to expanded state. + If true, expanded state. + If false, single line state. + + + + + Gets the first item in the multibuttonentry. + + + + + Gets the last item in the multibuttonentry. + + + + + Gets the entry object int the multibuttonentry. + + + + + Append a new item to the multibuttonentry. + + The label of new item. + A MultiButtonEntryItem to the item added. + + + + Prepend a new item to the multibuttonentry. + + The label of new item. + A MultiButtonEntryItem to the item added. + + + + Add a new item to the multibuttonentry before the indicated object reference. + + The item before which to add it. + The label of new item. + A MultiButtonEntryItem to the item added. + + + + Add a new item to the multibuttonentry after the indicated object. + + The item after which to add it. + The label of new item. + A MultiButtonEntryItem to the item added. + + + + Remove all items in the multibuttonentry. + + + + + Append an item filter function for text inserted in the Multibuttonentry. + + The function to use as item filter. + + + + Prepend a filter function for text inserted in the Multibuttonentry. + + The function to use as text filter. + + + + Remove a filter from the list. + + The filter function to remove. + + + + Set a function to format the string that will be used to display the hidden items counter. + If func is NULL, the default format will be used, which is "+ 'the hidden items counter'". + + The function to return string to show + + + + It inherits System.EventArgs. + The MultiButtonEntryItemEventArgs is a argument for all events of MultiButtonEntry. + It contains Item which is type. + + + + + Gets or sets MultiButtonEntryItem item. The return type is . + + + + + It inherits . + MutltiButtonEntryItem is a item which is added to MultiButtonEntry. + It contains Next and Prev properties to get next and previous item. + + + + + Creates and initializes a new instance of the MultiButtonEntryItem class. + + The text of MultiButtonEntryItem's Label name. + + + + Gets the label of this item. + + + + + Gets or sets the selected state of an item. + + + + + Get the next item in the multibuttonentry. + + + + + Get the previous item in the multibuttonentry. + + + + + The NaviframeEventArgs is a event args class for navi frame. + Inherits EventArgs + + + + + Sets or gets the content object. The name of content part is "elm.swallow.content". + + + + + Naviframe is a widget to stands for navigation frame. It's a views manager for applications. + Inherits Widget + + + + + Creates and initializes a new instance of Naviframe class. + + The parent is a given container which will be attached by Naviframe as a child. It's type. + + + + Popped will be triggered when NaviItem is removed. + + + It is always called when NaviItem was removed. + (even if removed by NaviItem.Delete()) + This event will be invoked in progress of Pop/Delete operation. + After called Popped event, Pop/Delete method will be returned + + + + + AnimationFinished will be triggered when animation is finished. + + + + + Gets the list of navi item + + + + + Sets or gets the the preserve content objects when items are popped. + + + + + Sets or gets whether the default back button is enabled + + + + + Push a new item to the top of the naviframe stack and show it. + The title and style are null. + + The main content object. The name of content part is "elm.swallow.content". + The created item or null upon failure. + + + + Push a new item to the top of the naviframe stack and show it. + The style are null. + + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + + + + + Push a new item to the top of the naviframe stack and show it. + + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + The current item style name. null would be default. + The created item or null upon failure. + + + + Insert a new item into the naviframe before item. + The title is "" and the style is null. + + The item which the new item is inserted before. + The main content object. The name of content part is "elm.swallow.content". + The created item or null upon failure. + + + + Insert a new item into the naviframe before item. + The style is null. + + The item which the new item is inserted before. + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + The created item or null upon failure. + + + + Insert a new item into the naviframe before item. + + The item which the new item is inserted before. + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + The current item style name. null would be default. + The created item or null upon failure. + + + + Insert a new item into the naviframe after item. + The title is "" and the style is null. + + The item which the new item is inserted after. + The main content object. The name of content part is "elm.swallow.content". + The created item or null upon failure. + + + + Insert a new item into the naviframe after item. + The style is null. + + The item which the new item is inserted after. + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + The created item or null upon failure. + + + + Insert a new item into the naviframe after item. + + The item which the new item is inserted after. + The main content object. The name of content part is "elm.swallow.content". + The current item title. null would be default. + The current item style name. null would be default. + The created item or null upon failure. + + + + Pop an item that is on top of the stack. + + + + + The NaviItem is a widget to contain the contents to show in Naviframe. + Inherits ItemObject + + + + + Popped will be triggered when NaviItem is removed. + + + + + Gets the content object. The name of content part is "elm.swallow.content". + + + + + Sets or gets a value whether title area is enabled or not. + + + + + Sets or gets the title bar background color + + + + + Sets or gets an item style. + + + + + Invalidate the EventArgs if _isPopped is false. + The method should be overridden in children class. + + + + + Enumeration for paneldirection type. + + + + + Top to bottom + + + + + Bottom to top + + + + + Left to right + + + + + Right to left + + + + + The Panel is a container that can contain subobjects. + + + + + Creates and initializes a new instance of Panel class. + + The EvasObject to which the new Panel will be attached as a child. + + + + Sets or gets the hidden status of a given Panel widget. + + + + + Sets or gets the direction of a given Panel widget. + + + + + Toggled will be triggered when toggles Panel. + + + + + Enable or disable scrolling in the Panel. + + + Bool value can be false or true. + + + + + Sets the scroll size of Panel. + + + The size of scroll area. + + + + + Toggles the hidden state of the Panel. + + + + + The Panes is a widget that adds a draggable bar between two contents. + When dragged this bar resizes contents' size. + + + + + Creates and initializes a new instance of the Panes class. + + The EvasObject to which the new Panes will be attached as a child. + + + + Pressed will be triggered when panes have been pressed (button isn't released yet). + + + + + Unpressed will be triggered when panes are released after being pressed. + + + + + Sets or gets resize mode of a given Panes widget. + True means the left and right panes resize homogeneously. + + + + + Sets or Gets the size proportion of the Panes widget's left side. + + + By default it's homogeneous, i.e., both sides have the same size.If something different is required, + it can be set with this function. For example, if the left content should be displayed over 75% of the panes size, + size should be passed as 0.75. This way, the right content is resized to 25% of the panes size. + If displayed vertically, left content is displayed at the top, and right content at the bottom. + This proportion changes when the user drags the panes bar. + + The value is float type and between 0.0 and 1.0 representing the size proportion of the left side. + + + + + Sets or gets the orientation of a given Panes widget. + + + Use this function to change how your panes is to be disposed: vertically or horizontally. + Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents. + By default panes is in a vertical mode. + + + + + Sets or gets the absolute minimum size of panes widget's left side. + If displayed vertically, left content is displayed at top. + value representing minimum size of left side in pixels. + + + + + Sets or gets the relative minimum size of panes widget's left side. + proportion of minimum size of left side. + If displayed vertically, left content is displayed at top. + value between 0.0 and 1.0 representing size proportion of minimum size of left side. + + + + + Sets or gets the absolute minimum size of panes widget's right side. + If displayed vertically, right content is displayed at top. + value representing minimum size of right side in pixels. + + + + + Sets or gets the relative minimum size of panes widget's right side. + proportion of minimum size of right side. + If displayed vertically, right content is displayed at top. + value between 0.0 and 1.0 representing size proportion of minimum size of right side. + + + + + The Point is a struct that defines a 2-D point as a pair of generic type. + + + + + Location along the horizontal axis. + + + + + Location along the vertical axis. + + + + + Whether the two s are equal. + + A on the left hand side. + A on the right hand side. + True if the two s have equal values. + + + + Whether two s are not equal. + + A on the left hand side. + A on the right hand side. + True if the two s do not have equal values. + + + + The Point3D is a Struct that defining a 3-D point. + + + + + The X coordinate of a 3D point. + + + + + The Y coordinate of a 3D point. + + + + + The Z coordinate of a 3D point. + + + + + Whether the two s are equal. + + A on the left hand side. + A on the right hand side. + True if the two s have equal values. + + + + Whether two s are not equal. + + A on the left hand side. + A on the right hand side. + True if the two s do not have equal values. + + + + The Polygon is a widget that used to draw a polygon (filled). + + + + + Creates and initializes a new instance of the Polygon class. + The EvasObject to which the new Polygon will be attached as a child. + + + + + Adds a new vertex to the Polygon. + The X coordinate of the new vertex. + The Y coordinate of the new vertex. + + + + + Adds a new vertex to the Polygon. + The coordinates of the new vertex. + + + + + Removes all the vertices of the Polygon, making it empty. + + + + + Enumeration for the popup orientation type. + + + + + Appears in the top of parent, default. + + + + + Appears in the center of parent. + + + + + Appears in the bottom of parent. + + + + + Appears in the left of parent. + + + + + Appears in the right of parent. + + + + + Appears in the top left of parent. + + + + + Appears in the top right of parent. + + + + + Appears in the bottom left of parent. + + + + + Appears in the bottom right of parent. + + + + + The Popup is a widget that is an enhancement of Notify. + In addition to content area, there are two optional sections, namely title area and action area. + + + + + Creates and initializes a new instance of the Popup class. + + The EvasObject to which the new Popup will be attached as a child. + + + + Dismissed will be triggered when Popup have been dismissed. + + + + + OutsideClicked will be triggered when users taps on the outside of Popup. + + + + + OutsideClicked will be triggered when Popup is closed as a result of timeout. + + + + + OutsideClicked will be triggered when the Popup transition is finished in showing. + + + + + Sets or gets the position in which Popup will appear in its parent. + + + + + Sets or gets the wrapping type of content text packed in content area of Popup widget. + + + + + + Sets or gets whether events should be passed to event blocked area by a click outside. + + + The visible region of popup is surrounded by a translucent region called Blocked Event area. + + + + + Sets or gets the AlignmentX in which the popup will appear in its parent. + + + + + Sets or gets the AlignmentY in which the popup will appear in its parent. + + + + + Gets the Opacity value of the Popup. + + + + + Adds label to a Popup widget. + + + The new PopupItem which contains label . + + + + Adds Label and icon to a Popup widget. + + The Label which will be added into a new PopupItem. + The icon which will be added into a new PopupItem. + The new PopupItem which contains label and icon. + + + + Uses this function to dismiss the popup in hide effect. + when the Popup is dismissed, the "dismissed" signal will be emitted. + + + + + The PopupItem is a class that including icon and text. + + + + + Gets the text label of popupitem.Return value is string. + + + + + Gets the icon EvasObject of popupitem. + + + + + The ProgressBar is a widget for visually representing the progress status of a given job/task. + + + + + Creates and initializes a new instance of the ProgressBar class. + + The EvasObject to which the new ProgressBar will be attached as a child. + + + + ValueChanged will be triggered when value of ProgressBar change. + + + + + Sets or gets the value wheather a given ProgressBar widget is at the "pulsing mode". + + + By default, progress bars display values from low to high value boundaries. + There are, though, contexts in which the progress of a given task is unknown. + For such cases, one can set a progress bar widget to a "pulsing state", + to give the user an idea that some computation is being held, + but without exact progress values. In the default theme, + it animates its bar with the contents filling in constantly and back to non-filled, in a loop. + + + + + Sets or gets the value of ProgressBar. + + + Use this property to set the progress bar levels. + If you pass a value out of the specified range(0.0~1.0), + it is interpreted as the closest of the boundary values in the range. + + + + + Sets or gets the span value of ProgressBar. + + + + + Sets or gets the value wheather a given ProgressBar widget is horizontal. + + + + + Sets or gets the value whether a given progress bar widget's displaying values are inverted. + + + + + Sets or gets format string for a given progress bar widget's units label. + + + If NULL is passed on format, it makes obj units area to be hidden completely. + If not, it sets the format string for the units label's text. + The units label is provided with a floating point value, so the units text displays at most one floating point value. + Note that the units label is optional. Use a format string such as "%1.2f meters" for example. + + + + + Starts a given progress bar "pulsing" animation, if its under that mode. + + + + + Stops a given progress bar "pulsing" animation, if its under that mode. + + + + + Gets the part value of the given part of the Progressbar. + + Part of the Progressbar. + Returns value range is from 0.0 to 1.0. + + + + Sets or gets the general or main color of the given Progressbar. + + + + + Sets the part value of the give part of the Progressbar. + + Part of the Progressbar. + Value range is from 0.0 to 1.0. + + + + The Radio is a widget that allows for 1 or more options to be displayed and have the user choose only 1 of them. + + + + + Creates and initializes a new instance of the Radio class. + + The EvasObject to which the new Radio will be attached as a child. + + + + ValueChanged will be triggered when value of Radio change. + + + + + Sets or gets a unique value to each Radio button. + + + + + Sets or gets the value of the radio group. + + + + + Adds this radio to a group of other radio objects. + + Group which add radio in. + + + + The Rect is a struct that represent rectangluar space. + + + + + Creates and initializes a new instance of the Rect class. + + X axis value. + Y axis value. + Width value. + Height value. + + + + Gets or sets the position of this Rectangle on the X axis. + + + + + Gets or sets the position of this Rectangle on the Y axis. + + + + + Gets or sets the width of this Rectangle. + + + + + Gets or sets the height of this Rectangle. + + + + + Gets the position of this Rectangle on the X axis. + + + + + Gets the extent along the X axis. + + + + + Gets the position of this Rectangle on the Y axis. + + + + + Gets the extent along the Y axis. + + + + + Gets the Point defined by Rectangle.Left and Rectangle.Top. + + + + + Gets the extent of the Rectangle along its X and Y axis. + + + + + Whether the two s are equal. + + A on the left hand side. + A on the right hand side. + True if the two s have equal values. + + + + Whether two s are not equal. + + A on the left hand side. + A on the right hand side. + True if the two s do not have equal values. + + + + The Rectangle is a class that used to draw a solid colored rectangle. + + + + + Creates and initializes a new instance of the Rectangle class. + + The to which the new Slider will be attached as a child. + + + + Enumeration for visible type of scrollbar. + + + + + Show scrollbars as needed + + + + + Always show scrollbars + + + + + Never show scrollbars + + + + + Enumeration for visible type of scrollbar. + + + + + Scrolling movement is allowed in both direction.(X axis and Y axis) + + + + + Scrolling movement is not allowed in Y axis direction. + + + + + Scrolling movement is not allowed in X axis direction. + + + + + Type that controls how the content is scrolled. + + + + + Scroll every direction. + + + + + Scroll single direction if the direction is certain. + + + + + Scroll only single direction. + + + + + The Scroller is a container that holds and clips a single object and allows you to scroll across it. + + + + + Creates and initializes a new instance of the Scroller class. + + The to which the new Scroller will be attached as a child. + + + + Scrolled will be triggered when the content has been scrolled. + + + + + DragStart will be triggered when dragging the contents around has started. + + + + + DragStop will be triggered when dragging the contents around has stopped. + + + + + PageScrolled will be triggered when the visible page has changed. + + + + + Gets the current region in the content object that is visible through the Scroller. + + + + + Sets or gets the value of HorizontalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the horizontal scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Sets or gets the value of VerticalScrollBarVisiblePolicy + + + ScrollBarVisiblePolicy.Auto means the vertical scrollbar is made visible if it is needed, and otherwise kept hidden. + ScrollBarVisiblePolicy.Visible turns it on all the time, and ScrollBarVisiblePolicy.Invisible always keeps it off. + + + + + Sets or gets the value of ScrollBlock. + + + This function will block scrolling movement in a given direction.One can disable movements in the X axis, the Y axis or both. + The default value is ScrollBlock.None, where movements are allowed in both directions. + + + + + Sets or gets scroll current page number. + + + Current page means the page which meets the top of the viewport. + If there are two or more pages in the viewport, it returns the number of the page which meets the top of the viewport. + The page number starts from 0. 0 is the first page. + + + + + Sets or gets scroll current page number. + + + Current page means the page which meets the left of the viewport. + If there are two or more pages in the viewport, it returns the number of the page which meets the left of the viewport. + The page number starts from 0. 0 is the first page. + + + + + Sets or gets the maximum limit of the movable page at vertical direction. + + + + + Sets or gets the maximum limit of the movable page at horizontal direction. + + + + + Sets or gets the vertical bounce behaviour. + When scrolling, the scroller may "bounce" when reaching an edge of the content object. + This is a visual way to indicate the end has been reached. + This is enabled by default for both axis. + This API will set if it is enabled for the given axis with the boolean parameters for each axis. + + + + + Sets or gets the horizontal bounce behaviour. + When scrolling, the scroller may "bounce" when reaching an edge of the content object. + This is a visual way to indicate the end has been reached. + This is enabled by default for both axis. + This API will set if it is enabled for the given axis with the boolean parameters for each axis. + + + + + Gets the width of the content object of the scroller. + + + + + Gets the height of the content object of the scroller. + + + + + Set scrolling gravity values for a scroller. + The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. + The scroller will adjust the view to glue itself as follows. + x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content + Default values for x and y are 0.0 + + + + + Set scrolling gravity values for a scroller. + The gravity, defines how the scroller will adjust its view when the size of the scroller contents increase. + The scroller will adjust the view to glue itself as follows. + x=0.0, for staying where it is relative to the left edge of the content x=1.0, for staying where it is relative to the rigth edge of the content y=0.0, for staying where it is relative to the top edge of the content y=1.0, for staying where it is relative to the bottom edge of the content + Default values for x and y are 0.0 + + + + + Get scroll last page number. + The page number starts from 0. 0 is the first page. This returns the last page number among the pages. + + + + + Get scroll last page number. + The page number starts from 0. 0 is the first page. This returns the last page number among the pages. + + + + + Set an infinite loop_ for a scroller. + This function sets the infinite loop vertically. + If the content is set, it will be shown repeatedly. + + + + + Set an infinite loop_ for a scroller. + This function sets the infinite loop horizontally. + If the content is set, it will be shown repeatedly. + + + + + Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. + + + + + Gets or sets a given scroller widget's scrolling page size, relative to its viewport size. + + + + + Gets or Sets the page snapping behavior of a scroller. + + + When scrolling, if a scroller is paged (see VerticalRelativePageSize), + the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further, + it will stop at the next page boundaries. This is disabled, by default, for both axis. + This function will set if it that is enabled or not, for each axis. + + + + + Gets or Sets the page snapping behavior of a scroller. + + + When scrolling, if a scroller is paged (see HorizontalRelativePageSize), + the scroller may snap to pages when being scrolled, i.e., even if it had momentum to scroll further, + it will stop at the next page boundaries. This is disabled, by default, for both axis. + This function will set if it that is enabled or not, for each axis. + + + + + Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. + + + + + Gets or sets the page size to an absolute fixed value, with 0 turning it off for that axis. + + + + + Gets or sets the event propagation for a scroller. + This enables or disables event propagation from the scroller content to the scroller and its parent. + By default event propagation is enabled. + + + + + Gets or sets the step size to move scroller by key event. + + + + + Gets or sets the step size to move scroller by key event. + + + + + Gets or sets a value whether mouse wheel is enabled or not over the scroller. + + + + + Gets or sets the type of single direction scroll. + + + + + Sets the scroller minimum size limited to the minimum size of the content. + By default the scroller will be as small as its design allows, irrespective of its content. + This will make the scroller minimum size the right size horizontally and/or vertically to perfectly fit its content in that direction. + + Enable limiting minimum size horizontally + Enable limiting minimum size vertically + + + + Sets the page size to an absolute fixed value, with 0 turning it off for that axis. + + The horizontal page size. + The vertical page size. + + + + Sets the scroll page size relative to the viewport size. + + + The scroller is capable of limiting scrolling by the user to "pages". + That is to jump by and only show a "whole page" at a time as if the continuous area of the scroller + content is split into page sized pieces. This sets the size of a page relative to the viewport of the scroller. + 1.0 is "1 viewport" which is the size (horizontally or vertically). 0.0 turns it off in that axis. + This is mutually exclusive with the page size (see elm_scroller_page_size_set() for more information). + Likewise 0.5 is "half a viewport". Usable values are normally between 0.0 and 1.0 including 1.0. + If you only want 1 axis to be page "limited", use 0.0 for the other axis. + + The horizontal page relative size. + The vertical page relative size. + + + + Shows a specific virtual region within the scroller content object by the page number. + (0, 0) of the indicated page is located at the top-left corner of the viewport. + + The horizontal page number. + The vertical page number. + True means slider with animation. + + + + Shows a specific virtual region within the scroller content object. + + + This ensures that all (or part, if it does not fit) of the designated region in the virtual content object ((0, 0) + starting at the top-left of the virtual content object) is shown within the scroller. + If set "animated" to true, it will allows the scroller to "smoothly slide" to this location + (if configuration in general calls for transitions). + It may not jump immediately to the new location and may take a while and show other content along the way. + + Rect struct of region. + True means allows the scroller to "smoothly slide" to this location. + + + + The Size is a struct that defining height and width as a pair of generic type. + + + + + Magnitude along the horizontal axis, in platform-defined units. + + + + + Magnitude along the vertical axis, in platform-specific units. + + + + + Initializes a new instance of the Size structure from the specified dimensions. + + The width to set + The height to set + + + + A human-readable representation of the . + + The string is formatted as "{{Width={0} Height={1}}}". + + + + Whether the two s are equal. + + A on the left hand side. + A on the right hand side. + True if the two s have equal values. + + + + Whether two s are not equal. + + A on the left hand side. + A on the right hand side. + True if the two s do not have equal values. + + + + Enumeration for the Slider's indicator visiblity mode. + + + + + Show indicator on mouse down or change in slider value. + + + + + Always show the indicator. + + + + + Show the indicator on focus. + + + + + Never show the indicator. + + + + + The Slider is a widget that adds a draggable slider widget for selecting the value of something within a range. + + + + + Creates and initializes a new instance of the Slider class. + + The to which the new Slider will be attached as a child. + + + + ValueChanged will be triggered when the Slider value is changed by the user. + + + + + DelayedValueChanged will be triggered when a short time after the value is changed by the user. + This will be called only when the user stops dragging for a very short period or when they release their finger/mouse, + so it avoids possibly expensive reactions to the value change. + + + + + DragStarted will be triggered when dragging the Slider indicator around has started. + + + + + DragStopped will be triggered when dragging the Slider indicator around has stopped. + + + + + Sets or gets the (exact) length of the bar region of a given Slider widget. + + + This sets the minimum width (when in the horizontal mode) or height (when in the vertical mode) + of the actual bar area of the slider obj. This in turn affects the object's minimum size. + Use this when you're not setting other size hints expanding on the given direction + (like weight and alignment hints), and you would like it to have a specific size. + + + + + Sets or gets the format string for the indicator label. + + + The slider may display its value somewhere other than the unit label, + for example, above the slider knob that is dragged around. This function sets the format string + used for this.If NULL, the indicator label won't be visible. If not, it sets the format string + for the label text. For the label text floating point value is provided, so the label text can + display up to 1 floating point value. Note that this is optional.Use a format string + such as "%1.2f meters" for example, and it displays values like: "3.14 meters" for a value + equal to 3.14159.By default, the indicator label is disabled. + + + + + Sets or gets the orientation of a given slider widget. + + + The orientation may be vertically or horizontally.By default, it's displayed horizontally. + + + + + Sets or gets the minimum values for the slider. + + + This defines the allowed minimum values to be selected by the user. + If the actual value is less than min, it is updated to min. + Actual value can be obtained with Value.By default, min is equal to 0.0. + + + + + Sets or gets the maximum values for the slider. + + + This defines the allowed maximum values to be selected by the user. + If the actual value is bigger then max, it is updated to max. + Actual value can be obtained with Value.By default, min is equal to 0.0, and max is equal to 1.0. + Maximum must be greater than minimum, otherwise the behavior is undefined. + + + + + Gets or sets the value displayed by the slider. + + + Value will be presented on the unit label following format specified with UnitFormat and + on indicator with IndicatorFormat.The value must to be between Minimum and Maximum values. + + + + + Sets or gets the step by which the slider indicator moves. + + + This value is used when the draggable object is moved automatically i.e., + in case of a key event when up/down/left/right key is pressed or in case accessibility + is set and the flick event is used to inc/dec slider values. + By default, the step value is equal to 0.05. + + + + + Gets or sets whether a given slider widget's displaying values are inverted. + + + A slider may be inverted, in which case it gets its values inverted, + with high values being on the left or top and low values on the right or bottom, + as opposed to normally have the low values on the former and high values on the latter, + respectively, for the horizontal and vertical modes. + + + + + Sets or gets whether to enlarge the slider indicator (augmented knob). + + + By default, the indicator is bigger when dragged by the user. + It won't display values set with IndicatorFormat if you disable the indicator. + + + + + Sets or gets the visible mode of slider indicator. + + + + + Sets or gets whether to Show the indicator of slider on focus. + + + + + It inherits . + The event with TEventArgs for . + EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. + This way, you can extend EvasObject's own . + They are defined by an event string, which identifies them uniquely. + + The parameter for the event. + + + + The delegate for creating smart event item args. + + The item data. + The sender obj. + The item sender obj. + Return smart event item args. + + + + Creates and initializes a new instance of the SmartEvent class. + + The source of the event. + The event name. + The event parameter. + + + + Creates and initializes a new instance of the SmartEvent class. + + The source of the event. + The event name. + + + + Adds or removes delegate for event. + + + + + Make current instance invalidate. + + + + + It inherits . + EvasObject can elect SmartEvent occurring inside of them to be reported back to their users via delegates. + This way, you can extend EvasObject's own . + They are defined by an event string, which identifies them uniquely. + + The parameter for the event. + + + + Creates and initializes a new instance of the SmartEvent class. + + The source of the event. + The event name. + + + + Adds or removes delegate for event. + + + + + Make current instance invalidate. + + + + + The Spinner is a widget that increase or decrease numeric values using arrow buttons, or edit values directly. + Inherits . + + + + + Creates and initializes a new instance of the Spinner class. + + The parent of new Spinner instance + + + + ValueChanged will be triggered whenever the spinner value is changed. + + + + + DelayedValueChanged will be triggered after a short time when the value is changed. + + + + + Sets or gets the label format of the spinner. + + + + + Sets or gets the minimum value for the spinner. + + + + + Sets or gets the maximum value for the spinner. + + + + + Sets or gets the step that used to increment or decrement the spinner value. + + + + + Sets or gets the value displayed by the spinner. + + + + + Sets or gets the interval on time updates for an user mouse button hold on spinner widgets' arrows. + + + + + Sets or gets the base for rounding. + + + + + Sets or gets the round value for rounding. + + + + + Sets or gets the wrap of a given spinner widget. + + + If wrap is disabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the maximum value. + If wrap is enabled, when the user tries to increment the value, but displayed value plus step value is bigger than maximum value, the new value will be the minimum value. + By default it's disabled. + + + + + Sets or gets whether the spinner can be directly edited by the user or not. + + By default it is enabled + + + + Set a special string to display in the place of the numerical value. + + The numerical value to be replaced + The label to be used + + + + Remove a previously added special value, After this, the spinner will display the value itself instead of a label. + + The replaced numerical value + + + + Get the special string display in the place of the numerical value. + + The replaced numerical value. + The value of the spinner which replaced numerical value with special string + + + + The Table is a container widget to arrange other widgets in a table where items can span multiple columns or rows . + Inherits . + + + + + Creates and initializes a new instance of the Table class. + + + A to which the new Table instance will be attached. + + + + + Sets or gets whether the layout of this table is homogeneous. + + True for homogeneous, False for no homogeneous + + + + Sets or gets the horizontal padding between the cells. + + + + + Sets or gets the vertical padding between the cells. + + + + + Adds a subobject on the table with the coordinates passed. + + The subobject to be added to the table + The column number + The row number + The column span + The row span + + + + Removes the child from the table. + + The subobject + + + + Removes all child objects from a table object. + + + + + Sets the color for particular part of the table. + + The name of part class + The color + + + + Gets the color of particular part of the table. + + The name of part class, it could be 'bg', 'elm.swllow.content' + The color of the particular part + + + + Enumeration for the selection mode of Toolbar. + + + + + Default select mode. + + + + + Always select mode. + + + + + No select mode. + + + + + No select mode with no finger size rule. + + + + + Enumeration that sets the toolbar items display behavior, it can be scrollable, can show a menu with exceeding items, or simply hide them. + + + + + Sets minimum toolbar size to fit all the items. + + + + + Hides exceeding items. + + + + + Allows accessing exceeding items through a scroller. + + + + + Inserts a button to pop up a menu with exceeding items. + + + + + Expands all items according to the size of the toolbar. + + + + + Enumeration for the icon lookup order of Toolbar. + + + + + Icon look up order: freedesktop, theme. + + + + + Icon look up order: theme, freedesktop. + + + + + Icon look up order: freedesktop. + + + + + Icon look up order: theme. + + + + + Event arguments for events of . + + + Inherits EventArgs. + + + + + Gets the ToolbarItem. + + + + + The Toolbar is a widget that displays a list of items inside a box. + + + + + Creates and initializes a new instance of the Toolbar class. + + + A EvasObject to which the new Table instance will be attached. + + + + + Selected will be triggered when toolbar have been selected. + + + + + Sets or gets whether the layout of this toolbar is homogeneous. + + True for homogeneous, False for no homogeneous + + + + Sets or gets the slection mode of a given Toolbar widget. + + + + + Sets or gets the shrink mode of a given Toolbar widget. + + + + + Sets or gets the icon lookup order, for toolbar items' icons. + The default lookup order is ToolbarIocnLookupOrder.ThemeFreedesktop. + Icons added before calling this function will not be affected. + + + + + Sets or gets the icon size of a given toolbar widget. + Default value is 32 pixels, to be used by toolbar items. + + + + + Gets the number of items in a toolbar widget. + + + + + Sets or gets the alignment of the items. + + The toolbar items alignment, a float between 0.0 and 1.0 + + + + Sets or gets the item's transverse expansion of a given toolbar widget. + + + The transverse expansion of the item, true for on and false for off. + By default it's false. + + + + + Appends ToolbarItem which just contains label to the toolbar. + + The label of the item + The new ToolbarItem which appended to the toolbar + + + + + + Appends ToolbarItem which contains label and icon to the toolbar. + + The label of the item + A string with the icon name or the absolute path of an image file + The new ToolbarItem which appended to the toolbar + + + + + + + Prepends ToolbarItem which just contains label to the toolbar. + + The label of the item + The new ToolbarItem which prepended to the toolbar + + + + + + + Prepends ToolbarItem which contains label and icon to the toolbar. + + The label of the item + A string with the icon name or the absolute path of an image file + The new which prepended to the toolbar + + + + + + + Inserts a new item which just contains label into the toolbar object before item . + + The toolbar item to insert before + The label of the item + The new which insert into the toolbar + + + + + Inserts a new item which contains label and icon into the toolbar object before item . + + The toolbar item to insert before + The label of the item + A string with the icon name or the absolute path of an image file + The new which insert into the toolbar + + + + + Inserts a new item which contains label and icon into the toolbar object after item . + + The toolbar item to insert after + The label of the item + A string with the icon name or the absolute path of an image file + The new which insert into the toolbar + + + + + Find the item with that label in the toolbar. + + The label of the item + The into the toolbar + + + + Gets the selected ToolbarItemItem of the toolbar. + + + + + Gets the first ToolbarItemItem of the toolbar. + + + + + Gets the last ToolbarItemItem of the toolbar. + + + + + The ToolbarItem is a item of Toolbar. + + + + + Sets or gets the icon path of the item. + + + + + Sets or gets the text string of the item. + + + + + Sets or gets the enable of the item. + + + + + Sets or gets whether displaying the item as a separator. + + Items aren't set as a separator by default. If set as a separator it displays a separator theme, so it won't display icons or labels. + + + + Sets or gets whether the item is selected. + + + + + Selected will be triggered when the item is selected. + + + + + LongPressed will be triggered when the item is pressed long time. + + + + + Clicked will be triggered when the item is clicked. + + + + + Transit is designed to apply various animated transition effects, such like translation, rotation, etc. + For using these effects, create an Transit and add the desired transition effects. + + Transit is not reusable. If the effect ends, the transit is destroyed automatically. + + + + A callback called when the transit is deleted. + + + + + Creates and initializes a new instance of Transit class. + + + + + Gets or sets the transit animation time + + + + + Gets or sets a value whether the objects states will be keep or not. + If it is not kept, the objects states will be reset when transition ends. + + + + + Gets or sets the transit animation acceleration type. + + + + + Gets or sets the transit repeat count. + If the repeat is a negative number, it will repeat infinite times. + + + + + Gets or sets if the auto reverse is on. + + + + + Gets or sets the event enabled when transit is operating. + + + + + Gets or sets the smooth scaling for transit map rendering + This gets smooth scaling for transit map rendering. + + + + + Get the time progression of the animation (a double value between 0.0 and 1.0). + The value returned is a fraction(current time / total time). + It represents the progression position relative to the total. + + + + + Gets or sets the transit animation tween mode acceleration factor. + + A factor value from 0.0 to 1.0. + + + + Gets or sets the transit animation tween mode acceleration factor. + + A factor value from 0.0 to 1.0. + + + + Starts the transition in given seconds. + Once this API is called, the transit begins to measure the time. + + The interval value in seconds + + + + Pause the transition. + + + + + Resume the transition. + + + + + Get the current chained transit list. + + Cannot add the duplicate transit. + + + + Get the objects list of the transit. + + Cannot add the duplicate object. + + + + Add the effect. + + EffectBase object. + + + + Add new object to apply the effects. + After the first addition of an object to transit, if its object list become empty again, the transit will be killed. + If the obj belongs to another transit, the obj will be removed from it and it will only belong to the other transit. + + It is not allowed to add a new object after transit begins. + Object to be animated. + + + + Removes an added object from the transit. + + Object to be removed from transit. + + + + Makes the chain relationship between two transits. + + The chain transit object. This transit will be operated after transit is done. + + + + Cut off the chain relationship between two transits. + + The chain transit object. + + + + The axis along which flip effect should be applied. + + + + + Flip on X axis + + + + + Flip on Y axis + + + + + The direction in which the wipe effect should occur. + + + + + Wipe to the left + + + + + Wipe to the right + + + + + Wipe to the up + + + + + Wipe to the down + + + + + Whether the wipe effect should show or hide the object. + + + + + Hide the object during the animation + + + + + Show the object during the animation + + + + + The type of acceleration used in the transition. + + + + + Constant speed + + + + + Starts slow, increase speed over time, then decrease again and stop slowly, v1 being a power factor + + + + + Starts fast and decrease speed over time, v1 being a power factor + + + + + Starts slow and increase speed over time, v1 being a power factor + + + + + Start at gradient v1, interpolated via power of v2 curve + + + + + Start at 0.0 then "drop" like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1 + + + + + Start at 0.0 then "wobble" like a spring rest position 1.0, and wobble v2 times, with decay factor of v1 + + + + + Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2) + + + + + Blend effect class. + + + + + Creates and initializes a new instance of BlendEffect class. + + + + + Color effect class. + + + + + Creates and initializes a new instance of ColorEffect class. + + The begin color of the effect + The end color of the effect + + + + The begin color of the effect + + + + + The end color of the effect + + + + + Fade effect class. + + + + + Creates and initializes a new instance of FadeEffect class. + + + + + Flip effect class. + + + + + Creates and initializes a new instance of FlipEffect class. + + Flipping Axis(X or Y). + Flipping Direction. True is clock-wise. + Resizable effect with FlipEffect + + + + Flipping Axis(X or Y). + + + + + Flipping Direction. True is clock-wise. + + + + + Resizable FlipEffect. + + + + + Resizing effect class. + + + + + Creates and initializes a new instance of FlipEffect class. + + The begin Size of the effect + The end Size of the effect + + + + The begin Size of the effect + + + + + The end Size of the effect + + + + + Rotation effect class. + + + + + Creates and initializes a new instance of RotationEffect class. + + The begin degree of the effect + The end degree of the effect + + + + The begin degree of the effect + + + + + The end degree of the effect + + + + + Translation effect class. + + + + + Creates and initializes a new instance of FlipEffect class. + + The begin Point of the effect + The end Point of the effect + + + + The begin Point of the effect + + + + + The end Point of the effect + + + + + Wipe effect class. + + + + + Creates and initializes a new instance of WipeEffect class. + + Wipe type. Hide or show. + Wipe Direction. + + + + Wipe type. Hide or show. + + + + + Wipe Direction. + + + + + Zoom effect class. + + + + + Creates and initializes a new instance of ZoomEffect class. + + The begin rate of the effect + The end rate of the effect + + + + The begin rate of the effect + + + + + The end rate of the effect + + + + + Appends a font path to the list of font paths used by the application. + + The new font path. + + + + Prepends a font path to the list of font paths used by the application. + + The new font path. + + + + Removes all font paths loaded into memory by evas_font_path_app_* APIs for the application. + + + + + Sets Edje color class. + + Color class + Object Red value + Object Red value + Object Red value + Object Red value + Outline Red value + Outline Green value + Outline Blue value + Outline Alpha value + Shadow Red value + Shadow Green value + Shadow Bluevalue + Shadow Alpha value + + + + + Gets Edje color class. + + Color class + Object Red value + Object Red value + Object Red value + Object Red value + Outline Red value + Outline Green value + Outline Blue value + Outline Alpha value + Shadow Red value + Shadow Green value + Shadow Bluevalue + Shadow Alpha value + + + + + Processes all queued up edje messages. + This function triggers the processing of messages addressed to any (alive) edje objects. + + + + + Sets the Edje text class. + + The text class name + The font name + The font size + True, on success or false, on error + + + + Gets the Edje text class. + + The text class name + The font name + The font size + True, on success or false, on error + + + + Delete the text class. + + + + + + Pre-multiplies a rgb triplet by an alpha factor. + + The alpha factor + The Red component of the color + The Green component of the color + The Blue component of the color + + + + Undoes pre-multiplies a rgb triplet by an alpha factor. + + The alpha factor + The Red component of the color + The Green component of the color + The Blue component of the color + + + + Enumeration for the focus direction. + + + + + Previous direction + + + + + Next direction + + + + + Up direction + + + + + Down direction + + + + + Right direction + + + + + Left direction + + + + + The Widget is abstract class, it is the parent of other widgets. + Inherits from . + + + + + Creates and initializes a new instance of the Widget class. + + The parent of new Widget instance + + + + Update the part contents + + The content which put to the part + The updated part + + + + Focused will be triggered when the widget is focused. + + + + + Unfocused will be triggered when the widget is unfocused. + + + + + Sets or gets the state of the widget, which might be enabled or disabled. + + + + + Sets or gets the style of the widget. + + + + + Gets whether this widget is focused. + + + + + Gets whether a widget is focusable or not. + + Widgets which are meant to be interacted with by input events are created able to be focused, by default + + + + Sets or gets the text of the widget. + + It could be override by special child class + + + + Sets or gets the background color of the widget. + + It could be override by special child class + + + + Sets or gets the opacity of the widget. + + It could be override by special child class + + + + Sets or gets whether a widget and its children are focusable or not. + + + + + Sets or gets the widget's mirrored mode. + + + + + Sets or gets the widget's mirrored mode setting. + When widget set automatic mode(true), it follows the system mirrored mode. + + + + + Sets the widget to be focused or not. + + Weather be focused + + + + Sets the ability for a widget to be focused. + + True if the object can be focused, false if not(and on errors) + + + + Gives focus to next widget in widget tree. + + Direction to move the focus + + + + Set next widget with specific focus direction. + + Focus next widget + Focus direction + + + + Sets content to particular part of the widget, and the preserve old content will not be unset. + + The name of particular part + The content + + + + + Sets content to particular part of the widget. + + The name of particular part + The content + true, preserve old content will be unset. false, preserve old content will not be unset. + + + + + Sets content to the widget, and the preserve old content will not be unset. + + The content + + + + + Sets content the widget. + + The content + true, preserve old content will be unset. false, preserve old content will not be unset. + + + + + Sets text to particular part of the widget. + + The name of particular part + The text + + + + Gets text of a particular part of the widget. + + The name of particular part + Text of the particular part of the widget + + + + Sets color of a particular part of the widget. + + The name of particular part + The color be set to widget + This method is a virtual method, it could be override by special child class + + + + Gets color of the particular part of the widget. + + The name of particular part + The color of the particular part + This method is a virtual method, it could be override by special child class + + + + Sets opacity of the particular part of the widget. + + The name of particular part + The opacity of the particular part + + + + Gets opacity of the particular part of the widget. + + The name of particular part + Opacity value of the particular part + + + + Enumeration for the display rotation of window. + + + + + Rotation value of window is 0 degree + + + + + Rotation value of window is 90 degree + + + + + Rotation value of window is 180 degree + + + + + Rotation value of window is 270 degree + + + + + Enumeration for the indicator opacity + + + + + Opacifies the status bar + + + + + Be translucent the status bar + + + Not supported. + + + + + Transparentizes the status bar + + + + + Enumeration for the indicator mode. + + + + + Unknown indicator state. + + + + + Hides the indicator. + + + + + Shows the indicator. + + + + + Enumeration for the keyboard mode + + + + + Unknown keyboard state + + + + + Request to deactivate the keyboard + + + + + Enable keyboard with default layout + + + + + Alpha (a-z) keyboard layout + + + + + Numeric keyboard layout + + + + + PIN keyboard layout + + + + + Phone keyboard layout + + + + + Hexadecimal numeric keyboard layout + + + + + Full (QWERTY) keyboard layout + + + + + Password keyboard layout + + + + + IP keyboard layout + + + + + Host keyboard layout + + + + + File keyboard layout + + + + + URL keyboard layout + + + + + Keypad layout + + + + + J2ME keyboard layout + + + + + Enumeration for the window type + + + + + Unknown + + + + + A normal window. Indicates a normal, top-level window. Almost every window will be created with this type. + + + + + Used for simple dialog windows. + + + + + For special desktop windows, like a background window holding desktop icons. + + + + + The window is used as a dock or panel. Usually would be kept on top of any other window by the Window Manager. + + + + + The window is used to hold a floating toolbar, or similar. + + + + + Similar to Toolbar. + + + + + A persistent utility window, like a toolbox or palette. + + + + + Splash window for a starting up application. + + + + + The window is a dropdown menu, as when an entry in a menubar is clicked. + + + + + Like DropdownMenu, but for the menu triggered by right-clicking an object. + + + + + The window is a tooltip. A short piece of explanatory text that typically appear after the mouse cursor hovers over an object for a while. + + + + + A notification window, like a warning about battery life or a new E-Mail received. + + + + + A window holding the contents of a combo box. + + + + + Used to indicate the window is a representation of an object being dragged across different windows, or even applications. + + + + + The window is rendered onto an image buffer. No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer. + This allows to have children window inside a parent one just like any other object would be, and do other things like applying Evas_Map effects to it. + + + + + The window is rendered onto an image buffer and can be shown other process's plug image object. + No actual window is created for this type, instead the window and all of its contents will be rendered to an image buffer and can be shown other process's plug image object. + + + + + This window was created using a pre-existing canvas. The window widget can be deleted, but the canvas must be managed externally. + + + + + The Window is container that contain the graphical user interface of a program. + + + + + Creates and initializes a new instance of the Window class. + + Window name. + + + + Creates and initializes a new instance of the Window class. + + + Parent widget which this widow created on. + + + Window name. + + + Window constructor.show window indicator,set callback + When closing the window in any way outside the program control, + and set callback when window rotation changed. + + + + + Creates and initializes a new instance of the Window class. + + + Parent widget which this widow created on. + + + Window name. + + + Window type + + + Window constructor.show window indicator,set callback + When closing the window in any way outside the program control, + and set callback when window rotation changed. + + + + + CloseRequested will be triggered when Window close. + + + + + RotationChanged will be triggered when Window do rotation. + + + + + Sets or gets Window name. + + + + + Gets the Window type. + + + + + Gets Window size with Size value(w,h) + + + + + Gets the screen dpi for the screen that a Window is on. + + + + + Gets the rotation of the Window.The rotation of the window in degrees (0-360). + + + + + Gets whether window manager supports window rotation or not. + + + + + Sets or gets available rotation degree. + + + + + Sets or gets whether auto deletion function is enable. + + + If you enable auto deletion, the window is automatically destroyed after the signal is emitted. + If auto deletion is disabled, the window is not destroyed and the program has to handle it. + + + + + Sets or gets the alpha channel state of a window. + + + True if the window alpha channel is enabled, false otherwise. + If alpha is true, the alpha channel of the canvas will be enabled possibly making parts of the window completely or partially transparent. + + + + + Sets or gets the role of the window. + + + The Role will be invalid if a new role is set or if the window is destroyed. + + + + + Sets or gets the mode of status bar. + + + + + Gets or sets the window's indicator mode. + + The indicator mode. + + + + Gets or sets the aspect ratio of a window. + + + + + Window's autohide state. + + + + + Get the borderless state of a window. + This function requests the Window Manager to not draw any decoration around the window. + + + + + Gets or sets the demand attention state of a window. + + + + + Gets or sets the floating mode of a window. + + + + + Gets or sets the animate status for the focus highlight for this window. + This function will enable or disable the animation of focus highlight only for the given window, regardless of the global setting for it. + + + + + Gets or sets the enabled status for the focus highlight in a window. + This function will enable or disable the focus highlight only for the given window, regardless of the global setting for it. + + + + + Gets or sets the style for the focus highlight on this window. + Sets the style to use for theming the highlight of focused objects on the given window.If style is NULL, the default will be used. + + + + + Get the keyboard mode of the window. + + + + + Gets or sets the layer of the window. + What this means exactly will depend on the underlying engine used. + In the case of X11 backed engines, the value in layer has the following meanings + less than 3 means that the window will be placed below all others, + more than 5 means that the window will be placed above all others, + and anything else means that the window will be placed in the default layer. + + + + + Gets or sets the modal state of a window. + + + + + Gets or sets the noblank property of a window. + This is a way to request the display on which the windowis shown does not blank, screensave or otherwise hide or obscure the window.It is intended for uses such as media playback on a television where a user may not want to be interrupted by an idle screen. + The noblank property may have no effect if the window is iconified/minimized or hidden. + + + + + Get the profile of a window. + + + + + Get the constraints on the maximum width and height of a window relative to the width and height of its screen. + When this function returns true, obj will never resize larger than the screen. + + + + + Gets or sets the base size of a window. + + + + + Gets or sets the step size of a window. + + + + + Get the screen position X of a window. + + + + + Get the screen position Y of a window. + + + + + Gets or sets the title of the window. + + + + + Gets or sets the urgent state of a window. + + + + + Gets or sets the withdrawn state of a window. + + + + + Create a socket to provide the service for Plug widget. + + A service name + A number (any value, 0 being the common default) to differentiate multiple instances of services with the same name. + A boolean that if true, specifies to create a system-wide service all users can connect to, otherwise the service is private to the user id that created the service. + If true, create successfull, otherwise false + + + + Set the rotation of the window. + + The rotation of the window, in degrees (0-360), counter-clockwise. + Resizes the window's contents so that they fit inside the current window geometry. + + + + Set the window to be skipped by focus. + This sets the window to be skipped by normal input. + This means a window manager will be asked to not focus this window as well as omit it from things like the taskbar, pager etc. + Call this and enable it on a window BEFORE you show it for the first time, otherwise it may have no effect. + Use this for windows that have only output information or might only be interacted with by the mouse or fingers, and never for typing input. + Be careful that this may have side-effects like making the window non-accessible in some cases unless the window is specially handled. Use this with care. + + + + + Pull up the window object. + Places the window pointed by obj at the top of the stack, so that it's not covered by any other window. + + + + + Bring down the window object. + Places the window pointed by obj at the bottom of the stack, so that no other window is covered by it. + + + + + This function sends a request to the Windows Manager to activate the Window. + If honored by the WM, the window receives the keyboard focus. + + + This is just a request that a Window Manager may ignore, so calling this function does not ensure + in any way that the window is going to be the active one after it. + + + + + Delete subobj as a resize object of window obj. + This function removes the object subobj from the resize objects of the window obj. + It will not delete the object itself, which will be left unmanaged and should be deleted by the developer, manually handled or set as child of some other container. + + Resize object. + + + + Adds obj as a resize object of the Window. + + + Setting an object as a resize object of the window means that the obj child's size and + position is controlled by the window directly. That is, the obj is resized to match the window size + and should never be moved or resized manually by the developer.In addition, + resize objects of the window control the minimum size of it as well as whether it can or cannot be resized by the user. + + + Resize object. + + + + + Set the keygrab of the window. + + keyname string to set keygrab + + + + Unset the keygrab of the window. + + keyname string to unset keygrab + + + + Enumeration for the wrap type. + + + + + No wrap. + + + + + Char wrap - wrap between characters. + + + + + Word wrap - wrap within the allowed wrapping points + (as defined in the unicode standard). + + + + + Mixed wrap - Word wrap, if that fails, char wrap. + + + + + Types of "Enter" keys available for different keyboards layout + + + + diff --git a/Artifacts/bin/Tizen.Account.AccountManager.dll b/Artifacts/bin/Tizen.Account.AccountManager.dll index 9964877..60289e2 100644 Binary files a/Artifacts/bin/Tizen.Account.AccountManager.dll and b/Artifacts/bin/Tizen.Account.AccountManager.dll differ diff --git a/Artifacts/bin/Tizen.Account.AccountManager.pdb b/Artifacts/bin/Tizen.Account.AccountManager.pdb index 12b0778..e919c8a 100644 Binary files a/Artifacts/bin/Tizen.Account.AccountManager.pdb and b/Artifacts/bin/Tizen.Account.AccountManager.pdb differ diff --git a/Artifacts/bin/Tizen.Account.AccountManager.xml b/Artifacts/bin/Tizen.Account.AccountManager.xml index 369744d..fee0296 100644 --- a/Artifacts/bin/Tizen.Account.AccountManager.xml +++ b/Artifacts/bin/Tizen.Account.AccountManager.xml @@ -1,932 +1,1015 @@ - - - - Tizen.Account.AccountManager - - - - - Interop for Account class APIs - - 3 - - Interop for AccountProvider class APIs - - 3 - - Interop for Account class APIs - - 3 - - Interop for Library reference - - 3 - - - - Interop for Account class APIs - - 3 - - - - Interop for AccountProvider class APIs - - 3 - - - - Interop for Account class APIs - - 3 - - - - Interop for Library reference - - 3 - - - - Represents the Account Information. - - 3 - - - - Creates a new Account instance. - - 3 - Account Instance. - - - - Id of the Account. - - 3 - Account Id shall be created only when account is added to the database. - - - - UserName of the Account. - - 3 - User Name of the Account. - - - - Display Name of the Account. - - 3 - DisplayName of the Account. - - - - Icon path of the Account. - - 3 - Icon path of the Account. - - - - Domain name of the Account. - - 3 - Domain name of the Account. - - - - Email Id of the Account. - - 3 - Email Id of the Account. - - - - Package Name of the Account. - - 3 - Package Name. - - - - Access Token of the Account. - - 3 - Access Token. - - - - Authentication type of the Account. - - 3 - Authentication type. - - - - Secrecy State of the Account. - - 3 - Secrecy State. - - - - Sync State of the Account. - - 3 - Sync State. - - - - Source of the Account . - - 3 - Account Source. - - - - Sets the account capability. - - 3 - The Account capability type - The Account capability state - In case of invalid parameters - - - - Gets all the capabilities of an account. - - 3 - The capability type to get the capability value. - The capability value (on/off) of the specified CapabilityState . - In case of invalid parameters - - - - Gets all the capabilities of an account. - - 3 - List of Cpabailities as Dictionary - - - - Sets the Custom Value to the Account. - - 3 - key to be added to the Account. - value to be updated for respective key for the Account. - In case of invalid parameters - - - - Gets the user specific custom text of an account key. - - 3 - The key to retrieve custom text . - The text of the given key - In case of invalid parameters - If there is no given capability type in the account - - - - Gets All the custome values. - - 3 - List of custom key, value pairs as Dictionary. - - - - Sets the user text. - - 3 - The index of the user text (must be in range from 0 to 4) - The text string to set as the user text - In case of invalid parameters - - - - Gets the user text. - - 3 - The index of the user text (range: 0 ~ 4) - The user text of the given key - In case of invalid parameters - In case of out of memory - - - - Gets the user int value. - - 3 - The index of the user int (range: 0 ~ 4) - The user int of the given key - In case of invalid parameters - - - - Sets the user integer value. - - 3 - The index of the user integer (must be in range from 0 to 4) - The integer to set as the user integer - In case of invalid parameters - - - - Overloaded Dispose API for destroying the Account Handle. - - 3 - - - - Enumeration for the state of capability - - 3 - - - - Account capability is invalid - - 3 - - - - Account capability is disabled - - 3 - - - - Account capability is enabled - - 3 - - - - Enumeration for the state of account secrecy. - - - - - Account secrecy is invalid - - 3 - - - - Account is not visible - - 3 - - - - Account is visible - - 3 - - - - Enumeration for the account sync status. - - 3 - - - - Account sync is invalid - - 3 - - - - Account sync not supported - - 3 - - - - Account sync supported but all synchronization functionalities are off - - 3 - - - - Account sync support and sync status is idle - - 3 - - - - Account sync support and sync status is running - - 3 - - - - Enumeration for the account auth type. - - 3 - - - - Auth type is invalid - - 3 - - - - XAuth type - - 3 - - - - OAuth type - - 3 - - - - Client-Login type - - 3 - - - - Account information change notification type - - 3 - - When the account database is changed, You can distinguish one event type from the other which are set for subscribing notification. - - - - - The insert notification type. - - 3 - - - - The delete notification type. - - 3 - - - - The update notification type. - - 3 - - - - The sync update notification type. - - 3 - - - - Enum to give the type of error occured, if any. - - 3 - - - - Successful. - - 3 - - - - Invalid parameter. - - 3 - - - - Out of memory. - - 3 - - - - Same user name exists in your application - - 3 - - - - Empty Data - - 3 - - - - elated record does not exist - - 3 - - - - Invalid Operation. - - 3 - - - - DB operation failed. - - 3 - - - - DB is not connected. - - 3 - - - - DB query syntax error - - 3 - - - - Iterator has reached the end - - 3 - - - - Notification failed - - 3 - - - - Permission denied. - - 3 - - - - XML parse failed - - 3 - - - - XML File not found - - 3 - - - - Subscription failed - - 3 - - - - Account provider is not registered - - 3 - - - - Multiple accounts are not supported. - - 3 - - - - SQLite busy handler expired - - 3 - - - - Account Id. - - 3 - - - - Account Id. - - 3 - - - - Serviceprovider Id of the account provider. - - 3 - - - - Icon path of an account provider. - - 3 - - - - Small icon path of an account provider. - - 3 - - - - Flag for account provider If supports multiple accounts. - - 3 - - - - Retrieves all the capability information of the account provider. - - 3 - http://tizen.org/privilege/account.read - - list of capability information. - - In case of any DB error - In case of privilege not defined. - - - - Gets the specific label information detail of an account provider. - - 3 - - The locale is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" or "ko-kr" for Korean, "en_US" or "en-us" for American English. - - The label text given for the locale - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given locale - In case of privilege not defined. - - - - Gets the specific label information detail of an account provider. - - 3 - - The application ID to search - - All the labels information for the given application Id. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given appid - In case of invalid parameter - In case of privilege not defined. - - - - Gets the label information detail of an account provider. - - 3 - All the labels information for the given account provider. - http://tizen.org/privilege/account.read - In case of any DB error - In case of privilege not defined. - - - - Checks whether the given appId exists in the account provider DB. - - 3 - The application ID to check. - returns true If App is supported - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given appid - In case of invalid parameter - In case of privilege not defined. - - - - Checks whether the given application ID supports the capability. - - 3 - The application Id - The capability information - - TRUE if the application supports the given capability, - otherwise FALSE if the application does not support the given capability - - http://tizen.org/privilege/account.read - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves capability information with application ID. - - 3 - application Id - Capability information list for the given appId. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given appid - In case of invalid parameter - In case of privilege not defined. - - - - Overloaded Dispose API for destroying the AccountProvider Handle. - - 3 - - - - The AccountManager APIs is separated into two major sections: - 1. Registering an account provider while an application is installed. This information will be used for the Add account screen. - 2. Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu. - - The APIs of both of the sections consist of the following functionality: - - Create an account or account provider - Update an account or account provider(Only available for the creator) - Delete an account or account provider(Only available for the creator) - Read an account or account provider with some filter - - - 3 - - - - This is contact capability string. - - 3 - - - - This is calendar capability string. - - 3 - - - - This is email capability string. - - 3 - - - - This is photo capability string. - - 3 - - - - This is video capability string. - - 3 - - - - This is music capability string. - - 3 - - - - This is document capability string. - - 3 - - - - This is message capability string. - - 3 - - - - This is game capability string. - - 3 - - - - Retrieves all accounts details from the account database. - - 3 - List of Accounts - http://tizen.org/privilege/account.read - In case of any DB error. - In case of privilege not defined. - - - - Retrieve an account with the account ID. - - 3 - The account Id to be searched. - Account instance with reference to the given id. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given account id - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all AccountProviders details from the account database. - - 3 - List of AccountProviders - http://tizen.org/privilege/account.read - In case of any DB error - In case of privilege not defined. - - - - Retrieves the account provider information with application Id. - - 3 - Application Id. - The AccountProvider instance associated with the given application Id. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given appid - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all the account providers information with feature. - - 3 - The capability value to search for account providers. - Retrieves AccountProviders information with the capability name. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given feature - In case of invalid parameter - In case of privilege not defined. - - - - Inserts into the Database with the new account Infomration. - - 3 - New Account instance to be added. - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - In case of OutOfMemory error. - - - - Updates the account details to the account database. - - 3 - account instance to be updated. - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - In case of OutOfMemory error. - - - - Deletes the account information from the Database. - - 3 - Account instance to be deleted from the database. - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - Deletes an account from the account database by user name. - - 3 - The user name of the account to delete. - The package name of the account to delete. - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - Deletes an account from the account database by package name. - - 3 - The package name of the account to delete. - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all accounts with the given user name. - - 3 - The user name to search . - Accounts list matched with the user name - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given username - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all accounts with the given package name. - - 3 - The package name to Search - Accounts list matched with the package name - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given package name - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all accounts with the given cpability type. - - 3 - Capability type - Accounts list matched with the capability type - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given capability type - In case of invalid parameter - In case of privilege not defined. - - - - Retrieves all capabilities with the given account - - 3 - account instance - Capabilities list as Dictionary of Capability type and State. - http://tizen.org/privilege/account.read - In case of any DB error or record not found for given account id - In case of invalid parameter - In case of privilege not defined. - - - - Gets the count of accounts in the account database. - - 3 - The number of accounts in the database - http://tizen.org/privilege/account.read - In case of any DB error - In case of privilege not defined. - - - - Updates the sync status of the given account. - - 3 - Account for which sync status needs to be updated - Sync State - http://tizen.org/privilege/account.read - http://tizen.org/privilege/account.write - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - ContentUpdated event is triggered when the media item info from DB changes. - - 3 - - ContentUpdate event is triggered if the MediaInformaion updated/deleted or new Inforamtion is Inserted. - - - A ContentUpdatedEventArgs object that contains information about the update operation. - http://tizen.org/privilege/account.read - In case of any DB error - In case of invalid parameter - In case of privilege not defined. - - - - Event arguments passed when Event is triggered to notify that account is updated/removed from the account database. - - 3 - - - - The account event type - - 3 - - - - The account ID to update - - 3 - - - + + + + Tizen.Account.AccountManager + + + + + Interop for Account class APIs. + + 3 + + Interop for AccountProvider class APIs. + + 3 + + Interop for Account class APIs. + + 3 + + Interop for the library reference. + + 3 + + + + Interop for Account class APIs. + + 3 + + + + Interop for AccountProvider class APIs. + + 3 + + + + Interop for Account class APIs. + + 3 + + + + Interop for the library reference. + + 3 + + + + Represents the account information. + + 3 + + + + Creates a new account instance. + + 3 + Account Instance. + + + + Id of the Account. + + 3 + Account ID shall be created only when the account is added to the database. + + + + UserName of the account. + + 3 + User name of the account. + + + + Display name of the account. + + 3 + Display name of the account. + + + + Icon path of the account. + + 3 + Icon path of the account. + + + + Domain name of the account. + + 3 + Domain name of the account. + + + + Email ID of the account. + + 3 + Email ID of the account. + + + + Package name of the account. + + 3 + Package name of the account. + + + + Access token of the account. + + 3 + Access token of the account. + + + + Authentication type of the account. + + 3 + Authentication type of the account. + + + + Secrecy state of the account. + + 3 + Secrecy state of the account. + + + + Sync state of the account. + + 3 + Sync state of the account. + + + + Source of the account. + + 3 + Account source. + + + + Handle of the account. + + 4 + Account handle. + + + + Sets the account capability. + + 3 + The account capability type. + The account capability state. + In case of an invalid parameter. + + + + Gets all the capabilities of the account. + + 3 + The capability type to get the capability value. + The capability value (on/off) of the specified CapabilityState. + In case of an invalid parameter. + + + + Gets all the capabilities of the account. + + 3 + List of capabilities as dictionary. + + + + Sets the custom value to the account. + + 3 + Key to be added to the account. + Value to be updated for respective key for the account. + In case of an invalid parameter. + + + + Gets the user specific custom text of an account key. + + 3 + The key to retrieve custom text. + The text of the given key. + In case of an invalid parameter. + If there is no given capability type in the account. + + + + Gets all the custom values. + + 3 + List of custom key, value pairs as dictionary. + + + + Sets the user text. + + 3 + The index of the user text (must be in range from 0 to 4). + The text string to set as the user text. + In case of an invalid parameter. + + + + Gets the user text. + + 3 + The index of the user text (must be in range from 0 to 4). + The user text of the given key. + In case of an invalid parameter. + In case of out of memory. + + + + Gets the user integer value. + + 3 + The index of the user integer (must be in range from 0 to 4). + The user integer of the given key. + In case of an invalid parameter. + + + + Sets the user integer value. + + 3 + The index of the user integer (must be in range from 0 to 4). + The integer to set as the user integer. + In case of an invalid parameter. + + + + Overloaded Dispose API for destroying the account handle. + + 3 + + + + Enumeration for the state of capability. + + 3 + + + + Account capability is invalid. + + 3 + + + + Account capability is disabled. + + 3 + + + + Account capability is enabled. + + 3 + + + + Enumeration for the state of account secrecy. + + + + + Account secrecy is invalid. + + 3 + + + + Account is not visible. + + 3 + + + + Account is visible. + + 3 + + + + Enumeration for the account sync status. + + 3 + + + + Account sync is invalid. + + 3 + + + + Account sync not supported. + + 3 + + + + Account sync supported, but all the synchronization functionalities are off. + + 3 + + + + Account sync supported and sync status is idle. + + 3 + + + + Acount sync supported and sync status is running. + + 3 + + + + Enumeration for the account auth type. + + 3 + + + + Auth type is invalid. + + 3 + + + + XAuth type. + + 3 + + + + OAuth type. + + 3 + + + + ClientLogin type. + + 3 + + + + Account information change notification types. + + 3 + + When the account database is changed, you can distinguish one event type from the other which are set for subscribing notification. + + + + + The insert notification type. + + 3 + + + + The delete notification type. + + 3 + + + + The update notification type. + + 3 + + + + The sync update notification type. + + 3 + + + + Enumeration for the types of error occured, if any. + + 3 + + + + Successful. + + 3 + + + + Invalid parameter. + + 3 + + + + Out of memory. + + 3 + + + + Same user name exists in your application. + + 3 + + + + Empty data. + + 3 + + + + Elated record does not exist. + + 3 + + + + Invalid operation. + + 3 + + + + DB operation failed. + + 3 + + + + DB is not connected. + + 3 + + + + DB query syntax error. + + 3 + + + + Iterator has reached the end. + + 3 + + + + Notification failed. + + 3 + + + + Permission denied. + + 3 + + + + XML parse failed. + + 3 + + + + XML file not found. + + 3 + + + + Subscription failed + + 3 + + + + Account provider is not registered. + + 3 + + + + Multiple accounts are not supported. + + 3 + + + + SQLite busy handler expired. + + 3 + + + + The account ID. + + 3 + + + + The account ID. + + 3 + + + + Serviceprovider ID of the account provider. + + 3 + + + + Icon path of the account provider. + + 3 + + + + Small icon path of the account provider. + + 3 + + + + Flag for the account provider if it supports multiple accounts. + + 3 + + + + Retrieves all the capability information of the account provider. + + 3 + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + + The list of capability information. + + In case of any DB error. + In case of privilege not defined. + The required feature is not supported. + + + + Gets the specific label information detail of the account provider. + + 3 + + The locale is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" or "ko-kr" for Korean, "en_US" or "en-us" for American English. + + The label text given for the locale. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given locale. + In case of privilege not defined. + The required feature is not supported. + + + + Gets the specific label information detail of the account provider. + + 3 + + The application ID to search. + + All the labels information for the given application ID. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given the application ID. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Gets the label information detail of the account provider. + + 3 + All the labels information for the given account provider. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of privilege not defined. + The required feature is not supported. + + + + Checks whether the given appId exists in the account provider DB. + + 3 + The application ID to check. + returns true If App is supported + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for the given application ID. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Checks whether the given application ID supports the capability. + + 3 + The application ID. + The capability information. + + TRUE if the application supports the given capability, + otherwise FALSE if the application does not support the given capability + + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves capability information with the application ID. + + 3 + The application ID. + Capability information list for the given appId. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for the given application ID. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Overloaded Dispose API for destroying the AccountProvider Handle. + + 3 + + + + The AccountManager APIs are separated into two major sections: + 1. Registering an account provider while an application is installed. This information will be used for the Add account screen. + 2. Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu. + + The APIs of both of the sections consist of the following functionality: + + Create an account or account provider. + Update an account or account provider (Only available for the creator). + Delete an account or account provider (Only available for the creator). + Read an account or account provider with some filter. + + + 3 + + + + This is the contact capability string. + + 3 + + + + This is the calendar capability string. + + 3 + + + + This is the email capability string. + + 3 + + + + This is the photo capability string. + + 3 + + + + This is the video capability string. + + 3 + + + + This is the music capability string. + + 3 + + + + This is the document capability string. + + 3 + + + + This is the message capability string. + + 3 + + + + This is the game capability string. + + 3 + + + + Retrieves all the accounts details from the account database. + + 3 + List of accounts. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves the account with the account ID. + + 3 + The account ID to be searched. + Account instance with reference to the given ID. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given account ID. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all the AccountProviders details from the account database. + + 3 + List of AccountProviders. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves the account provider information with the application ID. + + 3 + The application ID. + The AccountProvider instance associated with the given application ID. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given appid. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all the account providers information with feature. + + 3 + The capability value to search for account providers. + Retrieves the AccountProviders information with the capability name. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given feature. + In case of invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Inserts into the Database with the new account Information. + + 3 + New Account instance to be added. + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + In case of OutOfMemory error. + The required feature is not supported. + + + + Updates the account details to the account database. + + 3 + Account instance to be updated. + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + In case of OutOfMemory error. + The required feature is not supported. + + + + Deletes the account information from the database. + + 3 + Account instance to be deleted from the database. + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Deletes the account from the account database by user name. + + 3 + The user name of the account to delete. + The package name of the account to delete. + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Deletes the account from the account database by package name. + + 3 + The package name of the account to delete. + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all the accounts with the given user name. + + 3 + The user name to search. + Accounts list matched with the user name. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given username. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all the accounts with the given package name. + + 3 + The package name to search. + Accounts list matched with the package name. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given package name. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all accounts with the given capability type. + + 3 + Capability type. + Accounts list matched with the capability type. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for the given capability type. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Retrieves all the capabilities with the given account. + + 3 + Account instance. + Capabilities list as dictionary of the capability type and state. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error or record not found for given account ID. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Gets the count of accounts in the account database. + + 3 + The number of accounts in the database. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of privilege not defined. + The required feature is not supported. + + + + Updates the sync status of the given account. + + 3 + Account for which the sync status needs to be updated. + Sync State + http://tizen.org/privilege/account.read + http://tizen.org/privilege/account.write + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + ContentUpdated event is triggered when the media item info from DB changes. + + 3 + + ContentUpdate event is triggered if the MediaInformaion updated/deleted or new information is inserted. + + + A ContentUpdatedEventArgs object that contains information about the update operation. + http://tizen.org/privilege/account.read + http://tizen.org/feature/account + In case of any DB error. + In case of an invalid parameter. + In case of privilege not defined. + The required feature is not supported. + + + + Event arguments passed when the event is triggered to notify that the account is updated/removed from the account database. + + 3 + + + + The account event type. + + 3 + + + + The account ID to update. + + 3 + + + + Represents a wrapper class for a unmanaged Account handle. + + + + + Initializes a new instance of the SafeAppControlHandle class. + + + + + Initializes a new instance of the SafeAccountHandle class. + + An IntPtr object that represents the pre-existing handle to use. + true to reliably release the handle during the finalization phase; false to prevent reliable release. + + + + Gets a value that indicates whether the handle is invalid. + + + + + When overridden in a derived class, executes the code required to free the handle. + + true if the handle is released successfully + + + diff --git a/Artifacts/bin/Tizen.Account.FidoClient.dll b/Artifacts/bin/Tizen.Account.FidoClient.dll index 34e8955..ffef3ab 100644 Binary files a/Artifacts/bin/Tizen.Account.FidoClient.dll and b/Artifacts/bin/Tizen.Account.FidoClient.dll differ diff --git a/Artifacts/bin/Tizen.Account.FidoClient.pdb b/Artifacts/bin/Tizen.Account.FidoClient.pdb index 2ede000..46c1841 100644 Binary files a/Artifacts/bin/Tizen.Account.FidoClient.pdb and b/Artifacts/bin/Tizen.Account.FidoClient.pdb differ diff --git a/Artifacts/bin/Tizen.Account.FidoClient.xml b/Artifacts/bin/Tizen.Account.FidoClient.xml index 3a8925d..a9aafbe 100644 --- a/Artifacts/bin/Tizen.Account.FidoClient.xml +++ b/Artifacts/bin/Tizen.Account.FidoClient.xml @@ -1,531 +1,531 @@ - - - - Tizen.Account.FidoClient - - - - - Wrapper class for maintaining names of dependent native libraries. - - - - - - The authenticator Title - - 3 - - - - The Authenticator AAID (Authenticator Attestation ID) - - 3 - - - - The Authenticator description - - 3 - - - - The Authenticator assertion scheme. - - 3 - - - - The Authenticator algorithm. - - 3 - - - - The user verification method of this Authenticator - - 3 - - - - The key protection method of this Authenticator. - - 3 - - - - The matcher protection method of this Authenticator. - - 3 - - - - The attachment hint of this Authenticator. - - 3 - - - - Denotes the Authenticator is Second factor only which is supported by U2F standards. - - 3 - - - - The available attestation types for this Authenticator. - - 3 - - - - The Transaction Confirmation display type of this Authenticator. - - 3 - - - - The Transaction Confirmation display type of this Authenticator. - - 3 - - - - The icon of this Authenticator. - - 3 - - - - Class to find available FIDO specific authenticators on the device - - 3 - - - - - The FIDO UAF Client APIs - - 3 - - - - The FIDO Client vendor name - - 3 - - - - The FIDO Client Major version - - 3 - - - - The FIDO Client Minor version - - 3 - - - - The FIDO Server response for successfull interaction. - - 3 - - - - Checks whether the FIDO message can be processed - - 3 - The FIDO UAF message which is received from the relying party server - True if the message can be handled by the device, else false - http://tizen.org/privilege/fido.client - http://tizen.org/feature/fido.uaf - In case of invalid parameter - Thrown when the application does not have privilege to access this method - FIDO is not supported - - - UafMessage uafRequest = new UafMessage() - { - Operation = "UafRequestJson" - }; - bool response = await UafClient.CheckPolicyAsync(uafRequest); - - - - - - Processes the given FIDO UAF message. - - 3 - The FIDO UAF message which is received from the relying party server - The channel binding data in JSON format which is received from the relying party server - FIDO response message - http://tizen.org/privilege/fido.client - http://tizen.org/feature/fido.uaf - In case of invalid parameter - Thrown when the application does not have privilege to access this method - FIDO is not supported - - - UafMessage uafRequest = new UafMessage() - { - Operation = "UafAuthRequestJson" - }; - - var response = await UafClient.ProcessRequestAsync(uafRequest, null); - - - - - - Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client. - - 3 - The status code received from Server.(StautsOk implies success) - The FIDO response message sent to server in JSON format - http://tizen.org/privilege/fido.client - http://tizen.org/feature/fido.uaf - - This is especially important for cases when a new registration may be considered by the client to be in a pending state until it is communicated that the server accepted it - - In case of invalid parameter - Thrown when the application does not have privilege to access this method - FIDO is not supported - - - UafResponse response = new UafResponse() - { - Response = "Responsejson" - }; - - await UafClient.NotifyResultAsync(UafClient.StautsOk, response); - - - - - - Authenticator's supported algorithm and encoding - - 3 - - - - SECP256R1 ECDSA SHA256 Raw - - 3 - - - - SECP256R1 ECDSA SHA256 DER - - 3 - - - - RSA PSS SHA256 Raw - - 3 - - - - RSA PSS SHA256 DER - - 3 - - - - SECP256K1 ECDSA SHA256 Raw - - 3 - - - - SECP256K1 ECDSA SHA256 DER - - 3 - - - - Authenticator's supported user verification method type. - - 3 - - - - User presence verification. - - 3 - - - - User fingerprint verification. - - 3 - - - - User passcode verification. - - 3 - - - - User voiceprint verification. - - 3 - - - - User faceprint verification. - - 3 - - - - User location verification. - - 3 - - - - User eyeprint verification. - - 3 - - - - User pattern verification. - - 3 - - - - User handprint verification. - - 3 - - - - Silent verification. - - 3 - - - - If an authenticator sets multiple flags for user verification types, it may also set this flag to indicate that all verification methods will be enforced (e.g. faceprint AND voiceprint). If flags for multiple user verification methods are set and this flag is not set, verification with only one is necessary (e.g. fingerprint OR passcode). - - 3 - - - - Authenticator's supported key protection method type. - - 3 - - - - Software based key management. - - 3 - - - - Hardware based key management. - - 3 - - - - Trusted Execution Environment based key management. - - 3 - - - - Secure Element based key management. - - 3 - - - - Authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle. - - 3 - - - - Authenticator's supported matcher protection type. - - 3 - - - - Authenticator's matcher is running in software. - - 3 - - - - Authenticator's matcher is running inside the Trusted Execution Environment. - - 3 - - - - Aauthenticator's matcher is running on the chip. - - 3 - - - - Authenticator's supproted method to communicate to FIDO user device. - - 3 - - - - Authenticator is permanently attached to the FIDO User Device. - - 3 - - - - Authenticator is removable or remote from the FIDO User Device. - - 3 - - - - The external authenticator currently has an exclusive wired connection. - - 3 - - - - The external authenticator communicates with the FIDO User Device through wireless means. - - 3 - - - - Authenticator is able to communicate by NFC to the FIDO User Device. - - 3 - - - - Authenticator is able to communicate by Bluetooth to the FIDO User Device. - - 3 - - - - Authenticator is connected to the FIDO User Device ver a non-exclusive network (e.g. over a TCP/IP LAN or WAN, as opposed to a PAN or point-to-point connection). - - 3 - - - - The external authenticator is in a "ready" state. - - 3 - - - - The external authenticator is able to communicate using WiFi Direct with the FIDO User Device. - - 3 - - - - Authenticator's supported Attestation type. - - 3 - - - - Full basic attestation. - - 3 - - - - Surrogate basic attestation. - - 3 - - - - Transaction confirmation display capability type. - - 3 - - - - Some form of transaction confirmation display is available on this authenticator. - - 3 - - - - Software-based transaction confirmation display operating in a privileged context is available on this authenticator. - - 3 - - - - Transaction confirmation display is in a Trusted Execution Environment. - - 3 - - - - Transaction confirmation display based on hardware assisted capabilities is available on this authenticator. - - 3 - - - - Transaction confirmation display is provided on a distinct device from the FIDO User Device. - - 3 - - - - The FIDO message received from the relying party server - - 3 - - - - The constructor - - 3 - - - - The FIDO message in JSON format which is received from the relying party server - - 3 - - - - Represents FIDO response message - - 3 - - - - The constructor - - 3 - - - - FIDO response message in JSON format - - 3 - - - + + + + Tizen.Account.FidoClient + + + + + Wrapper class for maintaining names of dependent native libraries. + + + + + + The authenticator Title + + 3 + + + + The Authenticator AAID (Authenticator Attestation ID) + + 3 + + + + The Authenticator description + + 3 + + + + The Authenticator assertion scheme. + + 3 + + + + The Authenticator algorithm. + + 3 + + + + The user verification method of this Authenticator + + 3 + + + + The key protection method of this Authenticator. + + 3 + + + + The matcher protection method of this Authenticator. + + 3 + + + + The attachment hint of this Authenticator. + + 3 + + + + Denotes the Authenticator is Second factor only which is supported by U2F standards. + + 3 + + + + The available attestation types for this Authenticator. + + 3 + + + + The Transaction Confirmation display type of this Authenticator. + + 3 + + + + The Transaction Confirmation display type of this Authenticator. + + 3 + + + + The icon of this Authenticator. + + 3 + + + + Class to find available FIDO specific authenticators on the device + + 3 + + + + + The FIDO UAF Client APIs + + 3 + + + + The FIDO Client vendor name + + 3 + + + + The FIDO Client Major version + + 3 + + + + The FIDO Client Minor version + + 3 + + + + The FIDO Server response for successfull interaction. + + 3 + + + + Checks whether the FIDO message can be processed + + 3 + The FIDO UAF message which is received from the relying party server + True if the message can be handled by the device, else false + http://tizen.org/privilege/fido.client + http://tizen.org/feature/fido.uaf + In case of invalid parameter + Thrown when the application does not have privilege to access this method + FIDO is not supported + + + UafMessage uafRequest = new UafMessage() + { + Operation = "UafRequestJson" + }; + bool response = await UafClient.CheckPolicyAsync(uafRequest); + + + + + + Processes the given FIDO UAF message. + + 3 + The FIDO UAF message which is received from the relying party server + The channel binding data in JSON format which is received from the relying party server + FIDO response message + http://tizen.org/privilege/fido.client + http://tizen.org/feature/fido.uaf + In case of invalid parameter + Thrown when the application does not have privilege to access this method + FIDO is not supported + + + UafMessage uafRequest = new UafMessage() + { + Operation = "UafAuthRequestJson" + }; + + var response = await UafClient.ProcessRequestAsync(uafRequest, null); + + + + + + Notifies the FIDO client about the server result. FIDO Server sends the result of processing a UAF message to FIDO client. + + 3 + The status code received from Server.(StautsOk implies success) + The FIDO response message sent to server in JSON format + http://tizen.org/privilege/fido.client + http://tizen.org/feature/fido.uaf + + This is especially important for cases when a new registration may be considered by the client to be in a pending state until it is communicated that the server accepted it + + In case of invalid parameter + Thrown when the application does not have privilege to access this method + FIDO is not supported + + + UafResponse response = new UafResponse() + { + Response = "Responsejson" + }; + + await UafClient.NotifyResultAsync(UafClient.StautsOk, response); + + + + + + Authenticator's supported algorithm and encoding + + 3 + + + + SECP256R1 ECDSA SHA256 Raw + + 3 + + + + SECP256R1 ECDSA SHA256 DER + + 3 + + + + RSA PSS SHA256 Raw + + 3 + + + + RSA PSS SHA256 DER + + 3 + + + + SECP256K1 ECDSA SHA256 Raw + + 3 + + + + SECP256K1 ECDSA SHA256 DER + + 3 + + + + Authenticator's supported user verification method type. + + 3 + + + + User presence verification. + + 3 + + + + User fingerprint verification. + + 3 + + + + User passcode verification. + + 3 + + + + User voiceprint verification. + + 3 + + + + User faceprint verification. + + 3 + + + + User location verification. + + 3 + + + + User eyeprint verification. + + 3 + + + + User pattern verification. + + 3 + + + + User handprint verification. + + 3 + + + + Silent verification. + + 3 + + + + If an authenticator sets multiple flags for user verification types, it may also set this flag to indicate that all verification methods will be enforced (e.g. faceprint AND voiceprint). If flags for multiple user verification methods are set and this flag is not set, verification with only one is necessary (e.g. fingerprint OR passcode). + + 3 + + + + Authenticator's supported key protection method type. + + 3 + + + + Software based key management. + + 3 + + + + Hardware based key management. + + 3 + + + + Trusted Execution Environment based key management. + + 3 + + + + Secure Element based key management. + + 3 + + + + Authenticator does not store (wrapped) UAuth keys at the client, but relies on a server-provided key handle. + + 3 + + + + Authenticator's supported matcher protection type. + + 3 + + + + Authenticator's matcher is running in software. + + 3 + + + + Authenticator's matcher is running inside the Trusted Execution Environment. + + 3 + + + + Aauthenticator's matcher is running on the chip. + + 3 + + + + Authenticator's supproted method to communicate to FIDO user device. + + 3 + + + + Authenticator is permanently attached to the FIDO User Device. + + 3 + + + + Authenticator is removable or remote from the FIDO User Device. + + 3 + + + + The external authenticator currently has an exclusive wired connection. + + 3 + + + + The external authenticator communicates with the FIDO User Device through wireless means. + + 3 + + + + Authenticator is able to communicate by NFC to the FIDO User Device. + + 3 + + + + Authenticator is able to communicate by Bluetooth to the FIDO User Device. + + 3 + + + + Authenticator is connected to the FIDO User Device ver a non-exclusive network (e.g. over a TCP/IP LAN or WAN, as opposed to a PAN or point-to-point connection). + + 3 + + + + The external authenticator is in a "ready" state. + + 3 + + + + The external authenticator is able to communicate using WiFi Direct with the FIDO User Device. + + 3 + + + + Authenticator's supported Attestation type. + + 3 + + + + Full basic attestation. + + 3 + + + + Surrogate basic attestation. + + 3 + + + + Transaction confirmation display capability type. + + 3 + + + + Some form of transaction confirmation display is available on this authenticator. + + 3 + + + + Software-based transaction confirmation display operating in a privileged context is available on this authenticator. + + 3 + + + + Transaction confirmation display is in a Trusted Execution Environment. + + 3 + + + + Transaction confirmation display based on hardware assisted capabilities is available on this authenticator. + + 3 + + + + Transaction confirmation display is provided on a distinct device from the FIDO User Device. + + 3 + + + + The FIDO message received from the relying party server + + 3 + + + + The constructor + + 3 + + + + The FIDO message in JSON format which is received from the relying party server + + 3 + + + + Represents FIDO response message + + 3 + + + + The constructor + + 3 + + + + FIDO response message in JSON format + + 3 + + + diff --git a/Artifacts/bin/Tizen.Account.OAuth2.dll b/Artifacts/bin/Tizen.Account.OAuth2.dll index 0c087bc..87c3b01 100644 Binary files a/Artifacts/bin/Tizen.Account.OAuth2.dll and b/Artifacts/bin/Tizen.Account.OAuth2.dll differ diff --git a/Artifacts/bin/Tizen.Account.OAuth2.pdb b/Artifacts/bin/Tizen.Account.OAuth2.pdb index c8a55f9..dc6c828 100644 Binary files a/Artifacts/bin/Tizen.Account.OAuth2.pdb and b/Artifacts/bin/Tizen.Account.OAuth2.pdb differ diff --git a/Artifacts/bin/Tizen.Account.OAuth2.xml b/Artifacts/bin/Tizen.Account.OAuth2.xml index de90abe..9a7fe48 100644 --- a/Artifacts/bin/Tizen.Account.OAuth2.xml +++ b/Artifacts/bin/Tizen.Account.OAuth2.xml @@ -1,758 +1,758 @@ - - - - Tizen.Account.OAuth2 - - - - - Contains Interop declarations of OAuth2 classes. - - - Contains Interop declarations of OAuth2 classes. - - - Contains Interop declarations of OAuth2 classes. - - - Contains Interop declarations of OAuth2 classes. - - - Contains Interop declarations of OAuth2 classes. - - - Contains Interop declarations of OAuth2 classes. - - - - - Safehandle wrapper for OAuth2 native handles. - - - - - Wrapper class for OAuth2 native API. - - - - - Wrapper class for maintaining names of dependent native libraries. - - - - - Wrapper class for OAuth2 native API. - - - - - Wrapper class for OAuth2 native API. - - - - - Wrapper class for OAuth2 native API. - - - - - Class containing access token and related information. - - 3 - - - - The lifetime in seconds of the access token. - - 3 - - - - The access token issued by the authorization server. - - 3 - - - - The scope of the access token. - - 3 - - - - The type of the access token. - - 3 - - - - Enumerations for Client authentication scheme, used to sign client id and client secret accordingly. - Default is Basic (http://tools.ietf.org/html/rfc2617#section-2) - - 3 - Facebook and Google does not support HTTP Basic Authentication, instead they require client credentials to be sent via request body. - - - - HTTP Basic Authentication for client authentication - - 3 - - - - HTTP Basic Authentication for client authentication - - 3 - - - - Client credentials are sent via request body - - 3 - - - - The request parameters to be sent to authorization end point. - - 3 - - - - The desired response type from the OAuth authorization end point. - - 3 - - - - Client secret credentials. - - 3 - - - - The scope of the access. - - 3 - - - - The authorization end point URL. - - 3 - - - - The redirection endpoint of the auhorization flow. - - 3 - - - - The access token end point URL. - - 3 - - - - The client's state which is maintained between request and response. - - 3 - - - - Custom key-value parameters to be sent to the server - - 3 - - - - The response containing authroization code from the authorization server. - - 3 - - - - Destructor of the AuthorizationResponse class. - - 3 - - - - The authroization code. - - 3 - - - - The state parameter present in authorization request. - - 3 - - The value can be null depending on the server specifications. - - - - - Custom key-value parameter received from service provider - - 3 - - The return value can be null depending on the server specifications. - - - - - Releases any unmanaged resources used by this object. - - 3 - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - An abstract class to represent various OAuth 2.0 authorization code flows. - Refer to http://tools.ietf.org/html/rfc6749 about OAuth 2.0 protocols. - Also service provider document needs to be referred for using end points and additional parameters. - - 3 - - - - Constructor for Authoirzer instances - - 3 - - - - Destructor of the Authorizer class. - - 3 - - - - Indicates if the current instance is already handling an authorization request - - 3 - - - - Authorizes the client with access toekn / authorizaion code in Implicit and Authorization Code grant flows respectively. - - 3 - - - An authorization request - The authorization response from server - - - - Gets the access token in OAuth2 supported grant flows except Implicit Grant flow. - - 3 - - - A token request - The response from server - - - - Releases any unmanaged resources used by this object. - - 3 - - - - Retrieves access token using a refresh token. - - 3 - Request containing refresh token - The response containing access token. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Contains client credentials required for authentication in request-body - - 3 - - - - The constructor - - 3 - - - - The client identifier - - 3 - - - - The client secret - - 3 - - - - The ClientCredentialsAuthorizer is used to obtain access tokens using Client Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.4 - - 3 - - - - The constructor - - 3 - - - - Authorization not supported through this API for this flow. - - 3 - Thrown when the operation is not supported - - - - Refreshing access token is not supported in this flow. - - 3 - Thrown when the operation is not supported - - - - Retrieves access token using client credentials. - The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.4.2 - - 3 - The token request - The response containing access token. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - The class contains request parameters for retreiving access token in Client Credentials Grant flow. - - 3 - - - - The constructor - - 3 - - - - The grant type. - - 3 - - - - The class contains request parameters for retreiving authorization code in Authorization Code Grant flow. - Please refer https://tools.ietf.org/html/rfc6749#section-4.1.1 for more details - - - - - The constructor - - 3 - - - - The response type parameter to authorization server. - - 3 - - - - The CodeGrantAuthorizer is used to obtain access tokens and refresh tokens using Authorization Code Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.1 - - 3 - - - - The constructor - - 3 - - - - Retrieves authorization code asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.1 - - 3 - The authorization request - The response containing authorization code. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - Retrieves access token by exchanging authorization code received using . - The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.3 - - 3 - The token request - The response containing access token. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - Clears the cookies - - 3 - - - - Clear the cache - - 3 - - - - The class contains request parameters for retreiving access token in Authorization Code Grant flow. - - 3 - - - - The constructor - - 3 - - - - The grant type - - 3 - - - - The authoriztion code received from the authorization server. - - 3 - - - - The class contains request parameters for retreiving access token in Implicit Grant flow. - - - - - The constructor - - 3 - - - - The response type parameter to aturhoization server. - - 3 - - - - The ImplicitGrantAuthorizer is used to obtain access tokens using Implicit Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.2 - - 3 - - - - The constructor - - 3 - - - - Retrieves access token asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.2.1 - - 3 - The authorization request - The response containing access token. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - Access token can be retreived implicitly using in this flow. - - 3 - Thrown when the operation is not supported - - - - Refreshing access token is not supported in this flow. - - 3 - Thrown when the operation is not supported - - - - Exception wrapper for OAuth2 related exception - - - - - The error response. - - 3 - - - - Wrapper class contaning OAuth2 related error information - - 3 - - - - The server error code - - 3 - - - - The platform error cocde - - 3 - - - - Error description - - 3 - - - - URI of the error page. - - 3 - - - - The refresh token which can be used to obtain new access token. - - 3 - - - - The refresh token issued to the client. - - 3 - - - - The class contains request parameters for refreshing an access token. - - 3 - - - - The constructor - - 3 - - - - The grant type to be used - - 3 - - - - The refresh token issued by authorization server. - - 3 - - - - The ResourceOwnerPwdCredentialsAuthorizer is used to obtain access tokens using Resource Owner Password Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.3 - - 3 - - - - The constructor - - 3 - - - - Authorization not supported through this API for this flow. - - 3 - Thrown when the operation is not supported - - - - Retrieves access token by sending resource owner's password credentials. - The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.3.2 - - 3 - The token request - The response containing access token. - http://tizen.org/privilege/internet - Thrown when method failed due to invalid argumets - Thrown when method fails due to server error - - - - The class contains request parameters for retreiving access token in Resource Owner Password Credentials Grant flow. - - 3 - - - - The constructor - - - - - The grant type - - 3 - - - - The resource owner username - - 3 - - - - The resource owner password - - 3 - - - - Abstract wrapper class containing OAuth 2.0 request parameters for requesting an access token. - - 3 - - - - The Grant type - - 3 - - - - The client credentials - - 3 - - - - The access token end point URL. - - 3 - - - - The redirection endpoint of the auhorization flow. - - 3 - - - - The scope of the access request as described by https://tools.ietf.org/html/rfc6749#section-3.3 - - 3 - - - - Custom key-value parameters to be sent to the server - - 3 - - - - Client authentication scheme. Default is Basic - - 3 - - - - The client's state which is maintained between request and response. - - 3 - - - - The response from authroization server containing access token and an optional refresh token. - - 3 - - - - Destructor of the AuthorizationResponse class. - - 3 - - - - The access token - - 3 - - - - The state parameter present in authorization request. - - 3 - - The value can be null depending on the server specifications. - - - - - The refresh token. The value will be null if authorization server doesn't return a refresh token. - - 3 - - Issuing a refresh token is optional at the discretion of the authorization server. - - - - - Gets the value of the key received from service provider - - 3 - The value of respecitve key - Thrown when the key does not exist or when there is an invalid parameter. - - - - Releases any unmanaged resources used by this object. - - 3 - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - + + + + Tizen.Account.OAuth2 + + + + + Contains Interop declarations of OAuth2 classes. + + + Contains Interop declarations of OAuth2 classes. + + + Contains Interop declarations of OAuth2 classes. + + + Contains Interop declarations of OAuth2 classes. + + + Contains Interop declarations of OAuth2 classes. + + + Contains Interop declarations of OAuth2 classes. + + + + + Safehandle wrapper for OAuth2 native handles. + + + + + Wrapper class for OAuth2 native API. + + + + + Wrapper class for maintaining names of dependent native libraries. + + + + + Wrapper class for OAuth2 native API. + + + + + Wrapper class for OAuth2 native API. + + + + + Wrapper class for OAuth2 native API. + + + + + Class containing access token and related information. + + 3 + + + + The lifetime in seconds of the access token. + + 3 + + + + The access token issued by the authorization server. + + 3 + + + + The scope of the access token. + + 3 + + + + The type of the access token. + + 3 + + + + Enumerations for Client authentication scheme, used to sign client id and client secret accordingly. + Default is Basic (http://tools.ietf.org/html/rfc2617#section-2) + + 3 + Facebook and Google does not support HTTP Basic Authentication, instead they require client credentials to be sent via request body. + + + + HTTP Basic Authentication for client authentication + + 3 + + + + HTTP Basic Authentication for client authentication + + 3 + + + + Client credentials are sent via request body + + 3 + + + + The request parameters to be sent to authorization end point. + + 3 + + + + The desired response type from the OAuth authorization end point. + + 3 + + + + Client secret credentials. + + 3 + + + + The scope of the access. + + 3 + + + + The authorization end point URL. + + 3 + + + + The redirection endpoint of the auhorization flow. + + 3 + + + + The access token end point URL. + + 3 + + + + The client's state which is maintained between request and response. + + 3 + + + + Custom key-value parameters to be sent to the server + + 3 + + + + The response containing authroization code from the authorization server. + + 3 + + + + Destructor of the AuthorizationResponse class. + + 3 + + + + The authroization code. + + 3 + + + + The state parameter present in authorization request. + + 3 + + The value can be null depending on the server specifications. + + + + + Custom key-value parameter received from service provider + + 3 + + The return value can be null depending on the server specifications. + + + + + Releases any unmanaged resources used by this object. + + 3 + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + An abstract class to represent various OAuth 2.0 authorization code flows. + Refer to http://tools.ietf.org/html/rfc6749 about OAuth 2.0 protocols. + Also service provider document needs to be referred for using end points and additional parameters. + + 3 + + + + Constructor for Authoirzer instances + + 3 + + + + Destructor of the Authorizer class. + + 3 + + + + Indicates if the current instance is already handling an authorization request + + 3 + + + + Authorizes the client with access toekn / authorizaion code in Implicit and Authorization Code grant flows respectively. + + 3 + + + An authorization request + The authorization response from server + + + + Gets the access token in OAuth2 supported grant flows except Implicit Grant flow. + + 3 + + + A token request + The response from server + + + + Releases any unmanaged resources used by this object. + + 3 + + + + Retrieves access token using a refresh token. + + 3 + Request containing refresh token + The response containing access token. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Contains client credentials required for authentication in request-body + + 3 + + + + The constructor + + 3 + + + + The client identifier + + 3 + + + + The client secret + + 3 + + + + The ClientCredentialsAuthorizer is used to obtain access tokens using Client Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.4 + + 3 + + + + The constructor + + 3 + + + + Authorization not supported through this API for this flow. + + 3 + Thrown when the operation is not supported + + + + Refreshing access token is not supported in this flow. + + 3 + Thrown when the operation is not supported + + + + Retrieves access token using client credentials. + The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.4.2 + + 3 + The token request + The response containing access token. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + The class contains request parameters for retreiving access token in Client Credentials Grant flow. + + 3 + + + + The constructor + + 3 + + + + The grant type. + + 3 + + + + The class contains request parameters for retreiving authorization code in Authorization Code Grant flow. + Please refer https://tools.ietf.org/html/rfc6749#section-4.1.1 for more details + + + + + The constructor + + 3 + + + + The response type parameter to authorization server. + + 3 + + + + The CodeGrantAuthorizer is used to obtain access tokens and refresh tokens using Authorization Code Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.1 + + 3 + + + + The constructor + + 3 + + + + Retrieves authorization code asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.1 + + 3 + The authorization request + The response containing authorization code. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + Retrieves access token by exchanging authorization code received using . + The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.1.3 + + 3 + The token request + The response containing access token. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + Clears the cookies + + 3 + + + + Clear the cache + + 3 + + + + The class contains request parameters for retreiving access token in Authorization Code Grant flow. + + 3 + + + + The constructor + + 3 + + + + The grant type + + 3 + + + + The authoriztion code received from the authorization server. + + 3 + + + + The class contains request parameters for retreiving access token in Implicit Grant flow. + + + + + The constructor + + 3 + + + + The response type parameter to aturhoization server. + + 3 + + + + The ImplicitGrantAuthorizer is used to obtain access tokens using Implicit Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.2 + + 3 + + + + The constructor + + 3 + + + + Retrieves access token asynchronously. The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.2.1 + + 3 + The authorization request + The response containing access token. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + Access token can be retreived implicitly using in this flow. + + 3 + Thrown when the operation is not supported + + + + Refreshing access token is not supported in this flow. + + 3 + Thrown when the operation is not supported + + + + Exception wrapper for OAuth2 related exception + + + + + The error response. + + 3 + + + + Wrapper class contaning OAuth2 related error information + + 3 + + + + The server error code + + 3 + + + + The platform error cocde + + 3 + + + + Error description + + 3 + + + + URI of the error page. + + 3 + + + + The refresh token which can be used to obtain new access token. + + 3 + + + + The refresh token issued to the client. + + 3 + + + + The class contains request parameters for refreshing an access token. + + 3 + + + + The constructor + + 3 + + + + The grant type to be used + + 3 + + + + The refresh token issued by authorization server. + + 3 + + + + The ResourceOwnerPwdCredentialsAuthorizer is used to obtain access tokens using Resource Owner Password Credentials Grant flow as described at https://tools.ietf.org/html/rfc6749#section-4.3 + + 3 + + + + The constructor + + 3 + + + + Authorization not supported through this API for this flow. + + 3 + Thrown when the operation is not supported + + + + Retrieves access token by sending resource owner's password credentials. + The authroization request parameters should be as defined in https://tools.ietf.org/html/rfc6749#section-4.3.2 + + 3 + The token request + The response containing access token. + http://tizen.org/privilege/internet + Thrown when method failed due to invalid argumets + Thrown when method fails due to server error + + + + The class contains request parameters for retreiving access token in Resource Owner Password Credentials Grant flow. + + 3 + + + + The constructor + + + + + The grant type + + 3 + + + + The resource owner username + + 3 + + + + The resource owner password + + 3 + + + + Abstract wrapper class containing OAuth 2.0 request parameters for requesting an access token. + + 3 + + + + The Grant type + + 3 + + + + The client credentials + + 3 + + + + The access token end point URL. + + 3 + + + + The redirection endpoint of the auhorization flow. + + 3 + + + + The scope of the access request as described by https://tools.ietf.org/html/rfc6749#section-3.3 + + 3 + + + + Custom key-value parameters to be sent to the server + + 3 + + + + Client authentication scheme. Default is Basic + + 3 + + + + The client's state which is maintained between request and response. + + 3 + + + + The response from authroization server containing access token and an optional refresh token. + + 3 + + + + Destructor of the AuthorizationResponse class. + + 3 + + + + The access token + + 3 + + + + The state parameter present in authorization request. + + 3 + + The value can be null depending on the server specifications. + + + + + The refresh token. The value will be null if authorization server doesn't return a refresh token. + + 3 + + Issuing a refresh token is optional at the discretion of the authorization server. + + + + + Gets the value of the key received from service provider + + 3 + The value of respecitve key + Thrown when the key does not exist or when there is an invalid parameter. + + + + Releases any unmanaged resources used by this object. + + 3 + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + diff --git a/Artifacts/bin/Tizen.Account.SyncManager.dll b/Artifacts/bin/Tizen.Account.SyncManager.dll new file mode 100644 index 0000000..fe1ce5d Binary files /dev/null and b/Artifacts/bin/Tizen.Account.SyncManager.dll differ diff --git a/Artifacts/bin/Tizen.Account.SyncManager.pdb b/Artifacts/bin/Tizen.Account.SyncManager.pdb new file mode 100644 index 0000000..5157136 Binary files /dev/null and b/Artifacts/bin/Tizen.Account.SyncManager.pdb differ diff --git a/Artifacts/bin/Tizen.Account.SyncManager.xml b/Artifacts/bin/Tizen.Account.SyncManager.xml new file mode 100644 index 0000000..9bd1af4 --- /dev/null +++ b/Artifacts/bin/Tizen.Account.SyncManager.xml @@ -0,0 +1,236 @@ + + + + Tizen.Account.SyncManager + + + + + Wrapper class for maintaining names of dependent native libraries. + + + + + Enumeration for the Sync option + + + + + Sync job will be operated normally + + + + + Sync job will be operated as soon as possible + + + + + Sync job will not be performed again when it fails + + + + + Enumeration for the Sync period + + + + + Sync within 30 minutes + + + + + Sync within 1 hour + + + + + Sync within 2 hours + + + + + Sync within 3 hours + + + + + Sync within 6 hours + + + + + Sync within 12 hours + + + + + Sync within 1 day + + + + + The class contains the delegates to be called upon scheduling a sync operation + + + + + Callback function for Sync Adapter's start sync request + + The sync job parameters corresponding to the sync request. + true if sync operation is success, @c false otherwise. + + + + Callback function for Sync Adapter's cancel sync request. + + The sync job parameters corresponding to the sync request. + + + + Sets client (Sync Adapter) callback functions + + A callback function to be called by Sync Manager for performing sync operation. + A callback function to be called by Sync Manager for cancelling sync operation. + Thrown when any of the arguments are null. + Thrown when the application calling this API cannot be a sync adapter. + + + + Unsets client (Sync Adapter) callback functions + + Thrown when sync manager internal error occurs. + + + + The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations. + Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations. + + + + + The constructor + + + + + Requests Sync Manager to perform one time sync operation + + Sync job information of the sync job request. + sync options determine an way to operate sync job and can be used as ORing. + Thrown when any of the arugments are null. + Thrown when the application calling this api doesn't have a sync adapter. + A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + + + + Requests Sync Manager to perform periodic sync operations + + Sync job information of the sync job request. + Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. + sync options determine an way to operate sync job and can be used as ORing. + http://tizen.org/privilege/alarm.set + In case of privilege not defined. + Thrown when any of the arguments are null. + Thrown when the application calling this API doesn't have a sync adapter. + A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + + + + Requests Sync Manager to perform sync operations whenever corresponding DB changed + + Sync job information of the sync job request. + sync options determine an way to operate sync job and can be used as ORing. + http://tizen.org/privilege/calendar.read + http://tizen.org/privilege/contact.read + In case of privilege not defined. + Thrown when any of the arguments are null. + Thrown when the application calling this API doesn't have a sync adapter. + A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + + + + Get all the sync jobs registered with the sync manager + + + Returns the list of SyncJobData corresponding to sync requests. + + + + + Requests Sync Manager to remove corresponding sync job job based on id + + A unique value of each sync job, it can be used to search specific sync job and remove it. + Thrown if the input arugments is invalid. + + + + Class represents information about a sync job request + + + + + Represents calendar capability + + + If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object. + + + + + Represents contact capability + + + If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object. + + + + + Represents image capability + + + If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object. + + + + + Represents video capability + + + If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object. + + + + + Represents sound capability + + + If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object. + + + + + Represents music capability + + + If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object. + + + + + The account instance on which sync operation was requested or @c null in the case of accountless sync operation + + + + + User data which contains additional information related registered sync job + + + + + A string representing a sync job which has been operated or capability setting to operate data change sync job + + + + diff --git a/Artifacts/bin/Tizen.Applications.Alarm.dll b/Artifacts/bin/Tizen.Applications.Alarm.dll index 86e38ab..b0d2be4 100644 Binary files a/Artifacts/bin/Tizen.Applications.Alarm.dll and b/Artifacts/bin/Tizen.Applications.Alarm.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Alarm.pdb b/Artifacts/bin/Tizen.Applications.Alarm.pdb index f3f4898..80eaea9 100644 Binary files a/Artifacts/bin/Tizen.Applications.Alarm.pdb and b/Artifacts/bin/Tizen.Applications.Alarm.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Alarm.xml b/Artifacts/bin/Tizen.Applications.Alarm.xml index 5a31163..0d8d91b 100644 --- a/Artifacts/bin/Tizen.Applications.Alarm.xml +++ b/Artifacts/bin/Tizen.Applications.Alarm.xml @@ -1,290 +1,290 @@ - - - - Tizen.Applications.Alarm - - - - - The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future. - - - - public class AlarmExample - { - /// ... - IEnumerable < Alarm > alarms = AlarmManager.GetAllScheduledAlarms(); - alarms[0].Cancel(); - } - - - - - - Constructor created with the new AlarmId. - - - - - - The alarm ID uniquely identifies an alarm. - - - - - Gets the recurrence days of the week. - - http://tizen.org/privilege/alarm.get - - week_flag may be a combination of days, like Tuesday | Friday. - - - - - Gets the scheduled time. - - http://tizen.org/privilege/alarm.get - - - - Gets the period of time between the recurrent alarms. - - http://tizen.org/privilege/alarm.get - - - - Gets the AppControl to be invoked when the the alarm is triggered. - - http://tizen.org/privilege/alarm.get - - - - Gets whether the alarm will launch global application or not. - - http://tizen.org/privilege/alarm.set - http://tizen.org/privilege/alarm.get - - - - Cancels the specific alarm. - - Thrown in case of an invalid parmaeter. - Thrown in case of a permission denied due to insufficient privileges. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Enumeration for alarm week flag, the days of the week. - - - - - An identifier for Sunday. - - - - - An identifier for Monday. - - - - - An identifier for Tuesday. - - - - - An identifier for Wednesday. - - - - - An identifier for Thursday. - - - - - An identifier for Friday. - - - - - An identifier for Saturday. - - - - - All days of the week. - - - - - Only weekdays. - - - - - Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms. - The most obvious case is a calendar scheduling application, which lets you know when a meeting is about to start. Alarms are certainly better than actively waiting in a loop. - They are also better than putting an interface to sleep because they do not block your main UI thread. - Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks. - If an application is installed after setting the alarm, your alarm is canceled automatically. - - - - public class AlarmManagerExample - { - /// ... - Alarm alarm = AlarmManager.CreateAlarm(24000,1000,null); - AlarmManager.CancelAll(); - } - - - - - - Sets an alarm to be triggered after a specific time. - The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. - - The amount of time before the first execution (in seconds). - The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. - The actual interval is calculated by the OS. The minimum value is 600sec. - The destination AppControl is used to perform a specific task when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Sets an alarm to be triggered after a specific time. - The alarm will go off delay seconds later. - - The amount of time before the execution (in seconds). - The destination AppControl to perform a specific task when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Sets an alarm to be triggered at a specific time. - The date describes the time of the first occurrence. - - The first active alarm time. - The destination AppControl to perform specific work when the alarm is triggered. - An alarm instance is created with the set param values. - This operation is permitted with the UI application appcontrol only. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Sets an alarm to be triggered periodically, starting at a specific time. - The date describes the time of the first occurrence. - The weekFlag is the repeat value of the days of the week. - If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. - - This operation is permitted with UI application appcontrol only. - The first active alarm time. - The day of the week, AlarmWeekFlag may be a combination of days, like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday. - The destination AppControl to perform specific work when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Sets a notification alarm to be triggered at a specific time. - The date describes the time of the first occurrence. - - The first active alarm time. - The notification to be posted when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - http://tizen.org/privilege/notification - - - - Sets a notification alarm to be triggered after a specific time. - The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. - - The amount of time before the first execution (in seconds). - The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. - The notification to be posted when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - http://tizen.org/privilege/notification - - - - Sets a notification alarm to be triggered periodically, starting at a specific time. - The date describes the time of the first occurrence. - The weekFlag is the repeat value of the days of the week. - If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. - - The first active alarm time. - The day of the week, AlarmWeekFlag may be a combination of days, - like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday. - The notification to be posted when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - http://tizen.org/privilege/notification - - - - Sets a notification alarm to be triggered after a specific time. - The alarm will go off delay seconds later. - - The amount of time before the first execution (in seconds). - The notification to be posted when the alarm is triggered. - An alarm instance is created with the set param values. - Thrown in case of an invalid parameter. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - http://tizen.org/privilege/notification - - - - Cancels all scheduled alarms that are registered by the application that calls this API. - - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.set - - - - Retrieves all registered alarms. - - List of all alarm instances. - Thrown in case of a permission denied. - Thrown in case of any internal error. - http://tizen.org/privilege/alarm.get - - - - Gets the current system time. - - The current system time. - Thrown in case of any internal error. - - - + + + + Tizen.Applications.Alarm + + + + + The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future. + + + + public class AlarmExample + { + /// ... + IEnumerable < Alarm > alarms = AlarmManager.GetAllScheduledAlarms(); + alarms[0].Cancel(); + } + + + + + + Constructor created with the new AlarmId. + + + + + + The alarm ID uniquely identifies an alarm. + + + + + Gets the recurrence days of the week. + + http://tizen.org/privilege/alarm.get + + week_flag may be a combination of days, like Tuesday | Friday. + + + + + Gets the scheduled time. + + http://tizen.org/privilege/alarm.get + + + + Gets the period of time between the recurrent alarms. + + http://tizen.org/privilege/alarm.get + + + + Gets the AppControl to be invoked when the the alarm is triggered. + + http://tizen.org/privilege/alarm.get + + + + Gets whether the alarm will launch global application or not. + + http://tizen.org/privilege/alarm.set + http://tizen.org/privilege/alarm.get + + + + Cancels the specific alarm. + + Thrown in case of an invalid parmaeter. + Thrown in case of a permission denied due to insufficient privileges. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Enumeration for alarm week flag, the days of the week. + + + + + An identifier for Sunday. + + + + + An identifier for Monday. + + + + + An identifier for Tuesday. + + + + + An identifier for Wednesday. + + + + + An identifier for Thursday. + + + + + An identifier for Friday. + + + + + An identifier for Saturday. + + + + + All days of the week. + + + + + Only weekdays. + + + + + Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms. + The most obvious case is a calendar scheduling application, which lets you know when a meeting is about to start. Alarms are certainly better than actively waiting in a loop. + They are also better than putting an interface to sleep because they do not block your main UI thread. + Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks. + If an application is installed after setting the alarm, your alarm is canceled automatically. + + + + public class AlarmManagerExample + { + /// ... + Alarm alarm = AlarmManager.CreateAlarm(24000,1000,null); + AlarmManager.CancelAll(); + } + + + + + + Sets an alarm to be triggered after a specific time. + The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. + + The amount of time before the first execution (in seconds). + The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. + The actual interval is calculated by the OS. The minimum value is 600sec. + The destination AppControl is used to perform a specific task when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Sets an alarm to be triggered after a specific time. + The alarm will go off delay seconds later. + + The amount of time before the execution (in seconds). + The destination AppControl to perform a specific task when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Sets an alarm to be triggered at a specific time. + The date describes the time of the first occurrence. + + The first active alarm time. + The destination AppControl to perform specific work when the alarm is triggered. + An alarm instance is created with the set param values. + This operation is permitted with the UI application appcontrol only. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Sets an alarm to be triggered periodically, starting at a specific time. + The date describes the time of the first occurrence. + The weekFlag is the repeat value of the days of the week. + If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. + + This operation is permitted with UI application appcontrol only. + The first active alarm time. + The day of the week, AlarmWeekFlag may be a combination of days, like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday. + The destination AppControl to perform specific work when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Sets a notification alarm to be triggered at a specific time. + The date describes the time of the first occurrence. + + The first active alarm time. + The notification to be posted when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + http://tizen.org/privilege/notification + + + + Sets a notification alarm to be triggered after a specific time. + The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds. + + The amount of time before the first execution (in seconds). + The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. + The notification to be posted when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + http://tizen.org/privilege/notification + + + + Sets a notification alarm to be triggered periodically, starting at a specific time. + The date describes the time of the first occurrence. + The weekFlag is the repeat value of the days of the week. + If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time. + + The first active alarm time. + The day of the week, AlarmWeekFlag may be a combination of days, + like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday. + The notification to be posted when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + http://tizen.org/privilege/notification + + + + Sets a notification alarm to be triggered after a specific time. + The alarm will go off delay seconds later. + + The amount of time before the first execution (in seconds). + The notification to be posted when the alarm is triggered. + An alarm instance is created with the set param values. + Thrown in case of an invalid parameter. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + http://tizen.org/privilege/notification + + + + Cancels all scheduled alarms that are registered by the application that calls this API. + + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.set + + + + Retrieves all registered alarms. + + List of all alarm instances. + Thrown in case of a permission denied. + Thrown in case of any internal error. + http://tizen.org/privilege/alarm.get + + + + Gets the current system time. + + The current system time. + Thrown in case of any internal error. + + + diff --git a/Artifacts/bin/Tizen.Applications.AttachPanel.dll b/Artifacts/bin/Tizen.Applications.AttachPanel.dll index bf6e9c7..2c8409f 100644 Binary files a/Artifacts/bin/Tizen.Applications.AttachPanel.dll and b/Artifacts/bin/Tizen.Applications.AttachPanel.dll differ diff --git a/Artifacts/bin/Tizen.Applications.AttachPanel.pdb b/Artifacts/bin/Tizen.Applications.AttachPanel.pdb index 961fa18..0b2d866 100644 Binary files a/Artifacts/bin/Tizen.Applications.AttachPanel.pdb and b/Artifacts/bin/Tizen.Applications.AttachPanel.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.AttachPanel.xml b/Artifacts/bin/Tizen.Applications.AttachPanel.xml index 71d7b1d..5212640 100644 --- a/Artifacts/bin/Tizen.Applications.AttachPanel.xml +++ b/Artifacts/bin/Tizen.Applications.AttachPanel.xml @@ -1,286 +1,286 @@ - - - - Tizen.Applications.AttachPanel - - - - - Represents immutable class for attach panel. - - - - - Represents immutable class for attach panel. - - 3 - The caller's conformant - Thrown when an attempt to allocate memory fails. - Thrown when the AttachPanel is already exist or the is not a conformant object - - - - Gets the state of the AttachPanel. - - The AttachPanel window state - - - - Gets the value that indicates whether the AttachPanel is visible. - - visible value of AttachPanel state - - - - Add a content category in the AttachPanel. - - The ContentCategory to be added in the AttachPanel - The AttachPanel send some information using Bundle - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/camera - http://tizen.org/privilege/recorder - http://tizen.org/privilege/appmanager.launch - http://tizen.org/feature/camera - http://tizen.org/feature/microphone - - The caller app has to check the return value of this function. - Content categories will be shown as the sequence of using AddCategory - Some contents need time to load it all. - So, it is needed to use this before the mainloop of Show - Privileges, - http://tizen.org/privilege/mediastorage, for using Image or Camera - http://tizen.org/privilege/camera, for using Camera or TakePicture - http://tizen.org/privilege/recorder, for using Voice - http://tizen.org/privilege/appmanager.launch, for adding content categories on the More tab - http://tizen.org/feature/camera, for using Camera or TakePicture - http://tizen.org/feature/microphone, for using Voice - Deliver more information to the callee with a bundle if you need. - http://tizen.org/appcontrol/data/total_count - http://tizen.org/appcontrol/data/total_size - - Thrown when the is not a valid category - Thrown when application does not have privilege to access this method - Thrown when the device does not supported the feature - Thrown when the AttachPanel is not created yet or already destroyed - - - - Removes the ContentCategory from the AttachPanel - - The ContentCategory adding in the AttachPanel - Thrown when the is not a valid category - Thrown when the AttachPanel is not created yet or already destroyed - - - - Sets extraData to send to the ContentCategory using a Bundle - - The ContentCategory that some information to be set in the AttachPanel. - The AttachPanel send some information using Bundle - Thrown when the is not a valid category - Thrown when the AttachPanel is destroyed - Thrown when an attempt to allocate memory fails. - - - - Shows the attach panel with animations - - Thrown when the AttachPanel is destroyed - - - - Shows the attach panel and selects whether or not to animate - - Thrown when the AttachPanel is destroyed - - - - Hides the attach panel with animations - - Thrown when the AttachPanel is destroyed - - - - Hides the attach panel and selects whether or not to animate - - Thrown when the AttachPanel is destroyed - - - - Occurs when reserved events are published from the panel-side. - - - - - Occurs when an user selects and confirms something to attach in the AttachPanel - - - - - Enumeration for the attach panel content category. - - - - - Attaching images from the gallery - - - - - Taking pictures to attach - - - - - Taking a voice clip to attach - - - - - Attaching video from the gallery - - - - - Attaching audio from my files - - - - - Attaching calendar data from the calendar - - - - - Attaching contact data from the contacts - - - - - Attaching files data from my files - - - - - Taking a video clip to attach - - - - - Attaching files from the document list - - - - - Launching apps to take pictures will be attached - - - - - Attaching memo data from the memo - - - - - Enumeration for the attach panel event. - - - - - Attach panel starts the effect to show - - - - - Attach panel finishes the effect to show - - - - - Attach panel starts the effect to hide the panel - - - - - Attach panel finishes the effect to hide the panel - - - - - Class for event arguments of the result event - - - - - Property for attach panel object. - - - - - Results are from the content category. - - - - - Property for result - The caller app has to use ExtraData property to get received data. - - - - - Property for result of AppControl - - - - - Property for user data - - - - - Class for event arguments of the state event - - - - - Property for attach panel object - - - - - Property for event type. - - - - - Additional event information. - This can be NULL if there are no necessary information. - - - - - Property for user data. - - - - - Enumeration for the attach panel's window state. - - - - - Attach panel is not visible - - - - - Attach panel is in partial window mode - - - - - Attach panel is in full screen mode - - - - + + + + Tizen.Applications.AttachPanel + + + + + Represents immutable class for attach panel. + + + + + Represents immutable class for attach panel. + + 3 + The caller's conformant + Thrown when an attempt to allocate memory fails. + Thrown when the AttachPanel is already exist or the is not a conformant object + + + + Gets the state of the AttachPanel. + + The AttachPanel window state + + + + Gets the value that indicates whether the AttachPanel is visible. + + visible value of AttachPanel state + + + + Add a content category in the AttachPanel. + + The ContentCategory to be added in the AttachPanel + The AttachPanel send some information using Bundle + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/camera + http://tizen.org/privilege/recorder + http://tizen.org/privilege/appmanager.launch + http://tizen.org/feature/camera + http://tizen.org/feature/microphone + + The caller app has to check the return value of this function. + Content categories will be shown as the sequence of using AddCategory + Some contents need time to load it all. + So, it is needed to use this before the mainloop of Show + Privileges, + http://tizen.org/privilege/mediastorage, for using Image or Camera + http://tizen.org/privilege/camera, for using Camera or TakePicture + http://tizen.org/privilege/recorder, for using Voice + http://tizen.org/privilege/appmanager.launch, for adding content categories on the More tab + http://tizen.org/feature/camera, for using Camera or TakePicture + http://tizen.org/feature/microphone, for using Voice + Deliver more information to the callee with a bundle if you need. + http://tizen.org/appcontrol/data/total_count + http://tizen.org/appcontrol/data/total_size + + Thrown when the is not a valid category + Thrown when application does not have privilege to access this method + Thrown when the device does not supported the feature + Thrown when the AttachPanel is not created yet or already destroyed + + + + Removes the ContentCategory from the AttachPanel + + The ContentCategory adding in the AttachPanel + Thrown when the is not a valid category + Thrown when the AttachPanel is not created yet or already destroyed + + + + Sets extraData to send to the ContentCategory using a Bundle + + The ContentCategory that some information to be set in the AttachPanel. + The AttachPanel send some information using Bundle + Thrown when the is not a valid category + Thrown when the AttachPanel is destroyed + Thrown when an attempt to allocate memory fails. + + + + Shows the attach panel with animations + + Thrown when the AttachPanel is destroyed + + + + Shows the attach panel and selects whether or not to animate + + Thrown when the AttachPanel is destroyed + + + + Hides the attach panel with animations + + Thrown when the AttachPanel is destroyed + + + + Hides the attach panel and selects whether or not to animate + + Thrown when the AttachPanel is destroyed + + + + Occurs when reserved events are published from the panel-side. + + + + + Occurs when an user selects and confirms something to attach in the AttachPanel + + + + + Enumeration for the attach panel content category. + + + + + Attaching images from the gallery + + + + + Taking pictures to attach + + + + + Taking a voice clip to attach + + + + + Attaching video from the gallery + + + + + Attaching audio from my files + + + + + Attaching calendar data from the calendar + + + + + Attaching contact data from the contacts + + + + + Attaching files data from my files + + + + + Taking a video clip to attach + + + + + Attaching files from the document list + + + + + Launching apps to take pictures will be attached + + + + + Attaching memo data from the memo + + + + + Enumeration for the attach panel event. + + + + + Attach panel starts the effect to show + + + + + Attach panel finishes the effect to show + + + + + Attach panel starts the effect to hide the panel + + + + + Attach panel finishes the effect to hide the panel + + + + + Class for event arguments of the result event + + + + + Property for attach panel object. + + + + + Results are from the content category. + + + + + Property for result + The caller app has to use ExtraData property to get received data. + + + + + Property for result of AppControl + + + + + Property for user data + + + + + Class for event arguments of the state event + + + + + Property for attach panel object + + + + + Property for event type. + + + + + Additional event information. + This can be NULL if there are no necessary information. + + + + + Property for user data. + + + + + Enumeration for the attach panel's window state. + + + + + Attach panel is not visible + + + + + Attach panel is in partial window mode + + + + + Attach panel is in full screen mode + + + + diff --git a/Artifacts/bin/Tizen.Applications.Badge.dll b/Artifacts/bin/Tizen.Applications.Badge.dll index c121911..d80a1c3 100644 Binary files a/Artifacts/bin/Tizen.Applications.Badge.dll and b/Artifacts/bin/Tizen.Applications.Badge.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Badge.pdb b/Artifacts/bin/Tizen.Applications.Badge.pdb index a8288c2..b09099d 100644 Binary files a/Artifacts/bin/Tizen.Applications.Badge.pdb and b/Artifacts/bin/Tizen.Applications.Badge.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Badge.xml b/Artifacts/bin/Tizen.Applications.Badge.xml index 428e081..2197edd 100644 --- a/Artifacts/bin/Tizen.Applications.Badge.xml +++ b/Artifacts/bin/Tizen.Applications.Badge.xml @@ -1,178 +1,178 @@ - - - - Tizen.Applications.Badge - - - - - The class containing common properties of the Badge. - - - - - Initializes a new instance of the Badge class. - - 3 - Application ID - Count value - True if it should be displayed - Thrown when failed because of invalid argument - - - - Property for the count value of the badge. - - 3 - - - - Property for the application ID of the badge. - - 3 - - - - Property for display visibility. True if the badge display visible, otherwise false.. - - 3 - - - - The class for badge operation. - - - - - Event handler for receiving badge events. - - 3 - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access. - Thrown when Badge is not supported. - - - - Gets the badge information from the application ID. - - 3 - Application ID. - The Badge object with inputted application ID - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when failed because of an invalid argument. - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Removes the badge information. - - 3 - Application ID. - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when failed because of a an invalid argument. - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Removes the badge information. - - 3 - The Badge object. - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when failed because of an invalid argument. - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Adds the badge information. - - 3 - The Badge object. - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when failed because of an invalid argument. - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Updates the badge information. - - 3 - The Badge object. - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when failed because of an invalid argument. - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Gets all the badge information. - - 3 - List of all Badge instances. - http://tizen.org/feature/badge - http://tizen.org/privilege/notification - Thrown when an application does not have the privilege to access. - Thrown in case of failed conditions. - Thrown when Badge is not supported. - - - - Immutable class for getting the badge information. - - - - - The class for event arguments of the badge event. - - - - - Enumeration for the badge action. - - 3 - - - - The badge was added. - - - - - The badge was removed. - - - - - The badge was updated. - - - - - The property for the badge object. - - 3 - - - - The property for the action value. - - 3 - - - + + + + Tizen.Applications.Badge + + + + + The class containing common properties of the Badge. + + + + + Initializes a new instance of the Badge class. + + 3 + Application ID + Count value + True if it should be displayed + Thrown when failed because of invalid argument + + + + Property for the count value of the badge. + + 3 + + + + Property for the application ID of the badge. + + 3 + + + + Property for display visibility. True if the badge display visible, otherwise false.. + + 3 + + + + The class for badge operation. + + + + + Event handler for receiving badge events. + + 3 + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access. + Thrown when Badge is not supported. + + + + Gets the badge information from the application ID. + + 3 + Application ID. + The Badge object with inputted application ID + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when failed because of an invalid argument. + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Removes the badge information. + + 3 + Application ID. + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when failed because of a an invalid argument. + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Removes the badge information. + + 3 + The Badge object. + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when failed because of an invalid argument. + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Adds the badge information. + + 3 + The Badge object. + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when failed because of an invalid argument. + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Updates the badge information. + + 3 + The Badge object. + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when failed because of an invalid argument. + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Gets all the badge information. + + 3 + List of all Badge instances. + http://tizen.org/feature/badge + http://tizen.org/privilege/notification + Thrown when an application does not have the privilege to access. + Thrown in case of failed conditions. + Thrown when Badge is not supported. + + + + Immutable class for getting the badge information. + + + + + The class for event arguments of the badge event. + + + + + Enumeration for the badge action. + + 3 + + + + The badge was added. + + + + + The badge was removed. + + + + + The badge was updated. + + + + + The property for the badge object. + + 3 + + + + The property for the action value. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Applications.Common.dll b/Artifacts/bin/Tizen.Applications.Common.dll index a02a6da..bcadf6f 100644 Binary files a/Artifacts/bin/Tizen.Applications.Common.dll and b/Artifacts/bin/Tizen.Applications.Common.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Common.pdb b/Artifacts/bin/Tizen.Applications.Common.pdb index fa881fb..8079b94 100644 Binary files a/Artifacts/bin/Tizen.Applications.Common.pdb and b/Artifacts/bin/Tizen.Applications.Common.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Common.xml b/Artifacts/bin/Tizen.Applications.Common.xml index 9bfc03e..4be4926 100644 --- a/Artifacts/bin/Tizen.Applications.Common.xml +++ b/Artifacts/bin/Tizen.Applications.Common.xml @@ -1,2133 +1,2133 @@ - - - - Tizen.Applications.Common - - - - - An abstract class to provide default event handlers for apps. - - - - - Low level event types. - - - - - This class represents the type of event for backends. This class can be converted from the string type. - - - - - Pre-defined event type "PreCreated". - - - - - Pre-defined event type "Created". - - - - - Pre-defined event type "Terminated". - - - - - Pre-defined event type "AppControlReceived". - - - - - Pre-defined event type "Resumed". - - - - - Pre-defined event type "Paused". - - - - - Pre-defined event type "LowMemory". - - - - - Pre-defined event type "LowBattery". - - - - - Pre-defined event type "LocaleChanged". - - - - - Pre-defined event type "RegionFormatChanged". - - - - - Pre-defined event type "DeviceOrientationChanged". - - - - - Initializes the EventType class. - - The name of event type. - - - - Returns the name of event type. - - - - - Returns the hash code for event type string. - - - - - Determines whether this instance and a specified object. - - - - - Converts a string to EventType instance. - - - - - An interface that represents the backend lifecycles. - - - - - Adds an event handler. - - The type of event. - The handler method without arguments. - - - - Adds an event handler. - - The EventArgs type used in arguments of the handler method. - The type of event. - The handler method with a TEventArgs type argument. - - - - Runs the mainloop of the backend. - - - - - - Exits the mainloop of the backend. - - - - - Represents the control message to exchange between applications. - - - - public class AppControlExample : UIApplication - { - /// ... - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - AppControl appControl = new AppControl(); - appControl.ApplicationId = "org.tizen.calculator"; - AppControl.SendLaunchRequest(appControl, (launchRequest, replyRequest, result) => { - // ... - }); - } - } - - - - - - Initializes the instance of the AppControl class. - - Thrown when failed to create the AppControl handle. - - - - Initializes the instance of the AppControl class with a parameter. - - The flag value to receive an additional launch result event on the launch request. - Thrown when failed to create the AppControl handle. - - - - Initializes the instance of the AppControl class with the SafeAppControlHandle. - - - - - - Gets the SafeAppControlHandle instance. - - - - - Gets and sets the operation to be performed. - - - The operation is the mandatory information for the launch request. If the operation is not specified, - AppControlOperations.Default is used for the launch request. If the operation is AppControlOperations.Default, - the package information is mandatory to explicitly launch the application. - (if the operation is null for setter, it clears the previous value.) - - - - AppControl appControl = new AppControl(); - appControl.Operation = AppControlOperations.Default; - Log.Debug(LogTag, "Operation: " + appControl.Operation); - - - - - - Gets and sets the explicit MIME type of the data. - - - (if the mime is null for setter, it clears the previous value.) - - - - AppControl appControl = new AppControl(); - appControl.Mime = "image/jpg"; - Log.Debug(LogTag, "Mime: " + appControl.Mime); - - - - - - Gets and sets the URI of the data. - - - Since Tizen 2.4, if the parameter 'uri' is started with 'file://' and - it is a regular file in this application's data path, which can be obtained - by property DataPath in ApplicationInfo class, - it will be shared to the callee application. - Framework will grant a temporary permission to the callee application for this file and - revoke it when the callee application is terminated. - The callee application can just read it. - (if the uri is null for setter, it clears the previous value.) - - - - public class AppControlExample : UIApplication - { - ... - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - ... - AppControl appControl = new AppControl(); - appContrl.Uri = this.ApplicationInfo.DataPath + "image.jpg"; - Log.Debug(LogTag, "Set Uri: " + appControl.Uri); - } - } - - - - - - Gets and sets the explicit category. - - - (if the category is null for setter, it clears the previous value.) - - - - - Gets and sets the application ID to explicitly launch. - - - (if the application ID is null for setter, it clears the previous value.) - - - - AppControl appControl = new AppControl(); - appControl.ApplicationId = "org.tizen.calculator"; - Log.Debug(LogTag, "ApplicationId: " + appControl.ApplicationId); - - - - - - Gets and sets the launch mode of the application. - - - Although, LaunchMode were set as AppControlLaunchMode.Group, the - callee application would be launched as a single mode - if the manifest file of callee application defined the launch mode as "single". - This property can just set the preference of the caller application to launch an application. - Sub-applications, which were launched as a group mode always have own process. - Since Tizen 3.0, if launch mode is not set in the caller application control, - this property returns the AppControlLaunchMode.Single launch mode. - - - - AppControl appControl = new AppControl(); - appControl.LaunchMode = AppControlLaunchMode.Group; - - - - - - Gets the collection of the extra data. - - - Extra data for communication between AppControls. - - - - AppControl appControl = new AppControl(); - appControl.ExtraData.Add("key", "value"); - ... - - - - - - - Sends the launch request. - - - The operation is mandatory information for the launch request. - If the operation is not specified, AppControlOperations.Default is used by default. - If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n - Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. - Also, implicit launch requests are NOT delivered to service applications since 2.4. - To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. - - The AppControl. - Thrown when failed because of a null argument. - Thrown when failed because of an invalid operation. - Thrown when failed because of timeout. - http://tizen.org/privilege/appmanager.launch - - - AppControl appControl = new AppControl(); - appControl.ApplicationId = "org.tizen.calculator"; - AppControl.SendLaunchRequest(appControl); - - - - - - Sends the launch request. - - - The operation is mandatory information for the launch request. - If the operation is not specified, AppControlOperations.Default is used by default. - If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n - Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. - Also, implicit launch requests are NOT delivered to service applications since 2.4. - To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. - - The AppControl. - The callback function to be called when the reply is delivered. - Thrown when failed because of the argument is invalid. - Thrown when failed because of an invalid operation. - Thrown when failed because of timeout. - http://tizen.org/privilege/appmanager.launch - - - AppControl appControl = new AppControl(); - appControl.ApplicationId = "org.tizen.calculator"; - AppControl.SendLaunchRequest(appControl, (launchRequest, replyRequest, result) => { - // ... - }); - - - - - - Sends the terminate request to the application that is launched by AppControl. - - - You are not allowed to terminate other general applications using this API. - This API can be used to terminate sub-applications, which were launched as a group mode by the caller application. - Once the callee application is being terminated by this API, - other applications, which were launched by the callee application as a group mode will be terminated as well. - - The AppControl. - Thrown when failed because of the argument is invalid. - Thrown when failed because of an invalid operation. - Thrown when failed because of timeout. - - - AppControl terminateRequest = new AppControl(); - terminateRequest.ApplicationId = "org.tizen.calculator"; - AppControl.SendTerminateRequest(terminateRequest); - - - - - - Class for extra data. - - - - - Adds extra data. - - - The function replaces any existing value for the given key. - - The name of the extra data. - The value associated with the given key. - Thrown when a key or a value is a zero-length string. - Thrown when the application tries to use the same key with the system-defined key. - - - AppControl appControl = new AppControl(); - appControl.ExtraData.Add("myKey", "myValue"); - - - - - - Adds extra data. - - - The function replaces any existing value for the given key. - - The name of the extra data. - The value associated with the given key. - Thrown when key or value is a zero-length string. - Thrown when the application tries to use the same key with the system-defined key. - - - AppControl appControl = new AppControl(); - string[] myValues = new string[] { "first", "second", "third" }; - appControl.ExtraData.Add("myKey", myValues); - - - - - - - Gets the extra data. - - The name of extra data. - The value associated with the given key. - Thrown when the key is an invalid parameter. - Thrown when the key is not found. - Thrown when the key is rejected. - - - AppControl appControl = new AppControl(); - string myValue = appControl.ExtraData.Get("myKey") as string; - if (myValue != null) - { - // ... - } - - - - - - - Tries getting the extra data. - - The name of extra data. - The value associated with the given key. - The result whether getting the value is done. - Thrown when the key is an invalid parameter. - Thrown when the key is not found. - Thrown when the key is rejected. - - - AppControl appControl = new AppControl(); - string myValue = string.Empty; - bool result = appControl.ExtraData.TryGet("myKey", out myValue); - if (result != null) - { - // ... - } - - - - - - - Removes the extra data. - - The name of the extra data. - Thrown when the key is a zero-length string. - Thrown when the key is not found. - Thrown when the key is rejected. - - - AppControl appControl = new AppControl(); - appControl.ExtraData.Remove("myKey"); - - - - - - Counts keys in the extra data. - - The number of counting keys. - Thrown when the key is an invalid parameter. - - - AppControl appControl = new AppControl(); - int numberOfKeys = appControl.ExtraData.Count(); - - - - - - Checks whether the extra data associated with the given key is of the collection data type. - - The name of the extra data. - If true, the extra data is of the array data type, otherwise false. - Thrown when the key is a zero-length string. - Thrown when failed to check the key. - - - AppControl appControl = new AppControl(); - bool result = appControl.ExtraData.IsCollection("myKey"); - - - - - - Data of the AppControl. - - - - - Subject. - - - - - Recipients. - - - - - E-mail addresses that should be carbon copied. - - - - - E-mail addresses that should be blind carbon copied. - - - - - Text. - - - - - Title. - - - - - Selected items. - - - - - Paths of items. - - - - - Selection mode ("single" or "multiple"). - - - - - All-day mode of the event ("true" or "false"). - - - - - Start time of the event (format: YYYY-MM-DD HH:MM:SS). - - - - - End time of the event (format: YYYY-MM-DD HH:MM:SS). - - - - - E-mail addressed. - - - - - Phone numbers. - - - - - URLs. - - - - - IDs. - - - - - Type. - - - - - Total count. - - - - - Total size (unit : bytes). - - - - - Name. - - - - - Location. - - - - - Select the type of input method. - - - - - Send the pre inputted text, such as "http://" in web. - - - - - Send guide text to show to the user, such as "Input user name". - - - - - Send text to receive answer result from smart reply. - - - - - Enumeration for the application control launch mode. - - - - - Prefer to launch an application as a single mode. - - - - - Prefer to launch an application as a group mode. - - - - - Operations of the AppControl. - - - - - An explicit launch for a homescreen application. - - - - - An explicit launch for an application that excludes a homescreen application. - - - - - Provides an editable access to the given data. - - - - - Displays the data. - - - - - Picks items. - - - - - Creates contents. - - - - - Performs a call to someone. - - - - - Delivers some data to someone else. - - - - - Delivers text data to someone else. - - - - - Shares an item with someone else. - - - - - Shares multiple items with someone else. - - - - - Shares text data with someone else. - - - - - Dials a number. This shows an UI with the number to be dialed, allowing the user to explicitly initiate the call. - - - - - Performs a search. - - - - - Downloads items. - - - - - Prints contents. - - - - - Composes a message. - - - - - Can be launched by interested System-Event. - - - - - Adds an item. - - - - - Captures images by camera applications. - - - - - Captures videos by camera applications. - - - - - Shows system settings. - - - - - Shows settings to enable Bluetooth. - - - - - Shows settings to configure the Bluetooth visibility. - - - - - Shows settings to allow configuration of current location sources. - - - - - Shows NFC settings. - - - - - Shows settings to allow configuration of Wi-Fi. - - - - - Arguments for the event that raised when the application receives the AppControl. - - - - - Initializes the AppControlReceivedEventArgs class. - - - - - - The received AppControl. - - - - - Reply callback for the launch request - - The AppControl of the launch request that has been sent - The AppControl in which the results of the callee are contained - The result of the launch request - - - - Enumeration for the application control result. - - - - - The callee application launched actually. - - - - - The operation succeeded. - - - - - The operation failed by the callee. - - - - - The operation canceled by the platform. - - - - - The class that represents a Tizen application. - - - - - Gets the instance of the current application. - - - - - Gets the class representing directory information of the current application. - - - - - Gets the class representing information of the current application. - - - - - Runs the application's main loop. - - Arguments from commandline. - - - - Exits the main loop of the application. - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Finalizer of the application class. - - - - - Releases all resources used by the application class. - - - - - Arguments for the event raised when the application is disabled. - - - - - The ID of the application. - - - - - The event state of the application. - - - - - Arguments for the event raised when the application is enabled. - - - - - The ID of the application. - - - - - The event state of the application. - - - - - Enumeration for the application event state. - - - - - Processing started. - - - - - Processing completed. - - - - - Processing failed. - - - - - This class provides methods and properties to get information of the application. - - - - - A constructor of ApplicationInfo that takes the application ID. - - Application ID. - - - - Destructor of the class. - - - - - Gets the application ID. - - - - - Gets the package ID of the application. - - - - - Gets the label of the application. - - - - - Gets the executable path of the application. - - - - - Gets the absolute path to the icon image. - - - - - Gets the application type name. - - - - - Gets the application's metadata. - - - - - Checks whether the application information is nodisplay. If the application icon is not displayed on the menu screen, true; otherwise, false. - - - - - Checks whether the application is launched on booting time. If the application automatically starts on boot, true; otherwise, false. - - - - - Checks whether the application is preloaded. If the application is preloaded, true; otherwise, false. - - - - - Gets the shared data path. - - - - - Gets the shared resource path. - - - - - Gets the shared trust path. - - - - - Gets the external shared data path. - - - - - Gets the localized label of the application for the given locale. - - Locale. - - - - Releases all resources used by the ApplicationInfo class. - - - - - This class is a parameter of the GetInstalledApplicationsAsync method. - - - - - - - - - - This class is a possible key to use in the InstalledApplicationFilter. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This class is a parameter of the GetInstalledApplicationsAsync method. - - - - - Arguments for the event raised when the application is launched. - - - - - The information of the application. - - - - - This class has the methods and events of the ApplicationManager. - - - - - Occurs whenever the installed application is enabled. - - - - - Occurs whenever the installed application is disabled. - - - - - Occurs whenever the installed applications get launched. - - - - - Occurs whenever the installed applications get terminated. - - - - - Gets the information of the installed applications asynchronously. - - - - - Gets the information of the installed applications with the ApplicationInfoFilter asynchronously. - - Key-value pairs for filtering. - - - - Gets the information of the installed applications with the ApplicationInfoMetadataFilter asynchronously. - - Key-value pairs for filtering. - - - - Gets the information of the running applications asynchronously. - - - - - Gets the information of the running applications including subapp asynchronously. - - - - - Gets the information of the specified application with the application ID. - - Application ID. - - - - Returns if the specified application is running or not. - - The application ID. - Returns true if the given application is running, otherwise false. - Thrown when the given parameter is invalid. - - - - Gets the information of the recent applications. - - Returns a dictionary containing all the recent application info. - Thrown when failed because of an invalid operation. - - - - This class provides methods and properties to get information of the application. - - - - - A constructor of ApplicationRunningContext that takes the application ID. - - Application ID. - Thrown when failed because of an invalid argument. - Thrown when failed because of the "application not exist" error or the system error. - Thrown when failed because of out of memory. - - - - A constructor of ApplicationRunningContext that takes the application id. - - application id. - instance id. - Thrown when failed of invalid argument. - Thrown when failed because of application not exist error or system error. - Thrown when failed because of out of memory. - - - - Destructor of the class. - - - - - Enumeration for the application state. - - - - - The undefined state. - - - - - The UI application is running in the foreground. - - - - - The UI application is running in the background. - - - - - The service application is running. - - - - - The application is terminated. - - - - - Gets the application ID. - - - - - Gets the package ID of the application. - - - - - Gets the application's process ID. - - - - - Gets the state of the application. - - - - - Gets whether the application is sub application of the application group. - - - - - Terminates the application. - - Thrown when failed of invalid argument. - Thrown when failed because of permission denied. - Thrown when failed because of system error. - http://tizen.org/privilege/appmanager.kill - - - - Resumes the running application. - - Thrown when failed of invalid argument. - Thrown when failed because of permission denied. - Thrown when failed because of system error. - http://tizen.org/privilege/appmanager.launch - - - - Releases all resources used by the ApplicationRunningContext class. - - - - - Arguments for the event raised when the application is terminated. - - - - - The information of the application. - - - - - Enumeration for the applications type. - - - - - All applications. - - - - - UI applications. - - - - - Service applications. - - - - - A bundle object represents a bundle. - A bundle holds items (key-value pairs) and can be used with other Tizen APIs. - Keys can be used to access values. - This class is accessed by using a constructor to create a new instance of this object. - A bundle instance is not guaranteed to be thread safe if the instance is modified by multiple threads. - - - - - The bundle constructor. - - Thrown when out of memory. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - - - - - The bundle constructor. - - The SafeBundleHandle instance. - Thrown when the handle is null or invalid. - - - - The number of items in a bundle object. - - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - bundle.AddItem("string", "a_string"); - Console.WriteLine("There are {0} items in the bundle", bundle.Count); - - - - - The keys in a bundle object. - - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - bundle.AddItem("string1", "a_string1"); - bundle.AddItem("string2", "a_string2"); - bundle.AddItem("string3", "a_string3"); - Console.WriteLine("The bundle contains the following keys:"); - foreach(string key in bundle.Keys) - { - Console.WriteLine(key); - } - - - - - Gets the SafeBundleHandle instance. - - - - - Releases any unmanaged resources used by this object. - - - - - - Adds an item into the bundle. - - The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. - The value of the item. - Thrown when the key already exists or when there is an invalid parameter. - Thrown when a value is null. - Thrown when out of memory or when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; - bundle.AddItem("byte_array", byteArray); - - - - - Adds an item into the bundle. - - The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. - The value of the item. - The zero-based byte offset in value from which to add to the bundle. - The maximum number of bytes to add to the bundle starting with offset. - Thrown when the offset or count is out of range. - Thrown when the key already exists or when there is an invalid parameter. - Thrown when a value is null. - Thrown when out of memory or when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; - bundle.AddItem("byte_array", byteArray, 2, 3); - - - - - Adds an item into the bundle. - - The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. - The value of the item. - Thrown when the key already exists or when there is an invalid parameter. - Thrown when out of memory or when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - bundle.AddItem("string", "a_string"); - - - - - Adds an item into the bundle. - - The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. - The value of the item. - Thrown when the key already exists or when there is an invalid parameter. - Thrown when out of memory or when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - string[] stringArray = { "a", "b", "c" }; - bundle.AddItem("string_array", stringArray); - - - - - - - Gets the value of a bundle item with a specified key. - - The key of the bundle item whose value is desired. - The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type. - true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise. - Thrown when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; - bundle.AddItem("byte_array", byteArray); - byte[] aByteArray; - if (bundle.TryGetItem("byte_array", out aByteArray)) - { - Console.WriteLine("First item in the byte array: {0}", aByteArray[0]); - } - - - - - Gets the value of a bundle item with a specified key. - - The key of the bundle item whose value is desired. - The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type. - true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise. - Thrown when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - bundle.AddItem("string", "a_string"); - string aString; - if (bundle.TryGetItem("string", out aString)) - { - Console.WriteLine(aString); - } - - - - - - - Removes a bundle item with a specific key from a Bundle. - - The key of the item to delete. - true if the item is successfully found and removed, false otherwise (even if the item is not found). - Thrown when there is an invalid parameter. - Thrown when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - bundle.AddItem("string", "a_string"); - if (bundle.Contains("string")) - { - if (bundle.RemoveItem("string")) - { - Console.WriteLine("Removed"); - } - } - - - - - Decodes an encoded bundle data. - - The encoded bundle data. bundleRaw should be the returned value of Tizen.Applications.Bundle.Encode, otherwise this method will not succeed. - Decoded Bundle object. - Thrown when there is an invalid parameter. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - string bundleRaw = bundle.Encode(); - Bundle data = bundle.Decode(bundleRaw); - - - - - Encodes bundle to string. - - Encoded bundle data in string. - Thrown when out of memory or when the bundle instance has been disposed. - - Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); - string bundleRaw = bundle.Encode(); - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Destructor of the bundle class. - - - - - This class represents an application controlled lifecycles by the backend system. - - - - - Initializes the CoreApplication class. - - The backend instance implementing ICoreBacked interface. - - - - Occurs when the application is launched. - - - - - Occurs when the application is about to shutdown. - - - - - Occurs whenever the application receives the appcontrol message. - - - - - Occurs when the system memory is low. - - - - - Occurs when the system battery is low. - - - - - Occurs when the system language is chagned. - - - - - Occurs when the region format is changed. - - - - - Occurs when the device orientation is changed. - - - - - The backend instance. - - - - - Runs the application's main loop. - - Arguments from commandline. - - - - Exits the main loop of the application. - - - - - Overrides this method if want to handle behavior when the application is launched. - If base.OnCreated() is not called, the event 'Created' will not be emitted. - - - - - Overrides this method if want to handle behavior when the application is terminated. - If base.OnTerminate() is not called, the event 'Terminated' will not be emitted. - - - - - Overrides this method if want to handle behavior when the application receives the appcontrol message. - If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be emitted. - - - - - - Overrides this method if want to handle behavior when the system memory is low. - If base.OnLowMemory() is not called, the event 'LowMemory' will not be emitted. - - - - - Overrides this method if want to handle behavior when the system battery is low. - If base.OnLowBattery() is not called, the event 'LowBattery' will not be emitted. - - - - - Overrides this method if want to handle behavior when the system language is changed. - If base.OnLocaleChanged() is not called, the event 'LocaleChanged' will not be emitted. - - - - - Overrides this method if want to handle behavior when the region format is changed. - If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. - - - - - Overrides this method if want to handle behavior when the device orientation is changed. - If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Enumeration for the device orientation. - - - - - The device orientation is 0. - - - - - The device orientation is 90. - - - - - The device orientation is 180. - - - - - The device orientation is 270. - - - - - The class for event arguments of the DeviceOrientationChanged. - - - - - Initializes the DeviceOrientationEventArgs class. - - The information of the DeviceOrientation - - - - The received DeviceOrientation. - - - - - Represents directory information of the application. - - - - - Gets the absolute path to the application's data directory, which is used to store private data of the application. - - - - - Gets the absolute path to the application's cache directory, which is used to store temporary data of the application. - - - - - Gets the absolute path to the application resource directory. The resource files are delivered with the application package. - - - - - Gets the absolute path to the application's shared data directory, which is used to share data with other applications. - - - - - Gets the absolute path to the application's shared resource directory, which is used to share resources with other applications. - - - - - Gets the absolute path to the application's shared trusted directory, which is used to share data with a family of trusted applications. - - - - - Gets the absolute path to the application's external data directory, which is used to store data of the application. - - - - - Gets the absolute path to the application's external cache directory, which is used to store temporary data of the application. - - - - - Gets the absolute path to the application's external shared data directory, which is used to share data with other applications. - - - - - Gets the absolute path to the application's TEP(Tizen Expansion Package) directory. The resource files are delivered with the expansion package. - - - - - The class for the argument of the LocaleChanged EventHandler - - - - - Initializes LocaleChangedEventArgs class - - The information of the Locale - - - - The property to get the intformation of the Locale - - - - - The class for the argument of the LowBattery EventHandler - - - - - Initializes LowBatteryEventArgs class - - The information of the LowBatteryEventArgs - - - - The property to get the intformation of the LowBatteryStatus - - - - - Enumeration for the low battery status. - - - - - - - - - - The battery status is under 1%. - - - - - The battery status is under 5%. - - - - - The class for the argument of the LowMemory EventHandler - - - - - Initializes LowMemoryEventArgs class - - The information of the LowMemoryStatus - - - - The property to get the intformation of the LowMemoryStatus - - - - - Enumeration for the low memory status. - - - - - Not initialized status. - - - - - Normal status. - - - - - Soft warning status. - - - - - Hard warning status. - - - - - Represents the received AppControl. - - - - public class ReceivedAppControlExample : UIApplication - { - // ... - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - ReceivedAppControl control = e.ReceivedAppControl; - if (control.Operation == AppControlOperations.Pick) - { - Log.Debug(LogTag, "Received AppControl is Pick"); - } - if (control.IsReplyRequest) - { - AppControl replyRequest = new AppControl(); - replyRequest.ExtraData.Add("myKey", "I'm replying"); - control.ReplyToLaunchRequest(replyRequest, AppControlReplyResult.Succeeded); - } - } - } - - - - - - Initializes a ReceivedAppControl class. - - - - - Gets the application ID of the caller from the launch request. - - - The application ID of the caller. - - - - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - ReceivedAppControl control = e.ReceivedAppControl; - string caller = control.CallerApplicationId; - } - - - - - - Checks whether the caller is requesting a reply from the launch request. - - - If true, this ReceivedAppControl is requested by the caller, otherwise false - - - - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - ReceivedAppControl control = e.ReceivedAppControl; - bool isReply = control.IsReplyRequest; - } - - - - - - Replies to the launch request sent by the caller. - If the caller application sends the launch request to receive the result, the callee application can return the result back to the caller. - - The AppControl in which the results of the callee are contained. - The result code of the launch request. - - - protected override void OnAppControlReceived(AppControlReceivedEventArgs e) - { - ReceivedAppControl control = e.ReceivedAppControl; - if (control.IsReplyRequest) - { - AppControl replyRequest = new AppControl(); - replyRequest.ExtraData.Add("myKey", "I'm replying"); - control.ReplyToLaunchRequest(replyRequest, AppControlReplyResult.Succeeded); - } - } - - - - - - This class provides methods and properties to get information of the recent application. - - - - - Deletes the application from the recent application list. - - platform - - - - Deletes all recent applications from the recent application list. - - platform - - - - This class provides methods and properties to get information of the recent application. - - - - - Gets the instance ID. - - - - - Gets the instance name. - - - - - Gets the arguements. - - - - - Gets the URI. - - - - - Gets the launchTime. - - - - - Gets the recent application controller. - - - - - The class for the argument of the RegionFormatChanged EventHandler - - - - - Initializes RegionFormatChangedEventArgs class - - The information of the Region - - - - The property to get the intformation of the Region - - - - - The class for getting the resource path. - - - - - Enumeration for the resource category. - - - - - Image format. - - - - - Layout format. - - - - - Sound format. - - - - - Binary format. - - - - - Converts resource ID to the path name. - - Category to search. - ID to search. - Found resource path. - Thrown in case of failed conditions. - - - - Converts resource ID to the path name. - - Category to search. - ID to search. - Found resource path or null when the resource doesn't exist. - Thrown in case of failed conditions. - - - - Represents a wrapper class for an unmanaged AppControl handle. - - - - - Initializes a new instance of the SafeAppControlHandle class. - - - - - Initializes a new instance of the SafeAppControlHandle class. - - An IntPtr object that represents the pre-existing handle to use. - true to reliably release the handle during the finalization phase; false to prevent reliable release. - - - - Gets a value that indicates whether the handle is invalid. - - - - - When overridden in a derived class, executes the code required to free the handle. - - true if the handle is released successfully. - - - - Represents a wrapper class for an unmanaged bundle handle. - - - - - Initializes a new instance of the SafeBundleHandle class. - - - - - Initializes a new instance of the SafeBundleHandle class. - - An IntPtr object that represents the pre-existing handle to use. - true to reliably release the handle during the finalization phase; false to prevent reliable release. - - - - Gets a value that indicates whether the handle is invalid. - - - - - When overridden in a derived class, executes the code required to free the handle. - - true if the handle is released successfully. - - - - Provides a synchronization context for the Tizen application model. - - - - - Initializes a new instance of the TizenSynchronizationContext class. - - - - - Initilizes a new TizenSynchronizationContext and install into the current thread. - - - It is equivalent. - - SetSynchronizationContext(new TizenSynchronizationContext()); - - - - - - Dispatches an asynchronous message to a Tizen main loop. - - The SendOrPostCallback delegate to call. - The object passed to the delegate. - - The post method starts an asynchronous request to post a message. - - - - Dispatches a synchronous message to a Tizen main loop. - - The SendOrPostCallback delegate to call. - The object passed to the delegate. - - The send method starts a synchronous request to send a message. - - - + + + + Tizen.Applications.Common + + + + + An abstract class to provide default event handlers for apps. + + + + + Low level event types. + + + + + This class represents the type of event for backends. This class can be converted from the string type. + + + + + Pre-defined event type "PreCreated". + + + + + Pre-defined event type "Created". + + + + + Pre-defined event type "Terminated". + + + + + Pre-defined event type "AppControlReceived". + + + + + Pre-defined event type "Resumed". + + + + + Pre-defined event type "Paused". + + + + + Pre-defined event type "LowMemory". + + + + + Pre-defined event type "LowBattery". + + + + + Pre-defined event type "LocaleChanged". + + + + + Pre-defined event type "RegionFormatChanged". + + + + + Pre-defined event type "DeviceOrientationChanged". + + + + + Initializes the EventType class. + + The name of event type. + + + + Returns the name of event type. + + + + + Returns the hash code for event type string. + + + + + Determines whether this instance and a specified object. + + + + + Converts a string to EventType instance. + + + + + An interface that represents the backend lifecycles. + + + + + Adds an event handler. + + The type of event. + The handler method without arguments. + + + + Adds an event handler. + + The EventArgs type used in arguments of the handler method. + The type of event. + The handler method with a TEventArgs type argument. + + + + Runs the mainloop of the backend. + + + + + + Exits the mainloop of the backend. + + + + + Represents the control message to exchange between applications. + + + + public class AppControlExample : UIApplication + { + /// ... + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + AppControl appControl = new AppControl(); + appControl.ApplicationId = "org.tizen.calculator"; + AppControl.SendLaunchRequest(appControl, (launchRequest, replyRequest, result) => { + // ... + }); + } + } + + + + + + Initializes the instance of the AppControl class. + + Thrown when failed to create the AppControl handle. + + + + Initializes the instance of the AppControl class with a parameter. + + The flag value to receive an additional launch result event on the launch request. + Thrown when failed to create the AppControl handle. + + + + Initializes the instance of the AppControl class with the SafeAppControlHandle. + + + + + + Gets the SafeAppControlHandle instance. + + + + + Gets and sets the operation to be performed. + + + The operation is the mandatory information for the launch request. If the operation is not specified, + AppControlOperations.Default is used for the launch request. If the operation is AppControlOperations.Default, + the package information is mandatory to explicitly launch the application. + (if the operation is null for setter, it clears the previous value.) + + + + AppControl appControl = new AppControl(); + appControl.Operation = AppControlOperations.Default; + Log.Debug(LogTag, "Operation: " + appControl.Operation); + + + + + + Gets and sets the explicit MIME type of the data. + + + (if the mime is null for setter, it clears the previous value.) + + + + AppControl appControl = new AppControl(); + appControl.Mime = "image/jpg"; + Log.Debug(LogTag, "Mime: " + appControl.Mime); + + + + + + Gets and sets the URI of the data. + + + Since Tizen 2.4, if the parameter 'uri' is started with 'file://' and + it is a regular file in this application's data path, which can be obtained + by property DataPath in ApplicationInfo class, + it will be shared to the callee application. + Framework will grant a temporary permission to the callee application for this file and + revoke it when the callee application is terminated. + The callee application can just read it. + (if the uri is null for setter, it clears the previous value.) + + + + public class AppControlExample : UIApplication + { + ... + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + ... + AppControl appControl = new AppControl(); + appContrl.Uri = this.ApplicationInfo.DataPath + "image.jpg"; + Log.Debug(LogTag, "Set Uri: " + appControl.Uri); + } + } + + + + + + Gets and sets the explicit category. + + + (if the category is null for setter, it clears the previous value.) + + + + + Gets and sets the application ID to explicitly launch. + + + (if the application ID is null for setter, it clears the previous value.) + + + + AppControl appControl = new AppControl(); + appControl.ApplicationId = "org.tizen.calculator"; + Log.Debug(LogTag, "ApplicationId: " + appControl.ApplicationId); + + + + + + Gets and sets the launch mode of the application. + + + Although, LaunchMode were set as AppControlLaunchMode.Group, the + callee application would be launched as a single mode + if the manifest file of callee application defined the launch mode as "single". + This property can just set the preference of the caller application to launch an application. + Sub-applications, which were launched as a group mode always have own process. + Since Tizen 3.0, if launch mode is not set in the caller application control, + this property returns the AppControlLaunchMode.Single launch mode. + + + + AppControl appControl = new AppControl(); + appControl.LaunchMode = AppControlLaunchMode.Group; + + + + + + Gets the collection of the extra data. + + + Extra data for communication between AppControls. + + + + AppControl appControl = new AppControl(); + appControl.ExtraData.Add("key", "value"); + ... + + + + + + + Sends the launch request. + + + The operation is mandatory information for the launch request. + If the operation is not specified, AppControlOperations.Default is used by default. + If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n + Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. + Also, implicit launch requests are NOT delivered to service applications since 2.4. + To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. + + The AppControl. + Thrown when failed because of a null argument. + Thrown when failed because of an invalid operation. + Thrown when failed because of timeout. + http://tizen.org/privilege/appmanager.launch + + + AppControl appControl = new AppControl(); + appControl.ApplicationId = "org.tizen.calculator"; + AppControl.SendLaunchRequest(appControl); + + + + + + Sends the launch request. + + + The operation is mandatory information for the launch request. + If the operation is not specified, AppControlOperations.Default is used by default. + If the operation is AppControlOperations.Default, the application ID is mandatory to explicitly launch the application. \n + Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. + Also, implicit launch requests are NOT delivered to service applications since 2.4. + To launch a service application, an explicit launch request with the application ID given by property ApplicationId MUST be sent. + + The AppControl. + The callback function to be called when the reply is delivered. + Thrown when failed because of the argument is invalid. + Thrown when failed because of an invalid operation. + Thrown when failed because of timeout. + http://tizen.org/privilege/appmanager.launch + + + AppControl appControl = new AppControl(); + appControl.ApplicationId = "org.tizen.calculator"; + AppControl.SendLaunchRequest(appControl, (launchRequest, replyRequest, result) => { + // ... + }); + + + + + + Sends the terminate request to the application that is launched by AppControl. + + + You are not allowed to terminate other general applications using this API. + This API can be used to terminate sub-applications, which were launched as a group mode by the caller application. + Once the callee application is being terminated by this API, + other applications, which were launched by the callee application as a group mode will be terminated as well. + + The AppControl. + Thrown when failed because of the argument is invalid. + Thrown when failed because of an invalid operation. + Thrown when failed because of timeout. + + + AppControl terminateRequest = new AppControl(); + terminateRequest.ApplicationId = "org.tizen.calculator"; + AppControl.SendTerminateRequest(terminateRequest); + + + + + + Class for extra data. + + + + + Adds extra data. + + + The function replaces any existing value for the given key. + + The name of the extra data. + The value associated with the given key. + Thrown when a key or a value is a zero-length string. + Thrown when the application tries to use the same key with the system-defined key. + + + AppControl appControl = new AppControl(); + appControl.ExtraData.Add("myKey", "myValue"); + + + + + + Adds extra data. + + + The function replaces any existing value for the given key. + + The name of the extra data. + The value associated with the given key. + Thrown when key or value is a zero-length string. + Thrown when the application tries to use the same key with the system-defined key. + + + AppControl appControl = new AppControl(); + string[] myValues = new string[] { "first", "second", "third" }; + appControl.ExtraData.Add("myKey", myValues); + + + + + + + Gets the extra data. + + The name of extra data. + The value associated with the given key. + Thrown when the key is an invalid parameter. + Thrown when the key is not found. + Thrown when the key is rejected. + + + AppControl appControl = new AppControl(); + string myValue = appControl.ExtraData.Get("myKey") as string; + if (myValue != null) + { + // ... + } + + + + + + + Tries getting the extra data. + + The name of extra data. + The value associated with the given key. + The result whether getting the value is done. + Thrown when the key is an invalid parameter. + Thrown when the key is not found. + Thrown when the key is rejected. + + + AppControl appControl = new AppControl(); + string myValue = string.Empty; + bool result = appControl.ExtraData.TryGet("myKey", out myValue); + if (result != null) + { + // ... + } + + + + + + + Removes the extra data. + + The name of the extra data. + Thrown when the key is a zero-length string. + Thrown when the key is not found. + Thrown when the key is rejected. + + + AppControl appControl = new AppControl(); + appControl.ExtraData.Remove("myKey"); + + + + + + Counts keys in the extra data. + + The number of counting keys. + Thrown when the key is an invalid parameter. + + + AppControl appControl = new AppControl(); + int numberOfKeys = appControl.ExtraData.Count(); + + + + + + Checks whether the extra data associated with the given key is of the collection data type. + + The name of the extra data. + If true, the extra data is of the array data type, otherwise false. + Thrown when the key is a zero-length string. + Thrown when failed to check the key. + + + AppControl appControl = new AppControl(); + bool result = appControl.ExtraData.IsCollection("myKey"); + + + + + + Data of the AppControl. + + + + + Subject. + + + + + Recipients. + + + + + E-mail addresses that should be carbon copied. + + + + + E-mail addresses that should be blind carbon copied. + + + + + Text. + + + + + Title. + + + + + Selected items. + + + + + Paths of items. + + + + + Selection mode ("single" or "multiple"). + + + + + All-day mode of the event ("true" or "false"). + + + + + Start time of the event (format: YYYY-MM-DD HH:MM:SS). + + + + + End time of the event (format: YYYY-MM-DD HH:MM:SS). + + + + + E-mail addressed. + + + + + Phone numbers. + + + + + URLs. + + + + + IDs. + + + + + Type. + + + + + Total count. + + + + + Total size (unit : bytes). + + + + + Name. + + + + + Location. + + + + + Select the type of input method. + + + + + Send the pre inputted text, such as "http://" in web. + + + + + Send guide text to show to the user, such as "Input user name". + + + + + Send text to receive answer result from smart reply. + + + + + Enumeration for the application control launch mode. + + + + + Prefer to launch an application as a single mode. + + + + + Prefer to launch an application as a group mode. + + + + + Operations of the AppControl. + + + + + An explicit launch for a homescreen application. + + + + + An explicit launch for an application that excludes a homescreen application. + + + + + Provides an editable access to the given data. + + + + + Displays the data. + + + + + Picks items. + + + + + Creates contents. + + + + + Performs a call to someone. + + + + + Delivers some data to someone else. + + + + + Delivers text data to someone else. + + + + + Shares an item with someone else. + + + + + Shares multiple items with someone else. + + + + + Shares text data with someone else. + + + + + Dials a number. This shows an UI with the number to be dialed, allowing the user to explicitly initiate the call. + + + + + Performs a search. + + + + + Downloads items. + + + + + Prints contents. + + + + + Composes a message. + + + + + Can be launched by interested System-Event. + + + + + Adds an item. + + + + + Captures images by camera applications. + + + + + Captures videos by camera applications. + + + + + Shows system settings. + + + + + Shows settings to enable Bluetooth. + + + + + Shows settings to configure the Bluetooth visibility. + + + + + Shows settings to allow configuration of current location sources. + + + + + Shows NFC settings. + + + + + Shows settings to allow configuration of Wi-Fi. + + + + + Arguments for the event that raised when the application receives the AppControl. + + + + + Initializes the AppControlReceivedEventArgs class. + + + + + + The received AppControl. + + + + + Reply callback for the launch request + + The AppControl of the launch request that has been sent + The AppControl in which the results of the callee are contained + The result of the launch request + + + + Enumeration for the application control result. + + + + + The callee application launched actually. + + + + + The operation succeeded. + + + + + The operation failed by the callee. + + + + + The operation canceled by the platform. + + + + + The class that represents a Tizen application. + + + + + Gets the instance of the current application. + + + + + Gets the class representing directory information of the current application. + + + + + Gets the class representing information of the current application. + + + + + Runs the application's main loop. + + Arguments from commandline. + + + + Exits the main loop of the application. + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Finalizer of the application class. + + + + + Releases all resources used by the application class. + + + + + Arguments for the event raised when the application is disabled. + + + + + The ID of the application. + + + + + The event state of the application. + + + + + Arguments for the event raised when the application is enabled. + + + + + The ID of the application. + + + + + The event state of the application. + + + + + Enumeration for the application event state. + + + + + Processing started. + + + + + Processing completed. + + + + + Processing failed. + + + + + This class provides methods and properties to get information of the application. + + + + + A constructor of ApplicationInfo that takes the application ID. + + Application ID. + + + + Destructor of the class. + + + + + Gets the application ID. + + + + + Gets the package ID of the application. + + + + + Gets the label of the application. + + + + + Gets the executable path of the application. + + + + + Gets the absolute path to the icon image. + + + + + Gets the application type name. + + + + + Gets the application's metadata. + + + + + Checks whether the application information is nodisplay. If the application icon is not displayed on the menu screen, true; otherwise, false. + + + + + Checks whether the application is launched on booting time. If the application automatically starts on boot, true; otherwise, false. + + + + + Checks whether the application is preloaded. If the application is preloaded, true; otherwise, false. + + + + + Gets the shared data path. + + + + + Gets the shared resource path. + + + + + Gets the shared trust path. + + + + + Gets the external shared data path. + + + + + Gets the localized label of the application for the given locale. + + Locale. + + + + Releases all resources used by the ApplicationInfo class. + + + + + This class is a parameter of the GetInstalledApplicationsAsync method. + + + + + + + + + + This class is a possible key to use in the InstalledApplicationFilter. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + This class is a parameter of the GetInstalledApplicationsAsync method. + + + + + Arguments for the event raised when the application is launched. + + + + + The information of the application. + + + + + This class has the methods and events of the ApplicationManager. + + + + + Occurs whenever the installed application is enabled. + + + + + Occurs whenever the installed application is disabled. + + + + + Occurs whenever the installed applications get launched. + + + + + Occurs whenever the installed applications get terminated. + + + + + Gets the information of the installed applications asynchronously. + + + + + Gets the information of the installed applications with the ApplicationInfoFilter asynchronously. + + Key-value pairs for filtering. + + + + Gets the information of the installed applications with the ApplicationInfoMetadataFilter asynchronously. + + Key-value pairs for filtering. + + + + Gets the information of the running applications asynchronously. + + + + + Gets the information of the running applications including subapp asynchronously. + + + + + Gets the information of the specified application with the application ID. + + Application ID. + + + + Returns if the specified application is running or not. + + The application ID. + Returns true if the given application is running, otherwise false. + Thrown when the given parameter is invalid. + + + + Gets the information of the recent applications. + + Returns a dictionary containing all the recent application info. + Thrown when failed because of an invalid operation. + + + + This class provides methods and properties to get information of the application. + + + + + A constructor of ApplicationRunningContext that takes the application ID. + + Application ID. + Thrown when failed because of an invalid argument. + Thrown when failed because of the "application not exist" error or the system error. + Thrown when failed because of out of memory. + + + + A constructor of ApplicationRunningContext that takes the application id. + + application id. + instance id. + Thrown when failed of invalid argument. + Thrown when failed because of application not exist error or system error. + Thrown when failed because of out of memory. + + + + Destructor of the class. + + + + + Enumeration for the application state. + + + + + The undefined state. + + + + + The UI application is running in the foreground. + + + + + The UI application is running in the background. + + + + + The service application is running. + + + + + The application is terminated. + + + + + Gets the application ID. + + + + + Gets the package ID of the application. + + + + + Gets the application's process ID. + + + + + Gets the state of the application. + + + + + Gets whether the application is sub application of the application group. + + + + + Terminates the application. + + Thrown when failed of invalid argument. + Thrown when failed because of permission denied. + Thrown when failed because of system error. + http://tizen.org/privilege/appmanager.kill + + + + Resumes the running application. + + Thrown when failed of invalid argument. + Thrown when failed because of permission denied. + Thrown when failed because of system error. + http://tizen.org/privilege/appmanager.launch + + + + Releases all resources used by the ApplicationRunningContext class. + + + + + Arguments for the event raised when the application is terminated. + + + + + The information of the application. + + + + + Enumeration for the applications type. + + + + + All applications. + + + + + UI applications. + + + + + Service applications. + + + + + A bundle object represents a bundle. + A bundle holds items (key-value pairs) and can be used with other Tizen APIs. + Keys can be used to access values. + This class is accessed by using a constructor to create a new instance of this object. + A bundle instance is not guaranteed to be thread safe if the instance is modified by multiple threads. + + + + + The bundle constructor. + + Thrown when out of memory. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + + + + + The bundle constructor. + + The SafeBundleHandle instance. + Thrown when the handle is null or invalid. + + + + The number of items in a bundle object. + + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + bundle.AddItem("string", "a_string"); + Console.WriteLine("There are {0} items in the bundle", bundle.Count); + + + + + The keys in a bundle object. + + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + bundle.AddItem("string1", "a_string1"); + bundle.AddItem("string2", "a_string2"); + bundle.AddItem("string3", "a_string3"); + Console.WriteLine("The bundle contains the following keys:"); + foreach(string key in bundle.Keys) + { + Console.WriteLine(key); + } + + + + + Gets the SafeBundleHandle instance. + + + + + Releases any unmanaged resources used by this object. + + + + + + Adds an item into the bundle. + + The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. + The value of the item. + Thrown when the key already exists or when there is an invalid parameter. + Thrown when a value is null. + Thrown when out of memory or when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; + bundle.AddItem("byte_array", byteArray); + + + + + Adds an item into the bundle. + + The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. + The value of the item. + The zero-based byte offset in value from which to add to the bundle. + The maximum number of bytes to add to the bundle starting with offset. + Thrown when the offset or count is out of range. + Thrown when the key already exists or when there is an invalid parameter. + Thrown when a value is null. + Thrown when out of memory or when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; + bundle.AddItem("byte_array", byteArray, 2, 3); + + + + + Adds an item into the bundle. + + The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. + The value of the item. + Thrown when the key already exists or when there is an invalid parameter. + Thrown when out of memory or when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + bundle.AddItem("string", "a_string"); + + + + + Adds an item into the bundle. + + The key to identify the item with. If an item with the key already exists in the bundle, this method will not succeed. + The value of the item. + Thrown when the key already exists or when there is an invalid parameter. + Thrown when out of memory or when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + string[] stringArray = { "a", "b", "c" }; + bundle.AddItem("string_array", stringArray); + + + + + + + Gets the value of a bundle item with a specified key. + + The key of the bundle item whose value is desired. + The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type. + true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise. + Thrown when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + byte[] byteArray = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 }; + bundle.AddItem("byte_array", byteArray); + byte[] aByteArray; + if (bundle.TryGetItem("byte_array", out aByteArray)) + { + Console.WriteLine("First item in the byte array: {0}", aByteArray[0]); + } + + + + + Gets the value of a bundle item with a specified key. + + The key of the bundle item whose value is desired. + The value of the bundle item. If the key does not exist or the type of this parameter is incorrect, it is the default value for the value parameter type. + true if an item with the key exists and if the value is the same type as the output value parameter, false otherwise. + Thrown when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + bundle.AddItem("string", "a_string"); + string aString; + if (bundle.TryGetItem("string", out aString)) + { + Console.WriteLine(aString); + } + + + + + + + Removes a bundle item with a specific key from a Bundle. + + The key of the item to delete. + true if the item is successfully found and removed, false otherwise (even if the item is not found). + Thrown when there is an invalid parameter. + Thrown when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + bundle.AddItem("string", "a_string"); + if (bundle.Contains("string")) + { + if (bundle.RemoveItem("string")) + { + Console.WriteLine("Removed"); + } + } + + + + + Decodes an encoded bundle data. + + The encoded bundle data. bundleRaw should be the returned value of Tizen.Applications.Bundle.Encode, otherwise this method will not succeed. + Decoded Bundle object. + Thrown when there is an invalid parameter. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + string bundleRaw = bundle.Encode(); + Bundle data = bundle.Decode(bundleRaw); + + + + + Encodes bundle to string. + + Encoded bundle data in string. + Thrown when out of memory or when the bundle instance has been disposed. + + Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); + string bundleRaw = bundle.Encode(); + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Destructor of the bundle class. + + + + + This class represents an application controlled lifecycles by the backend system. + + + + + Initializes the CoreApplication class. + + The backend instance implementing ICoreBacked interface. + + + + Occurs when the application is launched. + + + + + Occurs when the application is about to shutdown. + + + + + Occurs whenever the application receives the appcontrol message. + + + + + Occurs when the system memory is low. + + + + + Occurs when the system battery is low. + + + + + Occurs when the system language is chagned. + + + + + Occurs when the region format is changed. + + + + + Occurs when the device orientation is changed. + + + + + The backend instance. + + + + + Runs the application's main loop. + + Arguments from commandline. + + + + Exits the main loop of the application. + + + + + Overrides this method if want to handle behavior when the application is launched. + If base.OnCreated() is not called, the event 'Created' will not be emitted. + + + + + Overrides this method if want to handle behavior when the application is terminated. + If base.OnTerminate() is not called, the event 'Terminated' will not be emitted. + + + + + Overrides this method if want to handle behavior when the application receives the appcontrol message. + If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be emitted. + + + + + + Overrides this method if want to handle behavior when the system memory is low. + If base.OnLowMemory() is not called, the event 'LowMemory' will not be emitted. + + + + + Overrides this method if want to handle behavior when the system battery is low. + If base.OnLowBattery() is not called, the event 'LowBattery' will not be emitted. + + + + + Overrides this method if want to handle behavior when the system language is changed. + If base.OnLocaleChanged() is not called, the event 'LocaleChanged' will not be emitted. + + + + + Overrides this method if want to handle behavior when the region format is changed. + If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. + + + + + Overrides this method if want to handle behavior when the device orientation is changed. + If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Enumeration for the device orientation. + + + + + The device orientation is 0. + + + + + The device orientation is 90. + + + + + The device orientation is 180. + + + + + The device orientation is 270. + + + + + The class for event arguments of the DeviceOrientationChanged. + + + + + Initializes the DeviceOrientationEventArgs class. + + The information of the DeviceOrientation + + + + The received DeviceOrientation. + + + + + Represents directory information of the application. + + + + + Gets the absolute path to the application's data directory, which is used to store private data of the application. + + + + + Gets the absolute path to the application's cache directory, which is used to store temporary data of the application. + + + + + Gets the absolute path to the application resource directory. The resource files are delivered with the application package. + + + + + Gets the absolute path to the application's shared data directory, which is used to share data with other applications. + + + + + Gets the absolute path to the application's shared resource directory, which is used to share resources with other applications. + + + + + Gets the absolute path to the application's shared trusted directory, which is used to share data with a family of trusted applications. + + + + + Gets the absolute path to the application's external data directory, which is used to store data of the application. + + + + + Gets the absolute path to the application's external cache directory, which is used to store temporary data of the application. + + + + + Gets the absolute path to the application's external shared data directory, which is used to share data with other applications. + + + + + Gets the absolute path to the application's TEP(Tizen Expansion Package) directory. The resource files are delivered with the expansion package. + + + + + The class for the argument of the LocaleChanged EventHandler + + + + + Initializes LocaleChangedEventArgs class + + The information of the Locale + + + + The property to get the intformation of the Locale + + + + + The class for the argument of the LowBattery EventHandler + + + + + Initializes LowBatteryEventArgs class + + The information of the LowBatteryEventArgs + + + + The property to get the intformation of the LowBatteryStatus + + + + + Enumeration for the low battery status. + + + + + + + + + + The battery status is under 1%. + + + + + The battery status is under 5%. + + + + + The class for the argument of the LowMemory EventHandler + + + + + Initializes LowMemoryEventArgs class + + The information of the LowMemoryStatus + + + + The property to get the intformation of the LowMemoryStatus + + + + + Enumeration for the low memory status. + + + + + Not initialized status. + + + + + Normal status. + + + + + Soft warning status. + + + + + Hard warning status. + + + + + Represents the received AppControl. + + + + public class ReceivedAppControlExample : UIApplication + { + // ... + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + ReceivedAppControl control = e.ReceivedAppControl; + if (control.Operation == AppControlOperations.Pick) + { + Log.Debug(LogTag, "Received AppControl is Pick"); + } + if (control.IsReplyRequest) + { + AppControl replyRequest = new AppControl(); + replyRequest.ExtraData.Add("myKey", "I'm replying"); + control.ReplyToLaunchRequest(replyRequest, AppControlReplyResult.Succeeded); + } + } + } + + + + + + Initializes a ReceivedAppControl class. + + + + + Gets the application ID of the caller from the launch request. + + + The application ID of the caller. + + + + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + ReceivedAppControl control = e.ReceivedAppControl; + string caller = control.CallerApplicationId; + } + + + + + + Checks whether the caller is requesting a reply from the launch request. + + + If true, this ReceivedAppControl is requested by the caller, otherwise false + + + + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + ReceivedAppControl control = e.ReceivedAppControl; + bool isReply = control.IsReplyRequest; + } + + + + + + Replies to the launch request sent by the caller. + If the caller application sends the launch request to receive the result, the callee application can return the result back to the caller. + + The AppControl in which the results of the callee are contained. + The result code of the launch request. + + + protected override void OnAppControlReceived(AppControlReceivedEventArgs e) + { + ReceivedAppControl control = e.ReceivedAppControl; + if (control.IsReplyRequest) + { + AppControl replyRequest = new AppControl(); + replyRequest.ExtraData.Add("myKey", "I'm replying"); + control.ReplyToLaunchRequest(replyRequest, AppControlReplyResult.Succeeded); + } + } + + + + + + This class provides methods and properties to get information of the recent application. + + + + + Deletes the application from the recent application list. + + platform + + + + Deletes all recent applications from the recent application list. + + platform + + + + This class provides methods and properties to get information of the recent application. + + + + + Gets the instance ID. + + + + + Gets the instance name. + + + + + Gets the arguements. + + + + + Gets the URI. + + + + + Gets the launchTime. + + + + + Gets the recent application controller. + + + + + The class for the argument of the RegionFormatChanged EventHandler + + + + + Initializes RegionFormatChangedEventArgs class + + The information of the Region + + + + The property to get the intformation of the Region + + + + + The class for getting the resource path. + + + + + Enumeration for the resource category. + + + + + Image format. + + + + + Layout format. + + + + + Sound format. + + + + + Binary format. + + + + + Converts resource ID to the path name. + + Category to search. + ID to search. + Found resource path. + Thrown in case of failed conditions. + + + + Converts resource ID to the path name. + + Category to search. + ID to search. + Found resource path or null when the resource doesn't exist. + Thrown in case of failed conditions. + + + + Represents a wrapper class for an unmanaged AppControl handle. + + + + + Initializes a new instance of the SafeAppControlHandle class. + + + + + Initializes a new instance of the SafeAppControlHandle class. + + An IntPtr object that represents the pre-existing handle to use. + true to reliably release the handle during the finalization phase; false to prevent reliable release. + + + + Gets a value that indicates whether the handle is invalid. + + + + + When overridden in a derived class, executes the code required to free the handle. + + true if the handle is released successfully. + + + + Represents a wrapper class for an unmanaged bundle handle. + + + + + Initializes a new instance of the SafeBundleHandle class. + + + + + Initializes a new instance of the SafeBundleHandle class. + + An IntPtr object that represents the pre-existing handle to use. + true to reliably release the handle during the finalization phase; false to prevent reliable release. + + + + Gets a value that indicates whether the handle is invalid. + + + + + When overridden in a derived class, executes the code required to free the handle. + + true if the handle is released successfully. + + + + Provides a synchronization context for the Tizen application model. + + + + + Initializes a new instance of the TizenSynchronizationContext class. + + + + + Initilizes a new TizenSynchronizationContext and install into the current thread. + + + It is equivalent. + + SetSynchronizationContext(new TizenSynchronizationContext()); + + + + + + Dispatches an asynchronous message to a Tizen main loop. + + The SendOrPostCallback delegate to call. + The object passed to the delegate. + + The post method starts an asynchronous request to post a message. + + + + Dispatches a synchronous message to a Tizen main loop. + + The SendOrPostCallback delegate to call. + The object passed to the delegate. + + The send method starts a synchronous request to send a message. + + + diff --git a/Artifacts/bin/Tizen.Applications.DataControl.dll b/Artifacts/bin/Tizen.Applications.DataControl.dll index da224c7..9a4aec2 100644 Binary files a/Artifacts/bin/Tizen.Applications.DataControl.dll and b/Artifacts/bin/Tizen.Applications.DataControl.dll differ diff --git a/Artifacts/bin/Tizen.Applications.DataControl.pdb b/Artifacts/bin/Tizen.Applications.DataControl.pdb index 109f601..88182cf 100644 Binary files a/Artifacts/bin/Tizen.Applications.DataControl.pdb and b/Artifacts/bin/Tizen.Applications.DataControl.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.DataControl.xml b/Artifacts/bin/Tizen.Applications.DataControl.xml index 3b6e19c..cc4e7b3 100644 --- a/Artifacts/bin/Tizen.Applications.DataControl.xml +++ b/Artifacts/bin/Tizen.Applications.DataControl.xml @@ -1,910 +1,910 @@ - - - - Tizen.Applications.DataControl - - - - - Represents the BulkData class for the DataControl bulk request. - - - - - Initializes the BulkData class. - - Thrown in case of any internal error. - - - - Adds the bulk data. - - Bulk data - Thrown in case of an invalid parameter. - - - - Gets the current data count. - - - - - Returns the data at the given zero-based data index. - - The target data index. - Thrown in case of an invalid parameter. - - - - Releases all the resources used by the BulkData class. - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Represents the BulkResultData class for the DataControl bulk request. - - - - - Initializes the BulkResultData class. - - Thrown in case of any internal error. - - - - Adds the bulk operation result data. - - The result data. - Result. - Thrown in case of an invalid parameter. - - - - Gets the current result data count. - - - - - Returns the result data at the given zero-based data index. - - The target result data index. - Thrown in case of an invalid parameter. - - - - Returns the result at the given zero-based data index. - - The target result index. - Thrown in case of an invalid parameter. - - - - Releases all the resources used by the BulkResultData class. - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Represents the Consumer class for the DataControl consumer application. - - - - - Sends the insert request to the provider application. - - The OnInsertResult will recieve the result of this API. - The insert data. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown when the message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the select request to the provider application. - - The OnSelectResult will recieve the result of this API. - Select the target column list. - The Where statement for the select query. - The Order statement for the select query. - Select the target page number. - Select the row count per page. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied.. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the delete request to the provider application. - - The OnDeleteResult will recieve the result of this API - The Where statement for the delete query. - Thrown in case if a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the update request to the provider application. - - The OnUpdateResult will recieve result of this API. - The update data. - The Where statement for the query. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown when the message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the bulk insert request to the provider application. - - The OnBulkInsertResult will recieve the result of this API. - The bulk insert data. - Thrown in case of an invalid parmaeter. - Thrown in case oif a permission is denied. - Thrown when the message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the map add request to the provider application. - - The OnMapAddResult will recieve the result of this API. - The key of the value to add. - The value to add. - Thrown in case of an invalid parmaeter. - Thrown in case of if a permission is denied. - Thrown when the message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the map get request to the provider application. - - The OnMapGetResult will recieve the result of this API. - The key of the value list to obtain. - The page number of the value set. - The desired maximum count of the data items per page. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the map remove request to the provider application. - - The OnMapRemoveResult will recieve the result of this API. - The key of the value to remove. - The value to remove. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the map set request to the provider application. - - The OnMapSetResult will recieve the result of this API. - The key of the value to replace. - The value to be replaced. - The new value that replaces the existing value. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown when message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Sends the map bulk add request to the provider application. - - The OnMapBulkAddResult will recieve the result of this API. - The map bulk add data. - Thrown in case of an invalid parmaeter. - Thrown in case if a permission is denied. - Thrown when the message has exceeded the maximum limit (1MB). - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Listens the DataChange event. - - The OnDataChangeListenResult will recieve the result of this API. - If success, the OnDataChange will recieve the DataChange event. - Thrown in case if a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - http://tizen.org/privilege/appmanager.launch - - - - Initializes the Consumer class with the providerId and the ataId. - - The DataControl Provider ID. - The DataControl Data ID. - Thrown in case of an invalid parmaeter. - Thrown in case of any internal error. - - - - Overrides this method if you want to handle the behavior when the DataChangeListen result is received. - - - - - Overrides this method if you want to handle the behavior when the data change event is received. - - - - - Overrides this method if you want to handle the behavior when the select response is received. - - - - - Overrides this method if you want to handle the behavior when the insert response is received. - - - - - Overrides this method if you want to handle the behavior when the update response is received. - - - - - Overrides this method if want to handle the behavior when the delete response is received. - - - - - Overrides this method if you want to handle the behavior when the BulkInsert response is received. - - - - - Overrides this method if you want to handle the behavior when the map get response is received. - - - - - Overrides this method if you want to handle the behavior when the map add response is received. - - - - - Overrides this method if you want to handle the behavior when the map set response is received. - - - - - Overrides this method if you want to handle the behavior when the map remove response is received. - - - - - Overrides this method if you want to handle the behavior when the BulkAdd response is received. - - - - - Releases the unmanaged resources used by the Consumer class specifying whether to perform a normal dispose operation. - - true for a normal dispose operation; false to finalize the handle. - - - - Releases all resources used by the Consumer class. - - - - - This interface is for the DataControl cursor. - - - - - Gets a column count. - - - - - Gets a column type. - - The index of column. - - - - Gets a column name. - - The index of column. - - - - Gets the numbers of rows in the cursor. - - - - - Gets a next row. - - - - - Gets a prev row. - - - - - Gets a first row. - - - - - Gets an integer value. - - The index of row. - - - - Gets an int64 value. - - The index of row. - - - - Gets a double value. - - The index of row. - - - - Gets a string value. - - The index of row. - - - - Gets a BLOB value. - - The index of row. - - - - Represents the MatrixCursor class for the DataControl provider's matrix cursor. - - - - - Gets the column count of the MatrixCursor. - - - - - Returns the column type at the given zero-based column index. - - Target column index - Thrown in case of an invalid parameter. - - - - Returns the column name at the given zero-based column index. - - The target column index. - Thrown in case of an invalid parameter. - - - - Gets the MatrixCursor's row count. - - - - - Move the MatrixCursor to the next row. - - - - - Move the MatrixCursor to the previous row. - - - - - Move the MatrixCursor to the first row. - - - - - Returns the value of the requested column as an integer. - - Thrown in case of an invalid parameter. - - - - Returns the value of the requested column as int64. - - Thrown in case of an invalid parameter. - - - - Returns the value of the requested column as a double. - - Thrown in case of an invalid parameter. - - - - Returns the value of the requested column as a string. - - Thrown in case of an invalid parameter. - - - - Returns the value of the requested column as a BLOB. - - Thrown in case of an invalid parameter. - - - - Initializes the MatrixCursor class with columnNames and columnTypes. - - The MatrixCursor's column name list. - The MatrixCursor's column type list. - Thrown in case of an invalid parameter. - Thrown in case of any internal error. - - - - Adds a new row to the end with the given column values. - - New column values - Thrown in case of an invalid parameter. - - - - Releases all the resources used by the MatrixCursor class. - - - - - Represents the Provider class for the DataControl provider application. - - - - - Gets the data ID. - - - - - Sends a data change notification to consumer applications which have successfully added a data change listen. - - The changed data type. - Customized information about the changed data. - Thrown in case of an invalid parameter. - Thrown in case a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - - - - Initializes the Provider class with the dataID. - - The DataControl Data ID. - Thrown in case of an invalid parameter. - - - - Starts the Provider service. - - Only one Provider service can be run for each process. - Thrown in case a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/datasharing - - - - Stops the Provider service. - - - - - Overrides this method if you want to handle the behavior when the select request is received. - - - - - Overrides this method if you want to handle the behavior when the insert request is received. - - - - - Overrides this method if you want to handle the behavior when the update request is received. - - - - - Overrides this method if you want to handle the behavior when the delete request is received. - - - - - Overrides this method if you want to handle the behavior when the bulk insert request is received. - - - - - Overrides this method if you want to handle the behavior when the map get request is received. - - - - - Overrides this method if you want to handle the behavior when the map add request is received. - - - - - Overrides this method if you want to handle the behavior when the update request is received. - - - - - Overrides this method if you want to handle the behavior when the delete request is received. - - - - - Overrides this method if you want to handle the behavior when the bulk add request is received. - - - - - Overrides this method if you want to handle the behavior when the data change listen request is received. - - - - - Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation. - - true for a normal dispose operation; false to finalize the handle. - - - - Releases all the resources used by the Provider class. - - - - - This class contains the insert operation result. - - - - - Gets the insert data's row ID. - - - - - Gets the insert operation result. - - - - - Initializes the InsertResult class with columnNames and columnTypes. - - The inserted row ID. - The insert request result. - - - - This class contains the bulk insert operation result. - - - - - Gets the bulk insert operation result data. - - - - - Gets the bulk insert operation result. - - - - - Initializes the InsertResult class with the bulkResultData and the result. - - The bulk insert request result data. - The bulk insert request result. - Thrown in case of an invalid parameter. - - - - This class contains the update operation result. - - - - - Gets the update operation result. - - - - - Initializes the UpdateResult class with the result. - - The update request result. - - - - This class contains the delete operation result. - - - - - Gets the delete operation result. - - - - - Initializes the DeleteResult class with the result. - - The delete request result. - - - - This class contains the select operation result. - - - - - Gets the select operation result cursor. - - - - - Gets the select operation result. - - - - - Initializes the SelectResult class with the cursor and the result. - - The cursor with the selected data. - The select request result. - Thrown in case of an invalid parameter. - - - - This class contains the MapAdd operation result. - - - - - Gets the MapAdd operation result. - - - - - Initializes the MapAddResult class with the result. - - The MapAdd request result. - - - - This class contains the MapBulkAdd operation result. - - - - - Gets the MapBulkAdd operation result data. - - - - - Gets the MapBulkAdd operation result. - - - - - Initializes the MapBulkAddResult class with the bulkResultData and the result. - - The MapBulkAdd request result data. - The MapBulkAdd request result. - Thrown in case of an invalid parameter. - - - - This class contains the MapSet operation result. - - - - - Gets the MapSet operation result. - - - - - Initializes the MapSetResult class with the result. - - MapSet request result - - - - This class contains the MapRemove operation result. - - - - - Gets the MapRemove operation result. - - - - - Initializes the MapRemoveResult class with the result. - - The MapRemove request result. - - - - This class contains the MapGet operation result. - - - - - Gets the result value list of the MapGet operation. - - - - - Gets the MapGet operation result. - - - - - Initializes the MapGetResult class with the data and the result. - - The MapGet request result data. - The MapGet request result. - Thrown in case of an invalid parameter. - - - - This class contains the DataChangeListen operation result. - - - - - Gets the DataChangeListen operation result. - - - - - Initializes the DataChangeListenResult class with the result. - - The DataChangeListen request result. - - - - Enumeration for the DataControl column types. - - - - - Value representing DataControl operation success. - - - - - Value representing DataControl operation success. - - - - - Value representing DataControl operation success. - - - - - Value representing DataControl operation success. - - - - - Enumeration for the DataControl column types. - - - - - Value representing DataControl provider data changed by update. - - - - - Value representing DataControl provider data changed by insert. - - - - - Value representing DataControl provider data changed by delete. - - - - - Value representing DataControl provider data changed by map add. - - - - - Value representing DataControl provider data changed by map remove. - - - - - Value representing DataControl provider data changed by map set. - - - - - Enumeration for the DataControl result types. - - - - - Value representing DataControl operation success. - - - - - Value representing DataControl operation causing out of memory error. - - - - - Value representing DataControl operation causing I/O error. - - - - - Value representing DataControl operation causing invalid parameter error. - - - - - Value representing DataControl operation causing permission denied error. - - - - - Value representing DataControl operation causing max exceed error. - - - - + + + + Tizen.Applications.DataControl + + + + + Represents the BulkData class for the DataControl bulk request. + + + + + Initializes the BulkData class. + + Thrown in case of any internal error. + + + + Adds the bulk data. + + Bulk data + Thrown in case of an invalid parameter. + + + + Gets the current data count. + + + + + Returns the data at the given zero-based data index. + + The target data index. + Thrown in case of an invalid parameter. + + + + Releases all the resources used by the BulkData class. + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Represents the BulkResultData class for the DataControl bulk request. + + + + + Initializes the BulkResultData class. + + Thrown in case of any internal error. + + + + Adds the bulk operation result data. + + The result data. + Result. + Thrown in case of an invalid parameter. + + + + Gets the current result data count. + + + + + Returns the result data at the given zero-based data index. + + The target result data index. + Thrown in case of an invalid parameter. + + + + Returns the result at the given zero-based data index. + + The target result index. + Thrown in case of an invalid parameter. + + + + Releases all the resources used by the BulkResultData class. + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Represents the Consumer class for the DataControl consumer application. + + + + + Sends the insert request to the provider application. + + The OnInsertResult will recieve the result of this API. + The insert data. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown when the message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the select request to the provider application. + + The OnSelectResult will recieve the result of this API. + Select the target column list. + The Where statement for the select query. + The Order statement for the select query. + Select the target page number. + Select the row count per page. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied.. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the delete request to the provider application. + + The OnDeleteResult will recieve the result of this API + The Where statement for the delete query. + Thrown in case if a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the update request to the provider application. + + The OnUpdateResult will recieve result of this API. + The update data. + The Where statement for the query. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown when the message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the bulk insert request to the provider application. + + The OnBulkInsertResult will recieve the result of this API. + The bulk insert data. + Thrown in case of an invalid parmaeter. + Thrown in case oif a permission is denied. + Thrown when the message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the map add request to the provider application. + + The OnMapAddResult will recieve the result of this API. + The key of the value to add. + The value to add. + Thrown in case of an invalid parmaeter. + Thrown in case of if a permission is denied. + Thrown when the message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the map get request to the provider application. + + The OnMapGetResult will recieve the result of this API. + The key of the value list to obtain. + The page number of the value set. + The desired maximum count of the data items per page. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the map remove request to the provider application. + + The OnMapRemoveResult will recieve the result of this API. + The key of the value to remove. + The value to remove. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the map set request to the provider application. + + The OnMapSetResult will recieve the result of this API. + The key of the value to replace. + The value to be replaced. + The new value that replaces the existing value. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown when message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Sends the map bulk add request to the provider application. + + The OnMapBulkAddResult will recieve the result of this API. + The map bulk add data. + Thrown in case of an invalid parmaeter. + Thrown in case if a permission is denied. + Thrown when the message has exceeded the maximum limit (1MB). + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Listens the DataChange event. + + The OnDataChangeListenResult will recieve the result of this API. + If success, the OnDataChange will recieve the DataChange event. + Thrown in case if a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + http://tizen.org/privilege/appmanager.launch + + + + Initializes the Consumer class with the providerId and the ataId. + + The DataControl Provider ID. + The DataControl Data ID. + Thrown in case of an invalid parmaeter. + Thrown in case of any internal error. + + + + Overrides this method if you want to handle the behavior when the DataChangeListen result is received. + + + + + Overrides this method if you want to handle the behavior when the data change event is received. + + + + + Overrides this method if you want to handle the behavior when the select response is received. + + + + + Overrides this method if you want to handle the behavior when the insert response is received. + + + + + Overrides this method if you want to handle the behavior when the update response is received. + + + + + Overrides this method if want to handle the behavior when the delete response is received. + + + + + Overrides this method if you want to handle the behavior when the BulkInsert response is received. + + + + + Overrides this method if you want to handle the behavior when the map get response is received. + + + + + Overrides this method if you want to handle the behavior when the map add response is received. + + + + + Overrides this method if you want to handle the behavior when the map set response is received. + + + + + Overrides this method if you want to handle the behavior when the map remove response is received. + + + + + Overrides this method if you want to handle the behavior when the BulkAdd response is received. + + + + + Releases the unmanaged resources used by the Consumer class specifying whether to perform a normal dispose operation. + + true for a normal dispose operation; false to finalize the handle. + + + + Releases all resources used by the Consumer class. + + + + + This interface is for the DataControl cursor. + + + + + Gets a column count. + + + + + Gets a column type. + + The index of column. + + + + Gets a column name. + + The index of column. + + + + Gets the numbers of rows in the cursor. + + + + + Gets a next row. + + + + + Gets a prev row. + + + + + Gets a first row. + + + + + Gets an integer value. + + The index of row. + + + + Gets an int64 value. + + The index of row. + + + + Gets a double value. + + The index of row. + + + + Gets a string value. + + The index of row. + + + + Gets a BLOB value. + + The index of row. + + + + Represents the MatrixCursor class for the DataControl provider's matrix cursor. + + + + + Gets the column count of the MatrixCursor. + + + + + Returns the column type at the given zero-based column index. + + Target column index + Thrown in case of an invalid parameter. + + + + Returns the column name at the given zero-based column index. + + The target column index. + Thrown in case of an invalid parameter. + + + + Gets the MatrixCursor's row count. + + + + + Move the MatrixCursor to the next row. + + + + + Move the MatrixCursor to the previous row. + + + + + Move the MatrixCursor to the first row. + + + + + Returns the value of the requested column as an integer. + + Thrown in case of an invalid parameter. + + + + Returns the value of the requested column as int64. + + Thrown in case of an invalid parameter. + + + + Returns the value of the requested column as a double. + + Thrown in case of an invalid parameter. + + + + Returns the value of the requested column as a string. + + Thrown in case of an invalid parameter. + + + + Returns the value of the requested column as a BLOB. + + Thrown in case of an invalid parameter. + + + + Initializes the MatrixCursor class with columnNames and columnTypes. + + The MatrixCursor's column name list. + The MatrixCursor's column type list. + Thrown in case of an invalid parameter. + Thrown in case of any internal error. + + + + Adds a new row to the end with the given column values. + + New column values + Thrown in case of an invalid parameter. + + + + Releases all the resources used by the MatrixCursor class. + + + + + Represents the Provider class for the DataControl provider application. + + + + + Gets the data ID. + + + + + Sends a data change notification to consumer applications which have successfully added a data change listen. + + The changed data type. + Customized information about the changed data. + Thrown in case of an invalid parameter. + Thrown in case a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + + + + Initializes the Provider class with the dataID. + + The DataControl Data ID. + Thrown in case of an invalid parameter. + + + + Starts the Provider service. + + Only one Provider service can be run for each process. + Thrown in case a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/datasharing + + + + Stops the Provider service. + + + + + Overrides this method if you want to handle the behavior when the select request is received. + + + + + Overrides this method if you want to handle the behavior when the insert request is received. + + + + + Overrides this method if you want to handle the behavior when the update request is received. + + + + + Overrides this method if you want to handle the behavior when the delete request is received. + + + + + Overrides this method if you want to handle the behavior when the bulk insert request is received. + + + + + Overrides this method if you want to handle the behavior when the map get request is received. + + + + + Overrides this method if you want to handle the behavior when the map add request is received. + + + + + Overrides this method if you want to handle the behavior when the update request is received. + + + + + Overrides this method if you want to handle the behavior when the delete request is received. + + + + + Overrides this method if you want to handle the behavior when the bulk add request is received. + + + + + Overrides this method if you want to handle the behavior when the data change listen request is received. + + + + + Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation. + + true for a normal dispose operation; false to finalize the handle. + + + + Releases all the resources used by the Provider class. + + + + + This class contains the insert operation result. + + + + + Gets the insert data's row ID. + + + + + Gets the insert operation result. + + + + + Initializes the InsertResult class with columnNames and columnTypes. + + The inserted row ID. + The insert request result. + + + + This class contains the bulk insert operation result. + + + + + Gets the bulk insert operation result data. + + + + + Gets the bulk insert operation result. + + + + + Initializes the InsertResult class with the bulkResultData and the result. + + The bulk insert request result data. + The bulk insert request result. + Thrown in case of an invalid parameter. + + + + This class contains the update operation result. + + + + + Gets the update operation result. + + + + + Initializes the UpdateResult class with the result. + + The update request result. + + + + This class contains the delete operation result. + + + + + Gets the delete operation result. + + + + + Initializes the DeleteResult class with the result. + + The delete request result. + + + + This class contains the select operation result. + + + + + Gets the select operation result cursor. + + + + + Gets the select operation result. + + + + + Initializes the SelectResult class with the cursor and the result. + + The cursor with the selected data. + The select request result. + Thrown in case of an invalid parameter. + + + + This class contains the MapAdd operation result. + + + + + Gets the MapAdd operation result. + + + + + Initializes the MapAddResult class with the result. + + The MapAdd request result. + + + + This class contains the MapBulkAdd operation result. + + + + + Gets the MapBulkAdd operation result data. + + + + + Gets the MapBulkAdd operation result. + + + + + Initializes the MapBulkAddResult class with the bulkResultData and the result. + + The MapBulkAdd request result data. + The MapBulkAdd request result. + Thrown in case of an invalid parameter. + + + + This class contains the MapSet operation result. + + + + + Gets the MapSet operation result. + + + + + Initializes the MapSetResult class with the result. + + MapSet request result + + + + This class contains the MapRemove operation result. + + + + + Gets the MapRemove operation result. + + + + + Initializes the MapRemoveResult class with the result. + + The MapRemove request result. + + + + This class contains the MapGet operation result. + + + + + Gets the result value list of the MapGet operation. + + + + + Gets the MapGet operation result. + + + + + Initializes the MapGetResult class with the data and the result. + + The MapGet request result data. + The MapGet request result. + Thrown in case of an invalid parameter. + + + + This class contains the DataChangeListen operation result. + + + + + Gets the DataChangeListen operation result. + + + + + Initializes the DataChangeListenResult class with the result. + + The DataChangeListen request result. + + + + Enumeration for the DataControl column types. + + + + + Value representing DataControl operation success. + + + + + Value representing DataControl operation success. + + + + + Value representing DataControl operation success. + + + + + Value representing DataControl operation success. + + + + + Enumeration for the DataControl column types. + + + + + Value representing DataControl provider data changed by update. + + + + + Value representing DataControl provider data changed by insert. + + + + + Value representing DataControl provider data changed by delete. + + + + + Value representing DataControl provider data changed by map add. + + + + + Value representing DataControl provider data changed by map remove. + + + + + Value representing DataControl provider data changed by map set. + + + + + Enumeration for the DataControl result types. + + + + + Value representing DataControl operation success. + + + + + Value representing DataControl operation causing out of memory error. + + + + + Value representing DataControl operation causing I/O error. + + + + + Value representing DataControl operation causing invalid parameter error. + + + + + Value representing DataControl operation causing permission denied error. + + + + + Value representing DataControl operation causing max exceed error. + + + + diff --git a/Artifacts/bin/Tizen.Applications.MessagePort.dll b/Artifacts/bin/Tizen.Applications.MessagePort.dll index ef0c2f2..1f2de35 100644 Binary files a/Artifacts/bin/Tizen.Applications.MessagePort.dll and b/Artifacts/bin/Tizen.Applications.MessagePort.dll differ diff --git a/Artifacts/bin/Tizen.Applications.MessagePort.pdb b/Artifacts/bin/Tizen.Applications.MessagePort.pdb index 55efffb..208544d 100644 Binary files a/Artifacts/bin/Tizen.Applications.MessagePort.pdb and b/Artifacts/bin/Tizen.Applications.MessagePort.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.MessagePort.xml b/Artifacts/bin/Tizen.Applications.MessagePort.xml index b55ef18..72c48b8 100644 --- a/Artifacts/bin/Tizen.Applications.MessagePort.xml +++ b/Artifacts/bin/Tizen.Applications.MessagePort.xml @@ -1,180 +1,180 @@ - - - - Tizen.Applications.MessagePort - - - - - The message port API provides functions to send and receive messages between applications. - - - The message port API provides functions for passing messages between applications. An application should register its own local port to receive messages from remote applications. - If a remote application sends a message, the registered callback function of the local port is called. - The trusted message-port API allows communications between applications that are signed by the same developer(author) certificate. - - - - - Initializes the instance of the MessagePort class. - - The name of the local message port. - If true, it is the trusted message port of application, otherwise false. - Thrown when portName is null or empty. - - MessagePort messagePort = new MessagePort("SenderPort", true); - - - - - Destructor of the MessagePort class. - - - - - Called when a message is received. - - - MessagePort messagePort = new MessagePort("SenderPort", true); - messagePort.MessageReceived += MessageReceivedCallback; - static void MessageReceivedCallback(object sender, MessageReceivedEventArgs e) - { - Console.WriteLine("Message Received "); - if (e.Remote.AppId != null) { - Console.WriteLine("from :"+e.Remote.AppId); - } - } - - - - - The name of the local message port. - - - - - If true, the message port is a trusted port, otherwise false. - - - - - If true, the message port is listening, otherwise false. - - - - - Register the local message port. - - Thrown when portName is already used, when there is an invalid parameter, when out of memory, when there is an I/O error. - - MessagePort messagePort = new MessagePort("SenderPort", true); - messagePort.MessageReceived += MessageReceivedCallback; - messagePort.Listen(); - - - - - Unregisters the local message port. - - Thrown when messageport is already stopped, when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. - - MessagePort messagePort = new MessagePort("SenderPort", true); - messagePort.MessageReceived += MessageReceivedCallback; - messagePort.Listen(); - using (var message = new Tizen.Application.Bundle()) - { - message.AddItem("message", "a_string"); - messagePort.Send(message, "ReceiverAppID", "ReceiverPort"); - } - messageProt.StopListening(); - - - - - Sends an untrusted message to the message port of a remote application. - - The message to be passed to the remote application, the recommended message size is under 4KB. - The ID of the remote application. - The name of the remote message port. - Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. - Thrown when message has exceeded the maximum limit(4KB). - - MessagePort messagePort = new MessagePort("SenderPort", true); - messagePort.MessageReceived += MessageReceivedCallback; - messagePort.Listen(); - using (var message = new Tizen.Application.Bundle()) - { - message.AddItem("message", "a_string"); - messagePort.Send(message, "ReceiverAppID", "ReceiverPort"); - } - - - - - Sends a message to the message port of a remote application. - - The message to be passed to the remote application, the recommended message size is under 4KB. - The ID of the remote application. - The name of the remote message port. - If true, it is the trusted message port of remote application, otherwise false. - Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. - Thrown when message has exceeded the maximum limit(4KB). - - MessagePort messagePort = new MessagePort("SenderPort", true); - messagePort.MessageReceived += MessageReceivedCallback; - messagePort.Listen(); - using (var message = new Tizen.Application.Bundle()) - { - message.AddItem("message", "a_string"); - messagePort.Send(message, "ReceiverAppID", "ReceiverPort", true); - } - - - - - Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation. - - true for a normal dispose operation; false to finalize the handle. - - - - Releases all resources used by the MessagePort class. - - - - - An extended EventArgs class, which contains remote message port information and message. - - - - - Contains AppId, port name, and trusted. - - - - - The message passed from the remote application. - - - - - Contains AppId, port name, and trusted. - - - - - The ID of the remote application that sent this message. - - - - - The name of the remote message port. - - - - - If true, the remote port is a trusted port, otherwise, if false, it is not. - - - - + + + + Tizen.Applications.MessagePort + + + + + The message port API provides functions to send and receive messages between applications. + + + The message port API provides functions for passing messages between applications. An application should register its own local port to receive messages from remote applications. + If a remote application sends a message, the registered callback function of the local port is called. + The trusted message-port API allows communications between applications that are signed by the same developer(author) certificate. + + + + + Initializes the instance of the MessagePort class. + + The name of the local message port. + If true, it is the trusted message port of application, otherwise false. + Thrown when portName is null or empty. + + MessagePort messagePort = new MessagePort("SenderPort", true); + + + + + Destructor of the MessagePort class. + + + + + Called when a message is received. + + + MessagePort messagePort = new MessagePort("SenderPort", true); + messagePort.MessageReceived += MessageReceivedCallback; + static void MessageReceivedCallback(object sender, MessageReceivedEventArgs e) + { + Console.WriteLine("Message Received "); + if (e.Remote.AppId != null) { + Console.WriteLine("from :"+e.Remote.AppId); + } + } + + + + + The name of the local message port. + + + + + If true, the message port is a trusted port, otherwise false. + + + + + If true, the message port is listening, otherwise false. + + + + + Register the local message port. + + Thrown when portName is already used, when there is an invalid parameter, when out of memory, when there is an I/O error. + + MessagePort messagePort = new MessagePort("SenderPort", true); + messagePort.MessageReceived += MessageReceivedCallback; + messagePort.Listen(); + + + + + Unregisters the local message port. + + Thrown when messageport is already stopped, when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. + + MessagePort messagePort = new MessagePort("SenderPort", true); + messagePort.MessageReceived += MessageReceivedCallback; + messagePort.Listen(); + using (var message = new Tizen.Application.Bundle()) + { + message.AddItem("message", "a_string"); + messagePort.Send(message, "ReceiverAppID", "ReceiverPort"); + } + messageProt.StopListening(); + + + + + Sends an untrusted message to the message port of a remote application. + + The message to be passed to the remote application, the recommended message size is under 4KB. + The ID of the remote application. + The name of the remote message port. + Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. + Thrown when message has exceeded the maximum limit(4KB). + + MessagePort messagePort = new MessagePort("SenderPort", true); + messagePort.MessageReceived += MessageReceivedCallback; + messagePort.Listen(); + using (var message = new Tizen.Application.Bundle()) + { + message.AddItem("message", "a_string"); + messagePort.Send(message, "ReceiverAppID", "ReceiverPort"); + } + + + + + Sends a message to the message port of a remote application. + + The message to be passed to the remote application, the recommended message size is under 4KB. + The ID of the remote application. + The name of the remote message port. + If true, it is the trusted message port of remote application, otherwise false. + Thrown when there is an invalid parameter, when the port is not found, when out of memory, when there is an I/O error. + Thrown when message has exceeded the maximum limit(4KB). + + MessagePort messagePort = new MessagePort("SenderPort", true); + messagePort.MessageReceived += MessageReceivedCallback; + messagePort.Listen(); + using (var message = new Tizen.Application.Bundle()) + { + message.AddItem("message", "a_string"); + messagePort.Send(message, "ReceiverAppID", "ReceiverPort", true); + } + + + + + Releases the unmanaged resource used by the MessagePort class specifying whether to perform a normal dispose operation. + + true for a normal dispose operation; false to finalize the handle. + + + + Releases all resources used by the MessagePort class. + + + + + An extended EventArgs class, which contains remote message port information and message. + + + + + Contains AppId, port name, and trusted. + + + + + The message passed from the remote application. + + + + + Contains AppId, port name, and trusted. + + + + + The ID of the remote application that sent this message. + + + + + The name of the remote message port. + + + + + If true, the remote port is a trusted port, otherwise, if false, it is not. + + + + diff --git a/Artifacts/bin/Tizen.Applications.Notification.dll b/Artifacts/bin/Tizen.Applications.Notification.dll index 5b520ef..c771324 100644 Binary files a/Artifacts/bin/Tizen.Applications.Notification.dll and b/Artifacts/bin/Tizen.Applications.Notification.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Notification.pdb b/Artifacts/bin/Tizen.Applications.Notification.pdb index 11766e4..13f8642 100644 Binary files a/Artifacts/bin/Tizen.Applications.Notification.pdb and b/Artifacts/bin/Tizen.Applications.Notification.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Notification.xml b/Artifacts/bin/Tizen.Applications.Notification.xml index 0ad502d..23ff943 100644 --- a/Artifacts/bin/Tizen.Applications.Notification.xml +++ b/Artifacts/bin/Tizen.Applications.Notification.xml @@ -1,1148 +1,1148 @@ - - - - Tizen.Applications.Notification - - - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - The class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - This class contains common properties and methods of notifications. - - - A notification is a message that is displayed on the notification area. - It is created to notify information to the user through the application. - This class helps you to provide method and property for creating notification object. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the tag of notification. - - - - - Gets or sets the title of notification. - - - - - Gets or sets the icon of notification. - You should set an absolute path for an image file. - - - - - Gets or sets the sub icon of notification. - This SubIcon is displayed in Icon you set. - You should set an absolute path for an image file. - - - - - Gets or sets the content of notification. - - - - - Gets or sets a value indicating whether TimeStamp of the notification is Visible or not. - Default to true. - - - - - Gets or sets the TimeStamp of notification. - - - If you don't set TimeStamp, it will set the value when the notification is posted. - TimeStamp requires NotificationManager.Post() to be called. - If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification. - - - - - Gets or sets action, which is invoked when the notification is clicked. - - - If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification. - - - - - - Gets or sets count, which is displayed at the right side of the notification. - - - You must set only positive number. - If you set count to negative number, this property throws exception. - - Thrown when argument is invalid. - - - - Gets or sets property. - - - - - - Gets or sets object for display at notification. - - - - - - Gets or sets which is included vibration, LED and sound option to be applied at notification. - - - If you set it to null, the already set AccessorySet will be initialized. - - - - Notification notification = new Notification - { - Title = "Notification", - Content = "Hello Tizen", - Icon = "Icon path", - Count = 3 - }; - - Notification.AccessorySet accessory = new Notification.AccessorySet - { - SoundOption = AccessoryOption.Custom, - SoundPath = "Sound File Path", - IsVibration = true, - LedOption = AccessoryOption.Custom, - LedOnMs = 100; - LedOffMs = 50; - LedColor = Color.Lime - }; - - notification.Accessory = accessory; - - NotificationManager.Post(notification); - - - - - - Gets or sets a value indicating whether notification is displayed on the default viewer. - If you set false and add style, you can see only style notification. - - - - - Gets or sets NotificationSafeHandle. - - - - - Gets or sets private ID. - - - - - Method for adding various styles to be applied to notification. - - - The user always see about valid notification style. If you add a style which is not supported in platform, - this method has no effect. - - The style to be applied to notification. - Thrown when argument is invalid. - - - Notification notification = new Notification - { - Title = "Notification", - Content = "Hello Tizen", - Icon = "Icon path", - Count = 3 - }; - - Notification.LockStyle lockStyle = new Notification.LockStyle - { - IconPath = "Icon path", - ThumbnailPath = "Thumbnail Path" - }; - - notification.AddStyle(lockStyle); - - NotificationManager.Post(notification); - - - - - - Method to remove style you already added. - - Type of notification style to be queried. - Thrown when argument is invalid. - - - - Method to get style you already added. - - Type of notification style to be queried. - - The Notification.Style object associated with the given style. - - Thrown when argument is invalid. - - - - Method to set extra data to add extra data. - - - The type of extra data is bundle. - - The key of the extra data you want to add. - The value you want to add. - Thrown when argument is invalid. - - - Notification notification = new Notification - { - Title = "Notification", - Content = "Hello Tizen", - Icon = "Icon path", - }; - - Bundle bundle = new Bundle(); - bundle.AddItem("key", "value"); - - notification.SetExtraData("firstKey", bundle); - - - - - - Method to remove extra you already added. - - - The type of extra data is bundle. - - The key of the extra data to add. - Thrown when argument is invalid. - - - - Method to get extra data you already set. - - The key of the extra data to get. - Bundle Object that include extra data - Thrown when argument is invalid. - - - - Releases any unmanaged resources used by this object. - - - - - Class for notification AccessorySet, which includes vibration, LED, and sound option. - - - - - Gets or sets the sound option. Default to AccessoryOption.Off. - - - If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown. - - - - - Gets or sets the sound path, It will play on the sound file you set. - You should set an absolute path for a sound file. - - - - - Gets or sets a value indicating whether vibration is operated. Default is false. - - - - - Gets or sets the led option. The default value is AccessoryOption.Off. - - - If you set AccessoryOption.Custom and not set LedColor, the LED will show default color. - - - - - Gets or sets the on time so that it looks like the device's LED is blinking. - - - Default value of LedOnMillisecond is 0. - The rate is specified in terms of the number of Milliseconds to be on. - You must set the on and off times at the same time. Otherwise, it may not operate normally. - - - - - Gets or sets the off time so that it looks like the device's LED is blinking. - - - The rate is specified in terms of the number of Milliseconds to be off. - You must set the on and off times at the same time. Otherwise, it may not operate normally. - - - - - Gets or sets the LED color that you would like the LED on the device to blink. - - - If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color. - - - - - Class for generating active style notification. - - - - - Initializes a new instance of the class. - - - - - Gets or sets an absolute path for an image file to display on the background of active notification. - - - - - Gets or sets a value indicating whether the active notification is removed automatically. Default value is true. - - - IsAutoRemove option lets the active notification to be removed several seconds after it shows. - When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes - it or the application, which posted the active notification. - > - - - - Gets or sets the default button to display highlight on the active notification. - - - The default button for display highlight is only reflected on the Tizen TV. - If you use this property on other profile, this value has no effect. - - - - - Gets or sets a ReplyAction to this active notification style. - - - When you add a ReplyAction to the ActiveStyle, the notification UI will show a ReplyAction with button. - If you set null parameter, ReplyAction is not displayed. - - - - - ButtonAction button = new ButtonAction - { - Index = ButtonIndex.First, - Text = "Yes" - Action = new AppControl{ ApplicationId = "org.tizen.app" }; - }; - - ReplyAction reply = new ReplyAction - { - ParentIndex = ButtonIndex.First; - PlaceHolderText = "Please write your reply." - ReplyMax = 160, - Button = new ButtonAction - { - Text = "Yes", - ImagePath = "image path" - Action = new AppControl{ ApplicationId = "org.tizen.app" }; - }; - }; - - ActiveStyle active = new ActiveStyle - { - AutoRemove = true, - BackgroundImage = "image path", - ReplyAction = reply - }; - - active.AddButtonAction(button); - - - - - - Gets or sets Action which is invoked when notification is hidden by user. - - - If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by user. - The property is only reflected on Tizen TV. - If you use this API on other profile, this action have no effect - - - - - - Gets or sets Action which is invoked when there is no any response by user until hide timeout. - - - This action occurs when there is no response to the notification until the delete timeout set by SetRemoveTime(). - If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by timeout. - The property is only reflected on Tizen TV. - If you use this API on other profile, this action settings have no effect - - - - - - Gets or sets Action which is invoked when the notification is hidden by external factor. - - - If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by external factor. - The property is only reflected on Tizen TV. - If you use this API on other profile, this action settings have no effect - - - - - - Gets the key of ActiveStyle. - - - - - Method to set time to hide or delete notification. - - - The time settings for hiding and deleting are only reflected on the Tizen TV. - If you use this API on other profile, this time settings have no effect. - - The value in seconds when the notification can be hidden from the notification viewer after the notification is posted. - The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. - Thrown when argument is invalid. - - - - Method to get time set to hide or delete notification. - - The value in seconds when the notification can be hidden from the notification viewer after notification is posted. - The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. - - - - Method to add a button to the active notification style. - Buttons are displayed on the notification. - - - If you add button that has same index, the button is replaced to latest adding button. - If you don't set an index on ButtonAction, the index is set sequentially from zero. - - A ButtonAction for appear to the notification. - Thrown when an argument is invalid. - - - - ButtonAction button = new ButtonAction - { - Index = 0, - Text = "Yes" - Action = new AppControl{ ApplicationId = "org.tizen.app" }; - }; - - ActiveStyle active = new ActiveStyle - { - IsAutoRemove = true, - BackgroundImage = "image path", - }; - - active.AddButtonAction(button); - - - - - - - Removes the ButtonAction you already added. - - The index to remove a button. - true if the element is successfully found and removed; otherwise, false. - - - - Gets the ButtonAction of the active notification. - - The index to get a button you already added. - The ButtonAction object, which you already added. - Thrown when an argument is invalid. - - - - This class helps you to set the button on active style of notification. - - - It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button. - > - - - - Gets or sets the index of the button, which appeares as notification. - - - - - Gets or sets the text describing the button. - - - - - Gets or sets the image path that represents the button. - You should provide an absolute path for an image file. - - - - - Gets or sets the action, which is invoked when the button is clicked. - - - If you don't set action, nothing happens when the button is clicked. - - - - ButtonAction button = new ButtonAction - { - Index = ButtonIndex.First, - text = "Yes", - ImagePath = "image path", - Action = new AppControl{ ApplicationId = "org.tizen.app" }; - }; - - - - - - - Class for generating indicator style notification. - - - - - Gets or sets an absolute path for an image file. - If you set IconPath, you can see the icon on the right side of indicator. - - - - - Gets or sets a sub text for displaying indicator style. - - - - - Gets the key of IndicatorStyle. - - - - - Class for generating lock style notification. - - - - - Gets or sets an absolute path for an image file to display the icon of lock style. - - - - - Gets or sets an absolute path for a thumbnail image file to display on lock style. - - - - - Gets the key of LockStyle. - - - - - An object that helps notification to make to SafeHandle. - - - - - Class for displaying progress notification. - You must initialize progress category, current, and max value when you create an object. - - - - - Initializes a new instance of the class. - You must initialize category, current, and max value of the progress. - - The category of progress that appeared on notification. - The current value of the progress. - The max value of the progress. - Thrown when an argument is invalid. - - - - Gets or sets category of ProgressType. - - - - - - Gets or sets current value of ProgressType. - - Thrown when argument is invalid. - - - - Gets or sets max value of ProgressType. - - Thrown when argument is invalid. - - - - Class for displaying direct-reply on notification. - You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl. - - - - - Gets or sets the index of button, which appears at notification. - If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user. - If you don't set ParentIndex, it appears as notification directly. - - - - - Gets or sets the PlaceHolderText of ReplyAction which appears at notification. - If you set PlaceHolderText, it is displayed to placeholder in notification. - - - - - Gets or sets the maximum number of characters that the user can input. - You must set a ReplyMax. Otherwise user don't write text to placeholder in notification. - - - Default value is 160. - - - - - Gets or sets the button, which appears as ReplyAction in notification. - You must set the button, otherwise, a user can't send written text to application, which is set by AppControl. - - - If you set it to null, the already set ButtonAction will be removed. - - - - ReplyAction button = new ReplyAction - { - ParentIndex = ButtonIndex.Second; - PlaceHolderText = "Please write your reply." - ReplyMax = 160, - Button = new ButtonAction - { - text = "Yes", - ImagePath = "image path", - Action = new AppControl{ ApplicationId = "org.tizen.app" }; - }; - }; - - - - - - An object can apply a rich notification style to a notification object. - If the platform does not provide rich notification, styles in this class have no effect. - - - - - Enumeration for the progress category. - - - - - Value for percent type. - - - - - Value for time type. - - - - - Value for pending type, which is not the updated progress current value. - - - - - Enumeration for the accessory option. - - - - - Value for off accessory option. - - - - - Value for on accessory option. - - - - - Value for the custom accessory option. - - - - - Enumeration for the button index. - - - - - Value for the default button index. - - - - - Value for the first button index. - - - - - Value for the second button index. - - - - - Value for the third button index. - - - - - Enumeration for the notification particular property. - - - - - Value for adjust nothing. - - - - - Value for display only SIM card inserted. - - - - - Value for disable application launch when it is selected. - - - - - Value for disable auto delete when it is selected. - - - - - Value for deleted when device is rebooted even though notification is not set ongoing. - - - - - Enumeration for the block state. - - - - - Value to check if the app is allowed to post notification. - - - - - Value to check if the app is not allowed to post any notification. - - - - - Value to check if the do not disturb mode is set by the user. - - - - - NotificationManager class to post, update, delete, and get notification. - - - - - Posts a new notification. - - Notification to post. - Thrown when an argument is invalid. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - - Notification.AccessorySet accessory = new Notification.AccessorySet - { - SoundOption = AccessoryOption.On, - CanVibrate = true - }; - notification.Accessory = accessory; - - // do something - - NotificationManager.Post(notification); - - - http://tizen.org/privilege/notification - - - - Updates a posted notification. - - Notification to update. - Thrown when an argument is invalid. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - - - string tag = "first tag"; - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = tag - }; - - Notification.AccessorySet accessory = new Notification.AccessorySet - { - LedOption = AccessoryOption.On, - VibrationOption = AccessoryOption.Custom, - VibrationPath = "vibration absolute path" - } - notification.Accessory = accessory; - - NotificationManager.Post(notification); - - // do something - - Notification loadNotification = NotificationManager.Load(tag); - - loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0); - - Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress)); - thread.IsBackground = true; - thread.Start(notification); - - ... - - static void UpdateProgress(Object obj) - { - Notification notification = (Notification)obj; - - for (double current = 1.0; current <= 100.0; current = current + 1.0) - { - notification.Progress.ProgressCurrent = current; - NotificationManager.Update(notification); - Thread.Sleep(300); - } - } - - - http://tizen.org/privilege/notification - 
-             Post method should be called on the notification object.
-
- - - - Deletes a posted notification. - - Notification to remove. - Thrown when an argument is invalid. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - NotificationManager.Post(notification); - - // do something - - NotificationManager.Delete(notification); - - - http://tizen.org/privilege/notification - 
-             Post method should be called on the notification object.
-
- - - - Removes all posted notifications of calling application. - - Thrown in case of a permission is denied. - Thrown in case of any internal error. - - - Notification firstNotification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - NotificationManager.Post(firstNotification); - - Notification secondNotification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "second notification" - }; - NotificationManager.Post(secondNotification); - NotificationManager.DeleteAll(); - - - http://tizen.org/privilege/notification - - - - Searches for a posted notification which has the specified tag and has not been deleted yet. - - - Load method should be called only for notifications, which have been posted using the NotificationManager.Post method. - If two or more notifications share the same tag, the notification posted most recently is returned. - - Tag used to query. - Notification Object with specified tag. - Throwing the same exception when argument is invalid and when the tag does not exist is misleading. - Thrown in case of permission denied. - Thrown in case of any internal error. - - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - NotificationManager.Post(notification); - - // do someting - - Notification loadNotification = NotificationManager.Load("first notification"); - - - http://tizen.org/privilege/notification - - - - Saves a notification template to the notification database. - - Notification to save as template. - Template name. - Thrown when an argument is invalid. - Thrown in case of a permission is denied. - Thrown when it can't be saved as a template. - - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - - Notification.Accessory accessory = new Notification.Accessory - { - LedOption = AccessoryOption.On, - VibrationOption = AccessoryOption.Custom, - VibrationPath = "vibration absolute path" - } - notification.setAccessory(accessory); - - // do something - - NotificationManager.Post(notification); - - Notification.LockStyle style = new Notification.LockStyle - { - IconPath = "icon path", - ThumbnailPath = "Thumbnail path" - } - notification.AddStyle(style); - NotificationManager.SaveTemplate(notification, "firstTemplate"); - - - http://tizen.org/privilege/notification - - - - Loads a notification template from the notification database. - - Template name. - Notification Object with inputted template name. - Throwing the same exception when argument is invalid and when the template does not exist is misleading. - Thrown in case of permission denied. - Thrown in case of any internal error. - - - Notification notification = new Notification - { - Title = "title", - Content = "content", - Icon = "absolute icon path", - Tag = "first notification" - }; - - Notification.Accessory accessory = new Notification.Accessory - { - LedOption = AccessoryOption.On, - VibrationOption = AccessoryOption.Custom, - VibrationPath = "vibration absolute path" - } - notification.setAccessory(accessory); - - // do something - - NotificationManager.Post(notification); - - Notification.LockStyle style = new Notification.LockStyle - { - IconPath = "icon path", - ThumbnailPath = "Thumbnail path" - } - notification.AddStyle(style); - NotificationManager.SaveTemplate(notification, "firstTemplate"); - Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate"); - - - http://tizen.org/privilege/notification - - - - Gets notification block state. - - - The user can set the notification block state in settings. - The block state indicates whether or not notifications can be posted. - Additionally, only notifications to the notification panel are allowed in "Do not disturb mode". - Sound, vibrate, and active notifications are blocked. - - NotificationBlockState is a state if notification is posted. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Gets a value that indicates whether the handle is invalid. - - - - + + + + Tizen.Applications.Notification + + + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + The class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + This class contains common properties and methods of notifications. + + + A notification is a message that is displayed on the notification area. + It is created to notify information to the user through the application. + This class helps you to provide method and property for creating notification object. + + + + + Initializes a new instance of the class. + + + + + Gets or sets the tag of notification. + + + + + Gets or sets the title of notification. + + + + + Gets or sets the icon of notification. + You should set an absolute path for an image file. + + + + + Gets or sets the sub icon of notification. + This SubIcon is displayed in Icon you set. + You should set an absolute path for an image file. + + + + + Gets or sets the content of notification. + + + + + Gets or sets a value indicating whether TimeStamp of the notification is Visible or not. + Default to true. + + + + + Gets or sets the TimeStamp of notification. + + + If you don't set TimeStamp, it will set the value when the notification is posted. + TimeStamp requires NotificationManager.Post() to be called. + If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification. + + + + + Gets or sets action, which is invoked when the notification is clicked. + + + If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification. + + + + + + Gets or sets count, which is displayed at the right side of the notification. + + + You must set only positive number. + If you set count to negative number, this property throws exception. + + Thrown when argument is invalid. + + + + Gets or sets property. + + + + + + Gets or sets object for display at notification. + + + + + + Gets or sets which is included vibration, LED and sound option to be applied at notification. + + + If you set it to null, the already set AccessorySet will be initialized. + + + + Notification notification = new Notification + { + Title = "Notification", + Content = "Hello Tizen", + Icon = "Icon path", + Count = 3 + }; + + Notification.AccessorySet accessory = new Notification.AccessorySet + { + SoundOption = AccessoryOption.Custom, + SoundPath = "Sound File Path", + IsVibration = true, + LedOption = AccessoryOption.Custom, + LedOnMs = 100; + LedOffMs = 50; + LedColor = Color.Lime + }; + + notification.Accessory = accessory; + + NotificationManager.Post(notification); + + + + + + Gets or sets a value indicating whether notification is displayed on the default viewer. + If you set false and add style, you can see only style notification. + + + + + Gets or sets NotificationSafeHandle. + + + + + Gets or sets private ID. + + + + + Method for adding various styles to be applied to notification. + + + The user always see about valid notification style. If you add a style which is not supported in platform, + this method has no effect. + + The style to be applied to notification. + Thrown when argument is invalid. + + + Notification notification = new Notification + { + Title = "Notification", + Content = "Hello Tizen", + Icon = "Icon path", + Count = 3 + }; + + Notification.LockStyle lockStyle = new Notification.LockStyle + { + IconPath = "Icon path", + ThumbnailPath = "Thumbnail Path" + }; + + notification.AddStyle(lockStyle); + + NotificationManager.Post(notification); + + + + + + Method to remove style you already added. + + Type of notification style to be queried. + Thrown when argument is invalid. + + + + Method to get style you already added. + + Type of notification style to be queried. + + The Notification.Style object associated with the given style. + + Thrown when argument is invalid. + + + + Method to set extra data to add extra data. + + + The type of extra data is bundle. + + The key of the extra data you want to add. + The value you want to add. + Thrown when argument is invalid. + + + Notification notification = new Notification + { + Title = "Notification", + Content = "Hello Tizen", + Icon = "Icon path", + }; + + Bundle bundle = new Bundle(); + bundle.AddItem("key", "value"); + + notification.SetExtraData("firstKey", bundle); + + + + + + Method to remove extra you already added. + + + The type of extra data is bundle. + + The key of the extra data to add. + Thrown when argument is invalid. + + + + Method to get extra data you already set. + + The key of the extra data to get. + Bundle Object that include extra data + Thrown when argument is invalid. + + + + Releases any unmanaged resources used by this object. + + + + + Class for notification AccessorySet, which includes vibration, LED, and sound option. + + + + + Gets or sets the sound option. Default to AccessoryOption.Off. + + + If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown. + + + + + Gets or sets the sound path, It will play on the sound file you set. + You should set an absolute path for a sound file. + + + + + Gets or sets a value indicating whether vibration is operated. Default is false. + + + + + Gets or sets the led option. The default value is AccessoryOption.Off. + + + If you set AccessoryOption.Custom and not set LedColor, the LED will show default color. + + + + + Gets or sets the on time so that it looks like the device's LED is blinking. + + + Default value of LedOnMillisecond is 0. + The rate is specified in terms of the number of Milliseconds to be on. + You must set the on and off times at the same time. Otherwise, it may not operate normally. + + + + + Gets or sets the off time so that it looks like the device's LED is blinking. + + + The rate is specified in terms of the number of Milliseconds to be off. + You must set the on and off times at the same time. Otherwise, it may not operate normally. + + + + + Gets or sets the LED color that you would like the LED on the device to blink. + + + If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color. + + + + + Class for generating active style notification. + + + + + Initializes a new instance of the class. + + + + + Gets or sets an absolute path for an image file to display on the background of active notification. + + + + + Gets or sets a value indicating whether the active notification is removed automatically. Default value is true. + + + IsAutoRemove option lets the active notification to be removed several seconds after it shows. + When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes + it or the application, which posted the active notification. + > + + + + Gets or sets the default button to display highlight on the active notification. + + + The default button for display highlight is only reflected on the Tizen TV. + If you use this property on other profile, this value has no effect. + + + + + Gets or sets a ReplyAction to this active notification style. + + + When you add a ReplyAction to the ActiveStyle, the notification UI will show a ReplyAction with button. + If you set null parameter, ReplyAction is not displayed. + + + + + ButtonAction button = new ButtonAction + { + Index = ButtonIndex.First, + Text = "Yes" + Action = new AppControl{ ApplicationId = "org.tizen.app" }; + }; + + ReplyAction reply = new ReplyAction + { + ParentIndex = ButtonIndex.First; + PlaceHolderText = "Please write your reply." + ReplyMax = 160, + Button = new ButtonAction + { + Text = "Yes", + ImagePath = "image path" + Action = new AppControl{ ApplicationId = "org.tizen.app" }; + }; + }; + + ActiveStyle active = new ActiveStyle + { + AutoRemove = true, + BackgroundImage = "image path", + ReplyAction = reply + }; + + active.AddButtonAction(button); + + + + + + Gets or sets Action which is invoked when notification is hidden by user. + + + If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by user. + The property is only reflected on Tizen TV. + If you use this API on other profile, this action have no effect + + + + + + Gets or sets Action which is invoked when there is no any response by user until hide timeout. + + + This action occurs when there is no response to the notification until the delete timeout set by SetRemoveTime(). + If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by timeout. + The property is only reflected on Tizen TV. + If you use this API on other profile, this action settings have no effect + + + + + + Gets or sets Action which is invoked when the notification is hidden by external factor. + + + If you set it to null, the already set AppControl will be removed and nothing will happen when notification is hidden by external factor. + The property is only reflected on Tizen TV. + If you use this API on other profile, this action settings have no effect + + + + + + Gets the key of ActiveStyle. + + + + + Method to set time to hide or delete notification. + + + The time settings for hiding and deleting are only reflected on the Tizen TV. + If you use this API on other profile, this time settings have no effect. + + The value in seconds when the notification can be hidden from the notification viewer after the notification is posted. + The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. + Thrown when argument is invalid. + + + + Method to get time set to hide or delete notification. + + The value in seconds when the notification can be hidden from the notification viewer after notification is posted. + The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. + + + + Method to add a button to the active notification style. + Buttons are displayed on the notification. + + + If you add button that has same index, the button is replaced to latest adding button. + If you don't set an index on ButtonAction, the index is set sequentially from zero. + + A ButtonAction for appear to the notification. + Thrown when an argument is invalid. + + + + ButtonAction button = new ButtonAction + { + Index = 0, + Text = "Yes" + Action = new AppControl{ ApplicationId = "org.tizen.app" }; + }; + + ActiveStyle active = new ActiveStyle + { + IsAutoRemove = true, + BackgroundImage = "image path", + }; + + active.AddButtonAction(button); + + + + + + + Removes the ButtonAction you already added. + + The index to remove a button. + true if the element is successfully found and removed; otherwise, false. + + + + Gets the ButtonAction of the active notification. + + The index to get a button you already added. + The ButtonAction object, which you already added. + Thrown when an argument is invalid. + + + + This class helps you to set the button on active style of notification. + + + It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button. + > + + + + Gets or sets the index of the button, which appeares as notification. + + + + + Gets or sets the text describing the button. + + + + + Gets or sets the image path that represents the button. + You should provide an absolute path for an image file. + + + + + Gets or sets the action, which is invoked when the button is clicked. + + + If you don't set action, nothing happens when the button is clicked. + + + + ButtonAction button = new ButtonAction + { + Index = ButtonIndex.First, + text = "Yes", + ImagePath = "image path", + Action = new AppControl{ ApplicationId = "org.tizen.app" }; + }; + + + + + + + Class for generating indicator style notification. + + + + + Gets or sets an absolute path for an image file. + If you set IconPath, you can see the icon on the right side of indicator. + + + + + Gets or sets a sub text for displaying indicator style. + + + + + Gets the key of IndicatorStyle. + + + + + Class for generating lock style notification. + + + + + Gets or sets an absolute path for an image file to display the icon of lock style. + + + + + Gets or sets an absolute path for a thumbnail image file to display on lock style. + + + + + Gets the key of LockStyle. + + + + + An object that helps notification to make to SafeHandle. + + + + + Class for displaying progress notification. + You must initialize progress category, current, and max value when you create an object. + + + + + Initializes a new instance of the class. + You must initialize category, current, and max value of the progress. + + The category of progress that appeared on notification. + The current value of the progress. + The max value of the progress. + Thrown when an argument is invalid. + + + + Gets or sets category of ProgressType. + + + + + + Gets or sets current value of ProgressType. + + Thrown when argument is invalid. + + + + Gets or sets max value of ProgressType. + + Thrown when argument is invalid. + + + + Class for displaying direct-reply on notification. + You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl. + + + + + Gets or sets the index of button, which appears at notification. + If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user. + If you don't set ParentIndex, it appears as notification directly. + + + + + Gets or sets the PlaceHolderText of ReplyAction which appears at notification. + If you set PlaceHolderText, it is displayed to placeholder in notification. + + + + + Gets or sets the maximum number of characters that the user can input. + You must set a ReplyMax. Otherwise user don't write text to placeholder in notification. + + + Default value is 160. + + + + + Gets or sets the button, which appears as ReplyAction in notification. + You must set the button, otherwise, a user can't send written text to application, which is set by AppControl. + + + If you set it to null, the already set ButtonAction will be removed. + + + + ReplyAction button = new ReplyAction + { + ParentIndex = ButtonIndex.Second; + PlaceHolderText = "Please write your reply." + ReplyMax = 160, + Button = new ButtonAction + { + text = "Yes", + ImagePath = "image path", + Action = new AppControl{ ApplicationId = "org.tizen.app" }; + }; + }; + + + + + + An object can apply a rich notification style to a notification object. + If the platform does not provide rich notification, styles in this class have no effect. + + + + + Enumeration for the progress category. + + + + + Value for percent type. + + + + + Value for time type. + + + + + Value for pending type, which is not the updated progress current value. + + + + + Enumeration for the accessory option. + + + + + Value for off accessory option. + + + + + Value for on accessory option. + + + + + Value for the custom accessory option. + + + + + Enumeration for the button index. + + + + + Value for the default button index. + + + + + Value for the first button index. + + + + + Value for the second button index. + + + + + Value for the third button index. + + + + + Enumeration for the notification particular property. + + + + + Value for adjust nothing. + + + + + Value for display only SIM card inserted. + + + + + Value for disable application launch when it is selected. + + + + + Value for disable auto delete when it is selected. + + + + + Value for deleted when device is rebooted even though notification is not set ongoing. + + + + + Enumeration for the block state. + + + + + Value to check if the app is allowed to post notification. + + + + + Value to check if the app is not allowed to post any notification. + + + + + Value to check if the do not disturb mode is set by the user. + + + + + NotificationManager class to post, update, delete, and get notification. + + + + + Posts a new notification. + + Notification to post. + Thrown when an argument is invalid. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + + Notification.AccessorySet accessory = new Notification.AccessorySet + { + SoundOption = AccessoryOption.On, + CanVibrate = true + }; + notification.Accessory = accessory; + + // do something + + NotificationManager.Post(notification); + + + http://tizen.org/privilege/notification + + + + Updates a posted notification. + + Notification to update. + Thrown when an argument is invalid. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + + + string tag = "first tag"; + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = tag + }; + + Notification.AccessorySet accessory = new Notification.AccessorySet + { + LedOption = AccessoryOption.On, + VibrationOption = AccessoryOption.Custom, + VibrationPath = "vibration absolute path" + } + notification.Accessory = accessory; + + NotificationManager.Post(notification); + + // do something + + Notification loadNotification = NotificationManager.Load(tag); + + loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0); + + Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress)); + thread.IsBackground = true; + thread.Start(notification); + + ... + + static void UpdateProgress(Object obj) + { + Notification notification = (Notification)obj; + + for (double current = 1.0; current <= 100.0; current = current + 1.0) + { + notification.Progress.ProgressCurrent = current; + NotificationManager.Update(notification); + Thread.Sleep(300); + } + } + + + http://tizen.org/privilege/notification + 
+             Post method should be called on the notification object.
+
+ + + + Deletes a posted notification. + + Notification to remove. + Thrown when an argument is invalid. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + NotificationManager.Post(notification); + + // do something + + NotificationManager.Delete(notification); + + + http://tizen.org/privilege/notification + 
+             Post method should be called on the notification object.
+
+ + + + Removes all posted notifications of calling application. + + Thrown in case of a permission is denied. + Thrown in case of any internal error. + + + Notification firstNotification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + NotificationManager.Post(firstNotification); + + Notification secondNotification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "second notification" + }; + NotificationManager.Post(secondNotification); + NotificationManager.DeleteAll(); + + + http://tizen.org/privilege/notification + + + + Searches for a posted notification which has the specified tag and has not been deleted yet. + + + Load method should be called only for notifications, which have been posted using the NotificationManager.Post method. + If two or more notifications share the same tag, the notification posted most recently is returned. + + Tag used to query. + Notification Object with specified tag. + Throwing the same exception when argument is invalid and when the tag does not exist is misleading. + Thrown in case of permission denied. + Thrown in case of any internal error. + + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + NotificationManager.Post(notification); + + // do someting + + Notification loadNotification = NotificationManager.Load("first notification"); + + + http://tizen.org/privilege/notification + + + + Saves a notification template to the notification database. + + Notification to save as template. + Template name. + Thrown when an argument is invalid. + Thrown in case of a permission is denied. + Thrown when it can't be saved as a template. + + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + + Notification.Accessory accessory = new Notification.Accessory + { + LedOption = AccessoryOption.On, + VibrationOption = AccessoryOption.Custom, + VibrationPath = "vibration absolute path" + } + notification.setAccessory(accessory); + + // do something + + NotificationManager.Post(notification); + + Notification.LockStyle style = new Notification.LockStyle + { + IconPath = "icon path", + ThumbnailPath = "Thumbnail path" + } + notification.AddStyle(style); + NotificationManager.SaveTemplate(notification, "firstTemplate"); + + + http://tizen.org/privilege/notification + + + + Loads a notification template from the notification database. + + Template name. + Notification Object with inputted template name. + Throwing the same exception when argument is invalid and when the template does not exist is misleading. + Thrown in case of permission denied. + Thrown in case of any internal error. + + + Notification notification = new Notification + { + Title = "title", + Content = "content", + Icon = "absolute icon path", + Tag = "first notification" + }; + + Notification.Accessory accessory = new Notification.Accessory + { + LedOption = AccessoryOption.On, + VibrationOption = AccessoryOption.Custom, + VibrationPath = "vibration absolute path" + } + notification.setAccessory(accessory); + + // do something + + NotificationManager.Post(notification); + + Notification.LockStyle style = new Notification.LockStyle + { + IconPath = "icon path", + ThumbnailPath = "Thumbnail path" + } + notification.AddStyle(style); + NotificationManager.SaveTemplate(notification, "firstTemplate"); + Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate"); + + + http://tizen.org/privilege/notification + + + + Gets notification block state. + + + The user can set the notification block state in settings. + The block state indicates whether or not notifications can be posted. + Additionally, only notifications to the notification panel are allowed in "Do not disturb mode". + Sound, vibrate, and active notifications are blocked. + + NotificationBlockState is a state if notification is posted. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Gets a value that indicates whether the handle is invalid. + + + + diff --git a/Artifacts/bin/Tizen.Applications.NotificationEventListener.dll b/Artifacts/bin/Tizen.Applications.NotificationEventListener.dll index 2bf986f..b248ca7 100644 Binary files a/Artifacts/bin/Tizen.Applications.NotificationEventListener.dll and b/Artifacts/bin/Tizen.Applications.NotificationEventListener.dll differ diff --git a/Artifacts/bin/Tizen.Applications.NotificationEventListener.pdb b/Artifacts/bin/Tizen.Applications.NotificationEventListener.pdb index 5e56900..5099c48 100644 Binary files a/Artifacts/bin/Tizen.Applications.NotificationEventListener.pdb and b/Artifacts/bin/Tizen.Applications.NotificationEventListener.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.NotificationEventListener.xml b/Artifacts/bin/Tizen.Applications.NotificationEventListener.xml index 112aea6..f5ee912 100644 --- a/Artifacts/bin/Tizen.Applications.NotificationEventListener.xml +++ b/Artifacts/bin/Tizen.Applications.NotificationEventListener.xml @@ -1,895 +1,895 @@ - - - - Tizen.Applications.NotificationEventListener - - - - - This class provides the property to get information about the deleted notification. - - - - - Gets the unique number of the notification. - - - - - This class provides the methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - This class provides methods and properties to get information about the posted or updated notification. - - - - - Initializes a new instance of the class. - - - - - Gets the unique ID of the notification. - - - - - Gets the appId of the notification. - - - - - Gets the title of the notification. - - - - - Gets the content text of the notification. - - - - - Gets the icon's path of the notification. - - - - - Gets the sub icon path of the notification. - - - - - Gets the timestamp if the notification is visible or not. - - - - - Gets TimeStamp of notification. - - - If IsTimeStampVisible property is set false, this TimeStamp property is meaningless. - - - - - Gets the count, which is displayed at the right side of notification. - - - - - Gets the tag of notification. - - - - - Gets a value that determines whether notification is displayed on the default viewer. - If IsDisplay property is set as false and add style, you can see only style notification. - - - - - Gets the AppControl, which is invoked when notification is clicked. - - - - - Gets the object of the progress notification. - - - - - Gets the AccessoryArgs, which has option of sound, vibration, and LED. - - - - - Gets the key for extra data. - - - - - Gets the property. - - - - - Gets the styleArgs of active, lock, indicator, and bigpicture. - - Type of notification style to be queried. - The NotificationEventListener.StyleArgs object associated with the given style. - Thrown when an argument is invalid. - - - - Gets the ExtraDataArgs. - - The key that specifies which extra data. - Returns the bundle for key. - - - - Class to get infomation about notification accessory. - - - - - Gets the sound option. - - - - - Gets the sound path. - - - - - Gets the vibration option. - - - - - Gets the LED option. - - - - - Gets LED on time period that you would like the LED on the device to blink as well as the rate. - - - Default value of LedOnMilliseconds is 0. - The rate is specified in terms of the number of milliseconds to be on. - - - - - Gets LED on time period that you would like the LED on the device to blink as well as the rate. - - - Default value of LedOffMillisecond is 0. - The rate is specified in terms of the number of millisecond to be off. - - - - - Gets LED color that you would like the LED on the device to blink. - - - - - Class to get infomation about notification active style. - - - - - Initializes a new instance of the class. - - - - - Gets the IsAutoRemove option of the active notification. - IsAutoRemove option lets the active notification be removed several seconds after it shows. - - - When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes - the active notification, or the app which posted the active notification removes the active notification. - - - - - Gets an absolute path for an image file to display on the background of active notification. - - - - - Gets the default button to display highlight on the active notification. - - - - - Gets timeout value in seconds when the notification can be hidden from the viewer. - - - - - Gets timeout value in seconds when the notification can be deleted from the viewer. - - - - - Gets Action which is invoked when notification is hidden by user. - - - The property is only reflected on Tizen TV. - If you use this API on other profile, this action have no effect - - - - - Gets or sets Action which is invoked when there is no any response by user until hide timeout. - - - The property is only reflected on Tizen TV. - If you use this API on other profile, this action settings have no effect - - - - - Gets or sets Action which is invoked when the notification is hidden by external factor. - - - If you use this API on other profile, this action settings have no effect - - - - - Gets a button to this active notification style. - Buttons are displayed in the notification content. - - - - - Gets a ReplyAction to this active notification style. - - - - - Class to get infomation about notification ButtonAction. - - - - - Gets the index of the button, which appears at notification. - - - - - Gets the text that describes the button. - - - - - Gets the image's path that represents the button. - - - - - Gets the AppControl that is invoked when the button is clicked. - - - - - Class to generate the indicator style notification. - - - - - Gets the path of the image file to display on the icon of indicator style. - - - - - Gets the sub text to display indicator style. - - - - - Class to get infomation about notification lock style. - - - - - Gets the path of the image file to display on the icon of lock style. - - - - - Gets the path of the thumbnail image file to display on the icon of lock style. - - - - - Class to get infomation about progress notification. - - - - - Gets category of ProgressType. - - - - - Gets current value of ProgressType. - - - - - Gets max value of ProgressType. - - - - - Class to get infomation about notification ReplyAction. - - - - - Gets index of button, which appears at notification. - If there is no ParentIndex, the ReplyAction should be displayed directly on the active notification. - - - - - Gets the PlaceHolderText of ReplyAction, which appears at notification. - It will be displayed to the text input box on the active notification. - - - - - Gets a max length of text input. - - - - - Gets the button displayed in the replyaction. - - - - - Enumeration for the progress category. - - - - - Value for the percent type. - - - - - Value for the time type. - - - - - Value for the pending type, which is not the updated progress current value. - - - - - Enumeration for the accessory option. - - - - - Value for off accessory option. - - - - - Value for on accessory option. - - - - - Value for the custom accessory option. - - - - - Enumeration for the button index. - - - - - Value for the default button index. - - - - - Value for the first button index. - - - - - Value for the second button index. - - - - - Value for the third button index. - - - - - Enumeration for the notification particular property. - - - - - Value for the adjust nothing. - - - - - Value for display only when SIM card inserted. - - - - - Value for disable application launch when it is selected. - - - - - Value for disable auto delete when it is selected. - - - - - Value for deleted when device is rebooted even though notification is not set OngoingType. - - - - - Enumeration for event type on notification. - - - - - Event type : Click on button 1. - - - - - Event type : Click on button 2. - - - - - Event type : Click on button 3. - - - - - Event type : Click on text_input button. - - - - - Event type : Hidden by user. - - - - - Event type : Deleted by timer. - - - - - Event type : Deleted by timer. - - - - - Event type : Clicked by user. - - - - - Event type : Deleted by user. - - - - - Enumeration for notification type. - - - - - Notification type. - - - - - Ongoing type. - - - - - Enumeration for notification text type. - - - - - Title. - - - - - Content. - - - - - Text to display the event count. - - - - - Box contents 1. - - - - - Box contents 1-1. - - - - - Box contents 2. - - - - - Box contents 2-1. - - - - - Text on button 1. - - - - - Text on button 2. - - - - - Text on button 3. - - - - - Guide text on the message reply box. - - - - - Text on button on the message reply box. - - - - - Enumeration for the image type. - - - - - Icon. - - - - - Indicator icon. - - - - - Lock screen icon. - - - - - Thumbnail. - - - - - Lock screen thumbnail. - - - - - Icon. - - - - - Image displayed on background. - - - - - Image for button 1. - - - - - Image for button 2. - - - - - Image for button 3. - - - - - Image for message reply. - - - - - Enumeration for notification layout type. - - - - - Default. - - - - - Layout for notification. Used to inform single event. - - - - - Layout for notification. Used to display images. - - - - - Layout for ongoing notification. Used to display text message. - - - - - Layout for ongoing notification. Used to display progress. - - - - - Enumeration for notification launch option type. - - - - - Launching with application control. - - - - - Enumeration for notification operation data code. - - - - - Default. - - - - - Operation type. - - - - - Private ID. - - - - - Notification handler. - - - - - Reserved. - - - - - Reserved. - - - - - Enumeration for notification operation code. - - - - - Default. - - - - - Notification inserted. - - - - - Notification updated. - - - - - Notification deleted. - - - - - Enumeration for event type on notification. - - - - - Event type : Click on button 1. - - - - - Event type : Click on button 2. - - - - - Event type : Click on button 3. - - - - - Event type : Click on icon. - - - - - Event type : Click on thumbnail. - - - - - Event type : Click on text_input button. - - - - - Enumeration for display application list. - - - - - Notification Tray(Quickpanel). - - - - - Ticker notification. - - - - - Lock screen. - - - - - Indicator. - - - - - Active notification. - - - - - All display application except active notification. - - - - - This class provides a way to register callback function for some notification events. - - - The event listener can use this class to get a list of notifications or to clear notifications. - - - - - Event handler for notification insert event. - - Thrown in case of an invalid parameter. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Event handler for notification update event. - - Thrown in case of an invalid parameter. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Event handler for notification delete event. - - Thrown in case of an invalid parameter. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Deletes a notification with appId and uniqueNumber. - - The name of the application you want to delete. - The unique number of the notification. - Thrown in case of an invalid parameter. - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Deletes all notifications. - - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - - Returns the notification list. - - Thrown in case of a permission is denied. - Thrown in case of any internal error. - http://tizen.org/privilege/notification - - - + + + + Tizen.Applications.NotificationEventListener + + + + + This class provides the property to get information about the deleted notification. + + + + + Gets the unique number of the notification. + + + + + This class provides the methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + This class provides methods and properties to get information about the posted or updated notification. + + + + + Initializes a new instance of the class. + + + + + Gets the unique ID of the notification. + + + + + Gets the appId of the notification. + + + + + Gets the title of the notification. + + + + + Gets the content text of the notification. + + + + + Gets the icon's path of the notification. + + + + + Gets the sub icon path of the notification. + + + + + Gets the timestamp if the notification is visible or not. + + + + + Gets TimeStamp of notification. + + + If IsTimeStampVisible property is set false, this TimeStamp property is meaningless. + + + + + Gets the count, which is displayed at the right side of notification. + + + + + Gets the tag of notification. + + + + + Gets a value that determines whether notification is displayed on the default viewer. + If IsDisplay property is set as false and add style, you can see only style notification. + + + + + Gets the AppControl, which is invoked when notification is clicked. + + + + + Gets the object of the progress notification. + + + + + Gets the AccessoryArgs, which has option of sound, vibration, and LED. + + + + + Gets the key for extra data. + + + + + Gets the property. + + + + + Gets the styleArgs of active, lock, indicator, and bigpicture. + + Type of notification style to be queried. + The NotificationEventListener.StyleArgs object associated with the given style. + Thrown when an argument is invalid. + + + + Gets the ExtraDataArgs. + + The key that specifies which extra data. + Returns the bundle for key. + + + + Class to get infomation about notification accessory. + + + + + Gets the sound option. + + + + + Gets the sound path. + + + + + Gets the vibration option. + + + + + Gets the LED option. + + + + + Gets LED on time period that you would like the LED on the device to blink as well as the rate. + + + Default value of LedOnMilliseconds is 0. + The rate is specified in terms of the number of milliseconds to be on. + + + + + Gets LED on time period that you would like the LED on the device to blink as well as the rate. + + + Default value of LedOffMillisecond is 0. + The rate is specified in terms of the number of millisecond to be off. + + + + + Gets LED color that you would like the LED on the device to blink. + + + + + Class to get infomation about notification active style. + + + + + Initializes a new instance of the class. + + + + + Gets the IsAutoRemove option of the active notification. + IsAutoRemove option lets the active notification be removed several seconds after it shows. + + + When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes + the active notification, or the app which posted the active notification removes the active notification. + + + + + Gets an absolute path for an image file to display on the background of active notification. + + + + + Gets the default button to display highlight on the active notification. + + + + + Gets timeout value in seconds when the notification can be hidden from the viewer. + + + + + Gets timeout value in seconds when the notification can be deleted from the viewer. + + + + + Gets Action which is invoked when notification is hidden by user. + + + The property is only reflected on Tizen TV. + If you use this API on other profile, this action have no effect + + + + + Gets or sets Action which is invoked when there is no any response by user until hide timeout. + + + The property is only reflected on Tizen TV. + If you use this API on other profile, this action settings have no effect + + + + + Gets or sets Action which is invoked when the notification is hidden by external factor. + + + If you use this API on other profile, this action settings have no effect + + + + + Gets a button to this active notification style. + Buttons are displayed in the notification content. + + + + + Gets a ReplyAction to this active notification style. + + + + + Class to get infomation about notification ButtonAction. + + + + + Gets the index of the button, which appears at notification. + + + + + Gets the text that describes the button. + + + + + Gets the image's path that represents the button. + + + + + Gets the AppControl that is invoked when the button is clicked. + + + + + Class to generate the indicator style notification. + + + + + Gets the path of the image file to display on the icon of indicator style. + + + + + Gets the sub text to display indicator style. + + + + + Class to get infomation about notification lock style. + + + + + Gets the path of the image file to display on the icon of lock style. + + + + + Gets the path of the thumbnail image file to display on the icon of lock style. + + + + + Class to get infomation about progress notification. + + + + + Gets category of ProgressType. + + + + + Gets current value of ProgressType. + + + + + Gets max value of ProgressType. + + + + + Class to get infomation about notification ReplyAction. + + + + + Gets index of button, which appears at notification. + If there is no ParentIndex, the ReplyAction should be displayed directly on the active notification. + + + + + Gets the PlaceHolderText of ReplyAction, which appears at notification. + It will be displayed to the text input box on the active notification. + + + + + Gets a max length of text input. + + + + + Gets the button displayed in the replyaction. + + + + + Enumeration for the progress category. + + + + + Value for the percent type. + + + + + Value for the time type. + + + + + Value for the pending type, which is not the updated progress current value. + + + + + Enumeration for the accessory option. + + + + + Value for off accessory option. + + + + + Value for on accessory option. + + + + + Value for the custom accessory option. + + + + + Enumeration for the button index. + + + + + Value for the default button index. + + + + + Value for the first button index. + + + + + Value for the second button index. + + + + + Value for the third button index. + + + + + Enumeration for the notification particular property. + + + + + Value for the adjust nothing. + + + + + Value for display only when SIM card inserted. + + + + + Value for disable application launch when it is selected. + + + + + Value for disable auto delete when it is selected. + + + + + Value for deleted when device is rebooted even though notification is not set OngoingType. + + + + + Enumeration for event type on notification. + + + + + Event type : Click on button 1. + + + + + Event type : Click on button 2. + + + + + Event type : Click on button 3. + + + + + Event type : Click on text_input button. + + + + + Event type : Hidden by user. + + + + + Event type : Deleted by timer. + + + + + Event type : Deleted by timer. + + + + + Event type : Clicked by user. + + + + + Event type : Deleted by user. + + + + + Enumeration for notification type. + + + + + Notification type. + + + + + Ongoing type. + + + + + Enumeration for notification text type. + + + + + Title. + + + + + Content. + + + + + Text to display the event count. + + + + + Box contents 1. + + + + + Box contents 1-1. + + + + + Box contents 2. + + + + + Box contents 2-1. + + + + + Text on button 1. + + + + + Text on button 2. + + + + + Text on button 3. + + + + + Guide text on the message reply box. + + + + + Text on button on the message reply box. + + + + + Enumeration for the image type. + + + + + Icon. + + + + + Indicator icon. + + + + + Lock screen icon. + + + + + Thumbnail. + + + + + Lock screen thumbnail. + + + + + Icon. + + + + + Image displayed on background. + + + + + Image for button 1. + + + + + Image for button 2. + + + + + Image for button 3. + + + + + Image for message reply. + + + + + Enumeration for notification layout type. + + + + + Default. + + + + + Layout for notification. Used to inform single event. + + + + + Layout for notification. Used to display images. + + + + + Layout for ongoing notification. Used to display text message. + + + + + Layout for ongoing notification. Used to display progress. + + + + + Enumeration for notification launch option type. + + + + + Launching with application control. + + + + + Enumeration for notification operation data code. + + + + + Default. + + + + + Operation type. + + + + + Private ID. + + + + + Notification handler. + + + + + Reserved. + + + + + Reserved. + + + + + Enumeration for notification operation code. + + + + + Default. + + + + + Notification inserted. + + + + + Notification updated. + + + + + Notification deleted. + + + + + Enumeration for event type on notification. + + + + + Event type : Click on button 1. + + + + + Event type : Click on button 2. + + + + + Event type : Click on button 3. + + + + + Event type : Click on icon. + + + + + Event type : Click on thumbnail. + + + + + Event type : Click on text_input button. + + + + + Enumeration for display application list. + + + + + Notification Tray(Quickpanel). + + + + + Ticker notification. + + + + + Lock screen. + + + + + Indicator. + + + + + Active notification. + + + + + All display application except active notification. + + + + + This class provides a way to register callback function for some notification events. + + + The event listener can use this class to get a list of notifications or to clear notifications. + + + + + Event handler for notification insert event. + + Thrown in case of an invalid parameter. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Event handler for notification update event. + + Thrown in case of an invalid parameter. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Event handler for notification delete event. + + Thrown in case of an invalid parameter. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Deletes a notification with appId and uniqueNumber. + + The name of the application you want to delete. + The unique number of the notification. + Thrown in case of an invalid parameter. + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Deletes all notifications. + + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + + Returns the notification list. + + Thrown in case of a permission is denied. + Thrown in case of any internal error. + http://tizen.org/privilege/notification + + + diff --git a/Artifacts/bin/Tizen.Applications.PackageManager.dll b/Artifacts/bin/Tizen.Applications.PackageManager.dll index 6cdd818..0d156f1 100644 Binary files a/Artifacts/bin/Tizen.Applications.PackageManager.dll and b/Artifacts/bin/Tizen.Applications.PackageManager.dll differ diff --git a/Artifacts/bin/Tizen.Applications.PackageManager.pdb b/Artifacts/bin/Tizen.Applications.PackageManager.pdb index 41d63c6..702467a 100644 Binary files a/Artifacts/bin/Tizen.Applications.PackageManager.pdb and b/Artifacts/bin/Tizen.Applications.PackageManager.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.PackageManager.xml b/Artifacts/bin/Tizen.Applications.PackageManager.xml index 97ae393..79cd022 100644 --- a/Artifacts/bin/Tizen.Applications.PackageManager.xml +++ b/Artifacts/bin/Tizen.Applications.PackageManager.xml @@ -1,930 +1,930 @@ - - - - Tizen.Applications.PackageManager - - - - - Enumeration for the certificate compare result type. - - - - - Certificates are matched. - - - - - Certificates are not matched. - - - - - First package does not have the certificate. - - - - - Second package does not have the certificate. - - - - - Certificates for both the packages do not exist. - - - - - Enumeration for the certification types. - - - - - Author certificate. - - - - - Distributor certificate. - - - - - Distributor2 certificate. - - - - - Enumeration for installation mode. - - - - - Normal Mode. - - - - - Mount Mode. - - - - - This class provides the methods and properties to get information about the packages. - - - - - The package ID. - - - - - Label of the package. - - - - - Absolute path to the icon image. - - - - - Version of the package. - - - - - Type of the package. - - - - - Installed storage type for the package. - - - - - Root path for the package. - - - - - Expansion package name for the package. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Checks whether the package is a system package. - - - - - Checks whether the package is removable. - - - - - Checks whether the package is preloaded. - - - - - Checks whether the current package is accessible. - - - - - Certificate information for the package. - - - - - Requested privilege for the package. - - - - - Installed time of the package. - - - - - Retrieves all the application IDs of this package. - - Returns a dictionary containing all the application information for a given application type. - - - - Retrieves all the application IDs of this package. - - Optional: AppType enumeration value. - Returns a dictionary containing all the application information for a given application type. - - - - Gets the package size information. - - Package size information. - http://tizen.org/privilege/packagemanager.info - - - - Compares the certificate information with the given package ID. - - ID of the package. - Certificate comparison result. - Thrown when a failed input package ID is invalid. - Thrown when the method failed due to an internal I/O error. - - - - This class provides information about the package certification. - - - - - Root certificate. - - - - - Intermediate certificate. - - - - - Signer certificate. - - - - - This class provides the methods and properties for the DRM operation. - - - - - Returns the response data. - - Returns the response data which is given when GenerateLicenseRequest has been invoked. - - - - Returns the request data. - - Returns the request data which is generated when GenerateLicenseRequest has been invoked. - - - - Returns the license URL. - - Returns the license URL which is generated when GenerateLicenseRequest has been invoked. - - - - Enumeration for the package manager event state. - - - - - Processing started. - - - - - Processing state. - - - - - Processing completed. - - - - - Processing failed. - - - - - Enumeration for the package manager event types. - - - - - Install event. - - - - - Uninstall event. - - - - - Update event. - - - - - Move event. - - - - - ClearData event. - - - - - This class is a parameter of the PackageManager::GetPackages method. - - - - - The default constructor with an empty filter list. All the installed applications will satisfy this filter unless updated with more specific filters. - - - - - The constructor with specific filters. Using this will filter out the installed packages which do not meet the filter criteria. - - - - - Filters to be used in the GetPackages method. - - - - - This class contains possible keys for the filter to be used in the GetPackages method. - - - - - Key of the boolean property for filtering if the package is removable. - - - - - Key of the boolean property for filtering if the package is read-only. - - - - - Key of the boolean property for filtering if the package supports disabling. - - - - - Key of the boolean property for filtering if the package is disabled. - - - - - Key of the boolean property for filtering if the package is preloaded. - - - - - PackageManager class. This class has the methods and events of the PackageManager. - - - The package manager is one of the core modules of the Tizen application framework and responsible for getting their information. - You can also retrieve information related to the packages that are installed on the device. - - - - - Event callback method for the request. - - Type of the package which was requested. - ID of the package which was requested. - Event type of the request. - Current event state of the request. - Progress for the request being processed by the package manager (in percent). - - - - InstallProgressChanged event. This event occurs when a package is getting installed and the progress of the request to the package manager is changed. - - - - - UninstallProgressChanged event. This event occurs when a package is getting uninstalled and the progress of the request to the package manager is changed. - - - - - UpdateProgressChanged event. This event occurs when a package is getting updated and the progress of the request to the package manager is changed. - - - - - MoveProgressChanged event. This event occurs when a package is getting moved and the progress of the request to the package manager is changed. - - - - - ClearDataProgressChanged event. This event occurs when data directories are cleared in the given package. - - - - - Gets the package ID for the given application ID. - - The ID of the application. - Returns the ID of the package. Empty string if the application ID does not exist. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when an application does not have the privilege to access this method. - http://tizen.org/privilege/packagemanager.info - - - - Gets the package information for the given package. - - The ID of the package. - Returns the package information for the given package ID. - Thrown when the failed input package ID is invalid. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when the method fails due to an internal I/O error. - Thrown when an application does not have the privilege to access this method. - http://tizen.org/privilege/packagemanager.info - - - - Clears the application's internal and external cache directories. - - ID of the package. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when the method fails due to an internal I/O error. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to an internal system error. - http://tizen.org/privilege/packagemanager.clearcache - - - - Clears all the application's internal and external cache directories. - - Thrown when there is not enough memory to continue the execution of the method. - Thrown when the method fails due to an internal IO error. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to an internal system error. - http://tizen.org/privilege/packagemanager.admin - platform - - - - Clears the application's internal and external data directories. - - - All files under data, shared/data, and shared/trusted in the internal storage are removed. - And, if the external storage exists, then all files under data and shared/trusted in the external storage are removed. - - ID of the package. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when the method failed due to an internal IO error. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to an internal system error. - http://tizen.org/privilege/packagemanager.admin - platform - - - - Retrieves the package information of all installed packages. - - Returns the list of packages. - http://tizen.org/privilege/packagemanager.info - - - - Retrieves the package information of all the installed packages satisfying the filter conditions. - - Optional - package filters. - Returns the list of packages. - http://tizen.org/privilege/packagemanager.info - - - - Gets the total package size information. - - Returns the total package size information asynchronously. - http://tizen.org/privilege/packagemanager.info - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Returns true if the installation request is successful, otherwise false. - - The 'true' means that the request for installation is successful. - To check the result of the installation, the caller should check the progress using the InstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - The event callback will be invoked only for the current request. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Package type for the package to be installed. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Absolute path for the expansion package to be installed. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Package type for the package to be installed. - The event callback will be invoked only for the current request. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Absolute path for the expansion package to be installed. - The event callback will be invoked only for the current request. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Absolute path for the expansion package to be installed. - Package type for the package to be installed. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Installs the package located at the given path. - - Absolute path for the package to be installed. - Absolute path for the expansion package to be installed. - Package type for the package to be installed. - The event callback will be invoked only for the current request. - Optional parameter to indicate special installation mode. - Returns true if installtion request is successful, false otherwise. - - The 'true' means that the request for installation is successful. - To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Uninstalls the package with the given name. - - ID of the package to be uninstalled. - Returns true if the uninstallation request is successful, false otherwise. - - The 'true' means that the request for uninstallation is successful. - To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Uninstalls package with the given names. - - ID of the package to be uninstalled. - Optional - Package type for the package to be uninstalled. - Returns true if the uninstalltion request is successful, false otherwise. - - The 'true' means that the request for uninstallation is successful. - To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Uninstalls the package with the given name. - - ID of the package to be uninstalled. - Optional - The event callback will be invoked only for the current request. - Returns true if the uninstallation request is successful, false otherwise. - - The 'true' means that the request for uninstallation is successful. - To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Uninstalls the package with the given name. - - ID of the package to be uninstalled - Optional - Package type for the package to be uninstalled. - Optional - The event callback will be invoked only for the current request. - Returns true if the uninstallation request is successful, false otherwise. - - The 'true' means that the request for uninstallation is successful. - To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Moves the package to the given storage. - - ID of the package to be moved. - Storage package should be moved to. - Returns true if the move request is successful, false otherwise. - - The 'true' means that the request for move is successful. - To check the result of move, the caller should check the progress using the MoveProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Moves the package to the given storage. - - ID of the package to be moved. - Optional - Package type for the package to be moved. - Storage package should be moved to. - Returns true if the move request is successful, false otherwise. - - The 'true' means that the request for move is successful. - To check the result of move, the caller should check the progress using the MoveProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Moves the package to the given storage. - - ID of the package to be moved. - Storage package should be moved to. - Optional - The event callback will be invoked only for the current request. - Returns true if move request is successful, false otherwise. - - The 'true' means that the request for move is successful. - To check the result of move, the caller should check the progress using the MoveProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Moves the package to the given storage. - - ID of the package to be moved. - Optional - Package type for the package to be moved. - Storage, package should be moved to. - Optional - The event callback will be invoked only for the current request. - Returns true if move request is successful, false otherwise. - - The 'true' means that the request for move is successful. - To check the result of move, the caller should check the progress using the MoveProgressChanged event. - - http://tizen.org/privilege/packagemanager.admin - platform - - - - Gets the permission type of the package which has a given application ID. - - ID of the application. - Returns the permission type. - http://tizen.org/privilege/packagemanager.info - Thrown when the failed input package ID is invalid. - Thrown when an application does not have the privilege to access this method. - - - - Gets the package's preload attribute which contains a given application ID. - - ID of the application. - Returns true if the package is preloaded, otherwise false. - http://tizen.org/privilege/packagemanager.info - Thrown when the failed input package ID is invalid. - Thrown when an application does not have the privilege to access this method. - - - - Compares the certificate of the two packages. - - Package ID to compare. - Package ID to be compared. - Returns certificate comparison result. - Thrown when the failed input package ID is invalid. - Thrown when the method failed due to an internal I/O error. - - - - Compares the certificate of the two packages which contain each given application ID. - - Application ID to compare. - Application ID to be compared. - Returns certificate comparison result. - Thrown when the failed input package ID is invalid. - Thrown when the method failed due to an internal I/O error. - - - - Drm nested class. This class has the PackageManager's drm related methods. - - - - - Generates a request for getting the license. - - Response data string of the purchase request. - Returns the package DRM information of a given response data which contains the required data and license URL. - http://tizen.org/privilege/packagemanager.admin - platform - Thrown when failed when input package ID is invalid. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to an internal system error. - - - - Registers the encrypted license. - - The response data string of the rights request. - Returns true if succeeds, otherwise false. - http://tizen.org/privilege/packagemanager.admin - platform - Thrown when failed when input package ID is invalid. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to internal system error. - - - - Decrypts the contents which are encrypted. - - Drm file path. - Decrypted file path. - Returns true if succeeds, otherwise false. - http://tizen.org/privilege/packagemanager.admin - platform - Thrown when failed when input package ID is invalid. - Thrown when there is not enough memory to continue the execution of the method. - Thrown when an application does not have the privilege to access this method. - Thrown when the method failed due to an internal system error. - - - - PackageManagerEventArgs class. This class is an event arguments of the InstallProgressChanged, UninstallProgressChanged, and UpdateProgressChanged events. - - - - - Type of the package to be installed, uninstalled, or updated. - - - - - Package ID to be installed, uninstalled, or updated. - - - - - Current state of the request to the package manager. - - - - - Progress for the request being processed by the package manager (in percent). - - - - - This class has read-only properties to get the package size information. - - - - - Data size for the package. - - - - - Cache size for the package. - - - - - Application size for the package. - - - - - External data size for the package. - - - - - External cache size for the package. - - - - - External application size for the package. - - - - - Enumeration for the package types. - - - - - Tizen native application package. - - - - - Tizen web/hybrid application package. - - - - - A special meaning type to represent the Tizen application package which is installed using the RPM spec. - Only some preloaded packages can have this type. - - - - - Enumeration for the permission types. - - - - - Permission is normal. - - - - - Permission is signature. - - - - - Permission is privilege. - - - - - Initializes a new instance of the SafePackageManagerHandle class. - - - - - Gets a value that indicates whether the handle is invalid. - - - - - Executes the code required to free the SafePackageManagerHandle. - - True if the handle is released successfully. - - - - Initializes a new instance of the SafePackageManagerRequestHandle class. - - - - - Gets a value that indicates whether the handle is invalid. - - - - - Executes the code required to free the SafePackageManagerRequestHandle. - - True if the handle is released successfully. - - - - Enumeration for the storage types. - - - - - Internal storage. - - - - - External storage. - - - - + + + + Tizen.Applications.PackageManager + + + + + Enumeration for the certificate compare result type. + + + + + Certificates are matched. + + + + + Certificates are not matched. + + + + + First package does not have the certificate. + + + + + Second package does not have the certificate. + + + + + Certificates for both the packages do not exist. + + + + + Enumeration for the certification types. + + + + + Author certificate. + + + + + Distributor certificate. + + + + + Distributor2 certificate. + + + + + Enumeration for installation mode. + + + + + Normal Mode. + + + + + Mount Mode. + + + + + This class provides the methods and properties to get information about the packages. + + + + + The package ID. + + + + + Label of the package. + + + + + Absolute path to the icon image. + + + + + Version of the package. + + + + + Type of the package. + + + + + Installed storage type for the package. + + + + + Root path for the package. + + + + + Expansion package name for the package. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Checks whether the package is a system package. + + + + + Checks whether the package is removable. + + + + + Checks whether the package is preloaded. + + + + + Checks whether the current package is accessible. + + + + + Certificate information for the package. + + + + + Requested privilege for the package. + + + + + Installed time of the package. + + + + + Retrieves all the application IDs of this package. + + Returns a dictionary containing all the application information for a given application type. + + + + Retrieves all the application IDs of this package. + + Optional: AppType enumeration value. + Returns a dictionary containing all the application information for a given application type. + + + + Gets the package size information. + + Package size information. + http://tizen.org/privilege/packagemanager.info + + + + Compares the certificate information with the given package ID. + + ID of the package. + Certificate comparison result. + Thrown when a failed input package ID is invalid. + Thrown when the method failed due to an internal I/O error. + + + + This class provides information about the package certification. + + + + + Root certificate. + + + + + Intermediate certificate. + + + + + Signer certificate. + + + + + This class provides the methods and properties for the DRM operation. + + + + + Returns the response data. + + Returns the response data which is given when GenerateLicenseRequest has been invoked. + + + + Returns the request data. + + Returns the request data which is generated when GenerateLicenseRequest has been invoked. + + + + Returns the license URL. + + Returns the license URL which is generated when GenerateLicenseRequest has been invoked. + + + + Enumeration for the package manager event state. + + + + + Processing started. + + + + + Processing state. + + + + + Processing completed. + + + + + Processing failed. + + + + + Enumeration for the package manager event types. + + + + + Install event. + + + + + Uninstall event. + + + + + Update event. + + + + + Move event. + + + + + ClearData event. + + + + + This class is a parameter of the PackageManager::GetPackages method. + + + + + The default constructor with an empty filter list. All the installed applications will satisfy this filter unless updated with more specific filters. + + + + + The constructor with specific filters. Using this will filter out the installed packages which do not meet the filter criteria. + + + + + Filters to be used in the GetPackages method. + + + + + This class contains possible keys for the filter to be used in the GetPackages method. + + + + + Key of the boolean property for filtering if the package is removable. + + + + + Key of the boolean property for filtering if the package is read-only. + + + + + Key of the boolean property for filtering if the package supports disabling. + + + + + Key of the boolean property for filtering if the package is disabled. + + + + + Key of the boolean property for filtering if the package is preloaded. + + + + + PackageManager class. This class has the methods and events of the PackageManager. + + + The package manager is one of the core modules of the Tizen application framework and responsible for getting their information. + You can also retrieve information related to the packages that are installed on the device. + + + + + Event callback method for the request. + + Type of the package which was requested. + ID of the package which was requested. + Event type of the request. + Current event state of the request. + Progress for the request being processed by the package manager (in percent). + + + + InstallProgressChanged event. This event occurs when a package is getting installed and the progress of the request to the package manager is changed. + + + + + UninstallProgressChanged event. This event occurs when a package is getting uninstalled and the progress of the request to the package manager is changed. + + + + + UpdateProgressChanged event. This event occurs when a package is getting updated and the progress of the request to the package manager is changed. + + + + + MoveProgressChanged event. This event occurs when a package is getting moved and the progress of the request to the package manager is changed. + + + + + ClearDataProgressChanged event. This event occurs when data directories are cleared in the given package. + + + + + Gets the package ID for the given application ID. + + The ID of the application. + Returns the ID of the package. Empty string if the application ID does not exist. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when an application does not have the privilege to access this method. + http://tizen.org/privilege/packagemanager.info + + + + Gets the package information for the given package. + + The ID of the package. + Returns the package information for the given package ID. + Thrown when the failed input package ID is invalid. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when the method fails due to an internal I/O error. + Thrown when an application does not have the privilege to access this method. + http://tizen.org/privilege/packagemanager.info + + + + Clears the application's internal and external cache directories. + + ID of the package. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when the method fails due to an internal I/O error. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to an internal system error. + http://tizen.org/privilege/packagemanager.clearcache + + + + Clears all the application's internal and external cache directories. + + Thrown when there is not enough memory to continue the execution of the method. + Thrown when the method fails due to an internal IO error. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to an internal system error. + http://tizen.org/privilege/packagemanager.admin + platform + + + + Clears the application's internal and external data directories. + + + All files under data, shared/data, and shared/trusted in the internal storage are removed. + And, if the external storage exists, then all files under data and shared/trusted in the external storage are removed. + + ID of the package. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when the method failed due to an internal IO error. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to an internal system error. + http://tizen.org/privilege/packagemanager.admin + platform + + + + Retrieves the package information of all installed packages. + + Returns the list of packages. + http://tizen.org/privilege/packagemanager.info + + + + Retrieves the package information of all the installed packages satisfying the filter conditions. + + Optional - package filters. + Returns the list of packages. + http://tizen.org/privilege/packagemanager.info + + + + Gets the total package size information. + + Returns the total package size information asynchronously. + http://tizen.org/privilege/packagemanager.info + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Returns true if the installation request is successful, otherwise false. + + The 'true' means that the request for installation is successful. + To check the result of the installation, the caller should check the progress using the InstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + The event callback will be invoked only for the current request. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Package type for the package to be installed. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Absolute path for the expansion package to be installed. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Package type for the package to be installed. + The event callback will be invoked only for the current request. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Absolute path for the expansion package to be installed. + The event callback will be invoked only for the current request. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Absolute path for the expansion package to be installed. + Package type for the package to be installed. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Installs the package located at the given path. + + Absolute path for the package to be installed. + Absolute path for the expansion package to be installed. + Package type for the package to be installed. + The event callback will be invoked only for the current request. + Optional parameter to indicate special installation mode. + Returns true if installtion request is successful, false otherwise. + + The 'true' means that the request for installation is successful. + To check the result of installation, the caller should check the progress using the InstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Uninstalls the package with the given name. + + ID of the package to be uninstalled. + Returns true if the uninstallation request is successful, false otherwise. + + The 'true' means that the request for uninstallation is successful. + To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Uninstalls package with the given names. + + ID of the package to be uninstalled. + Optional - Package type for the package to be uninstalled. + Returns true if the uninstalltion request is successful, false otherwise. + + The 'true' means that the request for uninstallation is successful. + To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Uninstalls the package with the given name. + + ID of the package to be uninstalled. + Optional - The event callback will be invoked only for the current request. + Returns true if the uninstallation request is successful, false otherwise. + + The 'true' means that the request for uninstallation is successful. + To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Uninstalls the package with the given name. + + ID of the package to be uninstalled + Optional - Package type for the package to be uninstalled. + Optional - The event callback will be invoked only for the current request. + Returns true if the uninstallation request is successful, false otherwise. + + The 'true' means that the request for uninstallation is successful. + To check the result of uninstallation, the caller should check the progress using the UninstallProgressChanged event or eventCallback. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Moves the package to the given storage. + + ID of the package to be moved. + Storage package should be moved to. + Returns true if the move request is successful, false otherwise. + + The 'true' means that the request for move is successful. + To check the result of move, the caller should check the progress using the MoveProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Moves the package to the given storage. + + ID of the package to be moved. + Optional - Package type for the package to be moved. + Storage package should be moved to. + Returns true if the move request is successful, false otherwise. + + The 'true' means that the request for move is successful. + To check the result of move, the caller should check the progress using the MoveProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Moves the package to the given storage. + + ID of the package to be moved. + Storage package should be moved to. + Optional - The event callback will be invoked only for the current request. + Returns true if move request is successful, false otherwise. + + The 'true' means that the request for move is successful. + To check the result of move, the caller should check the progress using the MoveProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Moves the package to the given storage. + + ID of the package to be moved. + Optional - Package type for the package to be moved. + Storage, package should be moved to. + Optional - The event callback will be invoked only for the current request. + Returns true if move request is successful, false otherwise. + + The 'true' means that the request for move is successful. + To check the result of move, the caller should check the progress using the MoveProgressChanged event. + + http://tizen.org/privilege/packagemanager.admin + platform + + + + Gets the permission type of the package which has a given application ID. + + ID of the application. + Returns the permission type. + http://tizen.org/privilege/packagemanager.info + Thrown when the failed input package ID is invalid. + Thrown when an application does not have the privilege to access this method. + + + + Gets the package's preload attribute which contains a given application ID. + + ID of the application. + Returns true if the package is preloaded, otherwise false. + http://tizen.org/privilege/packagemanager.info + Thrown when the failed input package ID is invalid. + Thrown when an application does not have the privilege to access this method. + + + + Compares the certificate of the two packages. + + Package ID to compare. + Package ID to be compared. + Returns certificate comparison result. + Thrown when the failed input package ID is invalid. + Thrown when the method failed due to an internal I/O error. + + + + Compares the certificate of the two packages which contain each given application ID. + + Application ID to compare. + Application ID to be compared. + Returns certificate comparison result. + Thrown when the failed input package ID is invalid. + Thrown when the method failed due to an internal I/O error. + + + + Drm nested class. This class has the PackageManager's drm related methods. + + + + + Generates a request for getting the license. + + Response data string of the purchase request. + Returns the package DRM information of a given response data which contains the required data and license URL. + http://tizen.org/privilege/packagemanager.admin + platform + Thrown when failed when input package ID is invalid. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to an internal system error. + + + + Registers the encrypted license. + + The response data string of the rights request. + Returns true if succeeds, otherwise false. + http://tizen.org/privilege/packagemanager.admin + platform + Thrown when failed when input package ID is invalid. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to internal system error. + + + + Decrypts the contents which are encrypted. + + Drm file path. + Decrypted file path. + Returns true if succeeds, otherwise false. + http://tizen.org/privilege/packagemanager.admin + platform + Thrown when failed when input package ID is invalid. + Thrown when there is not enough memory to continue the execution of the method. + Thrown when an application does not have the privilege to access this method. + Thrown when the method failed due to an internal system error. + + + + PackageManagerEventArgs class. This class is an event arguments of the InstallProgressChanged, UninstallProgressChanged, and UpdateProgressChanged events. + + + + + Type of the package to be installed, uninstalled, or updated. + + + + + Package ID to be installed, uninstalled, or updated. + + + + + Current state of the request to the package manager. + + + + + Progress for the request being processed by the package manager (in percent). + + + + + This class has read-only properties to get the package size information. + + + + + Data size for the package. + + + + + Cache size for the package. + + + + + Application size for the package. + + + + + External data size for the package. + + + + + External cache size for the package. + + + + + External application size for the package. + + + + + Enumeration for the package types. + + + + + Tizen native application package. + + + + + Tizen web/hybrid application package. + + + + + A special meaning type to represent the Tizen application package which is installed using the RPM spec. + Only some preloaded packages can have this type. + + + + + Enumeration for the permission types. + + + + + Permission is normal. + + + + + Permission is signature. + + + + + Permission is privilege. + + + + + Initializes a new instance of the SafePackageManagerHandle class. + + + + + Gets a value that indicates whether the handle is invalid. + + + + + Executes the code required to free the SafePackageManagerHandle. + + True if the handle is released successfully. + + + + Initializes a new instance of the SafePackageManagerRequestHandle class. + + + + + Gets a value that indicates whether the handle is invalid. + + + + + Executes the code required to free the SafePackageManagerRequestHandle. + + True if the handle is released successfully. + + + + Enumeration for the storage types. + + + + + Internal storage. + + + + + External storage. + + + + diff --git a/Artifacts/bin/Tizen.Applications.Preference.dll b/Artifacts/bin/Tizen.Applications.Preference.dll index bac3a01..64f10a3 100644 Binary files a/Artifacts/bin/Tizen.Applications.Preference.dll and b/Artifacts/bin/Tizen.Applications.Preference.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Preference.pdb b/Artifacts/bin/Tizen.Applications.Preference.pdb index 530849a..9aa47a7 100644 Binary files a/Artifacts/bin/Tizen.Applications.Preference.pdb and b/Artifacts/bin/Tizen.Applications.Preference.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Preference.xml b/Artifacts/bin/Tizen.Applications.Preference.xml index 6f4a0a3..7d620ab 100644 --- a/Artifacts/bin/Tizen.Applications.Preference.xml +++ b/Artifacts/bin/Tizen.Applications.Preference.xml @@ -1,156 +1,156 @@ - - - - Tizen.Applications.Preference - - - - - Contains interop declarations of the preference classes. - - - - - Contains interop declarations of the preference device API. - - - - - The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair. - Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean. - - - - - Retrieves all keys of the application preferences. - - - The list of keys. - - - - Preference.Set("Option_enabled", true); - Preference.Set("active_user", "Joe"); - Preference.Set("default_volume", 10); - Preference.Set("brightness", "0.6"); - foreach(string key in Preference.Keys) - { - Console.WriteLine("key {0}", key); - } - - - - - - Gets the event context for the given key. - - - The preference key. - The event context of respective key. - Thrown if the key is not found. - Thrown if the key is invalid parameter. - - - private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) - { - Console.WriteLine("key {0}", e.Key); - } - - Preference.EventContext context = null; - Preference.GetEventContext("active_user").TryGetTarget(out context); - if(context != null) - { - context.Changed += Preference_PreferenceChanged; - } - - Preference.Set("active_user", "Poe"); - - Preference.GetEventContext("active_user").TryGetTarget(out context); - if (context != null) - { - context.Changed -= Preference_PreferenceChanged; - } - - - - - - - - - Removes any preference value with the given key. - - The key to remove. - Thrown if the key is not found. - Thrown when the method failed due to an internal I/O error. - - - bool exists = Preference.Contains("active_user"); - if (exists) - { - string value = Preference.Remove("active_user"); - } - - - - - - Removes all the key-value pairs from the preference. - - Thrown when the method failed due to an internal I/O error. - - - Preference.Set("Option_enabled", true); - Preference.Set("active_user", "Joe"); - Preference.Set("default_volume", 10); - Preference.Set("brightness", "0.6"); - Preference.RemoveAll(); - - - - - - The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys. - - - - - Occurs whenever there is a change in the value of a preference key. - - Thrown when the key does not exist or when there is an invalid parameter. - Thrown when the bundle instance has been disposed. - - - private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) - { - Console.WriteLine("key {0}", e.Key); - } - Preference.EventContext context = null; - Preference.GetEventContext("active_user").TryGetTarget(out context); - if(context != null) - { - context.Changed += Preference_PreferenceChanged; - } - - Preference.Set("active_user", "Poe"); - - Preference.GetEventContext("active_user").TryGetTarget(out context); - if (context != null) - { - context.Changed -= Preference_PreferenceChanged; - } - - - - - - This class is an event argument of the PreferenceChanged event. - - - - - The key of the preference whose value is changed. - - - - + + + + Tizen.Applications.Preference + + + + + Contains interop declarations of the preference classes. + + + + + Contains interop declarations of the preference device API. + + + + + The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair. + Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean. + + + + + Retrieves all keys of the application preferences. + + + The list of keys. + + + + Preference.Set("Option_enabled", true); + Preference.Set("active_user", "Joe"); + Preference.Set("default_volume", 10); + Preference.Set("brightness", "0.6"); + foreach(string key in Preference.Keys) + { + Console.WriteLine("key {0}", key); + } + + + + + + Gets the event context for the given key. + + + The preference key. + The event context of respective key. + Thrown if the key is not found. + Thrown if the key is invalid parameter. + + + private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) + { + Console.WriteLine("key {0}", e.Key); + } + + Preference.EventContext context = null; + Preference.GetEventContext("active_user").TryGetTarget(out context); + if(context != null) + { + context.Changed += Preference_PreferenceChanged; + } + + Preference.Set("active_user", "Poe"); + + Preference.GetEventContext("active_user").TryGetTarget(out context); + if (context != null) + { + context.Changed -= Preference_PreferenceChanged; + } + + + + + + + + + Removes any preference value with the given key. + + The key to remove. + Thrown if the key is not found. + Thrown when the method failed due to an internal I/O error. + + + bool exists = Preference.Contains("active_user"); + if (exists) + { + string value = Preference.Remove("active_user"); + } + + + + + + Removes all the key-value pairs from the preference. + + Thrown when the method failed due to an internal I/O error. + + + Preference.Set("Option_enabled", true); + Preference.Set("active_user", "Joe"); + Preference.Set("default_volume", 10); + Preference.Set("brightness", "0.6"); + Preference.RemoveAll(); + + + + + + The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys. + + + + + Occurs whenever there is a change in the value of a preference key. + + Thrown when the key does not exist or when there is an invalid parameter. + Thrown when the bundle instance has been disposed. + + + private static void Preference_PreferenceChanged(object sender, PreferenceChangedEventArgs e) + { + Console.WriteLine("key {0}", e.Key); + } + Preference.EventContext context = null; + Preference.GetEventContext("active_user").TryGetTarget(out context); + if(context != null) + { + context.Changed += Preference_PreferenceChanged; + } + + Preference.Set("active_user", "Poe"); + + Preference.GetEventContext("active_user").TryGetTarget(out context); + if (context != null) + { + context.Changed -= Preference_PreferenceChanged; + } + + + + + + This class is an event argument of the PreferenceChanged event. + + + + + The key of the preference whose value is changed. + + + + diff --git a/Artifacts/bin/Tizen.Applications.RemoteView.dll b/Artifacts/bin/Tizen.Applications.RemoteView.dll index 03d3922..88c7036 100644 Binary files a/Artifacts/bin/Tizen.Applications.RemoteView.dll and b/Artifacts/bin/Tizen.Applications.RemoteView.dll differ diff --git a/Artifacts/bin/Tizen.Applications.RemoteView.pdb b/Artifacts/bin/Tizen.Applications.RemoteView.pdb index 0938356..841bff8 100644 Binary files a/Artifacts/bin/Tizen.Applications.RemoteView.pdb and b/Artifacts/bin/Tizen.Applications.RemoteView.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.RemoteView.xml b/Artifacts/bin/Tizen.Applications.RemoteView.xml index 48705ca..99ce6a4 100644 --- a/Artifacts/bin/Tizen.Applications.RemoteView.xml +++ b/Artifacts/bin/Tizen.Applications.RemoteView.xml @@ -1,140 +1,140 @@ - - - - Tizen.Applications.RemoteView - - - - - Represents the proxy class for the widget application. - - - - - The event types to send. - - - - - Type for feeding the mouse-up event to the widget application. - - - - - Type for canceling the click event procedure. - - - - - Layout object including preview image, overlay text, loading text, and remote screen image. - - http://tizen.org/privilege/widget.viewer - - - - The widget ID. - - http://tizen.org/privilege/widget.viewer - - - - The update period. - - http://tizen.org/privilege/widget.viewer - - - - Contents of the widget. - - - This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status). - - http://tizen.org/privilege/widget.viewer - - - - Summarized string of the widget content for accessibility. - - http://tizen.org/privilege/widget.viewer - - - - Pauses all the connected widget 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. - - - - - Pauses the widget application which is connected on this proxy. - - 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. - - - - Resumes the widget application which is connected on this proxy. - - 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. - - - - Sends the event to the widget application which is connected on this proxy. - - http://tizen.org/privilege/widget.viewer - Thrown when this operation is denied. - Thrown when this operation is not supported for this device. - - - - Represents a factory class for making the RemoteView objects. - - - - - Initializes RemoteViewFactory. - - Window object that will contain RemoteViews that are generated by RemoteViewFactory. - All the remote views will be located in the specified window object. - - 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. - - - - Creates a RemoteView object. - - Parent object. - Widget ID. - Contents that will be given to the widget instance. - Update period. - True if you want to show the preview image. - True if you want to show the overlay text. - True if you want to show the loading message. - RemoteView object. - 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. - - - - Finalizes the RemoteViewFactory. - - 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. - - - + + + + Tizen.Applications.RemoteView + + + + + Represents the proxy class for the widget application. + + + + + The event types to send. + + + + + Type for feeding the mouse-up event to the widget application. + + + + + Type for canceling the click event procedure. + + + + + Layout object including preview image, overlay text, loading text, and remote screen image. + + http://tizen.org/privilege/widget.viewer + + + + The widget ID. + + http://tizen.org/privilege/widget.viewer + + + + The update period. + + http://tizen.org/privilege/widget.viewer + + + + Contents of the widget. + + + This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status). + + http://tizen.org/privilege/widget.viewer + + + + Summarized string of the widget content for accessibility. + + http://tizen.org/privilege/widget.viewer + + + + Pauses all the connected widget 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. + + + + + Pauses the widget application which is connected on this proxy. + + 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. + + + + Resumes the widget application which is connected on this proxy. + + 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. + + + + Sends the event to the widget application which is connected on this proxy. + + http://tizen.org/privilege/widget.viewer + Thrown when this operation is denied. + Thrown when this operation is not supported for this device. + + + + Represents a factory class for making the RemoteView objects. + + + + + Initializes RemoteViewFactory. + + Window object that will contain RemoteViews that are generated by RemoteViewFactory. + All the remote views will be located in the specified window object. + + 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. + + + + Creates a RemoteView object. + + Parent object. + Widget ID. + Contents that will be given to the widget instance. + Update period. + True if you want to show the preview image. + True if you want to show the overlay text. + True if you want to show the loading message. + RemoteView object. + 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. + + + + Finalizes the RemoteViewFactory. + + 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. + + + diff --git a/Artifacts/bin/Tizen.Applications.Service.dll b/Artifacts/bin/Tizen.Applications.Service.dll index afa4e78..f101527 100644 Binary files a/Artifacts/bin/Tizen.Applications.Service.dll and b/Artifacts/bin/Tizen.Applications.Service.dll differ diff --git a/Artifacts/bin/Tizen.Applications.Service.pdb b/Artifacts/bin/Tizen.Applications.Service.pdb index 2cbaf2e..c31c086 100644 Binary files a/Artifacts/bin/Tizen.Applications.Service.pdb and b/Artifacts/bin/Tizen.Applications.Service.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.Service.xml b/Artifacts/bin/Tizen.Applications.Service.xml index 0bbfc16..1e20f86 100644 --- a/Artifacts/bin/Tizen.Applications.Service.xml +++ b/Artifacts/bin/Tizen.Applications.Service.xml @@ -1,24 +1,24 @@ - - - - Tizen.Applications.Service - - - - - Represents the service applications. - - - - - Initializes the ServiceApplication class. - - - - - Runs the service application's main loop. - - Arguments from commandline. - - - + + + + Tizen.Applications.Service + + + + + Represents the service applications. + + + + + Initializes the ServiceApplication class. + + + + + Runs the service application's main loop. + + Arguments from commandline. + + + diff --git a/Artifacts/bin/Tizen.Applications.ToastMessage.dll b/Artifacts/bin/Tizen.Applications.ToastMessage.dll index c077c67..f6db35e 100644 Binary files a/Artifacts/bin/Tizen.Applications.ToastMessage.dll and b/Artifacts/bin/Tizen.Applications.ToastMessage.dll differ diff --git a/Artifacts/bin/Tizen.Applications.ToastMessage.pdb b/Artifacts/bin/Tizen.Applications.ToastMessage.pdb index 30049fe..a29692a 100644 Binary files a/Artifacts/bin/Tizen.Applications.ToastMessage.pdb and b/Artifacts/bin/Tizen.Applications.ToastMessage.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.ToastMessage.xml b/Artifacts/bin/Tizen.Applications.ToastMessage.xml index 7e65e2d..32a6d72 100644 --- a/Artifacts/bin/Tizen.Applications.ToastMessage.xml +++ b/Artifacts/bin/Tizen.Applications.ToastMessage.xml @@ -1,33 +1,33 @@ - - - - Tizen.Applications.ToastMessage - - - - - The class helps you to create and show the ToastMessage which is a view quick message for the user. - - - - - Gets and sets a message to post the ToastMessage. - - - - - Posts a message on a toast pop-up. - - Thrown when the message is null. - - - ToastMessage toast = new ToastMessage - { - Message = "Hello TIzen" - }; - toast.Post(); - - - - - + + + + Tizen.Applications.ToastMessage + + + + + The class helps you to create and show the ToastMessage which is a view quick message for the user. + + + + + Gets and sets a message to post the ToastMessage. + + + + + Posts a message on a toast pop-up. + + Thrown when the message is null. + + + ToastMessage toast = new ToastMessage + { + Message = "Hello TIzen" + }; + toast.Post(); + + + + + diff --git a/Artifacts/bin/Tizen.Applications.UI.dll b/Artifacts/bin/Tizen.Applications.UI.dll index 9012823..dd54593 100644 Binary files a/Artifacts/bin/Tizen.Applications.UI.dll and b/Artifacts/bin/Tizen.Applications.UI.dll differ diff --git a/Artifacts/bin/Tizen.Applications.UI.pdb b/Artifacts/bin/Tizen.Applications.UI.pdb index bad4415..8572444 100644 Binary files a/Artifacts/bin/Tizen.Applications.UI.pdb and b/Artifacts/bin/Tizen.Applications.UI.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.UI.xml b/Artifacts/bin/Tizen.Applications.UI.xml index 97f6db3..d4be01f 100644 --- a/Artifacts/bin/Tizen.Applications.UI.xml +++ b/Artifacts/bin/Tizen.Applications.UI.xml @@ -1,63 +1,63 @@ - - - - Tizen.Applications.UI - - - - - Represents an application that has an UI screen. The events for resuming and pausing are provided. - - - - - Initializes the CoreUIApplication class. - - - The default backend for the UI application will be used. - - - - - Initializes the CoreUIApplication class. - - - If you want to change the backend, use this constructor. - - The backend instance implementing the ICoreBacked interface. - - - - Occurs whenever the application is resumed. - - - - - Occurs whenever the application is paused. - - - - - Runs the UI application's main loop. - - Arguments from the commandline. - - - - Overrides this method if you want to handle the behavior before calling OnCreate(). - - - - - Overrides this method if you want to handle the behavior when the application is resumed. - If base.OnResume() is not called, the event 'Resumed' will not be emitted. - - - - - Overrides this method if you want to handle the behavior when the application is paused. - If base.OnPause() is not called, the event 'Paused' will not be emitted. - - - - + + + + Tizen.Applications.UI + + + + + Represents an application that has an UI screen. The events for resuming and pausing are provided. + + + + + Initializes the CoreUIApplication class. + + + The default backend for the UI application will be used. + + + + + Initializes the CoreUIApplication class. + + + If you want to change the backend, use this constructor. + + The backend instance implementing the ICoreBacked interface. + + + + Occurs whenever the application is resumed. + + + + + Occurs whenever the application is paused. + + + + + Runs the UI application's main loop. + + Arguments from the commandline. + + + + Overrides this method if you want to handle the behavior before calling OnCreate(). + + + + + Overrides this method if you want to handle the behavior when the application is resumed. + If base.OnResume() is not called, the event 'Resumed' will not be emitted. + + + + + Overrides this method if you want to handle the behavior when the application is paused. + If base.OnPause() is not called, the event 'Paused' will not be emitted. + + + + diff --git a/Artifacts/bin/Tizen.Applications.WatchApplication.dll b/Artifacts/bin/Tizen.Applications.WatchApplication.dll index 577f43a..2eaba60 100644 Binary files a/Artifacts/bin/Tizen.Applications.WatchApplication.dll and b/Artifacts/bin/Tizen.Applications.WatchApplication.dll differ diff --git a/Artifacts/bin/Tizen.Applications.WatchApplication.pdb b/Artifacts/bin/Tizen.Applications.WatchApplication.pdb index 310950b..c1e46db 100644 Binary files a/Artifacts/bin/Tizen.Applications.WatchApplication.pdb and b/Artifacts/bin/Tizen.Applications.WatchApplication.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.WatchApplication.xml b/Artifacts/bin/Tizen.Applications.WatchApplication.xml index 34bd73b..5aa00a0 100644 --- a/Artifacts/bin/Tizen.Applications.WatchApplication.xml +++ b/Artifacts/bin/Tizen.Applications.WatchApplication.xml @@ -1,428 +1,428 @@ - - - - Tizen.Applications.WatchApplication - - - - - Class that represents the type of event for backends. This class can be converted from string type. - - - - - Pre-defined event type. "Created" - - - - - Pre-defined event type. "AmbientTick" - - - - - Pre-defined event type. "AmbientChanged" - - - - - Initializes the WatchEventType class. - - The name of watch event type. - - - - Converts a string to WatchEventType instance. - - - - - Arguments for the event that reaised when the device enters or exits the ambient mode. - - - - - The received Ambient mode - - - - - Enumeration for Ambient tick type. - - - - - No peridoic ambient tick. - - - - - Every minute. - - - - - Every 5 minutes. - - - - - Every 15 minutes. - - - - - Every 30 minutes. - - - - - Every hour. - - - - - Every 3 hours. - - - - - Every 6 hours. - - - - - Every 12 hours. - - - - - Every day. - - - - - Arguments for the event that reaised when the time tick comes. - - - - - The received WatchTime. - - - - - Enumeration for Time tick resolution. - - - - - 1 ~ 60 ticks per second. - - - - - 1 ~ 60 ticks per minute. - - - - - 1 ~ 60 ticks per hour. - - - - - The class that represents a Tizen watch application. - - - - - Initialize the WatchApplication class - - - Default backend for Watch application will be used. - - - - - Initialize the WatchApplication class - - - If want to change the backend , use this constructor - - The backend instance implementing ICoreBackend interface. - - - - Instance for the window - - - - - Occurs whenever the application is resumed. - - - - - Occurs whenever the application is paused. - - - - - Occurs whenever the time tick comes. - - - - - Occurs whenever the time tick comes in ambient mode. - - - - - Occurs when the ambient mode is changed. - - - - - Runs the UI applications' main loop. - - Arguments from commandline. - - - - Overrides this method if want to handle behavior when the application is launched. - If base.OnCreate() is not called, the event 'Created' will not be emitted. - - - - - Overrides this method if want to handle behavior when the application is resumed. - If base.OnResume() is not called, the event 'Resumed' will not be emitted. - - - - - Overrides this method if want to handle behavior when the application is paused. - If base.OnPause() is not called, the event 'Paused' will not be emitted. - - - - - Overrides this method if want to handle behavior when the time tick event comes. - If base.OnTick() is not called, the event 'TimeTick' will not be emitted. - - The received TimeEventArgs to get time information. - - - - Overrides this method if want to handle behavior when the time tick event comes in ambient mode. - If base.OnAmbientTick() is not called, the event 'AmbientTick' will not be emitted. - - The received TimeEventArgs to get time information. - http://tizen.org/privilege/alarm.set - - - - Overrides this method if want to handle behavior when the ambient mode is changed. - If base.OnAmbientChanged() is not called, the event 'AmbientChanged' will not be emitted. - - The received AmbientEventArgs - - - - Gets the current time - - WatchTime - Thrown when failed to get current time because of invalid parameter. - Thrown when failed to get current time because memory is not enough. - - - class MyApp : WatchApplication - { - ... - public void TestMethod() - { - WatchTime wt; - try - { - wt = GetCurrentTime(); - } - catch - { - } - } - } - - - - - - Gets the type of periodic ambient tick. - - AmbientTickType - Thrown when failed to get ambient tick type. - - - class MyApp : WatchApplication - { - ... - public void TestMethod() - { - AmbientTickType atType; - try - { - atType = GetAmbientTickType(); - } - catch - { - } - } - } - - - - - - Sets the type of periodic ambient tick. - OnAmbientTick will be called following settings. - If SetAmbientTickType is not called, OnAmbientTick will be called every minute. - - the type of ambient tick - Thrown when failed to set ambient tick type. - - - class MyApp : WatchApplication - { - ... - public void TestMethod() - { - try - { - SetAmbientTickType(AmbientTickType.EveryMinute); - } - catch - { - } - } - } - - - - - - Sets the frequency of time tick. - OnTick will be called following settings. - If SetTimeTickFrequency is not called, OnTick will be called every second. - - Ticks the number of ticks per given resolution type - Type of the resolution type - Thrown when failed to set time tick frequency. - - - class MyApp : WatchApplication - { - ... - public void TestMethod() - { - try - { - SetTimeTickFrequency(1, TimeTickResolution.TimeTicksPerMinute); - } - catch - { - } - } - } - - - - - - Gets the frequency fo time tick. - - Ticks the number of ticks per given resolution type - Type of the resolution type - Thrown when failed to get time tick frequency. - - - class MyApp : WatchApplication - { - ... - public void TestMethod() - { - int tick; - TimeTickResolution tType; - try - { - GetTimeTickFrequency(out tick, out tType); - } - catch - { - } - } - } - - - - - - The information of Watch Time - - - - - The information of year - - - - - The information fo month - - - - - The information of day - - - - - The information of day of week - - - - - The information of hour - - - - - The information of hour for 24 hour form - - - - - The information of Minute - - - - - The information of second - - - - - The information of millisecond - - - - - The information of timezone - - - - - The information of UTC time stamp - - - - + + + + Tizen.Applications.WatchApplication + + + + + Class that represents the type of event for backends. This class can be converted from string type. + + + + + Pre-defined event type. "Created" + + + + + Pre-defined event type. "AmbientTick" + + + + + Pre-defined event type. "AmbientChanged" + + + + + Initializes the WatchEventType class. + + The name of watch event type. + + + + Converts a string to WatchEventType instance. + + + + + Arguments for the event that reaised when the device enters or exits the ambient mode. + + + + + The received Ambient mode + + + + + Enumeration for Ambient tick type. + + + + + No peridoic ambient tick. + + + + + Every minute. + + + + + Every 5 minutes. + + + + + Every 15 minutes. + + + + + Every 30 minutes. + + + + + Every hour. + + + + + Every 3 hours. + + + + + Every 6 hours. + + + + + Every 12 hours. + + + + + Every day. + + + + + Arguments for the event that reaised when the time tick comes. + + + + + The received WatchTime. + + + + + Enumeration for Time tick resolution. + + + + + 1 ~ 60 ticks per second. + + + + + 1 ~ 60 ticks per minute. + + + + + 1 ~ 60 ticks per hour. + + + + + The class that represents a Tizen watch application. + + + + + Initialize the WatchApplication class + + + Default backend for Watch application will be used. + + + + + Initialize the WatchApplication class + + + If want to change the backend , use this constructor + + The backend instance implementing ICoreBackend interface. + + + + Instance for the window + + + + + Occurs whenever the application is resumed. + + + + + Occurs whenever the application is paused. + + + + + Occurs whenever the time tick comes. + + + + + Occurs whenever the time tick comes in ambient mode. + + + + + Occurs when the ambient mode is changed. + + + + + Runs the UI applications' main loop. + + Arguments from commandline. + + + + Overrides this method if want to handle behavior when the application is launched. + If base.OnCreate() is not called, the event 'Created' will not be emitted. + + + + + Overrides this method if want to handle behavior when the application is resumed. + If base.OnResume() is not called, the event 'Resumed' will not be emitted. + + + + + Overrides this method if want to handle behavior when the application is paused. + If base.OnPause() is not called, the event 'Paused' will not be emitted. + + + + + Overrides this method if want to handle behavior when the time tick event comes. + If base.OnTick() is not called, the event 'TimeTick' will not be emitted. + + The received TimeEventArgs to get time information. + + + + Overrides this method if want to handle behavior when the time tick event comes in ambient mode. + If base.OnAmbientTick() is not called, the event 'AmbientTick' will not be emitted. + + The received TimeEventArgs to get time information. + http://tizen.org/privilege/alarm.set + + + + Overrides this method if want to handle behavior when the ambient mode is changed. + If base.OnAmbientChanged() is not called, the event 'AmbientChanged' will not be emitted. + + The received AmbientEventArgs + + + + Gets the current time + + WatchTime + Thrown when failed to get current time because of invalid parameter. + Thrown when failed to get current time because memory is not enough. + + + class MyApp : WatchApplication + { + ... + public void TestMethod() + { + WatchTime wt; + try + { + wt = GetCurrentTime(); + } + catch + { + } + } + } + + + + + + Gets the type of periodic ambient tick. + + AmbientTickType + Thrown when failed to get ambient tick type. + + + class MyApp : WatchApplication + { + ... + public void TestMethod() + { + AmbientTickType atType; + try + { + atType = GetAmbientTickType(); + } + catch + { + } + } + } + + + + + + Sets the type of periodic ambient tick. + OnAmbientTick will be called following settings. + If SetAmbientTickType is not called, OnAmbientTick will be called every minute. + + the type of ambient tick + Thrown when failed to set ambient tick type. + + + class MyApp : WatchApplication + { + ... + public void TestMethod() + { + try + { + SetAmbientTickType(AmbientTickType.EveryMinute); + } + catch + { + } + } + } + + + + + + Sets the frequency of time tick. + OnTick will be called following settings. + If SetTimeTickFrequency is not called, OnTick will be called every second. + + Ticks the number of ticks per given resolution type + Type of the resolution type + Thrown when failed to set time tick frequency. + + + class MyApp : WatchApplication + { + ... + public void TestMethod() + { + try + { + SetTimeTickFrequency(1, TimeTickResolution.TimeTicksPerMinute); + } + catch + { + } + } + } + + + + + + Gets the frequency fo time tick. + + Ticks the number of ticks per given resolution type + Type of the resolution type + Thrown when failed to get time tick frequency. + + + class MyApp : WatchApplication + { + ... + public void TestMethod() + { + int tick; + TimeTickResolution tType; + try + { + GetTimeTickFrequency(out tick, out tType); + } + catch + { + } + } + } + + + + + + The information of Watch Time + + + + + The information of year + + + + + The information fo month + + + + + The information of day + + + + + The information of day of week + + + + + The information of hour + + + + + The information of hour for 24 hour form + + + + + The information of Minute + + + + + The information of second + + + + + The information of millisecond + + + + + The information of timezone + + + + + The information of UTC time stamp + + + + diff --git a/Artifacts/bin/Tizen.Applications.WidgetApplication.dll b/Artifacts/bin/Tizen.Applications.WidgetApplication.dll index a6ddc78..13454f8 100644 Binary files a/Artifacts/bin/Tizen.Applications.WidgetApplication.dll and b/Artifacts/bin/Tizen.Applications.WidgetApplication.dll differ diff --git a/Artifacts/bin/Tizen.Applications.WidgetApplication.pdb b/Artifacts/bin/Tizen.Applications.WidgetApplication.pdb index b103555..02949f5 100644 Binary files a/Artifacts/bin/Tizen.Applications.WidgetApplication.pdb and b/Artifacts/bin/Tizen.Applications.WidgetApplication.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.WidgetApplication.xml b/Artifacts/bin/Tizen.Applications.WidgetApplication.xml index 1df0275..ad852d5 100644 --- a/Artifacts/bin/Tizen.Applications.WidgetApplication.xml +++ b/Artifacts/bin/Tizen.Applications.WidgetApplication.xml @@ -1,133 +1,133 @@ - - - - Tizen.Applications.WidgetApplication - - - - - Represents a widget application. - - - - - Initializes the WidgetApplication class with the type and application ID. - - Map structure for the derived class type and widget ID. - - - - Initializes the WidgetApplication class with the type. - - Widget ID will be replaced as the application ID. - Derived class type. - - - - Gets all instances of the widget associated with the type. - - Class type for the widget. - - - - Runs the widget application's main loop. - - Arguments from the commandline. - - - - The abstract class for widget instances. - - - - - Window object for this widget instance. - It will be created after OnCreate method is invoked. - - - - - Delete type. - - - - - User deleted this widget from the viewer. - - - - - Widget is deleted because of other reasons. (For example, widget process is terminated temporarily by the system) - - - - - Constructor. - - - - - Sets the content information to the widget. - - The data set to save. - Thrown when failed because of an invalid argument. - Thrown when the API is not supported in this device. - Thrown in case of an unrecoverable error. - - - - Sends the title to the widget. - - When an accessibility mode is turned on, this string will be read. - Thrown when failed because of an invalid argument. - Thrown when the API is not supported in this device. - Thrown in case of an unrecoverable error. - - - - Finishes the context for the widget instance. - - Thrown when the API is not supported in this device. - Thrown in case of an unrecoverable error. - - - - Overrides this method if want to handle the behavior when the widget instance is started. - - The data set for the previous status. - The pixel value for the widget width. - The pixel value for the widget height. - - - - Overrides this method if want to handle the behavior when the widget instance is destroyed. - - The reason for destruction. - The data set to save. - - - - Overrides this method if want to handle the behavior when the widget instance is paused. - - - - - Overrides this method if want to handle the behavior when the widget instance is resumed. - - - - - Overrides this method if want to handle the behavior when the widget instance is resized. - - Widget width. - Widget height. - - - - Overrides this method if want to handle the behavior when the widget instance is updated. - - The data set for updating this widget will be provided by the requester. - Although the widget is paused, if it is true, the widget can be updated. - - - + + + + Tizen.Applications.WidgetApplication + + + + + Represents a widget application. + + + + + Initializes the WidgetApplication class with the type and application ID. + + Map structure for the derived class type and widget ID. + + + + Initializes the WidgetApplication class with the type. + + Widget ID will be replaced as the application ID. + Derived class type. + + + + Gets all instances of the widget associated with the type. + + Class type for the widget. + + + + Runs the widget application's main loop. + + Arguments from the commandline. + + + + The abstract class for widget instances. + + + + + Window object for this widget instance. + It will be created after OnCreate method is invoked. + + + + + Delete type. + + + + + User deleted this widget from the viewer. + + + + + Widget is deleted because of other reasons. (For example, widget process is terminated temporarily by the system) + + + + + Constructor. + + + + + Sets the content information to the widget. + + The data set to save. + Thrown when failed because of an invalid argument. + Thrown when the API is not supported in this device. + Thrown in case of an unrecoverable error. + + + + Sends the title to the widget. + + When an accessibility mode is turned on, this string will be read. + Thrown when failed because of an invalid argument. + Thrown when the API is not supported in this device. + Thrown in case of an unrecoverable error. + + + + Finishes the context for the widget instance. + + Thrown when the API is not supported in this device. + Thrown in case of an unrecoverable error. + + + + Overrides this method if want to handle the behavior when the widget instance is started. + + The data set for the previous status. + The pixel value for the widget width. + The pixel value for the widget height. + + + + Overrides this method if want to handle the behavior when the widget instance is destroyed. + + The reason for destruction. + The data set to save. + + + + Overrides this method if want to handle the behavior when the widget instance is paused. + + + + + Overrides this method if want to handle the behavior when the widget instance is resumed. + + + + + Overrides this method if want to handle the behavior when the widget instance is resized. + + Widget width. + Widget height. + + + + Overrides this method if want to handle the behavior when the widget instance is updated. + + The data set for updating this widget will be provided by the requester. + Although the widget is paused, if it is true, the widget can be updated. + + + diff --git a/Artifacts/bin/Tizen.Applications.WidgetControl.dll b/Artifacts/bin/Tizen.Applications.WidgetControl.dll index 4c0acda..8b6c879 100644 Binary files a/Artifacts/bin/Tizen.Applications.WidgetControl.dll and b/Artifacts/bin/Tizen.Applications.WidgetControl.dll differ diff --git a/Artifacts/bin/Tizen.Applications.WidgetControl.pdb b/Artifacts/bin/Tizen.Applications.WidgetControl.pdb index 6f0de16..606dcb0 100644 Binary files a/Artifacts/bin/Tizen.Applications.WidgetControl.pdb and b/Artifacts/bin/Tizen.Applications.WidgetControl.pdb differ diff --git a/Artifacts/bin/Tizen.Applications.WidgetControl.xml b/Artifacts/bin/Tizen.Applications.WidgetControl.xml index d9dfbc0..2b7a9b0 100644 --- a/Artifacts/bin/Tizen.Applications.WidgetControl.xml +++ b/Artifacts/bin/Tizen.Applications.WidgetControl.xml @@ -1,317 +1,317 @@ - - - - Tizen.Applications.WidgetControl - - - - - The class for receiving widget events and sending data to the widget. - - - - - Class for the widget instance. - - - - - The widget ID. - - 3 - - - - Gets the widget content. - - 3 - Thrown in case of failed conditions. - - - - Changes the content for the widget instance. - - 3 - Content to be changed. - True if you want to update your widget even if the provider is paused, otherwise false. - Thrown when failed because of an invalid argument. - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - Changes the update period for the widget instance. - - 3 - Thrown when failed because of an invalid argument. - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The class for the widget size information. - - - - - Enumeration for the types of widget size. - - 3 - - - - 175x175 based on 720x1280 resolution. - - - - - 354x175 based on 720x1280 resolution. - - - - - 354x354 based on 720x1280 resolution. - - - - - 712x175 based on 720x1280 resolution. - - - - - 712x354 based on 720x1280 resolution. - - - - - 712x533 based on 720x1280 resolution. - - - - - 712x712 based on 720x1280 resolution. - - - - - 712x891 based on 720x1280 resolution. - - - - - 712x1070 based on 720x1280 resolution. - - - - - 224x215 based on 720x1280 resolution. - - - - - 680x215 based on 720x1280 resolution. - - - - - 680x653 based on 720x1280 resolution. - - - - - 720x1280 based on 720x1280 resolution. - - - - - Widget width. - - 3 - - - - Widget height. - - 3 - - - - The path for the widget preview image file. - - 3 - - - - The size type of the widget. - - 3 - - - - Factory method for the WidgetControl. - It will create all the objects of WidgetControl based on the package ID. - - 3 - Package ID. - http://tizen.org/privilege/widget.viewer - Thrown when failed because of an invalid argument. - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - Gets all the widget IDs by the package ID. - - 3 - http://tizen.org/privilege/widget.viewer - Thrown when failed because of an invalid argument. - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The widget ID. - - 3 - - - - The flag value for "nodisplay". - - 3 - http://tizen.org/privilege/widget.viewer - - - - The event handler for a created widget instance. - - 3 - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The event handler for a resumed widget instance. - - 3 - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The event handler for a paused widget instance. - - 3 - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The event handler for a destroyed widget instance. - - 3 - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - The constructor of the WidgetControl object. - - 3 - Widget ID. - - - - Finalizer of the WidgetControl class. - - - - - Gets the objects for widget instance information. - - 3 - Thrown in case of failed conditions. - Thrown when the API is not supported in this device. - Thrown when an application does not have the privilege to access this method. - - - - Gets the objects for widget scale information. - - 3 - http://tizen.org/privilege/widget.viewer - Thrown in case of failed conditions. - Thrown when an application does not have the privilege to access this method. - - - - Gets the widget name. - - 3 - Language. - http://tizen.org/privilege/widget.viewer - Thrown when the argument is null. - - - - Gets the widget icon path. - - 3 - Language. - http://tizen.org/privilege/widget.viewer - Thrown when the argument is null. - - - - Releases all the resources used by the WidgetControl class. - - 3 - - - - The class for event arguments of the widget lifecycle. - - - - - Enumeration for the event type. - - - - - The widget is created. - - - - - The widget is destroyed. - - - - - The widget is paused. - - - - - The widget is resumed. - - - - - The widget ID. - - - - - The widget instance ID. - - - - - The event type. - - - - + + + + Tizen.Applications.WidgetControl + + + + + The class for receiving widget events and sending data to the widget. + + + + + Class for the widget instance. + + + + + The widget ID. + + 3 + + + + Gets the widget content. + + 3 + Thrown in case of failed conditions. + + + + Changes the content for the widget instance. + + 3 + Content to be changed. + True if you want to update your widget even if the provider is paused, otherwise false. + Thrown when failed because of an invalid argument. + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + Changes the update period for the widget instance. + + 3 + Thrown when failed because of an invalid argument. + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The class for the widget size information. + + + + + Enumeration for the types of widget size. + + 3 + + + + 175x175 based on 720x1280 resolution. + + + + + 354x175 based on 720x1280 resolution. + + + + + 354x354 based on 720x1280 resolution. + + + + + 712x175 based on 720x1280 resolution. + + + + + 712x354 based on 720x1280 resolution. + + + + + 712x533 based on 720x1280 resolution. + + + + + 712x712 based on 720x1280 resolution. + + + + + 712x891 based on 720x1280 resolution. + + + + + 712x1070 based on 720x1280 resolution. + + + + + 224x215 based on 720x1280 resolution. + + + + + 680x215 based on 720x1280 resolution. + + + + + 680x653 based on 720x1280 resolution. + + + + + 720x1280 based on 720x1280 resolution. + + + + + Widget width. + + 3 + + + + Widget height. + + 3 + + + + The path for the widget preview image file. + + 3 + + + + The size type of the widget. + + 3 + + + + Factory method for the WidgetControl. + It will create all the objects of WidgetControl based on the package ID. + + 3 + Package ID. + http://tizen.org/privilege/widget.viewer + Thrown when failed because of an invalid argument. + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + Gets all the widget IDs by the package ID. + + 3 + http://tizen.org/privilege/widget.viewer + Thrown when failed because of an invalid argument. + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The widget ID. + + 3 + + + + The flag value for "nodisplay". + + 3 + http://tizen.org/privilege/widget.viewer + + + + The event handler for a created widget instance. + + 3 + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The event handler for a resumed widget instance. + + 3 + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The event handler for a paused widget instance. + + 3 + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The event handler for a destroyed widget instance. + + 3 + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + The constructor of the WidgetControl object. + + 3 + Widget ID. + + + + Finalizer of the WidgetControl class. + + + + + Gets the objects for widget instance information. + + 3 + Thrown in case of failed conditions. + Thrown when the API is not supported in this device. + Thrown when an application does not have the privilege to access this method. + + + + Gets the objects for widget scale information. + + 3 + http://tizen.org/privilege/widget.viewer + Thrown in case of failed conditions. + Thrown when an application does not have the privilege to access this method. + + + + Gets the widget name. + + 3 + Language. + http://tizen.org/privilege/widget.viewer + Thrown when the argument is null. + + + + Gets the widget icon path. + + 3 + Language. + http://tizen.org/privilege/widget.viewer + Thrown when the argument is null. + + + + Releases all the resources used by the WidgetControl class. + + 3 + + + + The class for event arguments of the widget lifecycle. + + + + + Enumeration for the event type. + + + + + The widget is created. + + + + + The widget is destroyed. + + + + + The widget is paused. + + + + + The widget is resumed. + + + + + The widget ID. + + + + + The widget instance ID. + + + + + The event type. + + + + diff --git a/Artifacts/bin/Tizen.CallManager.dll b/Artifacts/bin/Tizen.CallManager.dll index 9591fa2..506203c 100644 Binary files a/Artifacts/bin/Tizen.CallManager.dll and b/Artifacts/bin/Tizen.CallManager.dll differ diff --git a/Artifacts/bin/Tizen.CallManager.pdb b/Artifacts/bin/Tizen.CallManager.pdb index 931a149..d6fa858 100644 Binary files a/Artifacts/bin/Tizen.CallManager.pdb and b/Artifacts/bin/Tizen.CallManager.pdb differ diff --git a/Artifacts/bin/Tizen.CallManager.xml b/Artifacts/bin/Tizen.CallManager.xml index 13b73ba..7cad3d4 100644 --- a/Artifacts/bin/Tizen.CallManager.xml +++ b/Artifacts/bin/Tizen.CallManager.xml @@ -1,1359 +1,1359 @@ - - - - Tizen.CallManager - - - - - Interop class for CallManager - - - - - CallManager Native Apis - - - - - A class which defines the properties of call. - - - - - Gets call id. - - - - - Gets call direction(MO or MT). - - - - - Get the call number. - - - - - Get the contact name of calling number. - - - - - Get the call type(Voice call or Video call). - - - - - Get the call state(Incoming, Active, etc). - - - - - Get the member count. - - - - - Checks if the call is emergency call. - - - - - Checks if the number is voice mail number. - - - - - Get the call domain(PS call, CS call, etc). - - - - - Get the person ID. - - - - - Get the start time of the call. - - - - - Get the contact name mode. - - - - - Get the session ID of the call. - - - - - Checks if HD is enabled for calling. - - - - - Checks if the call is a WiFi call. - - - - - Checks if upgrade/downgrade is enabled. - - - - - Checks if the remote call is on hold. - - - - - Checks if the call is added to conference. - - - - - Checks if the incoming call is a forwarded call. - - - - - A class which contains information about call event data. - - - - - Get the Call id of the number for which Call event has occurred. - - - - - Get the Sim slot type. - - - - - Get call end cause type. - - - - - Get incoming call data. - - - - - Get active call data. - - - - - Get the call data for held call. - - - - - A class which manages the use of Call Manager APIs. - - - - - Initializes the call manager. - - An instance of CmClientHandle class to use call manager APIs. - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when method failed due to invalid operation. - - - - Deinitializes the Call Manager handle. - - The Call Manager handle to be deinitialized. - Thrown when CmClientHandle is passed as null. - Thrown when method failed due to invalid operation. - - - - Sets LCD state for the device display. - - LCD state to be set. - Thrown when method failed due to invalid operation. - - - - A class which manages call manager events, properties and functions. - - - - - This event is raised when call status changes. - - - - - This event is raised when the mute status changes. - - - - - This event is raised when call events change. - - - - - This event is raised when dial status changes. - - - - - This event is raised when audio status changes. - - - - - This event is raised during DTMF indication. - - - - - This event is raised when call comes to foreground. - - - - - This event is raised when voice record status is changed. - - - - - Gets the mute status. - - - - - Gets the audio state. - - - - - Gets the list of call data. - - - - - Gets the list of conference call data. - - - - - Rejects the incoming call. - - partner - http://developer.samsung.com/tizen/privilege/call.reject - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Starts incoming call alert ringtone. - - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Stops incoming call alert ringtone. - - partner - http://developer.samsung.com/tizen/privilege/call.reject - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Enables call recovery. - - App ID to be recovered. - Thrown appId is passed as null. - Thrown when method failed due to invalid operation. - - - - Dials a call. - - Calling number to be dialed. - Type of the call to be dialed. - Multi sim slot type in which the call is dialed. - Thrown when privilege access is denied. - Thrown number is passed as null. - Thrown when method failed due to invalid operation. - - - - Swaps the calls. - - Thrown when method failed due to invalid operation. - - - - Joins a call with another. - - Thrown when method failed due to invalid operation. - - - - Splits a call. - - Call id to be splitted. - Thrown when method failed due to invalid operation. - - - - Transfers a call. - - Thrown when method failed due to invalid operation. - - - - Accepts MT ViLTE call as VoLTE. - - Call answer type. - Call type. - Thrown when method failed due to invalid operation. - - - - Answers an incoming call. - - Call answer type. - Thrown when method failed due to invalid operation. - - - - Upgrades a call. - - Thrown when method failed due to invalid operation. - - - - Downgrades a call. - - Thrown when method failed due to invalid operation. - - - - Confirms upgrade call request. - - Upgrade response type. - Thrown when method failed due to invalid operation. - - - - Sets the speaker on/off. - - Status of the speaker to be set. - Thrown when method failed due to invalid operation. - - - - Sets the bluetooth feature on/off. - - Status of the bluetooth to be set. - Thrown when method failed due to invalid operation. - - - - Sets extra volume if needed. - - Boolean value to indicate if the call is set to have extra volume. - Thrown when method failed due to invalid operation. - - - - Sets the noise reduction feature during call. - - Boolean value to indicate whether the call needs noise reduction. - Thrown when method failed due to invalid operation. - - - - Sets the mute state of the call. - - Mute state to be set. - Thrown when method failed due to invalid operation. - - - - Starts sending signal through DTMF digit. - - DTMF digit to be pressed on the phone. - Thrown when method failed due to invalid parameter. - Thrown when method failed due to invalid operation. - - - - Stops sending DTMF signal. - - Thrown when method failed due to invalid operation. - - - - Sends signal through DTMF digits. - - DTMF digits. - Thrown when dtmfDigits is passed as null. - Thrown when method failed due to invalid operation. - - - - Sends DTMF response. - - DTMF response type. - Thrown when method failed due to invalid operation. - - - - Activates call manager UI. - - Thrown when method failed due to invalid operation. - - - - Sets device LCD time out. - - LCD timeout to be set. - Thrown when method failed due to invalid operation. - - - - Starts voice recording. - - Call number. - Thrown when number is passed as null. - Thrown when method failed due to invalid operation. - - - - Stops voice record. - - Thrown when method failed due to invalid operation. - - - - Gets all current call data. - - Incoming calldata instance to be filled. - Active calldata instance to be filled. - Held calldata instance to be filled. - Thrown when method failed due to invalid operation. - - - - Holds the active call. - - platform - http://developer.samsung.com/tizen/privilege/call.admin - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Unholds the active call. - - platform - http://developer.samsung.com/tizen/privilege/call.admin - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Ends ongoing call. - - ID of the call which is to be ended. - Call release type. - platform - http://developer.samsung.com/tizen/privilege/call.admin - Thrown when privilege access is denied. - Thrown when method failed due to invalid operation. - - - - Enumeration for Call status. - - - - - Call is in idle state. - - - - - A new call arrived and is ringing or waiting. - - - - - At least one call exist that is in dialing, alerting, active, on hold state. - - - - - Max state. - - - - - Enumeration for Mute status. - - - - - Mute state is off. - - - - - Mute state is on. - - - - - Max status. - - - - - Enumeration for call dial status. - - - - - Dial status is success. - - - - - Dial status is cancel. - - - - - Dial status is fail. - - - - - Dial status is fail SS. - - - - - Dial status is fail FDN. - - - - - Dial status is fail flight mode. - - - - - Enumeration for DTMF indication type. - - - - - DTMF indication type is idle. - - - - - DTMF indication type is progressing. - - - - - DTMF indication type is wait. - - - - - Enumeration for audio state type. - - - - - None. - - - - - System LoudSpeaker path. - - - - - System Receiver. - - - - - Earjack path. - - - - - System BT Headset path. - - - - - Enumeration for video record status. - - - - - Video recording is started. - - - - - Video recording is stopped. - - - - - Enumeration for Video record status extra type. - - - - - Start. - - - - - Normal recording. - - - - - Answering message. - - - - - Start max. - - - - - Stop. - - - - - Stop by normal. - - - - - Stop by max size. - - - - - Stop by no free space. - - - - - Stop by time limit. - - - - - Error. - - - - - Stop by max. - - - - - Enumeration for call type. - - - - - Voice call type. - - - - - Video call type. - - - - - Invalid call type. - - - - - Enumeration for sim slot type. - - - - - Sim slot 1. - - - - - Sim slot 2. - - - - - Follow system configuration. - - - - - Enumeration for call answer types for accepting the incoming call. - - - - - Only single call exist, Accept the Incoming call. - - - - - Put the active call on hold and accepts the call. - - - - - Releases the active call and accept the call. - - - - - Releases the held call and accept the call. - - - - - Releases all calls and accept the call. - - - - - Enumeration for call upgrade response type while receiving upgrade request. - - - - - Accept incoming upgrade request. - - - - - Reject Incoming upgrade request. - - - - - Enumeration for feature(speaker/bluetooth) status. - - - - - On. - - - - - Off. - - - - - Enumeration for DTMF response type. - - - - - Cancel. - - - - - Continue. - - - - - Enumeration for LCD time out. - - - - - Set. - - - - - Unset. - - - - - After lock-screen comes in Connected state LCD goes to OFF in 5 secs. - - - - - When Keypad is ON, LCD goes to DIM in 3 secs then goes to OFF in 5 secs. - - - - - Default. - - - - - Enumeration for contact name mode. - - - - - None. - - - - - Unknown. - - - - - Private. - - - - - Payphone. - - - - - Enumeration for LCD control state. - - - - - Off. - - - - - On. - - - - - On lock. - - - - - On unlock. - - - - - Off sleep lock. - - - - - Off sleep unlock. - - - - - Enumeration for call event type. - - - - - Call Idle event. - - - - - Call Dialling event. - - - - - Call Active event. - - - - - Call Held event. - - - - - Call Alert event. - - - - - Call Incoming event. - - - - - Call Waiting event. - - - - - Call Join event. - - - - - Call Split event. - - - - - Call Swapped event. - - - - - Call Retrieved event. - - - - - Sat call control event. - - - - - Call upgrade request event. - - - - - Call downgraded event. - - - - - Call upgrade success event. - - - - - Call upgrade failure event. - - - - - Call downgrade success event. - - - - - Call downgrade failure event. - - - - - Call confirm upgrade success event. - - - - - Call confirm upgrade failure event. - - - - - VoWiFi ~ LTE hand-over update event. - - - - - Enumeration for call direction - - - - - MO call. - - - - - MT call. - - - - - Enumeration for the call state. - - - - - Call is in idle state. - - - - - Call is in connected and conversation state. - - - - - Call is in held state. - - - - - Call is in dialing state. - - - - - Call is in alerting state. - - - - - Call is in incoming state. - - - - - Call is in answered state, and waiting for connected indication event. - - - - - Enumeration for call domain. - - - - - CS call domain. - - - - - PS call domain. - - - - - Wearable call through BT handsfree profile. - - - - - Enumeration for call end cause type. - - - - - Call ended. - - - - - Call disconnected. - - - - - Service not allowed. - - - - - Call barred. - - - - - No service. - - - - - Network busy. - - - - - Network failed. - - - - - No answer from other party. - - - - - No credit available. - - - - - Call rejected. - - - - - User busy. - - - - - Wrong group. - - - - - Call not allowed. - - - - - Tapi error. - - - - - Call failed. - - - - - User not responding. - - - - - User alerting no answer. - - - - - Circuit Channel Unavailable,Network is out of Order,Switching equipment congestion,Temporary Failure. - - - - - Called Party Rejects the Call. - - - - - Entered number is invalid or incomplete. - - - - - Entered number has been changed. - - - - - Unassigned/Unallocated number. - - - - - Called Party does not respond. - - - - - IMEI rejected. - - - - - FDN number only. - - - - - SAT call control reject. - - - - - This number cannot receive video calls. - - - - - Enumeration for call release type. - - - - - Release call using given call handle. - - - - - Release all Calls. - - - - - Releases all hold calls. - - - - - Releases all active calls. - - - - - An extended EventArgs class which contains information about DTMF indication. - - - - - DTMF indication. - - - - - DTMF number. - - - - - An extended EventArgs class which contains changed audio status. - - - - - Audio state. - - - - - An extended EventArgs class which contains changed voice record status. - - - - - Voice record status. - - - - - Voice record status extra type. - - - - - An extended EventArgs class which contains changed call mute status. - - - - - Call mute status. - - - - - An extended EventArgs class which contains changed call status. - - - - - Call status. - - - - - Call number. - - - - - An extended EventArgs class which contains changed dial status. - - - - - Dial status. - - - - - An extended EventArgs class which contains changed call event. - - - - - Call event. - - - - - Call event data. - - - - - A class which defines the properties of conference call. - - - - - Conference call ID. - - - - - Call number. - - - - - Person ID. - - - - - Call name mode. - - - - + + + + Tizen.CallManager + + + + + Interop class for CallManager + + + + + CallManager Native Apis + + + + + A class which defines the properties of call. + + + + + Gets call id. + + + + + Gets call direction(MO or MT). + + + + + Get the call number. + + + + + Get the contact name of calling number. + + + + + Get the call type(Voice call or Video call). + + + + + Get the call state(Incoming, Active, etc). + + + + + Get the member count. + + + + + Checks if the call is emergency call. + + + + + Checks if the number is voice mail number. + + + + + Get the call domain(PS call, CS call, etc). + + + + + Get the person ID. + + + + + Get the start time of the call. + + + + + Get the contact name mode. + + + + + Get the session ID of the call. + + + + + Checks if HD is enabled for calling. + + + + + Checks if the call is a WiFi call. + + + + + Checks if upgrade/downgrade is enabled. + + + + + Checks if the remote call is on hold. + + + + + Checks if the call is added to conference. + + + + + Checks if the incoming call is a forwarded call. + + + + + A class which contains information about call event data. + + + + + Get the Call id of the number for which Call event has occurred. + + + + + Get the Sim slot type. + + + + + Get call end cause type. + + + + + Get incoming call data. + + + + + Get active call data. + + + + + Get the call data for held call. + + + + + A class which manages the use of Call Manager APIs. + + + + + Initializes the call manager. + + An instance of CmClientHandle class to use call manager APIs. + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when method failed due to invalid operation. + + + + Deinitializes the Call Manager handle. + + The Call Manager handle to be deinitialized. + Thrown when CmClientHandle is passed as null. + Thrown when method failed due to invalid operation. + + + + Sets LCD state for the device display. + + LCD state to be set. + Thrown when method failed due to invalid operation. + + + + A class which manages call manager events, properties and functions. + + + + + This event is raised when call status changes. + + + + + This event is raised when the mute status changes. + + + + + This event is raised when call events change. + + + + + This event is raised when dial status changes. + + + + + This event is raised when audio status changes. + + + + + This event is raised during DTMF indication. + + + + + This event is raised when call comes to foreground. + + + + + This event is raised when voice record status is changed. + + + + + Gets the mute status. + + + + + Gets the audio state. + + + + + Gets the list of call data. + + + + + Gets the list of conference call data. + + + + + Rejects the incoming call. + + partner + http://developer.samsung.com/tizen/privilege/call.reject + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Starts incoming call alert ringtone. + + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Stops incoming call alert ringtone. + + partner + http://developer.samsung.com/tizen/privilege/call.reject + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Enables call recovery. + + App ID to be recovered. + Thrown appId is passed as null. + Thrown when method failed due to invalid operation. + + + + Dials a call. + + Calling number to be dialed. + Type of the call to be dialed. + Multi sim slot type in which the call is dialed. + Thrown when privilege access is denied. + Thrown number is passed as null. + Thrown when method failed due to invalid operation. + + + + Swaps the calls. + + Thrown when method failed due to invalid operation. + + + + Joins a call with another. + + Thrown when method failed due to invalid operation. + + + + Splits a call. + + Call id to be splitted. + Thrown when method failed due to invalid operation. + + + + Transfers a call. + + Thrown when method failed due to invalid operation. + + + + Accepts MT ViLTE call as VoLTE. + + Call answer type. + Call type. + Thrown when method failed due to invalid operation. + + + + Answers an incoming call. + + Call answer type. + Thrown when method failed due to invalid operation. + + + + Upgrades a call. + + Thrown when method failed due to invalid operation. + + + + Downgrades a call. + + Thrown when method failed due to invalid operation. + + + + Confirms upgrade call request. + + Upgrade response type. + Thrown when method failed due to invalid operation. + + + + Sets the speaker on/off. + + Status of the speaker to be set. + Thrown when method failed due to invalid operation. + + + + Sets the bluetooth feature on/off. + + Status of the bluetooth to be set. + Thrown when method failed due to invalid operation. + + + + Sets extra volume if needed. + + Boolean value to indicate if the call is set to have extra volume. + Thrown when method failed due to invalid operation. + + + + Sets the noise reduction feature during call. + + Boolean value to indicate whether the call needs noise reduction. + Thrown when method failed due to invalid operation. + + + + Sets the mute state of the call. + + Mute state to be set. + Thrown when method failed due to invalid operation. + + + + Starts sending signal through DTMF digit. + + DTMF digit to be pressed on the phone. + Thrown when method failed due to invalid parameter. + Thrown when method failed due to invalid operation. + + + + Stops sending DTMF signal. + + Thrown when method failed due to invalid operation. + + + + Sends signal through DTMF digits. + + DTMF digits. + Thrown when dtmfDigits is passed as null. + Thrown when method failed due to invalid operation. + + + + Sends DTMF response. + + DTMF response type. + Thrown when method failed due to invalid operation. + + + + Activates call manager UI. + + Thrown when method failed due to invalid operation. + + + + Sets device LCD time out. + + LCD timeout to be set. + Thrown when method failed due to invalid operation. + + + + Starts voice recording. + + Call number. + Thrown when number is passed as null. + Thrown when method failed due to invalid operation. + + + + Stops voice record. + + Thrown when method failed due to invalid operation. + + + + Gets all current call data. + + Incoming calldata instance to be filled. + Active calldata instance to be filled. + Held calldata instance to be filled. + Thrown when method failed due to invalid operation. + + + + Holds the active call. + + platform + http://developer.samsung.com/tizen/privilege/call.admin + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Unholds the active call. + + platform + http://developer.samsung.com/tizen/privilege/call.admin + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Ends ongoing call. + + ID of the call which is to be ended. + Call release type. + platform + http://developer.samsung.com/tizen/privilege/call.admin + Thrown when privilege access is denied. + Thrown when method failed due to invalid operation. + + + + Enumeration for Call status. + + + + + Call is in idle state. + + + + + A new call arrived and is ringing or waiting. + + + + + At least one call exist that is in dialing, alerting, active, on hold state. + + + + + Max state. + + + + + Enumeration for Mute status. + + + + + Mute state is off. + + + + + Mute state is on. + + + + + Max status. + + + + + Enumeration for call dial status. + + + + + Dial status is success. + + + + + Dial status is cancel. + + + + + Dial status is fail. + + + + + Dial status is fail SS. + + + + + Dial status is fail FDN. + + + + + Dial status is fail flight mode. + + + + + Enumeration for DTMF indication type. + + + + + DTMF indication type is idle. + + + + + DTMF indication type is progressing. + + + + + DTMF indication type is wait. + + + + + Enumeration for audio state type. + + + + + None. + + + + + System LoudSpeaker path. + + + + + System Receiver. + + + + + Earjack path. + + + + + System BT Headset path. + + + + + Enumeration for video record status. + + + + + Video recording is started. + + + + + Video recording is stopped. + + + + + Enumeration for Video record status extra type. + + + + + Start. + + + + + Normal recording. + + + + + Answering message. + + + + + Start max. + + + + + Stop. + + + + + Stop by normal. + + + + + Stop by max size. + + + + + Stop by no free space. + + + + + Stop by time limit. + + + + + Error. + + + + + Stop by max. + + + + + Enumeration for call type. + + + + + Voice call type. + + + + + Video call type. + + + + + Invalid call type. + + + + + Enumeration for sim slot type. + + + + + Sim slot 1. + + + + + Sim slot 2. + + + + + Follow system configuration. + + + + + Enumeration for call answer types for accepting the incoming call. + + + + + Only single call exist, Accept the Incoming call. + + + + + Put the active call on hold and accepts the call. + + + + + Releases the active call and accept the call. + + + + + Releases the held call and accept the call. + + + + + Releases all calls and accept the call. + + + + + Enumeration for call upgrade response type while receiving upgrade request. + + + + + Accept incoming upgrade request. + + + + + Reject Incoming upgrade request. + + + + + Enumeration for feature(speaker/bluetooth) status. + + + + + On. + + + + + Off. + + + + + Enumeration for DTMF response type. + + + + + Cancel. + + + + + Continue. + + + + + Enumeration for LCD time out. + + + + + Set. + + + + + Unset. + + + + + After lock-screen comes in Connected state LCD goes to OFF in 5 secs. + + + + + When Keypad is ON, LCD goes to DIM in 3 secs then goes to OFF in 5 secs. + + + + + Default. + + + + + Enumeration for contact name mode. + + + + + None. + + + + + Unknown. + + + + + Private. + + + + + Payphone. + + + + + Enumeration for LCD control state. + + + + + Off. + + + + + On. + + + + + On lock. + + + + + On unlock. + + + + + Off sleep lock. + + + + + Off sleep unlock. + + + + + Enumeration for call event type. + + + + + Call Idle event. + + + + + Call Dialling event. + + + + + Call Active event. + + + + + Call Held event. + + + + + Call Alert event. + + + + + Call Incoming event. + + + + + Call Waiting event. + + + + + Call Join event. + + + + + Call Split event. + + + + + Call Swapped event. + + + + + Call Retrieved event. + + + + + Sat call control event. + + + + + Call upgrade request event. + + + + + Call downgraded event. + + + + + Call upgrade success event. + + + + + Call upgrade failure event. + + + + + Call downgrade success event. + + + + + Call downgrade failure event. + + + + + Call confirm upgrade success event. + + + + + Call confirm upgrade failure event. + + + + + VoWiFi ~ LTE hand-over update event. + + + + + Enumeration for call direction + + + + + MO call. + + + + + MT call. + + + + + Enumeration for the call state. + + + + + Call is in idle state. + + + + + Call is in connected and conversation state. + + + + + Call is in held state. + + + + + Call is in dialing state. + + + + + Call is in alerting state. + + + + + Call is in incoming state. + + + + + Call is in answered state, and waiting for connected indication event. + + + + + Enumeration for call domain. + + + + + CS call domain. + + + + + PS call domain. + + + + + Wearable call through BT handsfree profile. + + + + + Enumeration for call end cause type. + + + + + Call ended. + + + + + Call disconnected. + + + + + Service not allowed. + + + + + Call barred. + + + + + No service. + + + + + Network busy. + + + + + Network failed. + + + + + No answer from other party. + + + + + No credit available. + + + + + Call rejected. + + + + + User busy. + + + + + Wrong group. + + + + + Call not allowed. + + + + + Tapi error. + + + + + Call failed. + + + + + User not responding. + + + + + User alerting no answer. + + + + + Circuit Channel Unavailable,Network is out of Order,Switching equipment congestion,Temporary Failure. + + + + + Called Party Rejects the Call. + + + + + Entered number is invalid or incomplete. + + + + + Entered number has been changed. + + + + + Unassigned/Unallocated number. + + + + + Called Party does not respond. + + + + + IMEI rejected. + + + + + FDN number only. + + + + + SAT call control reject. + + + + + This number cannot receive video calls. + + + + + Enumeration for call release type. + + + + + Release call using given call handle. + + + + + Release all Calls. + + + + + Releases all hold calls. + + + + + Releases all active calls. + + + + + An extended EventArgs class which contains information about DTMF indication. + + + + + DTMF indication. + + + + + DTMF number. + + + + + An extended EventArgs class which contains changed audio status. + + + + + Audio state. + + + + + An extended EventArgs class which contains changed voice record status. + + + + + Voice record status. + + + + + Voice record status extra type. + + + + + An extended EventArgs class which contains changed call mute status. + + + + + Call mute status. + + + + + An extended EventArgs class which contains changed call status. + + + + + Call status. + + + + + Call number. + + + + + An extended EventArgs class which contains changed dial status. + + + + + Dial status. + + + + + An extended EventArgs class which contains changed call event. + + + + + Call event. + + + + + Call event data. + + + + + A class which defines the properties of conference call. + + + + + Conference call ID. + + + + + Call number. + + + + + Person ID. + + + + + Call name mode. + + + + diff --git a/Artifacts/bin/Tizen.Content.Download.dll b/Artifacts/bin/Tizen.Content.Download.dll index d849729..50d1216 100644 Binary files a/Artifacts/bin/Tizen.Content.Download.dll and b/Artifacts/bin/Tizen.Content.Download.dll differ diff --git a/Artifacts/bin/Tizen.Content.Download.pdb b/Artifacts/bin/Tizen.Content.Download.pdb index 6a8cb66..91ba567 100644 Binary files a/Artifacts/bin/Tizen.Content.Download.pdb and b/Artifacts/bin/Tizen.Content.Download.pdb differ diff --git a/Artifacts/bin/Tizen.Content.Download.xml b/Artifacts/bin/Tizen.Content.Download.xml index 94cc2f5..1651bf2 100644 --- a/Artifacts/bin/Tizen.Content.Download.xml +++ b/Artifacts/bin/Tizen.Content.Download.xml @@ -1,576 +1,576 @@ - - - - Tizen.Content.Download - - - - - Enumeration for the download states. - - 3 - - - - Unhandled exception. - - 3 - - - - Ready to download. - - 3 - - - - Queued to start downloading. - - 3 - - - - Currently downloading. - - 3 - - - - The download is paused and can be resumed. - - 3 - - - - The download is completed. - - 3 - - - - The download failed. - - 3 - - - - A user canceled the download request. - - 3 - - - - Enumeration for the network types. - - 3 - - - - The download is available through data network. - - 3 - - - - The download is available through Wi-Fi. - - 3 - - - - The download is available through Wi-Fi Direct. - - 3 - - - - The download is available either through data network or Wi-Fi. - - 3 - - - - Enumeration for the notification types. - - 3 - - - - Do not register notification. - - 3 - - - - Completion notification for success state and failed state. - - 3 - - - - All download notifications for ongoing state, success state, and failed state. - - 3 - - - - The Notification class consists of all the properties required to set notifications for the download operation. - - 3 - - - - Title of the notification. - If a user tries to get before the setting, an empty string is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Description of the notification. - If a user tries to get before the setting, an empty string is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Type of the notification. - If a user tries to get before the setting, the default NotificationType none is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - AppControl for an ongoing download notification. - If a user tries to get before the setting, null is returned. - - 3 - http://tizen.org/privilege/download - - When the notification message is clicked, the action is decided by the application control. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - AppControl for a completed download notification. - If a user tries to get before the setting, null is returned. - - 3 - http://tizen.org/privilege/download - - When the notification message is clicked, the action is decided by the application control. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - AppControl for a failed download notification. - If a user tries to get before the setting, null is returned. - - 3 - http://tizen.org/privilege/download - - When the notification message is clicked, the action is decided by the application control. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - An extended EventArgs class which contains the size of received data in bytes. - - 3 - - - - The received data size in bytes. - - 3 - - - - The Request class provides the functions to create and manage a single download request. - - 3 - - - - Creates a Request object. - - 3 - The URL to download. - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Creates a Request object. - - 3 - The URL to download - The directory path where downloaded file is stored. - The name of the downloaded file. - The network type which the download request must adhere to. - http://tizen.org/privilege/download - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.wifi.direct - http://tizen.org/feature/network.telephony - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - Thrown when a feature is not supported. - - - - Creates a Request object. - - 3 - The URL to download. - The directory path where the downloaded file is stored. - The name of the downloaded file. - The network type which the download request must adhere to. - HTTP header fields for the download request. - http://tizen.org/privilege/download - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.wifi.direct - http://tizen.org/feature/network.telephony - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - Thrown when a feature is not supported. - - - - An event that occurs when the download state changes. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - An event that occurs when the download progress changes. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The absolute path where the file will be downloaded. - If you try to get this property value before calling Start(), an empty string is returned. - - 3 - http://tizen.org/privilege/download - - Returns an empty string if the download is not completed or if a state has not yet changed to completed or if any other error occurs. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The MIME type of the downloaded content. - If you try to get this property value before calling Start(), an empty string is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The current state of the download. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The content name of the downloaded file. - This can be defined with reference of the HTTP response header data. The content name can be received when the HTTP response header is received. - If you try to get this property value before calling Start(), an empty string is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The total size of the downloaded content. - This information is received from the server. If the server does not send the total size of the content, the content size is set to zero. - If you try to get this property value before calling Start(), 0 is returned. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The HTTP status code when a download exception occurs. - If you try to get this property value before calling Start(), 0 is returned. - - 3 - http://tizen.org/privilege/download - - The state of the download request must be DownlodState.Failed. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The ETag value from the HTTP response header when making a HTTP request for resume. - If you try to get this property value before calling Start() or if any other error occurs, an empty string is returned. - - 3 - http://tizen.org/privilege/download - - The ETag value is either available or not dependent on the web server. If not available, then, on getting the property, a null value is returned. - After the download is started, it can get the ETag value. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation - Thrown when a permission is denied. - - - - Contains properties required for creating download notifications. - - 3 - - When the notification message is clicked, the action taken by the system is decided by the application control properties of the NotificationProperties instance. - If the app control is not set, the following default operation is executed when the notification message is clicked: - 1) The download completed state - the viewer application is executed according to the extension name of the downloaded content. - 2) The download failed state and ongoing state - the client application is executed. - This property should be set before calling Start(). - - - - - The full path of the temporary file stores the downloaded content. - - 3 - http://tizen.org/privilege/download - - The download state must be one of the states after downloading. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The URL to download. - - 3 - http://tizen.org/privilege/download - - Should be set before calling Start(). - If you try to get this property value before setting or if any other error occurs, an empty string is returned. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The allowed network type for downloading the file. - The file will be downloaded only under the allowed network. - If you try to get this property value before setting or if any other error occurs, the default value NetworkType All is returned. - - 3 - http://tizen.org/privilege/download - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.wifi.direct - http://tizen.org/feature/network.telephony - - Should be set before calling Start(). - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - Thrown when feature is not supported. - - - - The file will be downloaded to the set the destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to the default storage. - If you try to get this property value before setting or if any other error occurs, an empty string is returned. - - 3 - http://tizen.org/privilege/download - - Should be set before calling Start(). - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The file will be saved in the specified destination or the default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination. - If you try to get this property value before setting or if any other error occurs, an empty string is returned. - - 3 - http://tizen.org/privilege/download - - Should be set before calling Start(). - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Enables or disables auto download. - If this option is enabled, the previous downloading item is restarted automatically as soon as the download daemon is restarted. The download progress continues after the client process is terminated. - If you try to get this property value before setting, the default value false is returned. - - 3 - http://tizen.org/privilege/download - - The default value is false. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - The HTTP header field and value pairs to the download request. - The HTTP header <field,value> pair is the <key,value> pair in the dictionary HttpHeaders. - The given HTTP header field will be included with the HTTP request of the download request. - If you try to get this property value before setting, an empty dictionary is returned. - - 3 - - HTTP header fields should be set before calling Start(). - HTTP header fields can be removed before calling Start(). - - - - - Sets the directory path of a temporary file used in a previous download request. - This is only useful when resuming download to make the HTTP request header at the client side. Otherwise, the path is ignored. - - 3 - http://tizen.org/privilege/download - - If the ETag value is not present in the download database, it is not useful to set the temporary file path. - When resuming the download request, the data is attached at the end of this temporary file. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Starts or resumes the download. - Starts to download the current URL, or resumes the download if paused. - - 3 - http://tizen.org/privilege/download - - The URL is the mandatory information to start the download. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Pauses the download request. - - 3 - http://tizen.org/privilege/download - - The paused download request can be restarted with Start() or canceled with Cancel(). - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Cancels the download request. - - 3 - http://tizen.org/privilege/download - - The canceled download can be restarted with Start(). - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Releases all the resources used by the Request class. - - 3 - http://tizen.org/privilege/download - - After calling this method, the download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data. - - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - Deletes the corresponding download request. - - 3 - http://tizen.org/privilege/download - Thrown when it is failed due to an invalid parameter. - Thrown when it is failed due to an invalid operation. - Thrown when a permission is denied. - - - - An extended EventArgs class which contains the changed download state. - - 3 - - - - The present download state. - - 3 - - - + + + + Tizen.Content.Download + + + + + Enumeration for the download states. + + 3 + + + + Unhandled exception. + + 3 + + + + Ready to download. + + 3 + + + + Queued to start downloading. + + 3 + + + + Currently downloading. + + 3 + + + + The download is paused and can be resumed. + + 3 + + + + The download is completed. + + 3 + + + + The download failed. + + 3 + + + + A user canceled the download request. + + 3 + + + + Enumeration for the network types. + + 3 + + + + The download is available through data network. + + 3 + + + + The download is available through Wi-Fi. + + 3 + + + + The download is available through Wi-Fi Direct. + + 3 + + + + The download is available either through data network or Wi-Fi. + + 3 + + + + Enumeration for the notification types. + + 3 + + + + Do not register notification. + + 3 + + + + Completion notification for success state and failed state. + + 3 + + + + All download notifications for ongoing state, success state, and failed state. + + 3 + + + + The Notification class consists of all the properties required to set notifications for the download operation. + + 3 + + + + Title of the notification. + If a user tries to get before the setting, an empty string is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Description of the notification. + If a user tries to get before the setting, an empty string is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Type of the notification. + If a user tries to get before the setting, the default NotificationType none is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + AppControl for an ongoing download notification. + If a user tries to get before the setting, null is returned. + + 3 + http://tizen.org/privilege/download + + When the notification message is clicked, the action is decided by the application control. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + AppControl for a completed download notification. + If a user tries to get before the setting, null is returned. + + 3 + http://tizen.org/privilege/download + + When the notification message is clicked, the action is decided by the application control. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + AppControl for a failed download notification. + If a user tries to get before the setting, null is returned. + + 3 + http://tizen.org/privilege/download + + When the notification message is clicked, the action is decided by the application control. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + An extended EventArgs class which contains the size of received data in bytes. + + 3 + + + + The received data size in bytes. + + 3 + + + + The Request class provides the functions to create and manage a single download request. + + 3 + + + + Creates a Request object. + + 3 + The URL to download. + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Creates a Request object. + + 3 + The URL to download + The directory path where downloaded file is stored. + The name of the downloaded file. + The network type which the download request must adhere to. + http://tizen.org/privilege/download + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.wifi.direct + http://tizen.org/feature/network.telephony + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + Thrown when a feature is not supported. + + + + Creates a Request object. + + 3 + The URL to download. + The directory path where the downloaded file is stored. + The name of the downloaded file. + The network type which the download request must adhere to. + HTTP header fields for the download request. + http://tizen.org/privilege/download + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.wifi.direct + http://tizen.org/feature/network.telephony + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + Thrown when a feature is not supported. + + + + An event that occurs when the download state changes. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + An event that occurs when the download progress changes. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The absolute path where the file will be downloaded. + If you try to get this property value before calling Start(), an empty string is returned. + + 3 + http://tizen.org/privilege/download + + Returns an empty string if the download is not completed or if a state has not yet changed to completed or if any other error occurs. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The MIME type of the downloaded content. + If you try to get this property value before calling Start(), an empty string is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The current state of the download. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The content name of the downloaded file. + This can be defined with reference of the HTTP response header data. The content name can be received when the HTTP response header is received. + If you try to get this property value before calling Start(), an empty string is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The total size of the downloaded content. + This information is received from the server. If the server does not send the total size of the content, the content size is set to zero. + If you try to get this property value before calling Start(), 0 is returned. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The HTTP status code when a download exception occurs. + If you try to get this property value before calling Start(), 0 is returned. + + 3 + http://tizen.org/privilege/download + + The state of the download request must be DownlodState.Failed. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The ETag value from the HTTP response header when making a HTTP request for resume. + If you try to get this property value before calling Start() or if any other error occurs, an empty string is returned. + + 3 + http://tizen.org/privilege/download + + The ETag value is either available or not dependent on the web server. If not available, then, on getting the property, a null value is returned. + After the download is started, it can get the ETag value. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation + Thrown when a permission is denied. + + + + Contains properties required for creating download notifications. + + 3 + + When the notification message is clicked, the action taken by the system is decided by the application control properties of the NotificationProperties instance. + If the app control is not set, the following default operation is executed when the notification message is clicked: + 1) The download completed state - the viewer application is executed according to the extension name of the downloaded content. + 2) The download failed state and ongoing state - the client application is executed. + This property should be set before calling Start(). + + + + + The full path of the temporary file stores the downloaded content. + + 3 + http://tizen.org/privilege/download + + The download state must be one of the states after downloading. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The URL to download. + + 3 + http://tizen.org/privilege/download + + Should be set before calling Start(). + If you try to get this property value before setting or if any other error occurs, an empty string is returned. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The allowed network type for downloading the file. + The file will be downloaded only under the allowed network. + If you try to get this property value before setting or if any other error occurs, the default value NetworkType All is returned. + + 3 + http://tizen.org/privilege/download + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.wifi.direct + http://tizen.org/feature/network.telephony + + Should be set before calling Start(). + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + Thrown when feature is not supported. + + + + The file will be downloaded to the set the destination file path. The downloaded file is saved to an auto-generated file name in the destination. If the destination is not specified, the file will be downloaded to the default storage. + If you try to get this property value before setting or if any other error occurs, an empty string is returned. + + 3 + http://tizen.org/privilege/download + + Should be set before calling Start(). + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The file will be saved in the specified destination or the default storage with the set file name. If the file name is not specified, the downloaded file will be saved with an auto-generated file name in the destination. + If you try to get this property value before setting or if any other error occurs, an empty string is returned. + + 3 + http://tizen.org/privilege/download + + Should be set before calling Start(). + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Enables or disables auto download. + If this option is enabled, the previous downloading item is restarted automatically as soon as the download daemon is restarted. The download progress continues after the client process is terminated. + If you try to get this property value before setting, the default value false is returned. + + 3 + http://tizen.org/privilege/download + + The default value is false. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + The HTTP header field and value pairs to the download request. + The HTTP header <field,value> pair is the <key,value> pair in the dictionary HttpHeaders. + The given HTTP header field will be included with the HTTP request of the download request. + If you try to get this property value before setting, an empty dictionary is returned. + + 3 + + HTTP header fields should be set before calling Start(). + HTTP header fields can be removed before calling Start(). + + + + + Sets the directory path of a temporary file used in a previous download request. + This is only useful when resuming download to make the HTTP request header at the client side. Otherwise, the path is ignored. + + 3 + http://tizen.org/privilege/download + + If the ETag value is not present in the download database, it is not useful to set the temporary file path. + When resuming the download request, the data is attached at the end of this temporary file. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Starts or resumes the download. + Starts to download the current URL, or resumes the download if paused. + + 3 + http://tizen.org/privilege/download + + The URL is the mandatory information to start the download. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Pauses the download request. + + 3 + http://tizen.org/privilege/download + + The paused download request can be restarted with Start() or canceled with Cancel(). + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Cancels the download request. + + 3 + http://tizen.org/privilege/download + + The canceled download can be restarted with Start(). + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Releases all the resources used by the Request class. + + 3 + http://tizen.org/privilege/download + + After calling this method, the download request related data exists in the download database for a certain period of time. Within that time, it is possible to use other APIs with this data. + + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + Deletes the corresponding download request. + + 3 + http://tizen.org/privilege/download + Thrown when it is failed due to an invalid parameter. + Thrown when it is failed due to an invalid operation. + Thrown when a permission is denied. + + + + An extended EventArgs class which contains the changed download state. + + 3 + + + + The present download state. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Content.MediaContent.dll b/Artifacts/bin/Tizen.Content.MediaContent.dll index 603b566..d668de1 100644 Binary files a/Artifacts/bin/Tizen.Content.MediaContent.dll and b/Artifacts/bin/Tizen.Content.MediaContent.dll differ diff --git a/Artifacts/bin/Tizen.Content.MediaContent.pdb b/Artifacts/bin/Tizen.Content.MediaContent.pdb index b71b2f9..34a7e68 100644 Binary files a/Artifacts/bin/Tizen.Content.MediaContent.pdb and b/Artifacts/bin/Tizen.Content.MediaContent.pdb differ diff --git a/Artifacts/bin/Tizen.Content.MediaContent.xml b/Artifacts/bin/Tizen.Content.MediaContent.xml index 280842d..8f1d293 100644 --- a/Artifacts/bin/Tizen.Content.MediaContent.xml +++ b/Artifacts/bin/Tizen.Content.MediaContent.xml @@ -1,4071 +1,4071 @@ - - - - Tizen.Content.MediaContent - - - - - Represents a logical collection grouping of related media info. - - - - - - Get the id of the album. - - The unique id of the album. - - - - Gets the artist name of the album. - - The artist name. - - - - Gets the path to the album art. - - The path to the album art. - - - - Gets the name of the album. - - The album name. - - - - Returns a string representation of the album. - - A string representation of the current album. - - - - Provides commands to manage albums in the database. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of albums. - - The number of albums. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of albums with . - - The criteria to use to filter. This value can be null. - The number of albums. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves all the albums. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the albums with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves an album with an album id. - - The id of the album to query with. - The if exists, otherwise null. - The is disconnected. - The has already been disposed of. - is equal to or less than zero. - An error occurred while executing the command. - - - - Retrieves the number of media info that belongs to the album. - - The id of the album to query with. - The number of media info. - The is disconnected. - The has already been disposed of. - is equal to or less than zero. - An error occurred while executing the command. - - - - Retrieves the number of media info that belongs to the album with .. - - The id of the album to count media. - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - is equal to or less than zero. - An error occurred while executing the command. - - - - Retrieves the media info of an album. - - The id of the album to select media. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the media info of an album with . - - The id of the album to query with. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Represents an audio media information. - - - - - Gets the album name. - - The album from the metadata. - - - - Gets the artist name. - - The artist from the metadata. - - - - Gets the album artist name. - - The album artist from the metadata. - - - - Gets the genre. - - The genre from the metadata. - - - - Gets the composer. - - The composer from the metadata. - - - - Gets the year. - - The year from the metadata. - - - - Gets the recorded date. - - The recorded date from the metadata. - - - - Gets the copyright. - - The copyright from the metadata. - - - - Gets the track number. - - The track number from the metadata. - - - - Gets the bit rate in bit per second. - - The bit rate in bit per second. - - - - Gets the bit per sample. - - The bit per sample. - - - - Gets the sample rate in hertz. - - The sample rate in hertz. - - - - Gets the number of channels. - - The number of channels. - - - - Gets the track duration in milliseconds. - - The track duration in milliseconds. - - - - Represents a media bookmark that allows you to mark interesting moment - in media(video and audio) to enable fast searching. - - - - - Gets the id of the bookmark. - - The id of the bookmark. - - - - Gets the thumbnail path of the bookmark. - - The thumbnail path of the bookmark. - - - - Gets the offset in milliseconds. - - The offset of the bookmark in media in milliseconds. - - - - Gets the name of the bookmark. - - The name of the bookmark. - - - - Returns a string representation of the bookmark. - - A string representation of the current bookmark. - - - - Provides commands to manage bookmarks in database. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of bookmarks. - - The number of bookmarks. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of bookmarks with . - - The criteria to use to filter. This value can be null. - The number of bookmarks. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Inserts new bookmark into the database with the specified media and offset. - - http://tizen.org/privilege/content.write - The media id to be associated with. - The time offset in milliseconds. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Inserts new bookmark into the database with the specified media id, offset and name. - - http://tizen.org/privilege/content.write - The media id to be associated with. - The time offset in milliseconds. - The name of the bookmark. This value can be null. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Inserts new bookmark into the database with the specified media id, offset, name and thumbnail path. - - http://tizen.org/privilege/content.write - - Thumbnail may be useful only when the media is video. - - The media id to be associated with. - The time offset in milliseconds. - The name of the bookmark. This value can be null. - The thumbnail path of the bookmark. This value can be null. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Deletes a bookmark from the database. - - http://tizen.org/privilege/content.write - The bookmark id to delete. - true if the matched record was found and deleted, otherwise false. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than zero. - The caller has no required privilege. - - - - Retrieves the bookmarks. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the bookmarks with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Provides the column names that can be used for Select and Count commands. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets the column name for the id of media. - - The column name for the id of media. - The value type is string. - - - - - Gets the column name for the path of media. - - The column name for the file path of media. - The value type is string. - - - - - Gets the column name for display name of media. - - The column name for the display name of media. - The value type is string. - - - - - Gets the column name for the type of media. - - The column name for the type of media. - - The value type is integer. - The value should be an integer that is one of values. - - - - - - Gets the column name for the mime type of media. - - The column name for the mime type of media. - The value type is string. - - - - - Gets the column name for the file size of media. - - The column name for the file size of media. - The value type is integer. - - - - - Gets the column name for the date added of media. - - The column name for the date added of media. - - The value type is integer. - needs to be converted into the unix time. - - - - - - - Gets the column name for the date modified of media. - - The column name for the date modified of media. - - The value type is integer. - needs to be converted into the unix time. - - - - - - - Gets the column name for the timeline of media. - - The column name for the timeline of media. - - The value type is integer. - needs to be converted into the unix time. - - - - - - - Gets the column name for the thumbnail path of media. - - The column name for the thumbnail path of media. - - The value type is string. - - - - - - Gets the column name for the title of media. - - The column name for the title of media. - - The value type is string. - - - - - - Gets the column name for the album of media. - - The column name for the album of media. - - The value type is string. - - - - - - Gets the column name for the artist of media. - - The column name for the artist of media. - - The value type is string. - - - - - - - Gets the column name for the album artist of media. - - The column name for the album artist of media. - - The value type is string. - - - - - - - Gets the column name for the genre of media. - - The column name for the genre of media. - - The value type is string. - - - - - - - Gets the column name for the composer of media. - - The column name for the composer of media. - - The value type is string. - - - - - - - Gets the column name for the year of media. - - The column name for the year of media. - - The value type is string. - - - - - - - Gets the column name for the date recorded of media. - - The column name for the date recorded of media. - - The value type is string. - - - - - - - Gets the column name for the copyright of media. - - The column name for the copyright of media. - - The value type is string. - - - - - - - Gets the column name for the track number of media. - - The column name for the track number of media. - - The value type is string. - - - - - - - Gets the column name for the description of media. - - The column name for the description of media. - - The value type is string. - - - - - - Gets the column name for the bit rate of media. - - The column name for the bit rate of media. - - The value type is integer. - - - - - - - Gets the column name for the bit per sample of media. - - The column name for the bit per sample of media. - - The value type is integer. - - - - - - Gets the column name for the sample rate of media. - - The column name for the sample rate of media. - - The value type is integer. - - - - - - Gets the column name for the channels of media. - - The column name for the channels of media. - - The value type is integer. - - - - - - Gets the column name for the duration of media. - - The column name for the duration of media. - - The value type is integer. - - - - - - - Gets the column name for the longitude of media. - - The column name for the longitude of media. - - The value type is real. - - - - - - Gets the column name for the latitude of media. - - The column name for the latitude of media. - - The value type is real. - - - - - - Gets the column name for the altitude of media. - - The column name for the altitude of media. - - The value type is real. - - - - - - Gets the column name for the width of media. - - The column name for the width of media. - - The value type is integer. - - - - - - - Gets the column name for the height of media. - - The column name for the height of media. - - The value type is integer. - - - - - - - Gets the column name for the date taken of media. - - The column name for the date taken of media. - - The value type is integer. - - - - - - Gets the column name for the orientation of media. - - The column name for the orientation of media. - - The value type is integer. - The value should be an integer that is one of values. - - - - - - - Gets the column name for the burst id of media. - - The column name for the burst id of media. - - The value type is string. - - - - - - Gets the column name for the rating of media. - - The column name for the rating of media. - - The value type is integer. - - - - - - Gets the column name for the favorite status of media. - - The column name for the favorite status of media. - - The value type is integer(1 : true, 0 : false). - - - - - - Gets the column name for the provider of media. - - The column name for the provider of media. - - The value type is string. - - - - - - Gets the column name for the category of media. - - The column name for the category of media. - - The value type is string. - - - - - - Gets the column name for the location tag of media. - - The column name for the location tag of media. - - The value type is string. - - - - - - Gets the column name for the age rating of media. - - The column name for the age rating of media. - - The value type is string. - - > - - - - Gets the column name for the weather information of media. - - The column name for the weather information of media. - - The value type is string. - - - - - - Gets the column name for the drm of media. - - The column name for the drm of media. - - The value type is integer(1 : true, 0 : false). - - - - - - Gets the column name for the storage type of media. - - The column name for the storage type of media. - - The value type is integer. - The value should be an integer that is one of values. - - - - - - Gets the column name for the exposure time of media. - - The column name for the exposure time of media. - - The value type is integer. - - - - - - Gets the column name for the FNumber of media. - - The column name for the FNumber of media. - - The value type is integer. - - - - - - Gets the column name for the iso of media. - - The column name for the iso of media. - - The value type is integer. - - - - - - Gets the column name for the model of media. - - The column name for the model of media. - - The value type is string. - - - - - - Provides the folder column names that can be used for Select and Count commands. - - - - - - - - - - - Gets the column name for the name of album. - - The column name for the name of album. - - The value type is string. - - - - - - Gets the column name for the artist of album. - - The column name for the artist of album. - - The value type is string. - - - - - - Provides the folder column names that can be used for Select and Count commands. - - - - - - - - - - - Gets the column name for the id of folder. - - The column name for the id of folder. - - The value type is string. - - - - - - Gets the column name for the path of folder. - - The column name for the path of folder. - - The value type is string. - - - - - - Gets the column name for the name of folder. - - The column name for the name of folder. - - The value type is string. - - - - - - Gets the column name for the storage type of folder. - - The column name for the storage type of folder. - - The value type is integer. - The value should be an integer that is one of values. - - - - - - Provides the playlist column names that can be used for Select and Count commands. - - - - - - - - - - - Gets the column name for the name of playlist. - - The column name for the name of playlist. - - The value type is string. - - - - - - Gets the column name for the id of playlist. - - The column name for the id of playlist. - - The value type is integer. - - - - - - Gets the column name for the member order of playlist. - - The column name for the member order of playlist. - - The value type is integer. - - - - - - Gets the column name for the number of members of playlist. - - The column name for the number of members of playlist. - - The value type is integer. - - - - - - - Provides the tag column names that can be used for . - - - - - - - - - - - - - - - Gets the column name for the name of tag. - - The column name for the name of tag. - - The value type is string. - - - - - - Gets the column name for the number of media of tag. - - The column name for the number of media of tag. - - The value type is integer. - - - - - - - Gets the column name for the id of tag. - - The column name for the id of tag. - - The value type is integer. - - - - - - Provides the bookmark column names that can be used for Select and Count commands. - - - - - - - - - - - - - Gets the column name for offset of bookmark. - - The column name for the offset of bookmark. - - The value type is integer. - - - - - - Gets the column name for the id of bookmark. - - The column name for the id of bookmark. - - The value type is integer. - - - - - - Gets the column name for the name of bookmark. - - The column name for the name of bookmark. - - The value type is string. - - - - - - Provides the face info column names that can be used for Select and Count commands. - - - - - - - - - - - - Gets the column name for the tag of face info. - - The column name for the tag of face info. - - The value type is string. - - - - - - Gets the column name for the id of face info. - - The column name for the id of face info. - - The value type is string. - - - - - - Provides the storage column names that can be used for Select and Count commands. - - - - - - - - - - - Gets the column name for the id of storage. - - The column name for the id of storage. - - The value type is string. - - - - - - Gets the column name for the path of storage. - - The column name for the path of storage. - - The value type is string. - - - - - - Gets the column name for the type of storage. - - The column name for the type of storage. - - The value type is integer. - The value should be an integer that is one of values. - - - - - - Specifies how the strings are compared. - - - - - Default collation, binary. - - - - - Case-insensitive. - - - - - Trailing space characters are ignored. - - - - - Localized, NoCase also applied. - - - - - Specifies storage types. - - - - - The device's internal storage. - - - - - The device's external storage like sd card. - - - - - The external usb storage. - - - - - Specifies database operation types. - - - - - Insert operation. - - - - - Delete operation. - - - - - Update operation. - - - - - Specifies types of . - - - - - The type of an image. - - - - - - The type of a video. - - - - - - The type of sound. - - - - - - The type of music. - - - - - - The type of other. - - - - - Specifies orientation types of media. - - - - - None. - - - - - Normal. - - - - - Rotate 90 degrees. - - - - - Rotate 180 degrees. - - - - - Rotate 270 degrees. - - - - - Flip horizontal. - - - - - Flip vertical. - - - - - Transpose. - - - - - Transverse. - - - - - Provides data for the event. - - - - - Gets the process id which triggers the event. - - The process id which triggers the event. - - - - Gets the operation type. - - The operation type which triggers the event. - - - - Gets the id of the media updated. - - The id of the media updated. - - - - Gets the path of the media updated. - - The path of the media updated. - - - - Gets the type of the media updated. - - The of the media updated. - - - - The mime type of the media updated. - - The mime type of the media updated. - - - - Provides data for the event. - - - - - Gets the operation type. - - The operation type which triggers the event. - - - - Gets the id of the folder updated. - - The id of the folder updated. - - - - Gets the path of the folder updated. - - The path of the folder updated. - - - - Represents the face information for media. - - - - - Gets the region. - - The region of face in the media. - - The coordinates of the rectangle are orientation-applied values. - - - - - Gets the id of face info. - - - - - Gets the media id that the face info is added. - - The media id that the face info is added. - - - - Gets the tag name. - - The tag name of face info. - - - - Gets the orientation of face info. - - The orientation of face info. - - - - Returns a string representation of the face info. - - A string representation of the current face info. - - - - Provides commands to manage face infos in the database. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Deletes a face info from the database. - - http://tizen.org/privilege/content.write - The face info id to delete. - true if the matched record was found and deleted, otherwise false. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Retrieves the face info. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the face info with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Updates a tag with the specified tag. - - http://tizen.org/privilege/content.write - The face info id to update. - The tag value for update. - true if the matched record was found and updated, otherwise false. - Only values set in are updated. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Represents the folder information for media. - - - A is used to organize media content files i.e. image, audio, video files, - in the physical storage of the device. - - - - - Gets the id of folder. - - The unique id of folder. - - - - Gets the path of folder. - - The path of folder. - - - - Gets the name of folder. - - The name of folder. - - - - Gets the of the storage that the folder exists. - - The of the storage that the folder exists. - - - - Gets the storage id of the storage that the folder exists. - - The storage id of the storage that the folder exists. - - - - Returns a string representation of the folder. - - A string representation of the current folder. - - - - Provides commands to manage folders and query related media items in the database. - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of folders. - - The number of folders. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of folders with . - - The criteria to use to filter. This value can be null. - The number of folders. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the folders. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the folders with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the folder. - - The folder id to query with. - The instance if the matched record was found in the database, otherwise null. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of media info under the folder. - - The id of the folder to count media in the folder. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of media info under the folder with . - - The id of the folder to count media in the folder. - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the media info under the folder. - - The id of the folder to select media in the folder. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the media info under the folder with . - - The id of the folder to select media in the folder. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Represents the image media stored in the device. - - - - - Gets the image width in pixels. - - The image width in pixels. - - - - Gets the image height in pixels. - - The image height in pixels. - - - - Gets the orientation of image. - - The orientation of image. - - - - Gets the date of the creation time as a formatted string. - - The date of the creation time as a formatted string. - - - - Gets the burst shot id. - - The burst shot id if it is a burst shot, otherwise an empty string. - - - - - Gets the exposure time from exif. - - The exposure time from exif. - - - - Gets the FNumber from exif. - - The FNumber from exif. - - - - Gets the iso from exif. - - The iso from exif. - - - - Gets the model from exif. - - The model from exif. - - - - Gets the value indicating whether the media is a burst shot image. - - true if the media is a burst shot image, otherwise false. - - - - is a base class for command classes. - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Gets the . - - The which commands execute on. - - - - Provides a means of reading results obtained by executing a query. - - - - - Advances to the next record. - - true if there are more rows; otherwise false. - - - - Gets the current record. - - The current record object. - - - - Provides a means of reading results obtained by executing a query. - - - - - - Gets the current record. - - The current record if the position is valid; otherwise null. - - - - Advances to the next record. - - true if there are more rows; otherwise false. - - - - Disposes of the resources (other than memory) used by the MediaDataReader. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the current instance. - - - - - Provides the ability to connect to and manage the database. - - - - - Initializes a new instance of the class. - - - - - Connects to the database. - - The database is already connected. - The has already been disposed of. - An error occurred while connecting. - - - - Disconnects from the media database. - - The database is not connected. - The has already been disposed of. - An error occurred while connecting. - - - - Occurs when there is a change for media in the database. - - - - - Occurs when there is a change for folder in the database. - - - - - Requests to scan a media file. - - The path of the media to be scanned. - - It requests to scan a media file to the media server.\n - If the specified file is not registered to the database yet, - the media file information will be added to the database.\n - If it is already registered to the database, the media information is refreshed.\n - If the specified file does not exist, - the record of the media file will be deleted from the database.\n - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The database is not connected. - The has already been disposed of. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - The caller has no required privilege. - - - - Requests to scan a folder, recursively. - - - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The path to scan. - Folders that contains a file named ".scan_ignore" will not be scanned. - A task that represents the asynchronous scan operation. - The database is not connected. - The has already been disposed of. - The caller has no required privilege. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - - - - Requests to scan a folder. - - - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The path to scan. - The value indicating if the folder is to recursively scanned. - Folders that contains a file named ".scan_ignore" will not be scanned. - A task that represents the asynchronous scan operation. - The database is not connected. - The has already been disposed of. - The caller has no required privilege. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - - - - Requests to scan a folder, recursively. - - - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The path to scan. - The token to stop scanning. - Folders that contains a file named ".scan_ignore" will not be scanned. - A task that represents the asynchronous scan operation. - The database is not connected. - The has already been disposed of. - The caller has no required privilege. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - - - - Requests to scan a folder, recursively. - - - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The path to scan. - The value indicating if the folder is to recursively scanned. - The token to stop scanning. - Folders that contains a file named ".scan_ignore" will not be scanned. - A task that represents the asynchronous scan operation. - The database is not connected. - The has already been disposed of. - The caller has no required privilege. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - - - - Disposes of the resources (other than memory) used by the MediaDatabase. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources. - - - - - Gets the value indicating whether the database has been disposed of. - - true if the database has been disposed of; otherwise, false. - - - - Specifies database errors. - - - - - Operation failed. - - - - - Operation failed because the database is busy. - - - - - The exception that is thrown when an database operation failed. - - - - - Gets the error that causes the exception. - - The that causes the exception. - - - - Represents the information related to the media stored. - - - - - - - Gets the id of media. - - The unique id of media. - - - - Gets the path to media. - - The full path of the media file. - - - - Gets the name of media. - - The base name of the media file. - - - - Gets the of media. - - The of media. - - - - Gets the mime type from media. - - The mime type of media. - - - - Gets the file size of media in bytes. - - The file size of media in bytes. - - - - Gets the date of addition of media. - - The date of addition of media. - - - - Gets the date of modification of media. - - The date of modification of media. - - - - Gets the timeline of media. - - - The creation date if the file has the creation information (like recorded date or Image creation date), - otherwise the modified date. - - - - - Gets the thumbnail of media. - - The thumbnail path of media. - - - - Gets the description of media. - - The description from the metadata. - - - - Gets the longitude of media. - - The longitude. - - - - Gets the latitude of media. - - The latitude. - - - - Gets the altitude of media. - - The altitude. - - - - Gets the weather information of media. - - The weather information which a user sets. - - - - Gets the rating of media. - - The rating from the metadata. - - - - Gets the favorite status of media. - - true if media is set as favorite, otherwise false. - - - - Gets the provider of media. - - The provider which a user sets. - - - - Gets the title of media. - - The title of media. - - - - Gets the category of media. - - The category which a user sets. - - - - Gets the location tag of media. - - The location tag which a user sets. - - - - Gets the age rating of media. - - The age rating which a user sets. - - - - Gets the storage id of the storage that the media is stored on. - - The storage id of the storage that the media is stored on. - - - - Gets the value indicating whether the media is DRM-protected. - - A bool value indicating whether the media is DRM-protected. - - - - Gets the storage type of the storage that the media is stored on. - - The storage type of the storage that the media is stored on. - - - - Returns a string representation of the media info. - - A string representation of the current media info. - - - - Specifies group keys for . - - - - - Display name. - - - - - Media type. - - - - - Mime type. - - - - - File size. - - - - - Date added. - - - - - Date modified. - - - - - Content title. - - - - - Artist. - - - - - Album artist. - - - - - Genre. - - - - - Composer. - - - - - Year. - - - - - Date recorded. - - - - - Copyright. - - - - - Track number. - - - - - Description. - - - - - Longitude. - - - - - Latitude. - - - - - Altitude. - - - - - Burst shot. - - - - - Rating. - - - - - Provider. - - - - - Category. - - - - - Location tag. - - - - - Age rating. - - - - - Weather. - - - - - Provides commands to manage media info and query related items in the database. - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of the bookmarks added to the media. - - The media id to count bookmarks added to the media. - The number of bookmarks. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of the bookmarks added to the media with . - - The media id to count bookmarks added to the media. - The criteria to use to filter. This value can be null. - The number of bookmarks. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the bookmarks added to the media. - - The media id to select bookmarks added to the media. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the bookmarks added to the media with . - - The media id to select bookmarks added to the media. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of the face info added to or detected from the media. - - The media id to count face info added to the media. - The number of face info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of the face info added to or detected from the media with filter. - - The media id to count face info added to the media. - The criteria to use to filter. This value can be null. - The number of face info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the face info added to or detected from the media. - - The media id to select face info added to the media. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the face info added to or detected from the media with . - - The media id to select face info added to the media. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of tags that the media has. - - The number of tags. - The media id to count tags added to the media. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of tags that the media has with . - - The media id to count tags added to the media. - The criteria to use to filter. This value can be null. - The number of tags. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the tags that the media has. - - The media id to select tags added to the media. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the tags that the media has with . - - The media id to select tags added to the media. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of the media info. - - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of the media info with . - - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the media. - - The media id to retrieve. - The instance if the matched record was found in the database, otherwise null. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of values grouped by the specified column with . - - The column key. - The number of groups. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is invalid. - - - - Retrieves the number of values grouped by the specified column with . - - The column key. - The criteria to use to filter. This value can be null. - The number of groups. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is invalid. - - - - Retrieves the group values of the specified column. - - The column key. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is invalid. - - - - Retrieves the group values of the specified column. with . - - The column key. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is invalid. - - - - Retrieves all the media. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the media with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Deletes a media from the database. - - http://tizen.org/privilege/content.write - The media id to delete. - true if the matched record was found and deleted, otherwise false. - or can be used instead. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Adds media to the database. - - The file path to add. - The instance that contains the record information in the database. - - If the media already exists in the database, it returns existing information.\n - \n - or can be used instead.\n - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden path that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - does not exists. - The caller has no required privilege. - - - - Adds media files into the media database. - - - The paths that already exist in the database will be ignored.\n - At most 300 items can be added at once.\n - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The paths of the media files to add. - A task that represents the asynchronous add operation. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - contains null.\n - -or-\n - contains invalid path.\n - -or-\n - The number of is 300 or more items. - - contains a path that does not exist. - The caller has no required privilege. - - - - Adds burst shot images into the media database. - - The paths of the burst shot images to add. - A task that represents the asynchronous add operation. - - The paths that already exist in the database.\n - At most 300 items can be added at once. - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - contains null.\n - -or-\n - contains invalid path.\n - -or-\n - The number of is 300 or more items. - - contains a path that does not exist. - The caller has no required privilege. - - - - Updates a media with the specified values. - - http://tizen.org/privilege/content.write - The media id to update. - The values for update. - true if the matched record was found and updated, otherwise false. - Only values set in are updated. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - is null.\n - -or-\n - is null. - - is a zero-length string, contains only white space. - The caller has no required privilege. - - - - Updates the path of the media to the specified destination path in the database. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The media id to move. - The path that the media has been moved to. - true if the matched record was found and updated, otherwise false. - - Usually, it is used after the media file is moved to another path.\n - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - is null.\n - -or-\n - is null. - - - is a zero-length string, contains only white space.\n - -or-\n - is a zero-length string, contains only white space.\n - -or-\n - contains a hidden directory that starts with '.'.\n - -or-\n - contains a directory containing the ".scan_ignore" file. - - does not exists. - The caller has no required privilege. - - - - Creates a thumbnail image for the given media. - If a thumbnail already exists for the given media, the existing path will be returned. - - http://tizen.org/privilege/content.write - The media id to create thumbnail. - A task that represents the asynchronous operation. The task result contains the thumbnail path. - - The is disconnected.\n - -or-\n - An internal error occurred while executing. - - The has already been disposed of. - An error occurred while executing the command. - is null. - does not exist in the database. - - is a zero-length string, contains only white space. - - The file of the media does not exists; moved or deleted. - - Thumbnail is not available for the given media.\n - -or-\n - The media is in external usb storage( is ). - - - - - Creates a thumbnail image for the given media. - If a thumbnail already exists for the given media, the existing path will be returned. - - http://tizen.org/privilege/content.write - The media id to create thumbnail. - The token to cancel the operation. - A task that represents the asynchronous operation. The task result contains the thumbnail path. - - The is disconnected.\n - -or-\n - An internal error occurred while executing. - - The has already been disposed of. - An error occurred while executing the command. - is null. - does not exist in the database. - - is a zero-length string, contains only white space. - - The file of the media does not exists; moved or deleted. - - Thumbnail is not available for the given media.\n - -or-\n - The media is in external usb storage( is ). - - - - - Detects faces from the given media. - If a thumbnail already exists for the given media, the existing path will be returned. - - http://tizen.org/privilege/content.write - http://tizen.org/feature/vision.face_recognition - The media id to create thumbnail. - A task that represents the asynchronous add operation. The task result contains the number of faces detected. - - The is disconnected.\n - -or-\n - An internal error occurred while executing. - - The has already been disposed of. - An error occurred while executing the command. - is null. - does not exist in the database. - - is a zero-length string, contains only white space. - - The file of the media does not exists; moved or deleted. - Feace detection is not available for the given media. - The required feature is not supported. - The caller has no required privilege. - - - - Creates a thumbnail image for the given media. - If a thumbnail already exists for the given media, the existing path will be returned. - - - Media in external storage is not supported, with the exception of MMC. - - http://tizen.org/privilege/content.write - http://tizen.org/feature/vision.face_recognition - The media id to create thumbnail. - The token to cancel the operation. - A task that represents the asynchronous operation. The task result contains the number of faces detected. - - The is disconnected.\n - -or-\n - An internal error occurred while executing. - - The has already been disposed of. - An error occurred while executing the command. - is null. - does not exist in the database. - - is a zero-length string, contains only white space. - - The file of the media does not exists; moved or deleted. - - Face detection is not available for the given media.\n - -or-\n - The media is in external usb storage( is ). - - The required feature is not supported. - - - - Provides means to set values used for the update command. - - - The values only set in the object will be affected to the update command. - - - - - - Gets or sets the weather information for update. - - If the value is null, the update operation will have no effect on the field. - A string for weather; the field will not be updated if null. - - - - Gets or sets the favorite status for update. - - If the value is null, the update operation will have no effect on the field. - A value indicating whether the media is favorite; the field will not be updated if null. - - - - Gets or sets the provider information for update. - - If the value is null, the update operation will have no effect on the field. - A string for provider; the field will not be updated if null. - - - - Gets or sets the category information for update. - - If the value is null, the update operation will have no effect on the field. - A string for category; the field will not be updated if null. - - - - Gets or sets the location tag for update. - - If the value is null, the update operation will have no effect on the field. - A string for location tag; the field will not be updated if null. - - - - Gets or sets the age rating information for update. - - If the value is null, the update operation will have no effect on the field. - A string for age rating; the field will not be updated if null. - - - - Represents a playlist that is a group of media(usually songs). - - - - - Gets the ID of the playlist. - - The unique id of the playlist. - - - - Gets the name of the playlist. - - The name of the playlist. - - - - Gets the path to the thumbnail. - - The path to the thumbnail. - - - - Returns a string representation of the playlist. - - A string representation of the current playlist. - - - - Provides means to set values used for the update command. - - - The values only set in the object will be affected to the update command. - - - - - - Gets or sets the name of playlist for update. - - If the value is null, the update operation will have no effect on the field. - A string for name; the field will not be updated if null. - - - - Gets or sets the thumbnail path of playlist for update. - - If the value is null, the update operation will have no effect on the field. - A string for thumbnail path; the field will not be updated if null. - - - - Represents an order of a member of a playlist. - - - - - Initializes a new instance of the class with the specified member id and order value. - - The id of member. - The order value. - - is less than or equal to zero.\n - -or-\n - is less than zero. - - - - - Gets or sets the member id. - - The member id. - - is less than or equal to zero. - - - - - Gets or sets the value indicating the order of the member in a playlist. - - A integer value indicating the order of the member in a playlist. - - is less than zero. - - - - - Provides commands to manage playlists in the database. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of playlists. - - The number of playlists. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of playlists with . - - The criteria to use to filter. This value can be null. - The number of playlists. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the play order of the member. - - The playlist id. - The member id of the playlist. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - is less than or equal to zero.\n - -or-\n - is less than or equal to zero. - - - - - Deletes a playlist from the database. - - http://tizen.org/privilege/content.write - The playlist id to delete. - true if the matched record was found and deleted, otherwise false. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - The caller has no required privilege. - - - - Inserts a playlist into the database from the specified m3u file. - - - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/content.write - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The name of playlist. - The path to a m3u file to import. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - is null.\n - -or-\n - is null. - - - is a zero-length string.\n - -or-\n - is a zero-length string, contains only white space. - - does not exists. - The caller has no required privilege. - - - - Exports a playlist to a m3u file. - - - If the file already exists in the file system, then it will be overwritten.\n - \n - If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n - If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. - - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - The playlist id to export. - The path to a m3u file. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - is less than or equal to zero. - No matching playlist exists. - The caller has no required privilege. - - - - Inserts a playlist into the database with the specified name. - - http://tizen.org/privilege/content.write - The name of playlist. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string. - The caller has no required privilege. - - - - Inserts a playlist into the database with the specified name and thumbnail path. - - http://tizen.org/privilege/content.write - The name of playlist. - The path of thumbnail for playlist. This value can be null. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string. - The caller has no required privilege. - - - - Retrieves the playlists. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the playlists with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the playlist with the specified playlist id. - - The playlist id to select. - The instance if the matched record was found in the database, otherwise null. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the number of media info of the playlist. - - The playlist id to count media added to the playlist. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the number of media info of the playlist with . - - The playlist id to count media added to the playlist. - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the member id of the media in the playlist. - - The playlist id. - The media id. - The member id if the member was found in the playlist, otherwise -1. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the media info of the playlist. - - The playlist id to query with. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the media info of the playlist with . - - The playlist id to query with. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Updates a playlist with the specified values. - - http://tizen.org/privilege/content.write - The playlist id to update. - The values for update. - true if the matched record was found and updated, otherwise false. - Only values set in are updated. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is less than or equal to zero. - The caller has no required privilege. - - - - Adds media to a playlist. - - The playlist id that the media will be added to. - The media id to add to the playlist. - true if the matched record was found and updated, otherwise false. - The invalid media id will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - is less than or equal to zero. - - - - Adds a media set to a playlist. - - The playlist id that the media will be added to. - The collection of media id to add to the playlist. - true if the matched record was found and updated, otherwise false. - The invalid media ids will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - has no element.\n - -or-\n - contains null value.\n - -or-\n - contains a zero-length string or white space.\n - - is less than or equal to zero. - - - - Removes a member from a playlist. - - The playlist id. - The member id to be removed. - true if the matched record was found and updated, otherwise false. - The invalid id will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - is less than or equal to zero.\n - -or-\n - is less than or equal to zero.\n - - - - - Removes a media set from a playlist. - - The playlist id. - The collection of member id to remove from to the playlist. - true if the matched record was found and updated, otherwise false. - The invalid ids will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - has no element.\n - -or-\n - contains a value which is less than or equal to zero. - - is less than or equal to zero. - - - - Updates a play order of a playlist. - - The playlist id. - The to apply. - true if the matched record was found and updated, otherwise false. - The that is invalid will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is less than or equal to zero. - - - - Updates play orders of a playlist. - - The playlist id. - The collection of to apply. - true if the matched record was found and updated, otherwise false. - The that is invalid will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - has no element.\n - -or-\n - contains a null value. - - is less than or equal to zero. - - - - Represents a member of . - - - - - Gets the member id. - - The member id of playlist. - - - - Gets the media info of the member. - - The of the member. - - - - Base class for query arguments. - - - A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist - and MediaInfo on basis of details like limit, order and condition. - - - - - - Gets or sets the storage id for the given filter. - You can use this property when you want to search items only in the specific storage. - - The storage id to restrict storage to search, or null for all storages. - is a zero-length string, contains only white space. - - - - Provides the ability to filter the result of a Select command. - - - A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist - and MediaInfo. - - - - - Gets or sets the starting row position of a query(starting from zero). - - An integer value that indicates the starting row position of a query. - is less than zero.\n - - - - Gets or sets the number of rows to be retrieved. - - An integer value that indicates the limit of rows of the result. - is less than zero. - - - - Gets or sets the sort order of the results. - - The expression for the sort order. - - Expressions for the sort order can be:\n - column [COLLATE NOCASE/RTRIM/LOCALIZED] [ASC/DESC], column2 ... - - is a zero-length string, contains only white space. - - - - - - - - - - - Provides the ability to filter the result of a Count command. - - - A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist - and MediaInfo. - - - - - The exception that is thrown when no record is found in the database. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The message that describes the error. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The message that describes the error. - The exception that is the cause of the current exception. - - - - Represents location of the object bounded by rectangle defined by - coordinates of top left corner, width and height. - - - - - Initializes a new instance of the Rectangle with the specified values. - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The Width of the rectangle. - The Height of the rectangle. - - - - Gets or sets the x-coordinate of the upper-left corner of the rectangle. - - The x-coordinate of the upper-left edge of the rectangle. - - - - Gets or sets the y-coordinate of the upper-left corner of the rectangle. - - The y-coordinate of the upper-left edge of the rectangle. - - - - Gets or sets the width of the rectangle. - - The width of the rectangle. - - - - Gets or sets the height of the rectangle. - - The height of the rectangle. - - - - Gets the x-coordinate of the left edge of the rectangle. - - The x-coordinate of the left edge of the rectangle. - - - - Gets the y-coordinate of the top edge of the rectangle. - - The y-coordinate of the top edge of the rectangle. - - - - Gets the x-coordinate of the right edge of the rectangle. - - The x-coordinate of the right edge of the rectangle. - - - - Gets the y-coordinate of the bottom edge of the rectangle. - - The y-coordinate of the bottom edge of the rectangle. - - - - Returns a string representation of the rectangle. - - A string representation of the current rectangle. - - - - Returns the hash code for this Rectangle structure. - - An integer that represents the hash code for this rectangle. - - - - Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure. - - A to compare. - - true if obj is a Rectangle structure and its X, Y, Width and Height properties are - equal to the corresponding properties of this Rectangle structure; otherwise, false. - - - - - Tests whether two Rectangle structures have equal location and size. - - A to compare. - A to compare. - true if the two Rectangle structures have equal X, Y, Width, and Height properties; otherwise, false. - - - - Tests whether two Rectangle structures differ in location or size. - - A to compare. - A to compare. - true if any of the X, Y, Width or Height properties of the two Rectangle structures are unequal; otherwise false. - - - - Represents the storage information for media. - - - The system generates the storage id when the external storage is added. and manages the media information - in each of the storage by using storage id. - - - - - Gets the id of the storage. - - The unique id of the storage. - - - - Gets the path of the storage. - - The path of the storage. - - - - Gets the type of the storage. - - The type of the storage. - - - - Returns a string representation of the storage. - - A string representation of the current storage. - - - - Provides commands to manage external storages in the database. - - - Internal storage is not managed. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of storages. - - The number of storages. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of storages with . - - The criteria to use to filter. This value can be null. - The number of storages filtered. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the storage with the specified id. - - The storage id to select. - The instance if the matched record was found in the database, otherwise null. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves all the storages. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the storages with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of media info of the storage. - - The storage id. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the number of media info of the storage with . - - The storage id to query with. - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the media info of the storage. - - The storage id. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Retrieves the media info of the storage with . - - The storage id. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - - - - Represents a special piece of information that may be associated with media.\n - Tagging allows a user to organize large number of items into logical groups providing - a simplified and faster way of accessing media items. - - - - - Gets the id of the tag. - - The unique id of the tag. - - - - Gets the name of the tag. - - The name of the tag. - - - - Returns a string representation of the tag. - - A string representation of the current tag. - - - - Provides commands to manage tags in the database. - - - - - - Initializes a new instance of the class with the specified . - - A that the commands run on. - is null. - has already been disposed of. - - - - Retrieves the number of tags. - - The number of tags. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of tags with . - - The criteria to use to filter. This value can be null. - The number of tags filtered. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Deletes a tag from the database. - - http://tizen.org/privilege/content.write - The tag id to delete. - true if the matched record was found and deleted, otherwise false. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - The caller has no required privilege. - - - - Inserts a tag into the database with the specified name. - - http://tizen.org/privilege/content.write - The name of tag. - The instance that contains the record information inserted. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - The caller has no required privilege. - - - - Updates a tag with the specified name. - - http://tizen.org/privilege/content.write - The tag id to update. - The new name. - true if the matched record was found and updated, otherwise false. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is less than or equal to zero. - The caller has no required privilege. - - - - Retrieves the tag with the specified id. - - The tag id to select. - The instance if the matched record was found in the database, otherwise null. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves all the tags. - - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the tags with . - - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - - - - Retrieves the number of media info of the tag. - - The tag id. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the number of media info of the tag with . - - The tag id to query with. - The criteria to use to filter. This value can be null. - The number of media info. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the media info of the tag. - - The tag id. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Retrieves the media info of the tag with . - - The tag id. - The criteria to use to filter. This value can be null. - The containing the results. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is less than or equal to zero. - - - - Adds media to a tag. - - The tag id that the media will be added to. - The media id to add to the tag. - true if the matched record was found and updated, otherwise false. - The invalid media id will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - is less than or equal to zero. - - - - Adds a media set to a tag. - - The tag id that the media will be added to. - The media id to add to the tag. - true if the matched record was found and updated, otherwise false. - The invalid media ids will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - has no element.\n - -or-\n - contains null value.\n - -or-\n - contains a zero-length string, contains only white space.\n - - is less than or equal to zero. - - - - Removes media from a tag. - - The tag id. - The media id to remove from the tag. - true if the matched record was found and updated, otherwise false. - The invalid media id will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - is a zero-length string, contains only white space. - is less than or equal to zero. - - - - Removes a media set from a tag. - - The tag id. - The collection of media id to remove from the tag. - true if the matched record was found and updated, otherwise false. - The invalid ids will be ignored. - The is disconnected. - The has already been disposed of. - An error occurred while executing the command. - is null. - - has no element.\n - -or-\n - contains null value.\n - -or-\n - contains a zero-length string or white space.\n - - is less than or equal to zero. - - - - The exception that is thrown when a requested operation is not supported for content. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The message that describes the error. - - - - Initializes a new instance of the class with a specified error message - and a reference to the inner exception that is the cause of this exception. - - The message that describes the error. - The exception that is the cause of the current exception. - - - - Represents a video media information. - - - - - Gets the album name. - - The album name from the metadata. - - - - Gets the artist name. - - The artist name from the metadata. - - - - Gets the album artist name. - - The album artist name from the metadata. - - - - Gets the genre. - - The genre name from the metadata. - - - - Gets the composer name. - - The composer name from the metadata. - - - - Gets the year. - - The year from the metadata. - - - - Gets the recorded date. - - The recorded date information from the metadata if exists; otherwise, the modified date of the file. - - - - Gets the copyright notice. - - The copyright notice from the metadata. - - - - Gets the track number. - - The track number from the metadata. - - - - Gets the bitrate in bit per second. - - The bit rate of the video. - - - - Gets the track duration in milliseconds. - - The track duration of the video in milliseconds. - - - - Gets the video width in pixels. - - The width of the video in pixels. - - - - Gets the video height in pixels. - - The height of the video in pixels. - - - + + + + Tizen.Content.MediaContent + + + + + Represents a logical collection grouping of related media info. + + + + + + Get the id of the album. + + The unique id of the album. + + + + Gets the artist name of the album. + + The artist name. + + + + Gets the path to the album art. + + The path to the album art. + + + + Gets the name of the album. + + The album name. + + + + Returns a string representation of the album. + + A string representation of the current album. + + + + Provides commands to manage albums in the database. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of albums. + + The number of albums. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of albums with . + + The criteria to use to filter. This value can be null. + The number of albums. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves all the albums. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the albums with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves an album with an album id. + + The id of the album to query with. + The if exists, otherwise null. + The is disconnected. + The has already been disposed of. + is equal to or less than zero. + An error occurred while executing the command. + + + + Retrieves the number of media info that belongs to the album. + + The id of the album to query with. + The number of media info. + The is disconnected. + The has already been disposed of. + is equal to or less than zero. + An error occurred while executing the command. + + + + Retrieves the number of media info that belongs to the album with .. + + The id of the album to count media. + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + is equal to or less than zero. + An error occurred while executing the command. + + + + Retrieves the media info of an album. + + The id of the album to select media. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the media info of an album with . + + The id of the album to query with. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Represents an audio media information. + + + + + Gets the album name. + + The album from the metadata. + + + + Gets the artist name. + + The artist from the metadata. + + + + Gets the album artist name. + + The album artist from the metadata. + + + + Gets the genre. + + The genre from the metadata. + + + + Gets the composer. + + The composer from the metadata. + + + + Gets the year. + + The year from the metadata. + + + + Gets the recorded date. + + The recorded date from the metadata. + + + + Gets the copyright. + + The copyright from the metadata. + + + + Gets the track number. + + The track number from the metadata. + + + + Gets the bit rate in bit per second. + + The bit rate in bit per second. + + + + Gets the bit per sample. + + The bit per sample. + + + + Gets the sample rate in hertz. + + The sample rate in hertz. + + + + Gets the number of channels. + + The number of channels. + + + + Gets the track duration in milliseconds. + + The track duration in milliseconds. + + + + Represents a media bookmark that allows you to mark interesting moment + in media(video and audio) to enable fast searching. + + + + + Gets the id of the bookmark. + + The id of the bookmark. + + + + Gets the thumbnail path of the bookmark. + + The thumbnail path of the bookmark. + + + + Gets the offset in milliseconds. + + The offset of the bookmark in media in milliseconds. + + + + Gets the name of the bookmark. + + The name of the bookmark. + + + + Returns a string representation of the bookmark. + + A string representation of the current bookmark. + + + + Provides commands to manage bookmarks in database. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of bookmarks. + + The number of bookmarks. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of bookmarks with . + + The criteria to use to filter. This value can be null. + The number of bookmarks. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Inserts new bookmark into the database with the specified media and offset. + + http://tizen.org/privilege/content.write + The media id to be associated with. + The time offset in milliseconds. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Inserts new bookmark into the database with the specified media id, offset and name. + + http://tizen.org/privilege/content.write + The media id to be associated with. + The time offset in milliseconds. + The name of the bookmark. This value can be null. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Inserts new bookmark into the database with the specified media id, offset, name and thumbnail path. + + http://tizen.org/privilege/content.write + + Thumbnail may be useful only when the media is video. + + The media id to be associated with. + The time offset in milliseconds. + The name of the bookmark. This value can be null. + The thumbnail path of the bookmark. This value can be null. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Deletes a bookmark from the database. + + http://tizen.org/privilege/content.write + The bookmark id to delete. + true if the matched record was found and deleted, otherwise false. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than zero. + The caller has no required privilege. + + + + Retrieves the bookmarks. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the bookmarks with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Provides the column names that can be used for Select and Count commands. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Gets the column name for the id of media. + + The column name for the id of media. + The value type is string. + + + + + Gets the column name for the path of media. + + The column name for the file path of media. + The value type is string. + + + + + Gets the column name for display name of media. + + The column name for the display name of media. + The value type is string. + + + + + Gets the column name for the type of media. + + The column name for the type of media. + + The value type is integer. + The value should be an integer that is one of values. + + + + + + Gets the column name for the mime type of media. + + The column name for the mime type of media. + The value type is string. + + + + + Gets the column name for the file size of media. + + The column name for the file size of media. + The value type is integer. + + + + + Gets the column name for the date added of media. + + The column name for the date added of media. + + The value type is integer. + needs to be converted into the unix time. + + + + + + + Gets the column name for the date modified of media. + + The column name for the date modified of media. + + The value type is integer. + needs to be converted into the unix time. + + + + + + + Gets the column name for the timeline of media. + + The column name for the timeline of media. + + The value type is integer. + needs to be converted into the unix time. + + + + + + + Gets the column name for the thumbnail path of media. + + The column name for the thumbnail path of media. + + The value type is string. + + + + + + Gets the column name for the title of media. + + The column name for the title of media. + + The value type is string. + + + + + + Gets the column name for the album of media. + + The column name for the album of media. + + The value type is string. + + + + + + Gets the column name for the artist of media. + + The column name for the artist of media. + + The value type is string. + + + + + + + Gets the column name for the album artist of media. + + The column name for the album artist of media. + + The value type is string. + + + + + + + Gets the column name for the genre of media. + + The column name for the genre of media. + + The value type is string. + + + + + + + Gets the column name for the composer of media. + + The column name for the composer of media. + + The value type is string. + + + + + + + Gets the column name for the year of media. + + The column name for the year of media. + + The value type is string. + + + + + + + Gets the column name for the date recorded of media. + + The column name for the date recorded of media. + + The value type is string. + + + + + + + Gets the column name for the copyright of media. + + The column name for the copyright of media. + + The value type is string. + + + + + + + Gets the column name for the track number of media. + + The column name for the track number of media. + + The value type is string. + + + + + + + Gets the column name for the description of media. + + The column name for the description of media. + + The value type is string. + + + + + + Gets the column name for the bit rate of media. + + The column name for the bit rate of media. + + The value type is integer. + + + + + + + Gets the column name for the bit per sample of media. + + The column name for the bit per sample of media. + + The value type is integer. + + + + + + Gets the column name for the sample rate of media. + + The column name for the sample rate of media. + + The value type is integer. + + + + + + Gets the column name for the channels of media. + + The column name for the channels of media. + + The value type is integer. + + + + + + Gets the column name for the duration of media. + + The column name for the duration of media. + + The value type is integer. + + + + + + + Gets the column name for the longitude of media. + + The column name for the longitude of media. + + The value type is real. + + + + + + Gets the column name for the latitude of media. + + The column name for the latitude of media. + + The value type is real. + + + + + + Gets the column name for the altitude of media. + + The column name for the altitude of media. + + The value type is real. + + + + + + Gets the column name for the width of media. + + The column name for the width of media. + + The value type is integer. + + + + + + + Gets the column name for the height of media. + + The column name for the height of media. + + The value type is integer. + + + + + + + Gets the column name for the date taken of media. + + The column name for the date taken of media. + + The value type is integer. + + + + + + Gets the column name for the orientation of media. + + The column name for the orientation of media. + + The value type is integer. + The value should be an integer that is one of values. + + + + + + + Gets the column name for the burst id of media. + + The column name for the burst id of media. + + The value type is string. + + + + + + Gets the column name for the rating of media. + + The column name for the rating of media. + + The value type is integer. + + + + + + Gets the column name for the favorite status of media. + + The column name for the favorite status of media. + + The value type is integer(1 : true, 0 : false). + + + + + + Gets the column name for the provider of media. + + The column name for the provider of media. + + The value type is string. + + + + + + Gets the column name for the category of media. + + The column name for the category of media. + + The value type is string. + + + + + + Gets the column name for the location tag of media. + + The column name for the location tag of media. + + The value type is string. + + + + + + Gets the column name for the age rating of media. + + The column name for the age rating of media. + + The value type is string. + + > + + + + Gets the column name for the weather information of media. + + The column name for the weather information of media. + + The value type is string. + + + + + + Gets the column name for the drm of media. + + The column name for the drm of media. + + The value type is integer(1 : true, 0 : false). + + + + + + Gets the column name for the storage type of media. + + The column name for the storage type of media. + + The value type is integer. + The value should be an integer that is one of values. + + + + + + Gets the column name for the exposure time of media. + + The column name for the exposure time of media. + + The value type is integer. + + + + + + Gets the column name for the FNumber of media. + + The column name for the FNumber of media. + + The value type is integer. + + + + + + Gets the column name for the iso of media. + + The column name for the iso of media. + + The value type is integer. + + + + + + Gets the column name for the model of media. + + The column name for the model of media. + + The value type is string. + + + + + + Provides the folder column names that can be used for Select and Count commands. + + + + + + + + + + + Gets the column name for the name of album. + + The column name for the name of album. + + The value type is string. + + + + + + Gets the column name for the artist of album. + + The column name for the artist of album. + + The value type is string. + + + + + + Provides the folder column names that can be used for Select and Count commands. + + + + + + + + + + + Gets the column name for the id of folder. + + The column name for the id of folder. + + The value type is string. + + + + + + Gets the column name for the path of folder. + + The column name for the path of folder. + + The value type is string. + + + + + + Gets the column name for the name of folder. + + The column name for the name of folder. + + The value type is string. + + + + + + Gets the column name for the storage type of folder. + + The column name for the storage type of folder. + + The value type is integer. + The value should be an integer that is one of values. + + + + + + Provides the playlist column names that can be used for Select and Count commands. + + + + + + + + + + + Gets the column name for the name of playlist. + + The column name for the name of playlist. + + The value type is string. + + + + + + Gets the column name for the id of playlist. + + The column name for the id of playlist. + + The value type is integer. + + + + + + Gets the column name for the member order of playlist. + + The column name for the member order of playlist. + + The value type is integer. + + + + + + Gets the column name for the number of members of playlist. + + The column name for the number of members of playlist. + + The value type is integer. + + + + + + + Provides the tag column names that can be used for . + + + + + + + + + + + + + + + Gets the column name for the name of tag. + + The column name for the name of tag. + + The value type is string. + + + + + + Gets the column name for the number of media of tag. + + The column name for the number of media of tag. + + The value type is integer. + + + + + + + Gets the column name for the id of tag. + + The column name for the id of tag. + + The value type is integer. + + + + + + Provides the bookmark column names that can be used for Select and Count commands. + + + + + + + + + + + + + Gets the column name for offset of bookmark. + + The column name for the offset of bookmark. + + The value type is integer. + + + + + + Gets the column name for the id of bookmark. + + The column name for the id of bookmark. + + The value type is integer. + + + + + + Gets the column name for the name of bookmark. + + The column name for the name of bookmark. + + The value type is string. + + + + + + Provides the face info column names that can be used for Select and Count commands. + + + + + + + + + + + + Gets the column name for the tag of face info. + + The column name for the tag of face info. + + The value type is string. + + + + + + Gets the column name for the id of face info. + + The column name for the id of face info. + + The value type is string. + + + + + + Provides the storage column names that can be used for Select and Count commands. + + + + + + + + + + + Gets the column name for the id of storage. + + The column name for the id of storage. + + The value type is string. + + + + + + Gets the column name for the path of storage. + + The column name for the path of storage. + + The value type is string. + + + + + + Gets the column name for the type of storage. + + The column name for the type of storage. + + The value type is integer. + The value should be an integer that is one of values. + + + + + + Specifies how the strings are compared. + + + + + Default collation, binary. + + + + + Case-insensitive. + + + + + Trailing space characters are ignored. + + + + + Localized, NoCase also applied. + + + + + Specifies storage types. + + + + + The device's internal storage. + + + + + The device's external storage like sd card. + + + + + The external usb storage. + + + + + Specifies database operation types. + + + + + Insert operation. + + + + + Delete operation. + + + + + Update operation. + + + + + Specifies types of . + + + + + The type of an image. + + + + + + The type of a video. + + + + + + The type of sound. + + + + + + The type of music. + + + + + + The type of other. + + + + + Specifies orientation types of media. + + + + + None. + + + + + Normal. + + + + + Rotate 90 degrees. + + + + + Rotate 180 degrees. + + + + + Rotate 270 degrees. + + + + + Flip horizontal. + + + + + Flip vertical. + + + + + Transpose. + + + + + Transverse. + + + + + Provides data for the event. + + + + + Gets the process id which triggers the event. + + The process id which triggers the event. + + + + Gets the operation type. + + The operation type which triggers the event. + + + + Gets the id of the media updated. + + The id of the media updated. + + + + Gets the path of the media updated. + + The path of the media updated. + + + + Gets the type of the media updated. + + The of the media updated. + + + + The mime type of the media updated. + + The mime type of the media updated. + + + + Provides data for the event. + + + + + Gets the operation type. + + The operation type which triggers the event. + + + + Gets the id of the folder updated. + + The id of the folder updated. + + + + Gets the path of the folder updated. + + The path of the folder updated. + + + + Represents the face information for media. + + + + + Gets the region. + + The region of face in the media. + + The coordinates of the rectangle are orientation-applied values. + + + + + Gets the id of face info. + + + + + Gets the media id that the face info is added. + + The media id that the face info is added. + + + + Gets the tag name. + + The tag name of face info. + + + + Gets the orientation of face info. + + The orientation of face info. + + + + Returns a string representation of the face info. + + A string representation of the current face info. + + + + Provides commands to manage face infos in the database. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Deletes a face info from the database. + + http://tizen.org/privilege/content.write + The face info id to delete. + true if the matched record was found and deleted, otherwise false. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Retrieves the face info. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the face info with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Updates a tag with the specified tag. + + http://tizen.org/privilege/content.write + The face info id to update. + The tag value for update. + true if the matched record was found and updated, otherwise false. + Only values set in are updated. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Represents the folder information for media. + + + A is used to organize media content files i.e. image, audio, video files, + in the physical storage of the device. + + + + + Gets the id of folder. + + The unique id of folder. + + + + Gets the path of folder. + + The path of folder. + + + + Gets the name of folder. + + The name of folder. + + + + Gets the of the storage that the folder exists. + + The of the storage that the folder exists. + + + + Gets the storage id of the storage that the folder exists. + + The storage id of the storage that the folder exists. + + + + Returns a string representation of the folder. + + A string representation of the current folder. + + + + Provides commands to manage folders and query related media items in the database. + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of folders. + + The number of folders. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of folders with . + + The criteria to use to filter. This value can be null. + The number of folders. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the folders. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the folders with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the folder. + + The folder id to query with. + The instance if the matched record was found in the database, otherwise null. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of media info under the folder. + + The id of the folder to count media in the folder. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of media info under the folder with . + + The id of the folder to count media in the folder. + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the media info under the folder. + + The id of the folder to select media in the folder. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the media info under the folder with . + + The id of the folder to select media in the folder. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Represents the image media stored in the device. + + + + + Gets the image width in pixels. + + The image width in pixels. + + + + Gets the image height in pixels. + + The image height in pixels. + + + + Gets the orientation of image. + + The orientation of image. + + + + Gets the date of the creation time as a formatted string. + + The date of the creation time as a formatted string. + + + + Gets the burst shot id. + + The burst shot id if it is a burst shot, otherwise an empty string. + + + + + Gets the exposure time from exif. + + The exposure time from exif. + + + + Gets the FNumber from exif. + + The FNumber from exif. + + + + Gets the iso from exif. + + The iso from exif. + + + + Gets the model from exif. + + The model from exif. + + + + Gets the value indicating whether the media is a burst shot image. + + true if the media is a burst shot image, otherwise false. + + + + is a base class for command classes. + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Gets the . + + The which commands execute on. + + + + Provides a means of reading results obtained by executing a query. + + + + + Advances to the next record. + + true if there are more rows; otherwise false. + + + + Gets the current record. + + The current record object. + + + + Provides a means of reading results obtained by executing a query. + + + + + + Gets the current record. + + The current record if the position is valid; otherwise null. + + + + Advances to the next record. + + true if there are more rows; otherwise false. + + + + Disposes of the resources (other than memory) used by the MediaDataReader. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the current instance. + + + + + Provides the ability to connect to and manage the database. + + + + + Initializes a new instance of the class. + + + + + Connects to the database. + + The database is already connected. + The has already been disposed of. + An error occurred while connecting. + + + + Disconnects from the media database. + + The database is not connected. + The has already been disposed of. + An error occurred while connecting. + + + + Occurs when there is a change for media in the database. + + + + + Occurs when there is a change for folder in the database. + + + + + Requests to scan a media file. + + The path of the media to be scanned. + + It requests to scan a media file to the media server.\n + If the specified file is not registered to the database yet, + the media file information will be added to the database.\n + If it is already registered to the database, the media information is refreshed.\n + If the specified file does not exist, + the record of the media file will be deleted from the database.\n + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The database is not connected. + The has already been disposed of. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + The caller has no required privilege. + + + + Requests to scan a folder, recursively. + + + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The path to scan. + Folders that contains a file named ".scan_ignore" will not be scanned. + A task that represents the asynchronous scan operation. + The database is not connected. + The has already been disposed of. + The caller has no required privilege. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + + + + Requests to scan a folder. + + + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The path to scan. + The value indicating if the folder is to recursively scanned. + Folders that contains a file named ".scan_ignore" will not be scanned. + A task that represents the asynchronous scan operation. + The database is not connected. + The has already been disposed of. + The caller has no required privilege. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + + + + Requests to scan a folder, recursively. + + + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The path to scan. + The token to stop scanning. + Folders that contains a file named ".scan_ignore" will not be scanned. + A task that represents the asynchronous scan operation. + The database is not connected. + The has already been disposed of. + The caller has no required privilege. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + + + + Requests to scan a folder, recursively. + + + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The path to scan. + The value indicating if the folder is to recursively scanned. + The token to stop scanning. + Folders that contains a file named ".scan_ignore" will not be scanned. + A task that represents the asynchronous scan operation. + The database is not connected. + The has already been disposed of. + The caller has no required privilege. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + + + + Disposes of the resources (other than memory) used by the MediaDatabase. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources. + + + + + Gets the value indicating whether the database has been disposed of. + + true if the database has been disposed of; otherwise, false. + + + + Specifies database errors. + + + + + Operation failed. + + + + + Operation failed because the database is busy. + + + + + The exception that is thrown when an database operation failed. + + + + + Gets the error that causes the exception. + + The that causes the exception. + + + + Represents the information related to the media stored. + + + + + + + Gets the id of media. + + The unique id of media. + + + + Gets the path to media. + + The full path of the media file. + + + + Gets the name of media. + + The base name of the media file. + + + + Gets the of media. + + The of media. + + + + Gets the mime type from media. + + The mime type of media. + + + + Gets the file size of media in bytes. + + The file size of media in bytes. + + + + Gets the date of addition of media. + + The date of addition of media. + + + + Gets the date of modification of media. + + The date of modification of media. + + + + Gets the timeline of media. + + + The creation date if the file has the creation information (like recorded date or Image creation date), + otherwise the modified date. + + + + + Gets the thumbnail of media. + + The thumbnail path of media. + + + + Gets the description of media. + + The description from the metadata. + + + + Gets the longitude of media. + + The longitude. + + + + Gets the latitude of media. + + The latitude. + + + + Gets the altitude of media. + + The altitude. + + + + Gets the weather information of media. + + The weather information which a user sets. + + + + Gets the rating of media. + + The rating from the metadata. + + + + Gets the favorite status of media. + + true if media is set as favorite, otherwise false. + + + + Gets the provider of media. + + The provider which a user sets. + + + + Gets the title of media. + + The title of media. + + + + Gets the category of media. + + The category which a user sets. + + + + Gets the location tag of media. + + The location tag which a user sets. + + + + Gets the age rating of media. + + The age rating which a user sets. + + + + Gets the storage id of the storage that the media is stored on. + + The storage id of the storage that the media is stored on. + + + + Gets the value indicating whether the media is DRM-protected. + + A bool value indicating whether the media is DRM-protected. + + + + Gets the storage type of the storage that the media is stored on. + + The storage type of the storage that the media is stored on. + + + + Returns a string representation of the media info. + + A string representation of the current media info. + + + + Specifies group keys for . + + + + + Display name. + + + + + Media type. + + + + + Mime type. + + + + + File size. + + + + + Date added. + + + + + Date modified. + + + + + Content title. + + + + + Artist. + + + + + Album artist. + + + + + Genre. + + + + + Composer. + + + + + Year. + + + + + Date recorded. + + + + + Copyright. + + + + + Track number. + + + + + Description. + + + + + Longitude. + + + + + Latitude. + + + + + Altitude. + + + + + Burst shot. + + + + + Rating. + + + + + Provider. + + + + + Category. + + + + + Location tag. + + + + + Age rating. + + + + + Weather. + + + + + Provides commands to manage media info and query related items in the database. + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of the bookmarks added to the media. + + The media id to count bookmarks added to the media. + The number of bookmarks. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of the bookmarks added to the media with . + + The media id to count bookmarks added to the media. + The criteria to use to filter. This value can be null. + The number of bookmarks. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the bookmarks added to the media. + + The media id to select bookmarks added to the media. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the bookmarks added to the media with . + + The media id to select bookmarks added to the media. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of the face info added to or detected from the media. + + The media id to count face info added to the media. + The number of face info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of the face info added to or detected from the media with filter. + + The media id to count face info added to the media. + The criteria to use to filter. This value can be null. + The number of face info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the face info added to or detected from the media. + + The media id to select face info added to the media. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the face info added to or detected from the media with . + + The media id to select face info added to the media. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of tags that the media has. + + The number of tags. + The media id to count tags added to the media. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of tags that the media has with . + + The media id to count tags added to the media. + The criteria to use to filter. This value can be null. + The number of tags. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the tags that the media has. + + The media id to select tags added to the media. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the tags that the media has with . + + The media id to select tags added to the media. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of the media info. + + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of the media info with . + + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the media. + + The media id to retrieve. + The instance if the matched record was found in the database, otherwise null. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of values grouped by the specified column with . + + The column key. + The number of groups. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is invalid. + + + + Retrieves the number of values grouped by the specified column with . + + The column key. + The criteria to use to filter. This value can be null. + The number of groups. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is invalid. + + + + Retrieves the group values of the specified column. + + The column key. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is invalid. + + + + Retrieves the group values of the specified column. with . + + The column key. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is invalid. + + + + Retrieves all the media. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the media with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Deletes a media from the database. + + http://tizen.org/privilege/content.write + The media id to delete. + true if the matched record was found and deleted, otherwise false. + or can be used instead. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Adds media to the database. + + The file path to add. + The instance that contains the record information in the database. + + If the media already exists in the database, it returns existing information.\n + \n + or can be used instead.\n + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden path that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + does not exists. + The caller has no required privilege. + + + + Adds media files into the media database. + + + The paths that already exist in the database will be ignored.\n + At most 300 items can be added at once.\n + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The paths of the media files to add. + A task that represents the asynchronous add operation. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + contains null.\n + -or-\n + contains invalid path.\n + -or-\n + The number of is 300 or more items. + + contains a path that does not exist. + The caller has no required privilege. + + + + Adds burst shot images into the media database. + + The paths of the burst shot images to add. + A task that represents the asynchronous add operation. + + The paths that already exist in the database.\n + At most 300 items can be added at once. + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + contains null.\n + -or-\n + contains invalid path.\n + -or-\n + The number of is 300 or more items. + + contains a path that does not exist. + The caller has no required privilege. + + + + Updates a media with the specified values. + + http://tizen.org/privilege/content.write + The media id to update. + The values for update. + true if the matched record was found and updated, otherwise false. + Only values set in are updated. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + is null.\n + -or-\n + is null. + + is a zero-length string, contains only white space. + The caller has no required privilege. + + + + Updates the path of the media to the specified destination path in the database. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The media id to move. + The path that the media has been moved to. + true if the matched record was found and updated, otherwise false. + + Usually, it is used after the media file is moved to another path.\n + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + is null.\n + -or-\n + is null. + + + is a zero-length string, contains only white space.\n + -or-\n + is a zero-length string, contains only white space.\n + -or-\n + contains a hidden directory that starts with '.'.\n + -or-\n + contains a directory containing the ".scan_ignore" file. + + does not exists. + The caller has no required privilege. + + + + Creates a thumbnail image for the given media. + If a thumbnail already exists for the given media, the existing path will be returned. + + http://tizen.org/privilege/content.write + The media id to create thumbnail. + A task that represents the asynchronous operation. The task result contains the thumbnail path. + + The is disconnected.\n + -or-\n + An internal error occurred while executing. + + The has already been disposed of. + An error occurred while executing the command. + is null. + does not exist in the database. + + is a zero-length string, contains only white space. + + The file of the media does not exists; moved or deleted. + + Thumbnail is not available for the given media.\n + -or-\n + The media is in external usb storage( is ). + + + + + Creates a thumbnail image for the given media. + If a thumbnail already exists for the given media, the existing path will be returned. + + http://tizen.org/privilege/content.write + The media id to create thumbnail. + The token to cancel the operation. + A task that represents the asynchronous operation. The task result contains the thumbnail path. + + The is disconnected.\n + -or-\n + An internal error occurred while executing. + + The has already been disposed of. + An error occurred while executing the command. + is null. + does not exist in the database. + + is a zero-length string, contains only white space. + + The file of the media does not exists; moved or deleted. + + Thumbnail is not available for the given media.\n + -or-\n + The media is in external usb storage( is ). + + + + + Detects faces from the given media. + If a thumbnail already exists for the given media, the existing path will be returned. + + http://tizen.org/privilege/content.write + http://tizen.org/feature/vision.face_recognition + The media id to create thumbnail. + A task that represents the asynchronous add operation. The task result contains the number of faces detected. + + The is disconnected.\n + -or-\n + An internal error occurred while executing. + + The has already been disposed of. + An error occurred while executing the command. + is null. + does not exist in the database. + + is a zero-length string, contains only white space. + + The file of the media does not exists; moved or deleted. + Feace detection is not available for the given media. + The required feature is not supported. + The caller has no required privilege. + + + + Creates a thumbnail image for the given media. + If a thumbnail already exists for the given media, the existing path will be returned. + + + Media in external storage is not supported, with the exception of MMC. + + http://tizen.org/privilege/content.write + http://tizen.org/feature/vision.face_recognition + The media id to create thumbnail. + The token to cancel the operation. + A task that represents the asynchronous operation. The task result contains the number of faces detected. + + The is disconnected.\n + -or-\n + An internal error occurred while executing. + + The has already been disposed of. + An error occurred while executing the command. + is null. + does not exist in the database. + + is a zero-length string, contains only white space. + + The file of the media does not exists; moved or deleted. + + Face detection is not available for the given media.\n + -or-\n + The media is in external usb storage( is ). + + The required feature is not supported. + + + + Provides means to set values used for the update command. + + + The values only set in the object will be affected to the update command. + + + + + + Gets or sets the weather information for update. + + If the value is null, the update operation will have no effect on the field. + A string for weather; the field will not be updated if null. + + + + Gets or sets the favorite status for update. + + If the value is null, the update operation will have no effect on the field. + A value indicating whether the media is favorite; the field will not be updated if null. + + + + Gets or sets the provider information for update. + + If the value is null, the update operation will have no effect on the field. + A string for provider; the field will not be updated if null. + + + + Gets or sets the category information for update. + + If the value is null, the update operation will have no effect on the field. + A string for category; the field will not be updated if null. + + + + Gets or sets the location tag for update. + + If the value is null, the update operation will have no effect on the field. + A string for location tag; the field will not be updated if null. + + + + Gets or sets the age rating information for update. + + If the value is null, the update operation will have no effect on the field. + A string for age rating; the field will not be updated if null. + + + + Represents a playlist that is a group of media(usually songs). + + + + + Gets the ID of the playlist. + + The unique id of the playlist. + + + + Gets the name of the playlist. + + The name of the playlist. + + + + Gets the path to the thumbnail. + + The path to the thumbnail. + + + + Returns a string representation of the playlist. + + A string representation of the current playlist. + + + + Provides means to set values used for the update command. + + + The values only set in the object will be affected to the update command. + + + + + + Gets or sets the name of playlist for update. + + If the value is null, the update operation will have no effect on the field. + A string for name; the field will not be updated if null. + + + + Gets or sets the thumbnail path of playlist for update. + + If the value is null, the update operation will have no effect on the field. + A string for thumbnail path; the field will not be updated if null. + + + + Represents an order of a member of a playlist. + + + + + Initializes a new instance of the class with the specified member id and order value. + + The id of member. + The order value. + + is less than or equal to zero.\n + -or-\n + is less than zero. + + + + + Gets or sets the member id. + + The member id. + + is less than or equal to zero. + + + + + Gets or sets the value indicating the order of the member in a playlist. + + A integer value indicating the order of the member in a playlist. + + is less than zero. + + + + + Provides commands to manage playlists in the database. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of playlists. + + The number of playlists. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of playlists with . + + The criteria to use to filter. This value can be null. + The number of playlists. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the play order of the member. + + The playlist id. + The member id of the playlist. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + is less than or equal to zero.\n + -or-\n + is less than or equal to zero. + + + + + Deletes a playlist from the database. + + http://tizen.org/privilege/content.write + The playlist id to delete. + true if the matched record was found and deleted, otherwise false. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + The caller has no required privilege. + + + + Inserts a playlist into the database from the specified m3u file. + + + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/content.write + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The name of playlist. + The path to a m3u file to import. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + is null.\n + -or-\n + is null. + + + is a zero-length string.\n + -or-\n + is a zero-length string, contains only white space. + + does not exists. + The caller has no required privilege. + + + + Exports a playlist to a m3u file. + + + If the file already exists in the file system, then it will be overwritten.\n + \n + If you want to access internal storage, you should add privilege http://tizen.org/privilege/mediastorage.\n + If you want to access external storage, you should add privilege http://tizen.org/privilege/externalstorage. + + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + The playlist id to export. + The path to a m3u file. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + is less than or equal to zero. + No matching playlist exists. + The caller has no required privilege. + + + + Inserts a playlist into the database with the specified name. + + http://tizen.org/privilege/content.write + The name of playlist. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string. + The caller has no required privilege. + + + + Inserts a playlist into the database with the specified name and thumbnail path. + + http://tizen.org/privilege/content.write + The name of playlist. + The path of thumbnail for playlist. This value can be null. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string. + The caller has no required privilege. + + + + Retrieves the playlists. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the playlists with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the playlist with the specified playlist id. + + The playlist id to select. + The instance if the matched record was found in the database, otherwise null. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the number of media info of the playlist. + + The playlist id to count media added to the playlist. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the number of media info of the playlist with . + + The playlist id to count media added to the playlist. + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the member id of the media in the playlist. + + The playlist id. + The media id. + The member id if the member was found in the playlist, otherwise -1. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the media info of the playlist. + + The playlist id to query with. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the media info of the playlist with . + + The playlist id to query with. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Updates a playlist with the specified values. + + http://tizen.org/privilege/content.write + The playlist id to update. + The values for update. + true if the matched record was found and updated, otherwise false. + Only values set in are updated. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is less than or equal to zero. + The caller has no required privilege. + + + + Adds media to a playlist. + + The playlist id that the media will be added to. + The media id to add to the playlist. + true if the matched record was found and updated, otherwise false. + The invalid media id will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + is less than or equal to zero. + + + + Adds a media set to a playlist. + + The playlist id that the media will be added to. + The collection of media id to add to the playlist. + true if the matched record was found and updated, otherwise false. + The invalid media ids will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + has no element.\n + -or-\n + contains null value.\n + -or-\n + contains a zero-length string or white space.\n + + is less than or equal to zero. + + + + Removes a member from a playlist. + + The playlist id. + The member id to be removed. + true if the matched record was found and updated, otherwise false. + The invalid id will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + is less than or equal to zero.\n + -or-\n + is less than or equal to zero.\n + + + + + Removes a media set from a playlist. + + The playlist id. + The collection of member id to remove from to the playlist. + true if the matched record was found and updated, otherwise false. + The invalid ids will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + has no element.\n + -or-\n + contains a value which is less than or equal to zero. + + is less than or equal to zero. + + + + Updates a play order of a playlist. + + The playlist id. + The to apply. + true if the matched record was found and updated, otherwise false. + The that is invalid will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is less than or equal to zero. + + + + Updates play orders of a playlist. + + The playlist id. + The collection of to apply. + true if the matched record was found and updated, otherwise false. + The that is invalid will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + has no element.\n + -or-\n + contains a null value. + + is less than or equal to zero. + + + + Represents a member of . + + + + + Gets the member id. + + The member id of playlist. + + + + Gets the media info of the member. + + The of the member. + + + + Base class for query arguments. + + + A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist + and MediaInfo on basis of details like limit, order and condition. + + + + + + Gets or sets the storage id for the given filter. + You can use this property when you want to search items only in the specific storage. + + The storage id to restrict storage to search, or null for all storages. + is a zero-length string, contains only white space. + + + + Provides the ability to filter the result of a Select command. + + + A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist + and MediaInfo. + + + + + Gets or sets the starting row position of a query(starting from zero). + + An integer value that indicates the starting row position of a query. + is less than zero.\n + + + + Gets or sets the number of rows to be retrieved. + + An integer value that indicates the limit of rows of the result. + is less than zero. + + + + Gets or sets the sort order of the results. + + The expression for the sort order. + + Expressions for the sort order can be:\n + column [COLLATE NOCASE/RTRIM/LOCALIZED] [ASC/DESC], column2 ... + + is a zero-length string, contains only white space. + + + + + + + + + + + Provides the ability to filter the result of a Count command. + + + A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist + and MediaInfo. + + + + + The exception that is thrown when no record is found in the database. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified error message. + + The message that describes the error. + + + + Initializes a new instance of the class with a specified error message + and a reference to the inner exception that is the cause of this exception. + + The message that describes the error. + The exception that is the cause of the current exception. + + + + Represents location of the object bounded by rectangle defined by + coordinates of top left corner, width and height. + + + + + Initializes a new instance of the Rectangle with the specified values. + + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + The Width of the rectangle. + The Height of the rectangle. + + + + Gets or sets the x-coordinate of the upper-left corner of the rectangle. + + The x-coordinate of the upper-left edge of the rectangle. + + + + Gets or sets the y-coordinate of the upper-left corner of the rectangle. + + The y-coordinate of the upper-left edge of the rectangle. + + + + Gets or sets the width of the rectangle. + + The width of the rectangle. + + + + Gets or sets the height of the rectangle. + + The height of the rectangle. + + + + Gets the x-coordinate of the left edge of the rectangle. + + The x-coordinate of the left edge of the rectangle. + + + + Gets the y-coordinate of the top edge of the rectangle. + + The y-coordinate of the top edge of the rectangle. + + + + Gets the x-coordinate of the right edge of the rectangle. + + The x-coordinate of the right edge of the rectangle. + + + + Gets the y-coordinate of the bottom edge of the rectangle. + + The y-coordinate of the bottom edge of the rectangle. + + + + Returns a string representation of the rectangle. + + A string representation of the current rectangle. + + + + Returns the hash code for this Rectangle structure. + + An integer that represents the hash code for this rectangle. + + + + Tests whether obj is a Rectangle structure with the same location and size of this Rectangle structure. + + A to compare. + + true if obj is a Rectangle structure and its X, Y, Width and Height properties are + equal to the corresponding properties of this Rectangle structure; otherwise, false. + + + + + Tests whether two Rectangle structures have equal location and size. + + A to compare. + A to compare. + true if the two Rectangle structures have equal X, Y, Width, and Height properties; otherwise, false. + + + + Tests whether two Rectangle structures differ in location or size. + + A to compare. + A to compare. + true if any of the X, Y, Width or Height properties of the two Rectangle structures are unequal; otherwise false. + + + + Represents the storage information for media. + + + The system generates the storage id when the external storage is added. and manages the media information + in each of the storage by using storage id. + + + + + Gets the id of the storage. + + The unique id of the storage. + + + + Gets the path of the storage. + + The path of the storage. + + + + Gets the type of the storage. + + The type of the storage. + + + + Returns a string representation of the storage. + + A string representation of the current storage. + + + + Provides commands to manage external storages in the database. + + + Internal storage is not managed. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of storages. + + The number of storages. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of storages with . + + The criteria to use to filter. This value can be null. + The number of storages filtered. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the storage with the specified id. + + The storage id to select. + The instance if the matched record was found in the database, otherwise null. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves all the storages. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the storages with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of media info of the storage. + + The storage id. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the number of media info of the storage with . + + The storage id to query with. + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the media info of the storage. + + The storage id. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Retrieves the media info of the storage with . + + The storage id. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + + + + Represents a special piece of information that may be associated with media.\n + Tagging allows a user to organize large number of items into logical groups providing + a simplified and faster way of accessing media items. + + + + + Gets the id of the tag. + + The unique id of the tag. + + + + Gets the name of the tag. + + The name of the tag. + + + + Returns a string representation of the tag. + + A string representation of the current tag. + + + + Provides commands to manage tags in the database. + + + + + + Initializes a new instance of the class with the specified . + + A that the commands run on. + is null. + has already been disposed of. + + + + Retrieves the number of tags. + + The number of tags. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of tags with . + + The criteria to use to filter. This value can be null. + The number of tags filtered. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Deletes a tag from the database. + + http://tizen.org/privilege/content.write + The tag id to delete. + true if the matched record was found and deleted, otherwise false. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + The caller has no required privilege. + + + + Inserts a tag into the database with the specified name. + + http://tizen.org/privilege/content.write + The name of tag. + The instance that contains the record information inserted. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + The caller has no required privilege. + + + + Updates a tag with the specified name. + + http://tizen.org/privilege/content.write + The tag id to update. + The new name. + true if the matched record was found and updated, otherwise false. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is less than or equal to zero. + The caller has no required privilege. + + + + Retrieves the tag with the specified id. + + The tag id to select. + The instance if the matched record was found in the database, otherwise null. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves all the tags. + + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the tags with . + + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + + + + Retrieves the number of media info of the tag. + + The tag id. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the number of media info of the tag with . + + The tag id to query with. + The criteria to use to filter. This value can be null. + The number of media info. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the media info of the tag. + + The tag id. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Retrieves the media info of the tag with . + + The tag id. + The criteria to use to filter. This value can be null. + The containing the results. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is less than or equal to zero. + + + + Adds media to a tag. + + The tag id that the media will be added to. + The media id to add to the tag. + true if the matched record was found and updated, otherwise false. + The invalid media id will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + is less than or equal to zero. + + + + Adds a media set to a tag. + + The tag id that the media will be added to. + The media id to add to the tag. + true if the matched record was found and updated, otherwise false. + The invalid media ids will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + has no element.\n + -or-\n + contains null value.\n + -or-\n + contains a zero-length string, contains only white space.\n + + is less than or equal to zero. + + + + Removes media from a tag. + + The tag id. + The media id to remove from the tag. + true if the matched record was found and updated, otherwise false. + The invalid media id will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + is a zero-length string, contains only white space. + is less than or equal to zero. + + + + Removes a media set from a tag. + + The tag id. + The collection of media id to remove from the tag. + true if the matched record was found and updated, otherwise false. + The invalid ids will be ignored. + The is disconnected. + The has already been disposed of. + An error occurred while executing the command. + is null. + + has no element.\n + -or-\n + contains null value.\n + -or-\n + contains a zero-length string or white space.\n + + is less than or equal to zero. + + + + The exception that is thrown when a requested operation is not supported for content. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified error message. + + The message that describes the error. + + + + Initializes a new instance of the class with a specified error message + and a reference to the inner exception that is the cause of this exception. + + The message that describes the error. + The exception that is the cause of the current exception. + + + + Represents a video media information. + + + + + Gets the album name. + + The album name from the metadata. + + + + Gets the artist name. + + The artist name from the metadata. + + + + Gets the album artist name. + + The album artist name from the metadata. + + + + Gets the genre. + + The genre name from the metadata. + + + + Gets the composer name. + + The composer name from the metadata. + + + + Gets the year. + + The year from the metadata. + + + + Gets the recorded date. + + The recorded date information from the metadata if exists; otherwise, the modified date of the file. + + + + Gets the copyright notice. + + The copyright notice from the metadata. + + + + Gets the track number. + + The track number from the metadata. + + + + Gets the bitrate in bit per second. + + The bit rate of the video. + + + + Gets the track duration in milliseconds. + + The track duration of the video in milliseconds. + + + + Gets the video width in pixels. + + The width of the video in pixels. + + + + Gets the video height in pixels. + + The height of the video in pixels. + + + diff --git a/Artifacts/bin/Tizen.Content.MimeType.dll b/Artifacts/bin/Tizen.Content.MimeType.dll index 1ae7ab7..4552b5a 100644 Binary files a/Artifacts/bin/Tizen.Content.MimeType.dll and b/Artifacts/bin/Tizen.Content.MimeType.dll differ diff --git a/Artifacts/bin/Tizen.Content.MimeType.pdb b/Artifacts/bin/Tizen.Content.MimeType.pdb index 4444fc4..f4fd720 100644 Binary files a/Artifacts/bin/Tizen.Content.MimeType.pdb and b/Artifacts/bin/Tizen.Content.MimeType.pdb differ diff --git a/Artifacts/bin/Tizen.Content.MimeType.xml b/Artifacts/bin/Tizen.Content.MimeType.xml index 445f98f..110acd1 100644 --- a/Artifacts/bin/Tizen.Content.MimeType.xml +++ b/Artifacts/bin/Tizen.Content.MimeType.xml @@ -1,30 +1,30 @@ - - - - Tizen.Content.MimeType - - - - - The MimeUtil API provides functions to map the MIME types to file extensions and vice versa. - - Conversions are provided from the file extensions to MIME types and from the MIME types to file extensions. - - - - Gets the MIME type for the given file extension. - The MIME type is 'application/octet-stream' if the given file extension is not associated with specific file formats. - - The file extension. - - - string mimeType = MimeUtil.GetMimeType("png"); - - - - - - - - - + + + + Tizen.Content.MimeType + + + + + The MimeUtil API provides functions to map the MIME types to file extensions and vice versa. + + Conversions are provided from the file extensions to MIME types and from the MIME types to file extensions. + + + + Gets the MIME type for the given file extension. + The MIME type is 'application/octet-stream' if the given file extension is not associated with specific file formats. + + The file extension. + + + string mimeType = MimeUtil.GetMimeType("png"); + + + + + + + + + diff --git a/Artifacts/bin/Tizen.Context.dll b/Artifacts/bin/Tizen.Context.dll index a6dbcd7..5fb6363 100644 Binary files a/Artifacts/bin/Tizen.Context.dll and b/Artifacts/bin/Tizen.Context.dll differ diff --git a/Artifacts/bin/Tizen.Context.pdb b/Artifacts/bin/Tizen.Context.pdb index c4755b2..9ac681f 100644 Binary files a/Artifacts/bin/Tizen.Context.pdb and b/Artifacts/bin/Tizen.Context.pdb differ diff --git a/Artifacts/bin/Tizen.Context.xml b/Artifacts/bin/Tizen.Context.xml index 48de776..f553ca9 100644 --- a/Artifacts/bin/Tizen.Context.xml +++ b/Artifacts/bin/Tizen.Context.xml @@ -1,195 +1,195 @@ - - - - Tizen.Context - - - - - Base class for application statistics. - - - - - Base class which contains application statistics query result. - - - - - Gets the application id. - - The application id. - - - - This class provides APIs to query battery consumption per application. - - - - - The default constructor of BatteryStatistics class. - - http://tizen.org/feature/battery - Thrown when method fail due to internal error. - Thrown when the statistics is not supported. - - - - The constructor of BatteryStatistics class. - - The criteria of the battery statistics sorted by. - http://tizen.org/feature/battery - Thrown when an invalid argument is used. - Thrown when method fail due to internal error. - Thrown when the statistics is not supported. - - - - Retrieves a given type of battery statistics. - - The start time of the data to be aggregated. - The end time of the data to be aggregated. - Battery statistics data retrieved. - http://tizen.org/privilege/apphistory.read - Thrown when an invalid argument is used. - Thrown when invalid operation occurs. - Thrown when the app has no privilege to retrieve app history. - - - - Retrieves a given type of battery statistics. - - The start time of the data to be aggregated. - The end time of the data to be aggregated. - The number of data records to be retrieved. - Battery statistics data retrieved. - http://tizen.org/privilege/apphistory.read - Thrown when an invalid argument is used. - Thrown when invalid operation occurs. - Thrown when the app has no privilege to retrieve app history. - - - - Gets the last time when the device was fully charged. - - The last time when the device was fully charged. - http://tizen.org/feature/battery - Thrown when the statistics is not supported. - - - - Gets the criteria of battery statistics sorted by. - - The criteria of battery statistics sorted by. - - - - Sort order type of battery statistics. - - - - - Sorts apps by consumption, the most battery consuming apps appear first. (Default) - - - - - The class contains battery statistics information retrieved by BatteryStatistics. - - - - - Gets how many percentage of battery capacity was used by the application. - - Battery consumption used by the application. - - - - This class provides APIs to query application launch history. - - - - - The default constructor of UsageStatistics class. - - Thrown when method fail due to internal error. - - - - The constructor of UsageStatistics class. - - The criteria of the usage statistics sorted by. - Thrown when an invalid argument is used. - Thrown when method fail due to internal error. - - - - Retrieves a given type of usage statistics. - - The start time of the data to be aggregated. - The end time of the data to be aggregated. - Usage statistics data retrieved. - http://tizen.org/privilege/apphistory.read - Thrown when an invalid argument is used. - Thrown when invalid operation occurs. - Thrown when the app has no privilege to retrieve app history. - - - - Retrieves a given type of usage statistics. - - The start time of the data to be aggregated. - The end time of the data to be aggregated. - The number of data records to be retrieved. - Usage statistics data retrieved. - http://tizen.org/privilege/apphistory.read - Thrown when an invalid argument is used. - Thrown when invalid operation occurs. - Thrown when the app has no privilege to retrieve app history. - - - - Gets the criteria of usage statistics sorted by. - - The criteria of usage statistics sorted by. - - - - Sort order type of usage statistics - - - - - Sorts apps by the last launch time, the most recently launched apps appear first. (Default) - - - - - Sorts apps by the launch count of being launched, the most frequently launched apps appear first. - - - - - The class contains application usage statistics information retrieved by UsageStatistics. - - - - - Gets the time which the application is being displayed in the foreground in seconds. - - Duration which the application is used in the foreground in seconds. - - - - Gets how many times the application is used in the foreground. - - How many times the application is used in the foreground. - - - - Gets the last time when the application has been used. - - The last time when the application has been used. - - - + + + + Tizen.Context + + + + + Base class for application statistics. + + + + + Base class which contains application statistics query result. + + + + + Gets the application id. + + The application id. + + + + This class provides APIs to query battery consumption per application. + + + + + The default constructor of BatteryStatistics class. + + http://tizen.org/feature/battery + Thrown when method fail due to internal error. + Thrown when the statistics is not supported. + + + + The constructor of BatteryStatistics class. + + The criteria of the battery statistics sorted by. + http://tizen.org/feature/battery + Thrown when an invalid argument is used. + Thrown when method fail due to internal error. + Thrown when the statistics is not supported. + + + + Retrieves a given type of battery statistics. + + The start time of the data to be aggregated. + The end time of the data to be aggregated. + Battery statistics data retrieved. + http://tizen.org/privilege/apphistory.read + Thrown when an invalid argument is used. + Thrown when invalid operation occurs. + Thrown when the app has no privilege to retrieve app history. + + + + Retrieves a given type of battery statistics. + + The start time of the data to be aggregated. + The end time of the data to be aggregated. + The number of data records to be retrieved. + Battery statistics data retrieved. + http://tizen.org/privilege/apphistory.read + Thrown when an invalid argument is used. + Thrown when invalid operation occurs. + Thrown when the app has no privilege to retrieve app history. + + + + Gets the last time when the device was fully charged. + + The last time when the device was fully charged. + http://tizen.org/feature/battery + Thrown when the statistics is not supported. + + + + Gets the criteria of battery statistics sorted by. + + The criteria of battery statistics sorted by. + + + + Sort order type of battery statistics. + + + + + Sorts apps by consumption, the most battery consuming apps appear first. (Default) + + + + + The class contains battery statistics information retrieved by BatteryStatistics. + + + + + Gets how many percentage of battery capacity was used by the application. + + Battery consumption used by the application. + + + + This class provides APIs to query application launch history. + + + + + The default constructor of UsageStatistics class. + + Thrown when method fail due to internal error. + + + + The constructor of UsageStatistics class. + + The criteria of the usage statistics sorted by. + Thrown when an invalid argument is used. + Thrown when method fail due to internal error. + + + + Retrieves a given type of usage statistics. + + The start time of the data to be aggregated. + The end time of the data to be aggregated. + Usage statistics data retrieved. + http://tizen.org/privilege/apphistory.read + Thrown when an invalid argument is used. + Thrown when invalid operation occurs. + Thrown when the app has no privilege to retrieve app history. + + + + Retrieves a given type of usage statistics. + + The start time of the data to be aggregated. + The end time of the data to be aggregated. + The number of data records to be retrieved. + Usage statistics data retrieved. + http://tizen.org/privilege/apphistory.read + Thrown when an invalid argument is used. + Thrown when invalid operation occurs. + Thrown when the app has no privilege to retrieve app history. + + + + Gets the criteria of usage statistics sorted by. + + The criteria of usage statistics sorted by. + + + + Sort order type of usage statistics + + + + + Sorts apps by the last launch time, the most recently launched apps appear first. (Default) + + + + + Sorts apps by the launch count of being launched, the most frequently launched apps appear first. + + + + + The class contains application usage statistics information retrieved by UsageStatistics. + + + + + Gets the time which the application is being displayed in the foreground in seconds. + + Duration which the application is used in the foreground in seconds. + + + + Gets how many times the application is used in the foreground. + + How many times the application is used in the foreground. + + + + Gets the last time when the application has been used. + + The last time when the application has been used. + + + diff --git a/Artifacts/bin/Tizen.Convergence.dll b/Artifacts/bin/Tizen.Convergence.dll index b841428..88702af 100644 Binary files a/Artifacts/bin/Tizen.Convergence.dll and b/Artifacts/bin/Tizen.Convergence.dll differ diff --git a/Artifacts/bin/Tizen.Convergence.pdb b/Artifacts/bin/Tizen.Convergence.pdb index efc5d86..ca2d817 100644 Binary files a/Artifacts/bin/Tizen.Convergence.pdb and b/Artifacts/bin/Tizen.Convergence.pdb differ diff --git a/Artifacts/bin/Tizen.Convergence.xml b/Artifacts/bin/Tizen.Convergence.xml index 2a0f191..d9d2175 100644 --- a/Artifacts/bin/Tizen.Convergence.xml +++ b/Artifacts/bin/Tizen.Convergence.xml @@ -1,359 +1,359 @@ - - - - Tizen.Convergence - - - - - Discovery Error - - - - - Discovery Success - - - - - Discovery finished - - - - - Discovery lost - - - - - Undefined service - - - - - App-to-app communication service - - - - - Remote app-control service - - - - - Wrapper class for maintaining names of dependent native libraries. - - - - - The class provides APIs to support App to App communication service which relies on a remote server. - The initialization and execution of a server app (the app on the side with the Remote Server, e.g. TV) and a client app (e.g. the app on the mobile or wearable device) are slightly different. - On the server side an instance of the App Communication Service should be created and started by the app. Note, on the client side the service handle shouldn’t be created, but obtained during discovery. - For more information, refer Tizen D2D convergence specification - - - - - The constructor - - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - - - - Starts and initiates the service - - Channel to specify a logical session for the service - Contains additional data for start request. Refer D2D Convergence specification for more information - http://tizen.org/privilege/internet - http://tizen.org/privilege/bluetooth - http://tizen.org/privilege/d2d.datasharing - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown when the request is not supported as per Tizen D2D convergence specification - Thrown when any of the arugments are null - The result of the request is delivered through this event - - - - Reads data from the channel opened on the service - - Channel representing a logical session on the service - Contains additional data for start request. Refer D2D Convergence specification for more information - http://tizen.org/privilege/internet - http://tizen.org/privilege/bluetooth - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown when the request is not supported as per Tizen D2D convergence specification - Thrown when any of the arugments are null - The result of the request is delivered through this event - - - - Publishes a message to the remote server application - - Channel representing a logical session on the service - Contains additional data for start request. Refer D2D Convergence specification for more information - http://tizen.org/privilege/internet - http://tizen.org/privilege/bluetooth - http://tizen.org/privilege/d2d.datasharing - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown when the request is not supported as per Tizen D2D convergence specification - Thrown when any of the arugments are null - The result of the request is delivered through this event - - - - Stops the channel opened on the remote server application - - Channel representing a logical session on the service - Contains additional data for start request. Refer D2D Convergence specification for more information - http://tizen.org/privilege/internet - http://tizen.org/privilege/bluetooth - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown when the request is not supported as per Tizen D2D convergence specification - Thrown when any of the arugments are null - The result of the request is delivered through this event - - - - The Channel class provies a logical session for communicating with AppCommunicationService. - - - - - The constructor - - Uri of the server side app - Unique identifier - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Throws when the arguments passed are null - - - - Uri of the server side app - - - - - Unique identifier - - - - - The dispose method - - - - - The class encapsulates a D2D convergence compliant device information - - - - - The Unique ID of the device - - - - - Name of the device - - - - - The profile of the device - - - - - List of services supported by the device - - - - - The dispose method - - - - - DeviceFinder provides API to find all nearby Tizen D2D convergence compliant devices - - - - - The constructor - - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - - - - DeviceFound event is triggered when a device is found during discovery procedure - - - - - Starts the discovery of nearby devices - - Seconds for discovery timeout. 0 will use default timeout value - Cancellation token required to cancel the current discovery - http://tizen.org/privilege/internet - http://tizen.org/privilege/bluetooth - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown when the request is not supported as per Tizen D2D convergence specification - Devices found are delivered through this event - Task with discovery result - - - - The dispose method - - - - - Contains arguments for the event DeviceFound. - - - - - The device found - - - - - Represents a payload used in Tizen D2D convergence - - - - - The constructor - - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - - - - Adds a key-value pair to payload - - The key of the attribute - The value of the attribute - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown if the arguments passed are null - - - - Adds a key-value pair to payload - - The key of the attribute - The value of the attribute - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown if the arguments passed are null - - - - Sets binary to payload. - - The binary to set - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown if the arguments passed are null - - - - Gets the value of the key from payload - - The key of the attribute - The value of the attribute - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown if the arguments passed are null - Thrown if the key is not found - - - - Gets the value of the key from payload - - The key of the attribute - The value of the attribute - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - Thrown if the arguments passed are null - Thrown if the key is not found - - - - Gets binary from payload - - The result value - http://tizen.org/feature/convergence.d2d - Thrown if the required feature is not supported. - - - - The dispose method - - - - - The class abstracts the features provided by Tizen D2D Convergence. - - - - - - The ID of the service - - - - - The Version of the service - - - - - The event handler for Service Events(Start/Publish/Read/Stop) - - - - - The event handler for service error events - - - - - The dispose method - - - - - Contains arguments for the event ServiceErrorOccured. - - - - - The exception - - - - - Contains arguments for ServiceEventOccured - - - - - The channel on which the event occured - - - - - The payload containing the result - - - - + + + + Tizen.Convergence + + + + + Discovery Error + + + + + Discovery Success + + + + + Discovery finished + + + + + Discovery lost + + + + + Undefined service + + + + + App-to-app communication service + + + + + Remote app-control service + + + + + Wrapper class for maintaining names of dependent native libraries. + + + + + The class provides APIs to support App to App communication service which relies on a remote server. + The initialization and execution of a server app (the app on the side with the Remote Server, e.g. TV) and a client app (e.g. the app on the mobile or wearable device) are slightly different. + On the server side an instance of the App Communication Service should be created and started by the app. Note, on the client side the service handle shouldn’t be created, but obtained during discovery. + For more information, refer Tizen D2D convergence specification + + + + + The constructor + + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + + + + Starts and initiates the service + + Channel to specify a logical session for the service + Contains additional data for start request. Refer D2D Convergence specification for more information + http://tizen.org/privilege/internet + http://tizen.org/privilege/bluetooth + http://tizen.org/privilege/d2d.datasharing + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown when the request is not supported as per Tizen D2D convergence specification + Thrown when any of the arugments are null + The result of the request is delivered through this event + + + + Reads data from the channel opened on the service + + Channel representing a logical session on the service + Contains additional data for start request. Refer D2D Convergence specification for more information + http://tizen.org/privilege/internet + http://tizen.org/privilege/bluetooth + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown when the request is not supported as per Tizen D2D convergence specification + Thrown when any of the arugments are null + The result of the request is delivered through this event + + + + Publishes a message to the remote server application + + Channel representing a logical session on the service + Contains additional data for start request. Refer D2D Convergence specification for more information + http://tizen.org/privilege/internet + http://tizen.org/privilege/bluetooth + http://tizen.org/privilege/d2d.datasharing + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown when the request is not supported as per Tizen D2D convergence specification + Thrown when any of the arugments are null + The result of the request is delivered through this event + + + + Stops the channel opened on the remote server application + + Channel representing a logical session on the service + Contains additional data for start request. Refer D2D Convergence specification for more information + http://tizen.org/privilege/internet + http://tizen.org/privilege/bluetooth + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown when the request is not supported as per Tizen D2D convergence specification + Thrown when any of the arugments are null + The result of the request is delivered through this event + + + + The Channel class provies a logical session for communicating with AppCommunicationService. + + + + + The constructor + + Uri of the server side app + Unique identifier + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Throws when the arguments passed are null + + + + Uri of the server side app + + + + + Unique identifier + + + + + The dispose method + + + + + The class encapsulates a D2D convergence compliant device information + + + + + The Unique ID of the device + + + + + Name of the device + + + + + The profile of the device + + + + + List of services supported by the device + + + + + The dispose method + + + + + DeviceFinder provides API to find all nearby Tizen D2D convergence compliant devices + + + + + The constructor + + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + + + + DeviceFound event is triggered when a device is found during discovery procedure + + + + + Starts the discovery of nearby devices + + Seconds for discovery timeout. 0 will use default timeout value + Cancellation token required to cancel the current discovery + http://tizen.org/privilege/internet + http://tizen.org/privilege/bluetooth + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown when the request is not supported as per Tizen D2D convergence specification + Devices found are delivered through this event + Task with discovery result + + + + The dispose method + + + + + Contains arguments for the event DeviceFound. + + + + + The device found + + + + + Represents a payload used in Tizen D2D convergence + + + + + The constructor + + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + + + + Adds a key-value pair to payload + + The key of the attribute + The value of the attribute + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown if the arguments passed are null + + + + Adds a key-value pair to payload + + The key of the attribute + The value of the attribute + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown if the arguments passed are null + + + + Sets binary to payload. + + The binary to set + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown if the arguments passed are null + + + + Gets the value of the key from payload + + The key of the attribute + The value of the attribute + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown if the arguments passed are null + Thrown if the key is not found + + + + Gets the value of the key from payload + + The key of the attribute + The value of the attribute + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + Thrown if the arguments passed are null + Thrown if the key is not found + + + + Gets binary from payload + + The result value + http://tizen.org/feature/convergence.d2d + Thrown if the required feature is not supported. + + + + The dispose method + + + + + The class abstracts the features provided by Tizen D2D Convergence. + + + + + + The ID of the service + + + + + The Version of the service + + + + + The event handler for Service Events(Start/Publish/Read/Stop) + + + + + The event handler for service error events + + + + + The dispose method + + + + + Contains arguments for the event ServiceErrorOccured. + + + + + The exception + + + + + Contains arguments for ServiceEventOccured + + + + + The channel on which the event occured + + + + + The payload containing the result + + + + diff --git a/Artifacts/bin/Tizen.Location.Geofence.dll b/Artifacts/bin/Tizen.Location.Geofence.dll index 9bc1209..fe68361 100644 Binary files a/Artifacts/bin/Tizen.Location.Geofence.dll and b/Artifacts/bin/Tizen.Location.Geofence.dll differ diff --git a/Artifacts/bin/Tizen.Location.Geofence.pdb b/Artifacts/bin/Tizen.Location.Geofence.pdb index f11ef80..460662a 100644 Binary files a/Artifacts/bin/Tizen.Location.Geofence.pdb and b/Artifacts/bin/Tizen.Location.Geofence.pdb differ diff --git a/Artifacts/bin/Tizen.Location.Geofence.xml b/Artifacts/bin/Tizen.Location.Geofence.xml index a7ce221..57e0d79 100644 --- a/Artifacts/bin/Tizen.Location.Geofence.xml +++ b/Artifacts/bin/Tizen.Location.Geofence.xml @@ -1,812 +1,812 @@ - - - - Tizen.Location.Geofence - - - - - Geofence defines a virtual perimeter for a real-world geographic area. - If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you. - You can create a geofence with the information of the Geopoint, Wi-Fi, or BT. - - Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius. - WIFI: Geofence is specified by the BSSID of the Wi-Fi access point. - BT: Geofence is specified by the Bluetooth address. - - The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity) - and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP. - - 3 - - - - Gets the type of geofence. - - 3 - - - - Gets the ID of the place. - - 3 - - - - Gets the longitude of geofence. - - 3 - - - - Gets the latitude of geofence. - - 3 - - - - Gets the radius of geofence. - - 3 - - - - Gets the address of geofence. - - 3 - - - - Gets the BSSID of geofence. - - 3 - - - - Gets the SSID of geofence. - - 3 - - - - Creates a geopoint type of the new geofence. - - 3 - The current place ID. - Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees). - Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees). - Specifies the value of radius of the geofence [100 ~ 500](meter). - Specifies the value of the address. - The newly created geofence instance. - In case of an invalid parameter. - In case of any system error. - In case the geofence is not supported. - - - - Creates a Wi-Fi type of the new geofence. - - 3 - The current place ID. - Specifies the value of BSSID of the Wi-Fi MAC address. - Specifies the value of SSID of the Wi-Fi device. - The newly created geofence instance. - In case of an invalid parameter. - In case of any system error. - In case the geofence is not supported. - - - - Creates a Bluetooth type of the new geofence. - - 3 - The current place ID. - Specifies the value of BSSID of BT MAC address. - Specifies the value of SSID of BT Device. - The newly created geofence instance. - In case of an invalid parameter. - In case of any system error. - In case the geofence is not supported. - - - - The overloaded Dispose API for destroying the fence handle. - - 3 - - - - Represents the geofence list item data. - - 3 - - - - The geofence instance. - - 3 - - - - The geofence ID. - - 3 - - - - The index number of fences in the list. - - 3 - The index value starts from 1. - - - - The total number of fences that exists for the requester. - - 3 - - - - Represents the place list item data. - - 3 - - - - The current place ID. - - 3 - - - - The current place name. - - 3 - - - - The index number of places in the list. - - 3 - The index value starts from 1. - - - - The total number of places that exists for the requester. - - 3 - - - - The geofence status describes the current state and duration of a geofence. - - State: The state is specified by the current state of the fence. - Duration: Geofence is specified by the duration of the current state. - - - 3 - - - - Creates a new geofence status. - - 3 - In case of an invalid parameter. - In case of geofence is not supported. - - - - Gets the state of geofence. - - 3 - In case the geofence is not supported. - - - - Gets the amount of seconds, the geofence is in the current state. - - 3 - In case the geofence is not supported. - - - - The overloaded Dispose API for destroying the fence handle. - - 3 - - - - Enumeration for the geofence types. - - 3 - - - - Geofence is specified by the geospatial coordinate. - - 3 - - - - Geofence is specified by the Wi-Fi access point. - - 3 - - - - Geofence is specified by the Bluetooth device. - - 3 - - - - Enumeration for the state of geofence. - - 3 - - - - Uncertain state of geofence. - - 3 - - - - Geofence In state. - - 3 - - - - Geofence Out state. - - 3 - - - - Enumeration for the geofence management events. - - 3 - - - - Geofence is added. - - 3 - - - - Geofence is removed. - - 3 - - - - Geofencing is started. - - 3 - - - - Geofencing is stopped. - - 3 - - - - Place is added. - - 3 - - - - Place is removed. - - 3 - - - - Place is updated. - - 3 - - - - Setting for geofencing is enabled. - - 3 - - - - Setting for geofencing is disabled. - - 3 - - - - Enumeration for the provider of proximity. - - 3 - - - - Proximity is specified by the geospatial coordinate. - - 3 - - - - Proximity is specified by the Wi-Fi access point. - - 3 - - - - Proximity is specified by the Bluetooth device. - - 3 - - - - Proximity is specified by the Bluetooth low-energy device. - - 3 - - - - Proximity is specified by the sensor. - - 3 - - - - Enumeration for the state of proximity. - - 3 - - - - Uncertain state of proximity. - - 3 - - - - Far state of proximity. - - 3 - - - - Far state of proximity. - - 3 - - - - Immediate state of proximity. - - 3 - - - - Enumeration for the types of error occured, if any. - - 3 - - - - Successful. - - 3 - - - - Out of memory. - - 3 - - - - Invalid parameter. - - 3 - - - - Permission denied. - - 3 - - - - Not Supported. - - 3 - - - - Geofence manager is not initialized. - - 3 - - - - Invalid geofence ID. - - 3 - - - - Exception occurs. - - 3 - - - - Geofencing is already started. - - 3 - - - - Too many geofence. - - 3 - - - - Error in GPS, Wi-Fi, or BT. - - 3 - - - - DB error in the server side. - - 3 - - - - Access to the specified place is denied. - - 3 - - - - Access to the specified geofence is denied. - - 3 - - - - Event arguments are passed when an event is triggered to notify the proximity state change. - - 3 - - - - The internal constructor. - - 3 - The geofence ID. - The proximity state. - The proximity provider. - - - - The geofence ID. - - 3 - - - - The proximity state. - - 3 - - - - The proximity provider. - - 3 - - - - Event arguments are passed when an event is triggered to notify the geofence state change. - - 3 - - - - The internal constructor. - - 3 - The specified geofence ID. - The geofence state. - - - - The specified geofence ID. - - 3 - - - - The geofence state. - - 3 - - - - Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc.. - - 3 - - - - The internal constructor. - - 3 - The place ID. - The specified geofence ID. - The error code for the particular action. - The result code for the particular place and geofence management. - - - - The place ID. - - 3 - - - - The specified geofence ID. - - 3 - - - - The error code for the particular action. - - 3 - - - - The result code for the particular place and geofence management. - - 3 - - - - The Geofence Manager API provides service related to geofence (geo-fence). - Geofence is a virtual perimeter for a real-world geographic area. - This API provides functions to set geofence 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 are created by the MyPlace application that can be used by all applications. - Private places and fences are created by the specified application that 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 the geofence module. - - - 3 - - - - Creates a new Geofence manager. - - 3 - In case of out of memory condition. - In case of any system error. - In case the geofence is not supported. - - - - Checks whether the Geofence manager is available or not. - - 3 - - - - Starts the geofencing service. - - 3 - The specified geofence ID. - http://tizen.org/privilege/location - - When the location service is enabled, the StateChanged event is invoked and the service starts. - - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Stops the geofenceing service. - - 3 - The specified geofence ID. - http://tizen.org/privilege/location - - This function initiates the process of stopping the service. - You can stop and start the Geofence manager as needed. - - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Invokes when a device enters or exits the given geofence if this event is registered. - - 3 - - Call to Start() will invoke this event. - - In case the feature is not supported. - - - - Called when the proximity state of a device is changed. - - 3 - - Call to Start() will invoke this event. - - In case the feature is not supported. - - - - Called when some event occurs in the geofence and the place, such as add, update, etc.. - The events of public geofence is also received if there are public geofences. - - 3 - - Call to Start() will invoke this event. - The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned. - - In case the feature is not supported. - - - - The overloaded Dispose API for destroying the GeofenceManager handle. - - 3 - - - - Allows to create a virtual fence as geofence using the GeofenceManager instance. - A user can manage all the geofence or place related data and events. - - 3 - - - - Creates a VirtualPerimeter which can be used to create a virtual fence. - - 3 - The GeofenceManager instance. - In case of an invalid parameter. - - - - Creates a new place for the geofencing service. - - 3 - A place name to be created. - The place ID to be newly created on success. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Updates the place name of a given place ID. - - 3 - The specified place ID. - A new place name of the place ID. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any System error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Removes the specific place for the geofencing service. - - 3 - The specified place ID. - http://tizen.org/privilege/location - Incase of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Adds the geofence for a given Geofence manager. - - 3 - The geofence instance to be added. - The geofence ID to be newly created on success. - The return value will always be a number greater than zero. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Removes the geofence with a given geofence ID. - - 3 - The specified geofence ID. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Gets the name of place. - - 3 - The place ID. - The name of the place. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Retrieves a list of places registered in the specified Geofence manager. - - 3 - List of places registered as the PlaceData instance list. - http://tizen.org/privilege/location - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - - Retrieves a list of fences registered in the specified Geofence manager. - - 3 - List of FenceData instances registered for each geofence. - http://tizen.org/privilege/location - In case of any system error. - In case privileges are not defined. - In case geofence is not supported. - - - - Retrieves a list of fences registered in the specified place. - - 3 - The place ID. - The list of FenceData instances registered for each geofence for the specified place. - http://tizen.org/privilege/location - In case of an invalid parameter. - In case of any system error. - In case privileges are not defined. - In case the geofence is not supported. - - - + + + + Tizen.Location.Geofence + + + + + Geofence defines a virtual perimeter for a real-world geographic area. + If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you. + You can create a geofence with the information of the Geopoint, Wi-Fi, or BT. + + Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius. + WIFI: Geofence is specified by the BSSID of the Wi-Fi access point. + BT: Geofence is specified by the Bluetooth address. + + The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity) + and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP. + + 3 + + + + Gets the type of geofence. + + 3 + + + + Gets the ID of the place. + + 3 + + + + Gets the longitude of geofence. + + 3 + + + + Gets the latitude of geofence. + + 3 + + + + Gets the radius of geofence. + + 3 + + + + Gets the address of geofence. + + 3 + + + + Gets the BSSID of geofence. + + 3 + + + + Gets the SSID of geofence. + + 3 + + + + Creates a geopoint type of the new geofence. + + 3 + The current place ID. + Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees). + Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees). + Specifies the value of radius of the geofence [100 ~ 500](meter). + Specifies the value of the address. + The newly created geofence instance. + In case of an invalid parameter. + In case of any system error. + In case the geofence is not supported. + + + + Creates a Wi-Fi type of the new geofence. + + 3 + The current place ID. + Specifies the value of BSSID of the Wi-Fi MAC address. + Specifies the value of SSID of the Wi-Fi device. + The newly created geofence instance. + In case of an invalid parameter. + In case of any system error. + In case the geofence is not supported. + + + + Creates a Bluetooth type of the new geofence. + + 3 + The current place ID. + Specifies the value of BSSID of BT MAC address. + Specifies the value of SSID of BT Device. + The newly created geofence instance. + In case of an invalid parameter. + In case of any system error. + In case the geofence is not supported. + + + + The overloaded Dispose API for destroying the fence handle. + + 3 + + + + Represents the geofence list item data. + + 3 + + + + The geofence instance. + + 3 + + + + The geofence ID. + + 3 + + + + The index number of fences in the list. + + 3 + The index value starts from 1. + + + + The total number of fences that exists for the requester. + + 3 + + + + Represents the place list item data. + + 3 + + + + The current place ID. + + 3 + + + + The current place name. + + 3 + + + + The index number of places in the list. + + 3 + The index value starts from 1. + + + + The total number of places that exists for the requester. + + 3 + + + + The geofence status describes the current state and duration of a geofence. + + State: The state is specified by the current state of the fence. + Duration: Geofence is specified by the duration of the current state. + + + 3 + + + + Creates a new geofence status. + + 3 + In case of an invalid parameter. + In case of geofence is not supported. + + + + Gets the state of geofence. + + 3 + In case the geofence is not supported. + + + + Gets the amount of seconds, the geofence is in the current state. + + 3 + In case the geofence is not supported. + + + + The overloaded Dispose API for destroying the fence handle. + + 3 + + + + Enumeration for the geofence types. + + 3 + + + + Geofence is specified by the geospatial coordinate. + + 3 + + + + Geofence is specified by the Wi-Fi access point. + + 3 + + + + Geofence is specified by the Bluetooth device. + + 3 + + + + Enumeration for the state of geofence. + + 3 + + + + Uncertain state of geofence. + + 3 + + + + Geofence In state. + + 3 + + + + Geofence Out state. + + 3 + + + + Enumeration for the geofence management events. + + 3 + + + + Geofence is added. + + 3 + + + + Geofence is removed. + + 3 + + + + Geofencing is started. + + 3 + + + + Geofencing is stopped. + + 3 + + + + Place is added. + + 3 + + + + Place is removed. + + 3 + + + + Place is updated. + + 3 + + + + Setting for geofencing is enabled. + + 3 + + + + Setting for geofencing is disabled. + + 3 + + + + Enumeration for the provider of proximity. + + 3 + + + + Proximity is specified by the geospatial coordinate. + + 3 + + + + Proximity is specified by the Wi-Fi access point. + + 3 + + + + Proximity is specified by the Bluetooth device. + + 3 + + + + Proximity is specified by the Bluetooth low-energy device. + + 3 + + + + Proximity is specified by the sensor. + + 3 + + + + Enumeration for the state of proximity. + + 3 + + + + Uncertain state of proximity. + + 3 + + + + Far state of proximity. + + 3 + + + + Far state of proximity. + + 3 + + + + Immediate state of proximity. + + 3 + + + + Enumeration for the types of error occured, if any. + + 3 + + + + Successful. + + 3 + + + + Out of memory. + + 3 + + + + Invalid parameter. + + 3 + + + + Permission denied. + + 3 + + + + Not Supported. + + 3 + + + + Geofence manager is not initialized. + + 3 + + + + Invalid geofence ID. + + 3 + + + + Exception occurs. + + 3 + + + + Geofencing is already started. + + 3 + + + + Too many geofence. + + 3 + + + + Error in GPS, Wi-Fi, or BT. + + 3 + + + + DB error in the server side. + + 3 + + + + Access to the specified place is denied. + + 3 + + + + Access to the specified geofence is denied. + + 3 + + + + Event arguments are passed when an event is triggered to notify the proximity state change. + + 3 + + + + The internal constructor. + + 3 + The geofence ID. + The proximity state. + The proximity provider. + + + + The geofence ID. + + 3 + + + + The proximity state. + + 3 + + + + The proximity provider. + + 3 + + + + Event arguments are passed when an event is triggered to notify the geofence state change. + + 3 + + + + The internal constructor. + + 3 + The specified geofence ID. + The geofence state. + + + + The specified geofence ID. + + 3 + + + + The geofence state. + + 3 + + + + Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc.. + + 3 + + + + The internal constructor. + + 3 + The place ID. + The specified geofence ID. + The error code for the particular action. + The result code for the particular place and geofence management. + + + + The place ID. + + 3 + + + + The specified geofence ID. + + 3 + + + + The error code for the particular action. + + 3 + + + + The result code for the particular place and geofence management. + + 3 + + + + The Geofence Manager API provides service related to geofence (geo-fence). + Geofence is a virtual perimeter for a real-world geographic area. + This API provides functions to set geofence 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 are created by the MyPlace application that can be used by all applications. + Private places and fences are created by the specified application that 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 the geofence module. + + + 3 + + + + Creates a new Geofence manager. + + 3 + In case of out of memory condition. + In case of any system error. + In case the geofence is not supported. + + + + Checks whether the Geofence manager is available or not. + + 3 + + + + Starts the geofencing service. + + 3 + The specified geofence ID. + http://tizen.org/privilege/location + + When the location service is enabled, the StateChanged event is invoked and the service starts. + + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Stops the geofenceing service. + + 3 + The specified geofence ID. + http://tizen.org/privilege/location + + This function initiates the process of stopping the service. + You can stop and start the Geofence manager as needed. + + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Invokes when a device enters or exits the given geofence if this event is registered. + + 3 + + Call to Start() will invoke this event. + + In case the feature is not supported. + + + + Called when the proximity state of a device is changed. + + 3 + + Call to Start() will invoke this event. + + In case the feature is not supported. + + + + Called when some event occurs in the geofence and the place, such as add, update, etc.. + The events of public geofence is also received if there are public geofences. + + 3 + + Call to Start() will invoke this event. + The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned. + + In case the feature is not supported. + + + + The overloaded Dispose API for destroying the GeofenceManager handle. + + 3 + + + + Allows to create a virtual fence as geofence using the GeofenceManager instance. + A user can manage all the geofence or place related data and events. + + 3 + + + + Creates a VirtualPerimeter which can be used to create a virtual fence. + + 3 + The GeofenceManager instance. + In case of an invalid parameter. + + + + Creates a new place for the geofencing service. + + 3 + A place name to be created. + The place ID to be newly created on success. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Updates the place name of a given place ID. + + 3 + The specified place ID. + A new place name of the place ID. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any System error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Removes the specific place for the geofencing service. + + 3 + The specified place ID. + http://tizen.org/privilege/location + Incase of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Adds the geofence for a given Geofence manager. + + 3 + The geofence instance to be added. + The geofence ID to be newly created on success. + The return value will always be a number greater than zero. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Removes the geofence with a given geofence ID. + + 3 + The specified geofence ID. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Gets the name of place. + + 3 + The place ID. + The name of the place. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Retrieves a list of places registered in the specified Geofence manager. + + 3 + List of places registered as the PlaceData instance list. + http://tizen.org/privilege/location + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + + Retrieves a list of fences registered in the specified Geofence manager. + + 3 + List of FenceData instances registered for each geofence. + http://tizen.org/privilege/location + In case of any system error. + In case privileges are not defined. + In case geofence is not supported. + + + + Retrieves a list of fences registered in the specified place. + + 3 + The place ID. + The list of FenceData instances registered for each geofence for the specified place. + http://tizen.org/privilege/location + In case of an invalid parameter. + In case of any system error. + In case privileges are not defined. + In case the geofence is not supported. + + + diff --git a/Artifacts/bin/Tizen.Location.dll b/Artifacts/bin/Tizen.Location.dll index dbfc42d..e818e87 100644 Binary files a/Artifacts/bin/Tizen.Location.dll and b/Artifacts/bin/Tizen.Location.dll differ diff --git a/Artifacts/bin/Tizen.Location.pdb b/Artifacts/bin/Tizen.Location.pdb index 3cb33b6..8ab5bf9 100644 Binary files a/Artifacts/bin/Tizen.Location.pdb and b/Artifacts/bin/Tizen.Location.pdb differ diff --git a/Artifacts/bin/Tizen.Location.xml b/Artifacts/bin/Tizen.Location.xml index 13e963f..b0aecba 100644 --- a/Artifacts/bin/Tizen.Location.xml +++ b/Artifacts/bin/Tizen.Location.xml @@ -1,798 +1,798 @@ - - - - Tizen.Location - - - - - This class contains the functionality for obtaining information about GPS satellites in the range and in use. - - 3 - - - - The time interval between callback updates. - Should be in the range of 1~120 seconds. - - 3 - Thrown when an an invalid argument is used. - - - - The NMEA data from the satellite. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - The count of active satellites. - - 3 - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - The count of satellites in view. - - 3 - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - The list of satellites or last recorded satellites in view. - - 3 - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - The constructor of the GpsSatellite class. - - 3 - The locator object initilized using GPS. - Thrown when an invalid argument is used. - - - - The SatelliteStatusUpdated event is raised whenever the satellite information is updated. - The callback will be invoked periodically (every Interval seconds). - - 3 - http://tizen.org/privilege/location - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - This class contains the information of the satellite under consideration. - - 3 - - - - The Class constructor for the SatelliteInformation class. - - 3 - The azimuth value of the satellite in degrees. - The elevation of the satellite in meters. - The PRN value of the satellite. - The SNR value of the satellite in dB. - The flag signaling if the satellite is in use. - - - - The azimuth information of the satellite. - - 3 - The azimuth value of the satellite in degrees. - - - - The elevation information of the satellite. - - 3 - The azimuth value of the satellite in degrees. - - - - The PRN of the satellite. - - 3 - The azimuth value of the satellite in degrees. - - - - The SNR of the satellite. - - 3 - - - - The operational status of the satellite. - - 3 - - - - This class contains details of the location requested. - Includes the functionality to get the distance between locations. - - 3 - - - - The default constructor of the Location class. - - 3 - - - - The parameterized constructor of the Location class. - - 3 - The latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees). - The longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees). - The altitude value. - The accuracy in meters. - The device speed. - The device direction with respect to the north. - Time when the measurement took place. - Thrown when an invalid argument is used. - - - - The current latitude [-90.0 ~ 90.0] (degrees). - - 3 - - - - The current longitude [-180.0 ~ 180.0] (degrees). - - 3 - - - - The current altitude (meters). - - 3 - - - - The device speed (km/h). - - 3 - - - - The direction and degrees from the north. - - 3 - - - - The accuracy. - - 3 - - - - The time value when the measurement was done. - - 3 - - - - Gets the distance between the two given coordinates. - - 3 - The latitude of the source location [-90.0 ~ 90.0] (degrees). - The longitude of the source location[-180.0 ~ 180.0] (degrees). - The latitude of the source location [-90.0 ~ 90.0] (degrees). - The longitude of the source location[-180.0 ~ 180.0] (degrees). - Returns the distance between the source and the destination. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Gets the distance between the current and the specified location. - - 3 - The location object to which distance is to be calculated. - Returns the distance to the specified location. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The LocationBoundary class is an abstract class that provides functions related to the geographic bounds information. - - 3 - - - - Gets the location boundary type. - - 3 - - - - The destructor of the LocationBoundary class. - - 3 - - - - Checks if the boundary contains the specified geographical coordinates. - - 3 - The coordinate which needs to be checked. - Returns a boolean value indicating whether or not the specified coordinate lies in the geographical area. - - - - The overidden Dispose method of the IDisposable class. - - 3 - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - This class represents a rectangular location boundary. - Inherits the Abstract LocationBoundary class. - - 3 - - - - The constructor of the Rectangle boundary class. - - 3 - The coordinate which constitutes the top-left handside of the rectangular boundary. - The coordinate which constitutes the bottom-right handside of the rectangular boundary. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Gets the top-left handside coordinate of a rectangular boundary. - - 3 - - - - Gets the bottom-right handside coordinate of a rectangular boundary. - - 3 - - - - This class represents a circular location boundary. - Inherits the Abstract LocationBoundary class. - - 3 - - - - The constructor of the Circular boundary class. - - 3 - The coordinates which constitute the center of the circular boundary. - The radius value of the circular boundary. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Gets the coordinate of the center of a circular boundary. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Gets the radius of a circular boundary. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - This class represents a polygonal location boundary. - Inherits the Abstract LocationBoundary class. - - 3 - - - - The constructor of the Polygon Boundary class. - - 3 - The coordinates which constitute the polgonal boundary. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Gets the list of coordinates which constitute a polygonal boundary. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - This structure represents the coordinates of a geographical location. - - 3 - - - - Latitude component of the coordinate. - Should have a value between [-90.0 ~ 90.0] (degrees). - - 3 - - - - Longitude component of the coordinate. - Should have a value between [-180.0 ~ 180.0] (degrees). - - 3 - - - - An extended EventArgs class which contains the changed location information. - - 3 - - - - The class constructor for the LocationUpdatedEventArgs class. - - 3 - Object of the Location class. - - - - Gets the location update information. - - 3 - - - - Location Manager error codes. - - 3 - - - - - - - - - - - - - Location Boundary error codes. - - 3 - - - - - - - - - This class contains the functionality for obtaining the geographical infomation and setting the boundary condition. - Notifications on events like service becoming enabled or disabled, new position data being available, - and others can also be acquired. - - 3 - - - - The constructor of the Locator class. - - 3 - The back-end positioning method to be used for LBS. - http://tizen.org/feature/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The destructor of the Locator class. - - 3 - - - - The time interval between callback updates. - Should be in the range of 1~120 seconds. - - 3 - Thrown when an invalid argument is used. - - - - The time interval between the distance-based location callback updates. - Should be in the range of 1~120 seconds. - - 3 - Thrown when an invalid argument is used. - - - - The time interval between the position collection in batch mode. - Should be in the range of 1~255 seconds. - - 3 - Thrown when an invalid argument is used. - - - - The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific. - Should be in the range of 0~60000 seconds. - - 3 - Thrown when an invalid argument is used. - - - - The distance between callback updates. - Should be in the range of 1-120 meters. - - 3 - Thrown when an invalid argument is used. - - - - Gets the location object. - - 3 - - - - Gets the type used to obtain the location data. - - 3 - - - - Gets the status whether the mock location is enabled or not. - - 3 - http://tizen.org/privilege/location - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Starts the Location Manager which has been created using the specified method. - - 3 - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Stops the Location Manager which has been activated using the specified method. - Does not destroy the manager. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Sets a mock location for the given location method. - - 3 - The location object containing the mock location details. - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Clears a mock location for the given location method. - - 3 - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Gets the details of the location asynchronously. - - 3 - Timeout to stop requesting a single location after (seconds). - A task which contains the current location details. - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Gets the details of the location. - - 3 - Which contains the current location details. - http://tizen.org/privilege/location - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the application has no privilege to use the location. - Thrown when the location is not supported. - - - - Adds a bound for a given locator. - - 3 - The boundary object to be added to the locator. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Deletes a bound for a given locator. - - 3 - The boundary object to be removed from the locator. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The overidden Dispose method of the IDisposable class. - - 3 - Thrown when an invalid argument is used. - - - - The ServiceStateChanged event is invoked when the location service state is changed. - - 3 - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The ZoneChanged event is invoked when the previously set boundary area is entered or left. - - 3 - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The SetttingChanged event is raised when the location setting is changed. - - 3 - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The DistanceBasedLocationChanged event is raised with the updated location information. - The callback will be invoked at a minimum interval or minimum distance with the updated position information. - - 3 - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The LocationUpdated event is raised at defined intervals of time with the updated location information. - The callback will be invoked periodically. - - 3 - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - Enumeration for the state of the location service. - - 3 - - - - - Enumeration for the type of connection used in acquiring the location data. - - 3 - - - - - - - Enumeration for the created boundary type. - - 3 - - - - - - Enumeration for the error code for location manager. - - 3 - - - - - Checks if the specified geographical positioning type is supported or not. - - 3 - The back-end positioning method to be used for LBS. - Returns a boolean value indicating whether or not the specified method is supported. - - - - Checks if the specified geographical positioning type is enabled or not. - - 3 - The back-end positioning method to be used for LBS. - Returns a boolean value indicating whether or not the specified method is supported. - Thrown when the operation is invalid for the current state. - Thrown when an invalid argument is used. - Thrown when the location is not supported. - - - - The class constructor for the SatelliteStatusChangedEventArgs class. - - 3 - The number of active satellites. - The number of satellites in view. - The time at which the data has been extracted. - - - - Gets the number of active satellites. - - 3 - - - - Gets the number of satellites in view. - - 3 - - - - Get the timestamp. - - 3 - - - - An extended EventArgs class contains the changed location service state. - - - - - The class constructor for the ServiceStateChangedEventArgs class. - - 3 - An enumeration of type LocationServiceState. - - - - Get the service state. - - 3 - - - - The class constructor for the SettingChangedEventArgs class. - - 3 - The positioing method used for the location information. - The status of the method. - - - - Gets the currently used location method. - - 3 - - - - Method to get the setting value changed. - - 3 - - - - The class constructor for the ZoneChangedEventArgs class. - - 3 - An enumeration of type BoundaryState. - The latitude value [-90.0 ~ 90.0] (degrees). - The longitude value [-180.0 ~ 180.0] (degrees). - The altitude value. - The timestamp value. - - - - Gets the boundary state. - - 3 - - - - Gets the latitude. - - 3 - - - - Gets the longitude. - - 3 - - - - Gets the altitude. - - 3 - - - - Method to get the timestamp. - - 3 - - - + + + + Tizen.Location + + + + + This class contains the functionality for obtaining information about GPS satellites in the range and in use. + + 3 + + + + The time interval between callback updates. + Should be in the range of 1~120 seconds. + + 3 + Thrown when an an invalid argument is used. + + + + The NMEA data from the satellite. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + The count of active satellites. + + 3 + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + The count of satellites in view. + + 3 + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + The list of satellites or last recorded satellites in view. + + 3 + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + The constructor of the GpsSatellite class. + + 3 + The locator object initilized using GPS. + Thrown when an invalid argument is used. + + + + The SatelliteStatusUpdated event is raised whenever the satellite information is updated. + The callback will be invoked periodically (every Interval seconds). + + 3 + http://tizen.org/privilege/location + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + This class contains the information of the satellite under consideration. + + 3 + + + + The Class constructor for the SatelliteInformation class. + + 3 + The azimuth value of the satellite in degrees. + The elevation of the satellite in meters. + The PRN value of the satellite. + The SNR value of the satellite in dB. + The flag signaling if the satellite is in use. + + + + The azimuth information of the satellite. + + 3 + The azimuth value of the satellite in degrees. + + + + The elevation information of the satellite. + + 3 + The azimuth value of the satellite in degrees. + + + + The PRN of the satellite. + + 3 + The azimuth value of the satellite in degrees. + + + + The SNR of the satellite. + + 3 + + + + The operational status of the satellite. + + 3 + + + + This class contains details of the location requested. + Includes the functionality to get the distance between locations. + + 3 + + + + The default constructor of the Location class. + + 3 + + + + The parameterized constructor of the Location class. + + 3 + The latitude component of the device co-ordinate [-90.0 ~ 90.0] (degrees). + The longitude component of the device co-ordinate[-180.0 ~ 180.0] (degrees). + The altitude value. + The accuracy in meters. + The device speed. + The device direction with respect to the north. + Time when the measurement took place. + Thrown when an invalid argument is used. + + + + The current latitude [-90.0 ~ 90.0] (degrees). + + 3 + + + + The current longitude [-180.0 ~ 180.0] (degrees). + + 3 + + + + The current altitude (meters). + + 3 + + + + The device speed (km/h). + + 3 + + + + The direction and degrees from the north. + + 3 + + + + The accuracy. + + 3 + + + + The time value when the measurement was done. + + 3 + + + + Gets the distance between the two given coordinates. + + 3 + The latitude of the source location [-90.0 ~ 90.0] (degrees). + The longitude of the source location[-180.0 ~ 180.0] (degrees). + The latitude of the source location [-90.0 ~ 90.0] (degrees). + The longitude of the source location[-180.0 ~ 180.0] (degrees). + Returns the distance between the source and the destination. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Gets the distance between the current and the specified location. + + 3 + The location object to which distance is to be calculated. + Returns the distance to the specified location. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The LocationBoundary class is an abstract class that provides functions related to the geographic bounds information. + + 3 + + + + Gets the location boundary type. + + 3 + + + + The destructor of the LocationBoundary class. + + 3 + + + + Checks if the boundary contains the specified geographical coordinates. + + 3 + The coordinate which needs to be checked. + Returns a boolean value indicating whether or not the specified coordinate lies in the geographical area. + + + + The overidden Dispose method of the IDisposable class. + + 3 + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + This class represents a rectangular location boundary. + Inherits the Abstract LocationBoundary class. + + 3 + + + + The constructor of the Rectangle boundary class. + + 3 + The coordinate which constitutes the top-left handside of the rectangular boundary. + The coordinate which constitutes the bottom-right handside of the rectangular boundary. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Gets the top-left handside coordinate of a rectangular boundary. + + 3 + + + + Gets the bottom-right handside coordinate of a rectangular boundary. + + 3 + + + + This class represents a circular location boundary. + Inherits the Abstract LocationBoundary class. + + 3 + + + + The constructor of the Circular boundary class. + + 3 + The coordinates which constitute the center of the circular boundary. + The radius value of the circular boundary. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Gets the coordinate of the center of a circular boundary. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Gets the radius of a circular boundary. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + This class represents a polygonal location boundary. + Inherits the Abstract LocationBoundary class. + + 3 + + + + The constructor of the Polygon Boundary class. + + 3 + The coordinates which constitute the polgonal boundary. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Gets the list of coordinates which constitute a polygonal boundary. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + This structure represents the coordinates of a geographical location. + + 3 + + + + Latitude component of the coordinate. + Should have a value between [-90.0 ~ 90.0] (degrees). + + 3 + + + + Longitude component of the coordinate. + Should have a value between [-180.0 ~ 180.0] (degrees). + + 3 + + + + An extended EventArgs class which contains the changed location information. + + 3 + + + + The class constructor for the LocationUpdatedEventArgs class. + + 3 + Object of the Location class. + + + + Gets the location update information. + + 3 + + + + Location Manager error codes. + + 3 + + + + + + + + + + + + + Location Boundary error codes. + + 3 + + + + + + + + + This class contains the functionality for obtaining the geographical infomation and setting the boundary condition. + Notifications on events like service becoming enabled or disabled, new position data being available, + and others can also be acquired. + + 3 + + + + The constructor of the Locator class. + + 3 + The back-end positioning method to be used for LBS. + http://tizen.org/feature/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The destructor of the Locator class. + + 3 + + + + The time interval between callback updates. + Should be in the range of 1~120 seconds. + + 3 + Thrown when an invalid argument is used. + + + + The time interval between the distance-based location callback updates. + Should be in the range of 1~120 seconds. + + 3 + Thrown when an invalid argument is used. + + + + The time interval between the position collection in batch mode. + Should be in the range of 1~255 seconds. + + 3 + Thrown when an invalid argument is used. + + + + The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific. + Should be in the range of 0~60000 seconds. + + 3 + Thrown when an invalid argument is used. + + + + The distance between callback updates. + Should be in the range of 1-120 meters. + + 3 + Thrown when an invalid argument is used. + + + + Gets the location object. + + 3 + + + + Gets the type used to obtain the location data. + + 3 + + + + Gets the status whether the mock location is enabled or not. + + 3 + http://tizen.org/privilege/location + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Starts the Location Manager which has been created using the specified method. + + 3 + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Stops the Location Manager which has been activated using the specified method. + Does not destroy the manager. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Sets a mock location for the given location method. + + 3 + The location object containing the mock location details. + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Clears a mock location for the given location method. + + 3 + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Gets the details of the location asynchronously. + + 3 + Timeout to stop requesting a single location after (seconds). + A task which contains the current location details. + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Gets the details of the location. + + 3 + Which contains the current location details. + http://tizen.org/privilege/location + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the application has no privilege to use the location. + Thrown when the location is not supported. + + + + Adds a bound for a given locator. + + 3 + The boundary object to be added to the locator. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Deletes a bound for a given locator. + + 3 + The boundary object to be removed from the locator. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The overidden Dispose method of the IDisposable class. + + 3 + Thrown when an invalid argument is used. + + + + The ServiceStateChanged event is invoked when the location service state is changed. + + 3 + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The ZoneChanged event is invoked when the previously set boundary area is entered or left. + + 3 + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The SetttingChanged event is raised when the location setting is changed. + + 3 + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The DistanceBasedLocationChanged event is raised with the updated location information. + The callback will be invoked at a minimum interval or minimum distance with the updated position information. + + 3 + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The LocationUpdated event is raised at defined intervals of time with the updated location information. + The callback will be invoked periodically. + + 3 + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + Enumeration for the state of the location service. + + 3 + + + + + Enumeration for the type of connection used in acquiring the location data. + + 3 + + + + + + + Enumeration for the created boundary type. + + 3 + + + + + + Enumeration for the error code for location manager. + + 3 + + + + + Checks if the specified geographical positioning type is supported or not. + + 3 + The back-end positioning method to be used for LBS. + Returns a boolean value indicating whether or not the specified method is supported. + + + + Checks if the specified geographical positioning type is enabled or not. + + 3 + The back-end positioning method to be used for LBS. + Returns a boolean value indicating whether or not the specified method is supported. + Thrown when the operation is invalid for the current state. + Thrown when an invalid argument is used. + Thrown when the location is not supported. + + + + The class constructor for the SatelliteStatusChangedEventArgs class. + + 3 + The number of active satellites. + The number of satellites in view. + The time at which the data has been extracted. + + + + Gets the number of active satellites. + + 3 + + + + Gets the number of satellites in view. + + 3 + + + + Get the timestamp. + + 3 + + + + An extended EventArgs class contains the changed location service state. + + + + + The class constructor for the ServiceStateChangedEventArgs class. + + 3 + An enumeration of type LocationServiceState. + + + + Get the service state. + + 3 + + + + The class constructor for the SettingChangedEventArgs class. + + 3 + The positioing method used for the location information. + The status of the method. + + + + Gets the currently used location method. + + 3 + + + + Method to get the setting value changed. + + 3 + + + + The class constructor for the ZoneChangedEventArgs class. + + 3 + An enumeration of type BoundaryState. + The latitude value [-90.0 ~ 90.0] (degrees). + The longitude value [-180.0 ~ 180.0] (degrees). + The altitude value. + The timestamp value. + + + + Gets the boundary state. + + 3 + + + + Gets the latitude. + + 3 + + + + Gets the longitude. + + 3 + + + + Gets the altitude. + + 3 + + + + Method to get the timestamp. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Log.dll b/Artifacts/bin/Tizen.Log.dll index 95d18ac..b36636b 100644 Binary files a/Artifacts/bin/Tizen.Log.dll and b/Artifacts/bin/Tizen.Log.dll differ diff --git a/Artifacts/bin/Tizen.Log.pdb b/Artifacts/bin/Tizen.Log.pdb index 936d6a8..f600a0c 100644 Binary files a/Artifacts/bin/Tizen.Log.pdb and b/Artifacts/bin/Tizen.Log.pdb differ diff --git a/Artifacts/bin/Tizen.Log.xml b/Artifacts/bin/Tizen.Log.xml index 5bc2f50..d57ddae 100644 --- a/Artifacts/bin/Tizen.Log.xml +++ b/Artifacts/bin/Tizen.Log.xml @@ -1,79 +1,79 @@ - - - - Tizen.Log - - - - - Provides methods to print log messages to the Tizen logging system. - - - - - Prints a log message with the VERBOSE priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - - Prints a log message with the DEBUG priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - - Prints a log message with the INFO priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - - Prints a log message with the WARNING priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - - Prints a log message with the ERROR priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - - Prints a log message with the FATAL priority. - - 3 - The tag name of the log message. - The log message to print. - The source file path of the caller function. This argument will be set automatically by the compiler. - The function name of the caller function. This argument will be set automatically by the compiler. - The line number of the calling position. This argument will be set automatically by the compiler. - - - + + + + Tizen.Log + + + + + Provides methods to print log messages to the Tizen logging system. + + + + + Prints a log message with the VERBOSE priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + + Prints a log message with the DEBUG priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + + Prints a log message with the INFO priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + + Prints a log message with the WARNING priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + + Prints a log message with the ERROR priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + + Prints a log message with the FATAL priority. + + 3 + The tag name of the log message. + The log message to print. + The source file path of the caller function. This argument will be set automatically by the compiler. + The function name of the caller function. This argument will be set automatically by the compiler. + The line number of the calling position. This argument will be set automatically by the compiler. + + + diff --git a/Artifacts/bin/Tizen.Maps.dll b/Artifacts/bin/Tizen.Maps.dll index 280bf77..ef88ec4 100644 Binary files a/Artifacts/bin/Tizen.Maps.dll and b/Artifacts/bin/Tizen.Maps.dll differ diff --git a/Artifacts/bin/Tizen.Maps.pdb b/Artifacts/bin/Tizen.Maps.pdb index 11dcf90..c2ff878 100644 Binary files a/Artifacts/bin/Tizen.Maps.pdb and b/Artifacts/bin/Tizen.Maps.pdb differ diff --git a/Artifacts/bin/Tizen.Maps.xml b/Artifacts/bin/Tizen.Maps.xml index f0b0636..4b80c8f 100644 --- a/Artifacts/bin/Tizen.Maps.xml +++ b/Artifacts/bin/Tizen.Maps.xml @@ -1,2550 +1,2550 @@ - - - - Tizen.Maps - - - - - The utility method to check for an error. Returns false on failure and prints warning messages. - - Returns true in case of no error, otherwise false. - - - - The utility method to check for an error. Returns false on failure and throws an exception. - - Returns true in case of no error, otherwise false. - - - - The class representing a geographical area. - - 3 - - - - Constructs a rectangular area. - - 3 - Top-left coordinates of the area. - Bottom-left coordinates of the area. - Thrown when the required feature is not supported. - Thrown when input coordinates are invalid. - Thrown when a native operation fails to allocate memory. - - - - Constructs a circular area. - - 3 - Coordinates for center of the area. - Radius of the area. - Thrown when the required feature is not supported. - Thrown when input coordinates are invalid. - Thrown when a native operation fails to allocate memory. - - - - Releases all the resources used by this object. - - 3 - - - - The direction types for route maneuver. - - 3 - - - - Indicates an unknown direction. - - - - - Indicates the North direction. - - - - - Indicates the Northwest direction. - - - - - Indicates the Northeast direction. - - - - - Indicates the South direction. - - - - - Indicates the Southeast direction. - - - - - Indicates the Southwest direction. - - - - - Indicates the West direction. - - - - - Indicates the East direction. - - - - - The allowed distance units. - - 3 - - - - Indicates meter unit. - - - - - Indicates kilometer unit. - - - - - Indicates foot unit. - - - - - Indicates yard unit. - - - - - Geocode request for the map service. - - 3 - - - - A class representing geographical coordinates. - - 3 - - - - Constructs the map coordinates object. - - 3 - Latitude value must be between (-90.0 ~ 90.0) degrees. - Longitude value must be between (-180.0 ~ 180.0) degrees. - Thrown when values for latitude and longitude are not valid. - Thrown when a native operation fails to allocate memory. - - - - Gets the latitude coordinates. - - 3 - - - - Gets the longitude coordinates. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string that represents this object. - - - - Releases all the resources used by this object. - - 3 - - - - List of objects to be used in APIs. - - - - - The iterator for coordinates in this list. - - - - - Releases all the resources used by this object. - - 3 - - - - Enumeration for the user gesture over a map view. - - 3 - - - - Indicates the empty gesture. - - - - - Indicates the move map user gesture. - - - - - Indicates the zoom user gesture. - - - - - Indicates the click user gesture. - - - - - Indicates the double click user gesture. - - - - - Indicates the two-finger click user gesture. - - - - - Indicates the rotation user gesture. - - - - - Indicates the long press user gesture. - - - - - The preference for geocode searches. - - 3 - - - - Gets or sets a string that presents the preferred language. - - 3 - Language should be specified as an ISO 3166 alpha-2 two-letter country-code - followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". - - - - Gets or sets the maximum number of results. - - 3 - Setting a negative value will not have any effect on MaxResults value. - - - - The preferences for a place search. - - 3 - - - - Gets or sets the distance unit. - - 3 - - - - Gets or sets the preferred language. - - 3 - Language should be specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". - - - - Gets or sets the maximum number of results. - - 3 - - - - Gets or sets a string that represents the code of a preferred country. - - 3 - - - - Gets or sets the search properties as a key value pair. - - 3 - - - - The preferences for route search. - - 3 - - - - Gets or sets the distance unit. - - 3 - - - - Gets or sets the route optimization. - - 3 - - - - Gets or sets the route transport mode. - - 3 - - - - Gets or sets the route feature weight. - - 3 - - - - Gets or sets the route feature. - - 3 - - - - Gets or sets if a search for alternative routes is enabled. - - 3 - - - - Event arguments for gesture type map events. - - 3 - - - - Gets the type of gesture event. - - 3 - - - - Gets screen coordinates in the event. - - 3 - - - - Gets the number of fingers detected in the event. - - 3 - - - - Gets the zoom factor for zoom gesture event. - - 3 - - - - Gets the angle of rotation for rotate gesture event. - - 3 - - - - Gets the geographical coordinates for the event. - - 3 - - - - The map object. - - 3 - - - - Gets or sets visibility of the map object. - - 3 - - - - Map service class for service request. - - 3 - - - - Creates a new maps service object for given service provider. - - 3 - A string representing the name of the map service provider. - A string representing a certificate key to use the map service provider. - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when parameters are invalid. - Thrown when a native operation failed to allocate memory and connect to the service. - Thrown when application does not have some privilege to access this method. - - - - Gets the list of available map service providers. - - 3 - The list of map service providers. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have privilege to access this property. - - - - Gets the name of the map service provider. - - 3 - - - - Gets a user consent for the map service provider - - 3 - http://tizen.org/privilege/mapservice - - - - Gets and sets a string representing keys for the map service provider. - - 3 - Typically, the provider key is issued by each maps provider after signing up for a plan in the website. - Depending on the plan and its provider which you have signed, you might have to pay for the network traffic. - - - - Gets and sets a filter used for the place search result. - - 3 - - - - Gets the search preferences used for or . - - 3 - - - - Gets the search preferences used for . - - 3 - - - - Gets the search preferences used for . - - 3 - - - - Gets and sets the search preferences. - - 3 - - - - Gets the user's consent to use maps data. - - 3 - Returns true if user agreed that the application can use maps data, otherwise false. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Checks if the maps service supports the given request. - - 3 - Request type to check - Returns true if the maps service supports a request, otherwise false. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Checks if the maps service supports a given data feature. - - 3 - Data feature to check. - Returns true if the maps service supports a data feature, otherwise false. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Creates a geocode search request for the given free-formed address string. - - 3 - A string representing free-formed address. - Returns a GeocodeRequest object created with an address string. - - - - Creates a geocode search request for the given free-formed address string, within the specified boundary. - - 3 - A string representing the free-formed address. - An instance of Area object representing the interested area. - - Returns a GeocodeRequest object created with an address string and a specified boundary. - - - - Creates a geocode search request for the given structured address. - - 3 - A string representing the address of interest. - Returns a GeocodeRequest object created with a structured address. - - - - Creates a reverse geocode search request for the given latitude and longitude. - - 3 - Latitude of the interested place. - Longitude of the interested place. - Returns a ReverseGeocodeRequest object created with the location coordinates. - - - - Creates a reverse geocode search request for the given position coordinates list. - - 3 - Coordinates list with [2 ~ 100] coordinates. - Returns a MultiReverseGeocodeRequest object created with a list of location coordinates. - - - - Creates a route search request for the origin and destination points. - - 3 - Starting point. - Destination. - Returns a RouteSearchRequest object created with the origin and destination coordinates. - - - - Creates a place search request for a specified search radius around a given coordinates position. - - 3 - Geographical coordinates of the center. - A double value representing the radius of an area to search places. - Returns a PlaceSearchRequest object created with the location coordinates and search radius. - - - - Creates a place search request for places within a specified boundary. - - 3 - An instance of Area object representing and area to search interested places. - Returns a PlaceSearchRequest object created with a specified boundary. - - - - Creates a place search request for a free-formed address within the boundary. - - 3 - A string which represents a free-formed address. - An instance of area object representing an area to search interested places. - Returns a PlaceSearchRequest object created with an address string and a specified boundary. - - - - Releases all the resources used by this object. - - 3 - - - - Base class for a map service request. - - 3 - - - - - Creates a map service request. - - Map service object. - Request type. - - - - Sends a request to the map service provider. - - 3 - Response from the map service provider. - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the result is invalid. - Thrown when arguments are invalid. - - - - Releases all the resources used by this object. - - 3 - - - - The map view type (theme). - - 3 - - - - Indicates the normal street theme. - - - - - Indicates the satellite theme. - - - - - Indicates the terrain theme. - - - - - Indicates the hybrid theme that has both satellite and normal theme. - - - - - Map View class to show a map on the screen. - - 3 - - - - Creates a view and links it to the instance of a map service. - - 3 - An instance of object for which a map view will be drawn. - An instance of object. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when parameters are invalid. - Thrown when a native operation failed to allocate memory, and connect to the service. - - - - Adds or removes event handlers to deliver a scrolled gesture event. - - Event handlers to get a scrolled gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a zoomed gesture event. - - Event handlers to get a zoomed gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a clicked gesture event. - - Event handlers to get a clicked gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a double-clicked gesture event. - - Event handlers to get a double-clicked gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a clicked gesture event with two-fingers. - - Event handlers to get a clicked gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a rotated gesture event. - - Event handlers to get a rotated gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver a long-pressed gesture event. - - Event handlers to get a long-pressed gesture event. - 3 - Thrown when the required feature is not supported. - - - - Adds or removes event handlers to deliver an event representing a view ready to be used. - - Event handlers to get a view ready event. - 3 - Thrown when the required feature is not supported. - - - - Gets or sets the current zoom level. - - It is an integer value representing the current zoom level. - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Gets or sets the minimum zoom level. - - It is an integer value that limits minimal zoom level within a range of the current map plug-in support. - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Gets or sets the maximum zoom level. - - It is an integer value that limits maximum zoom level within a range of the current map plug-in support. - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Gets or sets the orientation on the map view. - - It is an integer value from 0 to 360 that indicates the orientation of the map view. - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Gets or sets theme type of the map view. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Indicates whether the map should show the 3D buildings layer. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Indicates whether the map should show the traffic layer. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Indicates whether the map should show the public transit layer. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Indicates whether the scale-bar is enabled or not. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - - - - Sets language of map view. - - The display language in the map. - A language is specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code. - Each language tag is composed of one or more "subtags" separated by hyphens (-). - Each subtag is composed of basic Latin letters or digits only. - For example, "ko-KR" for Korean, "en-US" for American English. - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - - - - Gets or sets geographical coordinates for map view's center. - - 3 - http://tizen.org/privilege/mapservice - http://tizen.org/privilege/internet - http://tizen.org/privilege/network.get - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - - - - Gets a list of the map object added to map view. - - 3 - - - - Changes the geographical coordinates to screen coordinates. - - 3 - Geographical coordinates. - Returns an instance of the screen coordinates on the current screen. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - Thrown when a native operation failed to allocate memory and connect to the service. - - - - Changes the screen coordinates to geographical coordinates. - - 3 - Screen coordinates. - Returns an instance of the geographical coordinates object. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - Thrown when a native operation failed to allocate memory and connect to the service. - - - - Adds a map object to map view. - - 3 - An instance of the map object to be added. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - Thrown when a native operation failed to allocate memory and connect to the service. - - - - Removes a map object from the map view. - - 3 - An instance of the map object to be removed. - Once removed, the child object will be become invalid. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - Thrown when native operation failed to allocate memory and connect to the service. - - - - Removes all map objects from the map view. - - 3 - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when a native operation failed to allocate memory and connect to the service. - - - - Captures a snapshot of the map view. - - 3 - Type of file format. - An integer value representing the quality for encoding from 1 to 100. - A string representing the file path for a snapshot. - http://tizen.org/privilege/mapservice - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the value is invalid. - Thrown when a native operation failed to allocate memory and connect to the service. - - - - Releases all the resources used by this object. - - 3 - - - - The marker map object. - - 3 - - - - Gets or sets the clicked event handlers. - - 3 - - - - Gets or sets the marker's visibility. - - 3 - - - - Gets or sets the geographical coordinates for this marker. - - 3 - - - - Gets or sets a string representing the image file path for this marker. - - 3 - - - - Gets or sets the screen size for this marker. - - 3 - - - - Gets or sets the z-order for this marker. - - 3 - The integer value is 0 by default, and must be in the range of -100 to 100. - - - - Changes the marker size. - - 3 - New size. - - - - Changes the marker coordinates. - - 3 - New position for the marker. - - - - Releases all the resources used by this object. - - 3 - - - - Pin type the marker map object. - - 3 - - - - Creates a pin type marker. - - 3 - Marker coordinates. - Thrown when input coordinates are invalid. - - - - Creates a pin type marker. - - 3 - Marker coordinates. - Image file path for the Marker. - - http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage. - - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the input coordinates or imagePath is invalid. - - - - Sticker type marker map object. - - 3 - - - - Creates a sticker type marker. - - 3 - Marker coordinates. - Thrown when input coordinates are invalid. - - - - Creates a sticker type marker. - - 3 - Marker coordinates. - Image file path for Marker. - - http://tizen.org/privilege/mediastorage is needed if the input or output path are relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if the input or output path are relevant to external storage. - - Thrown when the required feature is not supported. - Thrown when application does not have some privilege to access this method. - Thrown when the input coordinates or imagePath is invalid. - - - - Multiple reverse geocode request for Tizen map service. - - 3 - - - - Overlay map object. - - 3 - - - - Creates a normal overlay map object. - - 3 - - - Thrown when the input coordinates or objectToContain are invalid. - - - - Gets or sets the visibility of an overlay map object. - - 3 - - - - Gets or sets geographical coordinates for an overlay map object. - - 3 - - - - Gets or sets minimum zoom level for an overlay map object. - - 3 - - - - Gets or sets maximum zoom lever for an overlay map object. - - 3 - - - - Releases all the resources used by this object. - - 3 - - - - The bubble overlay map object. - - 3 - - - - Creates a bubble overlay. - - 3 - The geographical coordinates to be pointed. - The EvasObject to be shown. - Thrown when the required feature is not supported. - Thrown when the input coordinates or objectToContain are invalid. - - - - The box overlay map object. - - 3 - - - - Creates a box overlay. - - 3 - The geographical coordinates to be pointed. - The EvasObject to be shown. - Thrown when the required feature is not supported. - Thrown when the input coordinates or objectToContain are invalid - - - - Place information, used in place discovery and search requests. - - 3 - - - - Gets an ID string for the place. - - 3 - - - - Gets name string for the place. - - 3 - - - - Gets a view URI for the place. - - 3 - - - - Gets a distance for the place from the center. - - 3 - - - - Gets a geographical location for the place. - - 3 - - - - Gets an address for the place. - - 3 - - - - Gets a rating for the place. - - 3 - - - - Gets a supplier link for the place. - - 3 - - - - Gets a related link for the place. - - 3 - - - - Gets all the properties attached to this place. - - 3 - - - - Gets all the categories attached to this place. - - 3 - - - - Gets all the attributes attached to this place. - - 3 - - - - Gets all the contacts attached to this place. - - 3 - - - - Gets all the editorials attached to this place. - - 3 - - - - Gets all the images attached to this place. - - 3 - - - - Gets all the reviews attached to this place. - - 3 - - - - Releases all the resources used by this object. - - 3 - - - - Address information for the map point used in geocode and reverse geocode requests. - - 3 - - - - Constructs a map address object. - - 3 - Thrown when native operation failed to allocate memory. - - - - Gets a building number for this address. - - 3 - - - - Gets a city name for this address. - - 3 - - - - Gets a country name for this address. - - 3 - - - - Gets a country code for this address. - - 3 - - - - Gets a county for this address. - - 3 - - - - Gets a district name for this address. - - 3 - - - - Gets a free text associated with this address. - - 3 - - - - Gets a postal code for this address. - - 3 - - - - Gets a state name for this address. - - 3 - - - - Gets a street name for this address. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Releases all the resources used by this object. - - 3 - - - - List of objects to be used in APIs. - - - - - Constructs a map address list object. - - Thrown when the required feature is not supported. - Thrown when native operation failed to allocate memory. - - - - Gets an iterator for addresses in this list. - - - - - Releases all the resources used by this object. - - 3 - - - - Place attributes information, used in place discovery and search requests. - - 3 - - - - Gets an ID for the place attribute. - - 3 - - - - Gets a label for the place attribute. - - 3 - - - - Gets a text for the place attribute. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Place category information, used in place discovery and search requests. - - 3 - - - - Constructs a search category object. - - 3 - Thrown when native operation failed to allocate memory. - - - - Gets or sets an ID for this category. - - 3 - - - - Gets or sets a name for this category. - - 3 - - - - Gets or sets a URL for this category. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Releases all the resources used by this object. - - 3 - - - - Place contact information, used in place discovery and search requests. - - 3 - - - - Gets an ID for this place contact. - - 3 - - - - Gets a label for this place contact. - - 3 - - - - Gets a value for this place contact. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Place editorial information, used in place discovery and search requests. - - 3 - - - - Gets a description for this place editorial. - - 3 - - - - Gets a language for this place editorial. - - 3 - - - - Gets an instance of object which representing media for this place editorial. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Place filter information, used in place discovery and search requests. - - 3 - - - - Constructs a new place filter. - - 3 - Thrown when native operation failed to allocate memory. - - - - Gets or sets a free-formed address string for this place filter. - - 3 - Depending on maps provider which the application has selected, - it may treat , and - as the same kind of strings to search places. - - - - Gets or sets an instance of object for this place filter. - - 3 - - - - Gets or sets a keyword for this place filter. - - 3 - Depending on maps provider which the application has selected, - it may treat , and - as the same kind of strings to search places. - - - - Gets or sets a name for this place filter. - - 3 - Depending on maps provider which the application has selected, - it may treat , and - as the same kind of strings to search places. - - - - Releases all the resources used by this object. - - 3 - - - - Place image information, used in place discovery and search requests. - - 3 - - - - Gets an ID for this place image. - - 3 - - - - Gets an URL for this place image. - - 3 - - - - Gets the width for this place image. - - 3 - - - - Gets the height for this place image. - - 3 - - - - Gets an object representing the user link for this place image. - - 3 - - - - Gets an object representing the image media for this place image. - - 3 - - - - Place link object information, used in place discovery and search requests. - - 3 - - - - Gets a string representing the ID for this place link. - - 3 - - - - Gets a string representing the name for this place link. - - 3 - - - - Gets a string representing the link for this place link. - - 3 - - - - Gets a string representing the type for this place link. - - 3 - - - - List of objects to be used in APIs. - - - - - Gets an iterator for the addresses in this list. - - - - - Releases all the resources used by this object. - - 3 - - - - Place media information, used in place discovery and search requests. - - 3 - - - - Gets a string representing the attribution for this place media. - - 3 - - - - Gets an instance of object representing the supplier for this place media. - - 3 - - - - Gets an instance of object representing via data for this place media. - - 3 - - - - Place rating information, used in place discovery and search requests. - - 3 - - - - Gets the number of users rated for this place rating. - - 3 - - - - Gets the average value of this place rating. - - 3 - - - - Returns a string that represents this object. - - 3 - Returns a string which presents this object. - - - - Place review information, used in place discovery and search requests. - - 3 - - - - Gets an instance of object representing the time of this review. - - 3 - - - - Gets a string representing the title of this review. - - 3 - - - - Gets a value representing the rating of this review. - - 3 - - - - Gets a string representing the description of this review. - - 3 - - - - Gets a string representing the language of this review. - - 3 - - - - Gets an instance of object representing the review media of this review. - - 3 - - - - Gets an instance of object representing the user link of this review. - - 3 - - - - Place search request for Tizen map service. - - 3 - - - - The polygon map object. - - 3 - - - - Creates a polygon visual object. - - 3 - List of geographical coordinates. - Background color. - Thrown when input values are invalid. - - - - Adds or removes the clicked event handlers. - - 3 - - - - Gets or sets visibility for the polygon. - - 3 - - - - Gets or sets a list of geographical coordinates for polygon vertices. - - 3 - - - - Gets or sets a background color to fill the polygon. - - 3 - - - - Releases all the resources used by this object. - - 3 - - - - The polyline map object. - - 3 - - - - Creates polyline visual object. - - 3 - List of geographical coordinates. - Line color. - The width of line [1 ~ 100] (pixels). - Thrown when input values are invalid. - - - - Adds or removes the clicked event handlers. - - 3 - - - - Gets or sets the visibility for polyline. - - 3 - - - - Gets or sets a list of geographical coordinates for polyline vertices. - - 3 - - - - Gets or sets the line color. - - 3 - - - - Gets or sets the line width from 1 to 100 pixels. - - 3 - - - - Releases all the resources used by this object. - - 3 - - - - Reverses the geocode request for a map service. - - 3 - - - - Route information, used in Route Search requests. - - 3 - - - - Gets an instance of object representing destination coordinates for this route. - - 3 - - - - Gets the total distance for this route. - - 3 - - - - Get the total duration to cover this route. - - 3 - - - - Gets an ID for this route. - - 3 - - - - Gets the transport mode for this route. - - 3 - - - - Gets the origin coordinates for this route. - - 3 - - - - Gets a coordinates list for this route. - - 3 - - - - Gets a segment list for this route. - - 3 - - - - Gets the distance unit for this route. - - 3 - - - - Gets an instance of object which representing bounding area for this route. - - - - - Releases all the resources used by this object. - - 3 - - - - Route features used for route search requests. - - 3 - - - - Indicates no route features are selected. - - - - - Indicates toll roads (toll gates/booths). - - - - - Indicates a motorway. - - - - - Indicates a boat ferry. - - - - - Indicates a rail (train) ferry. - - - - - Indicates a public transport. - - - - - Indicates a tunnel. - - - - - Indicates a dirt road. - - - - - Indicates a park. - - - - - Indicates a high-occupancy vehicle lane. - - - - - Indicates stairs. - - - - - Route feature weights used in route search requests. - - 3 - - - - Indicates normal weighting. - - - - - Indicates that a feature is preferred. - - - - - Indicates that a feature is to be avoided. - - - - - Indicates that soft-exclude applies to the feature. - - - - - Indicates that the feature is to be strictly excluded. - - - - - Route maneuver information used in route search requests. - - 3 - - - - Gets the direction type for this maneuver. - - 3 - - - - Gets the turn type for this maneuver. - - 3 - - - - Gets a geographical coordinates position for this maneuver. - - 3 - - - - Gets a name of the road for this maneuver. - - 3 - - - - Gets an instruction text for this maneuver. - - 3 - - - - Gets a locale for this maneuver. - - 3 - - - - Gets the time to next instruction for this maneuver. - - 3 - - - - Gets the distance to next instruction for this maneuver. - - 3 - - - - Allowed route optimization option used in route search requests. - - 3 - - Depending on the loaded maps plug-in using , some features might have no effect or differences with the descriptions. - - - - - Indicates searching for the fastest routes. - - - - - Indicates searching for the shortest routes (car mode only). - - - - - Indicates searching for the most economic routes (car mode only). - - - - - Indicates searching for the most scenic routes. - - - - - Indicates searching for most the fastest routes now, based on the current traffic condition. - - - - - Indicates searching for the direct drive routes. - - - - - Routes the search request for Tizen map service requests. - - 3 - - - - Gets or sets a list of way-points to cover between the origin and destination. - - 3 - - - - Place Segment information used in Route Search requests. - - 3 - - - - Gets the origin coordinates for this segment. - - 3 - - - - Gets the destination coordinates for this segment. - - 3 - - - - Gets the total distance for this segment. - - 3 - - - - Gets the total duration to cover this segment. - - 3 - - - - Gets the maneuver list for this segment. - - 3 - - - - Gets the coordinates list for this segment. - - 3 - - - - Preferences for route search requests. - - 3 - - - - Constructor for a new search preference. - - 3 - - - - Constructor for a new search preference. - - - - - Gets or sets a preferred language. - - 3 - Language should be specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". - - - - Gets or sets the maximum result count for each service request. - - 3 - Setting negative value will not have any effect on MaxResults value. - - - - Gets or sets the distance unit. - - 3 - - - - Gets or sets the preferred country. - - 3 - - - - Gets or sets the search properties as a key value pair. - - 3 - - - - Gets or sets the route optimization. - - 3 - - - - Gets or sets the route transport mode. - - 3 - - - - Gets or sets the route feature weight. - - 3 - - - - Gets or sets the route feature. - - 3 - - - - Gets or sets if the searching for alternative routes is enabled. - - 3 - - - - Releases all the resources used by this object. - - 3 - - - - Features available in the map service. - - 3 - - - - Indicates availability of address value in the place data. - - - - - Indicates availability of rating value in the place data. - - - - - Indicates availability of place category list in the place data. - - - - - Indicates availability of place attribute list in the place data. - - - - - Indicates availability of place contact list in the place data. - - - - - Indicates availability of place editorial list in the place data. - - - - - Indicates availability of place review list in the place data. - - - - - Indicates availability of place image in the place data. - - - - - Indicates availability of place supplier link value in the place data. - - - - - Indicates availability of a related place link in the place data. - - - - - Indicates that the route data structure is defined as a path (a list of geographical coordinates). - - - - - Indicates that the route data structure is defined as a list of segments while each segment is defined as a path. - - - - - Indicates that the route data structure is defined as a list of segments while each segment is defined as a list of maneuvers. - - - - - Indicates availability of traffic information on the map. - - - - - Indicates availability of public transit information on the map. - - - - - Indicates availability of 3D building drawable on the map. - - - - - Indicates availability of scale bar on the map. - - - - - Service requests available in the maps service. - - 3 - - - - Indicates the service request to get position for a given free-formed address string is allowed. - - - - - Indicates that service request to get position for a given address, within the specified bounding , is allowed. - - - - - Indicates that service request to get position for a given is allowed. - - - - - Indicates that service request to get for a given is allowed. - - - - - Indicates that service request to get for a given is allowed. - - - - - Indicates that service request to query information for a given is allowed. - - - - - Indicates that service request to query information for a given is allowed. - - - - - Indicates that service request to query information for a given free-formed address string is allowed. - - - - - Indicates that service request to query information list for all places in a given is allowed. - - - - - Indicates that service request to get detailed information for a given is allowed. - - - - - Indicates that service request to query information from a given origin and destination is allowed. - - - - - Indicates that service request to query information passing through specified way-points is allowed. - - - - - Indicates that map view service is allowed. - - - - - Indicates that map view snapshot service is allowed. - - - - - Enumeration for the snapshot file formats. - - 3 - - - - Indicates the BMP file format. - - - - - Indicates the JPEG file format. - - - - - Route types. - - 3 - - - - Indicates that the route is to be traveled by a car. - - - - - Indicates that the route is for a pedestrian. - - - - - Indicates that the route is for a cyclist. - - - - - Indicates that the route is to be traveled using public transport. - - - - - Indicates that the route is for a truck. - - - - - Turns the Instruction type for route maneuver. - - 3 - - - - Indicates an unknown instruction. - - - - - Indicates instruction to move straight. - - - - - Indicates instruction to bear right. - - - - - Indicates instruction to turn slightly to the right. - - - - - Indicates instruction to turn right. - - - - - Indicates instruction to turn hard to the right. - - - - - Indicates instruction to U-turn to the right. - - - - - Indicates instruction to U-turn to the left. - - - - - Indicates instruction to turn hard to the left. - - - - - Indicates instruction to turn left. - - - - - Indicates instruction to turn slightly to the left. - - - - - Indicates instruction to bear left. - - - - - Indicates instruction to take right fork. - - - - - Indicates instruction to take left fork. - - - - - Indicates instruction to take straight fork. - - - - + + + + Tizen.Maps + + + + + The utility method to check for an error. Returns false on failure and prints warning messages. + + Returns true in case of no error, otherwise false. + + + + The utility method to check for an error. Returns false on failure and throws an exception. + + Returns true in case of no error, otherwise false. + + + + The class representing a geographical area. + + 3 + + + + Constructs a rectangular area. + + 3 + Top-left coordinates of the area. + Bottom-left coordinates of the area. + Thrown when the required feature is not supported. + Thrown when input coordinates are invalid. + Thrown when a native operation fails to allocate memory. + + + + Constructs a circular area. + + 3 + Coordinates for center of the area. + Radius of the area. + Thrown when the required feature is not supported. + Thrown when input coordinates are invalid. + Thrown when a native operation fails to allocate memory. + + + + Releases all the resources used by this object. + + 3 + + + + The direction types for route maneuver. + + 3 + + + + Indicates an unknown direction. + + + + + Indicates the North direction. + + + + + Indicates the Northwest direction. + + + + + Indicates the Northeast direction. + + + + + Indicates the South direction. + + + + + Indicates the Southeast direction. + + + + + Indicates the Southwest direction. + + + + + Indicates the West direction. + + + + + Indicates the East direction. + + + + + The allowed distance units. + + 3 + + + + Indicates meter unit. + + + + + Indicates kilometer unit. + + + + + Indicates foot unit. + + + + + Indicates yard unit. + + + + + Geocode request for the map service. + + 3 + + + + A class representing geographical coordinates. + + 3 + + + + Constructs the map coordinates object. + + 3 + Latitude value must be between (-90.0 ~ 90.0) degrees. + Longitude value must be between (-180.0 ~ 180.0) degrees. + Thrown when values for latitude and longitude are not valid. + Thrown when a native operation fails to allocate memory. + + + + Gets the latitude coordinates. + + 3 + + + + Gets the longitude coordinates. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string that represents this object. + + + + Releases all the resources used by this object. + + 3 + + + + List of objects to be used in APIs. + + + + + The iterator for coordinates in this list. + + + + + Releases all the resources used by this object. + + 3 + + + + Enumeration for the user gesture over a map view. + + 3 + + + + Indicates the empty gesture. + + + + + Indicates the move map user gesture. + + + + + Indicates the zoom user gesture. + + + + + Indicates the click user gesture. + + + + + Indicates the double click user gesture. + + + + + Indicates the two-finger click user gesture. + + + + + Indicates the rotation user gesture. + + + + + Indicates the long press user gesture. + + + + + The preference for geocode searches. + + 3 + + + + Gets or sets a string that presents the preferred language. + + 3 + Language should be specified as an ISO 3166 alpha-2 two-letter country-code + followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". + + + + Gets or sets the maximum number of results. + + 3 + Setting a negative value will not have any effect on MaxResults value. + + + + The preferences for a place search. + + 3 + + + + Gets or sets the distance unit. + + 3 + + + + Gets or sets the preferred language. + + 3 + Language should be specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". + + + + Gets or sets the maximum number of results. + + 3 + + + + Gets or sets a string that represents the code of a preferred country. + + 3 + + + + Gets or sets the search properties as a key value pair. + + 3 + + + + The preferences for route search. + + 3 + + + + Gets or sets the distance unit. + + 3 + + + + Gets or sets the route optimization. + + 3 + + + + Gets or sets the route transport mode. + + 3 + + + + Gets or sets the route feature weight. + + 3 + + + + Gets or sets the route feature. + + 3 + + + + Gets or sets if a search for alternative routes is enabled. + + 3 + + + + Event arguments for gesture type map events. + + 3 + + + + Gets the type of gesture event. + + 3 + + + + Gets screen coordinates in the event. + + 3 + + + + Gets the number of fingers detected in the event. + + 3 + + + + Gets the zoom factor for zoom gesture event. + + 3 + + + + Gets the angle of rotation for rotate gesture event. + + 3 + + + + Gets the geographical coordinates for the event. + + 3 + + + + The map object. + + 3 + + + + Gets or sets visibility of the map object. + + 3 + + + + Map service class for service request. + + 3 + + + + Creates a new maps service object for given service provider. + + 3 + A string representing the name of the map service provider. + A string representing a certificate key to use the map service provider. + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when parameters are invalid. + Thrown when a native operation failed to allocate memory and connect to the service. + Thrown when application does not have some privilege to access this method. + + + + Gets the list of available map service providers. + + 3 + The list of map service providers. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have privilege to access this property. + + + + Gets the name of the map service provider. + + 3 + + + + Gets a user consent for the map service provider + + 3 + http://tizen.org/privilege/mapservice + + + + Gets and sets a string representing keys for the map service provider. + + 3 + Typically, the provider key is issued by each maps provider after signing up for a plan in the website. + Depending on the plan and its provider which you have signed, you might have to pay for the network traffic. + + + + Gets and sets a filter used for the place search result. + + 3 + + + + Gets the search preferences used for or . + + 3 + + + + Gets the search preferences used for . + + 3 + + + + Gets the search preferences used for . + + 3 + + + + Gets and sets the search preferences. + + 3 + + + + Gets the user's consent to use maps data. + + 3 + Returns true if user agreed that the application can use maps data, otherwise false. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Checks if the maps service supports the given request. + + 3 + Request type to check + Returns true if the maps service supports a request, otherwise false. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Checks if the maps service supports a given data feature. + + 3 + Data feature to check. + Returns true if the maps service supports a data feature, otherwise false. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Creates a geocode search request for the given free-formed address string. + + 3 + A string representing free-formed address. + Returns a GeocodeRequest object created with an address string. + + + + Creates a geocode search request for the given free-formed address string, within the specified boundary. + + 3 + A string representing the free-formed address. + An instance of Area object representing the interested area. + + Returns a GeocodeRequest object created with an address string and a specified boundary. + + + + Creates a geocode search request for the given structured address. + + 3 + A string representing the address of interest. + Returns a GeocodeRequest object created with a structured address. + + + + Creates a reverse geocode search request for the given latitude and longitude. + + 3 + Latitude of the interested place. + Longitude of the interested place. + Returns a ReverseGeocodeRequest object created with the location coordinates. + + + + Creates a reverse geocode search request for the given position coordinates list. + + 3 + Coordinates list with [2 ~ 100] coordinates. + Returns a MultiReverseGeocodeRequest object created with a list of location coordinates. + + + + Creates a route search request for the origin and destination points. + + 3 + Starting point. + Destination. + Returns a RouteSearchRequest object created with the origin and destination coordinates. + + + + Creates a place search request for a specified search radius around a given coordinates position. + + 3 + Geographical coordinates of the center. + A double value representing the radius of an area to search places. + Returns a PlaceSearchRequest object created with the location coordinates and search radius. + + + + Creates a place search request for places within a specified boundary. + + 3 + An instance of Area object representing and area to search interested places. + Returns a PlaceSearchRequest object created with a specified boundary. + + + + Creates a place search request for a free-formed address within the boundary. + + 3 + A string which represents a free-formed address. + An instance of area object representing an area to search interested places. + Returns a PlaceSearchRequest object created with an address string and a specified boundary. + + + + Releases all the resources used by this object. + + 3 + + + + Base class for a map service request. + + 3 + + + + + Creates a map service request. + + Map service object. + Request type. + + + + Sends a request to the map service provider. + + 3 + Response from the map service provider. + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the result is invalid. + Thrown when arguments are invalid. + + + + Releases all the resources used by this object. + + 3 + + + + The map view type (theme). + + 3 + + + + Indicates the normal street theme. + + + + + Indicates the satellite theme. + + + + + Indicates the terrain theme. + + + + + Indicates the hybrid theme that has both satellite and normal theme. + + + + + Map View class to show a map on the screen. + + 3 + + + + Creates a view and links it to the instance of a map service. + + 3 + An instance of object for which a map view will be drawn. + An instance of object. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when parameters are invalid. + Thrown when a native operation failed to allocate memory, and connect to the service. + + + + Adds or removes event handlers to deliver a scrolled gesture event. + + Event handlers to get a scrolled gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a zoomed gesture event. + + Event handlers to get a zoomed gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a clicked gesture event. + + Event handlers to get a clicked gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a double-clicked gesture event. + + Event handlers to get a double-clicked gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a clicked gesture event with two-fingers. + + Event handlers to get a clicked gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a rotated gesture event. + + Event handlers to get a rotated gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver a long-pressed gesture event. + + Event handlers to get a long-pressed gesture event. + 3 + Thrown when the required feature is not supported. + + + + Adds or removes event handlers to deliver an event representing a view ready to be used. + + Event handlers to get a view ready event. + 3 + Thrown when the required feature is not supported. + + + + Gets or sets the current zoom level. + + It is an integer value representing the current zoom level. + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Gets or sets the minimum zoom level. + + It is an integer value that limits minimal zoom level within a range of the current map plug-in support. + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Gets or sets the maximum zoom level. + + It is an integer value that limits maximum zoom level within a range of the current map plug-in support. + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Gets or sets the orientation on the map view. + + It is an integer value from 0 to 360 that indicates the orientation of the map view. + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Gets or sets theme type of the map view. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Indicates whether the map should show the 3D buildings layer. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Indicates whether the map should show the traffic layer. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Indicates whether the map should show the public transit layer. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Indicates whether the scale-bar is enabled or not. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + + + + Sets language of map view. + + The display language in the map. + A language is specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code. + Each language tag is composed of one or more "subtags" separated by hyphens (-). + Each subtag is composed of basic Latin letters or digits only. + For example, "ko-KR" for Korean, "en-US" for American English. + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + + + + Gets or sets geographical coordinates for map view's center. + + 3 + http://tizen.org/privilege/mapservice + http://tizen.org/privilege/internet + http://tizen.org/privilege/network.get + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + + + + Gets a list of the map object added to map view. + + 3 + + + + Changes the geographical coordinates to screen coordinates. + + 3 + Geographical coordinates. + Returns an instance of the screen coordinates on the current screen. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + Thrown when a native operation failed to allocate memory and connect to the service. + + + + Changes the screen coordinates to geographical coordinates. + + 3 + Screen coordinates. + Returns an instance of the geographical coordinates object. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + Thrown when a native operation failed to allocate memory and connect to the service. + + + + Adds a map object to map view. + + 3 + An instance of the map object to be added. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + Thrown when a native operation failed to allocate memory and connect to the service. + + + + Removes a map object from the map view. + + 3 + An instance of the map object to be removed. + Once removed, the child object will be become invalid. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + Thrown when native operation failed to allocate memory and connect to the service. + + + + Removes all map objects from the map view. + + 3 + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when a native operation failed to allocate memory and connect to the service. + + + + Captures a snapshot of the map view. + + 3 + Type of file format. + An integer value representing the quality for encoding from 1 to 100. + A string representing the file path for a snapshot. + http://tizen.org/privilege/mapservice + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the value is invalid. + Thrown when a native operation failed to allocate memory and connect to the service. + + + + Releases all the resources used by this object. + + 3 + + + + The marker map object. + + 3 + + + + Gets or sets the clicked event handlers. + + 3 + + + + Gets or sets the marker's visibility. + + 3 + + + + Gets or sets the geographical coordinates for this marker. + + 3 + + + + Gets or sets a string representing the image file path for this marker. + + 3 + + + + Gets or sets the screen size for this marker. + + 3 + + + + Gets or sets the z-order for this marker. + + 3 + The integer value is 0 by default, and must be in the range of -100 to 100. + + + + Changes the marker size. + + 3 + New size. + + + + Changes the marker coordinates. + + 3 + New position for the marker. + + + + Releases all the resources used by this object. + + 3 + + + + Pin type the marker map object. + + 3 + + + + Creates a pin type marker. + + 3 + Marker coordinates. + Thrown when input coordinates are invalid. + + + + Creates a pin type marker. + + 3 + Marker coordinates. + Image file path for the Marker. + + http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage. + + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the input coordinates or imagePath is invalid. + + + + Sticker type marker map object. + + 3 + + + + Creates a sticker type marker. + + 3 + Marker coordinates. + Thrown when input coordinates are invalid. + + + + Creates a sticker type marker. + + 3 + Marker coordinates. + Image file path for Marker. + + http://tizen.org/privilege/mediastorage is needed if the input or output path are relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if the input or output path are relevant to external storage. + + Thrown when the required feature is not supported. + Thrown when application does not have some privilege to access this method. + Thrown when the input coordinates or imagePath is invalid. + + + + Multiple reverse geocode request for Tizen map service. + + 3 + + + + Overlay map object. + + 3 + + + + Creates a normal overlay map object. + + 3 + + + Thrown when the input coordinates or objectToContain are invalid. + + + + Gets or sets the visibility of an overlay map object. + + 3 + + + + Gets or sets geographical coordinates for an overlay map object. + + 3 + + + + Gets or sets minimum zoom level for an overlay map object. + + 3 + + + + Gets or sets maximum zoom lever for an overlay map object. + + 3 + + + + Releases all the resources used by this object. + + 3 + + + + The bubble overlay map object. + + 3 + + + + Creates a bubble overlay. + + 3 + The geographical coordinates to be pointed. + The EvasObject to be shown. + Thrown when the required feature is not supported. + Thrown when the input coordinates or objectToContain are invalid. + + + + The box overlay map object. + + 3 + + + + Creates a box overlay. + + 3 + The geographical coordinates to be pointed. + The EvasObject to be shown. + Thrown when the required feature is not supported. + Thrown when the input coordinates or objectToContain are invalid + + + + Place information, used in place discovery and search requests. + + 3 + + + + Gets an ID string for the place. + + 3 + + + + Gets name string for the place. + + 3 + + + + Gets a view URI for the place. + + 3 + + + + Gets a distance for the place from the center. + + 3 + + + + Gets a geographical location for the place. + + 3 + + + + Gets an address for the place. + + 3 + + + + Gets a rating for the place. + + 3 + + + + Gets a supplier link for the place. + + 3 + + + + Gets a related link for the place. + + 3 + + + + Gets all the properties attached to this place. + + 3 + + + + Gets all the categories attached to this place. + + 3 + + + + Gets all the attributes attached to this place. + + 3 + + + + Gets all the contacts attached to this place. + + 3 + + + + Gets all the editorials attached to this place. + + 3 + + + + Gets all the images attached to this place. + + 3 + + + + Gets all the reviews attached to this place. + + 3 + + + + Releases all the resources used by this object. + + 3 + + + + Address information for the map point used in geocode and reverse geocode requests. + + 3 + + + + Constructs a map address object. + + 3 + Thrown when native operation failed to allocate memory. + + + + Gets a building number for this address. + + 3 + + + + Gets a city name for this address. + + 3 + + + + Gets a country name for this address. + + 3 + + + + Gets a country code for this address. + + 3 + + + + Gets a county for this address. + + 3 + + + + Gets a district name for this address. + + 3 + + + + Gets a free text associated with this address. + + 3 + + + + Gets a postal code for this address. + + 3 + + + + Gets a state name for this address. + + 3 + + + + Gets a street name for this address. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Releases all the resources used by this object. + + 3 + + + + List of objects to be used in APIs. + + + + + Constructs a map address list object. + + Thrown when the required feature is not supported. + Thrown when native operation failed to allocate memory. + + + + Gets an iterator for addresses in this list. + + + + + Releases all the resources used by this object. + + 3 + + + + Place attributes information, used in place discovery and search requests. + + 3 + + + + Gets an ID for the place attribute. + + 3 + + + + Gets a label for the place attribute. + + 3 + + + + Gets a text for the place attribute. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Place category information, used in place discovery and search requests. + + 3 + + + + Constructs a search category object. + + 3 + Thrown when native operation failed to allocate memory. + + + + Gets or sets an ID for this category. + + 3 + + + + Gets or sets a name for this category. + + 3 + + + + Gets or sets a URL for this category. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Releases all the resources used by this object. + + 3 + + + + Place contact information, used in place discovery and search requests. + + 3 + + + + Gets an ID for this place contact. + + 3 + + + + Gets a label for this place contact. + + 3 + + + + Gets a value for this place contact. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Place editorial information, used in place discovery and search requests. + + 3 + + + + Gets a description for this place editorial. + + 3 + + + + Gets a language for this place editorial. + + 3 + + + + Gets an instance of object which representing media for this place editorial. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Place filter information, used in place discovery and search requests. + + 3 + + + + Constructs a new place filter. + + 3 + Thrown when native operation failed to allocate memory. + + + + Gets or sets a free-formed address string for this place filter. + + 3 + Depending on maps provider which the application has selected, + it may treat , and + as the same kind of strings to search places. + + + + Gets or sets an instance of object for this place filter. + + 3 + + + + Gets or sets a keyword for this place filter. + + 3 + Depending on maps provider which the application has selected, + it may treat , and + as the same kind of strings to search places. + + + + Gets or sets a name for this place filter. + + 3 + Depending on maps provider which the application has selected, + it may treat , and + as the same kind of strings to search places. + + + + Releases all the resources used by this object. + + 3 + + + + Place image information, used in place discovery and search requests. + + 3 + + + + Gets an ID for this place image. + + 3 + + + + Gets an URL for this place image. + + 3 + + + + Gets the width for this place image. + + 3 + + + + Gets the height for this place image. + + 3 + + + + Gets an object representing the user link for this place image. + + 3 + + + + Gets an object representing the image media for this place image. + + 3 + + + + Place link object information, used in place discovery and search requests. + + 3 + + + + Gets a string representing the ID for this place link. + + 3 + + + + Gets a string representing the name for this place link. + + 3 + + + + Gets a string representing the link for this place link. + + 3 + + + + Gets a string representing the type for this place link. + + 3 + + + + List of objects to be used in APIs. + + + + + Gets an iterator for the addresses in this list. + + + + + Releases all the resources used by this object. + + 3 + + + + Place media information, used in place discovery and search requests. + + 3 + + + + Gets a string representing the attribution for this place media. + + 3 + + + + Gets an instance of object representing the supplier for this place media. + + 3 + + + + Gets an instance of object representing via data for this place media. + + 3 + + + + Place rating information, used in place discovery and search requests. + + 3 + + + + Gets the number of users rated for this place rating. + + 3 + + + + Gets the average value of this place rating. + + 3 + + + + Returns a string that represents this object. + + 3 + Returns a string which presents this object. + + + + Place review information, used in place discovery and search requests. + + 3 + + + + Gets an instance of object representing the time of this review. + + 3 + + + + Gets a string representing the title of this review. + + 3 + + + + Gets a value representing the rating of this review. + + 3 + + + + Gets a string representing the description of this review. + + 3 + + + + Gets a string representing the language of this review. + + 3 + + + + Gets an instance of object representing the review media of this review. + + 3 + + + + Gets an instance of object representing the user link of this review. + + 3 + + + + Place search request for Tizen map service. + + 3 + + + + The polygon map object. + + 3 + + + + Creates a polygon visual object. + + 3 + List of geographical coordinates. + Background color. + Thrown when input values are invalid. + + + + Adds or removes the clicked event handlers. + + 3 + + + + Gets or sets visibility for the polygon. + + 3 + + + + Gets or sets a list of geographical coordinates for polygon vertices. + + 3 + + + + Gets or sets a background color to fill the polygon. + + 3 + + + + Releases all the resources used by this object. + + 3 + + + + The polyline map object. + + 3 + + + + Creates polyline visual object. + + 3 + List of geographical coordinates. + Line color. + The width of line [1 ~ 100] (pixels). + Thrown when input values are invalid. + + + + Adds or removes the clicked event handlers. + + 3 + + + + Gets or sets the visibility for polyline. + + 3 + + + + Gets or sets a list of geographical coordinates for polyline vertices. + + 3 + + + + Gets or sets the line color. + + 3 + + + + Gets or sets the line width from 1 to 100 pixels. + + 3 + + + + Releases all the resources used by this object. + + 3 + + + + Reverses the geocode request for a map service. + + 3 + + + + Route information, used in Route Search requests. + + 3 + + + + Gets an instance of object representing destination coordinates for this route. + + 3 + + + + Gets the total distance for this route. + + 3 + + + + Get the total duration to cover this route. + + 3 + + + + Gets an ID for this route. + + 3 + + + + Gets the transport mode for this route. + + 3 + + + + Gets the origin coordinates for this route. + + 3 + + + + Gets a coordinates list for this route. + + 3 + + + + Gets a segment list for this route. + + 3 + + + + Gets the distance unit for this route. + + 3 + + + + Gets an instance of object which representing bounding area for this route. + + + + + Releases all the resources used by this object. + + 3 + + + + Route features used for route search requests. + + 3 + + + + Indicates no route features are selected. + + + + + Indicates toll roads (toll gates/booths). + + + + + Indicates a motorway. + + + + + Indicates a boat ferry. + + + + + Indicates a rail (train) ferry. + + + + + Indicates a public transport. + + + + + Indicates a tunnel. + + + + + Indicates a dirt road. + + + + + Indicates a park. + + + + + Indicates a high-occupancy vehicle lane. + + + + + Indicates stairs. + + + + + Route feature weights used in route search requests. + + 3 + + + + Indicates normal weighting. + + + + + Indicates that a feature is preferred. + + + + + Indicates that a feature is to be avoided. + + + + + Indicates that soft-exclude applies to the feature. + + + + + Indicates that the feature is to be strictly excluded. + + + + + Route maneuver information used in route search requests. + + 3 + + + + Gets the direction type for this maneuver. + + 3 + + + + Gets the turn type for this maneuver. + + 3 + + + + Gets a geographical coordinates position for this maneuver. + + 3 + + + + Gets a name of the road for this maneuver. + + 3 + + + + Gets an instruction text for this maneuver. + + 3 + + + + Gets a locale for this maneuver. + + 3 + + + + Gets the time to next instruction for this maneuver. + + 3 + + + + Gets the distance to next instruction for this maneuver. + + 3 + + + + Allowed route optimization option used in route search requests. + + 3 + + Depending on the loaded maps plug-in using , some features might have no effect or differences with the descriptions. + + + + + Indicates searching for the fastest routes. + + + + + Indicates searching for the shortest routes (car mode only). + + + + + Indicates searching for the most economic routes (car mode only). + + + + + Indicates searching for the most scenic routes. + + + + + Indicates searching for most the fastest routes now, based on the current traffic condition. + + + + + Indicates searching for the direct drive routes. + + + + + Routes the search request for Tizen map service requests. + + 3 + + + + Gets or sets a list of way-points to cover between the origin and destination. + + 3 + + + + Place Segment information used in Route Search requests. + + 3 + + + + Gets the origin coordinates for this segment. + + 3 + + + + Gets the destination coordinates for this segment. + + 3 + + + + Gets the total distance for this segment. + + 3 + + + + Gets the total duration to cover this segment. + + 3 + + + + Gets the maneuver list for this segment. + + 3 + + + + Gets the coordinates list for this segment. + + 3 + + + + Preferences for route search requests. + + 3 + + + + Constructor for a new search preference. + + 3 + + + + Constructor for a new search preference. + + + + + Gets or sets a preferred language. + + 3 + Language should be specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code.
e.g. "ko-KR", "en-US". + + + + Gets or sets the maximum result count for each service request. + + 3 + Setting negative value will not have any effect on MaxResults value. + + + + Gets or sets the distance unit. + + 3 + + + + Gets or sets the preferred country. + + 3 + + + + Gets or sets the search properties as a key value pair. + + 3 + + + + Gets or sets the route optimization. + + 3 + + + + Gets or sets the route transport mode. + + 3 + + + + Gets or sets the route feature weight. + + 3 + + + + Gets or sets the route feature. + + 3 + + + + Gets or sets if the searching for alternative routes is enabled. + + 3 + + + + Releases all the resources used by this object. + + 3 + + + + Features available in the map service. + + 3 + + + + Indicates availability of address value in the place data. + + + + + Indicates availability of rating value in the place data. + + + + + Indicates availability of place category list in the place data. + + + + + Indicates availability of place attribute list in the place data. + + + + + Indicates availability of place contact list in the place data. + + + + + Indicates availability of place editorial list in the place data. + + + + + Indicates availability of place review list in the place data. + + + + + Indicates availability of place image in the place data. + + + + + Indicates availability of place supplier link value in the place data. + + + + + Indicates availability of a related place link in the place data. + + + + + Indicates that the route data structure is defined as a path (a list of geographical coordinates). + + + + + Indicates that the route data structure is defined as a list of segments while each segment is defined as a path. + + + + + Indicates that the route data structure is defined as a list of segments while each segment is defined as a list of maneuvers. + + + + + Indicates availability of traffic information on the map. + + + + + Indicates availability of public transit information on the map. + + + + + Indicates availability of 3D building drawable on the map. + + + + + Indicates availability of scale bar on the map. + + + + + Service requests available in the maps service. + + 3 + + + + Indicates the service request to get position for a given free-formed address string is allowed. + + + + + Indicates that service request to get position for a given address, within the specified bounding , is allowed. + + + + + Indicates that service request to get position for a given is allowed. + + + + + Indicates that service request to get for a given is allowed. + + + + + Indicates that service request to get for a given is allowed. + + + + + Indicates that service request to query information for a given is allowed. + + + + + Indicates that service request to query information for a given is allowed. + + + + + Indicates that service request to query information for a given free-formed address string is allowed. + + + + + Indicates that service request to query information list for all places in a given is allowed. + + + + + Indicates that service request to get detailed information for a given is allowed. + + + + + Indicates that service request to query information from a given origin and destination is allowed. + + + + + Indicates that service request to query information passing through specified way-points is allowed. + + + + + Indicates that map view service is allowed. + + + + + Indicates that map view snapshot service is allowed. + + + + + Enumeration for the snapshot file formats. + + 3 + + + + Indicates the BMP file format. + + + + + Indicates the JPEG file format. + + + + + Route types. + + 3 + + + + Indicates that the route is to be traveled by a car. + + + + + Indicates that the route is for a pedestrian. + + + + + Indicates that the route is for a cyclist. + + + + + Indicates that the route is to be traveled using public transport. + + + + + Indicates that the route is for a truck. + + + + + Turns the Instruction type for route maneuver. + + 3 + + + + Indicates an unknown instruction. + + + + + Indicates instruction to move straight. + + + + + Indicates instruction to bear right. + + + + + Indicates instruction to turn slightly to the right. + + + + + Indicates instruction to turn right. + + + + + Indicates instruction to turn hard to the right. + + + + + Indicates instruction to U-turn to the right. + + + + + Indicates instruction to U-turn to the left. + + + + + Indicates instruction to turn hard to the left. + + + + + Indicates instruction to turn left. + + + + + Indicates instruction to turn slightly to the left. + + + + + Indicates instruction to bear left. + + + + + Indicates instruction to take right fork. + + + + + Indicates instruction to take left fork. + + + + + Indicates instruction to take straight fork. + + + + diff --git a/Artifacts/bin/Tizen.Messaging.Push.dll b/Artifacts/bin/Tizen.Messaging.Push.dll index 724f04c..6df236b 100644 Binary files a/Artifacts/bin/Tizen.Messaging.Push.dll and b/Artifacts/bin/Tizen.Messaging.Push.dll differ diff --git a/Artifacts/bin/Tizen.Messaging.Push.pdb b/Artifacts/bin/Tizen.Messaging.Push.pdb index 691ec57..ecd3383 100644 Binary files a/Artifacts/bin/Tizen.Messaging.Push.pdb and b/Artifacts/bin/Tizen.Messaging.Push.pdb differ diff --git a/Artifacts/bin/Tizen.Messaging.Push.xml b/Artifacts/bin/Tizen.Messaging.Push.xml index 83fa71a..533e900 100644 --- a/Artifacts/bin/Tizen.Messaging.Push.xml +++ b/Artifacts/bin/Tizen.Messaging.Push.xml @@ -1,230 +1,230 @@ - - - - Tizen.Messaging.Push - - - - - - Event Handler for receiving the notifications. - - 3 - - - - Event Handler for receiving changes in States of the connection. - - 3 - - - - API to connect with the push service. - - 3 - http://tizen.org/privilege/push - In case of privilege not defined. - The Push Application ID Registered with the server. - - - - API to disconnect from the push service. - - 3 - - - - API to Register the application with the push server. - - 3 - - The method returns a task, which on completion will give a ServerResponse Object. - - - - - API to Deregister the application from the push server. - - 3 - - The method returns a task, which on completion will give a ServerResponse Object. - - - - - Gets the unread notifications for the application. - - 3 - - - - registration ID received from server. - 3 - - It is the string, which is the ID received from the server. - - - - - An extended EventArgs class, which contains the State Information. - - 3 - - - - Enumeration for the different states. - - 3 - - - - Registered with the Server. - - - - - Unregistered. - - - - - To change the provisioning server IP. - - - - - Ping interval is changing. - - - - - Error Occured in Changing State. - - - - - Gives the current state. - - 3 - - It is the current state. - - - - Gives information about the error if set. - - 3 - - It is the string, which contains the error string if set. - - - - An extended EventArgs class, which contains the message received. - - 3 - - - - Gives the Application Data recieved. - 3 - - It is the string, which stores the application data. - - - - Gives the Message Received Field. - - 3 - - It is the string, which stores the message field. - - - - Gives the time at which the Notification was received. - - 3 - - It is the DateTime field representing the time at which the Notification was received. - - - - Gives the Sender of the notification. - - 3 - - It is a string value representing the Sender of the Notification. - - - - Gives the session ID of the notification. - - 3 - - It is a string value representing the session ID of the Notification. - - - - Gives the request ID of the notification. - - 3 - - It is a string value representing the request ID of the Notification. - - - - Gives the value in the type field of the notification. - - 3 - - It is an integer value representing the type field of the notification. - - - - The ServerResponse structure provides the result and the server response if any. - - 3 - - - - Enumeration for the Result from the server. - - 3 - - - - Successful. - - - - - Time Out Occured. - - - - - Server Error Occured. - - - - - System Error Occured. - - - - - Gives the Result of the opeartion. - - 3 - - It is the Result state of the operation performed. - - - - Gives the Message from the server. - - 3 - - It is the Message sent by the server. - - - + + + + Tizen.Messaging.Push + + + + + + Event Handler for receiving the notifications. + + 3 + + + + Event Handler for receiving changes in States of the connection. + + 3 + + + + API to connect with the push service. + + 3 + http://tizen.org/privilege/push + In case of privilege not defined. + The Push Application ID Registered with the server. + + + + API to disconnect from the push service. + + 3 + + + + API to Register the application with the push server. + + 3 + + The method returns a task, which on completion will give a ServerResponse Object. + + + + + API to Deregister the application from the push server. + + 3 + + The method returns a task, which on completion will give a ServerResponse Object. + + + + + Gets the unread notifications for the application. + + 3 + + + + registration ID received from server. + 3 + + It is the string, which is the ID received from the server. + + + + + An extended EventArgs class, which contains the State Information. + + 3 + + + + Enumeration for the different states. + + 3 + + + + Registered with the Server. + + + + + Unregistered. + + + + + To change the provisioning server IP. + + + + + Ping interval is changing. + + + + + Error Occured in Changing State. + + + + + Gives the current state. + + 3 + + It is the current state. + + + + Gives information about the error if set. + + 3 + + It is the string, which contains the error string if set. + + + + An extended EventArgs class, which contains the message received. + + 3 + + + + Gives the Application Data recieved. + 3 + + It is the string, which stores the application data. + + + + Gives the Message Received Field. + + 3 + + It is the string, which stores the message field. + + + + Gives the time at which the Notification was received. + + 3 + + It is the DateTime field representing the time at which the Notification was received. + + + + Gives the Sender of the notification. + + 3 + + It is a string value representing the Sender of the Notification. + + + + Gives the session ID of the notification. + + 3 + + It is a string value representing the session ID of the Notification. + + + + Gives the request ID of the notification. + + 3 + + It is a string value representing the request ID of the Notification. + + + + Gives the value in the type field of the notification. + + 3 + + It is an integer value representing the type field of the notification. + + + + The ServerResponse structure provides the result and the server response if any. + + 3 + + + + Enumeration for the Result from the server. + + 3 + + + + Successful. + + + + + Time Out Occured. + + + + + Server Error Occured. + + + + + System Error Occured. + + + + + Gives the Result of the opeartion. + + 3 + + It is the Result state of the operation performed. + + + + Gives the Message from the server. + + 3 + + It is the Message sent by the server. + + + diff --git a/Artifacts/bin/Tizen.Messaging.dll b/Artifacts/bin/Tizen.Messaging.dll index f405b01..fabbc31 100644 Binary files a/Artifacts/bin/Tizen.Messaging.dll and b/Artifacts/bin/Tizen.Messaging.dll differ diff --git a/Artifacts/bin/Tizen.Messaging.pdb b/Artifacts/bin/Tizen.Messaging.pdb index 654e201..b605f41 100644 Binary files a/Artifacts/bin/Tizen.Messaging.pdb and b/Artifacts/bin/Tizen.Messaging.pdb differ diff --git a/Artifacts/bin/Tizen.Messaging.xml b/Artifacts/bin/Tizen.Messaging.xml index c06a59e..9ecc114 100644 --- a/Artifacts/bin/Tizen.Messaging.xml +++ b/Artifacts/bin/Tizen.Messaging.xml @@ -1,478 +1,478 @@ - - - - Tizen.Messaging - - - - - Represents an email attachment - - - - - The absolute full path of the file to be attached - - - - - The constructor - - - - - Result of sending the email - - - - - Failed to send the message - - - - - email sent successfully - - - - - The class contains Messaging API to support sending email messages. - - - - - The constructor - - - - - Subject of the email message - - - - - Body of the email message - - - - - List of file attachments - - - - - Collection of normal email recipients - - - Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). - - - - - Collection of CC(carbon copy) email recipients - - - Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). - - - - - Collection of BCC(blind carbon copy) email recipients - - - Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). - - - - - The class represents recipients of an email - - - - - The email address of the recipient - - - - - The constructor - - - - - The class to send email messages. - - - - - Sends the email message. - - The email message - Failure if email sending failed otherwise Success - - - - A class to represent cell broadcast messages. - - - - - A class to represent all messages. - - - - - The message ID - - - After creating Message object, default value of this property is 0. After sending, this value is changed. - - - - - The destination port of the message - - - - - The message box type - - - - - The text of the message - - - - - The time of the message - - - - - The SIM slot index of the message - - - - - Indicates sender of the message - - - - - An extended EventArgs class which contains a received message. - - - - - The received message - - - - - A class to manage informations of message address. - - - - - The address of the sender/recipient - - - - - Creates a message address. - - The recipient's address to receive a message - - - - A class to manage informations of message attachment. - - - - - The media type of attachment - - - - - The file path of attachment - - - - - Creates an attachment. - - The attachment's type - The file path to attach - - - - Enumeration for the result of sending a message. - - - - - Message sending failed - - - - - Message sending succeeded - - - - - Enumeration for the message type. - - - - - Unknown type - - - - - SMS type - - - - - MMS type - - - - - CB(Cell Broadcast) type - - - - - WAP Push type - - - - - Enumeration for the message box type. - - - - - All message box type - - - - - Inbox type - - - - - Outbox type - - - - - Sentbox type - - - - - Draft type - - - - - Enumeration for the SIM slot index of a message - - - - - Unknown SIM Slot - - - - - SIM Slot 1 - - - - - SIM Slot 2 - - - - - Enumeration for the recipient type of a message - - - - - Unknown - - - - - 'To' recipient - - - - - 'Cc' (carbon copy) recipient - - - - - 'Bcc' (blind carbon copy) recipient - - - - - Enumeration for the attachment tyoe for MMS messaging. - - - - - Unknown - - - - - The image - - - - - The audio - - - - - The video - - - - - A class for message management. It allows applications to use message service. - - http://tizen.org/privilege/message.read - - - - Sends a message. - - http://tizen.org/privilege/message.write - The message to be sent - The boolean variable to indicate sent message should be saved in sentbox or not - A task contains the result of message sending - Thrown when method failed due to invalid operation - Thrown when message service is not supported - Thrown when input coordinates are invalid - Thrown when application does not have proper privileges - - - - Searches for messages. - - http://tizen.org/privilege/message.read - The search filter for searching messages - A task contains the messages which fit with search filter - Thrown when method failed due to invalid operation - Thrown when message service is not supported - Thrown when input coordinates are invalid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - (event) MessageReceived is raised when receiving a message. - - http://tizen.org/privilege/message.read - - - - A class to represent message search filters. - - - - - Create a search filter for searching messages. - - - - - The message box type - - - - - The message type - - - - - The keyword to search in the text and subject - - - - - The recipient address - - - - - A class to represent multimedia messages. - - - - - Creates a multimedia message. - - - - - The subject of the multimedia message - - - - - Collection of normal message recipients - - - - - Collection of CC(carbon copy) message recipients - - - - - Collection of BCC(blind carbon copy) message recipients - - - - - The list of attachment files - - - - - A class to represent WAP push messages. - - - - - A class to represent short text messages. - - - - - Creates a short text message. - - - - - Collection of normal message recipients - - - - + + + + Tizen.Messaging + + + + + Represents an email attachment + + + + + The absolute full path of the file to be attached + + + + + The constructor + + + + + Result of sending the email + + + + + Failed to send the message + + + + + email sent successfully + + + + + The class contains Messaging API to support sending email messages. + + + + + The constructor + + + + + Subject of the email message + + + + + Body of the email message + + + + + List of file attachments + + + + + Collection of normal email recipients + + + Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). + + + + + Collection of CC(carbon copy) email recipients + + + Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). + + + + + Collection of BCC(blind carbon copy) email recipients + + + Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322). + + + + + The class represents recipients of an email + + + + + The email address of the recipient + + + + + The constructor + + + + + The class to send email messages. + + + + + Sends the email message. + + The email message + Failure if email sending failed otherwise Success + + + + A class to represent cell broadcast messages. + + + + + A class to represent all messages. + + + + + The message ID + + + After creating Message object, default value of this property is 0. After sending, this value is changed. + + + + + The destination port of the message + + + + + The message box type + + + + + The text of the message + + + + + The time of the message + + + + + The SIM slot index of the message + + + + + Indicates sender of the message + + + + + An extended EventArgs class which contains a received message. + + + + + The received message + + + + + A class to manage informations of message address. + + + + + The address of the sender/recipient + + + + + Creates a message address. + + The recipient's address to receive a message + + + + A class to manage informations of message attachment. + + + + + The media type of attachment + + + + + The file path of attachment + + + + + Creates an attachment. + + The attachment's type + The file path to attach + + + + Enumeration for the result of sending a message. + + + + + Message sending failed + + + + + Message sending succeeded + + + + + Enumeration for the message type. + + + + + Unknown type + + + + + SMS type + + + + + MMS type + + + + + CB(Cell Broadcast) type + + + + + WAP Push type + + + + + Enumeration for the message box type. + + + + + All message box type + + + + + Inbox type + + + + + Outbox type + + + + + Sentbox type + + + + + Draft type + + + + + Enumeration for the SIM slot index of a message + + + + + Unknown SIM Slot + + + + + SIM Slot 1 + + + + + SIM Slot 2 + + + + + Enumeration for the recipient type of a message + + + + + Unknown + + + + + 'To' recipient + + + + + 'Cc' (carbon copy) recipient + + + + + 'Bcc' (blind carbon copy) recipient + + + + + Enumeration for the attachment tyoe for MMS messaging. + + + + + Unknown + + + + + The image + + + + + The audio + + + + + The video + + + + + A class for message management. It allows applications to use message service. + + http://tizen.org/privilege/message.read + + + + Sends a message. + + http://tizen.org/privilege/message.write + The message to be sent + The boolean variable to indicate sent message should be saved in sentbox or not + A task contains the result of message sending + Thrown when method failed due to invalid operation + Thrown when message service is not supported + Thrown when input coordinates are invalid + Thrown when application does not have proper privileges + + + + Searches for messages. + + http://tizen.org/privilege/message.read + The search filter for searching messages + A task contains the messages which fit with search filter + Thrown when method failed due to invalid operation + Thrown when message service is not supported + Thrown when input coordinates are invalid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + (event) MessageReceived is raised when receiving a message. + + http://tizen.org/privilege/message.read + + + + A class to represent message search filters. + + + + + Create a search filter for searching messages. + + + + + The message box type + + + + + The message type + + + + + The keyword to search in the text and subject + + + + + The recipient address + + + + + A class to represent multimedia messages. + + + + + Creates a multimedia message. + + + + + The subject of the multimedia message + + + + + Collection of normal message recipients + + + + + Collection of CC(carbon copy) message recipients + + + + + Collection of BCC(blind carbon copy) message recipients + + + + + The list of attachment files + + + + + A class to represent WAP push messages. + + + + + A class to represent short text messages. + + + + + Creates a short text message. + + + + + Collection of normal message recipients + + + + diff --git a/Artifacts/bin/Tizen.Multimedia.AudioIO.dll b/Artifacts/bin/Tizen.Multimedia.AudioIO.dll index 2e8404e..0a989f5 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.AudioIO.dll and b/Artifacts/bin/Tizen.Multimedia.AudioIO.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.AudioIO.pdb b/Artifacts/bin/Tizen.Multimedia.AudioIO.pdb index 36c3d27..094efe1 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.AudioIO.pdb and b/Artifacts/bin/Tizen.Multimedia.AudioIO.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.AudioIO.xml b/Artifacts/bin/Tizen.Multimedia.AudioIO.xml index 0c8ee9c..61c435e 100644 --- a/Artifacts/bin/Tizen.Multimedia.AudioIO.xml +++ b/Artifacts/bin/Tizen.Multimedia.AudioIO.xml @@ -1,1045 +1,1045 @@ - - - - Tizen.Multimedia.AudioIO - - - - - Provides the ability to directly manage the system audio input devices. - - http://tizen.org/privilege/recorder - - - - Specifies the minimum value allowed for the audio capture, in Hertz (Hz). - - - - - - Specifies the maximum value allowed for the audio capture, in Hertz (Hz). - - - - - - Occurs when the state of the AudioCapture is changed. - - - - - Gets the sample rate of the audio input data stream, in Hertz (Hz). - - - - - Gets the channel type of the audio input data stream. - - - - - Gets the sample type of the audio input data stream. - - - - - Gets the size allocated for the audio input buffer. - - The AudioPlayback has already been disposed. - - - - Prepares the AudioCapture for reading audio data by starting buffering of audio data from the device. - - - Operation failed due to internal error.\n - -or-\n - The current state is not . - - - - - - Unprepares the AudioCapture. - - - Operation failed due to internal error.\n - -or-\n - The current state is . - - - - - - Pauses buffering of audio data from the device. - - - The current state is .\n - -or-\n - The method is called in the event handler. - - - - - - Resumes buffering audio data from the device. - - - The current state is .\n - -or-\n - The method is called in the event handler. - - - - - - Flushes and discards buffered audio data from the input stream. - - The current state is . - - - - Sets the sound stream information to the audio input. - - The to apply for the AudioCapture. - is null. - has already been disposed. - is not supported. - Not able to retrieve information from . - - - - Provides the ability to record audio from system audio input devices in synchronous way. - - http://tizen.org/privilege/recorder - - - - Initializes a new instance of the AudioCapture class with the specified sample rate, channel and sampleType. - - The audio sample rate.(8000 ~ 48000Hz) - The audio channel type. - The audio sample type. - - is less than .\n - -or-\n - is greater than . - - - is invalid.\n - -or-\n - is invalid. - - The required privilege is not specified. - The system does not support microphone. - - - - Reads audio data from the audio input buffer. - - The number of bytes to be read. - The buffer of audio data captured. - The current state is not . - is equal to or less than zero. - - - - Provides the ability to record audio from system audio input devices in asynchronous way. - - http://tizen.org/privilege/recorder - - - - Occurs when audio data is available. - - - - - Initializes a new instance of the AsyncAudioCapture class with the specified sample rate, channel and sampleType. - - The audio sample rate.(8000 ~ 48000Hz) - The audio channel type. - The audio sample type. - - is less than .\n - -or-\n - is greater than . - - - is invalid.\n - -or-\n - is invalid. - - The required privilege is not specified. - The system does not support microphone. - - - - Provides data for the event. - - - - - Gets the audio data captured. - - - - - Specifies the states for the , and . - - - - - Not prepared. - - - - - The stream is running. - - - - - The stream is paused. - - - - - Enumeration for audio sample type. - - - - - Unsigned 8-bit audio samples. - - - - - Signed 16-bit audio samples. - - - - - Provides data for the event and . - - - - - Gets the previous state. - - - - - Gets the current state. - - - - - Gets the value indicating whether the state is changed by policy or not. - - - - - Provides the ability to directly manage the system audio output devices and play PCM (pulse-code modulation) data. - - - - - Specifies the minimum value allowed for the audio capture, in Hertz (Hz). - - - - - - Specifies the maximum value allowed for the audio capture, in Hertz (Hz). - - - - - - Occurs when audio playback data can be written. - - - - - - Occurs when the state of the AudioPlayback is changed. - - - - - Initializes a new instance of the AudioPlayback class with the specified sample rate, channel and sample type. - - The audio sample rate.(8000 ~ 48000Hz) - The audio channel type. - The audio sample type. - - is less than .\n - -or-\n - is greater than . - - - is invalid.\n - -or-\n - is invalid. - - - - - Gets the sample rate of the audio output data stream, in Hertz (Hz). - - - - - Gets the channel type of the audio output data stream. - - - - - Gets the sample type of the audio output data stream. - - - - - Gets the sound type supported by the audio output device. - - The AudioPlayback has already been disposed. - - - - Gets the size allocated for the audio output buffer. - - The AudioPlayback has already been disposed. - - - - Drains buffered audio data from the output stream. - It blocks the calling thread until draining the stream buffer completely. (e.g. end of playback) - - The AudioPlayback has already been disposed. - The current state is . - - - - Starts writing the audio data to the device. - - The buffer to write. - The written size. - is null. - The length of is zero. - The current state is not . - The AudioPlayback has already been disposed. - - - - Prepares the AudioPlayback. - - - This must be called before . - - - Operation failed due to internal error.\n - -or-\n - The current state is not . - - The AudioPlayback has already been disposed. - - - - - Unprepares the AudioPlayback. - - - Operation failed due to internal error.\n - -or-\n - The current state is . - - The AudioPlayback has already been disposed. - - - - - Pauses feeding of audio data to the device. - - It has no effect if the current is the . - - The current state is .\n - -or-\n - The method is called in the event handler. - - The AudioPlayback has already been disposed. - - - - - Resumes feeding of audio data to the device. - - It has no effect if the current is the . - - The current state is .\n - -or-\n - The method is called in an event handler. - - The AudioPlayback has already been disposed. - - - - - Flushes and discards buffered audio data from the output stream. - - The current state is . - The AudioPlayback has already been disposed. - - - - Applies the sound stream information to the AudioPlayback. - - The to apply for the AudioPlayback. - is null. - - has already been disposed.\n - -or-\n - The AudioPlayback has already been disposed. - - is not supported. - Not able to retrieve information from . - - - - Provides the ability to play a tone. - - - - - Plays a tone, asynchronously. - - A to play. - A . - The tone duration in milliseconds. -1 indicates an infinite duration. - A task that represents the asynchronous operation. - is invalid. - is null. - is less than -1. - Any invalid operations occurred. - is not a supported type. - has already been disposed. - - - - Plays a tone, asynchronously. - - A to play. - A . - The tone duration in milliseconds. -1 indicates an infinite duration. - The cancellation token which can be used to stop playing the tone. - A task that represents the asynchronous operation. - is invalid. - is null. - is less than -1. - Any invalid operations occurred. - is not a supported type. - has already been disposed. - - - - Enumeration for Audio Codec. - - - - - The default tone. - - - - - Predefined DTMF 0. - - - - - Predefined DTMF 1. - - - - - Predefined DTMF 2. - - - - - redefined DTMF 3. - - - - - Predefined DTMF 4. - - - - - Predefined DTMF 5. - - - - - Predefined DTMF 6. - - - - - Predefined DTMF 7. - - - - - Predefined DTMF 8. - - - - - Predefined DTMF 9. - - - - - Predefined DTMF Star - Asterisk. - - - - - Predefined DTMF sharp (#). - - - - - Predefined DTMF A (A). - - - - - Predefined DTMF B (B). - - - - - Predefined DTMF C (C). - - - - - Predefined DTMF D (D). - - - - - Call supervisory tone, Dial tone: CEPT: 425Hz, continuous. - - - - - Call supervisory tone, Dial tone: ANSI (IS-95): 350Hz+440Hz, continuous. - - - - - Call supervisory tone, Dial tone: JAPAN: 400Hz, continuous. - - - - - Call supervisory tone, Busy: CEPT: 425Hz, 500ms ON, 500ms OFF. - - - - - Call supervisory tone, Busy: ANSI (IS-95): 480Hz+620Hz, 500ms ON, 500ms OFF. - - - - - Call supervisory tone, Busy: JAPAN: 400Hz, 500ms ON, 500ms OFF. - - - - - Call supervisory tone, Congestion: CEPT, JAPAN: 425Hz, 200ms ON, 200ms OFF. - - - - - Call supervisory tone, Congestion: ANSI (IS-95): 480Hz+620Hz, 250ms ON, 250ms OFF. - - - - - Call supervisory tone, Radio path acknowledgment : CEPT, ANSI: 425Hz, 200ms ON. - - - - - Call supervisory tone, Radio path acknowledgment : JAPAN: 400Hz, 1s ON, 2s OFF. - - - - - Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts. - - - - - Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF. - - - - - Call supervisory tone, Call Waiting: CEPT, JAPAN: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF. - - - - - Call supervisory tone, Call Waiting: ANSI (IS-95): 440 Hz, 300 ms ON, 9.7 s OFF, (100 ms ON, 100 ms OFF, 100 ms ON, 9.7s OFF. - - - - - Call supervisory tone, Ring Tone: CEPT, JAPAN: 425Hz, 1s ON, 4s OFF. - - - - - Call supervisory tone, Ring Tone: ANSI (IS-95): 440Hz + 480Hz, 2s ON, 4s OFF. - - - - - General beep: 400Hz+1200Hz, 35ms ON. - - - - - Proprietary tone, positive acknowledgment: 1200Hz, 100ms ON, 100ms OFF 2 bursts. - - - - - Proprietary tone, negative acknowledgment: 300Hz+400Hz+500Hz, 400ms ON. - - - - - Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON. - - - - - Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON. - - - - - Call supervisory tone (IS-95), intercept tone: alternating 440 Hz and 620 Hz tones, each on for 250 ms. - - - - - Call supervisory tone (IS-95), abbreviated intercept: intercept tone limited to 4 seconds. - - - - - Call supervisory tone (IS-95), abbreviated congestion: congestion tone limited to 4 seconds. - - - - - Call supervisory tone (IS-95), confirm tone: a 350 Hz tone added to a 440 Hz tone repeated 3 times in a 100 ms on, 100 ms off cycle. - - - - - Call supervisory tone (IS-95), pip tone: four bursts of 480 Hz tone (0.1 s on, 0.1 s off). - - - - - 425Hz continuous. - - - - - CDMA USA Ringback: 440Hz+480Hz 2s ON, 4000 OFF. - - - - - CDMA Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON. - - - - - CDMA Abbr Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON. - - - - - CDMA Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF. - - - - - CDMA Abbr Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF repeated for 8 times. - - - - - CDMA Network Busy tone: 480Hz+620Hz 500ms ON, 500ms OFF continuous. - - - - - CDMA Confirm tone: 350Hz+440Hz 100ms ON, 100ms OFF repeated for 3 times. - - - - - CDMA answer tone: silent tone - definition Frequency 0, 0ms ON, 0ms OFF. - - - - - CDMA Network Callwaiting tone: 440Hz 300ms ON. - - - - - CDMA PIP tone: 480Hz 100ms ON, 100ms OFF repeated for 4 times. - - - - - ISDN Call Signal Normal tone: {2091Hz 32ms ON, 2556 64ms ON} 20 times, 2091 32ms ON, 2556 48ms ON, 4s OFF. - - - - - ISDN Call Signal Intergroup tone: {2091Hz 32ms ON, 2556 64ms ON} 8 times, 2091Hz 32ms ON, 400ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 8times, 2091Hz 32ms ON, 4s OFF. - - - - - ISDN Call Signal SP PRI tone:{2091Hz 32ms ON, 2556 64ms ON} 4 times 2091Hz 16ms ON, 200ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 4 times, 2091Hz 16ms ON, 200ms OFF. - - - - - ISDN Call sign PAT3 tone: silent tone. - - - - - ISDN Ping Ring tone: {2091Hz 32ms ON, 2556Hz 64ms ON} 5 times 2091Hz 20ms ON. - - - - - ISDN Pat5 tone: silent tone. - - - - - ISDN Pat6 tone: silent tone. - - - - - ISDN Pat7 tone: silent tone. - - - - - TONE_CDMA_HIGH_L tone: {3700Hz 25ms, 4000Hz 25ms} 40 times 4000ms OFF, Repeat. - - - - - TONE_CDMA_MED_L tone: {2600Hz 25ms, 2900Hz 25ms} 40 times 4000ms OFF, Repeat. - - - - - TONE_CDMA_LOW_L tone: {1300Hz 25ms, 1450Hz 25ms} 40 times, 4000ms OFF, Repeat. - - - - - CDMA HIGH SS tone: {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 400ms OFF, repeat. - - - - - CDMA MED SS tone: {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 400ms OFF, repeat. - - - - - CDMA LOW SS tone: {1300z 25ms, 1450Hz 25ms} repeat 16 times, 400ms OFF, repeat. - - - - - CDMA HIGH SSL tone: {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 4000ms OFF, repeat. - - - - - CDMA MED SSL tone: {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 4000ms OFF, repeat. - - - - - CDMA LOW SSL tone: {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 16 times, 4000ms OFF, repeat. - - - - - CDMA HIGH SS2 tone: {3700Hz 25ms, 4000Hz 25ms} 20 times, 1000ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 3000ms OFF, repeat. - - - - - CDMA MED SS2 tone: {2600Hz 25ms, 2900Hz 25ms} 20 times, 1000ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 3000ms OFF, repeat. - - - - - CDMA LOW SS2 tone: {1300Hz 25ms, 1450Hz 25ms} 20 times, 1000ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 3000ms OFF, repeat. - - - - - CDMA HIGH SLS tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 3000ms OFF, REPEAT. - - - - - CDMA MED SLS tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 3000ms OFF, REPEAT. - - - - - CDMA LOW SLS tone: {1300Hz 25ms, 1450Hz 25ms} 10 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 10 times, 3000ms OFF, REPEAT. - - - - - CDMA HIGH S X4 tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 2500ms OFF, REPEAT. - - - - - CDMA MED S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT. - - - - - CDMA LOW S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT. - - - - - CDMA HIGH PBX L: {3700Hz 25ms, 4000Hz 25ms}20 times, 2000ms OFF, REPEAT. - - - - - CDMA MED PBX L: {2600Hz 25ms, 2900Hz 25ms}20 times, 2000ms OFF, REPEAT. - - - - - CDMA LOW PBX L: {1300Hz 25ms,1450Hz 25ms}20 times, 2000ms OFF, REPEAT. - - - - - CDMA HIGH PBX SS tone: {3700Hz 25ms, 4000Hz 25ms} 8 times 200 ms OFF, {3700Hz 25ms 4000Hz 25ms}8 times, 2000ms OFF, REPEAT. - - - - - CDMA MED PBX SS tone: {2600Hz 25ms, 2900Hz 25ms} 8 times 200 ms OFF, {2600Hz 25ms 2900Hz 25ms}8 times, 2000ms OFF, REPEAT. - - - - - CDMA LOW PBX SS tone: {1300Hz 25ms, 1450Hz 25ms} 8 times 200 ms OFF, {1300Hz 25ms 1450Hz 25ms}8 times, 2000ms OFF, REPEAT. - - - - - CDMA HIGH PBX SSL tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 1000ms OFF, REPEAT. - - - - - CDMA MED PBX SSL tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 1000ms OFF, REPEAT. - - - - - CDMA LOW PBX SSL tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 1000ms OFF, REPEAT. - - - - - CDMA HIGH PBX SLS tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 1000ms OFF, REPEAT. - - - - - CDMA MED PBX SLS tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 1000ms OFF, REPEAT. - - - - - CDMA LOW PBX SLS tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 1000ms OFF, REPEAT. - - - - - CDMA HIGH PBX X S4 tone: {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 800ms OFF, REPEAT. - - - - - CDMA MED PBX X S4 tone: {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 800ms OFF, REPEAT. - - - - - CDMA LOW PBX X S4 tone: {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 800ms OFF, REPEAT. - - - - - CDMA Alert Network Lite tone: 1109Hz 62ms ON, 784Hz 62ms ON, 740Hz 62ms ON 622Hz 62ms ON, 1109Hz 62ms ON. - - - - - CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON. - - - - - CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON. - - - - - CDMA KEYPAD Volume key lite tone: 941Hz+1477Hz 120ms ON. - - - - - CDMA PRESSHOLDKEY LITE tone: 587Hz 375ms ON, 1175Hz 125ms ON. - - - - - CDMA ALERT INCALL LITE tone: 587Hz 62ms, 784 62ms, 831Hz 62ms, 784Hz 62ms, 1109 62ms, 784Hz 62ms, 831Hz 62ms, 784Hz 62ms. - - - - - CDMA EMERGENCY RINGBACK tone: {941Hz 125ms ON, 10ms OFF} 3times 4990ms OFF, REPEAT. - - - - - CDMA ALERT CALL GUARD tone: {1319Hz 125ms ON, 125ms OFF} 3 times. - - - - - CDMA SOFT ERROR LITE tone: 1047Hz 125ms ON, 370Hz 125ms. - - - - - CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms. - - - - - CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. - - - - - CDMA_ABBR_ALERT tone: 1150Hz+770Hz 400ms ON. - - - - - CDMA_SIGNAL_OFF - silent tone. - - - - - User Defined Tone: 100Hz continuous. - - - - - User Defined Tone: 200Hz continuous. - - - - - User Defined Tone: 300Hz continuous. - - - - - Provides the ability to play a wav file. - - - - - Plays a wav file based on the specified . - - A task that represents the asynchronous operation. - A file path to play. - A . - - is null. - -or- - is null. - - An internal error occurs. - does not exists. - The format of is not supported. - has already been disposed of. - - - - Plays a wav file based on the specified . - - A task that represents the asynchronous operation. - A file path to play. - A . - A cancellation token which can be used to stop. - - is null. - -or- - is null. - - An internal error occurs. - does not exists. - The format of is not supported. - has already been disposed. - - - + + + + Tizen.Multimedia.AudioIO + + + + + Provides the ability to directly manage the system audio input devices. + + http://tizen.org/privilege/recorder + + + + Specifies the minimum value allowed for the audio capture, in Hertz (Hz). + + + + + + Specifies the maximum value allowed for the audio capture, in Hertz (Hz). + + + + + + Occurs when the state of the AudioCapture is changed. + + + + + Gets the sample rate of the audio input data stream, in Hertz (Hz). + + + + + Gets the channel type of the audio input data stream. + + + + + Gets the sample type of the audio input data stream. + + + + + Gets the size allocated for the audio input buffer. + + The AudioPlayback has already been disposed. + + + + Prepares the AudioCapture for reading audio data by starting buffering of audio data from the device. + + + Operation failed due to internal error.\n + -or-\n + The current state is not . + + + + + + Unprepares the AudioCapture. + + + Operation failed due to internal error.\n + -or-\n + The current state is . + + + + + + Pauses buffering of audio data from the device. + + + The current state is .\n + -or-\n + The method is called in the event handler. + + + + + + Resumes buffering audio data from the device. + + + The current state is .\n + -or-\n + The method is called in the event handler. + + + + + + Flushes and discards buffered audio data from the input stream. + + The current state is . + + + + Sets the sound stream information to the audio input. + + The to apply for the AudioCapture. + is null. + has already been disposed. + is not supported. + Not able to retrieve information from . + + + + Provides the ability to record audio from system audio input devices in synchronous way. + + http://tizen.org/privilege/recorder + + + + Initializes a new instance of the AudioCapture class with the specified sample rate, channel and sampleType. + + The audio sample rate.(8000 ~ 48000Hz) + The audio channel type. + The audio sample type. + + is less than .\n + -or-\n + is greater than . + + + is invalid.\n + -or-\n + is invalid. + + The required privilege is not specified. + The system does not support microphone. + + + + Reads audio data from the audio input buffer. + + The number of bytes to be read. + The buffer of audio data captured. + The current state is not . + is equal to or less than zero. + + + + Provides the ability to record audio from system audio input devices in asynchronous way. + + http://tizen.org/privilege/recorder + + + + Occurs when audio data is available. + + + + + Initializes a new instance of the AsyncAudioCapture class with the specified sample rate, channel and sampleType. + + The audio sample rate.(8000 ~ 48000Hz) + The audio channel type. + The audio sample type. + + is less than .\n + -or-\n + is greater than . + + + is invalid.\n + -or-\n + is invalid. + + The required privilege is not specified. + The system does not support microphone. + + + + Provides data for the event. + + + + + Gets the audio data captured. + + + + + Specifies the states for the , and . + + + + + Not prepared. + + + + + The stream is running. + + + + + The stream is paused. + + + + + Enumeration for audio sample type. + + + + + Unsigned 8-bit audio samples. + + + + + Signed 16-bit audio samples. + + + + + Provides data for the event and . + + + + + Gets the previous state. + + + + + Gets the current state. + + + + + Gets the value indicating whether the state is changed by policy or not. + + + + + Provides the ability to directly manage the system audio output devices and play PCM (pulse-code modulation) data. + + + + + Specifies the minimum value allowed for the audio capture, in Hertz (Hz). + + + + + + Specifies the maximum value allowed for the audio capture, in Hertz (Hz). + + + + + + Occurs when audio playback data can be written. + + + + + + Occurs when the state of the AudioPlayback is changed. + + + + + Initializes a new instance of the AudioPlayback class with the specified sample rate, channel and sample type. + + The audio sample rate.(8000 ~ 48000Hz) + The audio channel type. + The audio sample type. + + is less than .\n + -or-\n + is greater than . + + + is invalid.\n + -or-\n + is invalid. + + + + + Gets the sample rate of the audio output data stream, in Hertz (Hz). + + + + + Gets the channel type of the audio output data stream. + + + + + Gets the sample type of the audio output data stream. + + + + + Gets the sound type supported by the audio output device. + + The AudioPlayback has already been disposed. + + + + Gets the size allocated for the audio output buffer. + + The AudioPlayback has already been disposed. + + + + Drains buffered audio data from the output stream. + It blocks the calling thread until draining the stream buffer completely. (e.g. end of playback) + + The AudioPlayback has already been disposed. + The current state is . + + + + Starts writing the audio data to the device. + + The buffer to write. + The written size. + is null. + The length of is zero. + The current state is not . + The AudioPlayback has already been disposed. + + + + Prepares the AudioPlayback. + + + This must be called before . + + + Operation failed due to internal error.\n + -or-\n + The current state is not . + + The AudioPlayback has already been disposed. + + + + + Unprepares the AudioPlayback. + + + Operation failed due to internal error.\n + -or-\n + The current state is . + + The AudioPlayback has already been disposed. + + + + + Pauses feeding of audio data to the device. + + It has no effect if the current is the . + + The current state is .\n + -or-\n + The method is called in the event handler. + + The AudioPlayback has already been disposed. + + + + + Resumes feeding of audio data to the device. + + It has no effect if the current is the . + + The current state is .\n + -or-\n + The method is called in an event handler. + + The AudioPlayback has already been disposed. + + + + + Flushes and discards buffered audio data from the output stream. + + The current state is . + The AudioPlayback has already been disposed. + + + + Applies the sound stream information to the AudioPlayback. + + The to apply for the AudioPlayback. + is null. + + has already been disposed.\n + -or-\n + The AudioPlayback has already been disposed. + + is not supported. + Not able to retrieve information from . + + + + Provides the ability to play a tone. + + + + + Plays a tone, asynchronously. + + A to play. + A . + The tone duration in milliseconds. -1 indicates an infinite duration. + A task that represents the asynchronous operation. + is invalid. + is null. + is less than -1. + Any invalid operations occurred. + is not a supported type. + has already been disposed. + + + + Plays a tone, asynchronously. + + A to play. + A . + The tone duration in milliseconds. -1 indicates an infinite duration. + The cancellation token which can be used to stop playing the tone. + A task that represents the asynchronous operation. + is invalid. + is null. + is less than -1. + Any invalid operations occurred. + is not a supported type. + has already been disposed. + + + + Enumeration for Audio Codec. + + + + + The default tone. + + + + + Predefined DTMF 0. + + + + + Predefined DTMF 1. + + + + + Predefined DTMF 2. + + + + + redefined DTMF 3. + + + + + Predefined DTMF 4. + + + + + Predefined DTMF 5. + + + + + Predefined DTMF 6. + + + + + Predefined DTMF 7. + + + + + Predefined DTMF 8. + + + + + Predefined DTMF 9. + + + + + Predefined DTMF Star - Asterisk. + + + + + Predefined DTMF sharp (#). + + + + + Predefined DTMF A (A). + + + + + Predefined DTMF B (B). + + + + + Predefined DTMF C (C). + + + + + Predefined DTMF D (D). + + + + + Call supervisory tone, Dial tone: CEPT: 425Hz, continuous. + + + + + Call supervisory tone, Dial tone: ANSI (IS-95): 350Hz+440Hz, continuous. + + + + + Call supervisory tone, Dial tone: JAPAN: 400Hz, continuous. + + + + + Call supervisory tone, Busy: CEPT: 425Hz, 500ms ON, 500ms OFF. + + + + + Call supervisory tone, Busy: ANSI (IS-95): 480Hz+620Hz, 500ms ON, 500ms OFF. + + + + + Call supervisory tone, Busy: JAPAN: 400Hz, 500ms ON, 500ms OFF. + + + + + Call supervisory tone, Congestion: CEPT, JAPAN: 425Hz, 200ms ON, 200ms OFF. + + + + + Call supervisory tone, Congestion: ANSI (IS-95): 480Hz+620Hz, 250ms ON, 250ms OFF. + + + + + Call supervisory tone, Radio path acknowledgment : CEPT, ANSI: 425Hz, 200ms ON. + + + + + Call supervisory tone, Radio path acknowledgment : JAPAN: 400Hz, 1s ON, 2s OFF. + + + + + Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts. + + + + + Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF. + + + + + Call supervisory tone, Call Waiting: CEPT, JAPAN: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF. + + + + + Call supervisory tone, Call Waiting: ANSI (IS-95): 440 Hz, 300 ms ON, 9.7 s OFF, (100 ms ON, 100 ms OFF, 100 ms ON, 9.7s OFF. + + + + + Call supervisory tone, Ring Tone: CEPT, JAPAN: 425Hz, 1s ON, 4s OFF. + + + + + Call supervisory tone, Ring Tone: ANSI (IS-95): 440Hz + 480Hz, 2s ON, 4s OFF. + + + + + General beep: 400Hz+1200Hz, 35ms ON. + + + + + Proprietary tone, positive acknowledgment: 1200Hz, 100ms ON, 100ms OFF 2 bursts. + + + + + Proprietary tone, negative acknowledgment: 300Hz+400Hz+500Hz, 400ms ON. + + + + + Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON. + + + + + Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON. + + + + + Call supervisory tone (IS-95), intercept tone: alternating 440 Hz and 620 Hz tones, each on for 250 ms. + + + + + Call supervisory tone (IS-95), abbreviated intercept: intercept tone limited to 4 seconds. + + + + + Call supervisory tone (IS-95), abbreviated congestion: congestion tone limited to 4 seconds. + + + + + Call supervisory tone (IS-95), confirm tone: a 350 Hz tone added to a 440 Hz tone repeated 3 times in a 100 ms on, 100 ms off cycle. + + + + + Call supervisory tone (IS-95), pip tone: four bursts of 480 Hz tone (0.1 s on, 0.1 s off). + + + + + 425Hz continuous. + + + + + CDMA USA Ringback: 440Hz+480Hz 2s ON, 4000 OFF. + + + + + CDMA Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON. + + + + + CDMA Abbr Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON. + + + + + CDMA Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF. + + + + + CDMA Abbr Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF repeated for 8 times. + + + + + CDMA Network Busy tone: 480Hz+620Hz 500ms ON, 500ms OFF continuous. + + + + + CDMA Confirm tone: 350Hz+440Hz 100ms ON, 100ms OFF repeated for 3 times. + + + + + CDMA answer tone: silent tone - definition Frequency 0, 0ms ON, 0ms OFF. + + + + + CDMA Network Callwaiting tone: 440Hz 300ms ON. + + + + + CDMA PIP tone: 480Hz 100ms ON, 100ms OFF repeated for 4 times. + + + + + ISDN Call Signal Normal tone: {2091Hz 32ms ON, 2556 64ms ON} 20 times, 2091 32ms ON, 2556 48ms ON, 4s OFF. + + + + + ISDN Call Signal Intergroup tone: {2091Hz 32ms ON, 2556 64ms ON} 8 times, 2091Hz 32ms ON, 400ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 8times, 2091Hz 32ms ON, 4s OFF. + + + + + ISDN Call Signal SP PRI tone:{2091Hz 32ms ON, 2556 64ms ON} 4 times 2091Hz 16ms ON, 200ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 4 times, 2091Hz 16ms ON, 200ms OFF. + + + + + ISDN Call sign PAT3 tone: silent tone. + + + + + ISDN Ping Ring tone: {2091Hz 32ms ON, 2556Hz 64ms ON} 5 times 2091Hz 20ms ON. + + + + + ISDN Pat5 tone: silent tone. + + + + + ISDN Pat6 tone: silent tone. + + + + + ISDN Pat7 tone: silent tone. + + + + + TONE_CDMA_HIGH_L tone: {3700Hz 25ms, 4000Hz 25ms} 40 times 4000ms OFF, Repeat. + + + + + TONE_CDMA_MED_L tone: {2600Hz 25ms, 2900Hz 25ms} 40 times 4000ms OFF, Repeat. + + + + + TONE_CDMA_LOW_L tone: {1300Hz 25ms, 1450Hz 25ms} 40 times, 4000ms OFF, Repeat. + + + + + CDMA HIGH SS tone: {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 400ms OFF, repeat. + + + + + CDMA MED SS tone: {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 400ms OFF, repeat. + + + + + CDMA LOW SS tone: {1300z 25ms, 1450Hz 25ms} repeat 16 times, 400ms OFF, repeat. + + + + + CDMA HIGH SSL tone: {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 4000ms OFF, repeat. + + + + + CDMA MED SSL tone: {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 4000ms OFF, repeat. + + + + + CDMA LOW SSL tone: {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 16 times, 4000ms OFF, repeat. + + + + + CDMA HIGH SS2 tone: {3700Hz 25ms, 4000Hz 25ms} 20 times, 1000ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 3000ms OFF, repeat. + + + + + CDMA MED SS2 tone: {2600Hz 25ms, 2900Hz 25ms} 20 times, 1000ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 3000ms OFF, repeat. + + + + + CDMA LOW SS2 tone: {1300Hz 25ms, 1450Hz 25ms} 20 times, 1000ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 3000ms OFF, repeat. + + + + + CDMA HIGH SLS tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 3000ms OFF, REPEAT. + + + + + CDMA MED SLS tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 3000ms OFF, REPEAT. + + + + + CDMA LOW SLS tone: {1300Hz 25ms, 1450Hz 25ms} 10 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 10 times, 3000ms OFF, REPEAT. + + + + + CDMA HIGH S X4 tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 2500ms OFF, REPEAT. + + + + + CDMA MED S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT. + + + + + CDMA LOW S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT. + + + + + CDMA HIGH PBX L: {3700Hz 25ms, 4000Hz 25ms}20 times, 2000ms OFF, REPEAT. + + + + + CDMA MED PBX L: {2600Hz 25ms, 2900Hz 25ms}20 times, 2000ms OFF, REPEAT. + + + + + CDMA LOW PBX L: {1300Hz 25ms,1450Hz 25ms}20 times, 2000ms OFF, REPEAT. + + + + + CDMA HIGH PBX SS tone: {3700Hz 25ms, 4000Hz 25ms} 8 times 200 ms OFF, {3700Hz 25ms 4000Hz 25ms}8 times, 2000ms OFF, REPEAT. + + + + + CDMA MED PBX SS tone: {2600Hz 25ms, 2900Hz 25ms} 8 times 200 ms OFF, {2600Hz 25ms 2900Hz 25ms}8 times, 2000ms OFF, REPEAT. + + + + + CDMA LOW PBX SS tone: {1300Hz 25ms, 1450Hz 25ms} 8 times 200 ms OFF, {1300Hz 25ms 1450Hz 25ms}8 times, 2000ms OFF, REPEAT. + + + + + CDMA HIGH PBX SSL tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 1000ms OFF, REPEAT. + + + + + CDMA MED PBX SSL tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 1000ms OFF, REPEAT. + + + + + CDMA LOW PBX SSL tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 1000ms OFF, REPEAT. + + + + + CDMA HIGH PBX SLS tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 1000ms OFF, REPEAT. + + + + + CDMA MED PBX SLS tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 1000ms OFF, REPEAT. + + + + + CDMA LOW PBX SLS tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 1000ms OFF, REPEAT. + + + + + CDMA HIGH PBX X S4 tone: {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 800ms OFF, REPEAT. + + + + + CDMA MED PBX X S4 tone: {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 800ms OFF, REPEAT. + + + + + CDMA LOW PBX X S4 tone: {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 800ms OFF, REPEAT. + + + + + CDMA Alert Network Lite tone: 1109Hz 62ms ON, 784Hz 62ms ON, 740Hz 62ms ON 622Hz 62ms ON, 1109Hz 62ms ON. + + + + + CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON. + + + + + CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON. + + + + + CDMA KEYPAD Volume key lite tone: 941Hz+1477Hz 120ms ON. + + + + + CDMA PRESSHOLDKEY LITE tone: 587Hz 375ms ON, 1175Hz 125ms ON. + + + + + CDMA ALERT INCALL LITE tone: 587Hz 62ms, 784 62ms, 831Hz 62ms, 784Hz 62ms, 1109 62ms, 784Hz 62ms, 831Hz 62ms, 784Hz 62ms. + + + + + CDMA EMERGENCY RINGBACK tone: {941Hz 125ms ON, 10ms OFF} 3times 4990ms OFF, REPEAT. + + + + + CDMA ALERT CALL GUARD tone: {1319Hz 125ms ON, 125ms OFF} 3 times. + + + + + CDMA SOFT ERROR LITE tone: 1047Hz 125ms ON, 370Hz 125ms. + + + + + CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms. + + + + + CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. + + + + + CDMA_ABBR_ALERT tone: 1150Hz+770Hz 400ms ON. + + + + + CDMA_SIGNAL_OFF - silent tone. + + + + + User Defined Tone: 100Hz continuous. + + + + + User Defined Tone: 200Hz continuous. + + + + + User Defined Tone: 300Hz continuous. + + + + + Provides the ability to play a wav file. + + + + + Plays a wav file based on the specified . + + A task that represents the asynchronous operation. + A file path to play. + A . + + is null. + -or- + is null. + + An internal error occurs. + does not exists. + The format of is not supported. + has already been disposed of. + + + + Plays a wav file based on the specified . + + A task that represents the asynchronous operation. + A file path to play. + A . + A cancellation token which can be used to stop. + + is null. + -or- + is null. + + An internal error occurs. + does not exists. + The format of is not supported. + has already been disposed. + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Camera.dll b/Artifacts/bin/Tizen.Multimedia.Camera.dll index a14e9f1..63c9189 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Camera.dll and b/Artifacts/bin/Tizen.Multimedia.Camera.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Camera.pdb b/Artifacts/bin/Tizen.Multimedia.Camera.pdb index b66a086..7ed5998 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Camera.pdb and b/Artifacts/bin/Tizen.Multimedia.Camera.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Camera.xml b/Artifacts/bin/Tizen.Multimedia.Camera.xml index 31927f2..147eb15 100644 --- a/Artifacts/bin/Tizen.Multimedia.Camera.xml +++ b/Artifacts/bin/Tizen.Multimedia.Camera.xml @@ -1,2489 +1,2489 @@ - - - - Tizen.Multimedia.Camera - - - - - The camera class provides methods to capture photos and support setting up notifications - for state changes of capturing, previewing, focusing, information about resolution and binary format - and functions for picture manipulations like sepia negative and many more. - It also notifies you when a significant picture parameter changes e.g. focus. - - - - - Initializes a new instance of the Class. - - 3 - The camera device to access - - - - Destructor of the camera class. - - - - - Releases the unmanaged resources used by the Camera. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the Camera. - - 3 - - - - Event that occurs when the camera interrupt is started by policy. - - - - - Event that occurs when an camera is interrupted by policy. - - 3 - - - - Event that occurs when there is an asynchronous error. - - 3 - - - - Event that occurs when the auto focus state is changed. - - 3 - - - - Event that occurs when a face is detected in preview frame. - - 3 - - - - Event that occurs during capture of image. - - 3 - - - - Event that occurs after the capture of the image. - - 3 - - - - Event that occurs when there is change in HDR capture progress. - Check whether is supported or not before add this EventHandler. - - 3 - In case of HDR feature is not supported. - - - - Event that occurs when camera state is changed. - - 3 - - - - Event that occurs after the is changed. - - 3 - In case of any invalid operations. - In case of this feature is not supported. - In case of invalid parameters. - - - - Event that occurs once per frame when previewing. - Preview callback is registered when user add callback explicitly to avoid useless P/Invoke. - - 3 - - - - Event that occurs once per frame when previewing. - Preview callback is registered when user add callback explicitly to avoid useless P/Invoke. - - 3 - - - - Get/Set the various camera settings. - - 3 - - - - Gets the various camera capabilities. - - 3 - - - - Get/set various camera display properties. - - 3 - - - - Sets or gets the display type and handle to show preview images. - The camera must be in the state. - - 3 - - This must be set before StartPreview() method. - In Custom ROI display mode, DisplayRoiArea property must be set before calling this method. - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Gets the state of the camera. - - 3 - None, Created, Preview, Capturing, Captured - The camera already has been disposed. - - - - The hint for display reuse. - If the hint is set to true, the display will be reused when the camera device is changed with - ChangeDevice method. - - 3 - In case of invalid parameters. - Invalid state. - The camera already has been disposed. - - - - Gets the facing direction of camera module. - - 3 - A that specifies the facing direction of camera device. - The camera already has been disposed. - - - - Gets the camera device count. - - 3 - This returns 2, if the device supports primary and secondary cameras. - Otherwise 1, if the device only supports primary camera. - The camera already has been disposed. - - - - Changes the camera device. - - 3 - The hardware camera to access. - - If display reuse is set using - before stopping the preview, the display will be reused and last frame on the display - can be kept even though camera device is changed. - The camera must be in the . - - In case of invalid parameters. - In case of any invalid operations. - In case of ChangeDevice feature is not supported. - The camera already has been disposed. - - - - Gets the device state. - - 3 - The device to get state. - Returns the state of camera device - In case of invalid parameters. - In case of any invalid operations. - In case of this feature is not supported. - - - - Gets the flash state. - - 3 - The device to get state. - Returns the flash state of camera device - In case of invalid parameters. - In case of any invalid operations. - In case of this feature is not supported. - - - - Starts capturing and drawing preview frames on the screen. - The display property must be set using before using this method. - If needed set fps , preview resolution - , or preview format - before using this method. - The camera must be in the or state. - - 3 - - http://tizen.org/privilege/camera - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Stops capturing and drawing preview frames on the screen. - The camera must be in the state. - - 3 - - http://tizen.org/privilege/camera - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Starts capturing of still images. - EventHandler must be set for capturing using - and for completed using before calling this method. - The camera must be in the state. - - 3 - - http://tizen.org/privilege/camera - - - This function causes the transition of the camera state from Capturing to Captured - automatically and the corresponding EventHandlers will be invoked. - The preview should be restarted by calling method after capture is completed. - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Starts continuously capturing still images. - EventHandler must be set for capturing using - and for completed using before calling this method. - The camera must be in the state. - - 3 - - http://tizen.org/privilege/camera - - The number of still images. - The interval of the capture(milliseconds). - The cancellation token to cancel capturing. - - - If this is not supported zero shutter lag occurs. The capture resolution could be - changed to the preview resolution. This function causes the transition of the camera state - from Capturing to Captured automatically and the corresponding Eventhandlers will be invoked. - Each captured image will be delivered through Eventhandler set using event. - The preview should be restarted by calling method after capture is completed. - - In case of invalid parameters. - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Starts camera auto-focusing, asynchronously. - The camera must be in the or state. - - 3 - Continuous auto focus - - http://tizen.org/privilege/camera - - - If continuous status is true, the camera continuously tries to focus. - - In case of invalid parameters. - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Stops camera auto focusing. - The camera must be in the or state. - - 3 - - http://tizen.org/privilege/camera - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Starts face detection. - The camera must be in the state. - - 3 - - http://tizen.org/privilege/camera - - - This should be called after is started. - The Eventhandler set using invoked when the face is detected in preview frame. - Internally it starts continuous focus and focusing on the detected face. - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Stops face detection. - - 3 - - http://tizen.org/privilege/camera - - In case of any invalid operations. - In case of this feature is not supported. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - The CameraCapabilities class provides properties - to get various capability information of the camera device. - - - - - Gets the face detection feature's supported state. - true if supported, otherwise false. - - 3 - - - - Gets the media packet preview callback feature's supported state. - true if supported, otherwise false. - - 3 - - - - Gets the zero shutter lag feature's supported state. - true if supported, otherwise false. - - 3 - - - - Gets continuous capture feature's supported state. - true if supported, otherwise false. - - 3 - - - - Gets the support state of HDR capture. - true if supported, otherwise false. - - 3 - - - - Gets the support state of the anti-shake feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of the video stabilization feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of auto contrast feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of brightness feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of exposure feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of zoom feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of pan feature. - true if supported, otherwise false. - - 3 - - - - Gets the support state of tilt feature. - true if supported, otherwise false. - - 3 - - - - Retrieves all the preview resolutions supported by the camera. - - 3 - - It returns a list containing all the supported preview resolutions. - by recorder. - - The camera already has been disposed. - - - - Retrieves all the capture resolutions supported by the camera. - - 3 - - It returns a list containing all the supported capture resolutions. - - The camera already has been disposed. - - - - Retrieves all the capture formats supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the preview formats supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the fps supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the fps by resolution supported by the camera. - - 3 - The width of required preview resolution. - The height of required preview resolution. - - It returns a list containing all the supported by resolution. - - The camera already has been disposed. - - - - Retrieves all the fps by resolution supported by the camera. - - 3 - The size of required preview resolution. - - It returns a list containing all the supported by resolution. - - The camera already has been disposed. - - - - Retrieves all the auto focus modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the exposure modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the Iso level supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the theater modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the whitebalance modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the flash modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the scene modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the effect modes supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the stream rotation supported by the camera. - - 3 - - An IEnumerable containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the flips supported by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the ptz types by the camera. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - An extended EventArgs class which contains details about the captured still image. - - - - - The main image data of the captured still image. - - 3 - - - - The image data of the postview. - - 3 - - - - The image data of the thumbnail. - - 3 - - - - An extended EventArgs class which contains details about previous and current state - of the camera when its state is changed. - - - - - Camera device type. - - 3 - - - - Current state of the camera device. - - 3 - - - - The CameraDisplay class allows you to manage display for the camera. - It allows to set and get various display properties such as - rotation, display visibility and display mode. - - - - - The display mode. - - 3 - - This property is meaningful only in overlay or EVAS surface display type. - - A that specifies the display mode. - Display type is incorrect. - The camera already has been disposed. - - - - The display visibility. - True if camera display visible, otherwise false. - - 3 - - This property is meaningful only in overlay or EVAS surface display type. - - Display type is incorrect. - The camera already has been disposed. - - - - The display rotation. - - 3 - - This property is meaningful only in overlay or EVAS surface display type. - - A that specifies the rotation of camera device. - Display type is incorrect. - The camera already has been disposed. - - - - The display flip. - - 3 - - This property is meaningful only in overlay or EVAS surface display type. - - A that specifies camera flip type. - Display type is incorrect. - The camera already has been disposed. - - - - the ROI(Region Of Interest) area of display. - - 3 - - This property is meaningful only in overlay or EVAS surface display type. - - Display type is incorrect. - The camera already has been disposed. - - - - Enumeration for Camera device. - - 3 - - - - Rear Camera device. - - - - - Front Camera device. - - - - - Enumeration for Camera device state. - - 3 - - - - Not opened. - - - - - Opened. - - - - - Now previewing or capturing or is being used for video recording. - - - - - Enumeration for the facing direction of camera module . - - 3 - - - - Rear direction. - - - - - Front direction - - - - - Enumeration for the current flash state. - - 3 - - - - Flash is not used now through camera API. - - - - - Flash is used now through camera API. - - - - - Enumeration for the camera focus state. - - 3 - - - - Focus released. - - - - - Focus in progress - - - - - Focus succeeded - - - - - Focus failed. - - - - - Enumeration for the camera pixel format. - - 3 - - - - Invalid pixel format. - - - - - NV12 pixel format. - - - - - NV12 Tiled pixel format. - - - - - NV16 pixel format. - - - - - NV21 pixel format. - - - - - YUYV(YUY2) pixel format. - - - - - UYVY pixel format. - - - - - YUV422(Y:U:V) planar pixel format. - - - - - I420 pixel format. - - - - - YV12 pixel format. - - - - - RGB565 pixel format. - - - - - RGB565 pixel format. - - - - - RGBA pixel format. - - - - - ARGB pixel format. - - - - - Encoded pixel format. - - - - - Encoded pixel format : H264. - - - - - Enumeration for the camera policy. - - 3 - - - - None. - - - - - Security policy - - - - - Resource conflict - - - - - Enumeration for the camera state. - - 3 - - - - Before creating. - - - - - Created, but not initialized yet. - - - - - Preview. - - - - - While capturing. - - - - - After capturing. - - - - - Enumeration for the auto focus mode. - - 3 - - - - auto-focus is not set. - - - - - auto-focus in the normal mode. - - - - - auto-focus in the macro mode(close distance). - - - - - auto-focus in the full mode(all range scan, limited by device spec). - - - - - Enumeration for the color tone, which provides the impression of looking through a tinted glass. - - 3 - - - - None. - - - - - Mono. - - - - - Sepia. - - - - - Negative. - - - - - Blue. - - - - - Green. - - - - - Aqua. - - - - - Violet. - - - - - Orange. - - - - - Gray. - - - - - Red. - - - - - Antique. - - - - - Warm. - - - - - Pink. - - - - - Yellow. - - - - - Purple. - - - - - Emboss. - - - - - Outline. - - - - - Solarization. - - - - - Sketch. - - - - - Washed. - - - - - Vintage warm. - - - - - Vintage cold . - - - - - Posterization. - - - - - Cartoon. - - - - - Selective color - Red. - - - - - Selective color - Green. - - - - - Selective color - Blue. - - - - - Selective color - Yellow. - - - - - Selective color - Red and Yellow. - - - - - Other Graphic effects. - - - - - Enumeration for the camera exposure modes. - - 3 - - - - Off. - - - - - All mode. - - - - - Center mode. - - - - - Spot mode. - - - - - Custom mode. - - - - - Enumeration for the flash mode. - - 3 - - - - Always off. - - - - - Always splashes. - - - - - Depending on intensity of light, strobe starts to flash. - - - - - Red eye reduction. Multiple flash before capturing. - - - - - Slow sync curtain synchronization. - - - - - Front curtain synchronization. - - - - - Rear curtain synchronization. - - - - - Keep turned on until turning off. - - - - - Enumeration for preview FPS. - - 3 - - - - Auto FPS. - - - - - 7 FPS. - - - - - 8 FPS. - - - - - 15 FPS. - - - - - 20 FPS. - - - - - 24 FPS. - - - - - 25 FPS. - - - - - 30 FPS. - - - - - 60 FPS. - - - - - 90 FPS. - - - - - 120 FPS. - - - - - Enumeration for HDR capture mode. - - 3 - - - - Disable HDR capture. - - - - - Enable HDR capture. - - - - - Enable HDR capture and keep original image data. - - - - - Enumeration for the ISO levels of the camera. - - 3 - - - - ISO auto mode. - - - - - ISO 50. - - - - - ISO 100. - - - - - ISO 200. - - - - - ISO 400. - - - - - ISO 800. - - - - - ISO 1600. - - - - - ISO 3200. - - - - - Enumeration for PTZ(Pan Tilt Zoom) movement type. - - 3 - - - - Move to a specific coordinate position. - - - - - Move a specific distance from the current position. - - - - - Enumeration for PTZ(Pan Tilt Zoom) type. - - 3 - - - - Move the camera device physically. - - - - - Zoom digitally and move into portion of the image. - - - - - Enumeration for the camera scene mode. - - 3 - - - - Normal. - - - - - Portrait. - - - - - Landscape. - - - - - Sports. - - - - - Party & Indoor. - - - - - Beach & Indoor. - - - - - Sunset. - - - - - Dusk & Dawn. - - - - - Fall. - - - - - Night scene. - - - - - Firework. - - - - - Text. - - - - - Show window. - - - - - Candle light. - - - - - Backlight. - - - - - Aqua. - - - - - Enumeration for the orientation values of tag. - - 3 - - - - Row #0 is at the top, Column #0 is to the left. - - - - - Row #0 is at the top, Column #0 is to the right. - - - - - Row #0 is at the bottom, Column #0 is to the right. - - - - - Row #0 is at the bottom, Column #0 is to the left. - - - - - Row #0 is at the left, Column #0 is to the top. - - - - - Row #0 is at the right, Column #0 is to the top. - - - - - Row #0 is at the right, Column #0 is to the bottom. - - - - - Row #0 is at the left, Column #0 is to the bottom. - - - - - Enumeration for the theater mode. - - 3 - - - - Disable theater mode - External display shows same image as device display. - - - - - Clone mode - Preview image is displayed on external display with full screen mode. Also preview image is shown by the UI on device display. - - - - - Enable theater mode - Preview image is displayed on external display with full screen mode, but preview image is not shown on device display. - - - - - Enumeration for the white balance levels of the camera. - - 3 - - - - None. - - - - - Automatic. - - - - - Daylight. - - - - - Cloudy. - - - - - Fluorescent. - - - - - Incandescent. - - - - - Shade. - - - - - Horizon. - - - - - Flash. - - - - - Custom. - - - - - Enumeration for the camera display mode. - - 3 - - - - Letter box. - - - - - Origin size. - - - - - Full screen. - - - - - Cropped full screen. - - - - - Original size or letter box. - - - - - Custom ROI. - - - - - Enumeration for camera failure error. - - 3 - - - - Device Error. - - - - - Internal error. - - - - - Out of memory. - - - - - Service is disconnected. - - - - - Enumeration for Image datatype. - - 3 - - - - Single plane data. - - - - - Double plane data. - - - - - Triple plane data. - - - - - Encoded plane data. - - - - - An extended EventArgs class which contains details about error status and - state of the camera when it failed. - - - - - The camera error code. - - 3 - - - - The state of the camera. - - 3 - - - - An extended EventArgs class which contains details about focus state of the - camera. - - - - - Focus state of the camera. - - 3 - - - - An extended EventArgs class which contains details about previous and current state - of the camera when its interrupted. - - - - - Previous state of the camera. - - 3 - - - - Current state of the camera. - - 3 - - - - The policy that interrupted the camera. - - 3 - - - - An extended EventArgs class which contains details about current state - of the camera when interrupt is invoked internally in Native FW. - - - - - Current state of the camera. - - - - - The policy that interrupted the camera. - - - - - The camera setting class provides methods/properties to get and - set basic camera attributes. - - - - - Sets auto focus area. - - 3 - - should not be the . - - X position - Y position - In case of invalid parameters. - In case of any invalid operations. - The camera already has been disposed. - - - - Sets auto focus area. - - 3 - - should not be the . - - structure including X, Y position - In case of invalid parameters. - In case of any invalid operations. - The camera already has been disposed. - - - - Clears the auto focus area. - - 3 - The camera already has been disposed. - - - - The auto focus mode. - - 3 - A that specifies the auto focus mode. - The camera already has been disposed. - - - - The contrast level of the camera. - - 3 - The camera already has been disposed. - - - - The auto contrast. - If true auto contrast is enabled, otherwise false. - - 3 - The camera already has been disposed. - - - - Gets the available contrast level. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - The brightness level of the camera. - - 3 - The camera already has been disposed. - - - - Gets the available brightness level. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - The exposure value. - - 3 - The camera already has been disposed. - - - - The exposure mode. - - 3 - A that specifies the exposure mode. - The camera already has been disposed. - - - - Gets the available exposure value. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - The zoom level. - The range for zoom level is received from ZoomRange property. - - 3 - The camera already has been disposed. - - - - Gets the available zoom level. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - The whitebalance mode. - - 3 - A that specifies the white balance mode. - The camera already has been disposed. - - - - The ISO level. - - 3 - A that specifies ISO level. - The camera already has been disposed. - - - - The quality of the image. - The range for image quality is 1 to 100. - - 3 - The camera already has been disposed. - - - - The preview frame rate. - - 3 - A that specifies preview frame rate. - The camera already has been disposed. - - - - Gets or sets the resolution of preview - - 3 - In case of invalid parameters. - The camera already has been disposed. - - - - Gets the recommended preview resolution. - - 3 - - Depending on the capture resolution aspect ratio and display resolution, - the recommended preview resolution is determined. - - The camera already has been disposed. - - - - The preview data format. - - 3 - A that specifies the pixel format of preview data. - In case of invalid parameters. - The camera already has been disposed. - - - - Resolution of the captured image. - - 3 - In case of invalid parameters - The camera already has been disposed. - - - - Format of an image to be captured. - - 3 - A that specifies the pixel format of captured image. - In case of invalid parameters. - The camera already has been disposed. - - - - The bit rate of encoded preview. - - 3 - The camera already has been disposed. - - - - GOP(Group Of Pictures) interval of encoded preview. - - 3 - The camera already has been disposed. - - - - The theater mode. - - 3 - A that specifies theater mode. - - If you want to display the preview image on the external display with the full screen mode, - use this property. - - The camera already has been disposed. - - - - The camera effect mode. - - 3 - A that specifies effect mode. - The camera already has been disposed. - - - - The scene mode. - - 3 - A that specifies scene mode. - The camera already has been disposed. - - - - The camera's flash mode. - - 3 - A that specifies flash mode. - The camera already has been disposed. - - - - Gets the camera lens orientation angle. - - 3 - The camera already has been disposed. - - - - The stream rotation. - - 3 - A that specifies the rotation of camera device. - The camera already has been disposed. - - - - The stream flip. - - 3 - A that specifies camera flip type. - The camera already has been disposed. - - - - The mode of HDR(High dynamic range) capture. - - 3 - A that specifies the HDR mode. - - Taking multiple pictures at different exposure levels and intelligently stitching them together - so that we eventually arrive at a picture that is representative in both dark and bright areas. - If this attribute is set, then eventhandler set for HdrCaptureProgress event is invoked. - - The camera already has been disposed. - - - - The anti shake feature. - If true the antishake feature is enabled, otherwise false. - - 3 - The camera already has been disposed. - - - - Enables/Disables the video stabilization feature. - If true video stabilization is enabled, otherwise false. - - 3 - - If video stabilization is enabled, zero shutter lag is disabled. - This feature is used to record a video. - - The camera already has been disposed. - - - - Turn the shutter sound on or off, if it is permitted by policy. - - 3 - Shutter sound On/Off flag - - If this value is true, shutter sound will be disabled, otherwise enabled. - In some countries, this operation is not permitted. - - Disabling shutter sound is not permitted. - The camera already has been disposed. - - - - Sets the type of PTZ(Pan Tilt Zoom). Mechanical or Electronic. - - 3 - A that specifies the type of PTZ. - The camera already has been disposed. - - - - Sets the position to move horizontally. - - 3 - ptz move type. - pan step - In case of invalid parameters. - The camera already has been disposed. - - - - Gets the current position of the camera. - - 3 - Returns the camera's horizontal position - The camera already has been disposed. - - - - Sets the position to move vertically. - - 3 - ptz move type - tilt step - In case of invalid parameters. - The camera already has been disposed. - - - - Gets the current position of the camera. - - 3 - Returns the current vertical position - The camera already has been disposed. - - - - Gets lower limit and upper limit for pan position. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - Gets lower limit and upper limit for tilt position. - - 3 - - If min value is greater than the max value, it means this feature is not supported. - - In case of this feature is not supported. - - - - The scene mode. - true if EXIF tags are enabled in JPEG file, otherwise false. - - 3 - The camera already has been disposed. - - - - The camera image description in the EXIF tag. - - 3 - The camera already has been disposed. - - - - The software information in the EXIF tag. - - 3 - The camera already has been disposed. - - - - The geotag(GPS data) in the EXIF tag. - - 3 - The camera already has been disposed. - - - - Removes the geotag(GPS data) in the EXIF(Exchangeable image file format) tag. - - 3 - The camera already has been disposed. - - - - The camera orientation in the tag. - - 3 - The camera already has been disposed. - - - - An extended EventArgs class which contains details about previous and current state - of the camera when its state is changed. - - - - - Previous state of the camera. - - 3 - - - - Current state of the camera. - - 3 - - - - true if the state changed by policy such as Resource Conflict or Security, otherwise false - in normal state change. - - 3 - - - - The class containing image data which has two planes. - - - - - The Y plane data. - - 3 - - - - The UV plane data. - - 3 - - - - The class containing Encoded image data. - - - - - The buffer containing encoded image data. - - 3 - - - - An extended EventArgs class which contains details about all the faces detected. - If user need to remain faces data, user have to copy the data. - - - - - List containing faces of type . - - 3 - - - - The class contains the details of the detected face. - - - - - The Id of each face. - - 3 - - - - The confidence level for the detection of the face. - - 3 - - - - The X co-ordinate of the face. - - 3 - - - - The Y co-ordinate of the face. - - 3 - - - - The width of the face. - - 3 - - - - The height of the face. - - 3 - - - - An extended EventArgs class which contains details about the hdr capture progress. - - - - - Hdr Capture progress in percent. - - 3 - - - - Location class containing GPS data details. - - - - - Public constructor. - - Latitude data - Longitude data - Altitude data - - - - The Latitude data. - - 3 - - - - The Longitude data. - - 3 - - - - The Altitude data. - - 3 - - - - An extended EventArgs class which contains details about the Media packet preview frame. - - - - - Media Packet data. - - 3 - - - - An extended EventArgs class which contains details about the preview frame. - - - - - PreviewData frame. - - 3 - - - - The class containing preview image data. - - - - - The pixel format of the image. - - 3 - - - - The resolution of the preview image. - - 3 - - - - The timestamp of preview frame. - - 3 - - - - The type of preview plane. - - 3 - - - - The buffer including preview frame. - - 3 - - - - The class containing image data which has single plane. - - - - - The YUV plane data. - - 3 - - - - The class containing the captured still image. - - - - - The pixel format of the still image. - - 3 - - - - The resolution of the still image. - - 3 - - - - The buffer containing still image. - - 3 - - - - The Exif data describing additional metadata of still image. - Please refer Exif specification for more details. - - 3 - - - - The class containing image data which has three planes. - - - - - The Y plane data. - - 3 - - - - The U plane data. - - 3 - - - - The V plane data. - - 3 - - - + + + + Tizen.Multimedia.Camera + + + + + The camera class provides methods to capture photos and support setting up notifications + for state changes of capturing, previewing, focusing, information about resolution and binary format + and functions for picture manipulations like sepia negative and many more. + It also notifies you when a significant picture parameter changes e.g. focus. + + + + + Initializes a new instance of the Class. + + 3 + The camera device to access + + + + Destructor of the camera class. + + + + + Releases the unmanaged resources used by the Camera. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the Camera. + + 3 + + + + Event that occurs when the camera interrupt is started by policy. + + + + + Event that occurs when an camera is interrupted by policy. + + 3 + + + + Event that occurs when there is an asynchronous error. + + 3 + + + + Event that occurs when the auto focus state is changed. + + 3 + + + + Event that occurs when a face is detected in preview frame. + + 3 + + + + Event that occurs during capture of image. + + 3 + + + + Event that occurs after the capture of the image. + + 3 + + + + Event that occurs when there is change in HDR capture progress. + Check whether is supported or not before add this EventHandler. + + 3 + In case of HDR feature is not supported. + + + + Event that occurs when camera state is changed. + + 3 + + + + Event that occurs after the is changed. + + 3 + In case of any invalid operations. + In case of this feature is not supported. + In case of invalid parameters. + + + + Event that occurs once per frame when previewing. + Preview callback is registered when user add callback explicitly to avoid useless P/Invoke. + + 3 + + + + Event that occurs once per frame when previewing. + Preview callback is registered when user add callback explicitly to avoid useless P/Invoke. + + 3 + + + + Get/Set the various camera settings. + + 3 + + + + Gets the various camera capabilities. + + 3 + + + + Get/set various camera display properties. + + 3 + + + + Sets or gets the display type and handle to show preview images. + The camera must be in the state. + + 3 + + This must be set before StartPreview() method. + In Custom ROI display mode, DisplayRoiArea property must be set before calling this method. + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Gets the state of the camera. + + 3 + None, Created, Preview, Capturing, Captured + The camera already has been disposed. + + + + The hint for display reuse. + If the hint is set to true, the display will be reused when the camera device is changed with + ChangeDevice method. + + 3 + In case of invalid parameters. + Invalid state. + The camera already has been disposed. + + + + Gets the facing direction of camera module. + + 3 + A that specifies the facing direction of camera device. + The camera already has been disposed. + + + + Gets the camera device count. + + 3 + This returns 2, if the device supports primary and secondary cameras. + Otherwise 1, if the device only supports primary camera. + The camera already has been disposed. + + + + Changes the camera device. + + 3 + The hardware camera to access. + + If display reuse is set using + before stopping the preview, the display will be reused and last frame on the display + can be kept even though camera device is changed. + The camera must be in the . + + In case of invalid parameters. + In case of any invalid operations. + In case of ChangeDevice feature is not supported. + The camera already has been disposed. + + + + Gets the device state. + + 3 + The device to get state. + Returns the state of camera device + In case of invalid parameters. + In case of any invalid operations. + In case of this feature is not supported. + + + + Gets the flash state. + + 3 + The device to get state. + Returns the flash state of camera device + In case of invalid parameters. + In case of any invalid operations. + In case of this feature is not supported. + + + + Starts capturing and drawing preview frames on the screen. + The display property must be set using before using this method. + If needed set fps , preview resolution + , or preview format + before using this method. + The camera must be in the or state. + + 3 + + http://tizen.org/privilege/camera + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Stops capturing and drawing preview frames on the screen. + The camera must be in the state. + + 3 + + http://tizen.org/privilege/camera + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Starts capturing of still images. + EventHandler must be set for capturing using + and for completed using before calling this method. + The camera must be in the state. + + 3 + + http://tizen.org/privilege/camera + + + This function causes the transition of the camera state from Capturing to Captured + automatically and the corresponding EventHandlers will be invoked. + The preview should be restarted by calling method after capture is completed. + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Starts continuously capturing still images. + EventHandler must be set for capturing using + and for completed using before calling this method. + The camera must be in the state. + + 3 + + http://tizen.org/privilege/camera + + The number of still images. + The interval of the capture(milliseconds). + The cancellation token to cancel capturing. + + + If this is not supported zero shutter lag occurs. The capture resolution could be + changed to the preview resolution. This function causes the transition of the camera state + from Capturing to Captured automatically and the corresponding Eventhandlers will be invoked. + Each captured image will be delivered through Eventhandler set using event. + The preview should be restarted by calling method after capture is completed. + + In case of invalid parameters. + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Starts camera auto-focusing, asynchronously. + The camera must be in the or state. + + 3 + Continuous auto focus + + http://tizen.org/privilege/camera + + + If continuous status is true, the camera continuously tries to focus. + + In case of invalid parameters. + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Stops camera auto focusing. + The camera must be in the or state. + + 3 + + http://tizen.org/privilege/camera + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Starts face detection. + The camera must be in the state. + + 3 + + http://tizen.org/privilege/camera + + + This should be called after is started. + The Eventhandler set using invoked when the face is detected in preview frame. + Internally it starts continuous focus and focusing on the detected face. + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Stops face detection. + + 3 + + http://tizen.org/privilege/camera + + In case of any invalid operations. + In case of this feature is not supported. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + The CameraCapabilities class provides properties + to get various capability information of the camera device. + + + + + Gets the face detection feature's supported state. + true if supported, otherwise false. + + 3 + + + + Gets the media packet preview callback feature's supported state. + true if supported, otherwise false. + + 3 + + + + Gets the zero shutter lag feature's supported state. + true if supported, otherwise false. + + 3 + + + + Gets continuous capture feature's supported state. + true if supported, otherwise false. + + 3 + + + + Gets the support state of HDR capture. + true if supported, otherwise false. + + 3 + + + + Gets the support state of the anti-shake feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of the video stabilization feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of auto contrast feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of brightness feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of exposure feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of zoom feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of pan feature. + true if supported, otherwise false. + + 3 + + + + Gets the support state of tilt feature. + true if supported, otherwise false. + + 3 + + + + Retrieves all the preview resolutions supported by the camera. + + 3 + + It returns a list containing all the supported preview resolutions. + by recorder. + + The camera already has been disposed. + + + + Retrieves all the capture resolutions supported by the camera. + + 3 + + It returns a list containing all the supported capture resolutions. + + The camera already has been disposed. + + + + Retrieves all the capture formats supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the preview formats supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the fps supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the fps by resolution supported by the camera. + + 3 + The width of required preview resolution. + The height of required preview resolution. + + It returns a list containing all the supported by resolution. + + The camera already has been disposed. + + + + Retrieves all the fps by resolution supported by the camera. + + 3 + The size of required preview resolution. + + It returns a list containing all the supported by resolution. + + The camera already has been disposed. + + + + Retrieves all the auto focus modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the exposure modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the Iso level supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the theater modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the whitebalance modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the flash modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the scene modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the effect modes supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the stream rotation supported by the camera. + + 3 + + An IEnumerable containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the flips supported by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the ptz types by the camera. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + An extended EventArgs class which contains details about the captured still image. + + + + + The main image data of the captured still image. + + 3 + + + + The image data of the postview. + + 3 + + + + The image data of the thumbnail. + + 3 + + + + An extended EventArgs class which contains details about previous and current state + of the camera when its state is changed. + + + + + Camera device type. + + 3 + + + + Current state of the camera device. + + 3 + + + + The CameraDisplay class allows you to manage display for the camera. + It allows to set and get various display properties such as + rotation, display visibility and display mode. + + + + + The display mode. + + 3 + + This property is meaningful only in overlay or EVAS surface display type. + + A that specifies the display mode. + Display type is incorrect. + The camera already has been disposed. + + + + The display visibility. + True if camera display visible, otherwise false. + + 3 + + This property is meaningful only in overlay or EVAS surface display type. + + Display type is incorrect. + The camera already has been disposed. + + + + The display rotation. + + 3 + + This property is meaningful only in overlay or EVAS surface display type. + + A that specifies the rotation of camera device. + Display type is incorrect. + The camera already has been disposed. + + + + The display flip. + + 3 + + This property is meaningful only in overlay or EVAS surface display type. + + A that specifies camera flip type. + Display type is incorrect. + The camera already has been disposed. + + + + the ROI(Region Of Interest) area of display. + + 3 + + This property is meaningful only in overlay or EVAS surface display type. + + Display type is incorrect. + The camera already has been disposed. + + + + Enumeration for Camera device. + + 3 + + + + Rear Camera device. + + + + + Front Camera device. + + + + + Enumeration for Camera device state. + + 3 + + + + Not opened. + + + + + Opened. + + + + + Now previewing or capturing or is being used for video recording. + + + + + Enumeration for the facing direction of camera module . + + 3 + + + + Rear direction. + + + + + Front direction + + + + + Enumeration for the current flash state. + + 3 + + + + Flash is not used now through camera API. + + + + + Flash is used now through camera API. + + + + + Enumeration for the camera focus state. + + 3 + + + + Focus released. + + + + + Focus in progress + + + + + Focus succeeded + + + + + Focus failed. + + + + + Enumeration for the camera pixel format. + + 3 + + + + Invalid pixel format. + + + + + NV12 pixel format. + + + + + NV12 Tiled pixel format. + + + + + NV16 pixel format. + + + + + NV21 pixel format. + + + + + YUYV(YUY2) pixel format. + + + + + UYVY pixel format. + + + + + YUV422(Y:U:V) planar pixel format. + + + + + I420 pixel format. + + + + + YV12 pixel format. + + + + + RGB565 pixel format. + + + + + RGB565 pixel format. + + + + + RGBA pixel format. + + + + + ARGB pixel format. + + + + + Encoded pixel format. + + + + + Encoded pixel format : H264. + + + + + Enumeration for the camera policy. + + 3 + + + + None. + + + + + Security policy + + + + + Resource conflict + + + + + Enumeration for the camera state. + + 3 + + + + Before creating. + + + + + Created, but not initialized yet. + + + + + Preview. + + + + + While capturing. + + + + + After capturing. + + + + + Enumeration for the auto focus mode. + + 3 + + + + auto-focus is not set. + + + + + auto-focus in the normal mode. + + + + + auto-focus in the macro mode(close distance). + + + + + auto-focus in the full mode(all range scan, limited by device spec). + + + + + Enumeration for the color tone, which provides the impression of looking through a tinted glass. + + 3 + + + + None. + + + + + Mono. + + + + + Sepia. + + + + + Negative. + + + + + Blue. + + + + + Green. + + + + + Aqua. + + + + + Violet. + + + + + Orange. + + + + + Gray. + + + + + Red. + + + + + Antique. + + + + + Warm. + + + + + Pink. + + + + + Yellow. + + + + + Purple. + + + + + Emboss. + + + + + Outline. + + + + + Solarization. + + + + + Sketch. + + + + + Washed. + + + + + Vintage warm. + + + + + Vintage cold . + + + + + Posterization. + + + + + Cartoon. + + + + + Selective color - Red. + + + + + Selective color - Green. + + + + + Selective color - Blue. + + + + + Selective color - Yellow. + + + + + Selective color - Red and Yellow. + + + + + Other Graphic effects. + + + + + Enumeration for the camera exposure modes. + + 3 + + + + Off. + + + + + All mode. + + + + + Center mode. + + + + + Spot mode. + + + + + Custom mode. + + + + + Enumeration for the flash mode. + + 3 + + + + Always off. + + + + + Always splashes. + + + + + Depending on intensity of light, strobe starts to flash. + + + + + Red eye reduction. Multiple flash before capturing. + + + + + Slow sync curtain synchronization. + + + + + Front curtain synchronization. + + + + + Rear curtain synchronization. + + + + + Keep turned on until turning off. + + + + + Enumeration for preview FPS. + + 3 + + + + Auto FPS. + + + + + 7 FPS. + + + + + 8 FPS. + + + + + 15 FPS. + + + + + 20 FPS. + + + + + 24 FPS. + + + + + 25 FPS. + + + + + 30 FPS. + + + + + 60 FPS. + + + + + 90 FPS. + + + + + 120 FPS. + + + + + Enumeration for HDR capture mode. + + 3 + + + + Disable HDR capture. + + + + + Enable HDR capture. + + + + + Enable HDR capture and keep original image data. + + + + + Enumeration for the ISO levels of the camera. + + 3 + + + + ISO auto mode. + + + + + ISO 50. + + + + + ISO 100. + + + + + ISO 200. + + + + + ISO 400. + + + + + ISO 800. + + + + + ISO 1600. + + + + + ISO 3200. + + + + + Enumeration for PTZ(Pan Tilt Zoom) movement type. + + 3 + + + + Move to a specific coordinate position. + + + + + Move a specific distance from the current position. + + + + + Enumeration for PTZ(Pan Tilt Zoom) type. + + 3 + + + + Move the camera device physically. + + + + + Zoom digitally and move into portion of the image. + + + + + Enumeration for the camera scene mode. + + 3 + + + + Normal. + + + + + Portrait. + + + + + Landscape. + + + + + Sports. + + + + + Party & Indoor. + + + + + Beach & Indoor. + + + + + Sunset. + + + + + Dusk & Dawn. + + + + + Fall. + + + + + Night scene. + + + + + Firework. + + + + + Text. + + + + + Show window. + + + + + Candle light. + + + + + Backlight. + + + + + Aqua. + + + + + Enumeration for the orientation values of tag. + + 3 + + + + Row #0 is at the top, Column #0 is to the left. + + + + + Row #0 is at the top, Column #0 is to the right. + + + + + Row #0 is at the bottom, Column #0 is to the right. + + + + + Row #0 is at the bottom, Column #0 is to the left. + + + + + Row #0 is at the left, Column #0 is to the top. + + + + + Row #0 is at the right, Column #0 is to the top. + + + + + Row #0 is at the right, Column #0 is to the bottom. + + + + + Row #0 is at the left, Column #0 is to the bottom. + + + + + Enumeration for the theater mode. + + 3 + + + + Disable theater mode - External display shows same image as device display. + + + + + Clone mode - Preview image is displayed on external display with full screen mode. Also preview image is shown by the UI on device display. + + + + + Enable theater mode - Preview image is displayed on external display with full screen mode, but preview image is not shown on device display. + + + + + Enumeration for the white balance levels of the camera. + + 3 + + + + None. + + + + + Automatic. + + + + + Daylight. + + + + + Cloudy. + + + + + Fluorescent. + + + + + Incandescent. + + + + + Shade. + + + + + Horizon. + + + + + Flash. + + + + + Custom. + + + + + Enumeration for the camera display mode. + + 3 + + + + Letter box. + + + + + Origin size. + + + + + Full screen. + + + + + Cropped full screen. + + + + + Original size or letter box. + + + + + Custom ROI. + + + + + Enumeration for camera failure error. + + 3 + + + + Device Error. + + + + + Internal error. + + + + + Out of memory. + + + + + Service is disconnected. + + + + + Enumeration for Image datatype. + + 3 + + + + Single plane data. + + + + + Double plane data. + + + + + Triple plane data. + + + + + Encoded plane data. + + + + + An extended EventArgs class which contains details about error status and + state of the camera when it failed. + + + + + The camera error code. + + 3 + + + + The state of the camera. + + 3 + + + + An extended EventArgs class which contains details about focus state of the + camera. + + + + + Focus state of the camera. + + 3 + + + + An extended EventArgs class which contains details about previous and current state + of the camera when its interrupted. + + + + + Previous state of the camera. + + 3 + + + + Current state of the camera. + + 3 + + + + The policy that interrupted the camera. + + 3 + + + + An extended EventArgs class which contains details about current state + of the camera when interrupt is invoked internally in Native FW. + + + + + Current state of the camera. + + + + + The policy that interrupted the camera. + + + + + The camera setting class provides methods/properties to get and + set basic camera attributes. + + + + + Sets auto focus area. + + 3 + + should not be the . + + X position + Y position + In case of invalid parameters. + In case of any invalid operations. + The camera already has been disposed. + + + + Sets auto focus area. + + 3 + + should not be the . + + structure including X, Y position + In case of invalid parameters. + In case of any invalid operations. + The camera already has been disposed. + + + + Clears the auto focus area. + + 3 + The camera already has been disposed. + + + + The auto focus mode. + + 3 + A that specifies the auto focus mode. + The camera already has been disposed. + + + + The contrast level of the camera. + + 3 + The camera already has been disposed. + + + + The auto contrast. + If true auto contrast is enabled, otherwise false. + + 3 + The camera already has been disposed. + + + + Gets the available contrast level. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + The brightness level of the camera. + + 3 + The camera already has been disposed. + + + + Gets the available brightness level. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + The exposure value. + + 3 + The camera already has been disposed. + + + + The exposure mode. + + 3 + A that specifies the exposure mode. + The camera already has been disposed. + + + + Gets the available exposure value. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + The zoom level. + The range for zoom level is received from ZoomRange property. + + 3 + The camera already has been disposed. + + + + Gets the available zoom level. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + The whitebalance mode. + + 3 + A that specifies the white balance mode. + The camera already has been disposed. + + + + The ISO level. + + 3 + A that specifies ISO level. + The camera already has been disposed. + + + + The quality of the image. + The range for image quality is 1 to 100. + + 3 + The camera already has been disposed. + + + + The preview frame rate. + + 3 + A that specifies preview frame rate. + The camera already has been disposed. + + + + Gets or sets the resolution of preview + + 3 + In case of invalid parameters. + The camera already has been disposed. + + + + Gets the recommended preview resolution. + + 3 + + Depending on the capture resolution aspect ratio and display resolution, + the recommended preview resolution is determined. + + The camera already has been disposed. + + + + The preview data format. + + 3 + A that specifies the pixel format of preview data. + In case of invalid parameters. + The camera already has been disposed. + + + + Resolution of the captured image. + + 3 + In case of invalid parameters + The camera already has been disposed. + + + + Format of an image to be captured. + + 3 + A that specifies the pixel format of captured image. + In case of invalid parameters. + The camera already has been disposed. + + + + The bit rate of encoded preview. + + 3 + The camera already has been disposed. + + + + GOP(Group Of Pictures) interval of encoded preview. + + 3 + The camera already has been disposed. + + + + The theater mode. + + 3 + A that specifies theater mode. + + If you want to display the preview image on the external display with the full screen mode, + use this property. + + The camera already has been disposed. + + + + The camera effect mode. + + 3 + A that specifies effect mode. + The camera already has been disposed. + + + + The scene mode. + + 3 + A that specifies scene mode. + The camera already has been disposed. + + + + The camera's flash mode. + + 3 + A that specifies flash mode. + The camera already has been disposed. + + + + Gets the camera lens orientation angle. + + 3 + The camera already has been disposed. + + + + The stream rotation. + + 3 + A that specifies the rotation of camera device. + The camera already has been disposed. + + + + The stream flip. + + 3 + A that specifies camera flip type. + The camera already has been disposed. + + + + The mode of HDR(High dynamic range) capture. + + 3 + A that specifies the HDR mode. + + Taking multiple pictures at different exposure levels and intelligently stitching them together + so that we eventually arrive at a picture that is representative in both dark and bright areas. + If this attribute is set, then eventhandler set for HdrCaptureProgress event is invoked. + + The camera already has been disposed. + + + + The anti shake feature. + If true the antishake feature is enabled, otherwise false. + + 3 + The camera already has been disposed. + + + + Enables/Disables the video stabilization feature. + If true video stabilization is enabled, otherwise false. + + 3 + + If video stabilization is enabled, zero shutter lag is disabled. + This feature is used to record a video. + + The camera already has been disposed. + + + + Turn the shutter sound on or off, if it is permitted by policy. + + 3 + Shutter sound On/Off flag + + If this value is true, shutter sound will be disabled, otherwise enabled. + In some countries, this operation is not permitted. + + Disabling shutter sound is not permitted. + The camera already has been disposed. + + + + Sets the type of PTZ(Pan Tilt Zoom). Mechanical or Electronic. + + 3 + A that specifies the type of PTZ. + The camera already has been disposed. + + + + Sets the position to move horizontally. + + 3 + ptz move type. + pan step + In case of invalid parameters. + The camera already has been disposed. + + + + Gets the current position of the camera. + + 3 + Returns the camera's horizontal position + The camera already has been disposed. + + + + Sets the position to move vertically. + + 3 + ptz move type + tilt step + In case of invalid parameters. + The camera already has been disposed. + + + + Gets the current position of the camera. + + 3 + Returns the current vertical position + The camera already has been disposed. + + + + Gets lower limit and upper limit for pan position. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + Gets lower limit and upper limit for tilt position. + + 3 + + If min value is greater than the max value, it means this feature is not supported. + + In case of this feature is not supported. + + + + The scene mode. + true if EXIF tags are enabled in JPEG file, otherwise false. + + 3 + The camera already has been disposed. + + + + The camera image description in the EXIF tag. + + 3 + The camera already has been disposed. + + + + The software information in the EXIF tag. + + 3 + The camera already has been disposed. + + + + The geotag(GPS data) in the EXIF tag. + + 3 + The camera already has been disposed. + + + + Removes the geotag(GPS data) in the EXIF(Exchangeable image file format) tag. + + 3 + The camera already has been disposed. + + + + The camera orientation in the tag. + + 3 + The camera already has been disposed. + + + + An extended EventArgs class which contains details about previous and current state + of the camera when its state is changed. + + + + + Previous state of the camera. + + 3 + + + + Current state of the camera. + + 3 + + + + true if the state changed by policy such as Resource Conflict or Security, otherwise false + in normal state change. + + 3 + + + + The class containing image data which has two planes. + + + + + The Y plane data. + + 3 + + + + The UV plane data. + + 3 + + + + The class containing Encoded image data. + + + + + The buffer containing encoded image data. + + 3 + + + + An extended EventArgs class which contains details about all the faces detected. + If user need to remain faces data, user have to copy the data. + + + + + List containing faces of type . + + 3 + + + + The class contains the details of the detected face. + + + + + The Id of each face. + + 3 + + + + The confidence level for the detection of the face. + + 3 + + + + The X co-ordinate of the face. + + 3 + + + + The Y co-ordinate of the face. + + 3 + + + + The width of the face. + + 3 + + + + The height of the face. + + 3 + + + + An extended EventArgs class which contains details about the hdr capture progress. + + + + + Hdr Capture progress in percent. + + 3 + + + + Location class containing GPS data details. + + + + + Public constructor. + + Latitude data + Longitude data + Altitude data + + + + The Latitude data. + + 3 + + + + The Longitude data. + + 3 + + + + The Altitude data. + + 3 + + + + An extended EventArgs class which contains details about the Media packet preview frame. + + + + + Media Packet data. + + 3 + + + + An extended EventArgs class which contains details about the preview frame. + + + + + PreviewData frame. + + 3 + + + + The class containing preview image data. + + + + + The pixel format of the image. + + 3 + + + + The resolution of the preview image. + + 3 + + + + The timestamp of preview frame. + + 3 + + + + The type of preview plane. + + 3 + + + + The buffer including preview frame. + + 3 + + + + The class containing image data which has single plane. + + + + + The YUV plane data. + + 3 + + + + The class containing the captured still image. + + + + + The pixel format of the still image. + + 3 + + + + The resolution of the still image. + + 3 + + + + The buffer containing still image. + + 3 + + + + The Exif data describing additional metadata of still image. + Please refer Exif specification for more details. + + 3 + + + + The class containing image data which has three planes. + + + + + The Y plane data. + + 3 + + + + The U plane data. + + 3 + + + + The V plane data. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Multimedia.MediaCodec.dll b/Artifacts/bin/Tizen.Multimedia.MediaCodec.dll index 03a0c58..30eeffe 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.MediaCodec.dll and b/Artifacts/bin/Tizen.Multimedia.MediaCodec.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.MediaCodec.pdb b/Artifacts/bin/Tizen.Multimedia.MediaCodec.pdb index f0121cb..3d960d8 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.MediaCodec.pdb and b/Artifacts/bin/Tizen.Multimedia.MediaCodec.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.MediaCodec.xml b/Artifacts/bin/Tizen.Multimedia.MediaCodec.xml index d2c3f4f..31712c4 100644 --- a/Artifacts/bin/Tizen.Multimedia.MediaCodec.xml +++ b/Artifacts/bin/Tizen.Multimedia.MediaCodec.xml @@ -1,217 +1,217 @@ - - - - Tizen.Multimedia.MediaCodec - - - - - Provides data for the event. - - - - - Initializes a new instance of the BufferStatusChangedEventArgs class. - - The value representing new status of the codec. - - - - Gets the value indicating new status of the codec. - - - - - Provides data for the event. - - - - - Initializes a new instance of the InputProcessedEventArgs class. - - The packet that the codec has processed. - - - - Gets the packet that the codec has processed. - - - - - Provides the means to encode and decode video and audio data. - - - - - Initialize a new instance of the MediaCodec class. - - - - - Validates if the object already has been disposed of. - - The current object has been disposed of. - - - - Gets the audio codec list that the current device supports. - - - - - Gets the audio codec list that the current device supports. - - - - - Prepares the MediaCodec for encoding or decoding. - - - The codec is not configured, yet.\n - -or-\n - Internal error. - - - - - Unprepares the MediaCodec. - - - - - Configures the MediaCodec. - - The for properties of media data to decode or encode. - The value indicating whether the codec works as a encoder or a decoder. - The value indicating whether the codec uses hardware acceleration. - format is null - - is invalid.\n - -or-\n - is neither audio type nor video type. - - the mime type of the format is not supported. - - - - - - Adds the packet to the internal queue of the codec. - - The packet to be encoded or decoded. - packet is null. - the current codec is not prepared, yet. - Any attempts to modify the packet will be failed until the event for the packet is invoked. - - - - Flushes both input and output buffers. - - - - - Retrieves supported codec types for the specified params. - - The value indicating encoder or decoder. - The mime type to query. - The values indicating which codec types are supported on the current device. - type is invalid. - - - - Retrieves supported codec types for the specified params. - - The value indicating encoder or decoder. - The mime type to query. - The values indicating which codec types are supported on the current device. - type is invalid. - - - - Occurs when an output buffer is available. - - The output packet needs to be disposed after it is used to clean up unmanaged resources. - - - - Occurs when an input packet is processed. - - - - - - Occurs whenever an error is produced in the codec. - - - - - Occurs when the codec processes all input data. - - - - - Occurs when the codec needs more data or has enough data. - - - - - Provides data for the event. - - - - - Initializes a new instance of the ErrorOccurredEventArgs class. - - The value representing the type of the error. - - - - Gets the value indicating what kind of the error. - - - - - Specifies the status of a codec. - - - - - Not enough data to decode or encode. - - - - - Enough data to decode or encode. - - - - - Specifies types of codec. - - This enumeration has a attribute that allows a bitwise combination of its member values. - - - - - - The hardware-accelerated codec. - - - - - The software codec. - - - - - Provides data for the event. - - The output packet needs to be disposed after it is used to clean up unmanaged resources. - - - - Gets the result packet. - - - - + + + + Tizen.Multimedia.MediaCodec + + + + + Provides data for the event. + + + + + Initializes a new instance of the BufferStatusChangedEventArgs class. + + The value representing new status of the codec. + + + + Gets the value indicating new status of the codec. + + + + + Provides data for the event. + + + + + Initializes a new instance of the InputProcessedEventArgs class. + + The packet that the codec has processed. + + + + Gets the packet that the codec has processed. + + + + + Provides the means to encode and decode video and audio data. + + + + + Initialize a new instance of the MediaCodec class. + + + + + Validates if the object already has been disposed of. + + The current object has been disposed of. + + + + Gets the audio codec list that the current device supports. + + + + + Gets the audio codec list that the current device supports. + + + + + Prepares the MediaCodec for encoding or decoding. + + + The codec is not configured, yet.\n + -or-\n + Internal error. + + + + + Unprepares the MediaCodec. + + + + + Configures the MediaCodec. + + The for properties of media data to decode or encode. + The value indicating whether the codec works as a encoder or a decoder. + The value indicating whether the codec uses hardware acceleration. + format is null + + is invalid.\n + -or-\n + is neither audio type nor video type. + + the mime type of the format is not supported. + + + + + + Adds the packet to the internal queue of the codec. + + The packet to be encoded or decoded. + packet is null. + the current codec is not prepared, yet. + Any attempts to modify the packet will be failed until the event for the packet is invoked. + + + + Flushes both input and output buffers. + + + + + Retrieves supported codec types for the specified params. + + The value indicating encoder or decoder. + The mime type to query. + The values indicating which codec types are supported on the current device. + type is invalid. + + + + Retrieves supported codec types for the specified params. + + The value indicating encoder or decoder. + The mime type to query. + The values indicating which codec types are supported on the current device. + type is invalid. + + + + Occurs when an output buffer is available. + + The output packet needs to be disposed after it is used to clean up unmanaged resources. + + + + Occurs when an input packet is processed. + + + + + + Occurs whenever an error is produced in the codec. + + + + + Occurs when the codec processes all input data. + + + + + Occurs when the codec needs more data or has enough data. + + + + + Provides data for the event. + + + + + Initializes a new instance of the ErrorOccurredEventArgs class. + + The value representing the type of the error. + + + + Gets the value indicating what kind of the error. + + + + + Specifies the status of a codec. + + + + + Not enough data to decode or encode. + + + + + Enough data to decode or encode. + + + + + Specifies types of codec. + + This enumeration has a attribute that allows a bitwise combination of its member values. + + + + + + The hardware-accelerated codec. + + + + + The software codec. + + + + + Provides data for the event. + + The output packet needs to be disposed after it is used to clean up unmanaged resources. + + + + Gets the result packet. + + + + diff --git a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.dll b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.dll index 5b89832..ace35e4 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.dll and b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.pdb b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.pdb index 56aec89..f8d4894 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.pdb and b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.xml b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.xml index 1d79339..f9cb54f 100644 --- a/Artifacts/bin/Tizen.Multimedia.MediaPlayer.xml +++ b/Artifacts/bin/Tizen.Multimedia.MediaPlayer.xml @@ -1,1457 +1,1457 @@ - - - - Tizen.Multimedia.MediaPlayer - - - - - Provides the ability to control the audio effects for . - - - - - Gets a at the specified index. - - The index of the band to get. - The has already been disposed of. - - index is less than zero.\n - -or-\n - index is equal to or greater than . - - - - - Clears the equalizer effect. - - The has already been disposed of. - - - - Get the number of items. - - - - - Get the band level range of the bands in dB. - - - - - Gets the value whether the AudioEffect is available or not. - - - - - Gets the player that this AudioEffect belongs to. - - - - - Provides data for the event. - - - - - Initializes a new instance of the BufferingProgressChangedEventArgs class. - - The value indicating the buffering percentage. - - - - Gets the value indicating the buffering percentage. - - The percentage of the buffering. - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Represents data for a video frame captured. - - - - - Gets the raw buffer of the captured image. - - The color space format is RGB888. - - - - Gets the size. - - - - - Represents data for a downloading status. - - - - - Initializes a new instance of the DownloadProgress struct. - - The position that downloading started in percentage. - The position indicating the current downloading progress in percentage. - - - - Gets or sets the start position. - - The position that downloading started in percentage. - - - - Gets or sets the current position. - - The position indicating the current downloading progress in percentage. - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Represents a equalizer band of . - - - - - Sets or gets the gain for the equalizer band. - - The value indicating new gain in decibel(dB). - The player that this EqualizerBand belongs to has already been disposed of. - - is not inside of . - - - - - Gets the frequency in dB. - - - - - Gets the frequency range in dB. - - - - - Represents a media source using memory. - - - The buffer has to be filled with appropriate data which means it must be well-formatted. - If you provide invalid data, you won't receive an error until is called. - - - - - - Initialize a new instance of the MediaBufferSource class with an allocated buffer. - - The value indicating the size of the buffer. - - is zero.\n - -or-\n - is less than zero. - - - - - Initialize a new instance of the MediaBufferSource class from the buffer. - - The source array to be copied into the buffer. - buffer is null. - - - - Initialize a new instance of the MediaBufferSource class from the buffer - with the specified length and the specified offset. - - The source array to be copied into the buffer. - The value indicating the number of bytes to copy from the buffer. - The value indicating the offset in the buffer of the first byte to copy. - buffer is null. - - is less than zero.\n - -or-\n - is equal to or less than zero.\n - -or-\n - + is greater than buffer.Length. - - - - - Create a MediaBufferSource that wraps a byte array. - - The array to be wrapped. - A MediaBufferSource wrapping the byte array. - - - - Gets the byte array of this buffer. - - - - - MediaSource is a base class for sources. - - - - - Provides data for the event. - - - - - Initializes a new instance of the MediaStreamBufferStatusChangedEventArgs class. - - The value indicating the status of the stream. - - - - Gets the status. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides a means to configure properties and handle events for . - - - - - - Occurs when the buffer underrun or overflow. - - The event handler will be executed on an internal thread. - - - - - - Occurs when the seeking is requested. - - The event handler will be executed on an internal thread. - - - - Gets the max size of the buffer. - - The max size of the buffer. The default is 200000. - If the buffer level over the max size, will be raised with . - The is not assigned to a player. - value is zero. - - - - - Gets the min threshold of the buffer or zero if the is not assigned to a player. - - The minimum threshold of the buffer in percentage. The default is zero. - If the buffer level drops below the threshold value, will be raised with . - The is not assigned to a player. - value is greater than 100. - - - - - Provides data for the event. - - - - - Initializes a new instance of the MediaStreamSeekingOccurredEventArgs class. - - The value indicating the new position to seek. - - - - Gets the offset. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides the ability to push packets as the source of - - The source must be set as a source to a player before pushing. - - - - - Gets all supported audio types. - - - - - Gets all supported video types. - - - - - Initialize a new instance of the MediaStreamSource class - with the specified and . - - The for this source. - The for this source. - AAC and H.264 are supported. - Both and are null. - - is not supported.\n - -or-\n - is not supported.\n - - - - - - - Initialize a new instance of the MediaStreamSource class with the specified . - - The for this source. - AAC is supported. - is null. - is not supported. - - - - - Initialize a new instance of the MediaStreamSource class with the specified . - - H.264 can is supported. - The for this source. - is null. - is not supported. - - - - - Gets the audio configuration or null if no AudioMediaFormat is specified in the constructor. - - - - - Gets the video configuration or null if no VideoMediaFormat is specified in the constructor. - - - - - Pushes elementary stream to decode audio or video. - - This source must be set as a source to a player and the player must be in the , or state. - The to decode. - - This source is not set as a source to a player.\n - -or-\n - The player is not in the valid state. - - packet is null. - packet has been disposed. - - is neither video nor audio type.\n - -or-\n - The format of packet is not matched with the specified format in the constructor. - - the internal buffer reaches limits. - - - - - - - Gets the that this source is assigned to as a source or null if this source is not assigned. - - - - - - Represents a media source with a uri. - - - The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. - The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. - The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. - - - - - - Initializes a new instance of the MediaUriSource class with the specified uri. - The uri string. - For HTTP or RSTP, uri should start with "http://" or "rtsp://". - The default protocol is "file://". - If you provide an invalid uri, you won't receive an error until is called. - - - - Gets the uri. - - - - - Provides data for the event. - - - - - Initializes a new instance of the PlaybackInterruptedEventArgs class. - - The enum value indicating the reason. - - - - Gets the reason. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides the ability to control media playback. - - - The Player provides functions to play a media content. - It also provides functions to adjust the configurations of the player such as playback rate, volume, looping etc. - Note that only one video player can be played at one time. - - - - - Initialize a new instance of the Player class. - - - - - Releases all resources used by the current instance. - - - - - Gets the streaming download Progress. - - The containing current download progress. - The player must be in the or state. - - The player is not streaming.\n - -or-\n - The player is not in the valid state. - - The player has already been disposed of. - - - - Sets the subtitle path for playback. - - Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. - The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any files are used to play located in the internal storage. - The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any files are used to play located in the external storage. - - The player has already been disposed of. - is an empty string. - The specified path does not exist. - The path is null. - - - - Removes the subtitle path. - - The player must be in the state. - The player has already been disposed of. - The player is not in the valid state. - - - - Sets the offset for the subtitle. - - The value indicating a desired offset in milliseconds. - The player must be in the or state. - The player has already been disposed of. - - The player is not in the valid state.\n - -or-\n - No subtitle is set. - - - - - - Called when the is invoked. - - - - - Prepares the media player for playback, asynchronously. - - A task that represents the asynchronous prepare operation. - To prepare the player, the player must be in the state, - and a source must be set. - No source is set. - The player has already been disposed of. - The player is not in the valid state. - - - - Unprepares the player. - - - The most recently used source is reset and no longer associated with the player. Playback is no longer possible. - If you want to use the player again, you have to set a source and call again. - - The player must be in the , or state. - It has no effect if the player is already in the state. - - - The player has already been disposed of. - The player is not in the valid state. - - - - Called after the is unprepared. - - - - - - Starts or resumes playback. - - - The player must be in the or state. - It has no effect if the player is already in the state.\n - \n - Sound can be mixed with other sounds if you don't control the stream focus using . - - The player has already been disposed of. - The player is not in the valid state. - - - - - - - - - Stops playing media content. - - - The player must be in the or state. - It has no effect if the player is already in the state. - - The player has already been disposed of. - The player is not in the valid state. - - - - - - Pauses the player. - - - The player must be in the state. - It has no effect if the player is already in the state. - - The player has already been disposed of. - The player is not in the valid state. - - - - - Sets a media source for the player. - - A that specifies the source for playback. - The player must be in the state. - The player has already been disposed of. - - The player is not in the valid state.\n - -or-\n - It is not able to assign the source to the player. - - - - - - Captures a video frame asynchronously. - - A task that represents the asynchronous capture operation. - http://tizen.org/feature/multimedia.raw_video - The player must be in the or state. - The player has already been disposed of. - The player is not in the valid state. - The required feature is not supported. - - - - Gets the play position in milliseconds. - - The player must be in the , or state. - The player has already been disposed of. - The player is not in the valid state. - - - - - Sets the seek position for playback, asynchronously. - - The value indicating a desired position in milliseconds. - The value indicating whether the operation performs with accuracy. - - The player must be in the , or state. - If the is true, the play position will be adjusted as the specified value, - but this might be considerably slow. If false, the play position will be a nearest keyframe position. - - The player has already been disposed of. - The player is not in the valid state. - The specified position is not valid. - - - - - Sets playback rate. - - The value for the playback rate. Valid range is -5.0 to 5.0, inclusive. - - The player must be in the , or state. - The sound will be muted, when the playback rate is under 0.0 or over 2.0. - - The player has already been disposed of. - - The player is not in the valid state.\n - -or-\n - Streaming playback. - - - is less than 5.0.\n - -or-\n - is greater than 5.0.\n - -or-\n - is zero. - - - - - Applies the audio stream policy. - - The to apply. - - The player must be in the state.\n - \n - does not support all .\n - Supported types are , , - , , - , , - and . - - - The player has already been disposed of.\n - -or-\n - has already been disposed of. - - The player is not in the valid state. - is null. - - of is not supported by . - - - - - - This method supports the product infrastructure and is not intended to be used directly from application code. - - - - - Occurs when playback of a media is finished. - - - - - Occurs when playback of a media is interrupted. - - - - - Occurs when any error occurs. - - The event handler will be executed on an internal thread. - - - - Occurs when the video stream changed. - - The event handler will be executed on an internal thread. - - - - Occurs when the subtitle is updated. - - The event handler will be executed on an internal thread. - - - - Occurs when there is a change in the buffering status of streaming. - - - - - Occurs when a video frame is decoded. - - - The event handler will be executed on an internal thread. - The in event args should be disposed after use. - - http://tizen.org/feature/multimedia.raw_video - The required feature is not supported. - - - - - Gets the native handle of the player. - - An IntPtr that contains the native handle of the player. - The player has already been disposed of. - - - - Gets or Sets the cookie for streaming playback. - - To set, the player must be in the state. - The player is not in the valid state. - The player has already been disposed of. - The value to set is null. - - - - Gets or Sets the user agent for streaming playback. - - To set, the player must be in the state. - The player is not in the valid state. - The player has already been disposed of. - The value to set is null. - - - - Gets the state of the player. - - The current state of the player. - The player has already been disposed of. - - - - Gets or sets the audio latency mode. - - A that specifies the mode. The default is . - - If the mode is , - audio output interval can be increased so, it can keep more audio data to play. - But, state transition like pause or resume can be more slower than default(). - - The player has already been disposed of. - The value is not valid. - - - - Gets or sets the looping state. - - true if the playback is looping; otherwise, false. The default value is false. - The player has already been disposed of. - - - - Gets the display settings. - - A that specifies the display settings. - - - - Gets or sets the display. - - A that specifies the display. - The player must be in the state. - The player has already been disposed of. - The value has already been assigned to another player. - The player is not in the valid state. - - - - Gets the track info for audio. - - A for audio. - - - - Gets the track info for subtitle. - - A for subtitle. - - - - Gets the stream information. - - A for this player. - - - - Gets the audio effect. - - http://tizen.org/feature/multimedia.custom_audio_effect - The required feature is not supported. - - - - Gets or sets the mute state. - - true if the player is muted; otherwise, false. - The player has already been disposed of. - - - - Gets or sets the current volume. - - Valid volume range is from 0 to 1.0, inclusive. - The player has already been disposed of. - - is less than zero.\n - -or-\n - is greater than 1.0. - - - - - Provides a means to configure display settings for video . - - - - - This constructor supports the product infrastructure and is not intended to be used directly from application code. - - - - - Gets the player of this instance. - - The of this instance. - - - - Gets or sets the . - - - Operation failed; internal error. - - The player already has been disposed of. - The specified value to set is invalid. - - - - Gets or sets the value indicating whether the display is visible. - - true if the display is visible; otherwise false. - - Operation failed; internal error. - - The player already has been disposed of. - - - - Gets or sets the rotation of the display. - - , , , - - - Operation failed; internal error. - - The player already has been disposed of. - The specified value to set is invalid. - - - - Sets the roi(region of interest). - - The region. - - To set roi, must be set to first. - - - Operation failed; internal error.\n - -or-\n - is not set to . - - The player already has been disposed of. - width or height is less than or equal to zero. - - - - Specifies errors. - - - - - - - File does not exists. - - - - - Internal error. - - - - - No space. - - - - - Not enough buffer. - - - - - failed. - - - - - Invalid state. - - - - - Not supported file. - - - - - Invalid uri. - - - - - Connection to service failed. - - - - - Not permitted DRM. - - - - - Service disconnected. - - - - - Not supported audio codec. - - - - - Not supported video codec. - - - - - Not supported subtitle file. - - - - - Specifies states that a can have. - - - - - Initial state, unprepared. - - - - - - Prepared. - - - - - - Playing. - - - - - - Paused while playing media. - - - - - - Preparing in progress. - - /> - - - - Specifies audio latency modes for . - - - - - - Low audio latency mode. - - - - - Middle audio latency mode. - - - - - High audio latency mode. - - - - - Specifies display modes for - - - - - - Letter box. - - - - - Original size. - - - - - Full-screen. - - - - - Cropped full-screen. - - - - - Origin size (if surface size is larger than video size(width/height)) or - Letter box (if video size(width/height) is larger than surface size). - - - - - Region of interest, See . - - - - - Audio element stream type - - - - - Video element stream type - - - - - Text type - - - - - Specifies the streaming buffer status. - - - - - - - Underrun. - - - - - Completed. - - - - - Specifies the reason for the playback interruption. - - - - - - Interrupted by a resource conflict and the will be unprepared, automatically. - - - - - Specifies keys for the metadata. - - - - - - Album. - - - - - Artists. - - - - - Author. - - - - - Genre. - - - - - Title. - - - - - Year. - - - - - The exception that is thrown when there is no available space in a buffer. - - - - - Initializes a new instance of the NoBufferSpaceException class with a specified error message. - - Error description. - - - - The exception that is thrown when there is no available resource for internal use. - - - - - Initializes a new instance of the ResourceLimitException class with a specified error message. - - Error description. - - - - Provides data for the event. - - - - - Initializes a new instance of the PlayerErrorOccurredEventArgs class. - - The value indicating what kind of error occurred. - - - - Gets the error. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides a means to retrieve track information. - - - - - - - Gets the number of tracks. - - The number of tracks. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Gets the language code for the specified index or null if the language is undefined. - - The number of tracks. - - The that owns this instance must be in the , or state. - The language codes are defined in ISO 639-1. - - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - is less than zero.\n - -or-\n - is equal to or greater than - - - - - Gets or sets the selected track index. - - The currently selected track index. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - is less than zero.\n - -or-\n - is equal to or greater than - - - - - Represents properties for audio stream. - - - - - Initialize a new instance of the AudioStreamProperties struct with the specified sample rate, channels and bit rate. - - The sample rate of the stream. - The number of channels of the stream. - The bit rate of the stream. - - - - Gets or sets the sample rate. - - The audio sample rate(Hz). - - - - Gets or sets the channels. - - - - - Gets or sets the bit rate. - - The audio bit rate(Hz). - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Represents properties for video stream. - - - - - Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate and size. - - The fps of the stream. - The bit rate of the stream. - The size of the stream. - - - - Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate, width and height. - - The fps of the stream. - The bit rate of the stream. - The width of the stream. - The height of the stream. - - - - Gets or sets the fps. - - - - - Gets or sets the bit rate. - - - - - Gets or sets the size. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides a means to retrieve stream information. - - - - - Retrieves the album art of the stream or null if there is no album art data. - - Raw byte array if album art exists; otherwise null. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Retrieves the codec name of audio or null if there is no audio. - - A string that represents codec name. - - - - Retrieves the codec name of video or null if there is no video. - - A string that represents codec name. - - - - Gets the duration. - - The duration of the stream. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Gets the properties of audio. - - A that contains audio stream information. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Gets the properties of video. - - A that contains video stream information. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Gets the metadata with the specified key. - - A string that represents the value of the specified key. - The key to query. - The that owns this instance must be in the , or state. - The that this instance belongs to has been disposed. - The that this instance belongs to is not in the valid state. - - - - Gets the that owns this instance. - - - - - Provides data for the event. - - - - - Gets the duration of the updated subtitle. - - - - - Gets the text of the updated subtitle. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Provides data for the event. - - - - - Initializes a new instance of the VideoFrameDecodedEventArgs class. - - - - - Gets the packet containing the decoded frame. - - - - - Provides data for the event. - - - - - Initializes a new instance of the VideoStreamChangedEventArgs class. - - - - - Gets the of new video. - - - - - Gets the fps of new video - - - - - Gets the bit rate of new video. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - + + + + Tizen.Multimedia.MediaPlayer + + + + + Provides the ability to control the audio effects for . + + + + + Gets a at the specified index. + + The index of the band to get. + The has already been disposed of. + + index is less than zero.\n + -or-\n + index is equal to or greater than . + + + + + Clears the equalizer effect. + + The has already been disposed of. + + + + Get the number of items. + + + + + Get the band level range of the bands in dB. + + + + + Gets the value whether the AudioEffect is available or not. + + + + + Gets the player that this AudioEffect belongs to. + + + + + Provides data for the event. + + + + + Initializes a new instance of the BufferingProgressChangedEventArgs class. + + The value indicating the buffering percentage. + + + + Gets the value indicating the buffering percentage. + + The percentage of the buffering. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Represents data for a video frame captured. + + + + + Gets the raw buffer of the captured image. + + The color space format is RGB888. + + + + Gets the size. + + + + + Represents data for a downloading status. + + + + + Initializes a new instance of the DownloadProgress struct. + + The position that downloading started in percentage. + The position indicating the current downloading progress in percentage. + + + + Gets or sets the start position. + + The position that downloading started in percentage. + + + + Gets or sets the current position. + + The position indicating the current downloading progress in percentage. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Represents a equalizer band of . + + + + + Sets or gets the gain for the equalizer band. + + The value indicating new gain in decibel(dB). + The player that this EqualizerBand belongs to has already been disposed of. + + is not inside of . + + + + + Gets the frequency in dB. + + + + + Gets the frequency range in dB. + + + + + Represents a media source using memory. + + + The buffer has to be filled with appropriate data which means it must be well-formatted. + If you provide invalid data, you won't receive an error until is called. + + + + + + Initialize a new instance of the MediaBufferSource class with an allocated buffer. + + The value indicating the size of the buffer. + + is zero.\n + -or-\n + is less than zero. + + + + + Initialize a new instance of the MediaBufferSource class from the buffer. + + The source array to be copied into the buffer. + buffer is null. + + + + Initialize a new instance of the MediaBufferSource class from the buffer + with the specified length and the specified offset. + + The source array to be copied into the buffer. + The value indicating the number of bytes to copy from the buffer. + The value indicating the offset in the buffer of the first byte to copy. + buffer is null. + + is less than zero.\n + -or-\n + is equal to or less than zero.\n + -or-\n + + is greater than buffer.Length. + + + + + Create a MediaBufferSource that wraps a byte array. + + The array to be wrapped. + A MediaBufferSource wrapping the byte array. + + + + Gets the byte array of this buffer. + + + + + MediaSource is a base class for sources. + + + + + Provides data for the event. + + + + + Initializes a new instance of the MediaStreamBufferStatusChangedEventArgs class. + + The value indicating the status of the stream. + + + + Gets the status. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides a means to configure properties and handle events for . + + + + + + Occurs when the buffer underrun or overflow. + + The event handler will be executed on an internal thread. + + + + + + Occurs when the seeking is requested. + + The event handler will be executed on an internal thread. + + + + Gets the max size of the buffer. + + The max size of the buffer. The default is 200000. + If the buffer level over the max size, will be raised with . + The is not assigned to a player. + value is zero. + + + + + Gets the min threshold of the buffer or zero if the is not assigned to a player. + + The minimum threshold of the buffer in percentage. The default is zero. + If the buffer level drops below the threshold value, will be raised with . + The is not assigned to a player. + value is greater than 100. + + + + + Provides data for the event. + + + + + Initializes a new instance of the MediaStreamSeekingOccurredEventArgs class. + + The value indicating the new position to seek. + + + + Gets the offset. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides the ability to push packets as the source of + + The source must be set as a source to a player before pushing. + + + + + Gets all supported audio types. + + + + + Gets all supported video types. + + + + + Initialize a new instance of the MediaStreamSource class + with the specified and . + + The for this source. + The for this source. + AAC and H.264 are supported. + Both and are null. + + is not supported.\n + -or-\n + is not supported.\n + + + + + + + Initialize a new instance of the MediaStreamSource class with the specified . + + The for this source. + AAC is supported. + is null. + is not supported. + + + + + Initialize a new instance of the MediaStreamSource class with the specified . + + H.264 can is supported. + The for this source. + is null. + is not supported. + + + + + Gets the audio configuration or null if no AudioMediaFormat is specified in the constructor. + + + + + Gets the video configuration or null if no VideoMediaFormat is specified in the constructor. + + + + + Pushes elementary stream to decode audio or video. + + This source must be set as a source to a player and the player must be in the , or state. + The to decode. + + This source is not set as a source to a player.\n + -or-\n + The player is not in the valid state. + + packet is null. + packet has been disposed. + + is neither video nor audio type.\n + -or-\n + The format of packet is not matched with the specified format in the constructor. + + the internal buffer reaches limits. + + + + + + + Gets the that this source is assigned to as a source or null if this source is not assigned. + + + + + + Represents a media source with a uri. + + + The internet privilege(http://tizen.org/privilege/internet) must be added if any URLs are used to play from network. + The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any video/audio files are used to play located in the internal storage. + The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. + + + + + + Initializes a new instance of the MediaUriSource class with the specified uri. + The uri string. + For HTTP or RSTP, uri should start with "http://" or "rtsp://". + The default protocol is "file://". + If you provide an invalid uri, you won't receive an error until is called. + + + + Gets the uri. + + + + + Provides data for the event. + + + + + Initializes a new instance of the PlaybackInterruptedEventArgs class. + + The enum value indicating the reason. + + + + Gets the reason. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides the ability to control media playback. + + + The Player provides functions to play a media content. + It also provides functions to adjust the configurations of the player such as playback rate, volume, looping etc. + Note that only one video player can be played at one time. + + + + + Initialize a new instance of the Player class. + + + + + Releases all resources used by the current instance. + + + + + Gets the streaming download Progress. + + The containing current download progress. + The player must be in the or state. + + The player is not streaming.\n + -or-\n + The player is not in the valid state. + + The player has already been disposed of. + + + + Sets the subtitle path for playback. + + Only MicroDVD/SubViewer(*.sub), SAMI(*.smi), and SubRip(*.srt) subtitle formats are supported. + The mediastorage privilege(http://tizen.org/privilege/mediastorage) must be added if any files are used to play located in the internal storage. + The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any files are used to play located in the external storage. + + The player has already been disposed of. + is an empty string. + The specified path does not exist. + The path is null. + + + + Removes the subtitle path. + + The player must be in the state. + The player has already been disposed of. + The player is not in the valid state. + + + + Sets the offset for the subtitle. + + The value indicating a desired offset in milliseconds. + The player must be in the or state. + The player has already been disposed of. + + The player is not in the valid state.\n + -or-\n + No subtitle is set. + + + + + + Called when the is invoked. + + + + + Prepares the media player for playback, asynchronously. + + A task that represents the asynchronous prepare operation. + To prepare the player, the player must be in the state, + and a source must be set. + No source is set. + The player has already been disposed of. + The player is not in the valid state. + + + + Unprepares the player. + + + The most recently used source is reset and no longer associated with the player. Playback is no longer possible. + If you want to use the player again, you have to set a source and call again. + + The player must be in the , or state. + It has no effect if the player is already in the state. + + + The player has already been disposed of. + The player is not in the valid state. + + + + Called after the is unprepared. + + + + + + Starts or resumes playback. + + + The player must be in the or state. + It has no effect if the player is already in the state.\n + \n + Sound can be mixed with other sounds if you don't control the stream focus using . + + The player has already been disposed of. + The player is not in the valid state. + + + + + + + + + Stops playing media content. + + + The player must be in the or state. + It has no effect if the player is already in the state. + + The player has already been disposed of. + The player is not in the valid state. + + + + + + Pauses the player. + + + The player must be in the state. + It has no effect if the player is already in the state. + + The player has already been disposed of. + The player is not in the valid state. + + + + + Sets a media source for the player. + + A that specifies the source for playback. + The player must be in the state. + The player has already been disposed of. + + The player is not in the valid state.\n + -or-\n + It is not able to assign the source to the player. + + + + + + Captures a video frame asynchronously. + + A task that represents the asynchronous capture operation. + http://tizen.org/feature/multimedia.raw_video + The player must be in the or state. + The player has already been disposed of. + The player is not in the valid state. + The required feature is not supported. + + + + Gets the play position in milliseconds. + + The player must be in the , or state. + The player has already been disposed of. + The player is not in the valid state. + + + + + Sets the seek position for playback, asynchronously. + + The value indicating a desired position in milliseconds. + The value indicating whether the operation performs with accuracy. + + The player must be in the , or state. + If the is true, the play position will be adjusted as the specified value, + but this might be considerably slow. If false, the play position will be a nearest keyframe position. + + The player has already been disposed of. + The player is not in the valid state. + The specified position is not valid. + + + + + Sets playback rate. + + The value for the playback rate. Valid range is -5.0 to 5.0, inclusive. + + The player must be in the , or state. + The sound will be muted, when the playback rate is under 0.0 or over 2.0. + + The player has already been disposed of. + + The player is not in the valid state.\n + -or-\n + Streaming playback. + + + is less than 5.0.\n + -or-\n + is greater than 5.0.\n + -or-\n + is zero. + + + + + Applies the audio stream policy. + + The to apply. + + The player must be in the state.\n + \n + does not support all .\n + Supported types are , , + , , + , , + and . + + + The player has already been disposed of.\n + -or-\n + has already been disposed of. + + The player is not in the valid state. + is null. + + of is not supported by . + + + + + + This method supports the product infrastructure and is not intended to be used directly from application code. + + + + + Occurs when playback of a media is finished. + + + + + Occurs when playback of a media is interrupted. + + + + + Occurs when any error occurs. + + The event handler will be executed on an internal thread. + + + + Occurs when the video stream changed. + + The event handler will be executed on an internal thread. + + + + Occurs when the subtitle is updated. + + The event handler will be executed on an internal thread. + + + + Occurs when there is a change in the buffering status of streaming. + + + + + Occurs when a video frame is decoded. + + + The event handler will be executed on an internal thread. + The in event args should be disposed after use. + + http://tizen.org/feature/multimedia.raw_video + The required feature is not supported. + + + + + Gets the native handle of the player. + + An IntPtr that contains the native handle of the player. + The player has already been disposed of. + + + + Gets or Sets the cookie for streaming playback. + + To set, the player must be in the state. + The player is not in the valid state. + The player has already been disposed of. + The value to set is null. + + + + Gets or Sets the user agent for streaming playback. + + To set, the player must be in the state. + The player is not in the valid state. + The player has already been disposed of. + The value to set is null. + + + + Gets the state of the player. + + The current state of the player. + The player has already been disposed of. + + + + Gets or sets the audio latency mode. + + A that specifies the mode. The default is . + + If the mode is , + audio output interval can be increased so, it can keep more audio data to play. + But, state transition like pause or resume can be more slower than default(). + + The player has already been disposed of. + The value is not valid. + + + + Gets or sets the looping state. + + true if the playback is looping; otherwise, false. The default value is false. + The player has already been disposed of. + + + + Gets the display settings. + + A that specifies the display settings. + + + + Gets or sets the display. + + A that specifies the display. + The player must be in the state. + The player has already been disposed of. + The value has already been assigned to another player. + The player is not in the valid state. + + + + Gets the track info for audio. + + A for audio. + + + + Gets the track info for subtitle. + + A for subtitle. + + + + Gets the stream information. + + A for this player. + + + + Gets the audio effect. + + http://tizen.org/feature/multimedia.custom_audio_effect + The required feature is not supported. + + + + Gets or sets the mute state. + + true if the player is muted; otherwise, false. + The player has already been disposed of. + + + + Gets or sets the current volume. + + Valid volume range is from 0 to 1.0, inclusive. + The player has already been disposed of. + + is less than zero.\n + -or-\n + is greater than 1.0. + + + + + Provides a means to configure display settings for video . + + + + + This constructor supports the product infrastructure and is not intended to be used directly from application code. + + + + + Gets the player of this instance. + + The of this instance. + + + + Gets or sets the . + + + Operation failed; internal error. + + The player already has been disposed of. + The specified value to set is invalid. + + + + Gets or sets the value indicating whether the display is visible. + + true if the display is visible; otherwise false. + + Operation failed; internal error. + + The player already has been disposed of. + + + + Gets or sets the rotation of the display. + + , , , + + + Operation failed; internal error. + + The player already has been disposed of. + The specified value to set is invalid. + + + + Sets the roi(region of interest). + + The region. + + To set roi, must be set to first. + + + Operation failed; internal error.\n + -or-\n + is not set to . + + The player already has been disposed of. + width or height is less than or equal to zero. + + + + Specifies errors. + + + + + + + File does not exists. + + + + + Internal error. + + + + + No space. + + + + + Not enough buffer. + + + + + failed. + + + + + Invalid state. + + + + + Not supported file. + + + + + Invalid uri. + + + + + Connection to service failed. + + + + + Not permitted DRM. + + + + + Service disconnected. + + + + + Not supported audio codec. + + + + + Not supported video codec. + + + + + Not supported subtitle file. + + + + + Specifies states that a can have. + + + + + Initial state, unprepared. + + + + + + Prepared. + + + + + + Playing. + + + + + + Paused while playing media. + + + + + + Preparing in progress. + + /> + + + + Specifies audio latency modes for . + + + + + + Low audio latency mode. + + + + + Middle audio latency mode. + + + + + High audio latency mode. + + + + + Specifies display modes for + + + + + + Letter box. + + + + + Original size. + + + + + Full-screen. + + + + + Cropped full-screen. + + + + + Origin size (if surface size is larger than video size(width/height)) or + Letter box (if video size(width/height) is larger than surface size). + + + + + Region of interest, See . + + + + + Audio element stream type + + + + + Video element stream type + + + + + Text type + + + + + Specifies the streaming buffer status. + + + + + + + Underrun. + + + + + Completed. + + + + + Specifies the reason for the playback interruption. + + + + + + Interrupted by a resource conflict and the will be unprepared, automatically. + + + + + Specifies keys for the metadata. + + + + + + Album. + + + + + Artists. + + + + + Author. + + + + + Genre. + + + + + Title. + + + + + Year. + + + + + The exception that is thrown when there is no available space in a buffer. + + + + + Initializes a new instance of the NoBufferSpaceException class with a specified error message. + + Error description. + + + + The exception that is thrown when there is no available resource for internal use. + + + + + Initializes a new instance of the ResourceLimitException class with a specified error message. + + Error description. + + + + Provides data for the event. + + + + + Initializes a new instance of the PlayerErrorOccurredEventArgs class. + + The value indicating what kind of error occurred. + + + + Gets the error. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides a means to retrieve track information. + + + + + + + Gets the number of tracks. + + The number of tracks. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Gets the language code for the specified index or null if the language is undefined. + + The number of tracks. + + The that owns this instance must be in the , or state. + The language codes are defined in ISO 639-1. + + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + is less than zero.\n + -or-\n + is equal to or greater than + + + + + Gets or sets the selected track index. + + The currently selected track index. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + is less than zero.\n + -or-\n + is equal to or greater than + + + + + Represents properties for audio stream. + + + + + Initialize a new instance of the AudioStreamProperties struct with the specified sample rate, channels and bit rate. + + The sample rate of the stream. + The number of channels of the stream. + The bit rate of the stream. + + + + Gets or sets the sample rate. + + The audio sample rate(Hz). + + + + Gets or sets the channels. + + + + + Gets or sets the bit rate. + + The audio bit rate(Hz). + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Represents properties for video stream. + + + + + Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate and size. + + The fps of the stream. + The bit rate of the stream. + The size of the stream. + + + + Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate, width and height. + + The fps of the stream. + The bit rate of the stream. + The width of the stream. + The height of the stream. + + + + Gets or sets the fps. + + + + + Gets or sets the bit rate. + + + + + Gets or sets the size. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides a means to retrieve stream information. + + + + + Retrieves the album art of the stream or null if there is no album art data. + + Raw byte array if album art exists; otherwise null. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Retrieves the codec name of audio or null if there is no audio. + + A string that represents codec name. + + + + Retrieves the codec name of video or null if there is no video. + + A string that represents codec name. + + + + Gets the duration. + + The duration of the stream. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Gets the properties of audio. + + A that contains audio stream information. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Gets the properties of video. + + A that contains video stream information. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Gets the metadata with the specified key. + + A string that represents the value of the specified key. + The key to query. + The that owns this instance must be in the , or state. + The that this instance belongs to has been disposed. + The that this instance belongs to is not in the valid state. + + + + Gets the that owns this instance. + + + + + Provides data for the event. + + + + + Gets the duration of the updated subtitle. + + + + + Gets the text of the updated subtitle. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Provides data for the event. + + + + + Initializes a new instance of the VideoFrameDecodedEventArgs class. + + + + + Gets the packet containing the decoded frame. + + + + + Provides data for the event. + + + + + Initializes a new instance of the VideoStreamChangedEventArgs class. + + + + + Gets the of new video. + + + + + Gets the fps of new video + + + + + Gets the bit rate of new video. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Metadata.dll b/Artifacts/bin/Tizen.Multimedia.Metadata.dll index ca19acb..c7f9ba1 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Metadata.dll and b/Artifacts/bin/Tizen.Multimedia.Metadata.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Metadata.pdb b/Artifacts/bin/Tizen.Multimedia.Metadata.pdb index d454934..c0b350e 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Metadata.pdb and b/Artifacts/bin/Tizen.Multimedia.Metadata.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Metadata.xml b/Artifacts/bin/Tizen.Multimedia.Metadata.xml index d13c87a..1371edc 100644 --- a/Artifacts/bin/Tizen.Multimedia.Metadata.xml +++ b/Artifacts/bin/Tizen.Multimedia.Metadata.xml @@ -1,626 +1,626 @@ - - - - Tizen.Multimedia.Metadata - - - - - Provides a means to edit the metadata of the media file. - - - If you want to access only internal storage, - you should add privilege http://tizen.org/privilege/mediastorage. \n - Or if you want to access only external storage, - you should add privilege http://tizen.org/privilege/externalstorage. \n - - - - - Initializes a new instance of the class with the specified path. - - 3 - The path of the media file to edit metadata. - is null. - is a zero-length string, contains only white space. - The file is not supported. - File does not exist. - Caller does not have required privilege to access the file. - - - - Gets or sets the artist of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the title of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the album name of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the genre of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the author of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the copyright of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the date of media. - - 3 - - If the media contains ID3 tag, this refers to the recorded date. - If the media is a mp4 format, this refers to the year and the value to set will be converted into integer. - - The file is read-only. - The has already been disposed. - - - - Gets or sets the description of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the comment of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the track number of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets the count of album arts of media. - - 3 - The has already been disposed. - - - - Gets or sets the conductor of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Gets or sets the unsynchronized lyrics of media. - - 3 - The file is read-only. - The has already been disposed. - - - - Writes the modified metadata to the media file. - - - An internal error occurs.\n - -or-\n - The file is read-only. - - The has already been disposed. - - - - Gets the artwork image in the media file. - - 3 - The index of picture to import. - Artwork included in the media file. - Artwork included in the media file. - An internal error occurs. - - is less than zero.\n - -or-\n - is greater than or equal to .\n - - The has already been disposed. - - - - Appends the picture to the media file. - - 3 - The path of picture for adding to the metadata. - - An internal error occurs.\n - -or-\n - The media file is read-only. - - Picture path is null - File does not exist. - Caller does not have required privilege to access the file. - The has already been disposed. - The specified file is not supported. - - - - Removes the picture from the media file. - - 3 - The index of picture to remove. - - An internal error occurs.\n - -or-\n - The media file is read-only. - - - is less than zero.\n - -or-\n - is greater than or equal to .\n - - The has already been disposed. - - - - Releases all resources used by the object. - - - - - Enumeration for metadata extractor's error codes. - - - - - Represents artwork information of media. - - - - - Initializes a new instance of the Artwork class with the specified data and mime type. - - 3 - The data of the artwork to set metadata. - The mime type of the data of the artwork. - - - - Gets the encoded artwork image. - - 3 - - - - Gets the mime type of artwork. - - 3 - - - - Represents video metadata information. - - - - - Gets the bitrate. - - 3 - The bitrate value, or null if the information does not exist. - - - - Gets the video FPS. - - 3 - The fps value, or null if the information does not exist. - - - - Gets the width of the video. - - 3 - The width value, or null if the information does not exist. - - - - Gets the height of the video. - - 3 - The height value, or null if the information does not exist. - - - - Get the codec type of the video. - - 3 - A string representing the codec type, or null if the information does not exist. - - - - Gets the video stream count. - - 3 - The number of video streams. - - - - Represents audio metadata information. - - - - - Gets the audio bitrate. - - 3 - The bit rate value, or null if the information does not exist. - - - - Gets the audio channels. - - 3 - The number of the audio channels, or null if the information does not exist. - - - - Gets the audio sample rate. - - 3 - The sample rate, or null if the information does not exist. - - - - Gets the bit per sample of the audio. - - 3 - The bit per sample, or null if the information does not exist. - - - - Gets the audio stream count. - - 3 - The number of audio streams. - - - - Gets the audio codec type. - - 3 - - - - Represents metadata information of a media. - - - - - Gets the duration of the media. - - 3 - The duration value, or null if the information does not exist. - - - - Gets the video metadata. - - 3 - The video metadata, or null if the information does not exist. - - - - Gets the audio metadata. - - 3 - The audio metadata, or null if the information does not exist. - - - - Gets the artist of the media. - - 3 - A string representing the artist, or null if the information does not exist. - - - - Gets the title of the media. - - 3 - A string representing the title, or null if the information does not exist. - - - - Gets the album name of the media. - - 3 - A string representing the album name, or null if the information does not exist. - - - - Gets the album artist of the media. - - 3 - A string representing the album artist, or null if the information does not exist. - - - - Gets the genre of the media. - - 3 - A string representing the genre, or null if the information does not exist. - - - - Gets the author of the media. - - 3 - A string representing the author, or null if the information does not exist. - - - - Gets the copyright of the media. - - 3 - A string representing the copyright, or null if the information does not exist. - - - - Gets the release date of the media. - - 3 - A string representing the release date, or null if the information does not exist. - - - - Gets the description of the media. - - 3 - A string representing the description, or null if the information does not exist. - - - - Gets the comment of the media. - - 3 - A string representing the comment, or null if the information does not exist. - - - - Gets the track number of the media. - - 3 - A string representing the track number, or null if the information does not exist. - - - - Gets the classification of the media. - - 3 - A string representing the classification, or null if the information does not exist. - - - - Gets the rating of the media. - - 3 - A string representing the rating, or null if the information does not exist. - - - - Gets the longitude of the media. - - 3 - The longitude value, or null if the information does not exist. - - - - Gets the latitude of the media. - - 3 - The latitude value, or null if the information does not exist. - - - - Gets the altitude of the media. - - 3 - The altitude value, or null if the information does not exist. - - - - Gets the conductor of the media. - - 3 - A string representing the conductor, or null if the information does not exist. - - - - Gets the unsynchronized lyrics of the media. - - 3 - A string representing the unsynchronized lyrics, or null if the information does not exist. - - - - Gets the number of synchronized lyrics of the media. - - 3 - The number of the synchronized lyrics. - - - - Gets the recording date of the media. - - 3 - A string representing the recording date, or null if the information does not exist. - - - - Gets the rotate(orientation) information of the media. - - 3 - A string representing the rotation information, or null if the information does not exist. - - - - Gets the information for 360 content of the media. - - 3 - A string representing the information for 360 content, or null if the information does not exist. - - - - Provides a set of functions to get the metadata from a media file. - - - - - Initializes a new instance of the MetadataExtractor class with the specified path. - - 3 - The path for the file to extract metadata. - is null. - is not exist. - - - - Initializes a new instance of the MetadataExtractor class with the specified buffer. - - 3 - The buffer to extract metadata. - is null. - The length of is zero. - - - - Retrieves the . - - 3 - A for the given source. - Internal process error is occurred. - The has been already disposed of. - - - - Gets the artwork image in the source. - - 3 - A if it exists, otherwise null. - Internal process error is occurred. - The has been already disposed of. - - - - Gets the sync lyrics of the source. - - 3 - The index of lyrics to retrieve. - A object if is valid, otherwise null. - Internal process error is occurred. - The has been already disposed of. - - - - Gets the frame of a video media. - - 3 - The raw thumbnail data in RGB888 if it exists, otherwise null. - Internal process error is occurred. - The has been already disposed of. - - - - Gets the frame of a video media. - - 3 - The timestamp in milliseconds. - true to get an accurate frame for the given timestamp, - otherwise false to get the nearest i-frame of the video rapidly. - The raw frame data in RGB888 if a frame at specified time exists, otherwise null. - An internal error occurs. - The has been already disposed of. - - - - Metadata Extractor destructor - - 3 - - - - Releases all resources used by the object. - - - - - Enumeration for metadata extractor's error codes. - - - - - Represents synchronized lyrics information of media. - - - - - Initialize a new instance of the MetadataExtractor class with the specified lyrics and timestamp. - - 3 - The text of synchronized lyrics. - The timestamp of synchronized lyrics. - - - - Gets the text representation of the lyrics. - - 3 - - - - Gets the time information of the lyrics. - - 3 - - - - Represents a point in 2D space. - - - - + + + + Tizen.Multimedia.Metadata + + + + + Provides a means to edit the metadata of the media file. + + + If you want to access only internal storage, + you should add privilege http://tizen.org/privilege/mediastorage. \n + Or if you want to access only external storage, + you should add privilege http://tizen.org/privilege/externalstorage. \n + + + + + Initializes a new instance of the class with the specified path. + + 3 + The path of the media file to edit metadata. + is null. + is a zero-length string, contains only white space. + The file is not supported. + File does not exist. + Caller does not have required privilege to access the file. + + + + Gets or sets the artist of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the title of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the album name of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the genre of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the author of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the copyright of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the date of media. + + 3 + + If the media contains ID3 tag, this refers to the recorded date. + If the media is a mp4 format, this refers to the year and the value to set will be converted into integer. + + The file is read-only. + The has already been disposed. + + + + Gets or sets the description of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the comment of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the track number of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets the count of album arts of media. + + 3 + The has already been disposed. + + + + Gets or sets the conductor of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Gets or sets the unsynchronized lyrics of media. + + 3 + The file is read-only. + The has already been disposed. + + + + Writes the modified metadata to the media file. + + + An internal error occurs.\n + -or-\n + The file is read-only. + + The has already been disposed. + + + + Gets the artwork image in the media file. + + 3 + The index of picture to import. + Artwork included in the media file. + Artwork included in the media file. + An internal error occurs. + + is less than zero.\n + -or-\n + is greater than or equal to .\n + + The has already been disposed. + + + + Appends the picture to the media file. + + 3 + The path of picture for adding to the metadata. + + An internal error occurs.\n + -or-\n + The media file is read-only. + + Picture path is null + File does not exist. + Caller does not have required privilege to access the file. + The has already been disposed. + The specified file is not supported. + + + + Removes the picture from the media file. + + 3 + The index of picture to remove. + + An internal error occurs.\n + -or-\n + The media file is read-only. + + + is less than zero.\n + -or-\n + is greater than or equal to .\n + + The has already been disposed. + + + + Releases all resources used by the object. + + + + + Enumeration for metadata extractor's error codes. + + + + + Represents artwork information of media. + + + + + Initializes a new instance of the Artwork class with the specified data and mime type. + + 3 + The data of the artwork to set metadata. + The mime type of the data of the artwork. + + + + Gets the encoded artwork image. + + 3 + + + + Gets the mime type of artwork. + + 3 + + + + Represents video metadata information. + + + + + Gets the bitrate. + + 3 + The bitrate value, or null if the information does not exist. + + + + Gets the video FPS. + + 3 + The fps value, or null if the information does not exist. + + + + Gets the width of the video. + + 3 + The width value, or null if the information does not exist. + + + + Gets the height of the video. + + 3 + The height value, or null if the information does not exist. + + + + Get the codec type of the video. + + 3 + A string representing the codec type, or null if the information does not exist. + + + + Gets the video stream count. + + 3 + The number of video streams. + + + + Represents audio metadata information. + + + + + Gets the audio bitrate. + + 3 + The bit rate value, or null if the information does not exist. + + + + Gets the audio channels. + + 3 + The number of the audio channels, or null if the information does not exist. + + + + Gets the audio sample rate. + + 3 + The sample rate, or null if the information does not exist. + + + + Gets the bit per sample of the audio. + + 3 + The bit per sample, or null if the information does not exist. + + + + Gets the audio stream count. + + 3 + The number of audio streams. + + + + Gets the audio codec type. + + 3 + + + + Represents metadata information of a media. + + + + + Gets the duration of the media. + + 3 + The duration value, or null if the information does not exist. + + + + Gets the video metadata. + + 3 + The video metadata, or null if the information does not exist. + + + + Gets the audio metadata. + + 3 + The audio metadata, or null if the information does not exist. + + + + Gets the artist of the media. + + 3 + A string representing the artist, or null if the information does not exist. + + + + Gets the title of the media. + + 3 + A string representing the title, or null if the information does not exist. + + + + Gets the album name of the media. + + 3 + A string representing the album name, or null if the information does not exist. + + + + Gets the album artist of the media. + + 3 + A string representing the album artist, or null if the information does not exist. + + + + Gets the genre of the media. + + 3 + A string representing the genre, or null if the information does not exist. + + + + Gets the author of the media. + + 3 + A string representing the author, or null if the information does not exist. + + + + Gets the copyright of the media. + + 3 + A string representing the copyright, or null if the information does not exist. + + + + Gets the release date of the media. + + 3 + A string representing the release date, or null if the information does not exist. + + + + Gets the description of the media. + + 3 + A string representing the description, or null if the information does not exist. + + + + Gets the comment of the media. + + 3 + A string representing the comment, or null if the information does not exist. + + + + Gets the track number of the media. + + 3 + A string representing the track number, or null if the information does not exist. + + + + Gets the classification of the media. + + 3 + A string representing the classification, or null if the information does not exist. + + + + Gets the rating of the media. + + 3 + A string representing the rating, or null if the information does not exist. + + + + Gets the longitude of the media. + + 3 + The longitude value, or null if the information does not exist. + + + + Gets the latitude of the media. + + 3 + The latitude value, or null if the information does not exist. + + + + Gets the altitude of the media. + + 3 + The altitude value, or null if the information does not exist. + + + + Gets the conductor of the media. + + 3 + A string representing the conductor, or null if the information does not exist. + + + + Gets the unsynchronized lyrics of the media. + + 3 + A string representing the unsynchronized lyrics, or null if the information does not exist. + + + + Gets the number of synchronized lyrics of the media. + + 3 + The number of the synchronized lyrics. + + + + Gets the recording date of the media. + + 3 + A string representing the recording date, or null if the information does not exist. + + + + Gets the rotate(orientation) information of the media. + + 3 + A string representing the rotation information, or null if the information does not exist. + + + + Gets the information for 360 content of the media. + + 3 + A string representing the information for 360 content, or null if the information does not exist. + + + + Provides a set of functions to get the metadata from a media file. + + + + + Initializes a new instance of the MetadataExtractor class with the specified path. + + 3 + The path for the file to extract metadata. + is null. + is not exist. + + + + Initializes a new instance of the MetadataExtractor class with the specified buffer. + + 3 + The buffer to extract metadata. + is null. + The length of is zero. + + + + Retrieves the . + + 3 + A for the given source. + Internal process error is occurred. + The has been already disposed of. + + + + Gets the artwork image in the source. + + 3 + A if it exists, otherwise null. + Internal process error is occurred. + The has been already disposed of. + + + + Gets the sync lyrics of the source. + + 3 + The index of lyrics to retrieve. + A object if is valid, otherwise null. + Internal process error is occurred. + The has been already disposed of. + + + + Gets the frame of a video media. + + 3 + The raw thumbnail data in RGB888 if it exists, otherwise null. + Internal process error is occurred. + The has been already disposed of. + + + + Gets the frame of a video media. + + 3 + The timestamp in milliseconds. + true to get an accurate frame for the given timestamp, + otherwise false to get the nearest i-frame of the video rapidly. + The raw frame data in RGB888 if a frame at specified time exists, otherwise null. + An internal error occurs. + The has been already disposed of. + + + + Metadata Extractor destructor + + 3 + + + + Releases all resources used by the object. + + + + + Enumeration for metadata extractor's error codes. + + + + + Represents synchronized lyrics information of media. + + + + + Initialize a new instance of the MetadataExtractor class with the specified lyrics and timestamp. + + 3 + The text of synchronized lyrics. + The timestamp of synchronized lyrics. + + + + Gets the text representation of the lyrics. + + 3 + + + + Gets the time information of the lyrics. + + 3 + + + + Represents a point in 2D space. + + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Radio.dll b/Artifacts/bin/Tizen.Multimedia.Radio.dll index 141f9c6..ac6bc6c 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Radio.dll and b/Artifacts/bin/Tizen.Multimedia.Radio.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Radio.pdb b/Artifacts/bin/Tizen.Multimedia.Radio.pdb index 3fa175c..7064197 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Radio.pdb and b/Artifacts/bin/Tizen.Multimedia.Radio.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Radio.xml b/Artifacts/bin/Tizen.Multimedia.Radio.xml index 53d8419..d02a8e7 100644 --- a/Artifacts/bin/Tizen.Multimedia.Radio.xml +++ b/Artifacts/bin/Tizen.Multimedia.Radio.xml @@ -1,221 +1,221 @@ - - - - Tizen.Multimedia.Radio - - - - - Provides a means for using the radio feature. - - - - - Initialize a new instance of the Radio class. - - Radio feature is not supported - - - - Occurs when radio scan information is updated. - - - - - Occurs when radio scanning stops. - - - - - Occurs when radio scan is completed. - - - - - Occurs when radio is interrupted - - - - - Gets the current state of the radio. - - - - - Gets or sets the radio frequency, in [87500 ~ 108000] (kHz). - - - is less than of .\n - - or - \n - is greater than of .\n - - - - - Gets the current signal strength, in [-128 ~ 128] (dBm). - - - - - Gets the value indicating if radio is muted. - - - true if the radio is muted; otherwise, false. - The default is false. - - - - - Gets the channel spacing for current region. - - - - - Gets or sets the radio volume level. - - Valid volume range is from 0 to 1.0(100%), inclusive. - The default is 1.0. - - is less than zero.\n - - or -\n - is greater than 1.0. - - - - - Gets the frequency for the region, in [87500 ~ 108000] (kHz). - - - - - Starts the radio. - - The radio must be in the state. - The radio is not in the valid state. - - - - Stops the radio. - - The radio must be in the state. - The radio is not in the valid state. - - - - Starts radio scan, will trigger ScanInformationUpdated event, when scan information is updated - - The radio must be in the or state. - The radio is not in the valid state. - - - - - - Stops radio scan. - - The radio must be in the state. - The radio is not in the valid state. - - - - - Seeks up the effective frequency of the radio. - - - A task that represents the asynchronous seeking operation. - The result value is the current frequency, in range [87500 ~ 108000] (kHz). - It can be -1 if the seeking operation has failed. - - The radio must be in the state. - The radio is not in the valid state. - - - - Seeks down the effective frequency of the radio. - - - A task that represents the asynchronous seeking operation. - The result value is the current frequency, in range [87500 ~ 108000] (kHz). - It can be -1 if the seeking operation has failed. - - The radio must be in the state. - The radio is not in the valid state. - - - - Releases the resources used by the Radio. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Releases all resources used by the object. - - - - - Provides data for the event. - - - - - Gets the reason. - - The reason for interruption. - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Specifies interrupted reasons. - - - - - By a resource conflict. - - - - - Specifies states of the . - - - - - Ready to play or scan. - - - - - Playing audio from the tuner. - - - - - Scanning; searching for the next station for signal. - - - - - Provides data for the event. - - - - - Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz). - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - + + + + Tizen.Multimedia.Radio + + + + + Provides a means for using the radio feature. + + + + + Initialize a new instance of the Radio class. + + Radio feature is not supported + + + + Occurs when radio scan information is updated. + + + + + Occurs when radio scanning stops. + + + + + Occurs when radio scan is completed. + + + + + Occurs when radio is interrupted + + + + + Gets the current state of the radio. + + + + + Gets or sets the radio frequency, in [87500 ~ 108000] (kHz). + + + is less than of .\n + - or - \n + is greater than of .\n + + + + + Gets the current signal strength, in [-128 ~ 128] (dBm). + + + + + Gets the value indicating if radio is muted. + + + true if the radio is muted; otherwise, false. + The default is false. + + + + + Gets the channel spacing for current region. + + + + + Gets or sets the radio volume level. + + Valid volume range is from 0 to 1.0(100%), inclusive. + The default is 1.0. + + is less than zero.\n + - or -\n + is greater than 1.0. + + + + + Gets the frequency for the region, in [87500 ~ 108000] (kHz). + + + + + Starts the radio. + + The radio must be in the state. + The radio is not in the valid state. + + + + Stops the radio. + + The radio must be in the state. + The radio is not in the valid state. + + + + Starts radio scan, will trigger ScanInformationUpdated event, when scan information is updated + + The radio must be in the or state. + The radio is not in the valid state. + + + + + + Stops radio scan. + + The radio must be in the state. + The radio is not in the valid state. + + + + + Seeks up the effective frequency of the radio. + + + A task that represents the asynchronous seeking operation. + The result value is the current frequency, in range [87500 ~ 108000] (kHz). + It can be -1 if the seeking operation has failed. + + The radio must be in the state. + The radio is not in the valid state. + + + + Seeks down the effective frequency of the radio. + + + A task that represents the asynchronous seeking operation. + The result value is the current frequency, in range [87500 ~ 108000] (kHz). + It can be -1 if the seeking operation has failed. + + The radio must be in the state. + The radio is not in the valid state. + + + + Releases the resources used by the Radio. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Releases all resources used by the object. + + + + + Provides data for the event. + + + + + Gets the reason. + + The reason for interruption. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Specifies interrupted reasons. + + + + + By a resource conflict. + + + + + Specifies states of the . + + + + + Ready to play or scan. + + + + + Playing audio from the tuner. + + + + + Scanning; searching for the next station for signal. + + + + + Provides data for the event. + + + + + Gets the tuned radio frequency that is scanned, in range [87500 ~ 108000] (kHz). + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Recorder.dll b/Artifacts/bin/Tizen.Multimedia.Recorder.dll index 4efe20b..99911be 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Recorder.dll and b/Artifacts/bin/Tizen.Multimedia.Recorder.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Recorder.pdb b/Artifacts/bin/Tizen.Multimedia.Recorder.pdb index f702414..a65c4d1 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Recorder.pdb and b/Artifacts/bin/Tizen.Multimedia.Recorder.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Recorder.xml b/Artifacts/bin/Tizen.Multimedia.Recorder.xml index a93f7dc..c056ff6 100644 --- a/Artifacts/bin/Tizen.Multimedia.Recorder.xml +++ b/Artifacts/bin/Tizen.Multimedia.Recorder.xml @@ -1,778 +1,778 @@ - - - - Tizen.Multimedia.Recorder - - - - - An extended EventArgs class containing details of audio stream. - - - - - The audio stream data. - - 3 - - - - The length of audio stream data. - - 3 - - - - The audio format type. - - 3 - - - - The number of channels. - - 3 - - - - The recording time of the stream buffer in milliseconds. - - 3 - - - - An extended EventArgs class containing details of muxed stream(Audio + Video). - - - - - The muexed stream data. - - 3 - - - - The length of muxed stream data. - - 3 - - - - The offset of the stream data. - - 3 - - - - The recorder class provides methods to create audio/video recorder, - to start, stop and save the recorded content. It also provides methods - to get/set various attributes and capabilities of recorder. - - - - - Audio recorder constructor. - - - - - Video recorder constructor. - - - The camera object. - - - - - Recorder destructor. - - - - - Releases the unmanaged resources used by the Recorder. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the Recorder. - - 3 - - - - Event that occurs when an error occurs during recorder operation. - - 3 - - - - Event that occurs when recorder is interrupted. - - 3 - - - - This event occurs when recorder state is changed. - - 3 - - - - Event that occurs when recording information changes. - - 3 - - - - Event that occurs when audio stream data is being delivered. - - 3 - - - - Event that occurs when recording limit is reached. - - 3 - - - - Event that occurs when muxed stream data is being delivered. - - 3 - - - - Gets the various recorder features. - - 3 - - - - Get/Set the various recorder settings. - - 3 - - - - The current state of the recorder. - - 3 - A that specifies the state of recorder. - The camera already has been disposed. - - - - Prepare the media recorder for recording. - The recorder must be in the state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - - Before calling the function, it is required to set AudioEncoder, - videoencoder and fileformat properties of recorder. - - In case of any invalid operations. - The camera already has been disposed. - - - - Resets the media recorder. - The recorder must be in the state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - In case of any invalid operations. - The camera already has been disposed. - - - - Starts the recording. - The recorder must be in the state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - - If file path has been set to an existing file, this file is removed automatically and updated by new one. - In the video recorder, some preview format does not support record mode. It will return InvalidOperation error. - You should use default preview format or CameraPixelFormatNv12 in the record mode. - The filename should be set before this function is invoked. - - - http://tizen.org/privilege/recorder - - In case of any invalid operations. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Pause the recording. - The recorder must be in the state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - - Recording can be resumed with Start(). - - - http://tizen.org/privilege/recorder - - In case of any invalid operations. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Stops recording and saves the result. - The recorder must be in the or state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - - http://tizen.org/privilege/recorder - - In case of any invalid operations. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Cancels the recording. - The recording data is discarded and not written in the recording file. - The recorder must be in the or state. - After this method is finished without any exception, - The state of recorder will be changed to state. - - 3 - - http://tizen.org/privilege/recorder - - In case of any invalid operations. - The camera already has been disposed. - In case of access to the resources cannot be granted. - - - - Sets the audio stream policy. - - 3 - Policy. - The camera already has been disposed. - - - - Enumeration for Audio Codec. - - 3 - - - - Disable Audio track. - - - - - AMR codec. - - - - - AAC codec. - - - - - Vorbis codec. - - - - - PCM codec. - - - - - The mp3 codec. - - - - - Enumeration for Audio capture devices. - - 3 - - - - Capture audio from Mic device. - - - - - Capture audio from modem. - - - - - Enumeration for the file container format. - - 3 - - - - 3GP file format. - - - - - MP4 file format. - - - - - AMR file format. - - - - - ADTS file format. - - - - - WAV file format. - - - - - OGG file format. - - - - - M2TS file format. - - - - - Enumeration for the recorder policy. - - 3 - - - - None. - - - - - Security policy. - - - - - Resource conflict policy. - - - - - Enumeration for the recording limit. - - 3 - - - - Time limit in seconds of recording file - - - - - Size limit in KB(KiloBytes) of recording file. - - - - - No free space in storage. - - - - - Enumeration for recorder states. - - 3 - - - - Recorder is not created. - - - - - Recorder is created, but not prepared. - - - - - Recorder is ready to record. In case of video recorder, - preview display will be shown. - - - - - Recorder is recording media. - - - - - Recorder is paused while recording media. - - - - - Enumeration for video codec. - - 3 - - - - H263 codec. - - - - - H264 codec. - - - - - MPEG4 codec. - - - - - Theora codec. - - - - - Enumeration for recorder failure error. - - 3 - - - - Device Error. - - - - - Internal error. - - - - - Out of memory. - - - - - The camera setting class provides methods/properties to get and - set basic camera attributes. - - - - - Retrieves all the file formats supported by the recorder. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the audio encoders supported by the recorder. - - 3 - - It returns a list containing all the supported . - - The camera already has been disposed. - - - - Retrieves all the video encoders supported by the recorder. - - 3 - - It returns a list containing all the supported . - by recorder. - - The camera already has been disposed. - - - - Retrieves all the video resolutions supported by the recorder. - - 3 - - It returns videoresolution list containing the width and height of - different resolutions supported by recorder. - - The camera already has been disposed. - - - - An extended Eventargs class which contains interrupted policy details, previous and current - state of the recorder. - - - - - The policy that interrupted the recorder. - - 3 - - - - The previous state of the recorder. - - 3 - - - - The current state of the recorder. - - 3 - - - - The camera setting class provides methods/properties to get and - set basic camera attributes. - - - - - The number of audio channel. - - 3 - - For mono recording, set channel to 1. - For stereo recording, set channel to 2. - - The camera already has been disposed. - - - - The audio device for recording. - - 3 - A that specifies the type of audio device. - The camera already has been disposed. - - - - Get the peak audio input level in dB - - 3 - - 0dB indicates maximum input level, -300dB indicates minimum input level. - - The camera already has been disposed. - - - - The sampling rate of an audio stream in hertz. - - 3 - The camera already has been disposed. - - - - The bitrate of an audio encoder in bits per second. - - 3 - The camera already has been disposed. - - - - The bitrate of an video encoder in bits per second. - - 3 - The camera already has been disposed. - - - - The audio codec for encoding an audio stream. - - 3 - A that specifies the type of audio codec. - The camera already has been disposed. - - - - The video codec for encoding video stream. - - 3 - A that specifies the type of video codec. - The camera already has been disposed. - - - - The file format for recording media stream. - - 3 - A that specifies the file format. - The camera already has been disposed. - - - - The file path to record. - - 3 - - If the same file already exists in the file system, then old file - will be overwritten. - - The camera already has been disposed. - - - - The maximum size of a recording file in KB(kilobytes). If 0, means - unlimited recording size. - - 3 - - After reaching the limitation, the data which is being recorded will - be discarded and not written to the file. - The recorder state must be in 'Ready' or 'Created' state. - - The camera already has been disposed. - - - - The time limit of a recording file in Seconds. If 0, means unlimited recording - time. - - 3 - - After reaching the limitation, the data which is being recorded will - be discarded and not written to the file. - The recorder state must be in 'Ready' or 'Created' state. - - The camera already has been disposed. - - - - The mute state of a recorder. - - 3 - The camera already has been disposed. - - - - The video recording motion rate - - 3 - - The attribute is valid only in a video recorder. - If the rate is in range of 0-1, video is recorded in a slow motion mode. - If the rate is bigger than 1, video is recorded in a fast motion mode. - - The camera already has been disposed. - - - - The orientation in a video metadata tag. - - 3 - A that specifies the type of orientation. - The camera already has been disposed. - - - - Resolution of the video. - - 3 - In case of invalid parameters - The camera already has been disposed. - - - - An extended EventArgs class which contains details about previous and current state - of the recorder when its state is changed. - - - - - Previous state of the recorder. - - 3 - - - - Current state of the recorder. - - 3 - - - - true if the state changed by policy such as Resource Conflict or Security, otherwise false - in normal state change. - - 3 - - - - An extended EventArgs class which contains details about error status and - state of the recorder when it failed. - - - - - The error code. - - 3 - - - - The state of the recorder. - - 3 - - - - An extended EventArgs class containing details about the recording limit. - - - - - The limitation type. - - 3 - - - - An extened EventArgs class which contain the details of current recording status. - - - - - The time of recording in milliseconds. - - 3 - - - - The size of the recording file in Kilobyte. - - 3 - - - + + + + Tizen.Multimedia.Recorder + + + + + An extended EventArgs class containing details of audio stream. + + + + + The audio stream data. + + 3 + + + + The length of audio stream data. + + 3 + + + + The audio format type. + + 3 + + + + The number of channels. + + 3 + + + + The recording time of the stream buffer in milliseconds. + + 3 + + + + An extended EventArgs class containing details of muxed stream(Audio + Video). + + + + + The muexed stream data. + + 3 + + + + The length of muxed stream data. + + 3 + + + + The offset of the stream data. + + 3 + + + + The recorder class provides methods to create audio/video recorder, + to start, stop and save the recorded content. It also provides methods + to get/set various attributes and capabilities of recorder. + + + + + Audio recorder constructor. + + + + + Video recorder constructor. + + + The camera object. + + + + + Recorder destructor. + + + + + Releases the unmanaged resources used by the Recorder. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the Recorder. + + 3 + + + + Event that occurs when an error occurs during recorder operation. + + 3 + + + + Event that occurs when recorder is interrupted. + + 3 + + + + This event occurs when recorder state is changed. + + 3 + + + + Event that occurs when recording information changes. + + 3 + + + + Event that occurs when audio stream data is being delivered. + + 3 + + + + Event that occurs when recording limit is reached. + + 3 + + + + Event that occurs when muxed stream data is being delivered. + + 3 + + + + Gets the various recorder features. + + 3 + + + + Get/Set the various recorder settings. + + 3 + + + + The current state of the recorder. + + 3 + A that specifies the state of recorder. + The camera already has been disposed. + + + + Prepare the media recorder for recording. + The recorder must be in the state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + + Before calling the function, it is required to set AudioEncoder, + videoencoder and fileformat properties of recorder. + + In case of any invalid operations. + The camera already has been disposed. + + + + Resets the media recorder. + The recorder must be in the state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + In case of any invalid operations. + The camera already has been disposed. + + + + Starts the recording. + The recorder must be in the state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + + If file path has been set to an existing file, this file is removed automatically and updated by new one. + In the video recorder, some preview format does not support record mode. It will return InvalidOperation error. + You should use default preview format or CameraPixelFormatNv12 in the record mode. + The filename should be set before this function is invoked. + + + http://tizen.org/privilege/recorder + + In case of any invalid operations. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Pause the recording. + The recorder must be in the state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + + Recording can be resumed with Start(). + + + http://tizen.org/privilege/recorder + + In case of any invalid operations. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Stops recording and saves the result. + The recorder must be in the or state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + + http://tizen.org/privilege/recorder + + In case of any invalid operations. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Cancels the recording. + The recording data is discarded and not written in the recording file. + The recorder must be in the or state. + After this method is finished without any exception, + The state of recorder will be changed to state. + + 3 + + http://tizen.org/privilege/recorder + + In case of any invalid operations. + The camera already has been disposed. + In case of access to the resources cannot be granted. + + + + Sets the audio stream policy. + + 3 + Policy. + The camera already has been disposed. + + + + Enumeration for Audio Codec. + + 3 + + + + Disable Audio track. + + + + + AMR codec. + + + + + AAC codec. + + + + + Vorbis codec. + + + + + PCM codec. + + + + + The mp3 codec. + + + + + Enumeration for Audio capture devices. + + 3 + + + + Capture audio from Mic device. + + + + + Capture audio from modem. + + + + + Enumeration for the file container format. + + 3 + + + + 3GP file format. + + + + + MP4 file format. + + + + + AMR file format. + + + + + ADTS file format. + + + + + WAV file format. + + + + + OGG file format. + + + + + M2TS file format. + + + + + Enumeration for the recorder policy. + + 3 + + + + None. + + + + + Security policy. + + + + + Resource conflict policy. + + + + + Enumeration for the recording limit. + + 3 + + + + Time limit in seconds of recording file + + + + + Size limit in KB(KiloBytes) of recording file. + + + + + No free space in storage. + + + + + Enumeration for recorder states. + + 3 + + + + Recorder is not created. + + + + + Recorder is created, but not prepared. + + + + + Recorder is ready to record. In case of video recorder, + preview display will be shown. + + + + + Recorder is recording media. + + + + + Recorder is paused while recording media. + + + + + Enumeration for video codec. + + 3 + + + + H263 codec. + + + + + H264 codec. + + + + + MPEG4 codec. + + + + + Theora codec. + + + + + Enumeration for recorder failure error. + + 3 + + + + Device Error. + + + + + Internal error. + + + + + Out of memory. + + + + + The camera setting class provides methods/properties to get and + set basic camera attributes. + + + + + Retrieves all the file formats supported by the recorder. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the audio encoders supported by the recorder. + + 3 + + It returns a list containing all the supported . + + The camera already has been disposed. + + + + Retrieves all the video encoders supported by the recorder. + + 3 + + It returns a list containing all the supported . + by recorder. + + The camera already has been disposed. + + + + Retrieves all the video resolutions supported by the recorder. + + 3 + + It returns videoresolution list containing the width and height of + different resolutions supported by recorder. + + The camera already has been disposed. + + + + An extended Eventargs class which contains interrupted policy details, previous and current + state of the recorder. + + + + + The policy that interrupted the recorder. + + 3 + + + + The previous state of the recorder. + + 3 + + + + The current state of the recorder. + + 3 + + + + The camera setting class provides methods/properties to get and + set basic camera attributes. + + + + + The number of audio channel. + + 3 + + For mono recording, set channel to 1. + For stereo recording, set channel to 2. + + The camera already has been disposed. + + + + The audio device for recording. + + 3 + A that specifies the type of audio device. + The camera already has been disposed. + + + + Get the peak audio input level in dB + + 3 + + 0dB indicates maximum input level, -300dB indicates minimum input level. + + The camera already has been disposed. + + + + The sampling rate of an audio stream in hertz. + + 3 + The camera already has been disposed. + + + + The bitrate of an audio encoder in bits per second. + + 3 + The camera already has been disposed. + + + + The bitrate of an video encoder in bits per second. + + 3 + The camera already has been disposed. + + + + The audio codec for encoding an audio stream. + + 3 + A that specifies the type of audio codec. + The camera already has been disposed. + + + + The video codec for encoding video stream. + + 3 + A that specifies the type of video codec. + The camera already has been disposed. + + + + The file format for recording media stream. + + 3 + A that specifies the file format. + The camera already has been disposed. + + + + The file path to record. + + 3 + + If the same file already exists in the file system, then old file + will be overwritten. + + The camera already has been disposed. + + + + The maximum size of a recording file in KB(kilobytes). If 0, means + unlimited recording size. + + 3 + + After reaching the limitation, the data which is being recorded will + be discarded and not written to the file. + The recorder state must be in 'Ready' or 'Created' state. + + The camera already has been disposed. + + + + The time limit of a recording file in Seconds. If 0, means unlimited recording + time. + + 3 + + After reaching the limitation, the data which is being recorded will + be discarded and not written to the file. + The recorder state must be in 'Ready' or 'Created' state. + + The camera already has been disposed. + + + + The mute state of a recorder. + + 3 + The camera already has been disposed. + + + + The video recording motion rate + + 3 + + The attribute is valid only in a video recorder. + If the rate is in range of 0-1, video is recorded in a slow motion mode. + If the rate is bigger than 1, video is recorded in a fast motion mode. + + The camera already has been disposed. + + + + The orientation in a video metadata tag. + + 3 + A that specifies the type of orientation. + The camera already has been disposed. + + + + Resolution of the video. + + 3 + In case of invalid parameters + The camera already has been disposed. + + + + An extended EventArgs class which contains details about previous and current state + of the recorder when its state is changed. + + + + + Previous state of the recorder. + + 3 + + + + Current state of the recorder. + + 3 + + + + true if the state changed by policy such as Resource Conflict or Security, otherwise false + in normal state change. + + 3 + + + + An extended EventArgs class which contains details about error status and + state of the recorder when it failed. + + + + + The error code. + + 3 + + + + The state of the recorder. + + 3 + + + + An extended EventArgs class containing details about the recording limit. + + + + + The limitation type. + + 3 + + + + An extened EventArgs class which contain the details of current recording status. + + + + + The time of recording in milliseconds. + + 3 + + + + The size of the recording file in Kilobyte. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Remoting.dll b/Artifacts/bin/Tizen.Multimedia.Remoting.dll index a2862d3..c8edb77 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Remoting.dll and b/Artifacts/bin/Tizen.Multimedia.Remoting.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Remoting.pdb b/Artifacts/bin/Tizen.Multimedia.Remoting.pdb index 6bca94c..8bcfba5 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Remoting.pdb and b/Artifacts/bin/Tizen.Multimedia.Remoting.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Remoting.xml b/Artifacts/bin/Tizen.Multimedia.Remoting.xml index 6b7944e..c93ac17 100644 --- a/Artifacts/bin/Tizen.Multimedia.Remoting.xml +++ b/Artifacts/bin/Tizen.Multimedia.Remoting.xml @@ -1,1159 +1,1159 @@ - - - - Tizen.Multimedia.Remoting - - - - - CustomCommandRecieved event arguments - - - CustomCommandRecieved event arguments - - - - - Get the Client Name. - - 3 - - - - Get the Custom Command. - - 3 - - - - Get the Bundle Data. - - 3 - - - - CustomCommandRecieved event arguments - - - CustomCommandRecieved event arguments - - - - - Get the Sserver Name. - - 3 - - - - Get the Result. - - 3 - - - - Get the Bundle Data. - - 3 - - - - The MediaControllerClient class provides APIs required for media-controller-client. - - - http://tizen.org/privilege/mediacontroller.client - - - The MediaControllerClient APIs provides functions to get media information from server. - - - - - The constructor of MediaControllerClient class. - - 3 - Thrown when the operation is invalid for the current state - Thrown when the access is denied for media controller client - - - - ServerUpdated event is raised when server is changed - - 3 - - - - PlaybackUpdated event is raised when playback is changed - - 3 - - - - MetadataUpdated event is raised when metadata is changed - - 3 - - - - ShuffleModeUpdated event is raised when shuffle mode is changed - - 3 - - - - RepeatModeUpdated event is raised when server is changed - - 3 - - - - CommandReply event is raised when reply for command is recieved - - 3 - - - - gets latest server information - 3 - The name and state of the latest media controller server application: ServerInformation object - Thrown when the operation is invalid for the current state - - - - gets playback information for specific server - 3 - Server Name - The playback state and playback position of the specific media controller server application:MediaControllerPlayback object - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - gets metadata information for specific server - 3 - Server Name - The metadata information of the specific media controller server application:MediaControllerMetadata object - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - gets shuffle mode for specific server - 3 - Server Name - The shuffle mode of the specific media controller server application:MediaControllerShuffleMode enum - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - gets repeat mode for specific server \ - 3 - Server Name - The repeat mode of the specific media controller server application:MediaControllerRepeatMode enum - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Send command of playback state to server application - Server Name - Playback State - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Send customized command to server application - 3 - Server Name - Command - Bundle data - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Subscribe subscription type from specific server application - 3 - Subscription Type - Server Name - Thrown when an invalid argument is used - - - - Subscribe subscription type from specific server application - 3 - Subscription Type - Server Name - Thrown when an invalid argument is used - - - - gets activated server list - 3 - The list of activated media controller server applications: IEnumerable of string - - - - gets subscribed server list - 3 - Subscription Type - The list of subscribed media controller server applications: IEnumerable of string - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Specifies states that a can have. - - - - - Server state is unknown - - 3 - - - - Server is activated - - 3 - - - - Server is deactivated - - 3 - - - - Enumeration for playback state - - - - - Playback state is unknown - - 3 - - - - Playback is playing - - 3 - - - - Playback is paused - - 3 - - - - Playback is next - - 3 - - - - Playback is prev - - 3 - - - - Playback is fastforward - - 3 - - - - Playback is rewind - - 3 - - - - Enumeration for shuffle mode - - - - - Shuffle mode is On - - 3 - - - - Shuffle mode is Off - - 3 - - - - Enumeration for repeat mode - - - - - Repeat mode is On - - 3 - - - - Repeat mode is Off - - 3 - - - - Enumeration for repeat mode - - - - - The type of subscription is the state of server - - 3 - - - - The type of subscription is the playback - - 3 - - - - The type of subscription is the metadata - - 3 - - - - The type of subscription is the shuffle mode - - 3 - - - - The type of subscription is the repeat mode - - 3 - - - - Enumeration for metadata attributes - - - - - Attribute is title - - 3 - - - - Attribute is artist - - 3 - - - - Attribute is album - - 3 - - - - Attribute is author - - 3 - - - - Attribute is genre - - 3 - - - - Attribute is duration - - 3 - - - - Attribute is date - - 3 - - - - Attribute is copyright - - 3 - - - - Attribute is description - - 3 - - - - Attribute is track number - - 3 - - - - Attribute is picture - - 3 - - - - Metadata represents a metadata of media for server application to play - - - - - The constructor of MediaControllerMetadata class. - - 3 - - - - Set/Get the Title of media - - 3 - - - - Set/Get the Artist of media - - 3 - - - - Set/Get the Album of media - - 3 - - - - Set/Get the Author of media - - 3 - - - - Set/Get the Genre of media - - 3 - - - - Set/Get the Duration of media - - 3 - - - - Set/Get the Date of media - - 3 - - - - Set/Get the Copyright of media - - 3 - - - - Set/Get the Description of media - - 3 - - - - Set/Get the Track Number of media - - 3 - - - - Set/Get the Picture of media - - 3 - - - - Playback represents a playback state and playback position. - - - - - The constructor of MediaControllerPlayback class. - - 3 - - The state of the playback which is playing in MediaConttoller server application - - - The position of the playback which is playing in MediaConttoller server application - - - - - Set/Get the State of playback information - - 3 - - - - Set/Get the Position of playback information - - 3 - - - - The MediaControllerServer class provides APIs required for media-controller-server. - - - http://tizen.org/privilege/mediacontroller.server - - - The MediaControllerServer APIs provides functions to update media information. - - - - - The constructor of MediaControllerServer class. - - 3 - Thrown when the operation is invalid for the current state - Thrown when the access is denied for media controller client - - - - PlaybackStateCommandRecieved event is raised when client send command for playback - - 3 - - - - CustomCommandRecieved event is raised when client send customized command - - 3 - - - - Update playback state and playback position - 3 - playback state and playback position - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Update metadata information - 3 - metadata information - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Update shuffle mode - 3 - shuffle mode - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Update repeat mode - 3 - repeat mode - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - Send reply for command from server to client - 3 - client name to recieve reply - result to run command - Bundle to send various data - Thrown when an invalid argument is used - Thrown when the operation is invalid for the current state - - - - MetadataUpdated event arguments - - - MetadataUpdated event arguments - - - - - Get the Server Name. - - 3 - - - - Get the Metadata information. - - 3 - - - - PlaybackStateCommand event arguments - - - PlaybackStateCommand event arguments - - - - - Get the Client Name. - - 3 - - - - Get the State of playback. - - 3 - - - - PlaybackUpdated event arguments - - - PlaybackUpdated event arguments - - - - - Get the Server Name. - - 3 - - - - Get the Playback Information. - - 3 - - - - RepeatModeUpdated event arguments - - - RepeatModeUpdated event arguments - - - - - Get the Server Name. - - 3 - - - - Get the Repeat Mode. - - 3 - - - - ServerInformation represents a name and state of server application. - - - - - Get the Name of server - - 3 - - - - Get the State of server - - 3 - - - - ServerUpdated event arguments - - - ServerUpdated event arguments - - - - - Get the Server Information. - - 3 - - - - ShuffleModeUpdated event arguments - - - ShuffleModeUpdated event arguments - - - - - Get the Server Name. - - 3 - - - - Get the Shuffle Mode. - - 3 - - - - Provides data for the event. - - - - - Gets the current state of screen mirroring. - - - - - Provides data for the event. - - - - - Gets the error that occurred. - - - - - Provides the ability to connect to and disconnect from a screen mirroring source, - start, pause, and resume the screen mirroring as a sink. - - - - - Initializes a new instance of the ScreenMirroring class. - - http://tizen.org/feature/network.wifi.direct.display - The feature is not supported. - - - - Occurs when the state is changed. - - - - - Occurs when an error occurs. - - - - - Gets the negotiated audio info. - - - - - Gets the negotiated video info. - - - - - Prepares the screen mirroring with the specified display. - - - The state must be .\n - \n - All supported resolutions will be candidates. - - The display where the mirroring will be played on. - - has already been assigned to another. - - is null. - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - - - - Prepares the screen mirroring with the specified display and resolutions. - - - The state must be . - - The display where the mirroring will be played on. - The desired resolutions. - - contain invalid flags.\n - -or-\n - has already been assigned to another. - - is null. - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - - - - Creates the connection and ready for receiving data from a mirroring source. - - The source ip address to connect. - - The state must be state by - . - - A task that represents the asynchronous operation. - http://tizen.org/privilege/internet - is null. - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - is a zero-length string, contains only white space. - The has already been disposed. - Caller does not have required permission. - - - - Starts mirroring from the source. - - - The state must be state by - . - - A task that represents the asynchronous operation. - http://tizen.org/privilege/internet - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - Caller does not have required permission. - - - - Pauses mirroring from the source. - - - The state must be state by - . - - A task that represents the asynchronous operation. - http://tizen.org/privilege/internet - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - Caller does not have required permission. - - - - Resumes mirroring from the source. - - - The state must be state by - . - - A task that represents the asynchronous operation. - http://tizen.org/privilege/internet - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - Caller does not have required permission. - - - - Disconnects from the source. - - - The state must be , - or . - - http://tizen.org/privilege/internet - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - Caller does not have required permission. - - - - Unprepares the screen mirroring. - - - The state must be , - or . - - - The current state is not in the valid.\n - -or-\n - An internal error occurs. - - The has already been disposed. - - - - - Releases the resources used by the ScreenMirroring. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Provides a means to retrieve the audio information which is negotiated with the source device. - - - - - - Gets the negotiated audio codec. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Gets the negotiated audio channels. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Gets the negotiated audio sample rate. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Gets the negotiated audio bit width. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Specifies audio codecs for . - - - - - - Screen mirroring is not negotiated yet. - - - - - AAC codec for audio. - - - - - AC3 codec for audio. - - - - - LPCM codec for audio. - - - - - Specifies video codecs for . - - - - - - Screen mirroring is not negotiated yet. - - - - - H.264 codec for video. - - - - - Specifies available combinations of resolutions and fps for . - - - - - W-1920, H-1080, 30 fps. - - - - - W-1280, H-720, 30 fps. - - - - - W-960, H-540, 30 fps. - - - - - W-864, H-480, 30 fps. - - - - - W-720, H-480, 60 fps. - - - - - W-640, H-480, 60 fps. - - - - - W-640, H-360, 30 fps. - - - - - Specifies the states of . - - - - - Idle. - - - - - Prepared. - - - - - - Connected to a source. - - - - - - Playing. - - - - - - Paused while playing media. - - - - - - Disconnected from source. - - - - - - Specifies errors for . - - - - - Invalid operation. - - - - - Provides a means to retrieve the video information which is negotiated with the source device. - - - - - Gets the negotiated video codec. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Gets the negotiated video resolution. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - - Gets the negotiated video frame rate. - - - Not connected to a source.\n - \n - An internal error occurs. - - The has already been disposed. - - - + + + + Tizen.Multimedia.Remoting + + + + + CustomCommandRecieved event arguments + + + CustomCommandRecieved event arguments + + + + + Get the Client Name. + + 3 + + + + Get the Custom Command. + + 3 + + + + Get the Bundle Data. + + 3 + + + + CustomCommandRecieved event arguments + + + CustomCommandRecieved event arguments + + + + + Get the Sserver Name. + + 3 + + + + Get the Result. + + 3 + + + + Get the Bundle Data. + + 3 + + + + The MediaControllerClient class provides APIs required for media-controller-client. + + + http://tizen.org/privilege/mediacontroller.client + + + The MediaControllerClient APIs provides functions to get media information from server. + + + + + The constructor of MediaControllerClient class. + + 3 + Thrown when the operation is invalid for the current state + Thrown when the access is denied for media controller client + + + + ServerUpdated event is raised when server is changed + + 3 + + + + PlaybackUpdated event is raised when playback is changed + + 3 + + + + MetadataUpdated event is raised when metadata is changed + + 3 + + + + ShuffleModeUpdated event is raised when shuffle mode is changed + + 3 + + + + RepeatModeUpdated event is raised when server is changed + + 3 + + + + CommandReply event is raised when reply for command is recieved + + 3 + + + + gets latest server information + 3 + The name and state of the latest media controller server application: ServerInformation object + Thrown when the operation is invalid for the current state + + + + gets playback information for specific server + 3 + Server Name + The playback state and playback position of the specific media controller server application:MediaControllerPlayback object + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + gets metadata information for specific server + 3 + Server Name + The metadata information of the specific media controller server application:MediaControllerMetadata object + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + gets shuffle mode for specific server + 3 + Server Name + The shuffle mode of the specific media controller server application:MediaControllerShuffleMode enum + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + gets repeat mode for specific server \ + 3 + Server Name + The repeat mode of the specific media controller server application:MediaControllerRepeatMode enum + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Send command of playback state to server application + Server Name + Playback State + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Send customized command to server application + 3 + Server Name + Command + Bundle data + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Subscribe subscription type from specific server application + 3 + Subscription Type + Server Name + Thrown when an invalid argument is used + + + + Subscribe subscription type from specific server application + 3 + Subscription Type + Server Name + Thrown when an invalid argument is used + + + + gets activated server list + 3 + The list of activated media controller server applications: IEnumerable of string + + + + gets subscribed server list + 3 + Subscription Type + The list of subscribed media controller server applications: IEnumerable of string + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Specifies states that a can have. + + + + + Server state is unknown + + 3 + + + + Server is activated + + 3 + + + + Server is deactivated + + 3 + + + + Enumeration for playback state + + + + + Playback state is unknown + + 3 + + + + Playback is playing + + 3 + + + + Playback is paused + + 3 + + + + Playback is next + + 3 + + + + Playback is prev + + 3 + + + + Playback is fastforward + + 3 + + + + Playback is rewind + + 3 + + + + Enumeration for shuffle mode + + + + + Shuffle mode is On + + 3 + + + + Shuffle mode is Off + + 3 + + + + Enumeration for repeat mode + + + + + Repeat mode is On + + 3 + + + + Repeat mode is Off + + 3 + + + + Enumeration for repeat mode + + + + + The type of subscription is the state of server + + 3 + + + + The type of subscription is the playback + + 3 + + + + The type of subscription is the metadata + + 3 + + + + The type of subscription is the shuffle mode + + 3 + + + + The type of subscription is the repeat mode + + 3 + + + + Enumeration for metadata attributes + + + + + Attribute is title + + 3 + + + + Attribute is artist + + 3 + + + + Attribute is album + + 3 + + + + Attribute is author + + 3 + + + + Attribute is genre + + 3 + + + + Attribute is duration + + 3 + + + + Attribute is date + + 3 + + + + Attribute is copyright + + 3 + + + + Attribute is description + + 3 + + + + Attribute is track number + + 3 + + + + Attribute is picture + + 3 + + + + Metadata represents a metadata of media for server application to play + + + + + The constructor of MediaControllerMetadata class. + + 3 + + + + Set/Get the Title of media + + 3 + + + + Set/Get the Artist of media + + 3 + + + + Set/Get the Album of media + + 3 + + + + Set/Get the Author of media + + 3 + + + + Set/Get the Genre of media + + 3 + + + + Set/Get the Duration of media + + 3 + + + + Set/Get the Date of media + + 3 + + + + Set/Get the Copyright of media + + 3 + + + + Set/Get the Description of media + + 3 + + + + Set/Get the Track Number of media + + 3 + + + + Set/Get the Picture of media + + 3 + + + + Playback represents a playback state and playback position. + + + + + The constructor of MediaControllerPlayback class. + + 3 + + The state of the playback which is playing in MediaConttoller server application + + + The position of the playback which is playing in MediaConttoller server application + + + + + Set/Get the State of playback information + + 3 + + + + Set/Get the Position of playback information + + 3 + + + + The MediaControllerServer class provides APIs required for media-controller-server. + + + http://tizen.org/privilege/mediacontroller.server + + + The MediaControllerServer APIs provides functions to update media information. + + + + + The constructor of MediaControllerServer class. + + 3 + Thrown when the operation is invalid for the current state + Thrown when the access is denied for media controller client + + + + PlaybackStateCommandRecieved event is raised when client send command for playback + + 3 + + + + CustomCommandRecieved event is raised when client send customized command + + 3 + + + + Update playback state and playback position + 3 + playback state and playback position + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Update metadata information + 3 + metadata information + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Update shuffle mode + 3 + shuffle mode + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Update repeat mode + 3 + repeat mode + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + Send reply for command from server to client + 3 + client name to recieve reply + result to run command + Bundle to send various data + Thrown when an invalid argument is used + Thrown when the operation is invalid for the current state + + + + MetadataUpdated event arguments + + + MetadataUpdated event arguments + + + + + Get the Server Name. + + 3 + + + + Get the Metadata information. + + 3 + + + + PlaybackStateCommand event arguments + + + PlaybackStateCommand event arguments + + + + + Get the Client Name. + + 3 + + + + Get the State of playback. + + 3 + + + + PlaybackUpdated event arguments + + + PlaybackUpdated event arguments + + + + + Get the Server Name. + + 3 + + + + Get the Playback Information. + + 3 + + + + RepeatModeUpdated event arguments + + + RepeatModeUpdated event arguments + + + + + Get the Server Name. + + 3 + + + + Get the Repeat Mode. + + 3 + + + + ServerInformation represents a name and state of server application. + + + + + Get the Name of server + + 3 + + + + Get the State of server + + 3 + + + + ServerUpdated event arguments + + + ServerUpdated event arguments + + + + + Get the Server Information. + + 3 + + + + ShuffleModeUpdated event arguments + + + ShuffleModeUpdated event arguments + + + + + Get the Server Name. + + 3 + + + + Get the Shuffle Mode. + + 3 + + + + Provides data for the event. + + + + + Gets the current state of screen mirroring. + + + + + Provides data for the event. + + + + + Gets the error that occurred. + + + + + Provides the ability to connect to and disconnect from a screen mirroring source, + start, pause, and resume the screen mirroring as a sink. + + + + + Initializes a new instance of the ScreenMirroring class. + + http://tizen.org/feature/network.wifi.direct.display + The feature is not supported. + + + + Occurs when the state is changed. + + + + + Occurs when an error occurs. + + + + + Gets the negotiated audio info. + + + + + Gets the negotiated video info. + + + + + Prepares the screen mirroring with the specified display. + + + The state must be .\n + \n + All supported resolutions will be candidates. + + The display where the mirroring will be played on. + + has already been assigned to another. + + is null. + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + + + + Prepares the screen mirroring with the specified display and resolutions. + + + The state must be . + + The display where the mirroring will be played on. + The desired resolutions. + + contain invalid flags.\n + -or-\n + has already been assigned to another. + + is null. + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + + + + Creates the connection and ready for receiving data from a mirroring source. + + The source ip address to connect. + + The state must be state by + . + + A task that represents the asynchronous operation. + http://tizen.org/privilege/internet + is null. + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + is a zero-length string, contains only white space. + The has already been disposed. + Caller does not have required permission. + + + + Starts mirroring from the source. + + + The state must be state by + . + + A task that represents the asynchronous operation. + http://tizen.org/privilege/internet + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + Caller does not have required permission. + + + + Pauses mirroring from the source. + + + The state must be state by + . + + A task that represents the asynchronous operation. + http://tizen.org/privilege/internet + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + Caller does not have required permission. + + + + Resumes mirroring from the source. + + + The state must be state by + . + + A task that represents the asynchronous operation. + http://tizen.org/privilege/internet + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + Caller does not have required permission. + + + + Disconnects from the source. + + + The state must be , + or . + + http://tizen.org/privilege/internet + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + Caller does not have required permission. + + + + Unprepares the screen mirroring. + + + The state must be , + or . + + + The current state is not in the valid.\n + -or-\n + An internal error occurs. + + The has already been disposed. + + + + + Releases the resources used by the ScreenMirroring. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Provides a means to retrieve the audio information which is negotiated with the source device. + + + + + + Gets the negotiated audio codec. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Gets the negotiated audio channels. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Gets the negotiated audio sample rate. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Gets the negotiated audio bit width. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Specifies audio codecs for . + + + + + + Screen mirroring is not negotiated yet. + + + + + AAC codec for audio. + + + + + AC3 codec for audio. + + + + + LPCM codec for audio. + + + + + Specifies video codecs for . + + + + + + Screen mirroring is not negotiated yet. + + + + + H.264 codec for video. + + + + + Specifies available combinations of resolutions and fps for . + + + + + W-1920, H-1080, 30 fps. + + + + + W-1280, H-720, 30 fps. + + + + + W-960, H-540, 30 fps. + + + + + W-864, H-480, 30 fps. + + + + + W-720, H-480, 60 fps. + + + + + W-640, H-480, 60 fps. + + + + + W-640, H-360, 30 fps. + + + + + Specifies the states of . + + + + + Idle. + + + + + Prepared. + + + + + + Connected to a source. + + + + + + Playing. + + + + + + Paused while playing media. + + + + + + Disconnected from source. + + + + + + Specifies errors for . + + + + + Invalid operation. + + + + + Provides a means to retrieve the video information which is negotiated with the source device. + + + + + Gets the negotiated video codec. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Gets the negotiated video resolution. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + + Gets the negotiated video frame rate. + + + Not connected to a source.\n + \n + An internal error occurs. + + The has already been disposed. + + + diff --git a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.dll b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.dll index 23ef06a..77ec95a 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.dll and b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.pdb b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.pdb index 802f326..0ecc7a6 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.pdb and b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.xml b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.xml index 5a0b2be..ef7c369 100644 --- a/Artifacts/bin/Tizen.Multimedia.StreamRecorder.xml +++ b/Artifacts/bin/Tizen.Multimedia.StreamRecorder.xml @@ -1,619 +1,619 @@ - - - - Tizen.Multimedia.StreamRecorder - - - - - Provides methods to control stream recorder. - - - StreamRecorder class provides functions to record raw image frame - also provides recording start, stop and save the content etc. - - - - - Occurred when recording is progressing for recording status. - - - - - Occurred when recording time or size reach limit. - - - - - Occurred when streamrecorder complete to use pushed buffer. - - - - - Occurred when streamrecorder state is changed. - - - - - Occurred when error is occured. - - - - - Stream recorder constructor. - - - - - Stream recorder destructor. - - - - - Event that occurs when streamrecorder state is changed. - - - - - Event that occurs when buffer had comsumed completely. - - - - - Event that occurs when recording status changed. - - - - - Event that occurs when recording limit is reached. - - - - - Event that occurs when an error occured during recorder operation. - - - - - The file path to record. - - - If the same file already exists in the file system, then old file - will be overwritten. - - - - - - Get/Set the file format for recording media stream. - - - Must set . - The recorder state must be state. - - The format does not valid. - - - - - The audio codec for encoding an audio stream. - - - Must set or - by - - The codec does not valid. - - - - - The video codec for encoding video stream. - - - Must set or - by - - The codec does not valid. - - - - - The maximum size of a recording file in KB(kilobytes). If 0, means - unlimited recording size. - - - After reaching the limitation, the data which is being recorded will - be discarded and not written to the file. - The recorder state must be state. - - The value set to below 0. - - - - - The time limit of a recording file in Seconds. If 0, means unlimited recording - time. - - - After reaching the limitation, the data which is being recorded will - be discarded and not written to the file. - The recorder state must be state. - - The value set to below 0. - - - - - The sampling rate of an audio stream in hertz. - - - The recorder state must be state. - Must set or - by . - - The value set to below 0. - - - - The bitrate of an audio encoder in bits per second. - - - The recorder state must be state. - Must set or - by - - The value set to below 0. - - - - The bitrate of an video encoder in bits per second. - - - The recorder state must be state. - Must set or - by - - The value set to below 0. - - - - The video frame rate for recording media stream. - - - The recorder state must be state. - Must set or - by - - The value set to below 0. - - - - Get or Set the video source format for recording media stream. - - The value set to a invalid value. - - - - - The number of audio channel. - - - The attribute is applied only in Created state. - For mono recording, set channel to 1. - For stereo recording, set channel to 2. - The recorder state must be state. - - The value set to a invalid value. - - - - Video resolution of the video recording. - - - Must set or - by - The recorder state must be state. - - The value set to a invalid value. - - - - - Retrieves all the file formats supported by the stream recorder. - - - It returns a list containing all the supported file - formats by Stream recorder. - - - - - - Retrieves all the audio encoders supported by the recorder. - - - It returns a list containing all the supported audio encoders - by recorder. - - - - - - Retrieves all the video encoders supported by the recorder. - - - It returns a list containing all the supported video encoders - by recorder. - - - - - - Retrieves all the video resolutions supported by the recorder. - - - It returns videoresolution list containing the width and height of - different resolutions supported by recorder. - - - - - - Prepare the stream recorder. - - - Before calling the function, it is required to set , - , and properties of recorder. - - The streamrecorder is not in the valid state. - - - - - Resets the stream recorder. - - - The recorder state must be state by , and . - The StreamRecorder state will be . - - The streamrecorder is not in the valid state. - - - - - Starts the recording. - - - If file path has been set to an existing file, this file is removed automatically and updated by new one. - The filename should be set before this function is invoked. - The recorder state must be state by or - state by . - The filename shuild be set by - - The streamrecorder is not in the valid state. - The access ot the resources can not be granted. - - - - - - - - - Pause the recording. - - - Recording can be resumed with . - - The streamrecorder is not in the valid state. - - - - - - - Stops recording and saves the result. - - - The recorder state must be state by or - state by - When you want to record audio or video file, you need to add privilege according to rules below additionally. - - http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - - - The streamrecorder is not in the valid state. - The access ot the resources can not be granted. - - - - - - Cancels the recording. - The recording data is discarded and not written in the recording file. - - - - - - - Push stream buffer as recording raw data. - - - - - Set the source type of pushed data. - - - - - Release any unmanaged resources used by this object. - - - - - Enumeration for Audio Codec. - - - - - AMR codec. - - - - - AAC codec. - - - - - PCM codec. - - - - - Enumeration for the file container format. - - - - - 3GP file format. - - - - - MP4 file format. - - - - - AMR file format. - - - - - ADTS file format. - - - - - WAV file format. - - - - - Enumeration for the recorder notify type. - - - - - None. - - - - - State changed noti. - - - - - Enumeration for the recording limit type. - - - - - Time limit in seconds of recording file - - - - - Size limit in KB(KiloBytes) of recording file. - - - - - Enumeration for stream recorder states. - - - - - Stream recorder is not created. - - - - - Stream recorder is created, but not prepared. - - - - - Stream recorder is ready to record. - - - - - Stream recorder is recording pushed packet. - - - - - Stream recorder is paused. - - - - - Enumeration for video codec. - - - - - H263 codec. - - - - - MPEG4 codec. - - - - - Enumeration for source type. - - - - - Video source - - - - - Audio source - - - - - Audio/Video both - - - - - Enumeration for video source format. - - - - - Nv12 Video source format - - - - - Nv21 video source format - - - - - I420 video source format - - - - - Enumeration for stream recorder failure error. - - - - - Sucessful. - - - - - Internal error. - - - - - Internal error. - - - - - Out of memory. - - - - - An extended Eventargs class which contains interrupted policy details, previous and current - state of the recorder. - - - - - The previous state of the stream recorder. - - - - - The current state of the stream recorder. - - - - - The notify of the event. - - - - - Resolution for stream recorder. - - - - - The video width. - - The width. - - - - The video height. - - The height. - - - - An extended EventArgs. - - - - - Consumed buffer. - - - - - An extended EventArgs class which contains details about error status and - state of the recorder when it failed. - - - - - The error code. - - - - - The state of the recorder. - - - - - An extended EventArgs class containing details about the recording limit. - - - - - The limitation type. - - - - + + + + Tizen.Multimedia.StreamRecorder + + + + + Provides methods to control stream recorder. + + + StreamRecorder class provides functions to record raw image frame + also provides recording start, stop and save the content etc. + + + + + Occurred when recording is progressing for recording status. + + + + + Occurred when recording time or size reach limit. + + + + + Occurred when streamrecorder complete to use pushed buffer. + + + + + Occurred when streamrecorder state is changed. + + + + + Occurred when error is occured. + + + + + Stream recorder constructor. + + + + + Stream recorder destructor. + + + + + Event that occurs when streamrecorder state is changed. + + + + + Event that occurs when buffer had comsumed completely. + + + + + Event that occurs when recording status changed. + + + + + Event that occurs when recording limit is reached. + + + + + Event that occurs when an error occured during recorder operation. + + + + + The file path to record. + + + If the same file already exists in the file system, then old file + will be overwritten. + + + + + + Get/Set the file format for recording media stream. + + + Must set . + The recorder state must be state. + + The format does not valid. + + + + + The audio codec for encoding an audio stream. + + + Must set or + by + + The codec does not valid. + + + + + The video codec for encoding video stream. + + + Must set or + by + + The codec does not valid. + + + + + The maximum size of a recording file in KB(kilobytes). If 0, means + unlimited recording size. + + + After reaching the limitation, the data which is being recorded will + be discarded and not written to the file. + The recorder state must be state. + + The value set to below 0. + + + + + The time limit of a recording file in Seconds. If 0, means unlimited recording + time. + + + After reaching the limitation, the data which is being recorded will + be discarded and not written to the file. + The recorder state must be state. + + The value set to below 0. + + + + + The sampling rate of an audio stream in hertz. + + + The recorder state must be state. + Must set or + by . + + The value set to below 0. + + + + The bitrate of an audio encoder in bits per second. + + + The recorder state must be state. + Must set or + by + + The value set to below 0. + + + + The bitrate of an video encoder in bits per second. + + + The recorder state must be state. + Must set or + by + + The value set to below 0. + + + + The video frame rate for recording media stream. + + + The recorder state must be state. + Must set or + by + + The value set to below 0. + + + + Get or Set the video source format for recording media stream. + + The value set to a invalid value. + + + + + The number of audio channel. + + + The attribute is applied only in Created state. + For mono recording, set channel to 1. + For stereo recording, set channel to 2. + The recorder state must be state. + + The value set to a invalid value. + + + + Video resolution of the video recording. + + + Must set or + by + The recorder state must be state. + + The value set to a invalid value. + + + + + Retrieves all the file formats supported by the stream recorder. + + + It returns a list containing all the supported file + formats by Stream recorder. + + + + + + Retrieves all the audio encoders supported by the recorder. + + + It returns a list containing all the supported audio encoders + by recorder. + + + + + + Retrieves all the video encoders supported by the recorder. + + + It returns a list containing all the supported video encoders + by recorder. + + + + + + Retrieves all the video resolutions supported by the recorder. + + + It returns videoresolution list containing the width and height of + different resolutions supported by recorder. + + + + + + Prepare the stream recorder. + + + Before calling the function, it is required to set , + , and properties of recorder. + + The streamrecorder is not in the valid state. + + + + + Resets the stream recorder. + + + The recorder state must be state by , and . + The StreamRecorder state will be . + + The streamrecorder is not in the valid state. + + + + + Starts the recording. + + + If file path has been set to an existing file, this file is removed automatically and updated by new one. + The filename should be set before this function is invoked. + The recorder state must be state by or + state by . + The filename shuild be set by + + The streamrecorder is not in the valid state. + The access ot the resources can not be granted. + + + + + + + + + Pause the recording. + + + Recording can be resumed with . + + The streamrecorder is not in the valid state. + + + + + + + Stops recording and saves the result. + + + The recorder state must be state by or + state by + When you want to record audio or video file, you need to add privilege according to rules below additionally. + + http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + + + The streamrecorder is not in the valid state. + The access ot the resources can not be granted. + + + + + + Cancels the recording. + The recording data is discarded and not written in the recording file. + + + + + + + Push stream buffer as recording raw data. + + + + + Set the source type of pushed data. + + + + + Release any unmanaged resources used by this object. + + + + + Enumeration for Audio Codec. + + + + + AMR codec. + + + + + AAC codec. + + + + + PCM codec. + + + + + Enumeration for the file container format. + + + + + 3GP file format. + + + + + MP4 file format. + + + + + AMR file format. + + + + + ADTS file format. + + + + + WAV file format. + + + + + Enumeration for the recorder notify type. + + + + + None. + + + + + State changed noti. + + + + + Enumeration for the recording limit type. + + + + + Time limit in seconds of recording file + + + + + Size limit in KB(KiloBytes) of recording file. + + + + + Enumeration for stream recorder states. + + + + + Stream recorder is not created. + + + + + Stream recorder is created, but not prepared. + + + + + Stream recorder is ready to record. + + + + + Stream recorder is recording pushed packet. + + + + + Stream recorder is paused. + + + + + Enumeration for video codec. + + + + + H263 codec. + + + + + MPEG4 codec. + + + + + Enumeration for source type. + + + + + Video source + + + + + Audio source + + + + + Audio/Video both + + + + + Enumeration for video source format. + + + + + Nv12 Video source format + + + + + Nv21 video source format + + + + + I420 video source format + + + + + Enumeration for stream recorder failure error. + + + + + Sucessful. + + + + + Internal error. + + + + + Internal error. + + + + + Out of memory. + + + + + An extended Eventargs class which contains interrupted policy details, previous and current + state of the recorder. + + + + + The previous state of the stream recorder. + + + + + The current state of the stream recorder. + + + + + The notify of the event. + + + + + Resolution for stream recorder. + + + + + The video width. + + The width. + + + + The video height. + + The height. + + + + An extended EventArgs. + + + + + Consumed buffer. + + + + + An extended EventArgs class which contains details about error status and + state of the recorder when it failed. + + + + + The error code. + + + + + The state of the recorder. + + + + + An extended EventArgs class containing details about the recording limit. + + + + + The limitation type. + + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Util.dll b/Artifacts/bin/Tizen.Multimedia.Util.dll index 80b3c98..b148d2e 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Util.dll and b/Artifacts/bin/Tizen.Multimedia.Util.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Util.pdb b/Artifacts/bin/Tizen.Multimedia.Util.pdb index 231fd78..9a8178c 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Util.pdb and b/Artifacts/bin/Tizen.Multimedia.Util.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Util.xml b/Artifacts/bin/Tizen.Multimedia.Util.xml index 3f4928c..4a52bd2 100644 --- a/Artifacts/bin/Tizen.Multimedia.Util.xml +++ b/Artifacts/bin/Tizen.Multimedia.Util.xml @@ -1,997 +1,997 @@ - - - - Tizen.Multimedia.Util - - - - - Represents image data returned by a decoder class. - - - - - Gets the raw image data. - - - - - Gets the size of the image. - - - - - Represent gif image data used to encode a gif image with . - - - - - Initialize a new instance of the class with a buffer and a delay. - - The raw image buffer to be encoded. - The delay for this image, in 0.001 sec units. - is null. - The length of is zero. - - - - Gets the raw image data. - - - - - Gets or sets the delay for this image. - - Time delay in 0.001 sec units. - - - - YV12 - YCrCb planar format - - - - - YUV422 - planar - - - - - YUV420 - planar - - - - - NV12- planar - - - - - UYVY - packed - - - - - YUYV - packed - - - - - RGB565, high-byte is Blue - - - - - RGB888, high-byte is Blue - - - - - ARGB8888, high-byte is Blue - - - - - BGRA8888, high-byte is Alpha - - - - - RGBA8888, high-byte is Alpha - - - - - BGRX8888, high-byte is X - - - - - NV21- planar - - - - - NV16- planar - - - - - NV61- planar - - - - - This is a base class for image decoders. - - - - - Gets the image format of this decoder. - - - - - Sets the color-space to decode into. The default is . - - The value indicating color-space to decode into. - is invalid. - is not supported by the decoder. - - - - - Decodes an image from the specified file. - - Input file path from which to decode. - A task that represents the asynchronous decoding operation. - - Only Graphics Interchange Format(GIF) codec returns more than one frame.\n - \n - http://tizen.org/privilege/mediastorage is needed if is relevant to media storage.\n - http://tizen.org/privilege/externalstorage is needed if is relevant to external storage. - - is null. - - is an empty string.\n - - or -\n - is not a image file.\n - - or -\n - The format of is not . - - does not exists. - Caller does not have required permission to access the path. - The format of is not . - The has already been disposed of. - - - - Decodes an image from the buffer. - - The image buffer from which to decode. - A task that represents the asynchronous decoding operation. - - Only Graphics Interchange Format(GIF) codec returns more than one frame.\n - - is null. - - is an empty array.\n - - or -\n - The format of is not . - - The format of is not . - The has already been disposed of. - - - - Releases the unmanaged resources used by the ImageDecoder. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the ImageDecoder. - - - - - Provides the ability to decode Bitmap (BMP) encoded images. - - - - - Initialize a new instance of the class. - - will be the . - - - - Provides the ability to decode Portable Network Graphics (PNG) encoded images. - - - - - Initialize a new instance of the class. - - will be the . - - - - Provides the ability to decode Joint Photographic Experts Group (JPEG) encoded images. - - - - - A read-only field that represents the default value of . - - - - - Initialize a new instance of the class. - - will be the . - - - - Gets or sets the downscale at which the jpeg image should be decoded. - - is invalid. - - - - Provides the ability to decode Graphics Interchange Format (GIF) encoded images. - - - - - Initialize a new instance of the class. - - will be the . - - - - This is a base class for image encoders. - - - - - Gets the image format of this encoder. - - - - - Sets the resolution of the output image. - - The target resolution. - - The width of is less than or equal to zero.\n - - or -\n - The height of is less than or equal to zero. - - - - - Sets the color-space of the output image. - - The target color-space. - is invalid. - is not supported by the encoder. - - - - - Encodes an image from a raw image buffer to a specified . - - The image buffer to encode. - The stream that the image is encoded to. - A task that represents the asynchronous encoding operation. - - is null.\n - - or -\n - is null. - - - is an empty array.\n - - or -\n - is not writable.\n - - The resolution is not set. - The has already been disposed of. - - - - - Releases the unmanaged resources used by the ImageEncoder. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the ImageEncoder. - - - - - Provides the ability to encode Bitmap (BMP) format images. - - - - - Initialize a new instance of the class. - - will be the . - - - - Provides the ability to encode Portable Network Graphics (PNG) format images. - - - - - A read-only field that represents the default value of . - - - - - Initialize a new instance of the class. - - will be the . - - - - Initialize a new instance of the class with . - - will be the . - The compression level of the encoder. - is invalid. - - - - Gets or sets the compression level of the png image. - - The compression level. The default is . - is invalid. - - - - Provides the ability to encode Joint Photographic Experts Group (JPEG) format images. - - - - - A read-only field that represents the default value of . - - - - - Initialize a new instance of the class. - - will be the . - - - - Initialize a new instance of the class with initial quality value. - - The quality for JPEG image encoding; from 1(lowest quality) to 100(highest quality). - will be the . - - is less than or equal to 0.\n - - or -\n - is greater than 100. - - - - - Gets or sets the quality of the encoded image. - - - The quality of the output image. The default is 75.\n - Valid value is from 1(lowest quality) to 100(highest quality). - - - is less than or equal to 0.\n - - or -\n - is greater than 100. - - - - - Provides the ability to encode Graphics Interchange Format (GIF) format images. - - - - - Initialize a new instance of the class. - - will be the . - - - - Encodes a Graphics Interchange Format (GIF) image from multiple raw image buffers to a specified . - - The image frames to encode. - The stream that the image is encoded to. - A task that represents the asynchronous encoding operation. - - is null.\n - - or -\n - is null. - - - has no element(empty).\n - - or -\n - is not writable.\n - - The resolution is not set. - The has already been disposed of. - - - - - Specifies image formats for , and . - - - - - The Joint Photographic Experts Group format. - - - - - The Portable Network Graphics format. - - - - - The Graphics Interchange Format. - - - - - The Bitmap format. - - - - - Specifies how an image is rotated or flipped. - - - - - - No rotation. - - - - - Rotate 90 degree clockwise. - - - - - Rotate 180 degree clockwise. - - - - - Rotate 270 degree clockwise. - - - - - Flip horizontally. - - - - - Flip vertically. - - - - - A base class for image transformations. - - - - - Represents a collection of objects that can be individually accessed by index. - - - - - Initializes a new instance of the ImageTransformCollection class. - - - - - Gets or sets the at the specified index. - - The zero-based index of the to get or set. - The at the specified index. - - index is less than 0.\n - - or -\n - index is equal to or greater than Count. - - - - - Gets the number of items contained in the TransformCollection. - - - - - Adds a to the end of the collection. - - The to add. - - accepts null as a valid value for reference types and allows duplicate elements. - - - - - Removes all items. - - - - - Determines whether the contains the specified item. - - The to locate in the collection. - true if the is found in the collection; otherwise, false. - - - - Copies the items of the collection to an array, starting at the specified array index. - - The one-dimensional array that is the destination of the items copied from the collection. - The zero-based index in array at which copying begins. - is null. - is less than 0. - - The number of elements in the source collection is greater than the available space from arrayIndex to the end of the destination array. - - - - - Determines the index of the specified item in the collection. - - The to locate in the collection. - The index of value if found in the ; otherwise, -1. - - - - Inserts a into the collection at the specified index. - - The zero-based index at which should be inserted. - The to insert into the collection. - is null. - - index is less than 0.\n - -or-\n - index is greater than . - - - - - Removes the first occurrence of the specified from the collection. - - The to remove. - true if was removed from the collection; otherwise, false. - - - - Removes the at the specified index. - - The zero-based index to remove. - - index is less than 0.\n - - or -\n - index is equal to or greater than . - - - - - Returns an enumerator that can iterate through the collection. - - A enumerator that can be used to iterate through the collection. - - - - Represents a that is a composite of the transforms. - - - - - Gets or sets the . - - - - - Initializes a new instance of the ImageTransformGroup class. - - - - - Rotates or flips an image. - - - - - - Initialize a new instance of the class. - - The value how to rotate an image. - is invalid. - is . - - - - Gets or sets the value how to rotate an image. - - is invalid. - is . - - - - Rotates or flips an image. - - - - - - Initialize a new instance of the class. - - The value how to flip an image. - is invalid. - is . - - - - Gets or sets the value how to rotate an image. - - is invalid. - is . - - - - Changes colorspace of image. - - - - - - Initialize a new instance of the class. - - The colorspace of output image. - is invalid. - is not supported. - - - - - Gets or sets the colorspace of the result image. - - is invalid. - is not supported. - - - - - Gets the supported colorspaces for . - - - - - Crops an image. - - - - - Initialize a new instance of the class. - - The crop region. - - The X-position of is less than zero.\n - - or -\n - The Y-position of is less than zero.\n - - or -\n - The width of is less than or equal to zero.\n - - or -\n - The height of is less than or equal to zero. - - - - - Gets or sets the crop region. - - - The X-position of is less than zero.\n - - or -\n - The Y-position of is less than zero.\n - - or -\n - The width of is less than or equal to zero.\n - - or -\n - The height of is less than or equal to zero. - - - - - Resizes an image. - - - - - Initialize a new instance of the class. - - The size that an image is resized to. - - The width of is less than or equal to zero.\n - - or -\n - The height of is less than or equal to zero. - - - - - Gets or sets the size that an image is resized to. - - - The width of is less than or equal to zero.\n - - or -\n - The height of is less than or equal to zero. - - - - - Provides the ability to transform an image. - - - - - Initialize a new instance of the class. - - - - - Transforms an image with . - - to transform. The of this must be . - to apply. - A task that represents the asynchronous transforming operation. - - is null.\n - - or -\n - is null. - - The has already been disposed of. - Failed to apply . - - - - Releases the unmanaged resources used by the ImageTransformer. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the ImageTransformer. - - - - - Provides utilities for images. - - - - - Retrieves supported colorspaces for a that represents formats for and . - - An IEnumerable of representing the supported color-spaces. - The . - is invalid. - - - - Calculates the size of the image buffer for the specified resolution and color-space. - - The resolution of the image. - of the image. - The buffer size. - - width of is less than or equal to zero.\n - - or -\n - height of is less than or equal to zero. - - is invalid. - - - - Extracts representative color from an image buffer. - - Raw image buffer. - Resolution of the image. - The image should be . - The representative color of the image. - - is null. - is empty. - - width of is less than or equal to zero.\n - - or -\n - height of is less than or equal to zero. - - - - - Specifies JPEG Downscale options for decoding. - - - - - No downscale. - - - - - 1/2 downscale. - - - - - 1/4 downscale. - - - - - 1/8 downscale. - - - - - Specifies PNG compression levels. - - - - - No Compression. - - - - - Compression Level 1. Best speed. - - - - - Compression Level 2. - - - - - Compression Level 3. - - - - - Compression Level 4. - - - - - Compression Level 5. - - - - - Compression Level 6. - - - - - Compression Level 7. - - - - - Compression Level 8. - - - - - Compression Level 9. - - - - - Represents the result of thumbnail extraction. - - - - - The thumbnail data. - - 3 - - - - The size of the thumbnail. - - 3 - - - - Provides the ability to extract the thumbnail from media files. - - - - - Extracts the thumbnail for the given media with the specified path. - - 3 - A task that represents the asynchronous extracting operation. - The size of the thumbnail will be the default size(320x240).\n - The path of the media file to extract the thumbnail. - is null. - Requested does not exist. - Internal error occurred. - Caller does not have required privilege for accessing the . - The specified file is not supported. - - - - Extracts the thumbnail for the given media with the specified path. - - A task that represents the asynchronous extracting operation. - The size of the thumbnail will be the default size(320x240).\n - The path of the media file to extract the thumbnail. - The token to stop the operation. - is null. - Requested does not exist. - Internal error occurred. - Caller does not have required privilege for accessing the . - The specified file is not supported. - - - - Extracts the thumbnail for the given media with the specified path and size. - - 3 - A task that represents the asynchronous extracting operation. - - If the width is not a multiple of 8, it can be changed by inner process.\n - The width will be a multiple of 8 greater than the set value. - - The path of the media file to extract the thumbnail. - The size of the thumbnail. - is null. - Requested does not exist. - Internal error occurred. - Caller does not have required privilege for accessing the . - - Width or height of is less than or equal to zero. - - The specified file is not supported. - - - - Extracts the thumbnail for the given media with the specified path and size. - - 3 - A task that represents the asynchronous extracting operation. - - If the width is not a multiple of 8, it can be changed by inner process.\n - The width will be a multiple of 8 greater than the set value. - - The path of the media file to extract the thumbnail. - The size of the thumbnail. - The token to stop the operation. - is null. - Requested does not exist. - Internal error occurred. - Caller does not have required privilege for accessing the . - - Width or height of is less than or equal to zero. - - The specified file is not supported. - - - + + + + Tizen.Multimedia.Util + + + + + Represents image data returned by a decoder class. + + + + + Gets the raw image data. + + + + + Gets the size of the image. + + + + + Represent gif image data used to encode a gif image with . + + + + + Initialize a new instance of the class with a buffer and a delay. + + The raw image buffer to be encoded. + The delay for this image, in 0.001 sec units. + is null. + The length of is zero. + + + + Gets the raw image data. + + + + + Gets or sets the delay for this image. + + Time delay in 0.001 sec units. + + + + YV12 - YCrCb planar format + + + + + YUV422 - planar + + + + + YUV420 - planar + + + + + NV12- planar + + + + + UYVY - packed + + + + + YUYV - packed + + + + + RGB565, high-byte is Blue + + + + + RGB888, high-byte is Blue + + + + + ARGB8888, high-byte is Blue + + + + + BGRA8888, high-byte is Alpha + + + + + RGBA8888, high-byte is Alpha + + + + + BGRX8888, high-byte is X + + + + + NV21- planar + + + + + NV16- planar + + + + + NV61- planar + + + + + This is a base class for image decoders. + + + + + Gets the image format of this decoder. + + + + + Sets the color-space to decode into. The default is . + + The value indicating color-space to decode into. + is invalid. + is not supported by the decoder. + + + + + Decodes an image from the specified file. + + Input file path from which to decode. + A task that represents the asynchronous decoding operation. + + Only Graphics Interchange Format(GIF) codec returns more than one frame.\n + \n + http://tizen.org/privilege/mediastorage is needed if is relevant to media storage.\n + http://tizen.org/privilege/externalstorage is needed if is relevant to external storage. + + is null. + + is an empty string.\n + - or -\n + is not a image file.\n + - or -\n + The format of is not . + + does not exists. + Caller does not have required permission to access the path. + The format of is not . + The has already been disposed of. + + + + Decodes an image from the buffer. + + The image buffer from which to decode. + A task that represents the asynchronous decoding operation. + + Only Graphics Interchange Format(GIF) codec returns more than one frame.\n + + is null. + + is an empty array.\n + - or -\n + The format of is not . + + The format of is not . + The has already been disposed of. + + + + Releases the unmanaged resources used by the ImageDecoder. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the ImageDecoder. + + + + + Provides the ability to decode Bitmap (BMP) encoded images. + + + + + Initialize a new instance of the class. + + will be the . + + + + Provides the ability to decode Portable Network Graphics (PNG) encoded images. + + + + + Initialize a new instance of the class. + + will be the . + + + + Provides the ability to decode Joint Photographic Experts Group (JPEG) encoded images. + + + + + A read-only field that represents the default value of . + + + + + Initialize a new instance of the class. + + will be the . + + + + Gets or sets the downscale at which the jpeg image should be decoded. + + is invalid. + + + + Provides the ability to decode Graphics Interchange Format (GIF) encoded images. + + + + + Initialize a new instance of the class. + + will be the . + + + + This is a base class for image encoders. + + + + + Gets the image format of this encoder. + + + + + Sets the resolution of the output image. + + The target resolution. + + The width of is less than or equal to zero.\n + - or -\n + The height of is less than or equal to zero. + + + + + Sets the color-space of the output image. + + The target color-space. + is invalid. + is not supported by the encoder. + + + + + Encodes an image from a raw image buffer to a specified . + + The image buffer to encode. + The stream that the image is encoded to. + A task that represents the asynchronous encoding operation. + + is null.\n + - or -\n + is null. + + + is an empty array.\n + - or -\n + is not writable.\n + + The resolution is not set. + The has already been disposed of. + + + + + Releases the unmanaged resources used by the ImageEncoder. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the ImageEncoder. + + + + + Provides the ability to encode Bitmap (BMP) format images. + + + + + Initialize a new instance of the class. + + will be the . + + + + Provides the ability to encode Portable Network Graphics (PNG) format images. + + + + + A read-only field that represents the default value of . + + + + + Initialize a new instance of the class. + + will be the . + + + + Initialize a new instance of the class with . + + will be the . + The compression level of the encoder. + is invalid. + + + + Gets or sets the compression level of the png image. + + The compression level. The default is . + is invalid. + + + + Provides the ability to encode Joint Photographic Experts Group (JPEG) format images. + + + + + A read-only field that represents the default value of . + + + + + Initialize a new instance of the class. + + will be the . + + + + Initialize a new instance of the class with initial quality value. + + The quality for JPEG image encoding; from 1(lowest quality) to 100(highest quality). + will be the . + + is less than or equal to 0.\n + - or -\n + is greater than 100. + + + + + Gets or sets the quality of the encoded image. + + + The quality of the output image. The default is 75.\n + Valid value is from 1(lowest quality) to 100(highest quality). + + + is less than or equal to 0.\n + - or -\n + is greater than 100. + + + + + Provides the ability to encode Graphics Interchange Format (GIF) format images. + + + + + Initialize a new instance of the class. + + will be the . + + + + Encodes a Graphics Interchange Format (GIF) image from multiple raw image buffers to a specified . + + The image frames to encode. + The stream that the image is encoded to. + A task that represents the asynchronous encoding operation. + + is null.\n + - or -\n + is null. + + + has no element(empty).\n + - or -\n + is not writable.\n + + The resolution is not set. + The has already been disposed of. + + + + + Specifies image formats for , and . + + + + + The Joint Photographic Experts Group format. + + + + + The Portable Network Graphics format. + + + + + The Graphics Interchange Format. + + + + + The Bitmap format. + + + + + Specifies how an image is rotated or flipped. + + + + + + No rotation. + + + + + Rotate 90 degree clockwise. + + + + + Rotate 180 degree clockwise. + + + + + Rotate 270 degree clockwise. + + + + + Flip horizontally. + + + + + Flip vertically. + + + + + A base class for image transformations. + + + + + Represents a collection of objects that can be individually accessed by index. + + + + + Initializes a new instance of the ImageTransformCollection class. + + + + + Gets or sets the at the specified index. + + The zero-based index of the to get or set. + The at the specified index. + + index is less than 0.\n + - or -\n + index is equal to or greater than Count. + + + + + Gets the number of items contained in the TransformCollection. + + + + + Adds a to the end of the collection. + + The to add. + + accepts null as a valid value for reference types and allows duplicate elements. + + + + + Removes all items. + + + + + Determines whether the contains the specified item. + + The to locate in the collection. + true if the is found in the collection; otherwise, false. + + + + Copies the items of the collection to an array, starting at the specified array index. + + The one-dimensional array that is the destination of the items copied from the collection. + The zero-based index in array at which copying begins. + is null. + is less than 0. + + The number of elements in the source collection is greater than the available space from arrayIndex to the end of the destination array. + + + + + Determines the index of the specified item in the collection. + + The to locate in the collection. + The index of value if found in the ; otherwise, -1. + + + + Inserts a into the collection at the specified index. + + The zero-based index at which should be inserted. + The to insert into the collection. + is null. + + index is less than 0.\n + -or-\n + index is greater than . + + + + + Removes the first occurrence of the specified from the collection. + + The to remove. + true if was removed from the collection; otherwise, false. + + + + Removes the at the specified index. + + The zero-based index to remove. + + index is less than 0.\n + - or -\n + index is equal to or greater than . + + + + + Returns an enumerator that can iterate through the collection. + + A enumerator that can be used to iterate through the collection. + + + + Represents a that is a composite of the transforms. + + + + + Gets or sets the . + + + + + Initializes a new instance of the ImageTransformGroup class. + + + + + Rotates or flips an image. + + + + + + Initialize a new instance of the class. + + The value how to rotate an image. + is invalid. + is . + + + + Gets or sets the value how to rotate an image. + + is invalid. + is . + + + + Rotates or flips an image. + + + + + + Initialize a new instance of the class. + + The value how to flip an image. + is invalid. + is . + + + + Gets or sets the value how to rotate an image. + + is invalid. + is . + + + + Changes colorspace of image. + + + + + + Initialize a new instance of the class. + + The colorspace of output image. + is invalid. + is not supported. + + + + + Gets or sets the colorspace of the result image. + + is invalid. + is not supported. + + + + + Gets the supported colorspaces for . + + + + + Crops an image. + + + + + Initialize a new instance of the class. + + The crop region. + + The X-position of is less than zero.\n + - or -\n + The Y-position of is less than zero.\n + - or -\n + The width of is less than or equal to zero.\n + - or -\n + The height of is less than or equal to zero. + + + + + Gets or sets the crop region. + + + The X-position of is less than zero.\n + - or -\n + The Y-position of is less than zero.\n + - or -\n + The width of is less than or equal to zero.\n + - or -\n + The height of is less than or equal to zero. + + + + + Resizes an image. + + + + + Initialize a new instance of the class. + + The size that an image is resized to. + + The width of is less than or equal to zero.\n + - or -\n + The height of is less than or equal to zero. + + + + + Gets or sets the size that an image is resized to. + + + The width of is less than or equal to zero.\n + - or -\n + The height of is less than or equal to zero. + + + + + Provides the ability to transform an image. + + + + + Initialize a new instance of the class. + + + + + Transforms an image with . + + to transform. The of this must be . + to apply. + A task that represents the asynchronous transforming operation. + + is null.\n + - or -\n + is null. + + The has already been disposed of. + Failed to apply . + + + + Releases the unmanaged resources used by the ImageTransformer. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the ImageTransformer. + + + + + Provides utilities for images. + + + + + Retrieves supported colorspaces for a that represents formats for and . + + An IEnumerable of representing the supported color-spaces. + The . + is invalid. + + + + Calculates the size of the image buffer for the specified resolution and color-space. + + The resolution of the image. + of the image. + The buffer size. + + width of is less than or equal to zero.\n + - or -\n + height of is less than or equal to zero. + + is invalid. + + + + Extracts representative color from an image buffer. + + Raw image buffer. + Resolution of the image. + The image should be . + The representative color of the image. + + is null. + is empty. + + width of is less than or equal to zero.\n + - or -\n + height of is less than or equal to zero. + + + + + Specifies JPEG Downscale options for decoding. + + + + + No downscale. + + + + + 1/2 downscale. + + + + + 1/4 downscale. + + + + + 1/8 downscale. + + + + + Specifies PNG compression levels. + + + + + No Compression. + + + + + Compression Level 1. Best speed. + + + + + Compression Level 2. + + + + + Compression Level 3. + + + + + Compression Level 4. + + + + + Compression Level 5. + + + + + Compression Level 6. + + + + + Compression Level 7. + + + + + Compression Level 8. + + + + + Compression Level 9. + + + + + Represents the result of thumbnail extraction. + + + + + The thumbnail data. + + 3 + + + + The size of the thumbnail. + + 3 + + + + Provides the ability to extract the thumbnail from media files. + + + + + Extracts the thumbnail for the given media with the specified path. + + 3 + A task that represents the asynchronous extracting operation. + The size of the thumbnail will be the default size(320x240).\n + The path of the media file to extract the thumbnail. + is null. + Requested does not exist. + Internal error occurred. + Caller does not have required privilege for accessing the . + The specified file is not supported. + + + + Extracts the thumbnail for the given media with the specified path. + + A task that represents the asynchronous extracting operation. + The size of the thumbnail will be the default size(320x240).\n + The path of the media file to extract the thumbnail. + The token to stop the operation. + is null. + Requested does not exist. + Internal error occurred. + Caller does not have required privilege for accessing the . + The specified file is not supported. + + + + Extracts the thumbnail for the given media with the specified path and size. + + 3 + A task that represents the asynchronous extracting operation. + + If the width is not a multiple of 8, it can be changed by inner process.\n + The width will be a multiple of 8 greater than the set value. + + The path of the media file to extract the thumbnail. + The size of the thumbnail. + is null. + Requested does not exist. + Internal error occurred. + Caller does not have required privilege for accessing the . + + Width or height of is less than or equal to zero. + + The specified file is not supported. + + + + Extracts the thumbnail for the given media with the specified path and size. + + 3 + A task that represents the asynchronous extracting operation. + + If the width is not a multiple of 8, it can be changed by inner process.\n + The width will be a multiple of 8 greater than the set value. + + The path of the media file to extract the thumbnail. + The size of the thumbnail. + The token to stop the operation. + is null. + Requested does not exist. + Internal error occurred. + Caller does not have required privilege for accessing the . + + Width or height of is less than or equal to zero. + + The specified file is not supported. + + + diff --git a/Artifacts/bin/Tizen.Multimedia.Vision.dll b/Artifacts/bin/Tizen.Multimedia.Vision.dll index 368c3ce..d6a8bd3 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Vision.dll and b/Artifacts/bin/Tizen.Multimedia.Vision.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.Vision.pdb b/Artifacts/bin/Tizen.Multimedia.Vision.pdb index adc5505..846335a 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.Vision.pdb and b/Artifacts/bin/Tizen.Multimedia.Vision.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.Vision.xml b/Artifacts/bin/Tizen.Multimedia.Vision.xml index d5d286f..e14c48b 100644 --- a/Artifacts/bin/Tizen.Multimedia.Vision.xml +++ b/Artifacts/bin/Tizen.Multimedia.Vision.xml @@ -1,2757 +1,2757 @@ - - - - Tizen.Multimedia.Vision - - - - - Interop APIs - - - Interop APIs - - - Interop APIs - - - Interop APIs - - - Interop APIs - - - - - Interop for media vision APIs - - - Interop for media vision APIs - - - Interop for media vision APIs - - - Interop for Media vision APIs - - - Interop for media vision APIs - - - - - Interop for barcode detector APIs - - - - - Interop for barcode generator APIs - - - - - Interop for media vision source APIs - - - - - Interop for engine configuration APIs - - - - - Interop for Face APIs - - - - - Interop for FaceRecognitionModel APIs - - - - - Interop for FaceTrackingModel APIs - - - - - Interop for Image APIs - - - - - Interop for ImageTrackingModel APIs - - - - - Interop for surveillance APIs - - - - - Represents a detected barcode. - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - The quadrangle location of detected barcode. - - 3 - - - - The decoded message of barcode. - - 3 - - - - The type of detected barcode. - - 3 - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Represents a configuration of . - - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the target of the barcode detection. - - is not valid. - The already has been disposed of. - 3 - - - - Specifies the target of . - - 3 - - - - 1D and 2D. - - 3 - - - - 1D barcode only. - - 3 - - - - 2D barcode only. - - 3 - - - - Provides the ability to detect barcodes on image sources. - - 3 - - - - Detects barcodes on source and reads message from it. - - The instance. - Region of interest - rectangular area on the source which will be used for - barcode detection. Note that roi should be inside area on the source. - is null. - The feature is not supported. - already has been disposed of. - A task that represents the asynchronous detect operation. - - 3 - - - - Detects barcodes on source and reads message from it with . - - The instance. - Region of interest - rectangular area on the source which will be used for - barcode detection. Note that roi should be inside area on the source. - The configuration of the barcode detector. This value can be null. - A task that represents the asynchronous detect operation. - is null. - The feature is not supported. - - already has been disposed of.\n - -or-\n - already has been disposed of. - - - 3 - - - - Represents a configuration of instances. - - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the text visibility of the barcode to be generated. - - is not valid. - The already has been disposed of. - 3 - - - - Gets or sets the foreground color of the barcode to be generated. - - - The alpha value of the color will be ignored. - - The already has been disposed of. - 3 - - - - Gets or sets the background color of the barcode to be generated. - - - The alpha value of the color will be ignored. - - The already has been disposed of. - 3 - - - - Provides the ability to generate barcodes and QR codes. - Different encoding types , error correction codes - and code versions are supported for QRCodes. - - - 3 - - - - Generates a QR image with the specified message. - - The message to be encoded in the barcode. - The instance. - containing the generated QR image. - - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - contains characters which are illegal by the . - - The feature is not supported. - - 3 - - - - Generates a QR image with the specified message with . - - The message to be encoded in the barcode. - The instance. - The configuration of the barcode generator. This value can be null. - containing the generated QR image. - - must be , - because the text visibility is not supported in the QR code. - - - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - contains characters which are illegal by the . - - - The feature is not supported.\n - -or-\n - is the . - - already has been disposed of. - - 3 - - - - Generates a barcode image with the specified message. - - The message to be encoded in the barcode. - Type of the barcode to be generated. - containing the generated barcode image. - is null. - - is too long.\n - -or-\n - is .\n - -or-\n - is invalid. - -or-\n - contains illegal characters. - - The feature is not supported. - 3 - - - - Generates a barcode image with the specified message and . - - The message to be encoded in the barcode. - Type of the barcode to be generated. - The configuration of the barcode generator. This value can be null. - containing the generated barcode image. - is null. - - is too long.\n - -or-\n - is . - -or-\n - is invalid. - -or-\n - contains illegal characters. - - The feature is not supported. - already has been disposed of. - 3 - - - - Generates a QR image file with the specified message. - - - must be , - because the text visibility is not supported in the QR code. - - The message to be encoded in the barcode. - The instance. - The that contains information about the file to be generated. - - is null.\n - -or-\n - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - contains characters which are illegal by the . - - No permission to write a file. - The feature is not supported. - - 3 - - - - Generates a QR image file with the specified message and . - - - must be , - because the text visibility is not supported in the QR code. - - The message to be encoded in the barcode. - The instance. - The that contains - information about the file to be generated. - The configuration of the barcode generator. This value can be null. - - is null.\n - -or-\n - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - contains characters which are illegal by the . - - No permission to write a file. - - The feature is not supported.\n - -or-\n - is the . - - already has been disposed of. - 3 - - - - Generates a barcode image file with the specified message. - - The message to be encoded in the barcode. - Type of the barcode to be generated. - The that contains - information about the file to be generated. - - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - is . - -or-\n - is invalid. - -or-\n - contains illegal characters. - - No permission to write a file. - The feature is not supported. - 3 - - - - Generates a barcode image file with the specified message and . - - The message to be encoded in the barcode. - Type of the barcode to be generated. - The that contains - information about the file to be generated. - The configuration of the barcode generator. This value can be null. - - is null.\n - -or-\n - is null. - - - is too long.\n - -or-\n - is . - -or-\n - is invalid. - -or-\n - contains illegal characters. - - No permission to write a file. - The feature is not supported. - already has been disposed of. - 3 - - - - Represents a configuration for the image to be generated by . - - 3 - - - - Initializes a new instance of the class. - - - The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n - The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. - - The of the generated image. - The path to the file to be generated. - The format of the output image. - - The width of is less than or equal to zero.\n - -or-\n - The height of is less than or equal to zero. - - is null. - is invalid. - - BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(new Size(500, 400), "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); - - 3 - - - - Initializes a new instance of the class. - - - The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n - The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. - - The width of the image to be generated. - The height of the image to be generated. - The path to the file to be generated. - The format of the output image. - - is less than or equal to zero.\n - -or-\n - is less than or equal to zero. - - is null. - is invalid. - - BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); - - 3 - - - - Gets the size of the image. - - 3 - - - - Gets the width of the image. - - 3 - - - - Gets the height of the image. - - 3 - - - - Gets the path to the file that has to be generated. - - - The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n - The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage. - - 3 - - - - Gets the format of the output image. - - 3 - - - - Specifies supported image formats for - - - 3 - - - - BMP image format. - - 3 - - - - JPEG image format. - - 3 - - - - PNG image format. - - 3 - - - - Specifies the supported barcode types. - - - QR codes (versions 1 to 40) and set of 1D barcodes are supported - - - - 3 - - - - 2D barcode - Quick Response code. - - 3 - - - - 1D barcode - Universal Product Code with 12-digit. - - 3 - - - - 1D barcode - Universal Product Code with 6-digit. - - 3 - - - - 1D barcode - International Article Number with 8-digit. - - 3 - - - - 1D barcode - International Article Number with 13-digit. - - 3 - - - - 1D barcode - Code 128. - - 3 - - - - 1D barcode - Code 39. - - 3 - - - - 1D barcode - Interleaved Two of Five. - - 3 - - - - Specifies colorspaces for MediaVision. - - 3 - - - - The colorspace type is invalid. - - 3 - - - - The colorspace type is Y800. - - 3 - - - - The colorspace type is I420. - - 3 - - - - The colorspace type is NV12. - - 3 - - - - The colorspace type is YV12. - - 3 - - - - The colorspace type is NV21. - - 3 - - - - The colorspace type is YUYV. - - 3 - - - - The colorspace type is UYVY. - - 3 - - - - The colorspace type is 422P. - - 3 - - - - The colorspace type is RGB565. - - 3 - - - - The colorspace type is RGB888. - - 3 - - - - The colorspace type is RGBA. - - 3 - - - - A base class for configuration classes. - - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Specifies the supported QR code error correction level. - - 3 - - - - Recovery up to 7% losses. - - 3 - - - - Recovery up to 15% losses. - - 3 - - - - Recovery up to 25% losses. - - 3 - - - - Recovery up to 30% losses. - - 3 - - - - Specifies the eyes state types. - - 3 - - - - Eyes are open. - - 3 - - - - Eyes are closed. - - 3 - - - - The eyes condition wasn't determined. - - 3 - - - - Represents a configuration of instances. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the face detection haarcascade xml file for face detection. - - is null. - 3 - - - - Gets or sets minimum height of face which will be detected. - - - Default value is null (all detected faces will be applied), can be changed to specify the minimum face height. - - is less than zero. - 3 - - - - Gets or sets minimum width of face which will be detected. - - - Default value is null (all detected faces will be applied), can be changed to specify the minimum face width. - - is less than zero. - 3 - - - - Gets or sets the roi of the face detection. - - - Default value is null (the roi will be a full image) can be changed to specify the roi for face detection. - - - The width of is less than or equal to zero.\n - -or-\n - The height of is less than or equal to zero.\n - -or-\n - The x position of is less than zero.\n - -or-\n - The y position of is less than zero.\n - - 3 - - - - Provides the ability to detect faces on image sources. - - 3 - - - - Detects faces on the source.\n - Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously. - - The source of the media where faces will be detected. - A task that represents the asynchronous detect operation. - is null. - - The feature is not supported.\n - -or-\n - The format of is not supported. - - 3 - - - - Detects faces on the source.\n - Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously. - - The source of the media where faces will be detected. - The configuration of engine will be used for detecting. This value can be null. - A task that represents the asynchronous detect operation. - is null. - The feature is not supported. - 3 - - - - Represents a configuration of instances. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the method used for face recognition model learning. - Default value is . - - is not valid. - 3 - - - - Represents the face recognition model interface. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Initializes a new instance of the class with the specified path. - - - Models have been saved by can be loaded. - - Path to the model to load. - is null. - is invalid. - - The feature is not supported.\n - -or-\n - is not supported format. - - No permission to access the specified file. - - 3 - - - - Gets labels that had been learned by the model. - - 3 - - - - Saves the recognition model to the file. - - Path to the file to save the model. - is null. - No permission to write to the specified path. - The has already been disposed of. - The directory for does not exist. - 3 - - - - Adds face image example to be used for face recognition model learning. - - The that contains face image. - The label that identifies face for which example is adding. - Specify the same labels for the face images of a single person when calling this method. - Has to be unique for each face. - is null. - - The has already been disposed of.\n - -or-\n - has already been dispose of. - - - 3 - - - - Adds face image example to be used for face recognition model learning. - - The that contains face image. - The label that identifies face for which example is adding. - Specify the same labels for the face images of a single person when calling this method. - Has to be unique for each face. - The rectangular region of the face image at the source image. - is null. - - The has already been disposed of.\n - -or-\n - has already been dispose of. - - - 3 - - - - Removes all face examples added with the specified label. - - The label that identifies face for which examples will be removed. - The has already been disposed of. - true if the examples are successfully removed; otherwise, false if there is no example labeled with the specified label. - - - 3 - - - - Removes all face examples. - - The has already been disposed of. - 3 - - - - Learns face recognition model. - - - Before you start learning process, face recognition models has to be filled with training data - face image examples. - These examples has to be provided by or . - Recognition accuracy is usually increased when the different examples of the identical face are added more and more. - But it depends on the used learning algorithm. - - The has already been disposed of. - No examples added. - - - 3 - - - - Learns face recognition model with . - - - Before you start learning process, face recognition models has to be filled with training data - face image examples. - These examples has to be provided by or . - Recognition accuracy is usually increased when the different examples of the identical face are added more and more. - But it depends on the used learning algorithm. - - The configuration used for learning of the recognition models. This value can be null. - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - No examples added. - - - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Specifies the face recognition model learning algorithms. - - 3 - - - - Eigenfaces. - - 3 - - - - Fisherfaces. - - 3 - - - - Local Binary Patterns Histograms (LBPH); The default type. - - 3 - - - - Represents result of operations. - - 3 - - - - Gets the value indicating the recognition is successful. - - 3 - - - - Gets the label of the recognized face. - - 3 - - - - Gets the location of the recognized face. - - 3 - - - - The confidence of the recognition model that face has been recognized correctly (value from 0.0 to 1.0). - No faces were recognized if confidence was 0.0. When model has been learned on large amount of examples, - threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples, - then threshold can be reduced (0.5-0.85). - - 3 - - - - Provides the ability to recognize faces, face expressions and eye condition on image sources. - - 3 - - - - Performs face recognition on the source with . - - The of the media to recognize faces for. - The to be used for recognition. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - has already been disposed of. - is untrained model. - 3 - - - - Performs face recognition on the source with and a bounding box. - - The of the media to recognize faces for. - The to be used for recognition. - Rectangular box bounding face image on the source. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - has already been disposed of. - is untrained model. - 3 - - - - Performs face recognition on the source with and . - - The of the media to recognize faces for. - The to be used for recognition. - The configuration used for recognition. This value can be null. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - is untrained model. - 3 - - - - Performs face recognition on the source with , - and a bounding box. - - The of the media to recognize faces for. - The to be used for recognition. - Rectangular box bounding face image on the source. - The used for recognition. This value can be null. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - is untrained model. - 3 - - - - Determines eye-blink condition on media source. - - The source of the media to recognize eye-blink condition for. - The bounding the face at the source. - A task that represents the asynchronous recognition operation. - is null. - has already been disposed of. - The feature is not supported. - 3 - - - - Determines eye-blink condition on media source. - - The source of the media to recognize eye-blink condition for. - The bounding the face at the source. - The configuration used for eye-blink condition recognition. This value can be null. - A task that represents the asynchronous recognition operation. - is null. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - The feature is not supported. - 3 - - - - Determines facial expression on media source. - - The source of the media to recognize facial expression for. - The location bounding the face at the source. - A task that represents the asynchronous recognition operation. - is null. - has already been disposed of. - The feature is not supported. - 3 - - - - Determines facial expression on media source. - - The source of the media to recognize facial expression for. - The location bounding the face at the source. - The configuration used for expression recognition. This value can be null. - A task that represents the asynchronous recognition operation. - is null. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - The feature is not supported. - 3 - - - - Provides the ability to track faces on image sources. - - 3 - - - - Performs face tracking on the source with the trackingModel. - - The source of the media to recognize face for. - The model will be used for tracking. - The value indicating whether model learning while tracking. If it is true then model will try to learn - (if it supports learning feature), otherwise model will be not learned during the invoking tracking iteration. - Learning process improves tracking correctness, but can decrease tracking performance. - A task that represents the asynchronous tracking operation. - - is null.\n - -or-\n - is null. - - - has already been disposed of.\n - -or-\n - has already been disposed of. - - The feature is not supported. - is not prepared. - 3 - - - - Represents face tracking model. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Initializes a new instance of the class with the specified path. - - - Models has been saved by can be loaded. - - Path to the model to load. - is null. - is invalid. - - The feature is not supported.\n - -or-\n - is not supported format. - - No permission to access the specified file. - - 3 - - - - Initializes tracking model by the location of the face to be tracked. - - It is usually called once after tracking model is created and each time before tracking - is started for the new sequence of sources which is not the direct continuation of - the sequence for which tracking has been performed before. But it is allowed to call it - between tracking sessions to allow Media Vision start to track more accurately. - - - needs to be the position of the face to be tracked when called first time for the tracking model. - is fitted to the valid region of if has invalid points. - - The source where face location is specified. - Usually it is the first frame of the video or the first image in the continuous - image sequence planned to be used for tracking. - The region determining position of the face to be tracked on the source. - If null, then tracking model will try to find previously tracked face by itself. - is null. - - The has already been disposed of.\n - -or-\n - has already bean disposed of. - - 3 - - - - Saves the tracking model to the file. - - Path to the file to save the model. - is null. - No permission to write to the specified path. - The has already been disposed of. - The directory for does not exist. - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Represents result of face tracking operation. - - 3 - - - - Gets the value indicating the recognition is successful. - - 3 - - - - Gets the region which determines new position of the tracked face on the source. - - 3 - - - - The confidence of the tracking model that new location of the face was determined correctly - (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0. - - 3 - - - - Specifies the expression types for faces. - - 3 - - - - Unknown face expression. - - 3 - - - - Face expression is neutral. - - 3 - - - - Face expression is smiling. - - 3 - - - - Face expression is sadness. - - 3 - - - - Face expression is surprise. - - 3 - - - - Face expression is anger. - - 3 - - - - Face expression is fear. - - 3 - - - - Face expression is disgust. - - 3 - - - - Represents a configuration of fill operations of instances. - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the scale factor the image to be recognized.\n - The value of the factor will be used for resizing of the images (objects) for recognition. - The default value is 1.2. - - The already has been disposed of. - 3 - - - - Gets or sets the maximum key points should be detected on the image.\n - The maximal number of key points can be selected on the image object to calculate descriptors. - This key points will be used for image (object) recognition and has to be specified as integer number. - The default value is 1000. - - The already has been disposed of. - 3 - - - - Represents an image object. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Initializes a new instance of the class from the specified file. - - - ImageObject has been saved by can be loaded. - - Path to the image object to load. - is null. - is invalid. - - The feature is not supported.\n - -or-\n - is not supported file. - - No permission to access the specified file. - - 3 - - - - Gets a value that determines how well an image object can be recognized. - - - If recognition rate is too low, try to use another image or change some configuration parameters - and fill the image object again. - - - Recognition rate determines how well an image object can be recognized. This value can be from 0 to 1. - If the recognition rate is 0 object can not be recognized and the bigger it is the more likely to recognize the object. - - The has already been disposed of. - - - - - - 3 - - - - Gets the label for the image object. - - - The label value if the has label, otherwise null. - - The has already been disposed of. - - 3 - - - - Sets the label for the . - - - 3 - - - - Fills the image object.\n - Extracts data from @a source image which will be needed for recognition of depicted object in @a location. - - The source image where image object is depicted. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - 3 - - - - Fills the image object.\n - Extracts data from @a source image which will be needed for recognition of depicted object in @a location. - - The source image where image object is depicted. - The configuration used for extract recognition data from source. This value can be null. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of.\n - -or-\n - has already been disposed of. - - 3 - - - - Fills the image object.\n - Extracts data from @a source image which will be needed for recognition of depicted object in @a location. - - The source image where image object is depicted. - Rectangular bound of the image object on the source image. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of.\n - - 3 - - - - Fills the image object.\n - Extracts data from @a source image which will be needed for recognition of depicted object in @a location. - - The source image where image object is depicted. - The configuration used for extract recognition data from source. This value can be null. - Rectangular bound of the image object on the source image. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of.\n - -or-\n - has already been disposed of. - - 3 - - - - Saves the image object. - - Path to the file to save the model. - is null. - No permission to write to the specified path. - The has already been disposed of. - The directory for does not exist. - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Represents a configuration of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the scene scale factor. - - - The value indicating the factor will be used for resizing of the scene including the images (objects) for recognition. - The default is 1.2. - - The already has been disposed of. - 3 - - - - Gets or sets the maximum key points that should be detected on the scene. - The maximal number of key points can be selected on the scene including the images (objects) to calculate descriptors. - - - The maximal key points for image recognition. - The default is 5000. - - The already has been disposed of. - is less than zero. - 3 - - - - Gets or sets the minimum number of key points matches required for recognition. - - - The minimal number of key points should be matched between an image and a scene for image objects recognition. - The default is 30. - - The already has been disposed of. - is less than zero. - 3 - - - - Gets or sets the required matching part for the image recognition. - To recognize occluded or hidden an image by other images, required relative part of the matches in respect to the total - amount of matching keypoints required for image recognition. Too low value will result in unsustainable behavior, - but effect of object overlapping will be reduced. - - - The value indicating required relative part of the matches; can be from 0 to 1, inclusive. - The default is 0.05. - - The already has been disposed of. - - is less than zero.\n - -or-\n - is greater than one. - - 3 - - - - Gets or sets the part matching error for the image recognition.\n - Allowable error of matches number. - - - The value indicating allowable error of matches; can be from 0 to 1, inclusive. - The default is 0.1. - - The already has been disposed of. - - is less than zero.\n - -or-\n - is greater than one. - - 3 - - - - Represents a result of RecognizeAsync operations of . - - 3 - - - - The region of recognized image object on the source image. - - 3 - - - - Gets the value indicating the recognition is successful. - - 3 - - - - Provides the ability to recognize images on image sources. - - 3 - - - - Recognizes the given image objects on the source image.\n - - The source image on which image objects will be recognized. - The array of image objects which will be processed as targets of recognition. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null.\n - -or-\n - contains null reference. - - has no elements.(The length is zero.) - The feature is not supported. - has already been disposed of. - 3 - - - - Recognizes the given image objects on the source image.\n - - The source image on which image objects will be recognized. - The array of image objects which will be processed as targets of recognition. - The configuration used for recognition. This value can be null. - A task that represents the asynchronous recognition operation. - - is null.\n - -or-\n - is null.\n - -or-\n - contains null elements. - - has no elements.(The length is zero.) - The feature is not supported. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - 3 - - - - Provides the ability to track images on image sources. - - 3 - - - - Tracks the given image tracking model on the current frame. - - The current image of sequence where image tracking model will be tracked. - The image tracking model which processed as target of tracking. - A task that represents the asynchronous tracking operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - - has already been disposed of.\n - -or-\n - has already been disposed of. - - has no target. - - 3 - - - - Tracks the given image tracking model on the current frame and . - - The current image of sequence where image tracking model will be tracked. - The image tracking model which processed as target of tracking. - The configuration used for tracking. This value can be null. - A task that represents the asynchronous tracking operation. - - is null.\n - -or-\n - is null. - - The feature is not supported. - - has already been disposed of.\n - -or-\n - has already been disposed of.\n - -or-\n - has already been disposed of. - - has no target. - - 3 - - - - Represents a configuration of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets the number of recognition results in the tracking history. - - - The number of previous recognition results, which will influence the stabilization.\n - The default is 3. - - The already has been disposed of. - is less than zero. - 3 - - - - Gets or sets the expected tracking offset. - - - Relative offset value, for which the object offset is expected (relative to the object size in the current frame).\n - The default is 0. - - The already has been disposed of. - 3 - - - - Gets or sets the acceleration of the tracking stabilization. - - - Acceleration will be used for image stabilization (relative to the distance from current location to stabilized location); - from 0 to 1, inclusive.\n - The default is 0.1. - - The already has been disposed of. - - is less than zero.\n - -or-\n - is greater than one. - - 3 - - - - Gets or sets the speed of the tracking stabilization. - - - The start speed value used for image stabilization.\n - The default is 0.3. - - The already has been disposed of. - 3 - - - - Gets or sets the relative tolerant shift for the tracking stabilization. - - - It is component of tolerant shift which will be ignored by stabilization process. - (this value is relative to the object size in the current frame). - Tolerant shift will be computed like R * S + C, where R is the value set to , - S is the area of object location on frame, C is a constant value 1.3.\n - \n - The default is 0.00006. - - The already has been disposed of. - 3 - - - - Gets or sets the state of the contour stabilization during tracking process. - - - true if the contour stabilization is enabled; otherwise, false.\n - The default is true. - - The already has been disposed of. - 3 - - - - Represents the image tracking model interface. - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Initializes a new instance of the class with the specified path. - - - Model have been saved by can be loaded. - - Path to the model to load. - is null. - is invalid. - - The feature is not supported.\n - -or-\n - is not supported format. - - No permission to access the specified file. - - 3 - - - - Sets target of image tracking model.\n - Sets image object which will be tracked by using tracking functionality with this tracking model. - - Image object which will be set as the target for tracking. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - 3 - - - - Refreshes the state of image tracking model.\n - Clears moving history and change state to undetected. It is usually called each time before tracking is started - for the new sequence of sources which is not the direct continuation of the sequence for which tracking has been performed before. - Tracking algorithm will try to find image by itself. - - The has already been disposed of. - 3 - - - - Saves tracking model to the file. - - Path to the file to save the model. - is null. - No permission to write to the specified path. - The has already been disposed of. - The directory for does not exist. - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Enumeration for media vision's error codes. - - - - - Successful - - - - - Not supported - - - - - Message too long - - - - - No data - - - - - Key not available - - - - - Out of memory - - - - - Invalid parameter - - - - - Invalid operation - - - - - Permission denied - - - - - Not supported format - - - - - Internal error - - - - - Invalid data - - - - - Invalid path (Since 3.0) - - - - - Represents the media vision source to keep information on image or video frame data as raw buffer. - - 3 - - - - Initializes a new instance of the class based on the . - - The from which the source will be filled. - The feature is not supported. - is null. - has already been disposed of. - 3 - - - - Initializes a new instance of the class based on the buffer and . - - The buffer of image data. - The width of image. - The height of image. - The image . - The feature is not supported. - is null. - - has no element.(The length is zero.)\n - -or-\n - is invalid. - - 3 - - - - Gets the buffer of the media source. - - The has already been disposed of. - 3 - - - - Gets height of the media source. - - The has already been disposed of. - 3 - - - - Gets width of the media source. - - The has already been disposed of. - 3 - - - - Gets of the media source. - - The has already been disposed of. - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Provides data for the event. - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - Gets a set of rectangular regions where movement was detected. - - 3 - - - - Represents a configuration of . - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets movement detection threshold.\n - This value might be set before subscription on event - to specify the sensitivity of the movement detector. - - - The value indicating the sensitivity of the from 0 to 255 inclusive - where 255 means that no movements will be detected and 0 means that all frame changes - will be interpreted as movements.\n - The default is 10. - - The already has been disposed of. - - is less than zero.\n - -or-\n - is greater than 255. - - 3 - - - - Provides the ability to detect movement on image sources. - - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Occurs when the movement detected. - - The event handler will be executed on an internal thread. - 3 - - - - Adds . - - The source used for recognition. - is null. - The has already been disposed of. - - 3 - - - - Adds with the provided . - - The source used for recognition. - The config for the . This value can be null. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - - 3 - - - - Provides data for the event. - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - Gets a set of rectangular regions where appearances of the persons were detected. - - 3 - - - - Gets a set of rectangular regions where disappearances of the persons were detected. - - 3 - - - - Gets a set of rectangular regions where persons were tracked. - - 3 - - - - Represents a configuration of instances. - - 3 - - - - A read-only field that represents the default value of . - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Gets or sets how many frames will be skipped during push source.\n - - - The value to specify the number of calls will be ignored by subscription - of the event trigger.\n - - The default is 0. It means that no frames will be skipped and all will - be processed. - - The already has been disposed of. - is less than zero. - - 3 - - - - Provides the ability to detect person appearance changes on image sources. - - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Occurs when the any appearance changes detected. - - The event handler will be executed on an internal thread. - 3 - - - - Adds . - - The source used for recognition. - is null. - The has already been disposed of. - - 3 - - - - Adds with the provided . - - The source used for recognition. - The config for the . This value can be null. - is null. - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - - 3 - - - - Represents a configuration of instances. - - 3 - - - - Initializes a new instance of the class. - - Path to the face recognition model. - is null. - The feature is not supported. - 3 - - - - Gets or sets face recognition model file path. - - is null. - The already has been disposed of. - 3 - - - - Represents a result of instances. - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - Gets the rectangular location where person face was recognized. - - 3 - - - - Gets the label that correspond to the recognized person. - - 3 - - - - Gets the confidence value that correspond to the recognized person. - - 3 - - - - Provides data for the event. - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - Gets a set of information that correspond to the recognized persons. - - 3 - - - - Provides the ability to recognize person on image sources. - - - 3 - - - - Initializes a new instance of the class. - - The feature is not supported. - 3 - - - - Occurs when a person recognized. - - The event handler will be executed on an internal thread. - - 3 - - - - Adds with the provided . - - The source used for recognition. - The config for the . - - is null.\n - -or-\n - is null. - - - The has already been disposed of.\n - -or-\n - has already been disposed of. - - - of does not exists. - - - No permission to access to the . - - The model file is not supported format or file. - - 3 - - - - Represents a QR configuration of . - - 3 - - - - Initializes a new instance of the class. - - Encoding mode for the message. - Error correction level. - QR code version. From 1 to 40 inclusive. - - var obj = new QrConfiguration(QrMode.Numeric, ErrorCorrectionLevel.Medium, 30); - - - is less than 1.\n - -or-\n - is greater than 40. - - - is invalid.\n - -or- - is invalid. - - 3 - - - - Gets the encoding mode for the message. - - 3 - - - - Gets the error correction level. - - 3 - - - - Gets the QR code version. - - 3 - - - - Specifies the supported QR code encoding mode. - - 3 - - - - Numeric digits. - - 3 - - - - Alphanumeric characters, '$', '%', '*', '+', '-', '.', '/' and ':'. - - 3 - - - - Raw 8-bit bytes. - - 3 - - - - UTF-8 character encoding. - - 3 - - - - Represents a region with 4 s. - - 3 - - - - Initialize a new instance of the class with an array of . - - must have 4 elements. - four points that define object bounding quadrangle. - The Length of is not 4. - 3 - - - - Gets four points that define the object bounding quadrangle. - - 3 - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - SurveillanceEngineConfiguration is a base class for surveillance configurations. - - 3 - - - - SurveillanceEngine is a base class for surveillance event triggers. - Media Vision Surveillance provides functionality can be utilized for creation of video surveillance systems. - - - - - 3 - - - - Initializes a new instance of the class. - - The type of the event trigger - - - - Sets and gets ROI (Region Of Interest). - - The has already been disposed of. - 3 - - - - Removes the source from . - - is null. - The has already been disposed of. - has not been added. - 3 - - - - Releases all resources used by the object. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Provides the ability to push source to surveillance engines. - - - - - 3 - - - - Initializes a new instance of the class. - - 3 - - - - Pushes source to the surveillance system to detect events. - - The media source used for surveillance. - is null. - has already been disposed of. - This has not been added yet. - - - - - - 3 - - - + + + + Tizen.Multimedia.Vision + + + + + Interop APIs + + + Interop APIs + + + Interop APIs + + + Interop APIs + + + Interop APIs + + + + + Interop for media vision APIs + + + Interop for media vision APIs + + + Interop for media vision APIs + + + Interop for Media vision APIs + + + Interop for media vision APIs + + + + + Interop for barcode detector APIs + + + + + Interop for barcode generator APIs + + + + + Interop for media vision source APIs + + + + + Interop for engine configuration APIs + + + + + Interop for Face APIs + + + + + Interop for FaceRecognitionModel APIs + + + + + Interop for FaceTrackingModel APIs + + + + + Interop for Image APIs + + + + + Interop for ImageTrackingModel APIs + + + + + Interop for surveillance APIs + + + + + Represents a detected barcode. + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + The quadrangle location of detected barcode. + + 3 + + + + The decoded message of barcode. + + 3 + + + + The type of detected barcode. + + 3 + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Represents a configuration of . + + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the target of the barcode detection. + + is not valid. + The already has been disposed of. + 3 + + + + Specifies the target of . + + 3 + + + + 1D and 2D. + + 3 + + + + 1D barcode only. + + 3 + + + + 2D barcode only. + + 3 + + + + Provides the ability to detect barcodes on image sources. + + 3 + + + + Detects barcodes on source and reads message from it. + + The instance. + Region of interest - rectangular area on the source which will be used for + barcode detection. Note that roi should be inside area on the source. + is null. + The feature is not supported. + already has been disposed of. + A task that represents the asynchronous detect operation. + + 3 + + + + Detects barcodes on source and reads message from it with . + + The instance. + Region of interest - rectangular area on the source which will be used for + barcode detection. Note that roi should be inside area on the source. + The configuration of the barcode detector. This value can be null. + A task that represents the asynchronous detect operation. + is null. + The feature is not supported. + + already has been disposed of.\n + -or-\n + already has been disposed of. + + + 3 + + + + Represents a configuration of instances. + + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the text visibility of the barcode to be generated. + + is not valid. + The already has been disposed of. + 3 + + + + Gets or sets the foreground color of the barcode to be generated. + + + The alpha value of the color will be ignored. + + The already has been disposed of. + 3 + + + + Gets or sets the background color of the barcode to be generated. + + + The alpha value of the color will be ignored. + + The already has been disposed of. + 3 + + + + Provides the ability to generate barcodes and QR codes. + Different encoding types , error correction codes + and code versions are supported for QRCodes. + + + 3 + + + + Generates a QR image with the specified message. + + The message to be encoded in the barcode. + The instance. + containing the generated QR image. + + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + contains characters which are illegal by the . + + The feature is not supported. + + 3 + + + + Generates a QR image with the specified message with . + + The message to be encoded in the barcode. + The instance. + The configuration of the barcode generator. This value can be null. + containing the generated QR image. + + must be , + because the text visibility is not supported in the QR code. + + + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + contains characters which are illegal by the . + + + The feature is not supported.\n + -or-\n + is the . + + already has been disposed of. + + 3 + + + + Generates a barcode image with the specified message. + + The message to be encoded in the barcode. + Type of the barcode to be generated. + containing the generated barcode image. + is null. + + is too long.\n + -or-\n + is .\n + -or-\n + is invalid. + -or-\n + contains illegal characters. + + The feature is not supported. + 3 + + + + Generates a barcode image with the specified message and . + + The message to be encoded in the barcode. + Type of the barcode to be generated. + The configuration of the barcode generator. This value can be null. + containing the generated barcode image. + is null. + + is too long.\n + -or-\n + is . + -or-\n + is invalid. + -or-\n + contains illegal characters. + + The feature is not supported. + already has been disposed of. + 3 + + + + Generates a QR image file with the specified message. + + + must be , + because the text visibility is not supported in the QR code. + + The message to be encoded in the barcode. + The instance. + The that contains information about the file to be generated. + + is null.\n + -or-\n + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + contains characters which are illegal by the . + + No permission to write a file. + The feature is not supported. + + 3 + + + + Generates a QR image file with the specified message and . + + + must be , + because the text visibility is not supported in the QR code. + + The message to be encoded in the barcode. + The instance. + The that contains + information about the file to be generated. + The configuration of the barcode generator. This value can be null. + + is null.\n + -or-\n + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + contains characters which are illegal by the . + + No permission to write a file. + + The feature is not supported.\n + -or-\n + is the . + + already has been disposed of. + 3 + + + + Generates a barcode image file with the specified message. + + The message to be encoded in the barcode. + Type of the barcode to be generated. + The that contains + information about the file to be generated. + + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + is . + -or-\n + is invalid. + -or-\n + contains illegal characters. + + No permission to write a file. + The feature is not supported. + 3 + + + + Generates a barcode image file with the specified message and . + + The message to be encoded in the barcode. + Type of the barcode to be generated. + The that contains + information about the file to be generated. + The configuration of the barcode generator. This value can be null. + + is null.\n + -or-\n + is null. + + + is too long.\n + -or-\n + is . + -or-\n + is invalid. + -or-\n + contains illegal characters. + + No permission to write a file. + The feature is not supported. + already has been disposed of. + 3 + + + + Represents a configuration for the image to be generated by . + + 3 + + + + Initializes a new instance of the class. + + + The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n + The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. + + The of the generated image. + The path to the file to be generated. + The format of the output image. + + The width of is less than or equal to zero.\n + -or-\n + The height of is less than or equal to zero. + + is null. + is invalid. + + BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(new Size(500, 400), "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); + + 3 + + + + Initializes a new instance of the class. + + + The mediastorage privilege(http://tizen.org/privilege/mediastorage) is needed if image path is relevant to media storage.\n + The externalstorage privilege(http://tizen.org/privilege/externalstorage) is needed if image path is relevant to external storage. + + The width of the image to be generated. + The height of the image to be generated. + The path to the file to be generated. + The format of the output image. + + is less than or equal to zero.\n + -or-\n + is less than or equal to zero. + + is null. + is invalid. + + BarcodeImageConfiguration imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); + + 3 + + + + Gets the size of the image. + + 3 + + + + Gets the width of the image. + + 3 + + + + Gets the height of the image. + + 3 + + + + Gets the path to the file that has to be generated. + + + The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n + The externalstorage privilege http://tizen.org/privilege/externalstorage is needed if image path is relevant to external storage. + + 3 + + + + Gets the format of the output image. + + 3 + + + + Specifies supported image formats for + + + 3 + + + + BMP image format. + + 3 + + + + JPEG image format. + + 3 + + + + PNG image format. + + 3 + + + + Specifies the supported barcode types. + + + QR codes (versions 1 to 40) and set of 1D barcodes are supported + + + + 3 + + + + 2D barcode - Quick Response code. + + 3 + + + + 1D barcode - Universal Product Code with 12-digit. + + 3 + + + + 1D barcode - Universal Product Code with 6-digit. + + 3 + + + + 1D barcode - International Article Number with 8-digit. + + 3 + + + + 1D barcode - International Article Number with 13-digit. + + 3 + + + + 1D barcode - Code 128. + + 3 + + + + 1D barcode - Code 39. + + 3 + + + + 1D barcode - Interleaved Two of Five. + + 3 + + + + Specifies colorspaces for MediaVision. + + 3 + + + + The colorspace type is invalid. + + 3 + + + + The colorspace type is Y800. + + 3 + + + + The colorspace type is I420. + + 3 + + + + The colorspace type is NV12. + + 3 + + + + The colorspace type is YV12. + + 3 + + + + The colorspace type is NV21. + + 3 + + + + The colorspace type is YUYV. + + 3 + + + + The colorspace type is UYVY. + + 3 + + + + The colorspace type is 422P. + + 3 + + + + The colorspace type is RGB565. + + 3 + + + + The colorspace type is RGB888. + + 3 + + + + The colorspace type is RGBA. + + 3 + + + + A base class for configuration classes. + + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Specifies the supported QR code error correction level. + + 3 + + + + Recovery up to 7% losses. + + 3 + + + + Recovery up to 15% losses. + + 3 + + + + Recovery up to 25% losses. + + 3 + + + + Recovery up to 30% losses. + + 3 + + + + Specifies the eyes state types. + + 3 + + + + Eyes are open. + + 3 + + + + Eyes are closed. + + 3 + + + + The eyes condition wasn't determined. + + 3 + + + + Represents a configuration of instances. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the face detection haarcascade xml file for face detection. + + is null. + 3 + + + + Gets or sets minimum height of face which will be detected. + + + Default value is null (all detected faces will be applied), can be changed to specify the minimum face height. + + is less than zero. + 3 + + + + Gets or sets minimum width of face which will be detected. + + + Default value is null (all detected faces will be applied), can be changed to specify the minimum face width. + + is less than zero. + 3 + + + + Gets or sets the roi of the face detection. + + + Default value is null (the roi will be a full image) can be changed to specify the roi for face detection. + + + The width of is less than or equal to zero.\n + -or-\n + The height of is less than or equal to zero.\n + -or-\n + The x position of is less than zero.\n + -or-\n + The y position of is less than zero.\n + + 3 + + + + Provides the ability to detect faces on image sources. + + 3 + + + + Detects faces on the source.\n + Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously. + + The source of the media where faces will be detected. + A task that represents the asynchronous detect operation. + is null. + + The feature is not supported.\n + -or-\n + The format of is not supported. + + 3 + + + + Detects faces on the source.\n + Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously. + + The source of the media where faces will be detected. + The configuration of engine will be used for detecting. This value can be null. + A task that represents the asynchronous detect operation. + is null. + The feature is not supported. + 3 + + + + Represents a configuration of instances. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the method used for face recognition model learning. + Default value is . + + is not valid. + 3 + + + + Represents the face recognition model interface. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Initializes a new instance of the class with the specified path. + + + Models have been saved by can be loaded. + + Path to the model to load. + is null. + is invalid. + + The feature is not supported.\n + -or-\n + is not supported format. + + No permission to access the specified file. + + 3 + + + + Gets labels that had been learned by the model. + + 3 + + + + Saves the recognition model to the file. + + Path to the file to save the model. + is null. + No permission to write to the specified path. + The has already been disposed of. + The directory for does not exist. + 3 + + + + Adds face image example to be used for face recognition model learning. + + The that contains face image. + The label that identifies face for which example is adding. + Specify the same labels for the face images of a single person when calling this method. + Has to be unique for each face. + is null. + + The has already been disposed of.\n + -or-\n + has already been dispose of. + + + 3 + + + + Adds face image example to be used for face recognition model learning. + + The that contains face image. + The label that identifies face for which example is adding. + Specify the same labels for the face images of a single person when calling this method. + Has to be unique for each face. + The rectangular region of the face image at the source image. + is null. + + The has already been disposed of.\n + -or-\n + has already been dispose of. + + + 3 + + + + Removes all face examples added with the specified label. + + The label that identifies face for which examples will be removed. + The has already been disposed of. + true if the examples are successfully removed; otherwise, false if there is no example labeled with the specified label. + + + 3 + + + + Removes all face examples. + + The has already been disposed of. + 3 + + + + Learns face recognition model. + + + Before you start learning process, face recognition models has to be filled with training data - face image examples. + These examples has to be provided by or . + Recognition accuracy is usually increased when the different examples of the identical face are added more and more. + But it depends on the used learning algorithm. + + The has already been disposed of. + No examples added. + + + 3 + + + + Learns face recognition model with . + + + Before you start learning process, face recognition models has to be filled with training data - face image examples. + These examples has to be provided by or . + Recognition accuracy is usually increased when the different examples of the identical face are added more and more. + But it depends on the used learning algorithm. + + The configuration used for learning of the recognition models. This value can be null. + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + No examples added. + + + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Specifies the face recognition model learning algorithms. + + 3 + + + + Eigenfaces. + + 3 + + + + Fisherfaces. + + 3 + + + + Local Binary Patterns Histograms (LBPH); The default type. + + 3 + + + + Represents result of operations. + + 3 + + + + Gets the value indicating the recognition is successful. + + 3 + + + + Gets the label of the recognized face. + + 3 + + + + Gets the location of the recognized face. + + 3 + + + + The confidence of the recognition model that face has been recognized correctly (value from 0.0 to 1.0). + No faces were recognized if confidence was 0.0. When model has been learned on large amount of examples, + threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples, + then threshold can be reduced (0.5-0.85). + + 3 + + + + Provides the ability to recognize faces, face expressions and eye condition on image sources. + + 3 + + + + Performs face recognition on the source with . + + The of the media to recognize faces for. + The to be used for recognition. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + has already been disposed of. + is untrained model. + 3 + + + + Performs face recognition on the source with and a bounding box. + + The of the media to recognize faces for. + The to be used for recognition. + Rectangular box bounding face image on the source. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + has already been disposed of. + is untrained model. + 3 + + + + Performs face recognition on the source with and . + + The of the media to recognize faces for. + The to be used for recognition. + The configuration used for recognition. This value can be null. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + is untrained model. + 3 + + + + Performs face recognition on the source with , + and a bounding box. + + The of the media to recognize faces for. + The to be used for recognition. + Rectangular box bounding face image on the source. + The used for recognition. This value can be null. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + is untrained model. + 3 + + + + Determines eye-blink condition on media source. + + The source of the media to recognize eye-blink condition for. + The bounding the face at the source. + A task that represents the asynchronous recognition operation. + is null. + has already been disposed of. + The feature is not supported. + 3 + + + + Determines eye-blink condition on media source. + + The source of the media to recognize eye-blink condition for. + The bounding the face at the source. + The configuration used for eye-blink condition recognition. This value can be null. + A task that represents the asynchronous recognition operation. + is null. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + The feature is not supported. + 3 + + + + Determines facial expression on media source. + + The source of the media to recognize facial expression for. + The location bounding the face at the source. + A task that represents the asynchronous recognition operation. + is null. + has already been disposed of. + The feature is not supported. + 3 + + + + Determines facial expression on media source. + + The source of the media to recognize facial expression for. + The location bounding the face at the source. + The configuration used for expression recognition. This value can be null. + A task that represents the asynchronous recognition operation. + is null. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + The feature is not supported. + 3 + + + + Provides the ability to track faces on image sources. + + 3 + + + + Performs face tracking on the source with the trackingModel. + + The source of the media to recognize face for. + The model will be used for tracking. + The value indicating whether model learning while tracking. If it is true then model will try to learn + (if it supports learning feature), otherwise model will be not learned during the invoking tracking iteration. + Learning process improves tracking correctness, but can decrease tracking performance. + A task that represents the asynchronous tracking operation. + + is null.\n + -or-\n + is null. + + + has already been disposed of.\n + -or-\n + has already been disposed of. + + The feature is not supported. + is not prepared. + 3 + + + + Represents face tracking model. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Initializes a new instance of the class with the specified path. + + + Models has been saved by can be loaded. + + Path to the model to load. + is null. + is invalid. + + The feature is not supported.\n + -or-\n + is not supported format. + + No permission to access the specified file. + + 3 + + + + Initializes tracking model by the location of the face to be tracked. + + It is usually called once after tracking model is created and each time before tracking + is started for the new sequence of sources which is not the direct continuation of + the sequence for which tracking has been performed before. But it is allowed to call it + between tracking sessions to allow Media Vision start to track more accurately. + + + needs to be the position of the face to be tracked when called first time for the tracking model. + is fitted to the valid region of if has invalid points. + + The source where face location is specified. + Usually it is the first frame of the video or the first image in the continuous + image sequence planned to be used for tracking. + The region determining position of the face to be tracked on the source. + If null, then tracking model will try to find previously tracked face by itself. + is null. + + The has already been disposed of.\n + -or-\n + has already bean disposed of. + + 3 + + + + Saves the tracking model to the file. + + Path to the file to save the model. + is null. + No permission to write to the specified path. + The has already been disposed of. + The directory for does not exist. + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Represents result of face tracking operation. + + 3 + + + + Gets the value indicating the recognition is successful. + + 3 + + + + Gets the region which determines new position of the tracked face on the source. + + 3 + + + + The confidence of the tracking model that new location of the face was determined correctly + (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0. + + 3 + + + + Specifies the expression types for faces. + + 3 + + + + Unknown face expression. + + 3 + + + + Face expression is neutral. + + 3 + + + + Face expression is smiling. + + 3 + + + + Face expression is sadness. + + 3 + + + + Face expression is surprise. + + 3 + + + + Face expression is anger. + + 3 + + + + Face expression is fear. + + 3 + + + + Face expression is disgust. + + 3 + + + + Represents a configuration of fill operations of instances. + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the scale factor the image to be recognized.\n + The value of the factor will be used for resizing of the images (objects) for recognition. + The default value is 1.2. + + The already has been disposed of. + 3 + + + + Gets or sets the maximum key points should be detected on the image.\n + The maximal number of key points can be selected on the image object to calculate descriptors. + This key points will be used for image (object) recognition and has to be specified as integer number. + The default value is 1000. + + The already has been disposed of. + 3 + + + + Represents an image object. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Initializes a new instance of the class from the specified file. + + + ImageObject has been saved by can be loaded. + + Path to the image object to load. + is null. + is invalid. + + The feature is not supported.\n + -or-\n + is not supported file. + + No permission to access the specified file. + + 3 + + + + Gets a value that determines how well an image object can be recognized. + + + If recognition rate is too low, try to use another image or change some configuration parameters + and fill the image object again. + + + Recognition rate determines how well an image object can be recognized. This value can be from 0 to 1. + If the recognition rate is 0 object can not be recognized and the bigger it is the more likely to recognize the object. + + The has already been disposed of. + + + + + + 3 + + + + Gets the label for the image object. + + + The label value if the has label, otherwise null. + + The has already been disposed of. + + 3 + + + + Sets the label for the . + + + 3 + + + + Fills the image object.\n + Extracts data from @a source image which will be needed for recognition of depicted object in @a location. + + The source image where image object is depicted. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + 3 + + + + Fills the image object.\n + Extracts data from @a source image which will be needed for recognition of depicted object in @a location. + + The source image where image object is depicted. + The configuration used for extract recognition data from source. This value can be null. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of.\n + -or-\n + has already been disposed of. + + 3 + + + + Fills the image object.\n + Extracts data from @a source image which will be needed for recognition of depicted object in @a location. + + The source image where image object is depicted. + Rectangular bound of the image object on the source image. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of.\n + + 3 + + + + Fills the image object.\n + Extracts data from @a source image which will be needed for recognition of depicted object in @a location. + + The source image where image object is depicted. + The configuration used for extract recognition data from source. This value can be null. + Rectangular bound of the image object on the source image. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of.\n + -or-\n + has already been disposed of. + + 3 + + + + Saves the image object. + + Path to the file to save the model. + is null. + No permission to write to the specified path. + The has already been disposed of. + The directory for does not exist. + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Represents a configuration of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the scene scale factor. + + + The value indicating the factor will be used for resizing of the scene including the images (objects) for recognition. + The default is 1.2. + + The already has been disposed of. + 3 + + + + Gets or sets the maximum key points that should be detected on the scene. + The maximal number of key points can be selected on the scene including the images (objects) to calculate descriptors. + + + The maximal key points for image recognition. + The default is 5000. + + The already has been disposed of. + is less than zero. + 3 + + + + Gets or sets the minimum number of key points matches required for recognition. + + + The minimal number of key points should be matched between an image and a scene for image objects recognition. + The default is 30. + + The already has been disposed of. + is less than zero. + 3 + + + + Gets or sets the required matching part for the image recognition. + To recognize occluded or hidden an image by other images, required relative part of the matches in respect to the total + amount of matching keypoints required for image recognition. Too low value will result in unsustainable behavior, + but effect of object overlapping will be reduced. + + + The value indicating required relative part of the matches; can be from 0 to 1, inclusive. + The default is 0.05. + + The already has been disposed of. + + is less than zero.\n + -or-\n + is greater than one. + + 3 + + + + Gets or sets the part matching error for the image recognition.\n + Allowable error of matches number. + + + The value indicating allowable error of matches; can be from 0 to 1, inclusive. + The default is 0.1. + + The already has been disposed of. + + is less than zero.\n + -or-\n + is greater than one. + + 3 + + + + Represents a result of RecognizeAsync operations of . + + 3 + + + + The region of recognized image object on the source image. + + 3 + + + + Gets the value indicating the recognition is successful. + + 3 + + + + Provides the ability to recognize images on image sources. + + 3 + + + + Recognizes the given image objects on the source image.\n + + The source image on which image objects will be recognized. + The array of image objects which will be processed as targets of recognition. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null.\n + -or-\n + contains null reference. + + has no elements.(The length is zero.) + The feature is not supported. + has already been disposed of. + 3 + + + + Recognizes the given image objects on the source image.\n + + The source image on which image objects will be recognized. + The array of image objects which will be processed as targets of recognition. + The configuration used for recognition. This value can be null. + A task that represents the asynchronous recognition operation. + + is null.\n + -or-\n + is null.\n + -or-\n + contains null elements. + + has no elements.(The length is zero.) + The feature is not supported. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + 3 + + + + Provides the ability to track images on image sources. + + 3 + + + + Tracks the given image tracking model on the current frame. + + The current image of sequence where image tracking model will be tracked. + The image tracking model which processed as target of tracking. + A task that represents the asynchronous tracking operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + + has already been disposed of.\n + -or-\n + has already been disposed of. + + has no target. + + 3 + + + + Tracks the given image tracking model on the current frame and . + + The current image of sequence where image tracking model will be tracked. + The image tracking model which processed as target of tracking. + The configuration used for tracking. This value can be null. + A task that represents the asynchronous tracking operation. + + is null.\n + -or-\n + is null. + + The feature is not supported. + + has already been disposed of.\n + -or-\n + has already been disposed of.\n + -or-\n + has already been disposed of. + + has no target. + + 3 + + + + Represents a configuration of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets the number of recognition results in the tracking history. + + + The number of previous recognition results, which will influence the stabilization.\n + The default is 3. + + The already has been disposed of. + is less than zero. + 3 + + + + Gets or sets the expected tracking offset. + + + Relative offset value, for which the object offset is expected (relative to the object size in the current frame).\n + The default is 0. + + The already has been disposed of. + 3 + + + + Gets or sets the acceleration of the tracking stabilization. + + + Acceleration will be used for image stabilization (relative to the distance from current location to stabilized location); + from 0 to 1, inclusive.\n + The default is 0.1. + + The already has been disposed of. + + is less than zero.\n + -or-\n + is greater than one. + + 3 + + + + Gets or sets the speed of the tracking stabilization. + + + The start speed value used for image stabilization.\n + The default is 0.3. + + The already has been disposed of. + 3 + + + + Gets or sets the relative tolerant shift for the tracking stabilization. + + + It is component of tolerant shift which will be ignored by stabilization process. + (this value is relative to the object size in the current frame). + Tolerant shift will be computed like R * S + C, where R is the value set to , + S is the area of object location on frame, C is a constant value 1.3.\n + \n + The default is 0.00006. + + The already has been disposed of. + 3 + + + + Gets or sets the state of the contour stabilization during tracking process. + + + true if the contour stabilization is enabled; otherwise, false.\n + The default is true. + + The already has been disposed of. + 3 + + + + Represents the image tracking model interface. + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Initializes a new instance of the class with the specified path. + + + Model have been saved by can be loaded. + + Path to the model to load. + is null. + is invalid. + + The feature is not supported.\n + -or-\n + is not supported format. + + No permission to access the specified file. + + 3 + + + + Sets target of image tracking model.\n + Sets image object which will be tracked by using tracking functionality with this tracking model. + + Image object which will be set as the target for tracking. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + 3 + + + + Refreshes the state of image tracking model.\n + Clears moving history and change state to undetected. It is usually called each time before tracking is started + for the new sequence of sources which is not the direct continuation of the sequence for which tracking has been performed before. + Tracking algorithm will try to find image by itself. + + The has already been disposed of. + 3 + + + + Saves tracking model to the file. + + Path to the file to save the model. + is null. + No permission to write to the specified path. + The has already been disposed of. + The directory for does not exist. + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Enumeration for media vision's error codes. + + + + + Successful + + + + + Not supported + + + + + Message too long + + + + + No data + + + + + Key not available + + + + + Out of memory + + + + + Invalid parameter + + + + + Invalid operation + + + + + Permission denied + + + + + Not supported format + + + + + Internal error + + + + + Invalid data + + + + + Invalid path (Since 3.0) + + + + + Represents the media vision source to keep information on image or video frame data as raw buffer. + + 3 + + + + Initializes a new instance of the class based on the . + + The from which the source will be filled. + The feature is not supported. + is null. + has already been disposed of. + 3 + + + + Initializes a new instance of the class based on the buffer and . + + The buffer of image data. + The width of image. + The height of image. + The image . + The feature is not supported. + is null. + + has no element.(The length is zero.)\n + -or-\n + is invalid. + + 3 + + + + Gets the buffer of the media source. + + The has already been disposed of. + 3 + + + + Gets height of the media source. + + The has already been disposed of. + 3 + + + + Gets width of the media source. + + The has already been disposed of. + 3 + + + + Gets of the media source. + + The has already been disposed of. + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Provides data for the event. + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + Gets a set of rectangular regions where movement was detected. + + 3 + + + + Represents a configuration of . + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets movement detection threshold.\n + This value might be set before subscription on event + to specify the sensitivity of the movement detector. + + + The value indicating the sensitivity of the from 0 to 255 inclusive + where 255 means that no movements will be detected and 0 means that all frame changes + will be interpreted as movements.\n + The default is 10. + + The already has been disposed of. + + is less than zero.\n + -or-\n + is greater than 255. + + 3 + + + + Provides the ability to detect movement on image sources. + + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Occurs when the movement detected. + + The event handler will be executed on an internal thread. + 3 + + + + Adds . + + The source used for recognition. + is null. + The has already been disposed of. + + 3 + + + + Adds with the provided . + + The source used for recognition. + The config for the . This value can be null. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + + 3 + + + + Provides data for the event. + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + Gets a set of rectangular regions where appearances of the persons were detected. + + 3 + + + + Gets a set of rectangular regions where disappearances of the persons were detected. + + 3 + + + + Gets a set of rectangular regions where persons were tracked. + + 3 + + + + Represents a configuration of instances. + + 3 + + + + A read-only field that represents the default value of . + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Gets or sets how many frames will be skipped during push source.\n + + + The value to specify the number of calls will be ignored by subscription + of the event trigger.\n + + The default is 0. It means that no frames will be skipped and all will + be processed. + + The already has been disposed of. + is less than zero. + + 3 + + + + Provides the ability to detect person appearance changes on image sources. + + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Occurs when the any appearance changes detected. + + The event handler will be executed on an internal thread. + 3 + + + + Adds . + + The source used for recognition. + is null. + The has already been disposed of. + + 3 + + + + Adds with the provided . + + The source used for recognition. + The config for the . This value can be null. + is null. + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + + 3 + + + + Represents a configuration of instances. + + 3 + + + + Initializes a new instance of the class. + + Path to the face recognition model. + is null. + The feature is not supported. + 3 + + + + Gets or sets face recognition model file path. + + is null. + The already has been disposed of. + 3 + + + + Represents a result of instances. + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + Gets the rectangular location where person face was recognized. + + 3 + + + + Gets the label that correspond to the recognized person. + + 3 + + + + Gets the confidence value that correspond to the recognized person. + + 3 + + + + Provides data for the event. + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + Gets a set of information that correspond to the recognized persons. + + 3 + + + + Provides the ability to recognize person on image sources. + + + 3 + + + + Initializes a new instance of the class. + + The feature is not supported. + 3 + + + + Occurs when a person recognized. + + The event handler will be executed on an internal thread. + + 3 + + + + Adds with the provided . + + The source used for recognition. + The config for the . + + is null.\n + -or-\n + is null. + + + The has already been disposed of.\n + -or-\n + has already been disposed of. + + + of does not exists. + + + No permission to access to the . + + The model file is not supported format or file. + + 3 + + + + Represents a QR configuration of . + + 3 + + + + Initializes a new instance of the class. + + Encoding mode for the message. + Error correction level. + QR code version. From 1 to 40 inclusive. + + var obj = new QrConfiguration(QrMode.Numeric, ErrorCorrectionLevel.Medium, 30); + + + is less than 1.\n + -or-\n + is greater than 40. + + + is invalid.\n + -or- + is invalid. + + 3 + + + + Gets the encoding mode for the message. + + 3 + + + + Gets the error correction level. + + 3 + + + + Gets the QR code version. + + 3 + + + + Specifies the supported QR code encoding mode. + + 3 + + + + Numeric digits. + + 3 + + + + Alphanumeric characters, '$', '%', '*', '+', '-', '.', '/' and ':'. + + 3 + + + + Raw 8-bit bytes. + + 3 + + + + UTF-8 character encoding. + + 3 + + + + Represents a region with 4 s. + + 3 + + + + Initialize a new instance of the class with an array of . + + must have 4 elements. + four points that define object bounding quadrangle. + The Length of is not 4. + 3 + + + + Gets four points that define the object bounding quadrangle. + + 3 + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + SurveillanceEngineConfiguration is a base class for surveillance configurations. + + 3 + + + + SurveillanceEngine is a base class for surveillance event triggers. + Media Vision Surveillance provides functionality can be utilized for creation of video surveillance systems. + + + + + 3 + + + + Initializes a new instance of the class. + + The type of the event trigger + + + + Sets and gets ROI (Region Of Interest). + + The has already been disposed of. + 3 + + + + Removes the source from . + + is null. + The has already been disposed of. + has not been added. + 3 + + + + Releases all resources used by the object. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Provides the ability to push source to surveillance engines. + + + + + 3 + + + + Initializes a new instance of the class. + + 3 + + + + Pushes source to the surveillance system to detect events. + + The media source used for surveillance. + is null. + has already been disposed of. + This has not been added yet. + + + + + + 3 + + + diff --git a/Artifacts/bin/Tizen.Multimedia.dll b/Artifacts/bin/Tizen.Multimedia.dll index 3dd8169..393dd2d 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.dll and b/Artifacts/bin/Tizen.Multimedia.dll differ diff --git a/Artifacts/bin/Tizen.Multimedia.pdb b/Artifacts/bin/Tizen.Multimedia.pdb index 3fb4472..cc271f8 100644 Binary files a/Artifacts/bin/Tizen.Multimedia.pdb and b/Artifacts/bin/Tizen.Multimedia.pdb differ diff --git a/Artifacts/bin/Tizen.Multimedia.xml b/Artifacts/bin/Tizen.Multimedia.xml index a665e12..7502403 100644 --- a/Artifacts/bin/Tizen.Multimedia.xml +++ b/Artifacts/bin/Tizen.Multimedia.xml @@ -1,2466 +1,2466 @@ - - - - Tizen.Multimedia - - - - - The Device API provides functions to query the information of sound devices. - - - - - Gets the id of the device. - - The id of the device. - - - - Gets the name of the device. - - The name of the device. - - - - Gets the type of the device. - - The of the device. - - - - Gets the IO direction of the device. - - The IO direction of the device. - - - - Gets the state of the device. - - The of the device. - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Compares an object to an instance of for equality. - - A to compare. - true if the two devices are equal; otherwise, false. - - - - Gets the hash code for this instance of . - - The hash code for this instance of . - - - - Provides data for the event. - - - - - Gets the device. - - The . - - - - Gets the connection state of the device. - - true if the device is connected; otherwise, false. - - - - Provides data for the event. - - - - - Gets the device. - - The . - - - - Gets the state of the device. - - The of the device. - - - - Provides the ability to control volume levels and monitor audio devices. - - - - - Gets the volume controller. - - The . - - - - Gets the all devices currently connected. - - An IEnumerable<AudioDevice> that contains connected devices. - - - - Occurs when the state of connection of an audio device changes. - - - - - Occurs when the state of an audio device changes. - - - - - Specifies the flag for audio device options. - - This enumeration has a attribute that allows a bitwise combination of its member values. - - - - - - Input devices. - - - - - Output devices. - - - - - Input and output devices (both directions are available). - - - - - Built-in devices. - - - - - External devices. - - - - - Deactivated devices. - - - - - Activated devices. - - - - - All devices. - - - - - Specifies audio device type. - - - - - Built-in speaker. - - - - - Built-in receiver. - - - - - Built-in microphone. - - - - - Audio jack that can be connected to wired accessory such as headphones and headsets. - - - - - Bluetooth Media (A2DP). - - - - - HDMI. - - - - - Device for forwarding. - - - - - USB Audio. - - - - - Bluetooth Voice (SCO). - - - - - Specifies audio device direction. - - - - - Input device. - - - - - Output device. - - - - - Input/output device (both directions are available). - - - - - Specifies audio device state. - - - - - Deactivated state. - - - - - Activated state. - - - - - Specifies audio volume type. - - - - - System. - - - - - Notification. - - - - - Alarm. - - - - - Ringtone. - - - - - Media. - - - - - Call. - - - - - VoIP. - - - - - Voice. - - - - - No volume exists. - - - - - - Specifies audio stream type. - - - - - Media. - - - - - System. - - - - - Alarm. - - - - - Notification. - - - - - Emergency. - - - - - Voice information. - - - - - Voice recognition. - - - - - Ringtone for VoIP. - - - - - VoIP. - - - - - Media only for external devices. - - - - - Specifies change reason of audio stream focus state. - - - - - Media. - - - - - System. - - - - - Alarm. - - - - - Notification. - - - - - Emergency. - - - - - Voice information. - - - - - Voice recognition. - - - - - Ringtone. - - - - - VoIP. - - - - - Voice-call or video-call. - - - - - Media only for external devices. - - - - - Specifies the flag for audio stream focus options. - - This enumeration has a attribute that allows a bitwise combination of its member values. - - - - - - Playback focus. - - - - - Recording focus. - - - - - Specifies audio stream focus state. - - - - - Focus state for release. - - - - - Focus state for acquisition. - - - - - Specifies the flag for audio stream behaviors. - - This enumeration has a attribute that allows a bitwise combination of its member values. - - - - - - No Resume. - - - - - Fading. - - - - - Successful - - - - - Out of memory - - - - - Invalid parameter - - - - - Invalid operation - - - - - Permission denied - - - - - Not supported - - - - - No data - - - - - Internal error inside the sound system - - - - - Noncompliance with the sound system policy - - - - - No playing sound - - - - - Invalid state (Since 3.0) - - - - - The exception that is thrown when noncompliance with the sound system policy happens. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class with a specified error message and inner exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception.. - - - - Provides the ability to control a sound stream. - - - - - Initializes a new instance of the class with - - - To apply the stream policy according to this stream information, the AudioStreamPolicy should - be passed to other APIs related to playback or recording. (e.g., , , etc.) - - Type of sound stream for which policy needs to be created. - is invalid. - - - - Occurs when the state of focus that belongs to the current AudioStreamPolicy is changed. - - - The event is raised in the internal thread. - - - - - Gets the . - - - If the of the current AudioStreamPolicy is , - it returns . - - The of the policy instance. - The has already been disposed of. - - - - Gets the state of focus for playback. - - The state of focus for playback. - The has already been disposed of. - - - - Gets the state of focus for recording. - - The state of focus for recording. - The has already been disposed of. - - - - Gets or sets the auto focus reacquisition. - - - true if the auto focus reacquisition is enabled; otherwise, false.\n - The default is true. - - - If you don't want to reacquire the focus you've lost automatically, - disable the focus reacquisition. - - The has already been disposed of. - - - - Acquires the stream focus. - - The focuses that you want to acquire. - The requesting behaviors. - The extra information for this request. This value can be null. - is zero. - - contain a invalid bit.\n - -or-\n - contain a invalid bit.\n - - The focus has already been acquired. - Called in raised by releasing focus. - The has already been disposed of. - - - - Releases the acquired focus. - - The focus mask that you want to release. - The requesting behaviors. - The extra information for this request. This value can be null. - is zero. - - contain a invalid bit.\n - -or-\n - contain a invalid bit.\n - - The focus has not been acquired. - The has already been disposed of. - - - - Applies the stream routing. - - - If the stream has not been made yet, this will be applied when the stream starts to play. - - - - The has already been disposed of. - - - - - - Releases all resources used by the . - - - - - Releases the unmanaged resources used by the . - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Occurs when the focus state for stream types is changed regardless of the process. - - - - - Provides data for the event. - - - - - Gets the focus options. - - The focus options. - - - - Gets the focus state. - - The focus state. - - - - Gets the reason for state change of the focus. - - The reason for state change of the focus. - - - - Gets the requested behaviors that should be followed - - The requested behaviors that should be followed. - - - - Gets the extra information. - - - The extra information specified in or - . - - - - - - - Provides the ability to control the volume levels. - - - - - - Occurs when the volume level is changed. - - - - - Gets the volume type of the sound being currently played. - - The volume type of the sound being currently played. - - - - Gets the . - - The . - - - - Gets the . - - The . - - - - Provides a means to get max volume levels. - - - - - Gets the max volume level of the specified - - The to query. - The maximum volume level. - is invalid. - is . - - - - Provides data for the event. - - - - - Gets the focus options. - - The focus options. - - - - Gets the changed focus state. - - The focus state. - - - - Gets the reason for state change of the focus. - - The reason for state change of the focus. - - - - Gets the extra information. - - - The extra information specified in or - . - - - - - - - Provides data for the event. - - - - - Gets the sound type that volume is changed. - - The sound type that volume is changed. - - - - Gets the new volume. - - The new volume level. - - - - Provides a means to control volume levels. - - - - - Gets or sets the volume level of the specified - - The to control. - The current volume level. - To set volumes, the specified privilege is required. - http://tizen.org/privilege/volume.set - is invalid. - - is . - -or- - is less than zero. - -or- - is greater than . - - Caller does not have required privilege to set volume. - - - - Specifies whether a codec is audio codec or video codec. - - - - - Audio codec - - - - - Video codec - - - - - The exception that is thrown when the codec for an input file or a data stream is not supported - or the input is malformed. - - - - - Initializes a new instance of the class - with indicating which codec is not supported. - - - - - Initializes a new instance of the class with - indicating which codec is not supported and a specified error message. - - - - - Gets the of the exception. - - - - - Specifies color spaces for Tizen.Multimedia. - - - - - Y800 - - - - - I420 - - - - - NV12 - - - - - NV16 - - - - - NV21 - - - - - NV61 - - - - - YV12 - - - - - - YUYV - - - - - YUV422 - - - - - UYVY - - - - - YUV422P - - - - - - RGB565 - - - - - RGB888 - - - - - RGBA8888 - - - - - ARGB8888 - - - - - BGRA8888 - - - - - BGRX8888 - - - - - Overlay surface display - - - - - Evas image object surface display - - - - - This disposes off buffers - - - - - Provides a means to wrap various display types. - - - - - - - - Initializes a new instance of the class with a class. - - http://tizen.org/feature/multimedia.raw_video - The required feature is not supported. - - - - Initializes a new instance of the class with a class. - - - - - The exception that is thrown when an input file or a data stream that is supposed to conform - to a certain file format specification is malformed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a specified error message. - - - - - Specifies the flip operation. - - - - - No flip operation. - - - - - Flip horizontally. - - - - - Flip vertically. - - - - - Provides functionality to read a media buffer. - - - - - Gets or sets a value at the specified index. - - The index of the value to get or set. - - index is less than zero.\n - -or-\n - index is equal to or greater than . - - The object that owns the current buffer already has been disposed of. - The buffer is not available. i.e. not writable state. - - - - Gets the size of the buffer, in bytes. - - - - - Copies data from a byte array to the buffer. - - The array to copy to. - The zero-based index in the source array where copying should start. - The number of array elements to copy. - startIndex or length is not valid. - The object that owns the current buffer already has been disposed of. - - - - Copies data from a byte array to the buffer. - - The array to copy to. - The zero-based index in the source array where copying should start. - The number of array elements to copy. - The zero-based index in the buffer where copying should start. - startIndex, offset or length is not valid. - The object that owns the current buffer already has been disposed of. - - - - Provides functionality to read and write a media buffer. - - - - - Copies data from the buffer to a byte array. - - The array to copy from. - The zero-based index in the dest array where copying should start. - The number of elements to copy. - startIndex or length is not valid. - The object that owns the current buffer already has been disposed of. - The buffer is not available. i.e. not writable state. - - - - Copies data from the buffer to a byte array. - - The array to copy from. - The zero-based index in the dest array where copying should start. - The number of elements to copy. - The zero-based index in the buffer where copying should start. - startIndex, offset or length is not valid. - The object that owns the current buffer already has been disposed of. - The buffer is not available. i.e. not writable state. - - - - Represents a buffer for a . - - - - - Validates the range - - - - - offset + length is greater than .\n - -or-\n - offset or length is less than zero. - - - - - Represents a point in 2D space. - - - - - Initializes a new instance of the Point with the specified coordinates. - - X-axis coordinate of the point in 2D space. - Y-axis coordinate of the point in 2D space. - - - - Gets or sets X-axis coordinate of the point in 2D space. - - - - - Gets or sets Y-axis coordinate of the point in 2D space. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Gets the hash code for this instance of . - - The hash code for this instance of . - - - - Compares an object to an instance of for equality. - - A to compare. - true if the points are equal; otherwise, false. - - - - Compares two instances of for equality. - - A to compare. - A to compare. - true if the two instances of are equal; otherwise false. - - - - Compares two instances of for inequality. - - A to compare. - A to compare. - true if the two instances of are not equal; otherwise false. - - - - Represents a range(min, max) value. - - - - - Initializes a new instance of the Range with the specified values. - - Minimum value of the range. - Maximum value of the range. - is less than . - - - - Gets or sets minimum value of the range. - - - - - Gets or sets maximum value of the range. - - - - - Gets length of the range. - - - - - Determines if the specified value is inside of the range. - - A value to check. - true if the value is inside of the range; otherwise false. - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Gets the hash code for this instance of . - - The hash code for this instance of . - - - - Compares an object to an instance of for equality. - - A to compare. - true if the two ranges are equal; otherwise, false. - - - - Compares two instances of for equality. - - A to compare. - A to compare. - true if the two instances of are equal; otherwise false. - - - - Compares two instances of for inequality. - - A to compare. - A to compare. - true if the two instances of are not equal; otherwise false. - - - - This class represents location of the object bounded by rectangle defined by - coordinates of top left corner, width and height. - - - - - Initializes a new instance of the Rectangle with the specified values. - - The x-coordinate of the upper-left corner of the rectangle. - The y-coordinate of the upper-left corner of the rectangle. - The Width of the rectangle. - The Height of the rectangle. - - - - Initializes a new instance of the Rectangle with the specified values. - - A that represents the upper-left corner of the rectangular region. - A that represents the width and height of the rectangular region. - - - - Gets or sets the coordinates of the upper-left corner of the rectangle. - - - - - Gets or sets the x-coordinate of the upper-left corner of the rectangle. - - - - - Gets or sets the y-coordinate of the upper-left corner of the rectangle. - - - - - Gets or sets the width of the rectangle. - - - - - Gets or sets the height of the rectangle. - - - - - Gets the x-coordinate of the left edge of the rectangle. - - - - - Gets the y-coordinate of the top edge of the rectangle. - - - - - Gets the x-coordinate of the right edge of the rectangle. - - - - - Gets the y-coordinate of the bottom edge of the rectangle. - - - - - Gets or sets the size of the rectangle. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Gets the hash code for this instance of . - - The hash code for this instance of . - - - - Compares an object to an instance of for equality. - - A to compare. - true if the rectangles are equal; otherwise, false. - - - - Compares two instances of for equality. - - A to compare. - A to compare. - true if the two instances of are equal; otherwise false. - - - - Compares two instances of for inequality. - - A to compare. - A to compare. - true if the two instances of are not equal; otherwise false. - - - - Specifies the directions of rotation. - - - - - No rotation. - - - - - Rotate clockwise by 90 degrees. - - - - - Rotate clockwise by 180 degrees. - - - - - Rotate clockwise by 270 degrees. - - - - - Represents a size in 2D space. - - - - - Initializes a new instance of the Size with the specified values. - - Width of the size. - Height of the size. - - - - Gets or sets the width of the Size. - - - - - Gets or sets the height of the Size. - - - - - Returns a string that represents the current object. - - A string that represents the current object. - - - - Gets the hash code for this instance of . - - The hash code for this instance of . - - - - Compares an object to an instance of for equality. - - A to compare. - true if the two sizes are equal; otherwise, false. - - - - Compares two instances of for equality. - - A to compare. - A to compare. - true if the two instances of are equal; otherwise false. - - - - Compares two instances of for inequality. - - A to compare. - A to compare. - true if the two instances of are not equal; otherwise false. - - - - Specifies visibilities. - - - - - Invisible. - - - - - Visible. - - - - - Represents an audio media format. This class cannot be inherited. - - - - - Initializes a new instance of the AudioMediaFormat class with the specified mime type, - channel, sample rate, bit and bit rate. - - The mime type of the format. - The channel value of the format. - The sample rate value of the format. - The bit value of the format. - The bit rate value of the format. - is invalid(i.e. undefined value). - - , , or is less than zero. - - - - - Initializes a new instance of the AudioMediaFormat class with the specified mime type, - channel, sample rate, bit, bit rate and aac type. - - The mime type of the format. - The channel value of the format. - The sample rate value of the format. - The bit value of the format. - The bit rate value of the format. - The AAC bitstream format(ADIF or ADTS). - - or is invalid(i.e. undefined value).\n - -or-\n - is not , but is one of aac types. - - - , , or is less than zero. - - - - - Initializes a new instance of the AudioMediaFormat class from a native handle. - - A native handle. - - - - Returns an indication whether a specified mime type is a aac type. - - A mime type. - - - - Retrieves audio properties of media format from a native handle. - - A native handle that properties are retrieved from. - An out parameter for mime type. - An out parameter for channel. - An out parameter for sample rate. - An out parameter for bit. - An out parameter for bit rate. - - - - Retrieves aac type value from a native handle. - - A native handle that properties are retrieved from. - An out parameter for aac type. - - - - Gets the mime type of the current format. - - - - - Gets the channel value of the current format. - - - - - Gets the sample rate value of the current format. - - - - - Gets the bit value of the current format. - - - - - Gets the bit rate value of the current format. - - - - - Gets the aac type of the current format. - - - - - Represents a container media format. This class cannot be inherited. - - - - - Initializes a new instance of the ContainerMediaFormat class. - - The mime type of the container format. - mimeType is invalid(i.e. undefined value). - - - - Initializes a new instance of the ContainerMediaFormat class from a native handle. - - A native media format handle. - - - - Gets the mime type of the current format. - - - - - MediaFormat is a base class for media formats. - - - - - Initializes a new instance of the ContainerMediaFormat class with a type. - - A type for the format. - - - - Gets the type of the current format. - - - - - Creates a media format from a native handle. - - A native handle. - An object of one of subclasses of . - - - - Create a native media format from this object. - - A converted native handle. - The returned handle must be destroyed using . - - - - Fill out properties of a native media format with the current media format object. - - A native handle to be written. - - - - Specifies aac types for . - - - - - Raw, no header - - - - - ADTS header - - - - - ADIF header - - - - - Specifies the media format types. - - - - - - Audio media format. - - - - - Video media format. - - - - - Container media format. - - - - - Text media format. - - - - - Enumeration for media format data type - - - - - Encoded type - - - - - Raw type - - - - - Specifies the mime types for audio media formats. - - - - - AMR, Alias for . - - - - - AMR-NB. - - - - - AMR-WB. - - - - - AAC, Alias for . - - - - - AAC-LC (Advanced Audio Coding Low-Complexity profile). - - - - - HE-AAC (High-Efficiency Advanced Audio Coding). - - - - - HE-AAC-PS (High-Efficiency Advanced Audio Coding with Parametric Stereo). - - - - - MP3. - - - - - VORBIS. - - - - - FLAC. - - - - - Windows Media Audio 1. - - - - - Windows Media Audio 2. - - - - - Windows Media Audio Professional. - - - - - Windows Media Audio Lossless. - - - - - PCM. - - - - - Specifies the mime types for video media formats. - - - - - H261. - - - - - H263. - - - - - H263P. - - - - - H264_SP - - - - - H264_MP. - - - - - H264_HP. - - - - - MJPEG - - - - - MPEG1. - - - - - MPEG2_SP. - - - - - MPEG2_MP. - - - - - MPEG2_HP. - - - - - MPEG4_SP. - - - - - MPEG4_ASP. - - - - - I420 - - - - - NV12. - - - - - NV12T. - - - - - YV12. - - - - - NV21. - - - - - NV16. - - - - - YUYV. - - - - - UYVY. - - - - - 422P. - - - - - RGB565. - - - - - RGB888. - - - - - RGBA. - - - - - ARGB. - - - - - BGRA. - - - - - Specifies the mime types for container media formats. - - - - - MP4 container, Video. - - - - - AVI container, Video. - - - - - MPEG2TS container, Video. - - - - - MPEG2PS container, Video. - - - - - MATROSKA container, Video. - - - - - WEBM container, Video. - - - - - 3GP container, Video. - - - - - WAV container, Audio. - - - - - OGG container, Audio - - - - - AAC_ADTS container, Audio - - - - - AAC_ADIF container, Audio - - - - - Enumeration for text mime type - - - - - MP4. - - - - - 3GP. - - - - - Specifies text types. - - - - - This indicates no type specified. - - - - - The mp4 type. - - - - - The 3gpp type. - - - - - Represents a packet for multimedia. - - - Represents a packet for multimedia. - - - - - Initializes a new instance of the MediaPacket class with the specified media format. - - The media format containing properties for the packet. - format is null. - - of the specified format is . - Operation failed. - - - - Initializes a new instance of the MediaPacket class from a native handle. - - The native handle to be used. - - - - Creates and initializes a native handle for the current object. - - The format to be set to the media format. - Operation failed. - - - - Allocates internal buffer. - - Operation failed. - - - - Gets the media format of the current packet. - - - - - Gets or sets the PTS(Presentation Time Stamp) value of the current packet. - - The MediaPacket has already been disposed. - - The MediaPacket is not writable state which means it being used by another module. - - - - Gets or sets the DTS(Decoding Time Stamp) value of the current packet. - - The MediaPacket has already been disposed. - - The MediaPacket is not in writable state which means it being used by another module. - - - - Gets a value indicating whether the packet is encoded type. - - true if the packet is encoded type; otherwise, false. - The MediaPacket has already been disposed. - - - - Gets the buffer of the packet. - - The allocated to the packet. - This property will return null if the packet is raw video format. - The MediaPacket has already been disposed. - - - - - - Gets or sets a length of data written in the . - - The MediaPacket has already been disposed. - - The value specified for this property is less than zero or greater than . - - The MediaPacket has instead of .\n - -or-\n - The MediaPacket is not in writable state which means it being used by another module. - - - - - Gets the video planes of the packet. - - The s allocated to the packet. - This property will return null if the packet is not raw video format. - The MediaPacket has already been disposed. - - - - - - Gets or sets the buffer flags of the packet. - - The MediaPacket has already been disposed. - - The MediaPacket is not in writable state which means it being used by another module. - - - - - Gets a value indicating whether the packet has been disposed of. - - true if the packet has been disposed of; otherwise, false. - - - - Releases all resources used by the object. - - - The MediaPacket can not be disposed which means it being used by another module. - - - - - Releases the resources used by the object. - - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - Validate the current object has not been disposed of. - - The MediaPacket has already been disposed of. - - - - Ensures whether the packet is writable. - - The MediaPacket already has been disposed of. - The MediaPacket is being used by another module. - - - - Ensures whether the packet is readable. - - The MediaPacket already has been disposed of. - - - - Gets a value indicating whether the packet is raw video format. - - true if the packet is raw video format; otherwise, false. - - - - Retrieves video planes of the current packet. - - The s allocated to the current MediaPacket. - - - - Retrieves the buffer of the current packet. - - The allocated to the current MediaPacket. - - - - Creates an object of the MediaPacket with the specified . - - The media format for the new packet. - A new MediaPacket object. - - - - Validate the current object is not locked. - - The MediaPacket has already been disposed of. - The MediaPacket is in use by another module. - - - - Provides a thread-safe lock state controller. - - - - - Provides a thread-safe lock controller. - - - using (var lock = BaseMediaPacket.Lock(mediaPacket)) - { - .... - } - - - - - Represents a buffer for a . - - - - - Gets or sets a value at the specified index. - - The index of the value to get or set. - - index is less than zero.\n - -or-\n - index is equal to or greater than . - - The MediaPacket that owns the current buffer already has been disposed of. - The MediaPacket that owns the current buffer is being used by another module. - - - - Validates the range - - - - - offset + length is greater than .\n - -or-\n - offset or length is less than zero. - - - - - Copies data from a byte array to the buffer. - - The array to copy from. - The zero-based index in the source array where copying should start. - The number of array elements to copy. - The zero-based index in the buffer where copying should start. - startIndex, offset or length is not valid. - The MediaPacket that owns the current buffer already has been disposed of. - - - - Copies data from the buffer to a byte array. - - The array to copy to. - The zero-based index in the dest array where copying should start. - The number of elements to copy. - The zero-based index in the buffer where copying should start. - startIndex, offset or length is not valid. - The MediaPacket that owns the current buffer already has been disposed of. - The MediaPacket that owns the current buffer is being used by another module. - - - - Gets the size of the buffer, in bytes. - - The MediaPacket that owns the current buffer already has been disposed of. - - - - Specifies the flag for a buffer. - - This enumeration has a attribute that allows a bitwise combination of its member values. - - - - - - The buffer contains codec initialization or codec specific data instead of media data. - - - - - The buffer indicates the end of stream. - - - - - The buffer contains a sync frame. - - - - - Represents a video plane for . - This class is used if and only if the format of the packet is raw video. - - - - - Gets the buffer of the current video plane. - - The MediaPacket that owns the current buffer already has been disposed of. - - - - Gets the stride width of the current video plane. - - The MediaPacket that owns the current buffer already has been disposed of. - - - - Gets the stride height of the current video plane. - - The MediaPacket that owns the current buffer already has been disposed of. - - - - Represents a text media format. This class cannot be inherited. - - - - - Initializes a new instance of the TextMediaFormat class with the specified mime type - and text type. - - The mime type of the format. - The text type of the format. - - mimeType or textType is invalid(i.e. undefined value). - - - - Initializes a new instance of the TextMediaFormat class from a native handle. - - A native handle. - - - - Retrieves text properties of media format from a native handle. - - A native handle that properties are retrieved from. - An out parameter for mime type. - An out parameter for text type. - - - - Gets the mime type of the current format. - - - - - Gets the text type of the current format. - - - - - Represents a video media format. This class cannot be inherited. - - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type, width and height. - - The mime type of the format. - The width value of the format. - The height value of the format - mimeType is invalid(i.e. undefined value). - width, or height is less than zero. - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type and size. - - The mime type of the format. - The size of the format. - mimeType is invalid(i.e. undefined value). - width, or height is less than zero. - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type, - width, height and frame rate. - - The mime type of the format. - The width value of the format. - The height value of the format - The frame rate of the format. - mimeType is invalid(i.e. undefined value). - width, height or frameRate is less than zero. - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type, - width, height and frame rate. - - The mime type of the format. - The video size of the format. - The frame rate of the format. - mimeType is invalid(i.e. undefined value). - width, height or frameRate is less than zero. - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type, - width, height, frame rate and bit rate. - - The mime type of the format. - The width value of the format. - The height value of the format - The frame rate of the format. - The bit rate of the format. - mimeType is invalid(i.e. undefined value). - width, height, frameRate or bitRate is less than zero. - - - - Initializes a new instance of the VideoMediaFormat class with the specified mime type, - size, frame rate and bit rate. - - The mime type of the format. - The size of the format. - The frame rate of the format. - The bit rate of the format. - mimeType is invalid(i.e. undefined value). - width, height, frameRate or bitRate is less than zero. - - - - Initializes a new instance of the VideoMediaForma class from a native handle. - - A native handle. - - - - Retrieves video properties of media format from a native handle. - - A native handle that properties are retrieved from. - An out parameter for width. - An out parameter for height. - An out parameter for bit rate. - An out parameter for mime type. - - - - Retrieves frame rate from a native handle. - - A native handle that properties are retrieved from. - An out parameter for frame rate. - - - - Gets the mime type of the current format. - - - - - Gets the size of the current format. - - - - - Gets the frame rate value of the current format. - - - - - Gets the bit rate value of the current format. - - - - - The MediaView class allows application developers to display the video output on screen. - - - This view should not be instantiated directly.\n - Use to create the view. - - - - Tizen.Xamarin.Forms.Extension.MediaView mediaView = ... - ... - var display = new Display((Tizen.Multimedia.MediaView)MediaView.NativeView); - - - - - - This constructor is used by the infrastructure and is not intended to be used directly from application code. - - - - + + + + Tizen.Multimedia + + + + + The Device API provides functions to query the information of sound devices. + + + + + Gets the id of the device. + + The id of the device. + + + + Gets the name of the device. + + The name of the device. + + + + Gets the type of the device. + + The of the device. + + + + Gets the IO direction of the device. + + The IO direction of the device. + + + + Gets the state of the device. + + The of the device. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Compares an object to an instance of for equality. + + A to compare. + true if the two devices are equal; otherwise, false. + + + + Gets the hash code for this instance of . + + The hash code for this instance of . + + + + Provides data for the event. + + + + + Gets the device. + + The . + + + + Gets the connection state of the device. + + true if the device is connected; otherwise, false. + + + + Provides data for the event. + + + + + Gets the device. + + The . + + + + Gets the state of the device. + + The of the device. + + + + Provides the ability to control volume levels and monitor audio devices. + + + + + Gets the volume controller. + + The . + + + + Gets the all devices currently connected. + + An IEnumerable<AudioDevice> that contains connected devices. + + + + Occurs when the state of connection of an audio device changes. + + + + + Occurs when the state of an audio device changes. + + + + + Specifies the flag for audio device options. + + This enumeration has a attribute that allows a bitwise combination of its member values. + + + + + + Input devices. + + + + + Output devices. + + + + + Input and output devices (both directions are available). + + + + + Built-in devices. + + + + + External devices. + + + + + Deactivated devices. + + + + + Activated devices. + + + + + All devices. + + + + + Specifies audio device type. + + + + + Built-in speaker. + + + + + Built-in receiver. + + + + + Built-in microphone. + + + + + Audio jack that can be connected to wired accessory such as headphones and headsets. + + + + + Bluetooth Media (A2DP). + + + + + HDMI. + + + + + Device for forwarding. + + + + + USB Audio. + + + + + Bluetooth Voice (SCO). + + + + + Specifies audio device direction. + + + + + Input device. + + + + + Output device. + + + + + Input/output device (both directions are available). + + + + + Specifies audio device state. + + + + + Deactivated state. + + + + + Activated state. + + + + + Specifies audio volume type. + + + + + System. + + + + + Notification. + + + + + Alarm. + + + + + Ringtone. + + + + + Media. + + + + + Call. + + + + + VoIP. + + + + + Voice. + + + + + No volume exists. + + + + + + Specifies audio stream type. + + + + + Media. + + + + + System. + + + + + Alarm. + + + + + Notification. + + + + + Emergency. + + + + + Voice information. + + + + + Voice recognition. + + + + + Ringtone for VoIP. + + + + + VoIP. + + + + + Media only for external devices. + + + + + Specifies change reason of audio stream focus state. + + + + + Media. + + + + + System. + + + + + Alarm. + + + + + Notification. + + + + + Emergency. + + + + + Voice information. + + + + + Voice recognition. + + + + + Ringtone. + + + + + VoIP. + + + + + Voice-call or video-call. + + + + + Media only for external devices. + + + + + Specifies the flag for audio stream focus options. + + This enumeration has a attribute that allows a bitwise combination of its member values. + + + + + + Playback focus. + + + + + Recording focus. + + + + + Specifies audio stream focus state. + + + + + Focus state for release. + + + + + Focus state for acquisition. + + + + + Specifies the flag for audio stream behaviors. + + This enumeration has a attribute that allows a bitwise combination of its member values. + + + + + + No Resume. + + + + + Fading. + + + + + Successful + + + + + Out of memory + + + + + Invalid parameter + + + + + Invalid operation + + + + + Permission denied + + + + + Not supported + + + + + No data + + + + + Internal error inside the sound system + + + + + Noncompliance with the sound system policy + + + + + No playing sound + + + + + Invalid state (Since 3.0) + + + + + The exception that is thrown when noncompliance with the sound system policy happens. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class with a specified error message and inner exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception.. + + + + Provides the ability to control a sound stream. + + + + + Initializes a new instance of the class with + + + To apply the stream policy according to this stream information, the AudioStreamPolicy should + be passed to other APIs related to playback or recording. (e.g., , , etc.) + + Type of sound stream for which policy needs to be created. + is invalid. + + + + Occurs when the state of focus that belongs to the current AudioStreamPolicy is changed. + + + The event is raised in the internal thread. + + + + + Gets the . + + + If the of the current AudioStreamPolicy is , + it returns . + + The of the policy instance. + The has already been disposed of. + + + + Gets the state of focus for playback. + + The state of focus for playback. + The has already been disposed of. + + + + Gets the state of focus for recording. + + The state of focus for recording. + The has already been disposed of. + + + + Gets or sets the auto focus reacquisition. + + + true if the auto focus reacquisition is enabled; otherwise, false.\n + The default is true. + + + If you don't want to reacquire the focus you've lost automatically, + disable the focus reacquisition. + + The has already been disposed of. + + + + Acquires the stream focus. + + The focuses that you want to acquire. + The requesting behaviors. + The extra information for this request. This value can be null. + is zero. + + contain a invalid bit.\n + -or-\n + contain a invalid bit.\n + + The focus has already been acquired. + Called in raised by releasing focus. + The has already been disposed of. + + + + Releases the acquired focus. + + The focus mask that you want to release. + The requesting behaviors. + The extra information for this request. This value can be null. + is zero. + + contain a invalid bit.\n + -or-\n + contain a invalid bit.\n + + The focus has not been acquired. + The has already been disposed of. + + + + Applies the stream routing. + + + If the stream has not been made yet, this will be applied when the stream starts to play. + + + + The has already been disposed of. + + + + + + Releases all resources used by the . + + + + + Releases the unmanaged resources used by the . + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Occurs when the focus state for stream types is changed regardless of the process. + + + + + Provides data for the event. + + + + + Gets the focus options. + + The focus options. + + + + Gets the focus state. + + The focus state. + + + + Gets the reason for state change of the focus. + + The reason for state change of the focus. + + + + Gets the requested behaviors that should be followed + + The requested behaviors that should be followed. + + + + Gets the extra information. + + + The extra information specified in or + . + + + + + + + Provides the ability to control the volume levels. + + + + + + Occurs when the volume level is changed. + + + + + Gets the volume type of the sound being currently played. + + The volume type of the sound being currently played. + + + + Gets the . + + The . + + + + Gets the . + + The . + + + + Provides a means to get max volume levels. + + + + + Gets the max volume level of the specified + + The to query. + The maximum volume level. + is invalid. + is . + + + + Provides data for the event. + + + + + Gets the focus options. + + The focus options. + + + + Gets the changed focus state. + + The focus state. + + + + Gets the reason for state change of the focus. + + The reason for state change of the focus. + + + + Gets the extra information. + + + The extra information specified in or + . + + + + + + + Provides data for the event. + + + + + Gets the sound type that volume is changed. + + The sound type that volume is changed. + + + + Gets the new volume. + + The new volume level. + + + + Provides a means to control volume levels. + + + + + Gets or sets the volume level of the specified + + The to control. + The current volume level. + To set volumes, the specified privilege is required. + http://tizen.org/privilege/volume.set + is invalid. + + is . + -or- + is less than zero. + -or- + is greater than . + + Caller does not have required privilege to set volume. + + + + Specifies whether a codec is audio codec or video codec. + + + + + Audio codec + + + + + Video codec + + + + + The exception that is thrown when the codec for an input file or a data stream is not supported + or the input is malformed. + + + + + Initializes a new instance of the class + with indicating which codec is not supported. + + + + + Initializes a new instance of the class with + indicating which codec is not supported and a specified error message. + + + + + Gets the of the exception. + + + + + Specifies color spaces for Tizen.Multimedia. + + + + + Y800 + + + + + I420 + + + + + NV12 + + + + + NV16 + + + + + NV21 + + + + + NV61 + + + + + YV12 + + + + + + YUYV + + + + + YUV422 + + + + + UYVY + + + + + YUV422P + + + + + + RGB565 + + + + + RGB888 + + + + + RGBA8888 + + + + + ARGB8888 + + + + + BGRA8888 + + + + + BGRX8888 + + + + + Overlay surface display + + + + + Evas image object surface display + + + + + This disposes off buffers + + + + + Provides a means to wrap various display types. + + + + + + + + Initializes a new instance of the class with a class. + + http://tizen.org/feature/multimedia.raw_video + The required feature is not supported. + + + + Initializes a new instance of the class with a class. + + + + + The exception that is thrown when an input file or a data stream that is supposed to conform + to a certain file format specification is malformed. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a specified error message. + + + + + Specifies the flip operation. + + + + + No flip operation. + + + + + Flip horizontally. + + + + + Flip vertically. + + + + + Provides functionality to read a media buffer. + + + + + Gets or sets a value at the specified index. + + The index of the value to get or set. + + index is less than zero.\n + -or-\n + index is equal to or greater than . + + The object that owns the current buffer already has been disposed of. + The buffer is not available. i.e. not writable state. + + + + Gets the size of the buffer, in bytes. + + + + + Copies data from a byte array to the buffer. + + The array to copy to. + The zero-based index in the source array where copying should start. + The number of array elements to copy. + startIndex or length is not valid. + The object that owns the current buffer already has been disposed of. + + + + Copies data from a byte array to the buffer. + + The array to copy to. + The zero-based index in the source array where copying should start. + The number of array elements to copy. + The zero-based index in the buffer where copying should start. + startIndex, offset or length is not valid. + The object that owns the current buffer already has been disposed of. + + + + Provides functionality to read and write a media buffer. + + + + + Copies data from the buffer to a byte array. + + The array to copy from. + The zero-based index in the dest array where copying should start. + The number of elements to copy. + startIndex or length is not valid. + The object that owns the current buffer already has been disposed of. + The buffer is not available. i.e. not writable state. + + + + Copies data from the buffer to a byte array. + + The array to copy from. + The zero-based index in the dest array where copying should start. + The number of elements to copy. + The zero-based index in the buffer where copying should start. + startIndex, offset or length is not valid. + The object that owns the current buffer already has been disposed of. + The buffer is not available. i.e. not writable state. + + + + Represents a buffer for a . + + + + + Validates the range + + + + + offset + length is greater than .\n + -or-\n + offset or length is less than zero. + + + + + Represents a point in 2D space. + + + + + Initializes a new instance of the Point with the specified coordinates. + + X-axis coordinate of the point in 2D space. + Y-axis coordinate of the point in 2D space. + + + + Gets or sets X-axis coordinate of the point in 2D space. + + + + + Gets or sets Y-axis coordinate of the point in 2D space. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Gets the hash code for this instance of . + + The hash code for this instance of . + + + + Compares an object to an instance of for equality. + + A to compare. + true if the points are equal; otherwise, false. + + + + Compares two instances of for equality. + + A to compare. + A to compare. + true if the two instances of are equal; otherwise false. + + + + Compares two instances of for inequality. + + A to compare. + A to compare. + true if the two instances of are not equal; otherwise false. + + + + Represents a range(min, max) value. + + + + + Initializes a new instance of the Range with the specified values. + + Minimum value of the range. + Maximum value of the range. + is less than . + + + + Gets or sets minimum value of the range. + + + + + Gets or sets maximum value of the range. + + + + + Gets length of the range. + + + + + Determines if the specified value is inside of the range. + + A value to check. + true if the value is inside of the range; otherwise false. + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Gets the hash code for this instance of . + + The hash code for this instance of . + + + + Compares an object to an instance of for equality. + + A to compare. + true if the two ranges are equal; otherwise, false. + + + + Compares two instances of for equality. + + A to compare. + A to compare. + true if the two instances of are equal; otherwise false. + + + + Compares two instances of for inequality. + + A to compare. + A to compare. + true if the two instances of are not equal; otherwise false. + + + + This class represents location of the object bounded by rectangle defined by + coordinates of top left corner, width and height. + + + + + Initializes a new instance of the Rectangle with the specified values. + + The x-coordinate of the upper-left corner of the rectangle. + The y-coordinate of the upper-left corner of the rectangle. + The Width of the rectangle. + The Height of the rectangle. + + + + Initializes a new instance of the Rectangle with the specified values. + + A that represents the upper-left corner of the rectangular region. + A that represents the width and height of the rectangular region. + + + + Gets or sets the coordinates of the upper-left corner of the rectangle. + + + + + Gets or sets the x-coordinate of the upper-left corner of the rectangle. + + + + + Gets or sets the y-coordinate of the upper-left corner of the rectangle. + + + + + Gets or sets the width of the rectangle. + + + + + Gets or sets the height of the rectangle. + + + + + Gets the x-coordinate of the left edge of the rectangle. + + + + + Gets the y-coordinate of the top edge of the rectangle. + + + + + Gets the x-coordinate of the right edge of the rectangle. + + + + + Gets the y-coordinate of the bottom edge of the rectangle. + + + + + Gets or sets the size of the rectangle. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Gets the hash code for this instance of . + + The hash code for this instance of . + + + + Compares an object to an instance of for equality. + + A to compare. + true if the rectangles are equal; otherwise, false. + + + + Compares two instances of for equality. + + A to compare. + A to compare. + true if the two instances of are equal; otherwise false. + + + + Compares two instances of for inequality. + + A to compare. + A to compare. + true if the two instances of are not equal; otherwise false. + + + + Specifies the directions of rotation. + + + + + No rotation. + + + + + Rotate clockwise by 90 degrees. + + + + + Rotate clockwise by 180 degrees. + + + + + Rotate clockwise by 270 degrees. + + + + + Represents a size in 2D space. + + + + + Initializes a new instance of the Size with the specified values. + + Width of the size. + Height of the size. + + + + Gets or sets the width of the Size. + + + + + Gets or sets the height of the Size. + + + + + Returns a string that represents the current object. + + A string that represents the current object. + + + + Gets the hash code for this instance of . + + The hash code for this instance of . + + + + Compares an object to an instance of for equality. + + A to compare. + true if the two sizes are equal; otherwise, false. + + + + Compares two instances of for equality. + + A to compare. + A to compare. + true if the two instances of are equal; otherwise false. + + + + Compares two instances of for inequality. + + A to compare. + A to compare. + true if the two instances of are not equal; otherwise false. + + + + Specifies visibilities. + + + + + Invisible. + + + + + Visible. + + + + + Represents an audio media format. This class cannot be inherited. + + + + + Initializes a new instance of the AudioMediaFormat class with the specified mime type, + channel, sample rate, bit and bit rate. + + The mime type of the format. + The channel value of the format. + The sample rate value of the format. + The bit value of the format. + The bit rate value of the format. + is invalid(i.e. undefined value). + + , , or is less than zero. + + + + + Initializes a new instance of the AudioMediaFormat class with the specified mime type, + channel, sample rate, bit, bit rate and aac type. + + The mime type of the format. + The channel value of the format. + The sample rate value of the format. + The bit value of the format. + The bit rate value of the format. + The AAC bitstream format(ADIF or ADTS). + + or is invalid(i.e. undefined value).\n + -or-\n + is not , but is one of aac types. + + + , , or is less than zero. + + + + + Initializes a new instance of the AudioMediaFormat class from a native handle. + + A native handle. + + + + Returns an indication whether a specified mime type is a aac type. + + A mime type. + + + + Retrieves audio properties of media format from a native handle. + + A native handle that properties are retrieved from. + An out parameter for mime type. + An out parameter for channel. + An out parameter for sample rate. + An out parameter for bit. + An out parameter for bit rate. + + + + Retrieves aac type value from a native handle. + + A native handle that properties are retrieved from. + An out parameter for aac type. + + + + Gets the mime type of the current format. + + + + + Gets the channel value of the current format. + + + + + Gets the sample rate value of the current format. + + + + + Gets the bit value of the current format. + + + + + Gets the bit rate value of the current format. + + + + + Gets the aac type of the current format. + + + + + Represents a container media format. This class cannot be inherited. + + + + + Initializes a new instance of the ContainerMediaFormat class. + + The mime type of the container format. + mimeType is invalid(i.e. undefined value). + + + + Initializes a new instance of the ContainerMediaFormat class from a native handle. + + A native media format handle. + + + + Gets the mime type of the current format. + + + + + MediaFormat is a base class for media formats. + + + + + Initializes a new instance of the ContainerMediaFormat class with a type. + + A type for the format. + + + + Gets the type of the current format. + + + + + Creates a media format from a native handle. + + A native handle. + An object of one of subclasses of . + + + + Create a native media format from this object. + + A converted native handle. + The returned handle must be destroyed using . + + + + Fill out properties of a native media format with the current media format object. + + A native handle to be written. + + + + Specifies aac types for . + + + + + Raw, no header + + + + + ADTS header + + + + + ADIF header + + + + + Specifies the media format types. + + + + + + Audio media format. + + + + + Video media format. + + + + + Container media format. + + + + + Text media format. + + + + + Enumeration for media format data type + + + + + Encoded type + + + + + Raw type + + + + + Specifies the mime types for audio media formats. + + + + + AMR, Alias for . + + + + + AMR-NB. + + + + + AMR-WB. + + + + + AAC, Alias for . + + + + + AAC-LC (Advanced Audio Coding Low-Complexity profile). + + + + + HE-AAC (High-Efficiency Advanced Audio Coding). + + + + + HE-AAC-PS (High-Efficiency Advanced Audio Coding with Parametric Stereo). + + + + + MP3. + + + + + VORBIS. + + + + + FLAC. + + + + + Windows Media Audio 1. + + + + + Windows Media Audio 2. + + + + + Windows Media Audio Professional. + + + + + Windows Media Audio Lossless. + + + + + PCM. + + + + + Specifies the mime types for video media formats. + + + + + H261. + + + + + H263. + + + + + H263P. + + + + + H264_SP + + + + + H264_MP. + + + + + H264_HP. + + + + + MJPEG + + + + + MPEG1. + + + + + MPEG2_SP. + + + + + MPEG2_MP. + + + + + MPEG2_HP. + + + + + MPEG4_SP. + + + + + MPEG4_ASP. + + + + + I420 + + + + + NV12. + + + + + NV12T. + + + + + YV12. + + + + + NV21. + + + + + NV16. + + + + + YUYV. + + + + + UYVY. + + + + + 422P. + + + + + RGB565. + + + + + RGB888. + + + + + RGBA. + + + + + ARGB. + + + + + BGRA. + + + + + Specifies the mime types for container media formats. + + + + + MP4 container, Video. + + + + + AVI container, Video. + + + + + MPEG2TS container, Video. + + + + + MPEG2PS container, Video. + + + + + MATROSKA container, Video. + + + + + WEBM container, Video. + + + + + 3GP container, Video. + + + + + WAV container, Audio. + + + + + OGG container, Audio + + + + + AAC_ADTS container, Audio + + + + + AAC_ADIF container, Audio + + + + + Enumeration for text mime type + + + + + MP4. + + + + + 3GP. + + + + + Specifies text types. + + + + + This indicates no type specified. + + + + + The mp4 type. + + + + + The 3gpp type. + + + + + Represents a packet for multimedia. + + + Represents a packet for multimedia. + + + + + Initializes a new instance of the MediaPacket class with the specified media format. + + The media format containing properties for the packet. + format is null. + + of the specified format is . + Operation failed. + + + + Initializes a new instance of the MediaPacket class from a native handle. + + The native handle to be used. + + + + Creates and initializes a native handle for the current object. + + The format to be set to the media format. + Operation failed. + + + + Allocates internal buffer. + + Operation failed. + + + + Gets the media format of the current packet. + + + + + Gets or sets the PTS(Presentation Time Stamp) value of the current packet. + + The MediaPacket has already been disposed. + + The MediaPacket is not writable state which means it being used by another module. + + + + Gets or sets the DTS(Decoding Time Stamp) value of the current packet. + + The MediaPacket has already been disposed. + + The MediaPacket is not in writable state which means it being used by another module. + + + + Gets a value indicating whether the packet is encoded type. + + true if the packet is encoded type; otherwise, false. + The MediaPacket has already been disposed. + + + + Gets the buffer of the packet. + + The allocated to the packet. + This property will return null if the packet is raw video format. + The MediaPacket has already been disposed. + + + + + + Gets or sets a length of data written in the . + + The MediaPacket has already been disposed. + + The value specified for this property is less than zero or greater than . + + The MediaPacket has instead of .\n + -or-\n + The MediaPacket is not in writable state which means it being used by another module. + + + + + Gets the video planes of the packet. + + The s allocated to the packet. + This property will return null if the packet is not raw video format. + The MediaPacket has already been disposed. + + + + + + Gets or sets the buffer flags of the packet. + + The MediaPacket has already been disposed. + + The MediaPacket is not in writable state which means it being used by another module. + + + + + Gets a value indicating whether the packet has been disposed of. + + true if the packet has been disposed of; otherwise, false. + + + + Releases all resources used by the object. + + + The MediaPacket can not be disposed which means it being used by another module. + + + + + Releases the resources used by the object. + + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + + Validate the current object has not been disposed of. + + The MediaPacket has already been disposed of. + + + + Ensures whether the packet is writable. + + The MediaPacket already has been disposed of. + The MediaPacket is being used by another module. + + + + Ensures whether the packet is readable. + + The MediaPacket already has been disposed of. + + + + Gets a value indicating whether the packet is raw video format. + + true if the packet is raw video format; otherwise, false. + + + + Retrieves video planes of the current packet. + + The s allocated to the current MediaPacket. + + + + Retrieves the buffer of the current packet. + + The allocated to the current MediaPacket. + + + + Creates an object of the MediaPacket with the specified . + + The media format for the new packet. + A new MediaPacket object. + + + + Validate the current object is not locked. + + The MediaPacket has already been disposed of. + The MediaPacket is in use by another module. + + + + Provides a thread-safe lock state controller. + + + + + Provides a thread-safe lock controller. + + + using (var lock = BaseMediaPacket.Lock(mediaPacket)) + { + .... + } + + + + + Represents a buffer for a . + + + + + Gets or sets a value at the specified index. + + The index of the value to get or set. + + index is less than zero.\n + -or-\n + index is equal to or greater than . + + The MediaPacket that owns the current buffer already has been disposed of. + The MediaPacket that owns the current buffer is being used by another module. + + + + Validates the range + + + + + offset + length is greater than .\n + -or-\n + offset or length is less than zero. + + + + + Copies data from a byte array to the buffer. + + The array to copy from. + The zero-based index in the source array where copying should start. + The number of array elements to copy. + The zero-based index in the buffer where copying should start. + startIndex, offset or length is not valid. + The MediaPacket that owns the current buffer already has been disposed of. + + + + Copies data from the buffer to a byte array. + + The array to copy to. + The zero-based index in the dest array where copying should start. + The number of elements to copy. + The zero-based index in the buffer where copying should start. + startIndex, offset or length is not valid. + The MediaPacket that owns the current buffer already has been disposed of. + The MediaPacket that owns the current buffer is being used by another module. + + + + Gets the size of the buffer, in bytes. + + The MediaPacket that owns the current buffer already has been disposed of. + + + + Specifies the flag for a buffer. + + This enumeration has a attribute that allows a bitwise combination of its member values. + + + + + + The buffer contains codec initialization or codec specific data instead of media data. + + + + + The buffer indicates the end of stream. + + + + + The buffer contains a sync frame. + + + + + Represents a video plane for . + This class is used if and only if the format of the packet is raw video. + + + + + Gets the buffer of the current video plane. + + The MediaPacket that owns the current buffer already has been disposed of. + + + + Gets the stride width of the current video plane. + + The MediaPacket that owns the current buffer already has been disposed of. + + + + Gets the stride height of the current video plane. + + The MediaPacket that owns the current buffer already has been disposed of. + + + + Represents a text media format. This class cannot be inherited. + + + + + Initializes a new instance of the TextMediaFormat class with the specified mime type + and text type. + + The mime type of the format. + The text type of the format. + + mimeType or textType is invalid(i.e. undefined value). + + + + Initializes a new instance of the TextMediaFormat class from a native handle. + + A native handle. + + + + Retrieves text properties of media format from a native handle. + + A native handle that properties are retrieved from. + An out parameter for mime type. + An out parameter for text type. + + + + Gets the mime type of the current format. + + + + + Gets the text type of the current format. + + + + + Represents a video media format. This class cannot be inherited. + + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type, width and height. + + The mime type of the format. + The width value of the format. + The height value of the format + mimeType is invalid(i.e. undefined value). + width, or height is less than zero. + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type and size. + + The mime type of the format. + The size of the format. + mimeType is invalid(i.e. undefined value). + width, or height is less than zero. + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type, + width, height and frame rate. + + The mime type of the format. + The width value of the format. + The height value of the format + The frame rate of the format. + mimeType is invalid(i.e. undefined value). + width, height or frameRate is less than zero. + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type, + width, height and frame rate. + + The mime type of the format. + The video size of the format. + The frame rate of the format. + mimeType is invalid(i.e. undefined value). + width, height or frameRate is less than zero. + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type, + width, height, frame rate and bit rate. + + The mime type of the format. + The width value of the format. + The height value of the format + The frame rate of the format. + The bit rate of the format. + mimeType is invalid(i.e. undefined value). + width, height, frameRate or bitRate is less than zero. + + + + Initializes a new instance of the VideoMediaFormat class with the specified mime type, + size, frame rate and bit rate. + + The mime type of the format. + The size of the format. + The frame rate of the format. + The bit rate of the format. + mimeType is invalid(i.e. undefined value). + width, height, frameRate or bitRate is less than zero. + + + + Initializes a new instance of the VideoMediaForma class from a native handle. + + A native handle. + + + + Retrieves video properties of media format from a native handle. + + A native handle that properties are retrieved from. + An out parameter for width. + An out parameter for height. + An out parameter for bit rate. + An out parameter for mime type. + + + + Retrieves frame rate from a native handle. + + A native handle that properties are retrieved from. + An out parameter for frame rate. + + + + Gets the mime type of the current format. + + + + + Gets the size of the current format. + + + + + Gets the frame rate value of the current format. + + + + + Gets the bit rate value of the current format. + + + + + The MediaView class allows application developers to display the video output on screen. + + + This view should not be instantiated directly.\n + Use to create the view. + + + + Tizen.Xamarin.Forms.Extension.MediaView mediaView = ... + ... + var display = new Display((Tizen.Multimedia.MediaView)MediaView.NativeView); + + + + + + This constructor is used by the infrastructure and is not intended to be used directly from application code. + + + + diff --git a/Artifacts/bin/Tizen.NUI.dll b/Artifacts/bin/Tizen.NUI.dll index b47aa9b..cb9632b 100644 Binary files a/Artifacts/bin/Tizen.NUI.dll and b/Artifacts/bin/Tizen.NUI.dll differ diff --git a/Artifacts/bin/Tizen.NUI.pdb b/Artifacts/bin/Tizen.NUI.pdb index 368b45a..5ab65c4 100644 Binary files a/Artifacts/bin/Tizen.NUI.pdb and b/Artifacts/bin/Tizen.NUI.pdb differ diff --git a/Artifacts/bin/Tizen.NUI.xml b/Artifacts/bin/Tizen.NUI.xml index 0591f93..4b7f359 100644 --- a/Artifacts/bin/Tizen.NUI.xml +++ b/Artifacts/bin/Tizen.NUI.xml @@ -1,9710 +1,9710 @@ - - - - Tizen.NUI - - - - @brief Event arguments that passed via StatusChanged signal - - - - @brief Event arguments that passed via ActionNext signal - - - - @brief Event arguments that passed via ActionPrevious signal - - - - @brief Event arguments that passed via ActionActivate signal - - - - @brief Event arguments that passed via ActionRead signal - - - - @brief Event arguments that passed via ActionOver signal - - - - @brief Event arguments that passed via ActionReadNext signal - - - - @brief Event arguments that passed via ActionReadPrevious signal - - - - @brief Event arguments that passed via ActionUp signal - - - - @brief Event arguments that passed via ActionDown signal - - - - @brief Event arguments that passed via ActionClearFocus signal - - - - @brief Event arguments that passed via ActionBack signal - - - - @brief Event arguments that passed via ActionScrollUp signal - - - - @brief Event arguments that passed via ActionScrollDown signal - - - - @brief Event arguments that passed via ActionPageLeft signal - - - - @brief Event arguments that passed via ActionPageRight signal - - - - @brief Event arguments that passed via ActionPageUp signal - - - - @brief Event arguments that passed via ActionPageDown signal - - - - @brief Event arguments that passed via ActionMoveToFirst signal - - - - @brief Event arguments that passed via ActionMoveToLast signal - - - - @brief Event arguments that passed via ActionReadFromTop signal - - - - @brief Event arguments that passed via ActionReadFromNext signal - - - - @brief Event arguments that passed via ActionZoom signal - - - - @brief Event arguments that passed via ActionReadIndicatorInformation signal - - - - @brief Event arguments that passed via ActionReadPauseResume signal - - - - @brief Event arguments that passed via ActionStartStop signal - - - - @brief Event arguments that passed via ActionPageUp signal - - - - @brief Event arguments that passed via FocusedViewActivated signal - - - - @brief Event arguments that passed via FocusOvershot signal - - - - @brief Event arguments that passed via NUIApplicationInit signal - - - - @brief Application - is the application that is being initialized - - - - @brief Event arguments that passed via NUIApplicationTerminate signal - - - - @brief Application - is the application that is being Terminated - - - - @brief Event arguments that passed via NUIApplicationPause signal - - - - @brief Application - is the application that is being Paused - - - - @brief Event arguments that passed via NUIApplicationResume signal - - - - @brief Application - is the application that is being Resumed - - - - @brief Event arguments that passed via NUIApplicationReset signal - - - - @brief Application - is the application that is being Reset - - - - @brief Event arguments that passed via NUIApplicationResize signal - - - - @brief Application - is the application that is being Resized - - - - @brief Event arguments that passed via NUIApplicationLanguageChanged signal - - - - @brief Application - is the application that is being affected with Device's language change - - - - @brief Event arguments that passed via NUIApplicationRegionChanged signal - - - - @brief Application - is the application that is being affected with Device's region change - - - - @brief Event arguments that passed via NUIApplicationBatteryLow signal - - - - @brief Application - is the application that is being affected when the battery level of the device is low - - - - @brief Event arguments that passed via NUIApplicationMemoryLow signal - - - - @brief Application - is the application that is being affected when the memory level of the device is low - - - - @brief Event arguments that passed via NUIApplicationAppControl signal - - - - @brief Application - is the application that is receiving the launch request from another application - - - - @brief VoidP - contains the information about why the application is launched - - - - - - - - - - - - - - - Outer::outer_method(int) - - - - - - - Enumeration for texture types. - - - - - - Enumeration for stereoscopic view modes. - - - - - - - @brief Event arguments that passed via Uploaded signal - - - - @brief Image - is the image data that gets uploaded to GL. - - - - - Note that the IEnumerator documentation requires an InvalidOperationException to be thrown - whenever the collection is modified. This has been done for changes in the size of the - collection but not when one of the elements of the collection is modified as it is a bit - tricky to detect unmanaged code that modifies the collection under our feet. - - - Note that the IEnumerator documentation requires an InvalidOperationException to be thrown - whenever the collection is modified. This has been done for changes in the size of the - collection but not when one of the elements of the collection is modified as it is a bit - tricky to detect unmanaged code that modifies the collection under our feet. - - - - Application instance to connect event. - - - - - Dictionary to contain each type of event callback. - - - - - The default Constructor. - - - - - The constructor with stylesheet. - - - - - The constructor with stylesheet and window mode. - - - - - Add NUIApplication event to Application. - Put each type of event callback in Dictionary. - - Type of event - Event callback - - - - Add NUIApplication event to Application. - Put each type of event callback in Dictionary. - - Argument type for the event - Type of event - Event callback - - - - Dispose function. - - - - - Exit Application. - - - - - Run Application. - - Arguments from commandline. - - - - Region changed event callback function. - - Application instance - Event argument for RegionChanged - - - - Memory Low event callback function. - - Application instance - Event argument for MemoryLow - - - - Language changed event callback function. - - Application instance - Event argument for LanguageChanged - - - - Battery low event callback function. - - Application instance - Event argument for BatteryLow - - - - Initialized event callback function. - - Application instance - Event argument for Initialized - - - - Terminated event callback function. - - Application instance - Event argument for Terminated - - - - Resumed event callback function. - - Application instance - Event argument for Resumed - - - - App control event callback function. - - Application instance - Event argument for AppControl - - - - Paused event callback function. - - Application instance - Event argument for Paused - - - - Class that represents the type of NUI event for backends. This class can be converted from string type. - - - - - Initializes the EventType class. - - The name of event type. - - - - Pre-defined event type. "Reset" - - - - - Converts a string to NUIEventType instance. - - - - @brief Event arguments that passed via Notify signal - - - - @brief PropertyNotification - is the PropertyNotification handle that has the notification properties. - - - - - - Helper class for calculating what property indexes should be assigned to C# View (view) classes. - - - - - Initializes a new instance of the class. - - - - - Only called if a View has scriptable properties - - - - - Gets the index of the property. - Each property has to have unique index for this view type - - The property index. - View name - View type - Type. - - - - We calculate the start property indices, based on the type and it's class heirachy, e.g. DateView (70,000)- > Spin (60,000) -> View (50,000) - - - - start of the property range - - - last used of the property index - - - start of the property range - - - - This is used to store a mapping between C++ base handle objects and it's C# instances. - - - - - - Registry is a singleton - - - - - Given a C++ object the dictionary allows us to find which C# object it belongs to. - By keeping the weak reference only, it will allow the object to be garbage collected. - - - - - Store the mapping between this instance of BaseHandle (C# base class) and native part. - - The instance of BaseHandle (C# base class) - - - - Remove the this instance of BaseHandle (C# base class) and native part from the mapping table. - - The instance of BaseHandle (C# base class) - - - - Dispose - - - - - Addition operator for A+B - - Size, A - Size to assign, B - A Size containing the result of the addition - - - - Subtraction operator for A-B - - Size, A - Size to subtract, B - A Size containing the result of the subtraction - - - - Unary negation operator. - - Size for unary negation - A Size containg the negation - - - - Multiplication operator. - - Size for multiplication - The Size to multipl - A Size containing the result of the multiplication - - - - Multiplication operator. - - Size for multiplication - The float value to scale the Size - A Size containing the result of the scaling - - - - Division operator. - - Size for division - The Size to divide - A Size containing the result of the division> - - - - Division operator. - - Size for division - The float value to scale the Size by - A Size containing the result of the scaling - - - - Array subscript operator. - - Subscript index - The float at the given index - - - - Constructor. - - - - - Constructor. - - x (or width) component - y (or height) component - z (or depth) component - - - - Constructor. - - Size2D with x (width) and y (height) - - - - Zero constant, (0.0f, 0.0f, 0.0f). - - - - - - - Width property for width component of Siz - - - - - Height property for height component of Size - - - - - Depth property for depth component of Size - - - - - Type cast operator, Size to Vector3. - - Object of Size type - - - - Type cast operator, Vector3 to Size type. - - Object of Vector3 type - - - Note that the IEnumerator documentation requires an InvalidOperationException to be thrown - whenever the collection is modified. This has been done for changes in the size of the - collection but not when one of the elements of the collection is modified as it is a bit - tricky to detect unmanaged code that modifies the collection under our feet. - - - - An Adaptor object is used to initialize and control how Dali runs. - - It provides a lifecycle interface that allows the application - writer to provide their own main loop and other platform related - features. - - The Adaptor class provides a means for initialising the resources required by the Dali::Core. - - When dealing with platform events, the application writer MUST ensure that Dali is called in a - thread-safe manner. - - As soon as the Adaptor class is created and started, the application writer can initialise their - View objects straight away or as required by the main loop they intend to use (there is no - need to wait for an initialise signal as per the Tizen.NUI.Application class). - - - - - - Starts the Adaptor. - - - - - Pauses the Adaptor. - - - - - Resumes the Adaptor, if previously paused. - - If the adaptor is not paused, this does not do anything. - - - - Stops the Adaptor. - - - - - Release any locks the surface may hold. - - - For example, after compositing an offscreen surface, use this method to allow rendering to continue. - - - - - Set the number of frames per render. - - The number of vsyncs between successive renders.. - - Suggest this is a power of two: - 1 - render each vsync frame - 2 - render every other vsync frame - 4 - render every fourth vsync frame - 8 - render every eighth vsync frame - - - - - Set whether the frame count per render is managed using the hardware VSync or manually timed. - - True if the hardware VSync should be used. - - - - Returns a reference to the instance of the adaptor used by the current thread. - - The adaptor has been initialised.This is only valid in the main thread. - - - - Checks whether the adaptor is available. - - true, if it is available, false otherwise. - - - - Call this method to notify Dali when scene is created and initialized. - Notify Adaptor that the scene has been created. - - - - - Call this method to notify Dali when the system language changes. - - Use this only when NOT using Dali::Application, As Application created using - Application will automatically receive notification of language change. - When Dali::Application is not used, the application developer should - use app-core to receive language change notifications and should update Dali - by calling this method. - - - - - Sets minimum distance in pixels that the fingers must move towards/away from each other in order to trigger a pinch gesture. - - The minimum pinch distance in pixels. - - - - Feed a wheel event to the adaptor. - - wheel event. - - - - Feed a key event to the adaptor. - - The key event holding the key information. - - - - Notify Core that the scene has been created. - - - - - Sets the stereo base (eye separation) for Stereoscopic 3D. - The stereo base is the distance in millimetres between the eyes. Typical values are - between 50mm and 70mm. The default value is 65mm. - - The stereo base (eye separation) for Stereoscopic 3D. - - - - Event arguments that passed via Resized signal. - - - - - Adaptor - is the adaptor which has size changed. - - - - - - Event arguments that passed via LanguageChanged signal. - - - - - Adaptor - is the adaptor which has language changed. - - - - - - - To make AlphaFunction instance be disposed. - - - - - - - - - - - Returns the functioning mode of the alpha function - - The functioning mode of the alpha function - - - - This specifies the various types of BuiltinFunctions - - - - - Linear - - - - - No transformation - - - - - Reverse linear - - - - - Speeds up and comes to a sudden stop (Square) - - - - - Sudden start and slows to a gradual stop (Square) - - - - - Speeds up and comes to a sudden stop (Cubic) - - - - - Sudden start and slows to a gradual stop (Cubic) - - - - - Speeds up and slows to a gradual stop (Cubic) - - - - - Speeds up and comes to a sudden stop (sinusoidal) - - - - - Sudden start and slows to a gradual stop (sinusoidal) - - - - - Speeds up and slows to a gradual stop (sinusoidal) - - - - - Sudden start, loses momentum and returns to start position - - - - - Single revolution - - - - - Sudden start, exceed end position and return to a gradual stop - - - - - This specifies which mode is set for AlphaFuction - - - - - The user has used a built-in function. - - - - - The user has provided a custom function - - - - - The user has provided the control points of a bezier curve - - - - - - To make Animation instance be disposed. - - - - - @brief Event for Finished signal which can be used to subscribe/unsubscribe the event handler. - Finished signal is emitted when an Animation's animations have finished. - - - @brief Event for ProgressReached signal which can be used to subscribe/unsubscribe the event handler. - ProgressReached signal is emitted when the Animation has reached a given progress percentage, this is set in the api SetProgressNotification. - - - - Gets/Sets the duration in milli seconds of the animation. - - - - - Gets/Sets the default alpha function for the animation. - - - - - Queries the state of the animation. - - - - - - - - Stops the animation. - - end action can be set - - - - - - - - - - - - - - Animates a property between keyframes. - - The target object to animate - The target property to animate - The set of time/value pairs between which to animate - The method used to interpolate between values - The alpha function to apply - - - - Animates a property between keyframes. - - The target object to animate - The target property to animate - The set of time/value pairs between which to animate - Start time of animation in milli seconds - End time of animation in milli seconds - The method used to interpolate between values - The alpha function to apply - - - - - - - - Plays the animation. - - - - - - Play the animation after a given delay time.
- The delay time is not included in the looping time.
- When the delay time is negative value, it would treat as play immediately.
- - The delay time - - - - Pauses the animation. - - - - - Stops the animation. - - - - - - Enumeration for what to do when the animation ends, is stopped, or is destroyed. - - - - - When the animation ends, the animated property values are saved. - - - - - When the animation ends, the animated property values are forgotten. - - - - - If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel. - - - - - Enumeration for what interpolation method to use on key-frame animations. - - - - - Values in between key frames are interpolated using a linear polynomial. (Default) - - - - - Values in between key frames are interpolated using a cubic polynomial. - - - - - Enumeration for what state the animation is in. - - Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle. - - - - Animation has stopped - - - - - The animation is playing - - - - - The animation is paused - - - - - CustomView provides some common functionality required by all views. - - - - - Set the background with a property map. - - The background property map - - - - - - - Gets whether this control supports two dimensional keyboard navigation. - - true if this control supports two dimensional keyboard navigation - - - - Sets or Gets whether this control is a focus group for keyboard navigation. - - true if this control is set as a focus group for keyboard navigation - - - - Sets whether this control is a focus group for keyboard navigation. - (i.e. the scope of keyboard focus movement can be limitied to its child views). The control is not a focus group by default. - - Whether this control is set as a focus group for keyboard navigation - - - - Gets whether this control is a focus group for keyboard navigation. - - - - - Called by the AccessibilityManager to activate the Control. - - - - - Called by the KeyboardFocusManager. - - - - - Called by the KeyInputFocusManager to emit key event signals. - - The key event - True if the event was consumed - - - - - - Provides the View implementation of GetWidthForHeight. - - Height to use - The width based on the height - - - - Calculate the size for a child using the base view object. - - The child view to calculate the size for - The dimension to calculate the size for. E.g. width or height - Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found - - - - Determine if this view is dependent on it's children for relayout from the base class. - - The dimension(s) to check for - Return if the view is dependent on it's children - - - - Determine if this view is dependent on it's children for relayout from the base class. - - Return if the view is dependent on it's children - - - - - - Erase the entry matching the given index from the list of registered visuals. - - The Property index of the visual, used to reference visual - - - - - - - Create a transition effect on the control. - - transitionData The transition data describing the effect to create - A handle to an animation defined with the given effect, or an empty handle if no properties match - - - - - - - - Called after a child has been added to the owning view. - - The child which has been added - - - - Called after the owning view has attempted to remove a child( regardless of whether it succeeded or not ). - - The child being removed - - - - Called when the owning view property is set. - - The Property index that was set - The value to set - - - - Called when the owning view's size is set e.g. using View.SetSize(). - - The target size - - - - Called when the owning view's size is animated e.g. using Animation::AnimateTo( Property( view, View::Property::SIZE ), ... ). - - The object which is animating the owning view - The target size - - - - - - Called after a key-event is received by the view that has had its focus set. - - The key event - True if the key event should be consumed - - - - - - Notification for deriving classes. - - policy The policy being set - dimension The dimension the policy is being set for - - - - Return the natural size of the view. - - The view's natural size - - - - Calculate the size for a child. - - The child view to calculate the size for - The dimension to calculate the size for. E.g. width or height - Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found. - - - - - - Determine if this view is dependent on it's children for relayout. - - The dimension(s) to check for - Return if the view is dependent on it's children - - - - Determine if this view is dependent on it's children for relayout from the base class. - - Return true if the view is dependent on it's children - - - - Virtual method to notify deriving classes that relayout dependencies have been - met and the size for this object is about to be calculated for the given dimension. - - The dimension that is about to be calculated - - - - Virtual method to notify deriving classes that the size for a dimension has just been negotiated. - - The new size for the given dimension - The dimension that was just negotiated - - - - This method should be overridden by deriving classes requiring notifications when the style changes. - - The StyleManager object - Information denoting what has changed - - - - - This method should be overridden by deriving classes when they wish to respond the accessibility. - - The pan gesture - true if the pan gesture has been consumed by this control - - - - This method should be overridden by deriving classes when they wish to respond the accessibility - - The touch gesture - true if the touch event has been consumed by this control - - - - This method should be overridden by deriving classes when they wish to respond the accessibility up and down action (i.e. value change of slider control). - - isIncrease Whether the value should be increased or decreased - true if the value changed action has been consumed by this control - - - - This method should be overridden by deriving classes when they wish to respond the accessibility zoom action. - - true if the zoom action has been consumed by this control - - - - Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when focus is gained. - - - - - Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when focus is lost. - - - - - - - - - - - - - Enumeration for the instance of child properties belonging to the FlexContainer class. - - - - - Creates a FlexContainer handle. - Calling member functions with an uninitialized handle is not allowed. - - - - - Enumeration for the direction of the main axis in the flex container. This determines - the direction that flex items are laid out in the flex container. - - - - - Enumeration for the primary direction in which content is ordered in the flex container - and on which sides the ?�start??and ?�end??are. - - - - - Enumeration for the alignment of the flex items when the items do not use all available - space on the main-axis. - - - - - Enumeration for the alignment of the flex items or lines when the items or lines do not - use all the available space on the cross-axis. - - - - - Enumeration for the wrap type of the flex container when there is no enough room for - all the items on one flex line. - - - - - The primary direction in which content is ordered - - - - - The direction of the main-axis which determines the direction that flex items are laid out - - - - - Whether the flex items should wrap or not if there is no enough room for them on one flex line - - - - - The alignment of flex items when the items do not use all available space on the main-axis - - - - - The alignment of flex items when the items do not use all available space on the cross-axis - - - - - Similar to "alignItems", but it aligns flex lines, so only works when there are multiple lines - - - - - - Event arguments of resource ready. - - - - - The view whose resource is ready. - - - - - - Creates an initialized ImageView. - - - - - - - - ImageView ResourceUrl, type string - - - - - ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise - - - - - - - - - - Class to specify layout position for child view. - - - - - Constructor. - - The row index initialized - The column index initialized - The row span initialized - The column span initialized - - - - Constructor to initialise values to defaults for convenience. - - The row index initialized - The column index initialized - The row span initialized - - - - Constructor to initialise values to defaults for convenience. - - The row index initialized - The column index initialized - - - - Constructor to initialise values to defaults for convenience. - - The row index initialized - - - - Default constructor - - - - - Index of row - - - - - Index of column - - - - - Span of row - - - - - Span of column - - - - - Creates the TableView view. - - initialRows for the table - initialColumns for the table - - - - Copy constructor. Creates another handle that points to the same real object. - - Handle to copy from - - - - - Returns a child from the given layout position. - - The position in the table - Child that was in the cell or an uninitialized handle - - - - Removes a child from the given layout position. - - The position for the child to remove - Child that was removed or an uninitialized handle - - - - Finds the child's layout position. - - The child to search for - The position for the child - true if the child was included in this TableView - - - - Inserts a new row to given index. - - The rowIndex of the new row - - - - - Inserts a new column to the given index. - - The columnIndex of the new column - - - - - Resizes the TableView. - - The rows for the table - The columns for the table - - - - Sets horizontal and vertical padding between cells. - - Width and height - - - - Gets the current padding as width and height. - - The current padding as width and height - - - - Specifies this row as fitting its height to its children. - - The row to set - - - - Checks if the row is a fit row. - - The row to check - true if the row is fit - - - - Specifies this column as fitting its width to its children. - - The column to set - - - - Checks if the column is a fit column. - - The column to check - true if the column is fit - - - - - Gets a row's fixed height. - - The row index with fixed height - height The height in world coordinate units - - - - - Gets a row's relative height. - - The row index with relative height - Height in percentage units, between 0.0f and 1.0f - - - - - Gets a column's fixed width. - - The column index with fixed width - Width in world coordinate units - - - - - Gets a column's relative width. - - The column index with relative width - Width in percentage units, between 0.0f and 1.0f - - - - - Enumeration for describing how the size of a row / column has been set. - - - - - the amount of rows in the table. - - - - - the amount of columns in the table. - - - - - padding between cells. - - - - - The number of layout rows - - - - - The number of layout columns - - - - - A control which provides a multi-line editable text editor. - - - - - Dispose. - - - - - Event arguments that passed via TextChanged signal. - - - - - TextEditor - is the texteditor control which has the text contents changed. - - - - - - Event arguments that passed via ScrollStateChanged signal. - - - - - TextEditor - is the texteditor control which has the scroll state changed. - - - - - ScrollState - is the texteditor control scroll state. - - - - - - Creates the TextEditor control. - - - - - - - - Text color property. - - - - - Font family property. - - - - - Font style property. - - - - - Point size property. - - - - - Horizontal alignment property. - - - - - Scroll threshold property. - - - - - Scroll speed property. - - - - - Primary cursor color property. - - - - - SecondaryCursorColor property. - - - - - EnableCursorBlink property. - - - - - CursorBlinkInterval property. - - - - - CursorBlinkDuration property. - - - - - CursorWidth property. - - - - - GrabHandleImage property. - - - - - GrabHandlePressedImage property. - - - - - SelectionHandleImageLeft property. - - - - - SelectionHandleImageRight property. - - - - - SelectionHandlePressedImageLeft property. - - - - - SelectionHandlePressedImageRight property. - - - - - SelectionHandleMarkerImageLeft property. - - - - - SelectionHandleMarkerImageRight property. - - - - - SelectionHighlightColor property. - - - - - DecorationBoundingBox property. - - - - - EnableMarkup property. - - - - - InputColor property. - - - - - InputFontFamily property. - - - - - InputFontStyle property. - - - - - InputPointSize property. - - - - - LineSpacing property. - - - - - InputLineSpacing property. - - - - - Underline property. - - - - - InputUnderline property. - - - - - Shadow property. - - - - - InputShadow property. - - - - - Emboss property. - - - - - InputEmboss property. - - - - - Outline property. - - - - - InputOutline property. - - - - - SmoothScroll property. - - - - - SmoothScrollDuration property. - - - - - EnableScrollBar property. - - - - - ScrollBarShowDuration property. - - - - - ScrollBarFadeDuration property. - - - - - PixelSize property. - - - - - The line count of text. - - - - - The text to display when the TextEditor is empty and inactive. - - - - - The placeholder-text color. - - - - - Enable selection property. - - - - - Placeholder property. - Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size. - - - The following example demonstrates how to set the placeholder property. - - PropertyMap propertyMap = new PropertyMap(); - propertyMap.Add("placeholderText", new PropertyValue("Setting Placeholder Text")); - propertyMap.Add("placeholderTextFocused", new PropertyValue("Setting Placeholder Text Focused")); - propertyMap.Add("placeholderColor", new PropertyValue(Color.Red)); - propertyMap.Add("placeholderFontFamily", new PropertyValue("Arial")); - propertyMap.Add("placeholderPointSize", new PropertyValue(12.0f)); - - PropertyMap fontStyleMap = new PropertyMap(); - fontStyleMap.Add("weight", new PropertyValue("bold")); - fontStyleMap.Add("width", new PropertyValue("condensed")); - fontStyleMap.Add("slant", new PropertyValue("italic")); - propertyMap.Add("placeholderFontStyle", new PropertyValue(fontStyleMap)); - - TextEditor editor = new TextEditor(); - editor.Placeholder = propertyMap; - - - - - - - A control which provides a single-line editable text field. - - - - - Dispose - - - - - Text changed event arguments. - - - - - TextField. - - - - - MaxLengthReached event arguments. - - - - - TextField. - - - - - TextChanged event. - - - - - MaxLengthReached event. - - - - - Creates the TextField control. - - - - - - - - PlaceholderText property. - - - - - PlaceholderTextFocused property. - - - - - FontFamily property. - - - - - FontStyle property. - - - - - PointSize property. - - - - - MaxLength property. - - - - - ExceedPolicy property. - - - - - HorizontalAlignment property. - - - - - VerticalAlignment property. - - - - - TextColor property. - - - - - PlaceholderTextColor property. - - - - - ShadowOffset property. - - - - - ShadowColor property. - - - - - PrimaryCursorColor property. - - - - - SecondaryCursorColor property. - - - - - EnableCursorBlink property. - - - - - CursorBlinkInterval property. - - - - - CursorBlinkDuration property. - - - - - CursorWidth property. - - - - - GrabHandleImage property. - - - - - GrabHandlePressedImage property. - - - - - ScrollThreshold property. - - - - - ScrollSpeed property. - - - - - SelectionHandleImageLeft property. - - - - - SelectionHandleImageRight property. - - - - - SelectionHandlePressedImageLeft property. - - - - - SelectionHandlePressedImageRight property. - - - - - SelectionHandleMarkerImageLeft property. - - - - - SelectionHandleMarkerImageRight property. - - - - - SelectionHighlightColor property. - - - - - DecorationBoundingBox property. - - - - - InputMethodSettings property. - - - - - InputColor property. - - - - - EnableMarkup property. - - - - - InputFontFamily property. - - - - - InputFontStyle property. - - - - - InputPointSize property. - - - - - Underline property. - - - - - InputUnderline property. - - - - - Shadow property. - - - - - InputShadow property. - - - - - Emboss property. - - - - - InputEmboss property. - - - - - Outline property. - - - - - InputOutline property. - - - - - HiddenInputSettings property. - - - - - PixelSize property. - - - - - Enable selection property. - - - - - Placeholder property. - Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size. - - - The following example demonstrates how to set the placeholder property. - - PropertyMap propertyMap = new PropertyMap(); - propertyMap.Add("placeholderText", new PropertyValue("Setting Placeholder Text")); - propertyMap.Add("placeholderTextFocused", new PropertyValue("Setting Placeholder Text Focused")); - propertyMap.Add("placeholderColor", new PropertyValue(Color.Red)); - propertyMap.Add("placeholderFontFamily", new PropertyValue("Arial")); - propertyMap.Add("placeholderPointSize", new PropertyValue(12.0f)); - - PropertyMap fontStyleMap = new PropertyMap(); - fontStyleMap.Add("weight", new PropertyValue("bold")); - fontStyleMap.Add("width", new PropertyValue("condensed")); - fontStyleMap.Add("slant", new PropertyValue("italic")); - propertyMap.Add("placeholderFontStyle", new PropertyValue(fontStyleMap)); - - TextField field = new TextField(); - field.Placeholder = propertyMap; - - - - - - - Dispose - - - - - Creates the TextLabel control. - - - - - Creates the TextLabel control. - - The text to display - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - The line count of text. - - - - - - - VideoView is a control for video playback and display. - - - - - Event arguments that passed via Finished signal - - - - - The view for video playback and display. - - - - - - Creates an initialized VideoView. - - - - - - Starts the video playback. - - - - - Pauses the video playback. - - - - - Stops the video playback. - - - - - Seeks forward by the specified number of milliseconds. - - The position for forward playback - - - - Seeks backward by the specified number of milliseconds. - - The position for backward playback - - - - video file url as string type or PropertyMap. - - - - - looping status, true or false. - - - - - mute status, true or false. - - - - - left and right volume scalar as float type, PropertyMap with two values ( "left" and "right" ). - - - - - View is the base class for all views. - - - - - - - Event arguments that passed via KeyEvent signal. - - - - - Key - is the key sent to the View. - - - - - - - Event arguments that passed via Touch signal. - - - - - Touch - contains the information of touch points - - - - - - Event arguments that passed via Hover signal. - - - - - Hover - contains touch points that represent the points that are currently being hovered or the points where a hover has stopped. - - - - - - Event arguments that passed via Wheel signal. - - - - - WheelEvent - store a wheel rolling type : MOUSE_WHEEL or CUSTOM_WHEEL - - - - - - - - Event arguments of visibility changed. - - - - - The view, or child of view, whose visibility has changed. - - - - - Whether the view is now visible or not. - - - - - Whether the view's visible property has changed or a parent's. - - - - - - - Describes the direction to move the focus towards. - - - - - Creates a new instance of a View. - - - - - - Quries whether the view has focus. - - true if this view has focus - - - - Sets the name of the style to be applied to the view. - - A string matching a style described in a stylesheet - - - - Retrieves the name of the style to be applied to the view (if any). - - A string matching a style, or an empty string - - - - Clears the background. - - - - - styleName, type string. - - - - - - Create an Animation to animate the background color visual. If there is no - background visual, creates one with transparent black as it's mixColor. - - - - - Create an Animation to animate the mixColor of the named visual. - - - - - - The current state of the view. - - - - - The current sub state of the view. - - - - - Displays a tooltip - - - - - Displays a tooltip as Text - - - - - - - - The top-left cell this child occupies, if not set, the first available cell is used - - - - - The number of rows this child occupies, if not set, default value is 1 - - - - - The number of columns this child occupies, if not set, default value is 1 - - - - - The horizontal alignment of this child inside the cells, if not set, default value is 'left' - - - - - The vertical alignment of this child inside the cells, if not set, default value is 'top' - - - - - - - - - whether the view should be focusable by keyboard navigation. - - - - - Enumeration for describing the states of view. - - - - - Normal state - - - - - Focused state - - - - - Disabled state - - - - - - - - - - - - Determines whether the pivot point should be used to determine the position of the view. - This is true by default. - - If false, then the top-left of the view is used for the position. - Setting this to false will allow scaling or rotation around the anchor-point without affecting the view's position. - - - - - - Gets depth in the hierarchy for the view. - - - - - Sets the sibling order of the view so depth position can be defined within the same parent. - - - Note The initial value is 0. - Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order. - The values set by this Property will likely change. - - - - - Returns the natural size of the view. - - - Deriving classes stipulate the natural size and by default a view has a ZERO natural size. - - - - - Returns the natural size (Size2D) of the view. - - - Deriving classes stipulate the natural size and by default a view has a ZERO natural size. - - - - - Shows the View. - - - This is an asynchronous method. - - - - - Hides the View. - - - This is an asynchronous method. - If an view is hidden, then the view and its children will not be rendered. - This is regardless of the individual visibility of the children i.e.an view will only be rendered if all of its parents are shown. - - - - - Raise view above all other views. - - - Sibling order of views within the parent will be updated automatically. - Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. - - - - - Lower view to the bottom of all views. - - - Sibling order of views within the parent will be updated automatically. - Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. - - - - - Query if all resources required by a View are loaded and ready. - - Most resources are only loaded when the control is placed on stage - - - - - Raise the view to above the target view. - - Sibling order of views within the parent will be updated automatically. - Views on the level above the target view will still be shown above this view. - Raising this view above views with the same sibling order as each other will raise this view above them. - Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. - - Will be raised above this view - - - - Lower the view to below the target view. - - Sibling order of views within the parent will be updated automatically. - Lowering this view below views with the same sibling order as each other will lower this view above them. - Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. - - Will be lowered below this view - - - - Adds a child view to this View. - - 
This View(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.
- The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. - If the child already has a parent, it will be removed from old parent and reparented to this view. This may change child's position, color, scale etc as it now inherits them from this view. - The child - - - - Removes a child View from this View. If the view was not a child of this view, this is a no-op. - - 
This View(the parent) has been initialized. The child view is not the same as the parent view.
- The child - - - - Removes a View from its Parent View / Layer. If the View has no parent, this method does nothing. - - 
The (child) View has been initialized.
- - - - Retrieves the number of children held by the view. - - 
The View has been initialized.
- The number of children - - - - Retrieves child view by index. - - 
The View has been initialized.
- The index of the child to retrieve - The view for the given index or empty handle if children not initialized - - - - Search through this view's hierarchy for an view with the given name. - The view itself is also considered in the search. - - 
The View has been initialized.
- The name of the view to find - A handle to the view if found, or an empty handle if not - - - - Converts screen coordinates into the view's coordinate system using the default camera. - - 
The View has been initialized.
- The view coordinates are relative to the top-left(0.0, 0.0, 0.5) - On return, the X-coordinate relative to the view - On return, the Y-coordinate relative to the view - The screen X-coordinate - The screen Y-coordinate - True if the conversion succeeded - - - - - - - - - Gets/Sets the size width of an view. - - - - - Gets/Sets the size height of an view. - - - - - - Gets/Sets the position x of the View. - - - - - Gets/Sets the position y of the View. - - - - - Gets/Sets the position z of the View. - - - - - Gets/Sets the world position of the View. - - - - - - - - Gets/Sets the scale x factor applied to an view. - - - - - Gets/Sets the scale y factor applied to an view. - - - - - Gets/Sets the scale z factor applied to an view. - - - - - Gets the world scale of View. - - - - - Retrieves the visibility flag of an view. - - - If an view is not visible, then the view and its children will not be rendered. - This is regardless of the individual visibility values of the children i.e.an view will only be rendered if all of its parents have visibility set to true. - - - - - Gets the view's world color. - - - - - Gets/Sets the View's name. - - - - - Get the number of children held by the view. - - - - - Gets the View's ID. - Readonly - - - - - Gets/Sets the status of whether an view should emit touch or hover signals. - - - - - Gets/Sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view. - - - - - Gets/Sets the status of whether a child view inherits it's parent's orientation. - - - - - Gets/Sets the status of whether a child view inherits it's parent's scale. - - - - - - - Gets/Sets the width resize policy to be used. - - - - - Gets/Sets the height resize policy to be used. - - - - - - Gets/Sets the status of whether the width size is dependent on height size. - - - - - Gets/Sets the status of whether the height size is dependent on width size. - - - - - Gets/Sets the padding for use in layout. - - - - - Gets/Sets the minimum size an view can be assigned in size negotiation. - - - - - Gets/Sets the maximum size an view can be assigned in size negotiation. - - - - - - Gets/Sets clipping behavior(mode) of it's children. - - - - - Get the number of renderers held by the view. - - - - - A visual view control for user add any visual to it. - - - Example: - - VisualView _visualView = new VisualView(); - ImageVisualMap imageVisualMap1 = new ImageVisualMap(); - imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg"; - imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f ); - imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f ); - imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f ); - imageVisualMap1.Origin = AlignType.TOP_BEGIN; - imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN; - _visualView.AddVisual("imageVisual1", imageVisualMap1); - - - - - - Override the parent method. - - - - - Add or update a visual to visual view. - - The name of visual to add. If add a existed visual name, the visual will be replaced. - The property map of visual to create. - - - - Remove a visual by name. - - The name of visual to remove. - - - - Get the total number of Visuals which are added by users - - - - - Remove all visuals of visual view. - - - - - - Create visual animation (transition) with the input parameters. - - The visual map to animation. - The property of visual to animation. - The destination value of property after animation. - The start time of visual animation. - The end time of visual animation. - The alpha function of visual animation - The initial property value of visual animation - Animation instance - - - - Add group visual animation (transition) map with the input parameters. - - The visual map to animation. - The property of visual to animation. - The destination value of property after animation. - The start time of visual animation. - The end time of visual animation. - The alpha function of visual animation - The initial property value of visual animation - - - - Finish to add Visual animation (transition) map and create transition animation. - - Animation instance - - - - Color class. - - - - - To make Color instance be disposed. - - - - - Addition operator. - - First value - Second value - A Color containing the result of the addition - - - - Subtraction operator. - - First value - Second value - A Color containing the result of the subtraction - - - - Unary negation operator. - - Target Value - A Color containg the negation - - - - Multiplication operator. - - First Value - Second Value - A Color containing the result of the multiplication - - - - Division operator. - - First Value - Second Value - A Color containing the result of the division - - - - Array subscript operator overload. - - Subscript index - The float at the given index - - - - Default constructor - - - - - Constructor. - - red component - green component - blue component - alpha component - - - - Conversion constructor from an array of four floats. - - array Array of R,G,B,A - - - - Check if two Color classes are same. - - A Color to be compared - If two Colors are are same, then true. - - - - Check if two Color classes are different. - - A Color to be compared - If two Colors are are different, then true. - - - - red component. - - - - - green component. - - - - - blue component. - - - - - alpha component. - - - - - Get black colored Color class. - - - - - Get white colored Color class. - - - - - Get red colored Color class. - - - - - Get green colored Color class. - - - - - Get blue colored Color class. - - - - - Get yellow colored Color class. - - - - - Get magenta colored Color class. - - - - - Get cyan colored Color class. - - - - - Get transparent colored Color class. - - - - - convert Color class to Vector4 class implicitly. - - A Color to be converted to Vector4 - - - - - Add this attribute to any property belonging to a View (control) you want to be scriptable from JSON - - - Example: - - class MyView : public CustomView - { - [ScriptableProperty()] - public int MyProperty - { - get - { - return _myProperty; - } - set - { - _myProperty = value; - } - } - } - - Internally the following occurs for property registration ( this only occurs once per Type, not per Instance): - - - The controls static constructor should call ViewRegistry.Register() (only called once for the lifecycle of the app) - - Within Register() the code will introspect the Controls properties, looking for the ScriptableProperty() attribute - - For every property with the ScriptableProperty() attribute, TypeRegistration.RegisterProperty is called. - - TypeRegistration.RegisterProperty calls in to DALi C++ Code Dali::CSharpTypeRegistry::RegisterProperty() - - DALi C++ now knows the existance of the property and will try calling SetProperty, if it finds the property in a JSON file (loaded using builder). - - The DALi C# example - - class MyView : public CustomView - { - - [ScriptableProperty()] - public double Hours - { - get { return seconds / 3600; } - set { seconds = value * 3600; } - } - } - - Equivalent code in DALi C++: - in MyControl.h - class MyControl : public Control - { - struct Property - { - enum - { - HOURS = Control::CONTROL_PROPERTY_END_INDEX + 1 - } - } - } - - in MyControl-impl.cpp - - DALI_TYPE_REGISTRATION_BEGIN( Toolkit::MyControl, Toolkit::Control, Create ); - DALI_PROPERTY_REGISTRATION( Toolkit, MyControl, "Hours", INTEGER, DISABLED ) - DALI_TYPE_REGISTRATION_END() - - - - - - - View Registry singleton. - Used for registering controls and any scriptable properties they have ( see ScriptableProperty ) - - Internal Design from C# to C++ - - - Each custom C# view should have it's static constructor called before any JSON file is loaded. - Static constructors for a class will only run once ( they are run per control type, not per instance). - Example of running a static constructor: - System.Runtime.CompilerServices.RuntimeHelpers.RunClassConstructor (typeof(Spin).TypeHandle); - Inside the static constructor the control should register it's type with the ViewRegistry - e.g. - - static Spin() - { - ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) ); - } - - The control should also provide a CreateInstance function, which gets passed to the ViewRegistry - // Eventually it will be called if DALi Builderfinds a Spin control in a JSON file - static CustomView CreateInstance() - { - return new Spin(); - } - - - - The DALi C++ equivalent of this is - - TypeRegistration mType( typeid(Toolkit::Spin), typeid(Toolkit::Control), CreateInstance ); - - - - - - - - ViewRegistry is a singleton - - - - - - Lookup table to match C# types to DALi types, used for the automatic property registration - - - - - Called directly from DALi C++ type registry to create a control (View) using no marshalling. - - Pointer to the Control (Views) handle - C pointer to the Control (View) name - - - - Function which registers a view and all it's scriptable properties with DALi's type registry. - Means the View can be created / configured from a JSON script. - - The function uses introspection to scan a Views C# properties, then selects the ones with - [ScriptableProperty] attribute to be registered. - Example of a Spin view registering itself - static Spin() - { - ViewRegistry registers control type with DALi type registery - also uses introspection to find any properties that need to be registered with type registry - ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) ); - } - - - - - - Get a property value from a View - - - - - - Set a property value on a View - - - - - - Spin CustomView class - - - - - Creates an initialized Spin. - - - - - - - - Event handler when the TextField in Spin looses it's Key focus - - - - - - - - Value to be set in Spin. - - - - - Minimum Value of Spin Value. - - - - - Maximum Value of Spin Value. - - - - - Increasing, decresing step of Spin Value when Up or Down key is pressed. - - - - - Wrapping enabled status. - - - - - Text point size of Spin Value. - - - - - The color of Spin Value. - - - - - Maximum text lengh of Spin Value. - - - - - Reference of TextField of Spin. - - - - - Show indicator image, for example Up/Down Arrow image. - - - - - - Constructor. - - - - - Creates an angle in degrees. - - The initial value in degrees - - - - Creates an angle in degrees from a Radian. - - The initial value in Radians - - - - - To make FocusManager instance be disposed. - - - - - Event arguments that passed via PreFocusChange signal - - - - - - Event arguments that passed via FocusChanged signal. - - - - - FocusGroupChanged will be triggered after the current focused view has been changed. - - - - - Event arguments that passed via FocusGroupChanged signal. - - - - - - Event arguments that passed via FocusedViewEnterKey signal - - - - - FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it. - - - - - - Gets the current focused view. - - A handle to the current focused View or an empty handle if no View is focused - - - - Moves the focus to the next focusable View in the focus chain in the given direction(according to the focus traversal order). - - The direction of focus movement - true if the movement was successful - - - - - Move the focus to prev focused view. - - - - - - - Checks whether the view is set as a focus group or not. - - The View to be checked - Whether the View is set as a focus group - - - - Returns the closest ancestor of the given view that is a focus group. - - The View to be checked for its focus group - The focus group the given view belongs to or an empty handle if the given view - - - - - - Gets the singleton of FocusManager object. - - - - - - - The gesture type. - - - - - The gesture state. - - - - - The time the gesture took place. - - - - - Copy constructor. - - A reference to the copied handle - - - - Enumeration for type of gesture - - - - - Enumeration for state of the gesture. - - - - - - The time (in ms) that the hover event occurred. - - - - - - Retrieves the State of the point specified. - - The point required - The state of the point specified - - - - Retrieves the view that was underneath the point specified. - - The point required - The view that was underneath the point specified - - - - Retrieves the co-ordinates relative to the top-left of the hit-view at the point specified. - - The point required - The co-ordinates relative to the top-left of the hit-view of the point specified - - - - Retrieves the co-ordinates relative to the top-left of the screen of the point specified. - - The point required - The co-ordinates relative to the top-left of the screen of the point specified - - - - Default constructor. - - - - - Constructor. - - The time the event occurred - - - - Returns the total number of points. - - Total number of Points - - - - Specifically manages the ecore input method framework which enables the virtual or hardware keyboards. - - - - - This structure is used to pass on data from the IMF regarding predictive text. - - - - - Dispose pattern - - - - - Default Constructor - - - - - Constructor - - The name of the event from the IMF. - The pre-edit or commit string. - Start position from the current cursor position to start deleting characters. - The number of characters to delete from the cursorOffset. - - - - The pre-edit or commit string. - - - - - The pre-edit or commit string. - - - - - The name of the event from the IMF. - - - - - The name of the event from the IMF. - - - - - Start position from the current cursor position to start deleting characters. - - - - - Start position from the current cursor position to start deleting characters. - - - - - Number of characters to delete from the cursorOffset. - - - - - Number of characters to delete from the cursorOffset. - - - - - Data required by IMF from the callback. - - - - - Dispose pattern - - - - - Default Constructor - - - - - Constructor - - True if cursor position needs to be updated. - New position of cursor. - Current text string. - Flag if preedit reset is required. - - - - Current text string. - - - - - Current text string. - - - - - Current text string. - - - - - Current text string. - - - - - If cursor position needs to be updated. - - - - - If cursor position needs to be updated. - - - - - Flag if preedit reset is required. - - - - - Flag if preedit reset is required. - - - - - Retrieve a handle to the instance of ImfManager. - - A handle to the ImfManager. - - - - Activate the IMF.
- It means that the text editing is started at somewhere.
- If the H/W keyboard isn't connected then it will show the virtual keyboard. - - - - - Deactivate the IMF.
- It means that the text editing is finished at somewhere. - - - - - Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
- If true then keyboard will be restored (activated) after focus is regained. - - Restoration status. - - - - Set status whether the IMF has to restore the keyboard after losing focus. - - True means that keyboard should be restored after focus lost and regained. - - - - Send message reset the pred-edit state / imf module. - - - - - Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation. - - - - - Sets cursor position stored in VirtualKeyboard, this is required by the IMF context. - - Position of cursor. - - - - Gets cursor position stored in VirtualKeyboard, this is required by the IMF context. - - Current position of cursor - - - - Method to store the string required by the IMF, this is used to provide predictive word suggestions. - - The text string surrounding the current cursor point. - - - - Gets current text string set within the IMF manager, this is used to offer predictive suggestions. - - Surrounding text. - - - - Notifies IMF context that text input is set to multi line or not. - - True if multiline text input is used. - - - - Returns text direction of the keyboard's current input language. - - The direction of the text. - - - - Provides size and position of keyboard.
- Position is relative to whether keyboard is visible or not.
- If keyboard is not visible then position will be off the screen.
- If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
- the values then taken down. So ideally GetInputMethodArea() should be called after Show(). - - Rectangle which is keyboard panel x, y, width, height - - - - Sets up the input-panel specific data. - - The specific data to be set to the input panel. - - - - Gets the specific data of the current active input panel. - - The specific data to be got from the input panel. - - - - Gets the state of the current active input panel. - - The state of the input panel. - - - - Sets the return key on the input panel to be visible or invisible.
- The default is true. - - True if the return key is visible(enabled), false otherwise. - - - - Enable to show the input panel automatically when focused. - - If true, the input panel will be shown when focused. - - - - Shows the input panel. - - - - - Hides the input panel. - - - - - Gets the keyboard type.
- The default keyboard type is SoftwareKeyboard. - - The keyboard type - - - - Gets the current language locale of the input panel.
- Ex) en_US, en_GB, en_PH, fr_FR, ... - - The current language locale of the input panel. - - - - Constructor - - - - - ImfManager activated event arguments. - - - - - ImfManager activated event. - - - - - ImfManager activated event arguments. - - - - - ImfManager activated. - - - - - ImfManager activated signal. - - - - - ImfManager event received event arguments. - - - - - ImfManager event received. - - - - - ImfManager event received event arguments. - - - - - ImfManager event received. - - - - - ImfManager event received signal. - - - - - ImfManager status changed event arguments. - - - - - ImfManager status changed. - - - - - ImfManager status changed event arguments. - - - - - ImfManager status changed. - - - - - ImfManager status changed signal. - - - - - ImfManager resized event arguments. - - - - - ImfManager resized event. - - - - - ImfManager resized. - - - - - ImfManager resized signal. - - - - - ImfManager language changed event arguments. - - - - - ImfManager language changed event. - - - - - ImfManager language changed. - - - - - ImfManager language changed signal. - - - - - ImfManager keyboard type changed event arguments. - - - - - ImfManager keyboard type changed. - - - - - The direction of text. - - - - - Left to right. - - - - - Right to left. - - - - - Events that are generated by the IMF. - - - - - No event. - - - - - Pre-Edit changed. - - - - - Commit recieved. - - - - - Event to delete a range of characters from the string. - - - - - Event to query string and cursor position. - - - - - Private command sent from the input panel. - - - - - Enumeration for state of the input panel. - - - - - Unknown state. - - - - - Input panel is shown. - - - - - Input panel is hidden. - - - - - Input panel in process of being shown. - - - - - Enumeration for the type of Keyboard. - - - - - Software keyboard (Virtual keyboard) is default. - - - - - Hardware keyboard. - - - - - A class encapsulating the input method map. - - - - - Default constructor. - - - - - Get or set panel layout. - - - - - Get or set action button. - - - - - Get or set auto capital. - - - - - Get or set variation. - - - - - Get or set variation for normal layout. - - - - - Get or set variation for number only layout. - - - - - Get or set variation for password layout. - - - - - Get the input method map. - - - - - SetType that can be changed in the system Input Method. - - - - - Set Keyboard layout. - - - - - Set Action button title. - - - - - Set Auto capitalise of input. - - - - - Set variation. - - - - - Autocapitalization Types. - - - - - No auto-capitalization when typing. - - - - - Autocapitalize each word typed. - - - - - Autocapitalize the start of each sentence. - - - - - Autocapitalize all letters. - - - - - Input panel (virtual keyboard) layout types.. - - - - - Default layout. - - - - - Number layout. - - - - - Email layout. - - - - - URL layout. - - - - - Phone number layout. - - - - - IP layout. - - - - - Month layout. - - - - - Number layout. - - - - - Hexadecimal layout. - - - - - Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization). - - - - - Like normal, but no auto-correct, no auto-capitalization etc. - - - - - Date and time layout. - - - - - Emoticon layout. - - - - - Specifies what the Input Method "action" button functionality is set to. - - - - - Default action. - - - - - Done. - - - - - Go action. - - - - - Join action. - - - - - Login action. - - - - - Next action. - - - - - Previous action. - - - - - Search action. - - - - - Send action. - - - - - Sign in action. - - - - - Unspecified action. - - - - - Nothing to do. - - - - - Available variation for Normal layout. - - - - - The plain normal layout. - - - - - Filename layout. sysbols such as '/' should be disabled. - - - - - The name of a person. - - - - - Available variation for Number only layout. - - - - - The plain normal number layout. - - - - - The number layout to allow a positive or negative sign at the start. - - - - - The number layout to allow decimal point to provide fractional value. - - - - - The number layout to allow decimal point and negative sign. - - - - - Available variation for Password layout. - - - - - The normal password layout. - - - - - The password layout to allow only number. - - - - - The key structure is used to store a key press. - - - - - Name given to the key pressed - - - - - Keycode for the key pressed. - - - - - Special keys like shift, alt and control which modify the next key pressed. - - - - - The time (in ms) that the key event occurred. - - - - - State of the key event. - - - - - Default Constructor. - - - - - Constructor. - - The name of the key pressed or command from the IMF, if later then the some following parameters will be needed - A string of input characters or key pressed - The unique key code for the key pressed - The key modifier for special keys like shift and alt - The time (in ms) that the key event occurred - The state of the key event - - - - Checks to see if Shift key modifier has been supplied. - - True if shift modifier - - - - Checks to see if Ctrl (control) key modifier has been supplied. - - True if ctrl modifier - - - - Checks to see if Alt key modifier has been supplied. - - True if alt modifier - - - - Enumeration for specifying the state of the key event. - - - - - - Adds a key frame. - - A progress value between 0.0 and 1.0 - A value - - - - Adds a key frame. - - A progress value between 0.0 and 1.0 - A value - The alpha function used to blend to the next keyframe - - - - Creates an initialized KeyFrames handle. - - - - - Gets the type of the key frame. - - The key frame property type - - - - Adds a key frame. - - A progress value between 0.0 and 1.0 - A value - - - - Adds a key frame. - - A progress value between 0.0 and 1.0 - A value - The alpha function used to blend to the next keyframe - - - - Layers provide a mechanism for overlaying groups of actors on top of each other. - - - - - Creates a Layer object. - - - - - Search through this layer's hierarchy for an view with the given unique ID. - - 
This layer(the parent) has been initialized.
- The actor itself is also considered in the search. - The id of the child to find - A handle to the view if found, or an empty handle if not. - - - - Adds a child view to this layer. - - 
This layer(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent layer.
- The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. - If the child already has a parent, it will be removed from old parent and reparented to this layer. This may change child's position, color, scale etc as it now inherits them from this layer. - The child - - - - Removes a child View from this layer. If the view was not a child of this layer, this is a no-op. - - 
This layer(the parent) has been initialized. The child view is not the same as the parent view.
- The child - - - - - Increments the depth of the layer. - - - - - Decrements the depth of the layer. - - - - - Raises the layer to the top. - - - - - Lowers the layer to the bottom. - - - - - - - Retrieves child view by index. - - 
The View has been initialized.
- The index of the child to retrieve - The view for the given index or empty handle if children not initialized - - - - Enumeration for the behavior of the layer. - - - - - Layer Behavior, type String(Layer.LayerBehavior) - - - - - Internal only property to Enable/Disable Clipping, type Boolean. - By default this is false, i.e. the viewport of the Layer is the entire window. - - - - - Sets the Viewport (in window coordinates), type Rectangle. - The contents of the layer will not be visible outside this box, when ViewportEnabled is true. - - - - - - Retrieves and sets the Layer's visibility. - - - - - Get the number of children held by the layer. - - - - - Gets/Sets the Layer's name. - - - - - - - - - Constructor. - - The state of the gesture - - - - Represents an application that have UI screen. The NUIApplication class has a default stage. - - - - - Occurs whenever the application is resumed. - - - - - Occurs whenever the application is paused. - - - - - The instance of ResourceManager. - - - - - The default constructor. - - - - - The constructor with stylesheet. - - - - - The constructor with stylesheet and window mode. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Overrides this method if want to handle behavior. - - - - - Run NUIApplication. - - Arguments from commandline. - - - - Exit NUIApplication. - - - - - Enumeration for deciding whether a NUI application window is opaque or transparent. - - - - - ResourceManager to handle multilingual - - - - - Get the window instance. - - - - - This specifies whether the Actor uses its own color, or inherits. - - - - - Actor will use its own color. - - - - - Actor will use its parent color. - - - - - Actor will blend its color with its parents color. - - - - - Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default. - - - - - This specifies the dimesion of width or heigh for size negotiation. - - - - - Width dimension - - - - - Height dimension - - - - - Mask to cover all flags - - - - - Enumeration for the instance of how the actor and it's children will be drawn. - - - - - The default draw-mode - - - - - Draw the actor and its children as an overlay - - - - - Will be replaced by separate ClippingMode enum. Draw the actor and its children into the stencil buffer - - - - - Enumeration for size negotiation resize policies. - - - - - Size is fixed as set by SetSize - - - - - Size is to use the actor's natural size - - - - - - Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. - - - - - The actors size will be ( ParentSize * SizeRelativeToParentFactor ). - - - - - The actors size will be ( ParentSize + SizeRelativeToParentFactor ). - - - - - Size will adjust to wrap around all children - - - - - One dimension is dependent on the other - - - - - The size will be assigned to the actor - - - - - Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation. - - - - - Use the size that was set - - - - - Fit within the size set maintaining natural size aspect ratio - - - - - Fit within the size set maintaining natural size aspect ratio - - - - - Enumeration for ClippingMode describing how this Actor's children will be clipped against it. - - - - - This Actor will not clip its children. - - - - - This Actor will clip all children to within its boundaries (the actor will also be visible itself). - - - - - Enumeration for type determination of how camera operates. - - - - - Camera orientation is taken from CameraActor. - - - - - Camera is oriented to always look at a target. - - - - - Enumeration for projection modes. - - - - - Distance causes foreshortening; objects further from the camera appear smaller. - - - - - Relative distance from the camera does not affect the size of objects. - - - - - This specifies ccustomView behaviour types. - - - - - Use to provide default behaviour (size negotiation is on, event callbacks are not called) - - - - - True if control does not need size negotiation, i.e. it can be skipped in the algorithm - - - - - Use to provide key navigation support. - - - - - Use to make style change event disabled. - - - - - - No type - - - - - A boolean type - - - - - A float type - - - - - An integer type - - - - - a vector array of size=2 with float precision - - - - - a vector array of size=3 with float precision - - - - - a vector array of size=4 with float precision - - - - - a 3x3 matrix - - - - - a 4x4 matrix - - - - - an integer array of size=4 - - - - - either a quaternion or an axis angle rotation - - - - - A string type - - - - - an array of PropertyValue - - - - - a string key to PropertyValue mapping - - - - - - if the property is read-only - - - - - If the property is read/writeable - - - - - If the property can be animated or constrained - - - - - The number of access modes - - - - - Types of style change. Enumeration for StyleChange type. - - - - - Denotes that the default font has changed. - - - - - Denotes that the default font size has changed. - - - - - Denotes that the theme has changed. - - - - - Enumeration for horizontal alignment types. - - - - - Align horizontally left - - - - - Align horizontally center - - - - - Align horizontally right - - - - - Enumeration for vertical alignment types. - - - - - Align vertically top - - - - - Align vertically center - - - - - Align vertically bottom - - - - - Enumeration for point state type. - - - - - Touch or hover started - - - - - Touch or hover finished - - - - - Screen touched - - - - - Touch stopped - - - - - Finger dragged or hovered - - - - - Leave the boundary of an actor - - - - - - A system event has occurred which has interrupted the touch or hover event sequence. - - - - - Enumeration for the text horizontal aligning. - - - - - Texts place at the begin of horizontal direction. - - - - - Texts place at the center of horizontal direction. - - - - - Texts place at the end of horizontal direction. - - - - - Enumeration for the text horizontal aligning. - - - - - Texts place at the top of vertical direction. - - - - - Texts place at the center of vertical direction. - - - - - Texts place at the bottom of vertical direction. - - - - - - Defualt value - - - - - Clamp to edge - - - - - Repeat - - - - - Mirrored repeat - - - - - The type of coordinate system for certain attributes of the points in a gradient. - - - - - - - - Uses the terminal colors of the gradient to fill the remainder of the quad. - - - - - Reflect the gradient pattern start-to-end, end-to-start, start-to-end etc. until the quad is filled. - - - - - Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled. - - - - - The shading mode used by MeshVisual. - - - - - *Simplest*. One color that is lit by ambient and diffuse lighting. - - - - - Uses only the visual image textures provided with specular lighting in addition to ambient and diffuse lighting. - - - - - Uses all textures provided including a gloss, normal and texture map along with specular, ambient and diffuse lighting. - - - - - The primitive shape to render as a PrimitiveVisual. - - - - - A perfectly round geometrical object in three-dimensional space. - - - - - The area bound between two circles, i.e. a cone with the tip removed. - - - - - Equivalent to a conical frustrum with top radius of zero. - Equivalent to a conical frustrum with top radius of zero. - - - - Equivalent to a conical frustrum with top radius of zero. - - - - - Equivalent to a conical frustrum with equal radii for the top and bottom circles. - - - - - Equivalent to a bevelled cube with a bevel percentage of zero. - - - - - Equivalent to a bevelled cube with a bevel percentage of one. - - - - - - Full-screen image display: Limit loaded image resolution to device resolution using ShrinkToFit mode. - - - - - Thumbnail gallery grid: Limit loaded image resolution to screen tile using ScaleToFill mode. - - - - - Image columns: Limit loaded image resolution to column width using FitWidth mode. - - - - - Image rows: Limit loaded image resolution to row height using FitHeight mode. - - - - - - - For each output pixel, read one input pixel. - - - - - For each output pixel, read a quad of four input pixels and write a weighted average of them. - - - - - - Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average. - - - - - No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions. - - - - - For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image. - - - - - This specifies policy types that could be used by the transform for the offset or size. - - - - - Relative to the control (percentage [0.0f to 1.0f] of the control). - - - - - Absolute value in world units. - - - - - This specifies all the transform property types. - - - - - Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). - - - - - Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). - - - - - The origin of the visual within its control area. - - - - - The anchor-point of the visual - - - - - Whether the x or y OFFSET values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units). - - - - - Whether the width or height SIZE values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units). - - - - - This specifies visual types. - - - - - The index for the visual type. - - - - - Renders a solid color as an internal border to the control's quad. - - - - - Renders a solid color to the control's quad. - - - - - Renders a smooth transition of colors to the control's quad. - - - - - Renders an image into the control's quad. - - - - - Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. - - - - - Renders a simple 3D shape, such as a cube or sphere. - - - - - Renders a simple wire-frame outlining a quad. - - - - - Renders text. - - - - - Renders an n-patch image. - - - - - Renders an SVG image. - - - - - Renders a animated image. (Animated GIF) - - - - - This specifies visual properties. - - - - - This specifies shader properties. - - - - - This specifies Visaul align types. - - - - - This specifies properties of BorderVisual. - - - - - This specifies properties of ColorVisual. - - - - - This specifies properties of GradientVisual. - - - - - This specifies properties of ImageVisual. - - - - - This specifies properties of MeshVisual. - - - - - This specifies properties of PrimitiveVisual. - - - - - This specifies properties of TextVisual. - - - - - This specifies properties of NpatchImageVisual. - - - - - HiddenInput Property. - - - - - The type for HiddenInput mode. - - - - - Don't hide text. - - - - - Hide all the input text. - - - - - Hide n characters from start. - - - - - Show n characters from start. - - - - - Show last character for the duration(use ShowDuration property to modify duration). - - - - - ParentOrigin constants. - - - - - PivotPoint constants. - - - - - PositionAxis constants. - - - - - Auto scrolling stop behaviour. - - - - - Stop animation after current loop finished. - - - - - Stop animation immediatly and reset position. - - - - - An enum of screen mode. - - - - - The mode which turns the screen off after a timeout. - - - - - The mode which keeps the screen turned on. - - - - - An enum of notification window's priority level. - - - - - - Base nofitication level. - - - - - Medium notification level than base. - - - - - Higher notification level than medium. - - - - - The highest notification level. - - - - - An enum of Window types. - - - - - - A notification window, like a warning about battery life or a new E-Mail received. - - - - - A persistent utility window, like a toolbox or palette. - - - - - Used for simple dialog windows. - - - - - An enum of scroll state of text eidtor. - - - - - Scrolling is started. - - - - - Scrolling is finished. - - - - - An enum of line wrap mode of text controls. - - - - - Word mode will move word to next line - - - - - character will move character by character to next line - - - - - - - - - - - - This current touch position of the primary touch point in local actor coordinates. - - - - - - - This current touch position of the primary touch point in screen coordinates. - - - - - The total number of fingers touching the screen in a pan gesture. - - - - - Default Constructor. - - - - - Constructor. - - The state of the gesture - - - - - - - - - Creates an initialized Path handle. - - - - - Adds an interpolation point. - - The new interpolation point to be added - - - - Adds a control point. - - The new control point to be added - - - - - Sample path at a given progress. Calculates position and tangent at that point of the curve. - - A floating point value between 0.0 and 1.0 - The interpolated position at that progress - The interpolated tangent at that progress - - - - Accessor for the interpolation points. - - The index of the interpolation point - - - - Accessor for the control points. - - The index of the control point - - - - Gets the number of interpolation points in the path. - - The number of interpolation points in the path - - - - Enumeration for Points - - - - - Enumeration for ControlPoints - - - - - - - - The center point of the two points that caused the pinch gesture in screen coordinates. - - - - - The center point of the two points that caused the pinch gesture in local actor coordinates. - - - - - Default Constructor. - - The state of the gesture - - - - Position is a three dimensional vector. - - - - - Addition operator. - - Vector to add - Vector to add - A vector containing the result of the addition - - - - Subtraction operator. - - Vector to subtract - Vector to subtract - A vector containing the result of the subtraction - - - - Unary negation operator. - - Vector to netate - A vector containg the negation - - - - Multiplication operator. - - The vector to multiply - The vector to multiply - A vector containing the result of the multiplication - - - - Multiplication operator. - - The vector to multiply - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - The vector to divide - The vector to divide - A vector containing the result of the division - - - - Division operator. - - The vector to divide - The float value to scale the vector by - A vector containing the result of the scaling - - - - Const array subscript operator overload. Should be 0, 1 or 2. - - Subscript index - The float at the given index - - - - - - - - Constructor - - - - - Constructor - - x component - y component - z component - - - - Constructor - - Position2D to create this vector from - - - - Compare if rhs is equal to - - The vector to compare - Returns true if the two vectors are equal, otherwise false - - - - Compare if rhs is not equal to - - The vector to compare - Returns true if the two vectors are not equal, otherwise false - - - - x component - - - - - y component - - - - - z component - - - - - ParentOrigin constants. It's 0.0. - - - - - ParentOrigin constants. It's 1.0. - - - - - ParentOrigin constants. It's 0.0. - - - - - ParentOrigin constants. It's 1.0. - - - - - ParentOrigin constants. It's 0.5. - - - - - ParentOrigin constants: 0.0, 0.0, 0.5 - - - - - ParentOrigin constants: 0.5, 0.0, 0.5 - - - - - ParentOrigin constants: 1.0, 0.0, 0.5 - - - - - ParentOrigin constants: 0.0, 0.5, 0.5 - - - - - ParentOrigin constants: 0.0, 0.5, 0.5 - - - - - ParentOrigin constants: 1.0, 0.5, 0.5 - - - - - ParentOrigin constants: 0.0f, 1.0f, 0.5f - - - - - ParentOrigin constants: 0.5, 1.0, 0.5 - - - - - ParentOrigin constants: 1.0, 1.0, 0.5 - - - - - PivotPoint constants: 0.0 - - - - - PivotPoint constants: 1.0 - - - - - PivotPoint constants: 0.0 - - - - - PivotPoint constants: 1.0 - - - - - PivotPoint constants: 0.0 - - - - - PivotPoint constants: 0.0, 0.0, 0.5 - - - - - PivotPoint constants: 0.5, 0.0, 0.5 - - - - - PivotPoint constants: 1.0, 0.0, 0.5 - - - - - PivotPoint constants: 0.0, 0.5, 0.5 - - - - - PivotPoint constants: 0.5, 0.5, 0.5 - - - - - PivotPoint constants: 1.0, 0.5, 0.5 - - - - - PivotPoint constants: 0.0, 1.0, 0.5 - - - - - PivotPoint constants: 0.5, 1.0, 0.5 - - - - - PivotPoint constants: 1.0, 1.0, 0.5 - - - - - Constant ( 1.0f, 1.0f, 1.0f ) - - - - - Constant ( 0.0f, 0.0f, 0.0f ) - - - - - Convert a position instance to a vector3 instance. - - - - - Convert a vector3 instance to a position instance. - - - - - Position2D is a two dimensional vector. - - - - - Addition operator. - - Vector to add - Vector to add - A vector containing the result of the addition - - - - Subtraction operator. - - Vector to subtract - Vector to subtract - A vector containing the result of the subtraction - - - - Unary negation operator. - - Vector to netate - A vector containing the negation - - - - Multiplication operator. - - Vector to multiply - Vector to multiply - A vector containing the result of the multiplication - - - - Multiplication operator. - - Vector to multiply - The int value to scale the vector - A vector containing the result of the multiplication - - - - Division operator. - - Vector to divide - Vector to divide - A vector containing the result of the division - - - - Division operator. - - Vector to divide - The int value to scale the vector by - A vector containing the result of the division - - - - Const array subscript operator overload. Should be 0, or 1. - - Subscript index - The float at the given index - - - - Constructor - - - - - Constructor - - x component - y component - - - - Constructor - - Position to create this vector from - - - - Compare if rhs is equal to. - - The vector to compare - Returns true if the two vectors are equal, otherwise false - - - - Compare if rhs is not equal to. - - The vector to compare - Returns true if the two vectors are not equal, otherwise false - - - - x component. - - - - - y component. - - - - - Convert a position2D instance to a vector2 instance. - - - - - Convert a vector2 instance to a position2D instance. - - - - - Convert a Position2D instance to a Uint16Pair instance. - - - - - Convert a Uint16Pair instance to a Position2D instance. - - - - - Constructor. Create a Property instance. - - A valid handle to the target object - The index of a property - - - - Constructor. Create a Property instance. - - A valid handle to the target object - The index of a property - Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1) - - - - - - Gets/Sets the index of the property. - - - - - Gets/Sets the componentIndex of the property. - - - - - A Array of property values. - - - - - Operator to access an element. - - The element index to access. No bounds checking is performed - The a reference to the element - - - - Constructor - - - - - Retrieves the number of elements in the array. - - The number of elements in the array - - - - Retrieves the number of elements in the array. - - The number of elements in the array - - - - Returns whether the array is empty. - - Return true if empty, false otherwise - - - - Clears the array. - - - - - Increases the capacity of the array. - - The size to reserve - - - - Resizes to size. - - The size to resize - - - - Retrieves the capacity of the array. - - The allocated capacity of the array - - - - Adds an element to the array. - - The value to add to the end of the array - - - - Add an element to the array. - - The value to add to the end of the array - - - - Access an element. - - The element index to access. No bounds checking is performed - The a reference to the element - - - - Retrieves the value of elements in the array. - - The element index to retrieve. - The a reference to the element - - - - A key type which can be either a std::string or a Property::Index - - - - - The type of the key - - - - - The index key. - - - - - The string key. - - - - - Constructor - - The string key - - - - Constructor - - The index key - - - - Compare if rhs is equal to - - A string key to compare against - Returns true if the key compares, or false if it isn't equal or of the wrong type - - - - Compare if rhs is equal to - - A index key to compare against - Returns true if the key compares, or false if it isn't equal or of the wrong type - - - - Compare if rhs is equal to - - A key to compare against - Returns true if the keys are of the same type and have the same value - - - - Compare if rhs is not equal to - - An index key to compare against. - Returns true if the key is not equal or not a string key - - - - Compare if rhs is not equal to - - An index key to compare against. - Returns true if the key is not equal, or not an index key - - - - Compare if rhs is not equal to - - A key to compare against. - Returns true if the keys are not of the same type or are not equal - - - - The type of key - - - - - A Map of property values, the key type could be String or Property::Index. - - - - - - - Constructor - - - - - Copy Constructor - - The Map to copy from - - - - Retrieves the number of elements in the map. - - The number of elements in the map - - - - Returns whether the map is empty. - - Returns true if empty, false otherwise - - - - - - - - Retrieves the value at the specified position. - - The specified position - A reference to the value at the specified position - - - - Retrieve the key at the specified position. - - The specified position - A copy of the key at the specified position - - - - Finds the value for the specified key if it exists. - - The key to find - The value if it exists, an empty object otherwise - - - - Finds the value for the specified keys if either exist. - - The index key to find - The string key to find - The value if it exists, an empty object otherwise - - - - Clears the map. - - - - - - Retrieves the element with the specified string key. - - The key whose value to retrieve - The value for the element with the specified key - - - - Retrieves the element with the specified index key. - - The key whose value to retrieve - The value for the element with the specified key - - - - A value-type representing a property value. - - - - - - Creates a Size2D property value. - - A Size2D values - - - - Creates a Position2D property value. - - A Position2D values - - - - Creates a Size property value. - - A Size values - - - - Creates a Position property value. - - A Position values - - - - Creates a Color property value. - - A Color values - - - - Retrieves a Size2D value. - - On return, a Size2D value - - - - Retrieves a Position2D value. - - On return, a Position2D value - - - - Retrieves a Size value. - - On return, a Size value - - - - Retrieves a Position value. - - On return, a Position value - - - - Retrieves a Color value. - - On return, a Color value - - - - Default constructor. - - - - - Creates a boolean property value. - - A boolean value - - - - Creates an integer property value. - - An integer value - - - - Creates a float property value. - - A floating-point value - - - - Creates a Vector2 property value. - - A vector of 2 floating-point values - - - - Creates a Vector3 property value. - - A vector of 3 floating-point values - - - - Creates a Vector4 property value. - - A vector of 4 floating-point values - - - - Creates a Rectangle property value. - - A Rectangle values - - - - Creates a Rotation property value. - - A Rotation values - - - - Creates a string property value. - - A string - - - - Creates an array property value. - - An array - - - - Creates a map property value. - - An array - - - - Creates a PropertyType value. - - A PropertyType values - - - - Creates a PropertyValue value. - - A PropertyValue values - - - - Queries the type of this property value. - - The type ID - - - - Retrieves a boolean value. - - On return, a boolean value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a floating-point value. - - On return, a floating-point value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a integer value. - - On return, a integer value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves an integer rectangle. - - On return, an integer rectangle - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a vector value. - - On return, a vector value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a vector value. - - On return, a vector value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a vector value. - - On return, a vector value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a Rotation value. - - On return, a Rotation value - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves a string property value. - - On return, a string - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves an array property value. - - On return, the array as a vector Property Values - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - Retrieves an map property value. - - On return, the map as vector of string and Property Value pairs - Returns true if the value is successfully retrieved, false if the type is not convertible - - - - An angle in radians. - - - - - Default constructor, initializes to 0. - - - - - Creates an angle in radians. - - The initial value in radians - - - - Creates an angle in radians from an angle in degrees. - - The initial value in degrees - - - - Conversion to float. - - The float value of this Radian - - - - The value in radians - - - - - Rectangle class - - - - - Equality operator. - - First operand - Second operand - True if boxes are exactly same - - - - Inequality operator. - - The first rectangle - The second rectangle - True if rectangles are not identical - - - - X position of the rectangle - - - - - Y position of the rectangle - - - - - Width of the rectangle - - - - - Height of the rectangle - - - - - Constructor. - - - - - Constructor. - - X coordinate (or left) - Y coordinate (or right) - Width (or bottom) - Height (or top) - - - - Assignment from individual values. - - X coordinate - Y coordinate - Width - Height - - - - Determines whether or not this Rectangle is empty. - - True if width or height are zero - - - - Gets the left of the rectangle. - - The left edge of the rectangle - - - - Gets the right of the rectangle. - - The right edge of the rectangle - - - - Gets the top of the rectangle. - - The top of the rectangle - - - - Gets the bottom of the rectangle. - - The bottom of the rectangle - - - - Gets the area of the rectangle. - - The area of the rectangle - - - - Determines whether or not this rectangle and the specified rectangle intersect. - - The other rectangle to test against this rectangle - True if the rectangles intersect - - - - Determines whether or not this Rectangle contains the specified rectangle. - - The other rectangle to test against this rectangle - True if the specified rectangle is contained - - - - RelativeVector2 is a two dimensional vector. - Both values(x and y) should be between [0, 1]. - - - - - Addition operator. - - Vector to add - Vector to add - A vector containing the result of the addition - - - - Subtraction operator. - - Vector to subtract - Vector to subtract - A vector containing the result of the subtraction - - - - Multiplication operator. - - The vector to multiply - The vector to multiply - A vector containing the result of the multiplication - - - - Multiplication operator. - - The vector to multiply - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - The vector to divide - The vector to divide - A vector containing the result of the division - - - - Division operator. - - The vector to divide - The float value to scale the vector by - A vector containing the result of the scaling - - - - Const array subscript operator overload. Should be 0, 1. - - Subscript index - The float at the given index - - - - - - - - Constructor - - - - - Constructor - - x component - y component - - - - Constructor - - RelativeVector3 to create this vector from - - - - Constructor - - RelativeVector4 to create this vector from - - - - Compare if rhs is equal to - - The vector to compare - Returns true if the two vectors are equal, otherwise false - - - - Compare if rhs is not equal to - - The vector to compare - Returns true if the two vectors are not equal, otherwise false - - - - x component - - - - - y component - - - - - - - - - - - - - RelativeVector3 is a three dimensional vector. - All values(x, y, z and w) should be between [0, 1]. - - - - - Addition operator. - - Vector to add - Vector to add - A vector containing the result of the addition - - - - Subtraction operator. - - Vector to subtract - Vector to subtract - A vector containing the result of the subtraction - - - - Multiplication operator. - - The vector to multiply - The vector to multiply - A vector containing the result of the multiplication - - - - Multiplication operator. - - The vector to multiply - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - The vector to divide - The vector to divide - A vector containing the result of the division - - - - Division operator. - - The vector to divide - The float value to scale the vector by - A vector containing the result of the scaling - - - - Const array subscript operator overload. Should be 0, 1 or 2. - - Subscript index - The float at the given index - - - - - - - - Constructor - - - - - Constructor - - x component - y component - z component - - - - Constructor - - RelativeVector2 to create this vector from - - - - Constructor - - RelativeVector4 to create this vector from - - - - Compare if rhs is equal to - - The vector to compare - Returns true if the two vectors are equal, otherwise false - - - - Compare if rhs is not equal to - - The vector to compare - Returns true if the two vectors are not equal, otherwise false - - - - x component - - - - - y component - - - - - z component - - - - - - - - - - - - - RelativeVector4 is a four dimensional vector. - All values(x, y, and z) should be between [0, 1]. - - - - - Addition operator. - - Vector to add - Vector to add - A vector containing the result of the addition - - - - Subtraction operator. - - Vector to subtract - Vector to subtract - A vector containing the result of the subtraction - - - - Multiplication operator. - - The vector to multiply - The vector to multiply - A vector containing the result of the multiplication - - - - Multiplication operator. - - The vector to multiply - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - The vector to divide - The vector to divide - A vector containing the result of the division - - - - Division operator. - - The vector to divide - The float value to scale the vector by - A vector containing the result of the scaling - - - - Const array subscript operator overload. Should be 0, 1 3 or 3. - - Subscript index - The float at the given index - - - - - - - - Constructor - - - - - Constructor - - x component - y component - z component - w component - - - - Constructor - - RelativeVector2 to create this vector from - - - - Constructor - - RelativeVector3 to create this vector from - - - - Compare if rhs is equal to - - The vector to compare - Returns true if the two vectors are equal, otherwise false - - - - Compare if rhs is not equal to - - The vector to compare - Returns true if the two vectors are not equal, otherwise false - - - - x component - - - - - y component - - - - - z component - - - - - w component - - - - - - - - - - - - - Interface to encapsulate information required for relayout. - - - - - To make RelayoutContainer instance be disposed. - - - - - Adds relayout information to the container if it doesn't already exist. - - The view to relayout - The size to relayout - - - - Rotation Class - - - - - To make Rotation instance be disposed. - - - - - Addition operator. - - First Rotation - Second Rotation - A Rotation containing the result of the Addition - - - - Subtraction operator. - - First Rotation - Second Rotation - A Rotation containing the result of the subtract - - - - Unary Negation operator. - - First Rotation - A Rotation containing the negated result - - - - Multiplication operator. - - First Rotation - Second Rotation - A Rotation containing the result of the Multiplication - - - - Multiplication operator. - - Rotation - The vector to multiply - A Rotation containing the result of the multiplication - - - - Scale operator. - - Rotation - A value to scale by - A Rotation containing the result of the scaling - - - - Division operator. - - First Rotation - Second Rotation - A Rotation containing the result of the scaling - - - - Scale operator. - - Rotation - A value to scale by - A Rotation containing the result of the scaling - - - - Default Constructor. - - - - - Constructor from an axis and angle. - - The angle around the axis - The vector of the axis - - - - (0.0f,0.0f,0.0f,1.0f) - - - - - Helper to check if this is an identity quaternion. - - True if this is identity quaternion - - - - Converts the quaternion to an axis/angle pair. - - the result of axis - the result of angle Angle in radians - True if converted correctly - - - - Returns the length of the rotation - - The length of the rotation - - - - Returns the squared length of the rotation - - The squared length of the rotation - - - - Normalizes this to unit length. - - - - - Normalized. - - A normalized version of this rotation - - - - Conjugates this rotation. - - - - - Inverts this rotation. - - - - - Performs the logarithm of a rotation - - A rotation representing the logarithm - - - - Performs an exponent - - A rotation representing the exponent - - - - Returns the dot product of two rotations. - - The first rotation - The second rotation - The dot product of the two rotations - - - - Linear Interpolation (using a straight line between the two rotations). - - The start rotation - The end rotation - A progress value between 0 and 1 - The interpolated rotation - - - - Spherical Linear Interpolation (using the shortest arc of a great circle between the two rotations). - - The start rotation - The end rotation - A progress value between 0 and 1 - The interpolated rotation - - - - This version of Slerp, used by Squad, does not check for theta > 90. - - The start rotation - The end rotation - A progress value between 0 and 1 - The interpolated rotation - - - - Spherical Cubic Interpolation. - - The start rotation - The end rotation - The control rotation for q1 - The control rotation for q2 - A progress value between 0 and 1 - The interpolated rotation - - - - Returns the shortest angle between two rotations in Radians. - - The first rotation - The second rotation - The angle between the two rotation - - - - A two dimensional size - - - - - Dispose - - - - - Addition operator for A+B - - Size, A - Size to assign, B - A Size containing the result of the addition - - - - Subtraction operator for A-B - - Size, A - Size to subtract, B - A Size containing the result of the subtraction - - - - Unary negation operator. - - Size for unary negation - A Size containg the negation - - - - Multiplication operator. - - Size for multiplication - The Size to multipl - A Size containing the result of the multiplication - - - - Multiplication operator. - - Size for multiplication - The int value to scale the Size - A Size containing the result of the scaling - - - - Division operator. - - Size for division - The Size to divide - A Size containing the result of the division> - - - - Division operator. - - Size for division - The int value to scale the Size by - A Size containing the result of the scaling - - - - Array subscript operator. - - Subscript index - The float at the given index - - - - Get Size from pointer. - - Pointer of the Size - Size - - - - Constructor. - - - - - Constructor. - - x (or width) component - y (or height) component - - - - - - Property for width component of Size - - - - - Property for height component of Size - - - - - Type cast operator, Size2D to Vector2. - - Object of Size2D type - - - - Type cast operator, Vector2 to Size2D type. - - Object of Vector2 type - - - - Type cast operator, Size2D to Uint16Pair. - - Object of Size2D type - - - - Type cast operator, Uint16Pair to Size2D type. - - Object of Vector2 type - - - - - Dispose - - - - - Style changed event arguments - - - - - StyleManager. - - - - - - - - Gets the singleton of StyleManager object. - - A handle to the StyleManager control - - - - - Applies the default Toolkit theme. - - - - - Sets a constant for use when building styles. - - The key of the constant - The value of the constant - - - - Returns the style constant set for a specific key. - - The key of the constant - The value of the constant if it exists - - - - - Applies the specified style to the control. - - The control to which to apply the style - The name of the JSON style file to apply - The name of the style within the JSON file to apply - - - - A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times. - - - - - Dispose - - - - - Get TapGesture from the pointer. - - The pointer to cast - TapGesture object - - - - Number of taps property (read-only). - - - - - Number of touches property (read-only). - - - - - Screen point property (read-only). - - - - - Local point property (read-only). - - - - - Creates a TapGesture. - - - - - - Event arguments that passed via Tick event. - - - - - - Creates a tick Timer that emits periodic signal. - - Interval in milliseconds - A new timer - - - - - Stops timer. - - - - - - Tells whether timer is running. - - Whether Timer is started or not - - - - - - Returns the time (in ms) that the touch event occurred. - - The time (in ms) that the touch event occurred - - - - Returns the total number of points in this TouchData. - - Total number of Points - - - - - - - - - - - - The Text-to-speech (TTS) Player. - - - - - Gets the singleton of the TtsPlayer for the given mode. - - The mode of tts-player. - A handle of the Ttsplayer for the given mode. - - - - Gets the singleton of the TtsPlayer for the default mode.. - - A handle of the Ttsplayer for the default mode. - - - - Starts playing the audio data synthesized from the specified text. - - The text to play. - The TtsPlayer needs to be initialized. - - - - Stops playing the utterance. - - The TtsPlayer needs to be initialized. - - - - Pauses the currently playing utterance. - - The TtsPlayer needs to be initialized. - - - - Resumes the previously paused utterance. - - The TtsPlayer needs to be initialized. - - - - Gets the current state of the player. - - The current TTS state. - The TtsPlayer needs to be initialized. - - - - State changed argument. - - - - - State changed event. - - - - - Enumeration for the instance of TTS mode. - - - - - Default mode for normal application. - - - - - Notification mode, such as playing utterance is started or completed. - - - - - - Number of Mode. - - - - - Enumeration for the instance of TTS state. - - - - - Player is not available. - - - - - Player is ready to play. - - - - - Player is playing. - - - - - Player is paused. - - - - - - To make Button instance be disposed. - - - - - Clicked will be triggered when the button is touched and the touch point doesn't leave the boundary of the button. - - - - - Pressed will be triggered when the button is touched. - - - - - Released will be triggered when the button is touched and the touch point leaves the boundary of the button. - - - - - StateChanged will be triggered when the button's state is changed. - - - - - Gets/Sets the unselected button foreground/icon visual - - - - - Gets/Sets the selected button foreground/icon visual - - - - - Gets/Sets the disabled selected state foreground/icon button visual - - - - - Gets/Sets the disabled unselected state foreground/icon visual - - - - - Gets/Sets the disabled in the unselected state background, button visual - - - - - Gets/Sets the selected background button visual - - - - - Gets/Sets the disabled while unselected background button visual - - - - - Gets/Sets the disabled while selected background button visual - - - - - Gets/Sets the position of the the label in relation to the foreground/icon if both present - - - - - Gets/Sets the padding around the text - - - - - Gets/Sets the padding around the foreground visual - - - - - - If the autorepeating property is set to true then the togglable property is set to false. - - - - - By default this value is set to 0.15 seconds. - - - - - default this value is set to 0.05 seconds. - - - - - If the togglable property is set to true, then the autorepeating property is set to false. - - - - - /Gets/Sets the togglable button as either selected or unselected, togglable property must be set to true. - - - - - Gets/Sets unselected color. - - - - - Gets/Sets selected color. - - - - - Gets/Sets label. - - - - - Gets/Sets text of label. - - - - - Enumeration for describing the position the text label can be in relation to the control(and foreground/icon). - - - - - At the start of the control before the foreground/icon - - - - - At the end of the control after the foreground/icon - - - - - At the top of the control above the foreground/icon - - - - - At the bottom of the control below the foreground/icon - - - - - - To make CheckBoxButton instance be disposed. - - - - - Creates an initialized CheckBoxButton - - - - - The Popup widget provides a configurable pop-up dialog with built-in layout of three main fields. - - - - - Event arguments that passed via OutsideTouchedEvent - - - - - Event arguments that passed via ShowingEventArgs - - - - - Event arguments that passed via ShownEventArgs - - - - - Event arguments that passed via HidingEventArgs - - - - - Event arguments that passed via HiddenEventArgs - - - - - Event is sent when user has touched outside of the Dialog. - - - - - Event is sent when the Popup is starting to be shown. - - - - - Event is sent when the Popup has been fully displayed. - - - - - Event is sent when the Popup is starting to be hidden. - - - - - Event is sent when the Popup has been completely hidden. - - - - - Create the Popup. - - - - - Sets a title for this Popup. - - The actor to set a title - - - - Sets the content actor. - - The actor to use - - - - Sets the actor to use for a footer in this Popup. - - The footer actor to be added to this Popup - - - - - The display states of the Popup. - - - - - - - Popup title. - - - - - Popup content. - - - - - Popup footer. - - - - - Popup display state. - - - - - Touch transparent. - - - - - Popup tail visibility. - - - - - Popup tail position. - - - - - Contextual mode. - - - - - Animation duration. - - - - - Animation mode. - - - - - Entry animation. - - - - - Exit animation. - - - - - Auto hide delay. - - - - - Backing enabled. - - - - - Backing color. - - - - - Background image. - - - - - Background border. - - - - - Tail up image. - - - - - Tail down image. - - - - - Tail left image. - - - - - Tail right image. - - - - - ProgressBar is a control to give the user an indication of the progress of an operation. - - - - - To make ProgressBar instance be disposed. - - - - - Event arguments that passed via ValueChangedEventArgs - - - - - Event is sent when the ProgressBar value changes. - - - - - Creates the ProgressBar. - - - - - - - Sets the progress-bar as \e indeterminate state. - - - - - - - - - - The Label visual of progress bar. - - - - - A PushButton changes its appearance when is pressed and returns to its original when is released. - - - - - To make PushButton instance be disposed. - - - - - Creates the PushButton. - - - - - Icon located to the left of text. - - - - - Icon located to the right of text. - - - - - Icon located to the top of text. - - - - - Icon located to the bottom of text. - - - - - Icon located to the right of text by default. - - - - - - To make RadioButton instance be disposed. - - - - - Creates an uninitialized RadioButton - - - - - Creates an uninitialized RadioButton with Label - - Label text - - - - - To make ScrollBar instance be disposed. - - - - - Event arguments that passed via PanFinished event - - - - - Event arguments that passed via ScrollPositionIntervalReached event - - - - - current scroll position of the scrollable content - - - - - Event emitted when panning is finished on the scroll indicator. - - - - - Event emitted when the current scroll position of the scrollable content - - - - - Creates an initialized ScrollBar. - - The direction of scroll bar (either vertically or horizontally) - - - - Creates an uninitialized ScrollBar - - - - - Direction of scroll bar - - - - - Indicator height policy. - - - - - Direction of scroll bar - - - - - Indicator height policy. - - - - - the fixed height of scroll indicator. - - - - - the duration in seconds for the scroll indicator to become fully visible. - - - - - the duration in seconds for the scroll indicator to become fully invisible. - - - - - the list of values to get notification when the current scroll position of the scrollable object goes above or below any of these values. - - - - - The minimum height for a variable size indicator. - - - - - The padding at the start of the indicator. For example, the top if scrollDirection is Vertical. - - - - - The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical. - - - - - Slider is a control to enable sliding an indicator between two values. - - - - - Dispose - - - - - Value changed event arguments. - - - - - Slider. - - - - - Slider value. - - - - - Sliding finished event arguments. - - - - - Slider. - - - - - Slider value. - - - - - Mark reached event arguments. - - - - - Slider. - - - - - Slider value. - - - - - Event emitted when the slider value changes. - - - - - Event emitted when the sliding is finished. - - - - - Event emitted when the slider handle reaches a mark. - - - - - Get Slider from the pointer. - - The pointer of Slider - Object of Slider type - - - - Creates the Slider control. - - - - - - Lower bound property - - - - - Upper bound property - - - - - Value property - - - - - Track visual property - - - - - Handle visual property - - - - - Progress visual property - - - - - Popup visual property - - - - - Popup arrow visual property - - - - - Disable color property - - - - - Value presicion property - - - - - Show popup property - - - - - Show value property - - - - - Marks property - - - - - Snap to marks property - - - - - Mark tolerance property - - - - @brief Event arguments that passed via SnapStarted signal - - - - @brief SnapEvent - is the SnapEvent information like snap or flick (it tells the target position, scale, rotation for the snap or flick). - - - - - - A two dimensional vector. - - - - - Addition operator. - - First value - Second value - A vector containing the result of the addition - - - - Subtraction operator. - - First value - Second value - A vector containing the result of the subtraction - - - - Unary negation operator. - - Target Value - A vector containg the negation - - - - Multiplication operator. - - First Value - Second Value - A vector containing the result of the multiplication - - - - Multiplication operator. - - First Value - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - First Value - Second Value - A vector containing the result of the division - - - - Division operator. - - First Value - The float value to scale the vector by - A vector containing the result of the scaling - - - - Array subscript operator overload. - - Subscript index - The float at the given index - - - - Default constructor, initializes the vector to 0. - - - - - Constructor. - - x or width component - y or height component - - - - Conversion constructor from an array of two floats. - - Array of xy - - - - Constructor. - - Vector3 to create this vector from - - - - Constructor. - - Vector4 to create this vector from - - - - (1.0f,1.0f) - - - - - Vector representing the X axis - - - - - Vector representing the Y axis - - - - - Vector representing the negative X axis - - - - - Vector representing the negative Y axis - - - - - (0.0f, 0.0f) - - - - - Returns the length of the vector. - - The length of the vector - - - - - Sets the vector to be unit length, whilst maintaining its direction. - - - - - Clamps the vector between minimum and maximum vectors. - - The minimum vector - The maximum vector - - - - x component - - - - - width - - - - - y component - - - - - height - - - - - A three dimensional vector. - - - - - Addition operator. - - First Value - Second Value - A vector containing the result of the addition - - - - Subtraction operator. - - First Value - Second Value - A vector containing the result of the subtraction - - - - Unary negation operator. - - Target Value - A vector containg the negation - - - - Multiplication operator. - - First Value - Second Value - A vector containing the result of the multiplication - - - - Multiplication operator. - - First Value - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - First Value - Second Value - A vector containing the result of the division - - - - Division operator. - - First Value - The float value to scale the vector by - A vector containing the result of the scaling - - - - Array subscript operator overload. - - Subscript index - The float at the given index - - - - Constructor. - - - - - Default constructor, initializes the vector to 0. - - x (or width) component - y (or height) component - z (or depth) component - - - - Conversion constructor from an array of three floats. - - Array of xyz - - - - Constructor. - - Vector2 to create this vector from - - - - Constructor - - Vector4 to create this vector from - - - - (1.0f,1.0f,1.0f) - - - - - Vector representing the X axis - - - - - Vector representing the Y axis - - - - - Vector representing the Z axis - - - - - Vector representing the negative X axis - - - - - Vector representing the negative Y axis - - - - - Vector representing the negative Z axis - - - - - (0.0f, 0.0f, 0.0f) - - - - - Returns the length of the vector. - - The length of the vector - - - - - Sets the vector to be unit length, whilst maintaining its direction. - - - - - Clamps the vector between minimum and maximum vectors. - - The minimum vector - The maximum vector - - - - - - x component - - - - - width component - - - - - red component - - - - - y component - - - - - height component - - - - - green component - - - - - z component - - - - - depth component - - - - - blue component - - - - - A four dimensional vector. - - - - - Addition operator. - - First value - Second value - A vector containing the result of the addition - - - - Subtraction operator. - - First value - Second value - A vector containing the result of the subtraction - - - - Unary negation operator. - - Target Value - A vector containg the negation - - - - Multiplication operator. - - First Value - Second Value - A vector containing the result of the multiplication - - - - Multiplication operator. - - First Value - The float value to scale the vector - A vector containing the result of the scaling - - - - Division operator. - - First Value - Second Value - A vector containing the result of the division - - - - Division operator. - - First Value - The float value to scale the vector by - A vector containing the result of the scaling - - - - Array subscript operator overload. - - Subscript index - The float at the given index - - - - Default constructor, initializes the vector to 0. - - - - - Conversion constructor from four floats. - - x (or r/s) component - y (or g/t) component - z (or b/p) component - w (or a/q) component - - - - Conversion constructor from an array of four floats. - - array Array of either xyzw/rgba/stpq - - - - Conversion constructor from Vector2. - - Vector2 to copy from, z and w are initialized to 0 - - - - Conversion constructor from Vector3. - - Vector3 to copy from, w is initialized to 0 - - - - (1.0f,1.0f,1.0f,1.0f) - - - - - (1.0f,0.0f,0.0f,0.0f) - - - - - (0.0f,1.0f,0.0f,0.0f) - - - - - (0.0f,0.0f,1.0f,0.0f) - - - - - (0.0f, 0.0f, 0.0f, 0.0f) - - - - - Returns the length of the vector. - - The length - - - - - - Clamps the vector between minimum and maximum vectors. - - The minimum vector - The maximum vector - - - - x component - - - - - red component - - - - - s component - - - - - y component - - - - - green component - - - - - t component - - - - - z component - - - - - blue component - - - - - p component - - - - - w component - - - - - alpha component - - - - - q component - - - - - - Create an empty Visual Handle - - - - - name of the visual - - - - - Sets the transform and the control size - - A property map describing the transform - The size of the parent control for visuals that need to scale internally. - - - - Returns the height for a given width. - - Width to use. - The height based on the width. - - - - Returns the width for a given height. - - Height to use. - The width based on the height. - - - - - the depth index of this visual. - - - - - Create the property map representing this visual. - - - - - VisualFactory is a singleton object that provides and shares visuals between views - - - - - Request the visual - - The map contains the properties required by the visual. The content of the map determines the type of visual that will be returned. - The handle to the created visual - - - - retrieve VisualFactory singleton. - - - - - A class encapsulating the transform map of visual. - - - - - - - - - - - - - - - - - - Get the transform map used by the visual. - - - - - Get the property map to create the visual. - - - - - The shader to use in the visual. - - - - - - Mix color is a blend color for any visual. - - - - - Opacity is the alpha component of the mixColor, above. - - - - - A class encapsulating the property map of a image visual. - - - - - - - - - - - - - - - - A class encapsulating the property map of a text visual. - - - - - - - - - - - - - - A class encapsulating the property map of a border visual. - - - - - - - - A class encapsulating the property map of a color visual. - - - - - - A class encapsulating the property map of a gradient visual. - - - - - - - - - - - - - A class encapsulating the property map of a mesh visual. - - - - - - - - - - - - A class encapsulating the property map of a primetive visual. - - - - - - - - - - - - - - - - - A class encapsulating the property map of a n-patch image visual. - - - - - - - - A class encapsulating the property map of a SVG visual. - - - - - A class encapsulating the property map of a Animated Image(AGIF) visual. - - - - - - The type of the wheel event - - - - - he direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel) - - - - - Modifier keys pressed during the event (such as shift, alt and control) - - - - - The co-ordinates of the cursor relative to the top-left of the screen - - - - - The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise) - - - - - The time the wheel is being rolled - - - - - Default constructor. - - - - - Constructor. - - The type of the wheel event - The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel) - Modifier keys pressed during the event (such as shift, alt and control) - The co-ordinates of the cursor relative to the top-left of the screen - The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise) - The time the wheel is being rolled - - - - Checks to see if Shift key modifier has been supplied. - - True if shift modifier - - - - Checks to see if Ctrl (control) key modifier has been supplied. - - True if ctrl modifier - - - - Checks to see if Alt key modifier has been supplied. - - True if alt modifier - - - - The type of the wheel event - - - - - - To make Button instance be disposed. - - - - - Create a new WidgetView. - - - - - Event arguments of widget view. - - - - - The widet view. - - - - - - - - - - - Pauses a given widget. - - true on success, false otherwise. - - - - Resume a given widget. - - true on success, false otherwise. - - - - Cancels touch event procedure. - If you call this function after feed the touch down event, the widget will get ON_HOLD events. - If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event. - - true on success, false otherwise. - - - - Activate a widget in faulted state. - A widget in faulted state MUST be activated before adding the widget. - - - - - Gets the id of widget. - - - - - Gets the id of instance. - - - - - Gets the content info. - - - - - Gets the title. - - - - - Gets the update peroid. - - - - - Gets/sets the preview. - - - - - Gets/sets the loading text. - - - - - Gets/sets whether the widget state is faulted or not. - - - - - Gets/sets whether the widget is permanent delete or not. - - - - - WidgetViewManager manages addition of WidgetView controls. - This class provides the functionality of adding the widget views and controlling the widgets. - - - - - To make WidgetViewManager instance be disposed. - - - - - Creates a new widget view object. - - The widget id. - Contents that will be given to the widget instance. - The widget width. - The widget height. - The period of updating contents of the widget. - A handle to WidgetView. - - - - - To make Window instance be disposed. - - - - - Sets whether window accepts focus or not. - - If focus is accepted or not. Default is true. - - - - Returns whether window accepts focus or not. - - True if the window accept focus, false otherwise - - - - Shows the window if it is hidden. - - - - - Hides the window if it is showing. - - - - - Retrieves whether the window is visible or not. - - true, if the windoe is visible - - - - Gets the count of supported auxiliary hints of the window. - - The number of supported auxiliary hints. - - - - Gets the supported auxiliary hint string of the window. - - The index of the supported auxiliary hint lists. - The auxiliary hint string of the index. - - - - Creates an auxiliary hint of the window. - - The auxiliary hint string. - The value string. - The ID of created auxiliary hint, or 0 on failure. - - - - Removes an auxiliary hint of the window. - - The ID of the auxiliary hint. - True if no error occurred, false otherwise. - - - - Changes a value of the auxiliary hint. - - The auxiliary hint ID. - The value string to be set. - True if no error occurred, false otherwise. - - - - Gets a value of the auxiliary hint. - - The auxiliary hint ID. - The string value of the auxiliary hint ID, or an empty string if none exists. - - - - Gets an ID of the auxiliary hint string. - - The auxiliary hint string. - The ID of auxiliary hint string, or 0 on failure. - - - - Sets a region to accept input events. - - The region to accept input events. - - - - Gets/Sets a window type. - - - - - Sets a priority level for the specified notification window. - - The notification window level. - True if no error occurred, false otherwise. - - - - Gets a priority level for the specified notification window. - - The notification window level. - - - - Sets a transparent window's visual state to opaque. - - Whether the window's visual state is opaque. - - - - Returns whether a transparent window's visual state is opaque or not. - - True if the window's visual state is opaque, false otherwise. - - - - Sets a window's screen mode. - - The screen mode. - True if no error occurred, false otherwise. - - - - Gets a screen mode of the window. - - The screen mode. - - - - Sets preferred brightness of the window. - - The preferred brightness (0 to 100). - True if no error occurred, false otherwise. - - - - Gets preffered brightness of the window. - - The preffered brightness. - - - - Raises window to the top of Window stack. - - - - - Lowers window to the bottom of Window stack. - - - - - Activates window to the top of Window stack even it is iconified. - - - - - Get default ( root ) layer. - - The root layer - - - - Queries the number of on-window layers. - - The number of layers. - Note that a default layer is always provided (count >= 1). - - - - Keep rendering for at least the given amount of time. - - Time to keep rendering, 0 means render at least one more frame - - - - - - - - - Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing. - - - - - Enumeration for key grab mode for platform-level APIs. - - - - - Grab a key only when on the top of the grabbing-window stack mode. - - - - - Grab a key together with the other client window(s) mode. - - - - - Grab a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode. - - - - - Grab a key exclusively regardless of the grabbing-window's position on the window stack mode. - - - - - Enumeration for opacity of the indicator. - - - - - Enumeration for visible mode of the indicator. - - - - - Touch event argument. - - - - - Touch. - - - - - - Wheel event arguments. - - - - - Wheel. - - - - - Event emitted when wheel event is received. - - - - - Key event arguments. - - - - - Key - - - - - Event emitted when key event is received. - - - - - Window size property (read-only). - - - - - Background color property. - - - - - - - Add layer to the Stage. - - Layer to add - - - - Remove layer from the Stage. - - Layer to remove - - - - Gets/Sets a size of the window. - - - - - Gets/Sets a position of the window. - - - - + + + + Tizen.NUI + + + + @brief Event arguments that passed via StatusChanged signal + + + + @brief Event arguments that passed via ActionNext signal + + + + @brief Event arguments that passed via ActionPrevious signal + + + + @brief Event arguments that passed via ActionActivate signal + + + + @brief Event arguments that passed via ActionRead signal + + + + @brief Event arguments that passed via ActionOver signal + + + + @brief Event arguments that passed via ActionReadNext signal + + + + @brief Event arguments that passed via ActionReadPrevious signal + + + + @brief Event arguments that passed via ActionUp signal + + + + @brief Event arguments that passed via ActionDown signal + + + + @brief Event arguments that passed via ActionClearFocus signal + + + + @brief Event arguments that passed via ActionBack signal + + + + @brief Event arguments that passed via ActionScrollUp signal + + + + @brief Event arguments that passed via ActionScrollDown signal + + + + @brief Event arguments that passed via ActionPageLeft signal + + + + @brief Event arguments that passed via ActionPageRight signal + + + + @brief Event arguments that passed via ActionPageUp signal + + + + @brief Event arguments that passed via ActionPageDown signal + + + + @brief Event arguments that passed via ActionMoveToFirst signal + + + + @brief Event arguments that passed via ActionMoveToLast signal + + + + @brief Event arguments that passed via ActionReadFromTop signal + + + + @brief Event arguments that passed via ActionReadFromNext signal + + + + @brief Event arguments that passed via ActionZoom signal + + + + @brief Event arguments that passed via ActionReadIndicatorInformation signal + + + + @brief Event arguments that passed via ActionReadPauseResume signal + + + + @brief Event arguments that passed via ActionStartStop signal + + + + @brief Event arguments that passed via ActionPageUp signal + + + + @brief Event arguments that passed via FocusedViewActivated signal + + + + @brief Event arguments that passed via FocusOvershot signal + + + + @brief Event arguments that passed via NUIApplicationInit signal + + + + @brief Application - is the application that is being initialized + + + + @brief Event arguments that passed via NUIApplicationTerminate signal + + + + @brief Application - is the application that is being Terminated + + + + @brief Event arguments that passed via NUIApplicationPause signal + + + + @brief Application - is the application that is being Paused + + + + @brief Event arguments that passed via NUIApplicationResume signal + + + + @brief Application - is the application that is being Resumed + + + + @brief Event arguments that passed via NUIApplicationReset signal + + + + @brief Application - is the application that is being Reset + + + + @brief Event arguments that passed via NUIApplicationResize signal + + + + @brief Application - is the application that is being Resized + + + + @brief Event arguments that passed via NUIApplicationLanguageChanged signal + + + + @brief Application - is the application that is being affected with Device's language change + + + + @brief Event arguments that passed via NUIApplicationRegionChanged signal + + + + @brief Application - is the application that is being affected with Device's region change + + + + @brief Event arguments that passed via NUIApplicationBatteryLow signal + + + + @brief Application - is the application that is being affected when the battery level of the device is low + + + + @brief Event arguments that passed via NUIApplicationMemoryLow signal + + + + @brief Application - is the application that is being affected when the memory level of the device is low + + + + @brief Event arguments that passed via NUIApplicationAppControl signal + + + + @brief Application - is the application that is receiving the launch request from another application + + + + @brief VoidP - contains the information about why the application is launched + + + + + + + + + + + + + + + Outer::outer_method(int) + + + + + + + Enumeration for texture types. + + + + + + Enumeration for stereoscopic view modes. + + + + + + + @brief Event arguments that passed via Uploaded signal + + + + @brief Image - is the image data that gets uploaded to GL. + + + + + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + + + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + + + + Application instance to connect event. + + + + + Dictionary to contain each type of event callback. + + + + + The default Constructor. + + + + + The constructor with stylesheet. + + + + + The constructor with stylesheet and window mode. + + + + + Add NUIApplication event to Application. + Put each type of event callback in Dictionary. + + Type of event + Event callback + + + + Add NUIApplication event to Application. + Put each type of event callback in Dictionary. + + Argument type for the event + Type of event + Event callback + + + + Dispose function. + + + + + Exit Application. + + + + + Run Application. + + Arguments from commandline. + + + + Region changed event callback function. + + Application instance + Event argument for RegionChanged + + + + Memory Low event callback function. + + Application instance + Event argument for MemoryLow + + + + Language changed event callback function. + + Application instance + Event argument for LanguageChanged + + + + Battery low event callback function. + + Application instance + Event argument for BatteryLow + + + + Initialized event callback function. + + Application instance + Event argument for Initialized + + + + Terminated event callback function. + + Application instance + Event argument for Terminated + + + + Resumed event callback function. + + Application instance + Event argument for Resumed + + + + App control event callback function. + + Application instance + Event argument for AppControl + + + + Paused event callback function. + + Application instance + Event argument for Paused + + + + Class that represents the type of NUI event for backends. This class can be converted from string type. + + + + + Initializes the EventType class. + + The name of event type. + + + + Pre-defined event type. "Reset" + + + + + Converts a string to NUIEventType instance. + + + + @brief Event arguments that passed via Notify signal + + + + @brief PropertyNotification - is the PropertyNotification handle that has the notification properties. + + + + + + Helper class for calculating what property indexes should be assigned to C# View (view) classes. + + + + + Initializes a new instance of the class. + + + + + Only called if a View has scriptable properties + + + + + Gets the index of the property. + Each property has to have unique index for this view type + + The property index. + View name + View type + Type. + + + + We calculate the start property indices, based on the type and it's class heirachy, e.g. DateView (70,000)- > Spin (60,000) -> View (50,000) + + + + start of the property range + + + last used of the property index + + + start of the property range + + + + This is used to store a mapping between C++ base handle objects and it's C# instances. + + + + + + Registry is a singleton + + + + + Given a C++ object the dictionary allows us to find which C# object it belongs to. + By keeping the weak reference only, it will allow the object to be garbage collected. + + + + + Store the mapping between this instance of BaseHandle (C# base class) and native part. + + The instance of BaseHandle (C# base class) + + + + Remove the this instance of BaseHandle (C# base class) and native part from the mapping table. + + The instance of BaseHandle (C# base class) + + + + Dispose + + + + + Addition operator for A+B + + Size, A + Size to assign, B + A Size containing the result of the addition + + + + Subtraction operator for A-B + + Size, A + Size to subtract, B + A Size containing the result of the subtraction + + + + Unary negation operator. + + Size for unary negation + A Size containg the negation + + + + Multiplication operator. + + Size for multiplication + The Size to multipl + A Size containing the result of the multiplication + + + + Multiplication operator. + + Size for multiplication + The float value to scale the Size + A Size containing the result of the scaling + + + + Division operator. + + Size for division + The Size to divide + A Size containing the result of the division> + + + + Division operator. + + Size for division + The float value to scale the Size by + A Size containing the result of the scaling + + + + Array subscript operator. + + Subscript index + The float at the given index + + + + Constructor. + + + + + Constructor. + + x (or width) component + y (or height) component + z (or depth) component + + + + Constructor. + + Size2D with x (width) and y (height) + + + + Zero constant, (0.0f, 0.0f, 0.0f). + + + + + + + Width property for width component of Siz + + + + + Height property for height component of Size + + + + + Depth property for depth component of Size + + + + + Type cast operator, Size to Vector3. + + Object of Size type + + + + Type cast operator, Vector3 to Size type. + + Object of Vector3 type + + + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + + + + An Adaptor object is used to initialize and control how Dali runs. + + It provides a lifecycle interface that allows the application + writer to provide their own main loop and other platform related + features. + + The Adaptor class provides a means for initialising the resources required by the Dali::Core. + + When dealing with platform events, the application writer MUST ensure that Dali is called in a + thread-safe manner. + + As soon as the Adaptor class is created and started, the application writer can initialise their + View objects straight away or as required by the main loop they intend to use (there is no + need to wait for an initialise signal as per the Tizen.NUI.Application class). + + + + + + Starts the Adaptor. + + + + + Pauses the Adaptor. + + + + + Resumes the Adaptor, if previously paused. + + If the adaptor is not paused, this does not do anything. + + + + Stops the Adaptor. + + + + + Release any locks the surface may hold. + + + For example, after compositing an offscreen surface, use this method to allow rendering to continue. + + + + + Set the number of frames per render. + + The number of vsyncs between successive renders.. + + Suggest this is a power of two: + 1 - render each vsync frame + 2 - render every other vsync frame + 4 - render every fourth vsync frame + 8 - render every eighth vsync frame + + + + + Set whether the frame count per render is managed using the hardware VSync or manually timed. + + True if the hardware VSync should be used. + + + + Returns a reference to the instance of the adaptor used by the current thread. + + The adaptor has been initialised.This is only valid in the main thread. + + + + Checks whether the adaptor is available. + + true, if it is available, false otherwise. + + + + Call this method to notify Dali when scene is created and initialized. + Notify Adaptor that the scene has been created. + + + + + Call this method to notify Dali when the system language changes. + + Use this only when NOT using Dali::Application, As Application created using + Application will automatically receive notification of language change. + When Dali::Application is not used, the application developer should + use app-core to receive language change notifications and should update Dali + by calling this method. + + + + + Sets minimum distance in pixels that the fingers must move towards/away from each other in order to trigger a pinch gesture. + + The minimum pinch distance in pixels. + + + + Feed a wheel event to the adaptor. + + wheel event. + + + + Feed a key event to the adaptor. + + The key event holding the key information. + + + + Notify Core that the scene has been created. + + + + + Sets the stereo base (eye separation) for Stereoscopic 3D. + The stereo base is the distance in millimetres between the eyes. Typical values are + between 50mm and 70mm. The default value is 65mm. + + The stereo base (eye separation) for Stereoscopic 3D. + + + + Event arguments that passed via Resized signal. + + + + + Adaptor - is the adaptor which has size changed. + + + + + + Event arguments that passed via LanguageChanged signal. + + + + + Adaptor - is the adaptor which has language changed. + + + + + + + To make AlphaFunction instance be disposed. + + + + + + + + + + + Returns the functioning mode of the alpha function + + The functioning mode of the alpha function + + + + This specifies the various types of BuiltinFunctions + + + + + Linear + + + + + No transformation + + + + + Reverse linear + + + + + Speeds up and comes to a sudden stop (Square) + + + + + Sudden start and slows to a gradual stop (Square) + + + + + Speeds up and comes to a sudden stop (Cubic) + + + + + Sudden start and slows to a gradual stop (Cubic) + + + + + Speeds up and slows to a gradual stop (Cubic) + + + + + Speeds up and comes to a sudden stop (sinusoidal) + + + + + Sudden start and slows to a gradual stop (sinusoidal) + + + + + Speeds up and slows to a gradual stop (sinusoidal) + + + + + Sudden start, loses momentum and returns to start position + + + + + Single revolution + + + + + Sudden start, exceed end position and return to a gradual stop + + + + + This specifies which mode is set for AlphaFuction + + + + + The user has used a built-in function. + + + + + The user has provided a custom function + + + + + The user has provided the control points of a bezier curve + + + + + + To make Animation instance be disposed. + + + + + @brief Event for Finished signal which can be used to subscribe/unsubscribe the event handler. + Finished signal is emitted when an Animation's animations have finished. + + + @brief Event for ProgressReached signal which can be used to subscribe/unsubscribe the event handler. + ProgressReached signal is emitted when the Animation has reached a given progress percentage, this is set in the api SetProgressNotification. + + + + Gets/Sets the duration in milli seconds of the animation. + + + + + Gets/Sets the default alpha function for the animation. + + + + + Queries the state of the animation. + + + + + + + + Stops the animation. + + end action can be set + + + + + + + + + + + + + + Animates a property between keyframes. + + The target object to animate + The target property to animate + The set of time/value pairs between which to animate + The method used to interpolate between values + The alpha function to apply + + + + Animates a property between keyframes. + + The target object to animate + The target property to animate + The set of time/value pairs between which to animate + Start time of animation in milli seconds + End time of animation in milli seconds + The method used to interpolate between values + The alpha function to apply + + + + + + + + Plays the animation. + + + + + + Play the animation after a given delay time.
+ The delay time is not included in the looping time.
+ When the delay time is negative value, it would treat as play immediately.
+ + The delay time + + + + Pauses the animation. + + + + + Stops the animation. + + + + + + Enumeration for what to do when the animation ends, is stopped, or is destroyed. + + + + + When the animation ends, the animated property values are saved. + + + + + When the animation ends, the animated property values are forgotten. + + + + + If the animation is stopped, the animated property values are saved as if the animation had run to completion, otherwise behaves like Cancel. + + + + + Enumeration for what interpolation method to use on key-frame animations. + + + + + Values in between key frames are interpolated using a linear polynomial. (Default) + + + + + Values in between key frames are interpolated using a cubic polynomial. + + + + + Enumeration for what state the animation is in. + + Calling Reset() on this class will NOT reset the animation. It will call BaseHandle.Reset() which drops the object handle. + + + + Animation has stopped + + + + + The animation is playing + + + + + The animation is paused + + + + + CustomView provides some common functionality required by all views. + + + + + Set the background with a property map. + + The background property map + + + + + + + Gets whether this control supports two dimensional keyboard navigation. + + true if this control supports two dimensional keyboard navigation + + + + Sets or Gets whether this control is a focus group for keyboard navigation. + + true if this control is set as a focus group for keyboard navigation + + + + Sets whether this control is a focus group for keyboard navigation. + (i.e. the scope of keyboard focus movement can be limitied to its child views). The control is not a focus group by default. + + Whether this control is set as a focus group for keyboard navigation + + + + Gets whether this control is a focus group for keyboard navigation. + + + + + Called by the AccessibilityManager to activate the Control. + + + + + Called by the KeyboardFocusManager. + + + + + Called by the KeyInputFocusManager to emit key event signals. + + The key event + True if the event was consumed + + + + + + Provides the View implementation of GetWidthForHeight. + + Height to use + The width based on the height + + + + Calculate the size for a child using the base view object. + + The child view to calculate the size for + The dimension to calculate the size for. E.g. width or height + Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found + + + + Determine if this view is dependent on it's children for relayout from the base class. + + The dimension(s) to check for + Return if the view is dependent on it's children + + + + Determine if this view is dependent on it's children for relayout from the base class. + + Return if the view is dependent on it's children + + + + + + Erase the entry matching the given index from the list of registered visuals. + + The Property index of the visual, used to reference visual + + + + + + + Create a transition effect on the control. + + transitionData The transition data describing the effect to create + A handle to an animation defined with the given effect, or an empty handle if no properties match + + + + + + + + Called after a child has been added to the owning view. + + The child which has been added + + + + Called after the owning view has attempted to remove a child( regardless of whether it succeeded or not ). + + The child being removed + + + + Called when the owning view property is set. + + The Property index that was set + The value to set + + + + Called when the owning view's size is set e.g. using View.SetSize(). + + The target size + + + + Called when the owning view's size is animated e.g. using Animation::AnimateTo( Property( view, View::Property::SIZE ), ... ). + + The object which is animating the owning view + The target size + + + + + + Called after a key-event is received by the view that has had its focus set. + + The key event + True if the key event should be consumed + + + + + + Notification for deriving classes. + + policy The policy being set + dimension The dimension the policy is being set for + + + + Return the natural size of the view. + + The view's natural size + + + + Calculate the size for a child. + + The child view to calculate the size for + The dimension to calculate the size for. E.g. width or height + Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found. + + + + + + Determine if this view is dependent on it's children for relayout. + + The dimension(s) to check for + Return if the view is dependent on it's children + + + + Determine if this view is dependent on it's children for relayout from the base class. + + Return true if the view is dependent on it's children + + + + Virtual method to notify deriving classes that relayout dependencies have been + met and the size for this object is about to be calculated for the given dimension. + + The dimension that is about to be calculated + + + + Virtual method to notify deriving classes that the size for a dimension has just been negotiated. + + The new size for the given dimension + The dimension that was just negotiated + + + + This method should be overridden by deriving classes requiring notifications when the style changes. + + The StyleManager object + Information denoting what has changed + + + + + This method should be overridden by deriving classes when they wish to respond the accessibility. + + The pan gesture + true if the pan gesture has been consumed by this control + + + + This method should be overridden by deriving classes when they wish to respond the accessibility + + The touch gesture + true if the touch event has been consumed by this control + + + + This method should be overridden by deriving classes when they wish to respond the accessibility up and down action (i.e. value change of slider control). + + isIncrease Whether the value should be increased or decreased + true if the value changed action has been consumed by this control + + + + This method should be overridden by deriving classes when they wish to respond the accessibility zoom action. + + true if the zoom action has been consumed by this control + + + + Called when the control gain key input focus. Should be overridden by derived classes if they need to customize what happens when focus is gained. + + + + + Called when the control loses key input focus. Should be overridden by derived classes if they need to customize what happens when focus is lost. + + + + + + + + + + + + + Enumeration for the instance of child properties belonging to the FlexContainer class. + + + + + Creates a FlexContainer handle. + Calling member functions with an uninitialized handle is not allowed. + + + + + Enumeration for the direction of the main axis in the flex container. This determines + the direction that flex items are laid out in the flex container. + + + + + Enumeration for the primary direction in which content is ordered in the flex container + and on which sides the ?�start??and ?�end??are. + + + + + Enumeration for the alignment of the flex items when the items do not use all available + space on the main-axis. + + + + + Enumeration for the alignment of the flex items or lines when the items or lines do not + use all the available space on the cross-axis. + + + + + Enumeration for the wrap type of the flex container when there is no enough room for + all the items on one flex line. + + + + + The primary direction in which content is ordered + + + + + The direction of the main-axis which determines the direction that flex items are laid out + + + + + Whether the flex items should wrap or not if there is no enough room for them on one flex line + + + + + The alignment of flex items when the items do not use all available space on the main-axis + + + + + The alignment of flex items when the items do not use all available space on the cross-axis + + + + + Similar to "alignItems", but it aligns flex lines, so only works when there are multiple lines + + + + + + Event arguments of resource ready. + + + + + The view whose resource is ready. + + + + + + Creates an initialized ImageView. + + + + + + + + ImageView ResourceUrl, type string + + + + + ImageView ImageMap, type PropertyMap : string if it is a url, map otherwise + + + + + + + + + + Class to specify layout position for child view. + + + + + Constructor. + + The row index initialized + The column index initialized + The row span initialized + The column span initialized + + + + Constructor to initialise values to defaults for convenience. + + The row index initialized + The column index initialized + The row span initialized + + + + Constructor to initialise values to defaults for convenience. + + The row index initialized + The column index initialized + + + + Constructor to initialise values to defaults for convenience. + + The row index initialized + + + + Default constructor + + + + + Index of row + + + + + Index of column + + + + + Span of row + + + + + Span of column + + + + + Creates the TableView view. + + initialRows for the table + initialColumns for the table + + + + Copy constructor. Creates another handle that points to the same real object. + + Handle to copy from + + + + + Returns a child from the given layout position. + + The position in the table + Child that was in the cell or an uninitialized handle + + + + Removes a child from the given layout position. + + The position for the child to remove + Child that was removed or an uninitialized handle + + + + Finds the child's layout position. + + The child to search for + The position for the child + true if the child was included in this TableView + + + + Inserts a new row to given index. + + The rowIndex of the new row + + + + + Inserts a new column to the given index. + + The columnIndex of the new column + + + + + Resizes the TableView. + + The rows for the table + The columns for the table + + + + Sets horizontal and vertical padding between cells. + + Width and height + + + + Gets the current padding as width and height. + + The current padding as width and height + + + + Specifies this row as fitting its height to its children. + + The row to set + + + + Checks if the row is a fit row. + + The row to check + true if the row is fit + + + + Specifies this column as fitting its width to its children. + + The column to set + + + + Checks if the column is a fit column. + + The column to check + true if the column is fit + + + + + Gets a row's fixed height. + + The row index with fixed height + height The height in world coordinate units + + + + + Gets a row's relative height. + + The row index with relative height + Height in percentage units, between 0.0f and 1.0f + + + + + Gets a column's fixed width. + + The column index with fixed width + Width in world coordinate units + + + + + Gets a column's relative width. + + The column index with relative width + Width in percentage units, between 0.0f and 1.0f + + + + + Enumeration for describing how the size of a row / column has been set. + + + + + the amount of rows in the table. + + + + + the amount of columns in the table. + + + + + padding between cells. + + + + + The number of layout rows + + + + + The number of layout columns + + + + + A control which provides a multi-line editable text editor. + + + + + Dispose. + + + + + Event arguments that passed via TextChanged signal. + + + + + TextEditor - is the texteditor control which has the text contents changed. + + + + + + Event arguments that passed via ScrollStateChanged signal. + + + + + TextEditor - is the texteditor control which has the scroll state changed. + + + + + ScrollState - is the texteditor control scroll state. + + + + + + Creates the TextEditor control. + + + + + + + + Text color property. + + + + + Font family property. + + + + + Font style property. + + + + + Point size property. + + + + + Horizontal alignment property. + + + + + Scroll threshold property. + + + + + Scroll speed property. + + + + + Primary cursor color property. + + + + + SecondaryCursorColor property. + + + + + EnableCursorBlink property. + + + + + CursorBlinkInterval property. + + + + + CursorBlinkDuration property. + + + + + CursorWidth property. + + + + + GrabHandleImage property. + + + + + GrabHandlePressedImage property. + + + + + SelectionHandleImageLeft property. + + + + + SelectionHandleImageRight property. + + + + + SelectionHandlePressedImageLeft property. + + + + + SelectionHandlePressedImageRight property. + + + + + SelectionHandleMarkerImageLeft property. + + + + + SelectionHandleMarkerImageRight property. + + + + + SelectionHighlightColor property. + + + + + DecorationBoundingBox property. + + + + + EnableMarkup property. + + + + + InputColor property. + + + + + InputFontFamily property. + + + + + InputFontStyle property. + + + + + InputPointSize property. + + + + + LineSpacing property. + + + + + InputLineSpacing property. + + + + + Underline property. + + + + + InputUnderline property. + + + + + Shadow property. + + + + + InputShadow property. + + + + + Emboss property. + + + + + InputEmboss property. + + + + + Outline property. + + + + + InputOutline property. + + + + + SmoothScroll property. + + + + + SmoothScrollDuration property. + + + + + EnableScrollBar property. + + + + + ScrollBarShowDuration property. + + + + + ScrollBarFadeDuration property. + + + + + PixelSize property. + + + + + The line count of text. + + + + + The text to display when the TextEditor is empty and inactive. + + + + + The placeholder-text color. + + + + + Enable selection property. + + + + + Placeholder property. + Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size. + + + The following example demonstrates how to set the placeholder property. + + PropertyMap propertyMap = new PropertyMap(); + propertyMap.Add("placeholderText", new PropertyValue("Setting Placeholder Text")); + propertyMap.Add("placeholderTextFocused", new PropertyValue("Setting Placeholder Text Focused")); + propertyMap.Add("placeholderColor", new PropertyValue(Color.Red)); + propertyMap.Add("placeholderFontFamily", new PropertyValue("Arial")); + propertyMap.Add("placeholderPointSize", new PropertyValue(12.0f)); + + PropertyMap fontStyleMap = new PropertyMap(); + fontStyleMap.Add("weight", new PropertyValue("bold")); + fontStyleMap.Add("width", new PropertyValue("condensed")); + fontStyleMap.Add("slant", new PropertyValue("italic")); + propertyMap.Add("placeholderFontStyle", new PropertyValue(fontStyleMap)); + + TextEditor editor = new TextEditor(); + editor.Placeholder = propertyMap; + + + + + + + A control which provides a single-line editable text field. + + + + + Dispose + + + + + Text changed event arguments. + + + + + TextField. + + + + + MaxLengthReached event arguments. + + + + + TextField. + + + + + TextChanged event. + + + + + MaxLengthReached event. + + + + + Creates the TextField control. + + + + + + + + PlaceholderText property. + + + + + PlaceholderTextFocused property. + + + + + FontFamily property. + + + + + FontStyle property. + + + + + PointSize property. + + + + + MaxLength property. + + + + + ExceedPolicy property. + + + + + HorizontalAlignment property. + + + + + VerticalAlignment property. + + + + + TextColor property. + + + + + PlaceholderTextColor property. + + + + + ShadowOffset property. + + + + + ShadowColor property. + + + + + PrimaryCursorColor property. + + + + + SecondaryCursorColor property. + + + + + EnableCursorBlink property. + + + + + CursorBlinkInterval property. + + + + + CursorBlinkDuration property. + + + + + CursorWidth property. + + + + + GrabHandleImage property. + + + + + GrabHandlePressedImage property. + + + + + ScrollThreshold property. + + + + + ScrollSpeed property. + + + + + SelectionHandleImageLeft property. + + + + + SelectionHandleImageRight property. + + + + + SelectionHandlePressedImageLeft property. + + + + + SelectionHandlePressedImageRight property. + + + + + SelectionHandleMarkerImageLeft property. + + + + + SelectionHandleMarkerImageRight property. + + + + + SelectionHighlightColor property. + + + + + DecorationBoundingBox property. + + + + + InputMethodSettings property. + + + + + InputColor property. + + + + + EnableMarkup property. + + + + + InputFontFamily property. + + + + + InputFontStyle property. + + + + + InputPointSize property. + + + + + Underline property. + + + + + InputUnderline property. + + + + + Shadow property. + + + + + InputShadow property. + + + + + Emboss property. + + + + + InputEmboss property. + + + + + Outline property. + + + + + InputOutline property. + + + + + HiddenInputSettings property. + + + + + PixelSize property. + + + + + Enable selection property. + + + + + Placeholder property. + Gets/Sets the placeholder : text, color, font family, font style, point size, and pixel size. + + + The following example demonstrates how to set the placeholder property. + + PropertyMap propertyMap = new PropertyMap(); + propertyMap.Add("placeholderText", new PropertyValue("Setting Placeholder Text")); + propertyMap.Add("placeholderTextFocused", new PropertyValue("Setting Placeholder Text Focused")); + propertyMap.Add("placeholderColor", new PropertyValue(Color.Red)); + propertyMap.Add("placeholderFontFamily", new PropertyValue("Arial")); + propertyMap.Add("placeholderPointSize", new PropertyValue(12.0f)); + + PropertyMap fontStyleMap = new PropertyMap(); + fontStyleMap.Add("weight", new PropertyValue("bold")); + fontStyleMap.Add("width", new PropertyValue("condensed")); + fontStyleMap.Add("slant", new PropertyValue("italic")); + propertyMap.Add("placeholderFontStyle", new PropertyValue(fontStyleMap)); + + TextField field = new TextField(); + field.Placeholder = propertyMap; + + + + + + + Dispose + + + + + Creates the TextLabel control. + + + + + Creates the TextLabel control. + + The text to display + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The line count of text. + + + + + + + VideoView is a control for video playback and display. + + + + + Event arguments that passed via Finished signal + + + + + The view for video playback and display. + + + + + + Creates an initialized VideoView. + + + + + + Starts the video playback. + + + + + Pauses the video playback. + + + + + Stops the video playback. + + + + + Seeks forward by the specified number of milliseconds. + + The position for forward playback + + + + Seeks backward by the specified number of milliseconds. + + The position for backward playback + + + + video file url as string type or PropertyMap. + + + + + looping status, true or false. + + + + + mute status, true or false. + + + + + left and right volume scalar as float type, PropertyMap with two values ( "left" and "right" ). + + + + + View is the base class for all views. + + + + + + + Event arguments that passed via KeyEvent signal. + + + + + Key - is the key sent to the View. + + + + + + + Event arguments that passed via Touch signal. + + + + + Touch - contains the information of touch points + + + + + + Event arguments that passed via Hover signal. + + + + + Hover - contains touch points that represent the points that are currently being hovered or the points where a hover has stopped. + + + + + + Event arguments that passed via Wheel signal. + + + + + WheelEvent - store a wheel rolling type : MOUSE_WHEEL or CUSTOM_WHEEL + + + + + + + + Event arguments of visibility changed. + + + + + The view, or child of view, whose visibility has changed. + + + + + Whether the view is now visible or not. + + + + + Whether the view's visible property has changed or a parent's. + + + + + + + Describes the direction to move the focus towards. + + + + + Creates a new instance of a View. + + + + + + Quries whether the view has focus. + + true if this view has focus + + + + Sets the name of the style to be applied to the view. + + A string matching a style described in a stylesheet + + + + Retrieves the name of the style to be applied to the view (if any). + + A string matching a style, or an empty string + + + + Clears the background. + + + + + styleName, type string. + + + + + + Create an Animation to animate the background color visual. If there is no + background visual, creates one with transparent black as it's mixColor. + + + + + Create an Animation to animate the mixColor of the named visual. + + + + + + The current state of the view. + + + + + The current sub state of the view. + + + + + Displays a tooltip + + + + + Displays a tooltip as Text + + + + + + + + The top-left cell this child occupies, if not set, the first available cell is used + + + + + The number of rows this child occupies, if not set, default value is 1 + + + + + The number of columns this child occupies, if not set, default value is 1 + + + + + The horizontal alignment of this child inside the cells, if not set, default value is 'left' + + + + + The vertical alignment of this child inside the cells, if not set, default value is 'top' + + + + + + + + + whether the view should be focusable by keyboard navigation. + + + + + Enumeration for describing the states of view. + + + + + Normal state + + + + + Focused state + + + + + Disabled state + + + + + + + + + + + + Determines whether the pivot point should be used to determine the position of the view. + This is true by default. + + If false, then the top-left of the view is used for the position. + Setting this to false will allow scaling or rotation around the anchor-point without affecting the view's position. + + + + + + Gets depth in the hierarchy for the view. + + + + + Sets the sibling order of the view so depth position can be defined within the same parent. + + + Note The initial value is 0. + Raise, Lower, RaiseToTop, LowerToBottom, RaiseAbove and LowerBelow will override the sibling order. + The values set by this Property will likely change. + + + + + Returns the natural size of the view. + + + Deriving classes stipulate the natural size and by default a view has a ZERO natural size. + + + + + Returns the natural size (Size2D) of the view. + + + Deriving classes stipulate the natural size and by default a view has a ZERO natural size. + + + + + Shows the View. + + + This is an asynchronous method. + + + + + Hides the View. + + + This is an asynchronous method. + If an view is hidden, then the view and its children will not be rendered. + This is regardless of the individual visibility of the children i.e.an view will only be rendered if all of its parents are shown. + + + + + Raise view above all other views. + + + Sibling order of views within the parent will be updated automatically. + Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. + + + + + Lower view to the bottom of all views. + + + Sibling order of views within the parent will be updated automatically. + Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. + + + + + Query if all resources required by a View are loaded and ready. + + Most resources are only loaded when the control is placed on stage + + + + + Raise the view to above the target view. + + Sibling order of views within the parent will be updated automatically. + Views on the level above the target view will still be shown above this view. + Raising this view above views with the same sibling order as each other will raise this view above them. + Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. + + Will be raised above this view + + + + Lower the view to below the target view. + + Sibling order of views within the parent will be updated automatically. + Lowering this view below views with the same sibling order as each other will lower this view above them. + Once a raise or lower API is used that view will then have an exclusive sibling order independent of insertion. + + Will be lowered below this view + + + + Adds a child view to this View. + + 
This View(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent view.
+ The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. + If the child already has a parent, it will be removed from old parent and reparented to this view. This may change child's position, color, scale etc as it now inherits them from this view. + The child + + + + Removes a child View from this View. If the view was not a child of this view, this is a no-op. + + 
This View(the parent) has been initialized. The child view is not the same as the parent view.
+ The child + + + + Removes a View from its Parent View / Layer. If the View has no parent, this method does nothing. + + 
The (child) View has been initialized.
+ + + + Retrieves the number of children held by the view. + + 
The View has been initialized.
+ The number of children + + + + Retrieves child view by index. + + 
The View has been initialized.
+ The index of the child to retrieve + The view for the given index or empty handle if children not initialized + + + + Search through this view's hierarchy for an view with the given name. + The view itself is also considered in the search. + + 
The View has been initialized.
+ The name of the view to find + A handle to the view if found, or an empty handle if not + + + + Converts screen coordinates into the view's coordinate system using the default camera. + + 
The View has been initialized.
+ The view coordinates are relative to the top-left(0.0, 0.0, 0.5) + On return, the X-coordinate relative to the view + On return, the Y-coordinate relative to the view + The screen X-coordinate + The screen Y-coordinate + True if the conversion succeeded + + + + + + + + + Gets/Sets the size width of an view. + + + + + Gets/Sets the size height of an view. + + + + + + Gets/Sets the position x of the View. + + + + + Gets/Sets the position y of the View. + + + + + Gets/Sets the position z of the View. + + + + + Gets/Sets the world position of the View. + + + + + + + + Gets/Sets the scale x factor applied to an view. + + + + + Gets/Sets the scale y factor applied to an view. + + + + + Gets/Sets the scale z factor applied to an view. + + + + + Gets the world scale of View. + + + + + Retrieves the visibility flag of an view. + + + If an view is not visible, then the view and its children will not be rendered. + This is regardless of the individual visibility values of the children i.e.an view will only be rendered if all of its parents have visibility set to true. + + + + + Gets the view's world color. + + + + + Gets/Sets the View's name. + + + + + Get the number of children held by the view. + + + + + Gets the View's ID. + Readonly + + + + + Gets/Sets the status of whether an view should emit touch or hover signals. + + + + + Gets/Sets the status of whether the view should receive a notification when touch or hover motion events leave the boundary of the view. + + + + + Gets/Sets the status of whether a child view inherits it's parent's orientation. + + + + + Gets/Sets the status of whether a child view inherits it's parent's scale. + + + + + + + Gets/Sets the width resize policy to be used. + + + + + Gets/Sets the height resize policy to be used. + + + + + + Gets/Sets the status of whether the width size is dependent on height size. + + + + + Gets/Sets the status of whether the height size is dependent on width size. + + + + + Gets/Sets the padding for use in layout. + + + + + Gets/Sets the minimum size an view can be assigned in size negotiation. + + + + + Gets/Sets the maximum size an view can be assigned in size negotiation. + + + + + + Gets/Sets clipping behavior(mode) of it's children. + + + + + Get the number of renderers held by the view. + + + + + A visual view control for user add any visual to it. + + + Example: + + VisualView _visualView = new VisualView(); + ImageVisualMap imageVisualMap1 = new ImageVisualMap(); + imageVisualMap1.URL = "./NUISample/res/images/image-1.jpg"; + imageVisualMap1.VisualSize = new Vector2( 300.0f, 300.0f ); + imageVisualMap1.Offset = new Vector2( 50.0f, 50.0f ); + imageVisualMap1.OffsetSizeMode = new Vector4( 1.0f, 1.0f, 1.0f, 1.0f ); + imageVisualMap1.Origin = AlignType.TOP_BEGIN; + imageVisualMap1.AnchorPoint = AlignType.TOP_BEGIN; + _visualView.AddVisual("imageVisual1", imageVisualMap1); + + + + + + Override the parent method. + + + + + Add or update a visual to visual view. + + The name of visual to add. If add a existed visual name, the visual will be replaced. + The property map of visual to create. + + + + Remove a visual by name. + + The name of visual to remove. + + + + Get the total number of Visuals which are added by users + + + + + Remove all visuals of visual view. + + + + + + Create visual animation (transition) with the input parameters. + + The visual map to animation. + The property of visual to animation. + The destination value of property after animation. + The start time of visual animation. + The end time of visual animation. + The alpha function of visual animation + The initial property value of visual animation + Animation instance + + + + Add group visual animation (transition) map with the input parameters. + + The visual map to animation. + The property of visual to animation. + The destination value of property after animation. + The start time of visual animation. + The end time of visual animation. + The alpha function of visual animation + The initial property value of visual animation + + + + Finish to add Visual animation (transition) map and create transition animation. + + Animation instance + + + + Color class. + + + + + To make Color instance be disposed. + + + + + Addition operator. + + First value + Second value + A Color containing the result of the addition + + + + Subtraction operator. + + First value + Second value + A Color containing the result of the subtraction + + + + Unary negation operator. + + Target Value + A Color containg the negation + + + + Multiplication operator. + + First Value + Second Value + A Color containing the result of the multiplication + + + + Division operator. + + First Value + Second Value + A Color containing the result of the division + + + + Array subscript operator overload. + + Subscript index + The float at the given index + + + + Default constructor + + + + + Constructor. + + red component + green component + blue component + alpha component + + + + Conversion constructor from an array of four floats. + + array Array of R,G,B,A + + + + Check if two Color classes are same. + + A Color to be compared + If two Colors are are same, then true. + + + + Check if two Color classes are different. + + A Color to be compared + If two Colors are are different, then true. + + + + red component. + + + + + green component. + + + + + blue component. + + + + + alpha component. + + + + + Get black colored Color class. + + + + + Get white colored Color class. + + + + + Get red colored Color class. + + + + + Get green colored Color class. + + + + + Get blue colored Color class. + + + + + Get yellow colored Color class. + + + + + Get magenta colored Color class. + + + + + Get cyan colored Color class. + + + + + Get transparent colored Color class. + + + + + convert Color class to Vector4 class implicitly. + + A Color to be converted to Vector4 + + + + + Spin CustomView class + + + + + Creates an initialized Spin. + + + + + + + + Event handler when the TextField in Spin looses it's Key focus + + + + + + + + Value to be set in Spin. + + + + + Minimum Value of Spin Value. + + + + + Maximum Value of Spin Value. + + + + + Increasing, decresing step of Spin Value when Up or Down key is pressed. + + + + + Wrapping enabled status. + + + + + Text point size of Spin Value. + + + + + The color of Spin Value. + + + + + Maximum text lengh of Spin Value. + + + + + Reference of TextField of Spin. + + + + + Show indicator image, for example Up/Down Arrow image. + + + + + Add this attribute to any property belonging to a View (control) you want to be scriptable from JSON + + + Example: + + class MyView : public CustomView + { + [ScriptableProperty()] + public int MyProperty + { + get + { + return _myProperty; + } + set + { + _myProperty = value; + } + } + } + + Internally the following occurs for property registration ( this only occurs once per Type, not per Instance): + + - The controls static constructor should call ViewRegistry.Register() (only called once for the lifecycle of the app) + - Within Register() the code will introspect the Controls properties, looking for the ScriptableProperty() attribute + - For every property with the ScriptableProperty() attribute, TypeRegistration.RegisterProperty is called. + - TypeRegistration.RegisterProperty calls in to DALi C++ Code Dali::CSharpTypeRegistry::RegisterProperty() + - DALi C++ now knows the existance of the property and will try calling SetProperty, if it finds the property in a JSON file (loaded using builder). + + The DALi C# example + + class MyView : public CustomView + { + + [ScriptableProperty()] + public double Hours + { + get { return seconds / 3600; } + set { seconds = value * 3600; } + } + } + + Equivalent code in DALi C++: + in MyControl.h + class MyControl : public Control + { + struct Property + { + enum + { + HOURS = Control::CONTROL_PROPERTY_END_INDEX + 1 + } + } + } + + in MyControl-impl.cpp + + DALI_TYPE_REGISTRATION_BEGIN( Toolkit::MyControl, Toolkit::Control, Create ); + DALI_PROPERTY_REGISTRATION( Toolkit, MyControl, "Hours", INTEGER, DISABLED ) + DALI_TYPE_REGISTRATION_END() + + + + + + + View Registry singleton. + Used for registering controls and any scriptable properties they have ( see ScriptableProperty ) + + Internal Design from C# to C++ + + - Each custom C# view should have it's static constructor called before any JSON file is loaded. + Static constructors for a class will only run once ( they are run per control type, not per instance). + Example of running a static constructor: + System.Runtime.CompilerServices.RuntimeHelpers.RunClassConstructor (typeof(Spin).TypeHandle); + Inside the static constructor the control should register it's type with the ViewRegistry + e.g. + + static Spin() + { + ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) ); + } + + The control should also provide a CreateInstance function, which gets passed to the ViewRegistry + // Eventually it will be called if DALi Builderfinds a Spin control in a JSON file + static CustomView CreateInstance() + { + return new Spin(); + } + + + + The DALi C++ equivalent of this is + + TypeRegistration mType( typeid(Toolkit::Spin), typeid(Toolkit::Control), CreateInstance ); + + + + + + + + ViewRegistry is a singleton + + + + + + Lookup table to match C# types to DALi types, used for the automatic property registration + + + + + Called directly from DALi C++ type registry to create a control (View) using no marshalling. + + Pointer to the Control (Views) handle + C pointer to the Control (View) name + + + + Function which registers a view and all it's scriptable properties with DALi's type registry. + Means the View can be created / configured from a JSON script. + + The function uses introspection to scan a Views C# properties, then selects the ones with + [ScriptableProperty] attribute to be registered. + Example of a Spin view registering itself + static Spin() + { + ViewRegistry registers control type with DALi type registery + also uses introspection to find any properties that need to be registered with type registry + ViewRegistry.Instance.Register(CreateInstance, typeof(Spin) ); + } + + + + + + Get a property value from a View + + + + + + Set a property value on a View + + + + + + + Constructor. + + + + + Creates an angle in degrees. + + The initial value in degrees + + + + Creates an angle in degrees from a Radian. + + The initial value in Radians + + + + + To make FocusManager instance be disposed. + + + + + Event arguments that passed via PreFocusChange signal + + + + + + Event arguments that passed via FocusChanged signal. + + + + + FocusGroupChanged will be triggered after the current focused view has been changed. + + + + + Event arguments that passed via FocusGroupChanged signal. + + + + + + Event arguments that passed via FocusedViewEnterKey signal + + + + + FocusedViewActivated will be triggered when the current focused view has the enter key pressed on it. + + + + + + Gets the current focused view. + + A handle to the current focused View or an empty handle if no View is focused + + + + Moves the focus to the next focusable View in the focus chain in the given direction(according to the focus traversal order). + + The direction of focus movement + true if the movement was successful + + + + + Move the focus to prev focused view. + + + + + + + Checks whether the view is set as a focus group or not. + + The View to be checked + Whether the View is set as a focus group + + + + Returns the closest ancestor of the given view that is a focus group. + + The View to be checked for its focus group + The focus group the given view belongs to or an empty handle if the given view + + + + + + Gets the singleton of FocusManager object. + + + + + + + The gesture type. + + + + + The gesture state. + + + + + The time the gesture took place. + + + + + Copy constructor. + + A reference to the copied handle + + + + Enumeration for type of gesture + + + + + Enumeration for state of the gesture. + + + + + + The time (in ms) that the hover event occurred. + + + + + + Retrieves the State of the point specified. + + The point required + The state of the point specified + + + + Retrieves the view that was underneath the point specified. + + The point required + The view that was underneath the point specified + + + + Retrieves the co-ordinates relative to the top-left of the hit-view at the point specified. + + The point required + The co-ordinates relative to the top-left of the hit-view of the point specified + + + + Retrieves the co-ordinates relative to the top-left of the screen of the point specified. + + The point required + The co-ordinates relative to the top-left of the screen of the point specified + + + + Default constructor. + + + + + Constructor. + + The time the event occurred + + + + Returns the total number of points. + + Total number of Points + + + + Specifically manages the ecore input method framework which enables the virtual or hardware keyboards. + + + + + This structure is used to pass on data from the IMF regarding predictive text. + + + + + Dispose pattern + + + + + Default Constructor + + + + + Constructor + + The name of the event from the IMF. + The pre-edit or commit string. + Start position from the current cursor position to start deleting characters. + The number of characters to delete from the cursorOffset. + + + + The pre-edit or commit string. + + + + + The pre-edit or commit string. + + + + + The name of the event from the IMF. + + + + + The name of the event from the IMF. + + + + + Start position from the current cursor position to start deleting characters. + + + + + Start position from the current cursor position to start deleting characters. + + + + + Number of characters to delete from the cursorOffset. + + + + + Number of characters to delete from the cursorOffset. + + + + + Data required by IMF from the callback. + + + + + Dispose pattern + + + + + Default Constructor + + + + + Constructor + + True if cursor position needs to be updated. + New position of cursor. + Current text string. + Flag if preedit reset is required. + + + + Current text string. + + + + + Current text string. + + + + + Current text string. + + + + + Current text string. + + + + + If cursor position needs to be updated. + + + + + If cursor position needs to be updated. + + + + + Flag if preedit reset is required. + + + + + Flag if preedit reset is required. + + + + + Retrieve a handle to the instance of ImfManager. + + A handle to the ImfManager. + + + + Activate the IMF.
+ It means that the text editing is started at somewhere.
+ If the H/W keyboard isn't connected then it will show the virtual keyboard. + + + + + Deactivate the IMF.
+ It means that the text editing is finished at somewhere. + + + + + Get the restoration status, which controls if the keyboard is restored after the focus lost then regained.
+ If true then keyboard will be restored (activated) after focus is regained. + + Restoration status. + + + + Set status whether the IMF has to restore the keyboard after losing focus. + + True means that keyboard should be restored after focus lost and regained. + + + + Send message reset the pred-edit state / imf module. + + + + + Notifies IMF context that the cursor position has changed, required for features like auto-capitalisation. + + + + + Sets cursor position stored in VirtualKeyboard, this is required by the IMF context. + + Position of cursor. + + + + Gets cursor position stored in VirtualKeyboard, this is required by the IMF context. + + Current position of cursor + + + + Method to store the string required by the IMF, this is used to provide predictive word suggestions. + + The text string surrounding the current cursor point. + + + + Gets current text string set within the IMF manager, this is used to offer predictive suggestions. + + Surrounding text. + + + + Notifies IMF context that text input is set to multi line or not. + + True if multiline text input is used. + + + + Returns text direction of the keyboard's current input language. + + The direction of the text. + + + + Provides size and position of keyboard.
+ Position is relative to whether keyboard is visible or not.
+ If keyboard is not visible then position will be off the screen.
+ If keyboard is not being shown when this method is called the keyboard is partially setup (IMFContext) to get
+ the values then taken down. So ideally GetInputMethodArea() should be called after Show(). + + Rectangle which is keyboard panel x, y, width, height + + + + Sets up the input-panel specific data. + + The specific data to be set to the input panel. + + + + Gets the specific data of the current active input panel. + + The specific data to be got from the input panel. + + + + Gets the state of the current active input panel. + + The state of the input panel. + + + + Sets the return key on the input panel to be visible or invisible.
+ The default is true. + + True if the return key is visible(enabled), false otherwise. + + + + Enable to show the input panel automatically when focused. + + If true, the input panel will be shown when focused. + + + + Shows the input panel. + + + + + Hides the input panel. + + + + + Gets the keyboard type.
+ The default keyboard type is SoftwareKeyboard. + + The keyboard type + + + + Gets the current language locale of the input panel.
+ Ex) en_US, en_GB, en_PH, fr_FR, ... + + The current language locale of the input panel. + + + + Constructor + + + + + ImfManager activated event arguments. + + + + + ImfManager activated event. + + + + + ImfManager activated event arguments. + + + + + ImfManager activated. + + + + + ImfManager activated signal. + + + + + ImfManager event received event arguments. + + + + + ImfManager event received. + + + + + ImfManager event received event arguments. + + + + + ImfManager event received. + + + + + ImfManager event received signal. + + + + + ImfManager status changed event arguments. + + + + + ImfManager status changed. + + + + + ImfManager status changed event arguments. + + + + + ImfManager status changed. + + + + + ImfManager status changed signal. + + + + + ImfManager resized event arguments. + + + + + ImfManager resized event. + + + + + ImfManager resized. + + + + + ImfManager resized signal. + + + + + ImfManager language changed event arguments. + + + + + ImfManager language changed event. + + + + + ImfManager language changed. + + + + + ImfManager language changed signal. + + + + + ImfManager keyboard type changed event arguments. + + + + + ImfManager keyboard type changed. + + + + + The direction of text. + + + + + Left to right. + + + + + Right to left. + + + + + Events that are generated by the IMF. + + + + + No event. + + + + + Pre-Edit changed. + + + + + Commit recieved. + + + + + Event to delete a range of characters from the string. + + + + + Event to query string and cursor position. + + + + + Private command sent from the input panel. + + + + + Enumeration for state of the input panel. + + + + + Unknown state. + + + + + Input panel is shown. + + + + + Input panel is hidden. + + + + + Input panel in process of being shown. + + + + + Enumeration for the type of Keyboard. + + + + + Software keyboard (Virtual keyboard) is default. + + + + + Hardware keyboard. + + + + + A class encapsulating the input method map. + + + + + Default constructor. + + + + + Get or set panel layout. + + + + + Get or set action button. + + + + + Get or set auto capital. + + + + + Get or set variation. + + + + + Get or set variation for normal layout. + + + + + Get or set variation for number only layout. + + + + + Get or set variation for password layout. + + + + + Get the input method map. + + + + + SetType that can be changed in the system Input Method. + + + + + Set Keyboard layout. + + + + + Set Action button title. + + + + + Set Auto capitalise of input. + + + + + Set variation. + + + + + Autocapitalization Types. + + + + + No auto-capitalization when typing. + + + + + Autocapitalize each word typed. + + + + + Autocapitalize the start of each sentence. + + + + + Autocapitalize all letters. + + + + + Input panel (virtual keyboard) layout types.. + + + + + Default layout. + + + + + Number layout. + + + + + Email layout. + + + + + URL layout. + + + + + Phone number layout. + + + + + IP layout. + + + + + Month layout. + + + + + Number layout. + + + + + Hexadecimal layout. + + + + + Command-line terminal layout including ESC, Alt, Ctrl key, so on (no auto-correct, no auto-capitalization). + + + + + Like normal, but no auto-correct, no auto-capitalization etc. + + + + + Date and time layout. + + + + + Emoticon layout. + + + + + Specifies what the Input Method "action" button functionality is set to. + + + + + Default action. + + + + + Done. + + + + + Go action. + + + + + Join action. + + + + + Login action. + + + + + Next action. + + + + + Previous action. + + + + + Search action. + + + + + Send action. + + + + + Sign in action. + + + + + Unspecified action. + + + + + Nothing to do. + + + + + Available variation for Normal layout. + + + + + The plain normal layout. + + + + + Filename layout. sysbols such as '/' should be disabled. + + + + + The name of a person. + + + + + Available variation for Number only layout. + + + + + The plain normal number layout. + + + + + The number layout to allow a positive or negative sign at the start. + + + + + The number layout to allow decimal point to provide fractional value. + + + + + The number layout to allow decimal point and negative sign. + + + + + Available variation for Password layout. + + + + + The normal password layout. + + + + + The password layout to allow only number. + + + + + The key structure is used to store a key press. + + + + + Name given to the key pressed + + + + + Keycode for the key pressed. + + + + + Special keys like shift, alt and control which modify the next key pressed. + + + + + The time (in ms) that the key event occurred. + + + + + State of the key event. + + + + + Default Constructor. + + + + + Constructor. + + The name of the key pressed or command from the IMF, if later then the some following parameters will be needed + A string of input characters or key pressed + The unique key code for the key pressed + The key modifier for special keys like shift and alt + The time (in ms) that the key event occurred + The state of the key event + + + + Checks to see if Shift key modifier has been supplied. + + True if shift modifier + + + + Checks to see if Ctrl (control) key modifier has been supplied. + + True if ctrl modifier + + + + Checks to see if Alt key modifier has been supplied. + + True if alt modifier + + + + Enumeration for specifying the state of the key event. + + + + + + Adds a key frame. + + A progress value between 0.0 and 1.0 + A value + + + + Adds a key frame. + + A progress value between 0.0 and 1.0 + A value + The alpha function used to blend to the next keyframe + + + + Creates an initialized KeyFrames handle. + + + + + Gets the type of the key frame. + + The key frame property type + + + + Adds a key frame. + + A progress value between 0.0 and 1.0 + A value + + + + Adds a key frame. + + A progress value between 0.0 and 1.0 + A value + The alpha function used to blend to the next keyframe + + + + Layers provide a mechanism for overlaying groups of actors on top of each other. + + + + + Creates a Layer object. + + + + + Search through this layer's hierarchy for an view with the given unique ID. + + 
This layer(the parent) has been initialized.
+ The actor itself is also considered in the search. + The id of the child to find + A handle to the view if found, or an empty handle if not. + + + + Adds a child view to this layer. + + 
This layer(the parent) has been initialized. The child view has been initialized. The child view is not the same as the parent layer.
+ The child will be referenced by its parent. This means that the child will be kept alive, even if the handle passed into this method is reset or destroyed. + If the child already has a parent, it will be removed from old parent and reparented to this layer. This may change child's position, color, scale etc as it now inherits them from this layer. + The child + + + + Removes a child View from this layer. If the view was not a child of this layer, this is a no-op. + + 
This layer(the parent) has been initialized. The child view is not the same as the parent view.
+ The child + + + + + Increments the depth of the layer. + + + + + Decrements the depth of the layer. + + + + + Raises the layer to the top. + + + + + Lowers the layer to the bottom. + + + + + + + Retrieves child view by index. + + 
The View has been initialized.
+ The index of the child to retrieve + The view for the given index or empty handle if children not initialized + + + + Enumeration for the behavior of the layer. + + + + + Layer Behavior, type String(Layer.LayerBehavior) + + + + + Internal only property to Enable/Disable Clipping, type Boolean. + By default this is false, i.e. the viewport of the Layer is the entire window. + + + + + Sets the Viewport (in window coordinates), type Rectangle. + The contents of the layer will not be visible outside this box, when ViewportEnabled is true. + + + + + + Retrieves and sets the Layer's visibility. + + + + + Get the number of children held by the layer. + + + + + Gets/Sets the Layer's name. + + + + + + + + + Constructor. + + The state of the gesture + + + + Represents an application that have UI screen. The NUIApplication class has a default stage. + + + + + Occurs whenever the application is resumed. + + + + + Occurs whenever the application is paused. + + + + + The instance of ResourceManager. + + + + + The default constructor. + + + + + The constructor with stylesheet. + + + + + The constructor with stylesheet and window mode. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Overrides this method if want to handle behavior. + + + + + Run NUIApplication. + + Arguments from commandline. + + + + Exit NUIApplication. + + + + + Enumeration for deciding whether a NUI application window is opaque or transparent. + + + + + ResourceManager to handle multilingual + + + + + Get the window instance. + + + + + This specifies whether the Actor uses its own color, or inherits. + + + + + Actor will use its own color. + + + + + Actor will use its parent color. + + + + + Actor will blend its color with its parents color. + + + + + Actor will blend its alpha with its parents alpha. This means when parent fades in or out child does as well. This is the default. + + + + + This specifies the dimesion of width or heigh for size negotiation. + + + + + Width dimension + + + + + Height dimension + + + + + Mask to cover all flags + + + + + Enumeration for the instance of how the actor and it's children will be drawn. + + + + + The default draw-mode + + + + + Draw the actor and its children as an overlay + + + + + Will be replaced by separate ClippingMode enum. Draw the actor and its children into the stencil buffer + + + + + Enumeration for size negotiation resize policies. + + + + + Size is fixed as set by SetSize + + + + + Size is to use the actor's natural size + + + + + + Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. + + + + + The actors size will be ( ParentSize * SizeRelativeToParentFactor ). + + + + + The actors size will be ( ParentSize + SizeRelativeToParentFactor ). + + + + + Size will adjust to wrap around all children + + + + + One dimension is dependent on the other + + + + + The size will be assigned to the actor + + + + + Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation. + + + + + Use the size that was set + + + + + Fit within the size set maintaining natural size aspect ratio + + + + + Fit within the size set maintaining natural size aspect ratio + + + + + Enumeration for ClippingMode describing how this Actor's children will be clipped against it. + + + + + This Actor will not clip its children. + + + + + This Actor will clip all children to within its boundaries (the actor will also be visible itself). + + + + + Enumeration for type determination of how camera operates. + + + + + Camera orientation is taken from CameraActor. + + + + + Camera is oriented to always look at a target. + + + + + Enumeration for projection modes. + + + + + Distance causes foreshortening; objects further from the camera appear smaller. + + + + + Relative distance from the camera does not affect the size of objects. + + + + + This specifies ccustomView behaviour types. + + + + + Use to provide default behaviour (size negotiation is on, event callbacks are not called) + + + + + True if control does not need size negotiation, i.e. it can be skipped in the algorithm + + + + + Use to provide key navigation support. + + + + + Use to make style change event disabled. + + + + + + No type + + + + + A boolean type + + + + + A float type + + + + + An integer type + + + + + a vector array of size=2 with float precision + + + + + a vector array of size=3 with float precision + + + + + a vector array of size=4 with float precision + + + + + a 3x3 matrix + + + + + a 4x4 matrix + + + + + an integer array of size=4 + + + + + either a quaternion or an axis angle rotation + + + + + A string type + + + + + an array of PropertyValue + + + + + a string key to PropertyValue mapping + + + + + + if the property is read-only + + + + + If the property is read/writeable + + + + + If the property can be animated or constrained + + + + + The number of access modes + + + + + Types of style change. Enumeration for StyleChange type. + + + + + Denotes that the default font has changed. + + + + + Denotes that the default font size has changed. + + + + + Denotes that the theme has changed. + + + + + Enumeration for horizontal alignment types. + + + + + Align horizontally left + + + + + Align horizontally center + + + + + Align horizontally right + + + + + Enumeration for vertical alignment types. + + + + + Align vertically top + + + + + Align vertically center + + + + + Align vertically bottom + + + + + Enumeration for point state type. + + + + + Touch or hover started + + + + + Touch or hover finished + + + + + Screen touched + + + + + Touch stopped + + + + + Finger dragged or hovered + + + + + Leave the boundary of an actor + + + + + + A system event has occurred which has interrupted the touch or hover event sequence. + + + + + Enumeration for the text horizontal aligning. + + + + + Texts place at the begin of horizontal direction. + + + + + Texts place at the center of horizontal direction. + + + + + Texts place at the end of horizontal direction. + + + + + Enumeration for the text horizontal aligning. + + + + + Texts place at the top of vertical direction. + + + + + Texts place at the center of vertical direction. + + + + + Texts place at the bottom of vertical direction. + + + + + + Defualt value + + + + + Clamp to edge + + + + + Repeat + + + + + Mirrored repeat + + + + + The type of coordinate system for certain attributes of the points in a gradient. + + + + + + + + Uses the terminal colors of the gradient to fill the remainder of the quad. + + + + + Reflect the gradient pattern start-to-end, end-to-start, start-to-end etc. until the quad is filled. + + + + + Repeat the gradient pattern start-to-end, start-to-end, start-to-end etc. until the quad is filled. + + + + + The shading mode used by MeshVisual. + + + + + *Simplest*. One color that is lit by ambient and diffuse lighting. + + + + + Uses only the visual image textures provided with specular lighting in addition to ambient and diffuse lighting. + + + + + Uses all textures provided including a gloss, normal and texture map along with specular, ambient and diffuse lighting. + + + + + The primitive shape to render as a PrimitiveVisual. + + + + + A perfectly round geometrical object in three-dimensional space. + + + + + The area bound between two circles, i.e. a cone with the tip removed. + + + + + Equivalent to a conical frustrum with top radius of zero. + Equivalent to a conical frustrum with top radius of zero. + + + + Equivalent to a conical frustrum with top radius of zero. + + + + + Equivalent to a conical frustrum with equal radii for the top and bottom circles. + + + + + Equivalent to a bevelled cube with a bevel percentage of zero. + + + + + Equivalent to a bevelled cube with a bevel percentage of one. + + + + + + Full-screen image display: Limit loaded image resolution to device resolution using ShrinkToFit mode. + + + + + Thumbnail gallery grid: Limit loaded image resolution to screen tile using ScaleToFill mode. + + + + + Image columns: Limit loaded image resolution to column width using FitWidth mode. + + + + + Image rows: Limit loaded image resolution to row height using FitHeight mode. + + + + + + + For each output pixel, read one input pixel. + + + + + For each output pixel, read a quad of four input pixels and write a weighted average of them. + + + + + + Iteratively box filter to almost the right size, then for each output pixel, read four pixels from the last level of box filtering and write their weighted average. + + + + + No filtering is performed. If the SCALE_TO_FILL scaling mode is enabled, the borders of the image may be trimmed to match the aspect ratio of the desired dimensions. + + + + + For caching algorithms where a client strongly prefers a cache-hit to reuse a cached image. + + + + + This specifies policy types that could be used by the transform for the offset or size. + + + + + Relative to the control (percentage [0.0f to 1.0f] of the control). + + + + + Absolute value in world units. + + + + + This specifies all the transform property types. + + + + + Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). + + + + + Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). + + + + + The origin of the visual within its control area. + + + + + The anchor-point of the visual + + + + + Whether the x or y OFFSET values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units). + + + + + Whether the width or height SIZE values are relative (percentage [0.0f to 1.0f] of the control) or absolute (in world units). + + + + + This specifies visual types. + + + + + The index for the visual type. + + + + + Renders a solid color as an internal border to the control's quad. + + + + + Renders a solid color to the control's quad. + + + + + Renders a smooth transition of colors to the control's quad. + + + + + Renders an image into the control's quad. + + + + + Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. + + + + + Renders a simple 3D shape, such as a cube or sphere. + + + + + Renders a simple wire-frame outlining a quad. + + + + + Renders text. + + + + + Renders an n-patch image. + + + + + Renders an SVG image. + + + + + Renders a animated image. (Animated GIF) + + + + + This specifies visual properties. + + + + + This specifies shader properties. + + + + + This specifies Visaul align types. + + + + + This specifies properties of BorderVisual. + + + + + This specifies properties of ColorVisual. + + + + + This specifies properties of GradientVisual. + + + + + This specifies properties of ImageVisual. + + + + + This specifies properties of MeshVisual. + + + + + This specifies properties of PrimitiveVisual. + + + + + This specifies properties of TextVisual. + + + + + This specifies properties of NpatchImageVisual. + + + + + HiddenInput Property. + + + + + The type for HiddenInput mode. + + + + + Don't hide text. + + + + + Hide all the input text. + + + + + Hide n characters from start. + + + + + Show n characters from start. + + + + + Show last character for the duration(use ShowDuration property to modify duration). + + + + + ParentOrigin constants. + + + + + PivotPoint constants. + + + + + PositionAxis constants. + + + + + Auto scrolling stop behaviour. + + + + + Stop animation after current loop finished. + + + + + Stop animation immediatly and reset position. + + + + + An enum of screen mode. + + + + + The mode which turns the screen off after a timeout. + + + + + The mode which keeps the screen turned on. + + + + + An enum of notification window's priority level. + + + + + + Base nofitication level. + + + + + Medium notification level than base. + + + + + Higher notification level than medium. + + + + + The highest notification level. + + + + + An enum of Window types. + + + + + + A notification window, like a warning about battery life or a new E-Mail received. + + + + + A persistent utility window, like a toolbox or palette. + + + + + Used for simple dialog windows. + + + + + An enum of scroll state of text eidtor. + + + + + Scrolling is started. + + + + + Scrolling is finished. + + + + + An enum of line wrap mode of text controls. + + + + + Word mode will move word to next line + + + + + character will move character by character to next line + + + + + + + + + + + + This current touch position of the primary touch point in local actor coordinates. + + + + + + + This current touch position of the primary touch point in screen coordinates. + + + + + The total number of fingers touching the screen in a pan gesture. + + + + + Default Constructor. + + + + + Constructor. + + The state of the gesture + + + + + + + + + Creates an initialized Path handle. + + + + + Adds an interpolation point. + + The new interpolation point to be added + + + + Adds a control point. + + The new control point to be added + + + + + Sample path at a given progress. Calculates position and tangent at that point of the curve. + + A floating point value between 0.0 and 1.0 + The interpolated position at that progress + The interpolated tangent at that progress + + + + Accessor for the interpolation points. + + The index of the interpolation point + + + + Accessor for the control points. + + The index of the control point + + + + Gets the number of interpolation points in the path. + + The number of interpolation points in the path + + + + Enumeration for Points + + + + + Enumeration for ControlPoints + + + + + + + + The center point of the two points that caused the pinch gesture in screen coordinates. + + + + + The center point of the two points that caused the pinch gesture in local actor coordinates. + + + + + Default Constructor. + + The state of the gesture + + + + Position is a three dimensional vector. + + + + + Addition operator. + + Vector to add + Vector to add + A vector containing the result of the addition + + + + Subtraction operator. + + Vector to subtract + Vector to subtract + A vector containing the result of the subtraction + + + + Unary negation operator. + + Vector to netate + A vector containg the negation + + + + Multiplication operator. + + The vector to multiply + The vector to multiply + A vector containing the result of the multiplication + + + + Multiplication operator. + + The vector to multiply + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + The vector to divide + The vector to divide + A vector containing the result of the division + + + + Division operator. + + The vector to divide + The float value to scale the vector by + A vector containing the result of the scaling + + + + Const array subscript operator overload. Should be 0, 1 or 2. + + Subscript index + The float at the given index + + + + + + + + Constructor + + + + + Constructor + + x component + y component + z component + + + + Constructor + + Position2D to create this vector from + + + + Compare if rhs is equal to + + The vector to compare + Returns true if the two vectors are equal, otherwise false + + + + Compare if rhs is not equal to + + The vector to compare + Returns true if the two vectors are not equal, otherwise false + + + + x component + + + + + y component + + + + + z component + + + + + ParentOrigin constants. It's 0.0. + + + + + ParentOrigin constants. It's 1.0. + + + + + ParentOrigin constants. It's 0.0. + + + + + ParentOrigin constants. It's 1.0. + + + + + ParentOrigin constants. It's 0.5. + + + + + ParentOrigin constants: 0.0, 0.0, 0.5 + + + + + ParentOrigin constants: 0.5, 0.0, 0.5 + + + + + ParentOrigin constants: 1.0, 0.0, 0.5 + + + + + ParentOrigin constants: 0.0, 0.5, 0.5 + + + + + ParentOrigin constants: 0.0, 0.5, 0.5 + + + + + ParentOrigin constants: 1.0, 0.5, 0.5 + + + + + ParentOrigin constants: 0.0f, 1.0f, 0.5f + + + + + ParentOrigin constants: 0.5, 1.0, 0.5 + + + + + ParentOrigin constants: 1.0, 1.0, 0.5 + + + + + PivotPoint constants: 0.0 + + + + + PivotPoint constants: 1.0 + + + + + PivotPoint constants: 0.0 + + + + + PivotPoint constants: 1.0 + + + + + PivotPoint constants: 0.0 + + + + + PivotPoint constants: 0.0, 0.0, 0.5 + + + + + PivotPoint constants: 0.5, 0.0, 0.5 + + + + + PivotPoint constants: 1.0, 0.0, 0.5 + + + + + PivotPoint constants: 0.0, 0.5, 0.5 + + + + + PivotPoint constants: 0.5, 0.5, 0.5 + + + + + PivotPoint constants: 1.0, 0.5, 0.5 + + + + + PivotPoint constants: 0.0, 1.0, 0.5 + + + + + PivotPoint constants: 0.5, 1.0, 0.5 + + + + + PivotPoint constants: 1.0, 1.0, 0.5 + + + + + Constant ( 1.0f, 1.0f, 1.0f ) + + + + + Constant ( 0.0f, 0.0f, 0.0f ) + + + + + Convert a position instance to a vector3 instance. + + + + + Convert a vector3 instance to a position instance. + + + + + Position2D is a two dimensional vector. + + + + + Addition operator. + + Vector to add + Vector to add + A vector containing the result of the addition + + + + Subtraction operator. + + Vector to subtract + Vector to subtract + A vector containing the result of the subtraction + + + + Unary negation operator. + + Vector to netate + A vector containing the negation + + + + Multiplication operator. + + Vector to multiply + Vector to multiply + A vector containing the result of the multiplication + + + + Multiplication operator. + + Vector to multiply + The int value to scale the vector + A vector containing the result of the multiplication + + + + Division operator. + + Vector to divide + Vector to divide + A vector containing the result of the division + + + + Division operator. + + Vector to divide + The int value to scale the vector by + A vector containing the result of the division + + + + Const array subscript operator overload. Should be 0, or 1. + + Subscript index + The float at the given index + + + + Constructor + + + + + Constructor + + x component + y component + + + + Constructor + + Position to create this vector from + + + + Compare if rhs is equal to. + + The vector to compare + Returns true if the two vectors are equal, otherwise false + + + + Compare if rhs is not equal to. + + The vector to compare + Returns true if the two vectors are not equal, otherwise false + + + + x component. + + + + + y component. + + + + + Convert a position2D instance to a vector2 instance. + + + + + Convert a vector2 instance to a position2D instance. + + + + + Convert a Position2D instance to a Uint16Pair instance. + + + + + Convert a Uint16Pair instance to a Position2D instance. + + + + + Constructor. Create a Property instance. + + A valid handle to the target object + The index of a property + + + + Constructor. Create a Property instance. + + A valid handle to the target object + The index of a property + Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1) + + + + + + Gets/Sets the index of the property. + + + + + Gets/Sets the componentIndex of the property. + + + + + A Array of property values. + + + + + Operator to access an element. + + The element index to access. No bounds checking is performed + The a reference to the element + + + + Constructor + + + + + Retrieves the number of elements in the array. + + The number of elements in the array + + + + Retrieves the number of elements in the array. + + The number of elements in the array + + + + Returns whether the array is empty. + + Return true if empty, false otherwise + + + + Clears the array. + + + + + Increases the capacity of the array. + + The size to reserve + + + + Resizes to size. + + The size to resize + + + + Retrieves the capacity of the array. + + The allocated capacity of the array + + + + Adds an element to the array. + + The value to add to the end of the array + + + + Add an element to the array. + + The value to add to the end of the array + + + + Access an element. + + The element index to access. No bounds checking is performed + The a reference to the element + + + + Retrieves the value of elements in the array. + + The element index to retrieve. + The a reference to the element + + + + A key type which can be either a std::string or a Property::Index + + + + + The type of the key + + + + + The index key. + + + + + The string key. + + + + + Constructor + + The string key + + + + Constructor + + The index key + + + + Compare if rhs is equal to + + A string key to compare against + Returns true if the key compares, or false if it isn't equal or of the wrong type + + + + Compare if rhs is equal to + + A index key to compare against + Returns true if the key compares, or false if it isn't equal or of the wrong type + + + + Compare if rhs is equal to + + A key to compare against + Returns true if the keys are of the same type and have the same value + + + + Compare if rhs is not equal to + + An index key to compare against. + Returns true if the key is not equal or not a string key + + + + Compare if rhs is not equal to + + An index key to compare against. + Returns true if the key is not equal, or not an index key + + + + Compare if rhs is not equal to + + A key to compare against. + Returns true if the keys are not of the same type or are not equal + + + + The type of key + + + + + A Map of property values, the key type could be String or Property::Index. + + + + + + + Constructor + + + + + Copy Constructor + + The Map to copy from + + + + Retrieves the number of elements in the map. + + The number of elements in the map + + + + Returns whether the map is empty. + + Returns true if empty, false otherwise + + + + + + + + Retrieves the value at the specified position. + + The specified position + A reference to the value at the specified position + + + + Retrieve the key at the specified position. + + The specified position + A copy of the key at the specified position + + + + Finds the value for the specified key if it exists. + + The key to find + The value if it exists, an empty object otherwise + + + + Finds the value for the specified keys if either exist. + + The index key to find + The string key to find + The value if it exists, an empty object otherwise + + + + Clears the map. + + + + + + Retrieves the element with the specified string key. + + The key whose value to retrieve + The value for the element with the specified key + + + + Retrieves the element with the specified index key. + + The key whose value to retrieve + The value for the element with the specified key + + + + A value-type representing a property value. + + + + + + Creates a Size2D property value. + + A Size2D values + + + + Creates a Position2D property value. + + A Position2D values + + + + Creates a Size property value. + + A Size values + + + + Creates a Position property value. + + A Position values + + + + Creates a Color property value. + + A Color values + + + + Retrieves a Size2D value. + + On return, a Size2D value + + + + Retrieves a Position2D value. + + On return, a Position2D value + + + + Retrieves a Size value. + + On return, a Size value + + + + Retrieves a Position value. + + On return, a Position value + + + + Retrieves a Color value. + + On return, a Color value + + + + Default constructor. + + + + + Creates a boolean property value. + + A boolean value + + + + Creates an integer property value. + + An integer value + + + + Creates a float property value. + + A floating-point value + + + + Creates a Vector2 property value. + + A vector of 2 floating-point values + + + + Creates a Vector3 property value. + + A vector of 3 floating-point values + + + + Creates a Vector4 property value. + + A vector of 4 floating-point values + + + + Creates a Rectangle property value. + + A Rectangle values + + + + Creates a Rotation property value. + + A Rotation values + + + + Creates a string property value. + + A string + + + + Creates an array property value. + + An array + + + + Creates a map property value. + + An array + + + + Creates a PropertyType value. + + A PropertyType values + + + + Creates a PropertyValue value. + + A PropertyValue values + + + + Queries the type of this property value. + + The type ID + + + + Retrieves a boolean value. + + On return, a boolean value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a floating-point value. + + On return, a floating-point value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a integer value. + + On return, a integer value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves an integer rectangle. + + On return, an integer rectangle + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a vector value. + + On return, a vector value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a vector value. + + On return, a vector value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a vector value. + + On return, a vector value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a Rotation value. + + On return, a Rotation value + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves a string property value. + + On return, a string + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves an array property value. + + On return, the array as a vector Property Values + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + Retrieves an map property value. + + On return, the map as vector of string and Property Value pairs + Returns true if the value is successfully retrieved, false if the type is not convertible + + + + An angle in radians. + + + + + Default constructor, initializes to 0. + + + + + Creates an angle in radians. + + The initial value in radians + + + + Creates an angle in radians from an angle in degrees. + + The initial value in degrees + + + + Conversion to float. + + The float value of this Radian + + + + The value in radians + + + + + Rectangle class + + + + + Equality operator. + + First operand + Second operand + True if boxes are exactly same + + + + Inequality operator. + + The first rectangle + The second rectangle + True if rectangles are not identical + + + + X position of the rectangle + + + + + Y position of the rectangle + + + + + Width of the rectangle + + + + + Height of the rectangle + + + + + Constructor. + + + + + Constructor. + + X coordinate (or left) + Y coordinate (or right) + Width (or bottom) + Height (or top) + + + + Assignment from individual values. + + X coordinate + Y coordinate + Width + Height + + + + Determines whether or not this Rectangle is empty. + + True if width or height are zero + + + + Gets the left of the rectangle. + + The left edge of the rectangle + + + + Gets the right of the rectangle. + + The right edge of the rectangle + + + + Gets the top of the rectangle. + + The top of the rectangle + + + + Gets the bottom of the rectangle. + + The bottom of the rectangle + + + + Gets the area of the rectangle. + + The area of the rectangle + + + + Determines whether or not this rectangle and the specified rectangle intersect. + + The other rectangle to test against this rectangle + True if the rectangles intersect + + + + Determines whether or not this Rectangle contains the specified rectangle. + + The other rectangle to test against this rectangle + True if the specified rectangle is contained + + + + RelativeVector2 is a two dimensional vector. + Both values(x and y) should be between [0, 1]. + + + + + Addition operator. + + Vector to add + Vector to add + A vector containing the result of the addition + + + + Subtraction operator. + + Vector to subtract + Vector to subtract + A vector containing the result of the subtraction + + + + Multiplication operator. + + The vector to multiply + The vector to multiply + A vector containing the result of the multiplication + + + + Multiplication operator. + + The vector to multiply + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + The vector to divide + The vector to divide + A vector containing the result of the division + + + + Division operator. + + The vector to divide + The float value to scale the vector by + A vector containing the result of the scaling + + + + Const array subscript operator overload. Should be 0, 1. + + Subscript index + The float at the given index + + + + + + + + Constructor + + + + + Constructor + + x component + y component + + + + Constructor + + RelativeVector3 to create this vector from + + + + Constructor + + RelativeVector4 to create this vector from + + + + Compare if rhs is equal to + + The vector to compare + Returns true if the two vectors are equal, otherwise false + + + + Compare if rhs is not equal to + + The vector to compare + Returns true if the two vectors are not equal, otherwise false + + + + x component + + + + + y component + + + + + + + + + + + + + RelativeVector3 is a three dimensional vector. + All values(x, y, z and w) should be between [0, 1]. + + + + + Addition operator. + + Vector to add + Vector to add + A vector containing the result of the addition + + + + Subtraction operator. + + Vector to subtract + Vector to subtract + A vector containing the result of the subtraction + + + + Multiplication operator. + + The vector to multiply + The vector to multiply + A vector containing the result of the multiplication + + + + Multiplication operator. + + The vector to multiply + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + The vector to divide + The vector to divide + A vector containing the result of the division + + + + Division operator. + + The vector to divide + The float value to scale the vector by + A vector containing the result of the scaling + + + + Const array subscript operator overload. Should be 0, 1 or 2. + + Subscript index + The float at the given index + + + + + + + + Constructor + + + + + Constructor + + x component + y component + z component + + + + Constructor + + RelativeVector2 to create this vector from + + + + Constructor + + RelativeVector4 to create this vector from + + + + Compare if rhs is equal to + + The vector to compare + Returns true if the two vectors are equal, otherwise false + + + + Compare if rhs is not equal to + + The vector to compare + Returns true if the two vectors are not equal, otherwise false + + + + x component + + + + + y component + + + + + z component + + + + + + + + + + + + + RelativeVector4 is a four dimensional vector. + All values(x, y, and z) should be between [0, 1]. + + + + + Addition operator. + + Vector to add + Vector to add + A vector containing the result of the addition + + + + Subtraction operator. + + Vector to subtract + Vector to subtract + A vector containing the result of the subtraction + + + + Multiplication operator. + + The vector to multiply + The vector to multiply + A vector containing the result of the multiplication + + + + Multiplication operator. + + The vector to multiply + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + The vector to divide + The vector to divide + A vector containing the result of the division + + + + Division operator. + + The vector to divide + The float value to scale the vector by + A vector containing the result of the scaling + + + + Const array subscript operator overload. Should be 0, 1 3 or 3. + + Subscript index + The float at the given index + + + + + + + + Constructor + + + + + Constructor + + x component + y component + z component + w component + + + + Constructor + + RelativeVector2 to create this vector from + + + + Constructor + + RelativeVector3 to create this vector from + + + + Compare if rhs is equal to + + The vector to compare + Returns true if the two vectors are equal, otherwise false + + + + Compare if rhs is not equal to + + The vector to compare + Returns true if the two vectors are not equal, otherwise false + + + + x component + + + + + y component + + + + + z component + + + + + w component + + + + + + + + + + + + + Interface to encapsulate information required for relayout. + + + + + To make RelayoutContainer instance be disposed. + + + + + Adds relayout information to the container if it doesn't already exist. + + The view to relayout + The size to relayout + + + + Rotation Class + + + + + To make Rotation instance be disposed. + + + + + Addition operator. + + First Rotation + Second Rotation + A Rotation containing the result of the Addition + + + + Subtraction operator. + + First Rotation + Second Rotation + A Rotation containing the result of the subtract + + + + Unary Negation operator. + + First Rotation + A Rotation containing the negated result + + + + Multiplication operator. + + First Rotation + Second Rotation + A Rotation containing the result of the Multiplication + + + + Multiplication operator. + + Rotation + The vector to multiply + A Rotation containing the result of the multiplication + + + + Scale operator. + + Rotation + A value to scale by + A Rotation containing the result of the scaling + + + + Division operator. + + First Rotation + Second Rotation + A Rotation containing the result of the scaling + + + + Scale operator. + + Rotation + A value to scale by + A Rotation containing the result of the scaling + + + + Default Constructor. + + + + + Constructor from an axis and angle. + + The angle around the axis + The vector of the axis + + + + (0.0f,0.0f,0.0f,1.0f) + + + + + Helper to check if this is an identity quaternion. + + True if this is identity quaternion + + + + Converts the quaternion to an axis/angle pair. + + the result of axis + the result of angle Angle in radians + True if converted correctly + + + + Returns the length of the rotation + + The length of the rotation + + + + Returns the squared length of the rotation + + The squared length of the rotation + + + + Normalizes this to unit length. + + + + + Normalized. + + A normalized version of this rotation + + + + Conjugates this rotation. + + + + + Inverts this rotation. + + + + + Performs the logarithm of a rotation + + A rotation representing the logarithm + + + + Performs an exponent + + A rotation representing the exponent + + + + Returns the dot product of two rotations. + + The first rotation + The second rotation + The dot product of the two rotations + + + + Linear Interpolation (using a straight line between the two rotations). + + The start rotation + The end rotation + A progress value between 0 and 1 + The interpolated rotation + + + + Spherical Linear Interpolation (using the shortest arc of a great circle between the two rotations). + + The start rotation + The end rotation + A progress value between 0 and 1 + The interpolated rotation + + + + This version of Slerp, used by Squad, does not check for theta > 90. + + The start rotation + The end rotation + A progress value between 0 and 1 + The interpolated rotation + + + + Spherical Cubic Interpolation. + + The start rotation + The end rotation + The control rotation for q1 + The control rotation for q2 + A progress value between 0 and 1 + The interpolated rotation + + + + Returns the shortest angle between two rotations in Radians. + + The first rotation + The second rotation + The angle between the two rotation + + + + A two dimensional size + + + + + Dispose + + + + + Addition operator for A+B + + Size, A + Size to assign, B + A Size containing the result of the addition + + + + Subtraction operator for A-B + + Size, A + Size to subtract, B + A Size containing the result of the subtraction + + + + Unary negation operator. + + Size for unary negation + A Size containg the negation + + + + Multiplication operator. + + Size for multiplication + The Size to multipl + A Size containing the result of the multiplication + + + + Multiplication operator. + + Size for multiplication + The int value to scale the Size + A Size containing the result of the scaling + + + + Division operator. + + Size for division + The Size to divide + A Size containing the result of the division> + + + + Division operator. + + Size for division + The int value to scale the Size by + A Size containing the result of the scaling + + + + Array subscript operator. + + Subscript index + The float at the given index + + + + Get Size from pointer. + + Pointer of the Size + Size + + + + Constructor. + + + + + Constructor. + + x (or width) component + y (or height) component + + + + + + Property for width component of Size + + + + + Property for height component of Size + + + + + Type cast operator, Size2D to Vector2. + + Object of Size2D type + + + + Type cast operator, Vector2 to Size2D type. + + Object of Vector2 type + + + + Type cast operator, Size2D to Uint16Pair. + + Object of Size2D type + + + + Type cast operator, Uint16Pair to Size2D type. + + Object of Vector2 type + + + + + Dispose + + + + + Style changed event arguments + + + + + StyleManager. + + + + + + + + Gets the singleton of StyleManager object. + + A handle to the StyleManager control + + + + + Applies the default Toolkit theme. + + + + + Sets a constant for use when building styles. + + The key of the constant + The value of the constant + + + + Returns the style constant set for a specific key. + + The key of the constant + The value of the constant if it exists + + + + + Applies the specified style to the control. + + The control to which to apply the style + The name of the JSON style file to apply + The name of the style within the JSON file to apply + + + + A TapGesture is emitted when the user taps the screen with the stated number of fingers a stated number of times. + + + + + Dispose + + + + + Get TapGesture from the pointer. + + The pointer to cast + TapGesture object + + + + Number of taps property (read-only). + + + + + Number of touches property (read-only). + + + + + Screen point property (read-only). + + + + + Local point property (read-only). + + + + + Creates a TapGesture. + + + + + + Event arguments that passed via Tick event. + + + + + + Creates a tick Timer that emits periodic signal. + + Interval in milliseconds + A new timer + + + + + Stops timer. + + + + + + Tells whether timer is running. + + Whether Timer is started or not + + + + + + Returns the time (in ms) that the touch event occurred. + + The time (in ms) that the touch event occurred + + + + Returns the total number of points in this TouchData. + + Total number of Points + + + + + + + + + + + + The Text-to-speech (TTS) Player. + + + + + Gets the singleton of the TtsPlayer for the given mode. + + The mode of tts-player. + A handle of the Ttsplayer for the given mode. + + + + Gets the singleton of the TtsPlayer for the default mode.. + + A handle of the Ttsplayer for the default mode. + + + + Starts playing the audio data synthesized from the specified text. + + The text to play. + The TtsPlayer needs to be initialized. + + + + Stops playing the utterance. + + The TtsPlayer needs to be initialized. + + + + Pauses the currently playing utterance. + + The TtsPlayer needs to be initialized. + + + + Resumes the previously paused utterance. + + The TtsPlayer needs to be initialized. + + + + Gets the current state of the player. + + The current TTS state. + The TtsPlayer needs to be initialized. + + + + State changed argument. + + + + + State changed event. + + + + + Enumeration for the instance of TTS mode. + + + + + Default mode for normal application. + + + + + Notification mode, such as playing utterance is started or completed. + + + + + + Number of Mode. + + + + + Enumeration for the instance of TTS state. + + + + + Player is not available. + + + + + Player is ready to play. + + + + + Player is playing. + + + + + Player is paused. + + + + + + To make Button instance be disposed. + + + + + Clicked will be triggered when the button is touched and the touch point doesn't leave the boundary of the button. + + + + + Pressed will be triggered when the button is touched. + + + + + Released will be triggered when the button is touched and the touch point leaves the boundary of the button. + + + + + StateChanged will be triggered when the button's state is changed. + + + + + Gets/Sets the unselected button foreground/icon visual + + + + + Gets/Sets the selected button foreground/icon visual + + + + + Gets/Sets the disabled selected state foreground/icon button visual + + + + + Gets/Sets the disabled unselected state foreground/icon visual + + + + + Gets/Sets the disabled in the unselected state background, button visual + + + + + Gets/Sets the selected background button visual + + + + + Gets/Sets the disabled while unselected background button visual + + + + + Gets/Sets the disabled while selected background button visual + + + + + Gets/Sets the position of the the label in relation to the foreground/icon if both present + + + + + Gets/Sets the padding around the text + + + + + Gets/Sets the padding around the foreground visual + + + + + + If the autorepeating property is set to true then the togglable property is set to false. + + + + + By default this value is set to 0.15 seconds. + + + + + default this value is set to 0.05 seconds. + + + + + If the togglable property is set to true, then the autorepeating property is set to false. + + + + + /Gets/Sets the togglable button as either selected or unselected, togglable property must be set to true. + + + + + Gets/Sets unselected color. + + + + + Gets/Sets selected color. + + + + + Gets/Sets label. + + + + + Gets/Sets text of label. + + + + + Enumeration for describing the position the text label can be in relation to the control(and foreground/icon). + + + + + At the start of the control before the foreground/icon + + + + + At the end of the control after the foreground/icon + + + + + At the top of the control above the foreground/icon + + + + + At the bottom of the control below the foreground/icon + + + + + + To make CheckBoxButton instance be disposed. + + + + + Creates an initialized CheckBoxButton + + + + + The Popup widget provides a configurable pop-up dialog with built-in layout of three main fields. + + + + + Event arguments that passed via OutsideTouchedEvent + + + + + Event arguments that passed via ShowingEventArgs + + + + + Event arguments that passed via ShownEventArgs + + + + + Event arguments that passed via HidingEventArgs + + + + + Event arguments that passed via HiddenEventArgs + + + + + Event is sent when user has touched outside of the Dialog. + + + + + Event is sent when the Popup is starting to be shown. + + + + + Event is sent when the Popup has been fully displayed. + + + + + Event is sent when the Popup is starting to be hidden. + + + + + Event is sent when the Popup has been completely hidden. + + + + + Create the Popup. + + + + + Sets a title for this Popup. + + The actor to set a title + + + + Sets the content actor. + + The actor to use + + + + Sets the actor to use for a footer in this Popup. + + The footer actor to be added to this Popup + + + + + The display states of the Popup. + + + + + + + Popup title. + + + + + Popup content. + + + + + Popup footer. + + + + + Popup display state. + + + + + Touch transparent. + + + + + Popup tail visibility. + + + + + Popup tail position. + + + + + Contextual mode. + + + + + Animation duration. + + + + + Animation mode. + + + + + Entry animation. + + + + + Exit animation. + + + + + Auto hide delay. + + + + + Backing enabled. + + + + + Backing color. + + + + + Background image. + + + + + Background border. + + + + + Tail up image. + + + + + Tail down image. + + + + + Tail left image. + + + + + Tail right image. + + + + + ProgressBar is a control to give the user an indication of the progress of an operation. + + + + + To make ProgressBar instance be disposed. + + + + + Event arguments that passed via ValueChangedEventArgs + + + + + Event is sent when the ProgressBar value changes. + + + + + Creates the ProgressBar. + + + + + + + Sets the progress-bar as \e indeterminate state. + + + + + + + + + + The Label visual of progress bar. + + + + + A PushButton changes its appearance when is pressed and returns to its original when is released. + + + + + To make PushButton instance be disposed. + + + + + Creates the PushButton. + + + + + Icon located to the left of text. + + + + + Icon located to the right of text. + + + + + Icon located to the top of text. + + + + + Icon located to the bottom of text. + + + + + Icon located to the right of text by default. + + + + + + To make RadioButton instance be disposed. + + + + + Creates an uninitialized RadioButton + + + + + Creates an uninitialized RadioButton with Label + + Label text + + + + + To make ScrollBar instance be disposed. + + + + + Event arguments that passed via PanFinished event + + + + + Event arguments that passed via ScrollPositionIntervalReached event + + + + + current scroll position of the scrollable content + + + + + Event emitted when panning is finished on the scroll indicator. + + + + + Event emitted when the current scroll position of the scrollable content + + + + + Creates an initialized ScrollBar. + + The direction of scroll bar (either vertically or horizontally) + + + + Creates an uninitialized ScrollBar + + + + + Direction of scroll bar + + + + + Indicator height policy. + + + + + Direction of scroll bar + + + + + Indicator height policy. + + + + + the fixed height of scroll indicator. + + + + + the duration in seconds for the scroll indicator to become fully visible. + + + + + the duration in seconds for the scroll indicator to become fully invisible. + + + + + the list of values to get notification when the current scroll position of the scrollable object goes above or below any of these values. + + + + + The minimum height for a variable size indicator. + + + + + The padding at the start of the indicator. For example, the top if scrollDirection is Vertical. + + + + + The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical. + + + + + Slider is a control to enable sliding an indicator between two values. + + + + + Dispose + + + + + Value changed event arguments. + + + + + Slider. + + + + + Slider value. + + + + + Sliding finished event arguments. + + + + + Slider. + + + + + Slider value. + + + + + Mark reached event arguments. + + + + + Slider. + + + + + Slider value. + + + + + Event emitted when the slider value changes. + + + + + Event emitted when the sliding is finished. + + + + + Event emitted when the slider handle reaches a mark. + + + + + Get Slider from the pointer. + + The pointer of Slider + Object of Slider type + + + + Creates the Slider control. + + + + + + Lower bound property + + + + + Upper bound property + + + + + Value property + + + + + Track visual property + + + + + Handle visual property + + + + + Progress visual property + + + + + Popup visual property + + + + + Popup arrow visual property + + + + + Disable color property + + + + + Value presicion property + + + + + Show popup property + + + + + Show value property + + + + + Marks property + + + + + Snap to marks property + + + + + Mark tolerance property + + + + @brief Event arguments that passed via SnapStarted signal + + + + @brief SnapEvent - is the SnapEvent information like snap or flick (it tells the target position, scale, rotation for the snap or flick). + + + + + + A two dimensional vector. + + + + + Addition operator. + + First value + Second value + A vector containing the result of the addition + + + + Subtraction operator. + + First value + Second value + A vector containing the result of the subtraction + + + + Unary negation operator. + + Target Value + A vector containg the negation + + + + Multiplication operator. + + First Value + Second Value + A vector containing the result of the multiplication + + + + Multiplication operator. + + First Value + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + First Value + Second Value + A vector containing the result of the division + + + + Division operator. + + First Value + The float value to scale the vector by + A vector containing the result of the scaling + + + + Array subscript operator overload. + + Subscript index + The float at the given index + + + + Default constructor, initializes the vector to 0. + + + + + Constructor. + + x or width component + y or height component + + + + Conversion constructor from an array of two floats. + + Array of xy + + + + Constructor. + + Vector3 to create this vector from + + + + Constructor. + + Vector4 to create this vector from + + + + (1.0f,1.0f) + + + + + Vector representing the X axis + + + + + Vector representing the Y axis + + + + + Vector representing the negative X axis + + + + + Vector representing the negative Y axis + + + + + (0.0f, 0.0f) + + + + + Returns the length of the vector. + + The length of the vector + + + + + Sets the vector to be unit length, whilst maintaining its direction. + + + + + Clamps the vector between minimum and maximum vectors. + + The minimum vector + The maximum vector + + + + x component + + + + + width + + + + + y component + + + + + height + + + + + A three dimensional vector. + + + + + Addition operator. + + First Value + Second Value + A vector containing the result of the addition + + + + Subtraction operator. + + First Value + Second Value + A vector containing the result of the subtraction + + + + Unary negation operator. + + Target Value + A vector containg the negation + + + + Multiplication operator. + + First Value + Second Value + A vector containing the result of the multiplication + + + + Multiplication operator. + + First Value + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + First Value + Second Value + A vector containing the result of the division + + + + Division operator. + + First Value + The float value to scale the vector by + A vector containing the result of the scaling + + + + Array subscript operator overload. + + Subscript index + The float at the given index + + + + Constructor. + + + + + Default constructor, initializes the vector to 0. + + x (or width) component + y (or height) component + z (or depth) component + + + + Conversion constructor from an array of three floats. + + Array of xyz + + + + Constructor. + + Vector2 to create this vector from + + + + Constructor + + Vector4 to create this vector from + + + + (1.0f,1.0f,1.0f) + + + + + Vector representing the X axis + + + + + Vector representing the Y axis + + + + + Vector representing the Z axis + + + + + Vector representing the negative X axis + + + + + Vector representing the negative Y axis + + + + + Vector representing the negative Z axis + + + + + (0.0f, 0.0f, 0.0f) + + + + + Returns the length of the vector. + + The length of the vector + + + + + Sets the vector to be unit length, whilst maintaining its direction. + + + + + Clamps the vector between minimum and maximum vectors. + + The minimum vector + The maximum vector + + + + + + x component + + + + + width component + + + + + red component + + + + + y component + + + + + height component + + + + + green component + + + + + z component + + + + + depth component + + + + + blue component + + + + + A four dimensional vector. + + + + + Addition operator. + + First value + Second value + A vector containing the result of the addition + + + + Subtraction operator. + + First value + Second value + A vector containing the result of the subtraction + + + + Unary negation operator. + + Target Value + A vector containg the negation + + + + Multiplication operator. + + First Value + Second Value + A vector containing the result of the multiplication + + + + Multiplication operator. + + First Value + The float value to scale the vector + A vector containing the result of the scaling + + + + Division operator. + + First Value + Second Value + A vector containing the result of the division + + + + Division operator. + + First Value + The float value to scale the vector by + A vector containing the result of the scaling + + + + Array subscript operator overload. + + Subscript index + The float at the given index + + + + Default constructor, initializes the vector to 0. + + + + + Conversion constructor from four floats. + + x (or r/s) component + y (or g/t) component + z (or b/p) component + w (or a/q) component + + + + Conversion constructor from an array of four floats. + + array Array of either xyzw/rgba/stpq + + + + Conversion constructor from Vector2. + + Vector2 to copy from, z and w are initialized to 0 + + + + Conversion constructor from Vector3. + + Vector3 to copy from, w is initialized to 0 + + + + (1.0f,1.0f,1.0f,1.0f) + + + + + (1.0f,0.0f,0.0f,0.0f) + + + + + (0.0f,1.0f,0.0f,0.0f) + + + + + (0.0f,0.0f,1.0f,0.0f) + + + + + (0.0f, 0.0f, 0.0f, 0.0f) + + + + + Returns the length of the vector. + + The length + + + + + + Clamps the vector between minimum and maximum vectors. + + The minimum vector + The maximum vector + + + + x component + + + + + red component + + + + + s component + + + + + y component + + + + + green component + + + + + t component + + + + + z component + + + + + blue component + + + + + p component + + + + + w component + + + + + alpha component + + + + + q component + + + + + + Create an empty Visual Handle + + + + + name of the visual + + + + + Sets the transform and the control size + + A property map describing the transform + The size of the parent control for visuals that need to scale internally. + + + + Returns the height for a given width. + + Width to use. + The height based on the width. + + + + Returns the width for a given height. + + Height to use. + The width based on the height. + + + + + the depth index of this visual. + + + + + Create the property map representing this visual. + + + + + VisualFactory is a singleton object that provides and shares visuals between views + + + + + Request the visual + + The map contains the properties required by the visual. The content of the map determines the type of visual that will be returned. + The handle to the created visual + + + + retrieve VisualFactory singleton. + + + + + A class encapsulating the transform map of visual. + + + + + + + + + + + + + + + + + + Get the transform map used by the visual. + + + + + Get the property map to create the visual. + + + + + The shader to use in the visual. + + + + + + Mix color is a blend color for any visual. + + + + + Opacity is the alpha component of the mixColor, above. + + + + + A class encapsulating the property map of a image visual. + + + + + + + + + + + + + + + + A class encapsulating the property map of a text visual. + + + + + + + + + + + + + + A class encapsulating the property map of a border visual. + + + + + + + + A class encapsulating the property map of a color visual. + + + + + + A class encapsulating the property map of a gradient visual. + + + + + + + + + + + + + A class encapsulating the property map of a mesh visual. + + + + + + + + + + + + A class encapsulating the property map of a primetive visual. + + + + + + + + + + + + + + + + + A class encapsulating the property map of a n-patch image visual. + + + + + + + + A class encapsulating the property map of a SVG visual. + + + + + A class encapsulating the property map of a Animated Image(AGIF) visual. + + + + + + The type of the wheel event + + + + + he direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel) + + + + + Modifier keys pressed during the event (such as shift, alt and control) + + + + + The co-ordinates of the cursor relative to the top-left of the screen + + + + + The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise) + + + + + The time the wheel is being rolled + + + + + Default constructor. + + + + + Constructor. + + The type of the wheel event + The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel) + Modifier keys pressed during the event (such as shift, alt and control) + The co-ordinates of the cursor relative to the top-left of the screen + The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise) + The time the wheel is being rolled + + + + Checks to see if Shift key modifier has been supplied. + + True if shift modifier + + + + Checks to see if Ctrl (control) key modifier has been supplied. + + True if ctrl modifier + + + + Checks to see if Alt key modifier has been supplied. + + True if alt modifier + + + + The type of the wheel event + + + + + + To make Button instance be disposed. + + + + + Create a new WidgetView. + + + + + Event arguments of widget view. + + + + + The widet view. + + + + + + + + + + + Pauses a given widget. + + true on success, false otherwise. + + + + Resume a given widget. + + true on success, false otherwise. + + + + Cancels touch event procedure. + If you call this function after feed the touch down event, the widget will get ON_HOLD events. + If a widget gets ON_HOLD event, it will not do anything even if you feed touch up event. + + true on success, false otherwise. + + + + Activate a widget in faulted state. + A widget in faulted state MUST be activated before adding the widget. + + + + + Gets the id of widget. + + + + + Gets the id of instance. + + + + + Gets the content info. + + + + + Gets the title. + + + + + Gets the update peroid. + + + + + Gets/sets the preview. + + + + + Gets/sets the loading text. + + + + + Gets/sets whether the widget state is faulted or not. + + + + + Gets/sets whether the widget is permanent delete or not. + + + + + WidgetViewManager manages addition of WidgetView controls. + This class provides the functionality of adding the widget views and controlling the widgets. + + + + + To make WidgetViewManager instance be disposed. + + + + + Creates a new widget view object. + + The widget id. + Contents that will be given to the widget instance. + The widget width. + The widget height. + The period of updating contents of the widget. + A handle to WidgetView. + + + + + To make Window instance be disposed. + + + + + Sets whether window accepts focus or not. + + If focus is accepted or not. Default is true. + + + + Returns whether window accepts focus or not. + + True if the window accept focus, false otherwise + + + + Shows the window if it is hidden. + + + + + Hides the window if it is showing. + + + + + Retrieves whether the window is visible or not. + + true, if the windoe is visible + + + + Gets the count of supported auxiliary hints of the window. + + The number of supported auxiliary hints. + + + + Gets the supported auxiliary hint string of the window. + + The index of the supported auxiliary hint lists. + The auxiliary hint string of the index. + + + + Creates an auxiliary hint of the window. + + The auxiliary hint string. + The value string. + The ID of created auxiliary hint, or 0 on failure. + + + + Removes an auxiliary hint of the window. + + The ID of the auxiliary hint. + True if no error occurred, false otherwise. + + + + Changes a value of the auxiliary hint. + + The auxiliary hint ID. + The value string to be set. + True if no error occurred, false otherwise. + + + + Gets a value of the auxiliary hint. + + The auxiliary hint ID. + The string value of the auxiliary hint ID, or an empty string if none exists. + + + + Gets an ID of the auxiliary hint string. + + The auxiliary hint string. + The ID of auxiliary hint string, or 0 on failure. + + + + Sets a region to accept input events. + + The region to accept input events. + + + + Gets/Sets a window type. + + + + + Sets a priority level for the specified notification window. + + The notification window level. + True if no error occurred, false otherwise. + + + + Gets a priority level for the specified notification window. + + The notification window level. + + + + Sets a transparent window's visual state to opaque. + + Whether the window's visual state is opaque. + + + + Returns whether a transparent window's visual state is opaque or not. + + True if the window's visual state is opaque, false otherwise. + + + + Sets a window's screen mode. + + The screen mode. + True if no error occurred, false otherwise. + + + + Gets a screen mode of the window. + + The screen mode. + + + + Sets preferred brightness of the window. + + The preferred brightness (0 to 100). + True if no error occurred, false otherwise. + + + + Gets preffered brightness of the window. + + The preffered brightness. + + + + Raises window to the top of Window stack. + + + + + Lowers window to the bottom of Window stack. + + + + + Activates window to the top of Window stack even it is iconified. + + + + + Get default ( root ) layer. + + The root layer + + + + Queries the number of on-window layers. + + The number of layers. + Note that a default layer is always provided (count >= 1). + + + + Keep rendering for at least the given amount of time. + + Time to keep rendering, 0 means render at least one more frame + + + + + + + + + Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing. + + + + + Enumeration for key grab mode for platform-level APIs. + + + + + Grab a key only when on the top of the grabbing-window stack mode. + + + + + Grab a key together with the other client window(s) mode. + + + + + Grab a key exclusively regardless of the grabbing-window's position on the window stack with the possibility of overriding the grab by the other client window mode. + + + + + Grab a key exclusively regardless of the grabbing-window's position on the window stack mode. + + + + + Enumeration for opacity of the indicator. + + + + + Enumeration for visible mode of the indicator. + + + + + Touch event argument. + + + + + Touch. + + + + + + Wheel event arguments. + + + + + Wheel. + + + + + Event emitted when wheel event is received. + + + + + Key event arguments. + + + + + Key + + + + + Event emitted when key event is received. + + + + + Window size property (read-only). + + + + + Background color property. + + + + + + + Add layer to the Stage. + + Layer to add + + + + Remove layer from the Stage. + + Layer to remove + + + + Gets/Sets a size of the window. + + + + + Gets/Sets a position of the window. + + + + diff --git a/Artifacts/bin/Tizen.Network.Bluetooth.dll b/Artifacts/bin/Tizen.Network.Bluetooth.dll index a3ba163..b7e123f 100644 Binary files a/Artifacts/bin/Tizen.Network.Bluetooth.dll and b/Artifacts/bin/Tizen.Network.Bluetooth.dll differ diff --git a/Artifacts/bin/Tizen.Network.Bluetooth.pdb b/Artifacts/bin/Tizen.Network.Bluetooth.pdb index c44bbac..b7719cb 100644 Binary files a/Artifacts/bin/Tizen.Network.Bluetooth.pdb and b/Artifacts/bin/Tizen.Network.Bluetooth.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Bluetooth.xml b/Artifacts/bin/Tizen.Network.Bluetooth.xml index 39e53d2..044c109 100644 --- a/Artifacts/bin/Tizen.Network.Bluetooth.xml +++ b/Artifacts/bin/Tizen.Network.Bluetooth.xml @@ -1,3510 +1,3510 @@ - - - - Tizen.Network.Bluetooth - - - - - - A property to check whether the Bluetooth is enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - The local adapter address. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - The name of the local adapter. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - The visibility mode of the Bluetooth adapter. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - A property to check whether the device discovery process is in progress. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - The remaining time, in seconds, until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - The StateChanged event is raised when the Bluetooth adapter state is changed. - - - - - The NameChanged event is raised when the Bluetooth adapter name is changed. - - - - - The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed. - - - - - The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable. - - - - - The DiscoveryStateChanged event is raised when the device discovery state is changed. - - - - - This event is called when the LE scan result is obtained. - - - - - Starts the device discovery process. - - - The Bluetooth must be enabled and the device discovery process can be stopped by StopDiscovery(). - If this succeeds, the DiscoveryStateChanged event will be invoked. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or the start discovery fails. - - - - Stops the device discovery process. - - - The device discovery process must be in progress with StartDiscovery(). - If this succeeds, the DiscoveryStateChanged event will be invoked. - - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled or - the discovery process is not is progress. - - - - Retrieves the device information of all bonded devices. - - - The Bluetooth must be enabled. - - The list of the bonded BluetoothDeviceInfo objects. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or reading the Bonded devices list is failed. - - - - Gets the device information of a bonded device. - - - The Bluetooth must be enabled. - - Information of the bonded BluetoothDeviceInfo object. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or reading the bonded device information fails. - - - - Checks whether the UUID of service is used or not. - - true if the specified serviceUuid is used, otherwise false. - The UUID of Service. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - - - - Gets the hash and the randomizer value of the local OOB data object. - - - The Bluetooth must be enabled. - - The BluetoothOobData object. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or the read OObData procedure is failed. - - - - Sets the hash and the randmoizer value of the OOB data into the remote device. - - - The Bluetooth must be enabled. - - The remote device address. - The BluetoothOobData object. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or the set OobData procedure is failed. - - - - Removes the hash and the randomizer value of the OOB data from the remote device. - - - The Bluetooth must be enabled. - - The remote device address. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled. - or if the Remove Oobdata procedure is failed. - - - - Starts the Bluetooth LE scan operation to discover BLE devices - - - The Bluetooth must be enabled. - The result of the operation StartLeScan. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or the Start LE scan is failed. - - - - Stops the Bluetooth LE scan operation. - - - The Bluetooth must be enabled. - The result of the operation stopLescan. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or the Stop LE scan is failed. - - - - Returns the BluetoothLeAdvertiser instance. - - - The Bluetooth must be enabled before calling this API. - - The BluetoothLeAdvertiser instance. - - - - Registers a rfcomm server socket with a specific UUID. - - - The Bluetooth must be enabled before calling this API. - - The BluetoothServerSocket instance. - The UUID of service to provide. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or the socket create error occurs. - - - - Removes the rfcomm server socket which was created using CreateServerSocket(). - - - The socket must be created with CreateServerSocket(). The ConnectionStateChanged event is raised after this API is called. - - The server socket instance is created using CreateServerSocket(). - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or the socket destroy error occurs. - - - - This class is used to handle the connection with other Bluetooth audio devices - like headset, hands-free, and headphone. - - http://tizen.org/privilege/bluetooth - - - - The AudioConnectionStateChanged event is called when the audio connection state is changed. - - - - - - - This class is used to notify changes of the target device (For example, media player) to the control device (For example, headset). - - http://tizen.org/privilege/bluetooth - - - - The TargetConnectionStateChanged event is invoked when the connection state is changed. - - - - - The EqualizerStateChanged event is invoked when the equalizer state is changed by the remote control device. - - - - - The RepeatModeChanged event is invoked when the repeat mode is changed by the remote control device. - - - - - The ShuffleModeChanged event is invoked when the shuffle mode is changed by the remote control device. - - - - - The ScanModeChanged event is invoked when the scan mode is changed by the remote control device. - - - - - Notifies the equalize state to the remote device. - - - The remote device must be connected. - - The equalizer state. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the equalizer state to the remote device fails. - - - - - Notifies the shuffle mode to the remote device. - - - The remote device must be connected. - - The shuffle mode. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the shuffle mode state to the remote device fails. - - - - Notifies the scan mode to the remote device. - - - The remote device must be connected. - - The scan mode. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the scan mode state to the remote device fails. - - - - Notifies the player state to the remote device. - - - The remote device must be connected. - - The player state. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the player state to the remote device fails. - - - - Notifies the current position of the song to the remote device. - - - The remote device must be connected. - - The current position in milliseconds. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the current position state to the remote device fails. - - - - Notifies the track to the remote device. - - - The remote device must be connected. - - The data of the track. - Thrown when the Bluetooth is not supported. - Thrown when the Bluetooth is not enabled - or when notifying the shuffle track state to the remote device fails. - - - - This class is used to handle the device class types and the service. - - - - - The type of the major device class. - - - - - The type of the minor device class. - - - - - The major service class mask. - - - - - This class contains the information of the Bluetooth OOB data. - - - - - The default constructor. Initializes an object of the BluetoothOobData. - - - - - The hash value. - - - - - The randomizer value. - - - - - This class contains the information of the Bluetooth device SDP data. - - - - - The device address. - - - - - The service UUID. - - - - - This class contains the information of the Bluetooth device connection data. - - - - - The device address. - - - - - The type of the connection link. - - - - - The disconnect reason. - - - - - This class contains the information of the track data. - - - - - The default constructor. Initializes an object of the track. - - - - - The title of the track. - - - - - The artist of the track. - - - - - The album of the track. - - - - - The genre of the track. - - - - - The track number. - - - - - The number of all tracks. - - - - - The duration of the track in milliseconds. - - - - - This class contains the information of the manufacturer data. - - - - - The default Constructor. Initializes an object of the ManufacturerData. - - - - - The manufacturer ID. - - - - - The length of the manufacturer data. - - - - - The manufacturer data. - - - - - This class contains the information of the Bluetooth service data. - - - - - The default constructor. Initializes an object of the BluetoothServiceData. - - - - - The UUID of the service. - - - - - The data length of the service data. - - - - - The service data. - - - - - This class contains the service data information. - - - - - The Bluetooth LE service UUID. - - - - - The Bluetooth LE service data. - - - - - The length of the service data. - - - - - This class contains the information of the socket data. - - - - - The socket FD. - - - - - The length of the received data. - - - - - The received data. - - - - - This class contains the information of the socket connection. - - - - - The connected socket FD. - - - - - The remote device address. - - - - - The service UUID. - - - - - - The address of the device. - - - - - The name of the device. - - - - - The strength indicator of received signal of the device. - - - - - The class of the device. - - - - - The service UUID list of the device. - - - - - The number of services. - - - - - The paired state of the device. - - - - - The connection state of the device. - - - - - The authorization state of the device. - - - - - The Bluetooth appearance. - - - - - The length of the manufacturer data. - - - - - The manufacturer data. - - - - - The BondCreated event is raised when the process of creating the bond is finished. - - - - - The BondDestroyed event is raised when the bond is destroyed. - - - - - The AuthorizationChanged event is raised when the authorization of the device is changed. - - - - - The ServiceSearched event is raised when the process of service searched is finished. - - - - - The ConnectionStateChanged event is raised when the connection state is changed. - - - - - Creates a bond with the remote Bluetooth device. - - - The Bluetooth must be enabled and the remote device must be discoverable by StartDiscovery(). The bond can be destroyed by DestroyBond(). - The bonding request can be cancelled by CancelBonding(). If this succeeds, the BondCreated event will be invoked. - - Thrown when the BT/BTLE is not enabled - or when the create bonding process to the remote device fails. - - - - Cancels the bonding process. - - - Bonding must be in progress by CreateBond(). - - Thrown when the BT/BTLE is not enabled - or when the cancel bonding procedure to remote device fails. - - - - Destroys the bond. - - - The Bluetooth must be enabled and the bond must be created by CreateBond(). - If this succeeds, the BondDestroyed event will be invoked. - - Thrown when the BT/BTLE is not enabled - or when the destroy bonding procedure fails. - - - - Sets an alias for the bonded device. - - - The Bluetooth must be enabled and the bond must be created by CreateBond(). - - The alias name of the remote device. - Thrown when the BT/BTLE is not enabled - or when the set alias name to remote device fails. - - - - Sets the authorization of a bonded device. - - - The Bluetooth must be enabled and the bond must be created by CreateBond(). - If this succeeds, the AuthorizationChanged event will be invoked. - - The authorization state. - Thrown when the BT/BTLE is not enabled - or when the set authorization to remote device fails. - - - - Gets the mask from the UUID. - - The service mask list converted from the given UUID list. - The UUID list of the device. - Thrown when the BT/BTLE is not enabled - or when the get Mask from UUID fails. - - - - Starts the search for services supported by the specified device. - - - The Bluetooth must be enabled and remote device must be discoverable by StartDiscovery(). The bond must be created by CreateBond(). - If this succeeds, the ServiceSearched event will be invoked. - - Thrown when the BT/BTLE is not enabled - or when the remote device service search fails. - - - - Gets the connected profiles. - - - The Bluetooth must be enabled. - - The connected Bluetooth profiles. - Thrown when the BT/BTLE is not enabled - or when there is no BT connection. - - - - Determines if profile is connected to the specified remote device. - - - The Bluetooth must be enabled. - - true if profile is connected, otherwise false. - The Bluetooth profile type. - Thrown when the BT/BTLE is not enabled - or when there is no BT connection. - - - - Returns the instance of the Bluetooth profile type. - - - The Bluetooth must be enabled. - - - - - Creates the client socket. - - The IBluetoothClientSocket instance. - The UUID of the service. - - - - Enumeration for the Bluetooth states. - - - - - The disabled state. - - - - - The enabled state. - - - - - Enumeration for the Bluetooth errors. - - - - - Successful. - - - - - Operation canceled. - - - - - Invalid parameter. - - - - - Out of memory. - - - - - Device or resource busy. - - - - - Timeout error. - - - - - Operation now in progress. - - - - - Bluetooth is not supported. - - - - - Permission denied. - - - - - Quota exceeded. - - - - - No data available. - - - - - Local adapter not initialized. - - - - - Local adapter not enabled. - - - - - Operation already done. - - - - - Operation failed. - - - - - Operation not in progress. - - - - - Remote device not bonded. - - - - - Authentication rejected. - - - - - Authentication failed. - - - - - Remote device not found. - - - - - Service search failed. - - - - - Remote device is not connected. - - - - - Resource temporarily unavailable. - - - - - Service Not Found. - - - - - Enumeration for the Bluetooth visibility modes. - - - - - The non-discoverable mode. - - - - - The discoverable mode. - - - - - The discoverable mode with limited time. - - - - - Enumeration for the Bluetooth major device class types. - - - - - The miscellaneous major class type. - - - - - The computer major class type. - - - - - The phone major class type. - - - - - The LAN/Network access point major class type. - - - - - The audio/video major class type. - - - - - The peripheral major class type. - - - - - The imaging major class type. - - - - - The wearable major class type. - - - - - The toy major class type. - - - - - The health major class type. - - - - - The uncategorized major class type. - - - - - Enumeration for the Bluetooth minor device class types. - - - - - The uncategorized computer minor class type. - - - - - The desktop workstation computer minor class type. - - - - - The server computer minor class type. - - - - - The laptop computer minor class type. - - - - - The handheld PC/PDA computer minor class type. - - - - - The palm sized PC/PDA computer minor class type. - - - - - The wearable computer minor class type. - - - - - The unclassified phone minor class type. - - - - - The cellular phone minor class type. - - - - - The cordless phone minor class type. - - - - - The smartphone phone minor class type. - - - - - The wired modem or voice gateway phone minor class type. - - - - - The ISDN phone minor class type. - - - - - Fully available LAN/Network access point minor class type. - - - - - 1-17% utilized LAN/Network access point minor class type. - - - - - 17-33% utilized LAN/Network access point minor class type. - - - - - 33-50% utilized LAN/Network access point minor class type. - - - - - 50-67% utilized LAN/Network access point minor class type. - - - - - 67-83% utilized LAN/Network access point minor class type. - - - - - 83-99% utilized LAN/Network access point minor class type. - - - - - No service available LAN/Network access point minor class type. - - - - - The uncategorized audio/video minor class type. - - - - - The wearable headset audio/video minor class type. - - - - - The hands free audio/video minor class type. - - - - - The microphone audio/video minor class type. - - - - - The loudspeaker audio/video minor class type. - - - - - The headphones audio/video minor class type. - - - - - The portable audio audio/video minor class type. - - - - - The car audio audio/video minor class type. - - - - - The SetTopbox audio/video minor class type. - - - - - The Hi-Fi audio/video minor class type. - - - - - The VCR audio/video minor class type. - - - - - The video camera audio/video minor class type. - - - - - Camcorder audio/video minor class type. - - - - - The video monitor audio/video minor class type. - - - - - The video display and loudspeaker audio/video minor class type. - - - - - The video conferencing audio/video minor class type. - - - - - The gaming/toy audio/video minor class type. - - - - - The uncategorized peripheral minor class type. - - - - - The keyboard peripheral minor class type. - - - - - The pointing device peripheral minor class type. - - - - - The combo keyboard peripheral minor class type. - - - - - The joystick peripheral minor class type. - - - - - The game pad peripheral minor class type. - - - - - The remote control peripheral minor class type. - - - - - The sensing device peripheral minor class type. - - - - - The digitizer peripheral minor class type. - - - - - The card reader peripheral minor class type. - - - - - The digital pen peripheral minor class type. - - - - - The handheld scanner peripheral minor class type. - - - - - The handheld gestural input computer minor class type. - - - - - The display imaging minor class type. - - - - - The camera imaging minor class type. - - - - - The scanner imaging minor class type. - - - - - The printer imaging minor class type. - - - - - The wrist watch wearable minor class type. - - - - - The pager wearable minor class type. - - - - - The jacket wearable minor class type. - - - - - The helmet wearable minor class type. - - - - - The glasses wearable minor class type. - - - - - The robot toy minor class type. - - - - - The vehicle toy minor class type. - - - - - The doll toy minor class type. - - - - - The controller toy minor class type. - - - - - The game toy minor class type. - - - - - The uncategorized health minor class type. - - - - - The BP monitor health minor class type. - - - - - The thermometer health minor class type. - - - - - The scale health minor class type. - - - - - The glucose meter health minor class type. - - - - - The pulse oximeter health minor class type. - - - - - The heart/pulse rate monitor health minor class type. - - - - - The display health minor class type. - - - - - The step counter health minor class type. - - - - - The body composition analyzer health minor class type. - - - - - The peak flow monitor health minor class type. - - - - - The medication monitor health minor class type. - - - - - The knee prosthesis health minor class type. - - - - - The ankle prosthesis health minor class type. - - - - - Enumeration for the Bluetooth device discovery states. - - - - - The device discovery is started. - - - - - The device discovery is finished. - - - - - The remote device is found. - - - - - Enumeration for the Bluetooth appearance types. - - - - - Unknown. - - - - - Generic phone. - - - - - Generic computer. - - - - - Generic watch. - - - - - Enumeration for the Bluetooth audio profile types. - - - - - All supported profiles of audio. - - - - - The Headset and Hands-Free profile. - - - - - The Advanced Audio Distribution profile. - - - - - The Audio Gateway profile. - - - - - The Advanced Audio Distribution profile sink role. - - - - - Enumeration for the Bluetooth service class types. - - - - - No service class. - - - - - The RES service class. - - - - - The SPP service class. - - - - - The DUN service class. - - - - - The FAX service class. - - - - - The LAP service class. - - - - - The HSP service class. - - - - - The HFPservice class. - - - - - The OPP service class. - - - - - The FTP service class. - - - - - The CTP service class. - - - - - The ICP service class. - - - - - The Sync service class. - - - - - The BPP service class. - - - - - The BIP service class. - - - - - The PANU service class. - - - - - The NAP service class. - - - - - The GN service class. - - - - - The SAP service class. - - - - - The A2DP service class. - - - - - The AVRCP service class. - - - - - The PBAP service class. - - - - - The HID service class. - - - - - The A2DP Source service class. - - - - - All service class. - - - - - The Max service class. - - - - - Enumeration for the Bluetooth profile types. - - - - - The RFCOMM profile. - - - - - The Advanced Audio Distribution Profile Source role. - - - - - The Headset profile. - - - - - The Human Interface Device profile. - - - - - The Network Access Point profile. - - - - - The Audio Gateway profile. - - - - - The Generic Attribute profile. - - - - - The NAP Server profile. - - - - - The advanced Audio Distribution profile sink role. - - - - - Enumeration for the Bluetooth authorization types. - - - - - The authorized type. - - - - - The unauthorized type. - - - - - Enumeration for the Bluetooth connection link types. - - - - - The BR/EDR link. - - - - - The LE link. - - - - - The default connection type. - - - - - Enumeration for the Bluetooth disconnect reason. - - - - - The disconnected by unknown reason. - - - - - The disconnected by timeout. - - - - - The disconnected by local host. - - - - - The disconnected by remote. - - - - - Enumeration for the connected Bluetooth device event roles. - - - - - Unknown role. - - - - - The server role. - - - - - The client role. - - - - - Enumeration for the Bluetooth socket connection states. - - - - - The RFCOMM is connected. - - - - - The RFCOMM is disconnected. - - - - - Enumeration for the equalizer states. - - - - - Equalizer Off. - - - - - Equalizer On. - - - - - Enumeration for the repeat modes. - - - - - Repeat off. - - - - - Single track repeat. - - - - - All track repeat. - - - - - Group repeat. - - - - - Enumeration for the shuffle modes. - - - - - Shuffle off. - - - - - All tracks shuffle. - - - - - Group shuffle. - - - - - Enumeration for the scan modes. - - - - - Scan off. - - - - - All tracks scan. - - - - - Group scan. - - - - - Enumeration for the player states. - - - - - The stopped state. - - - - - The playing state. - - - - - The paused state. - - - - - The seek forward state. - - - - - The seek rewind state. - - - - - Enumeration for the Bluetooth LE device address types. - - - - - The Buetooth LE public address. - - - - - The Bluetooth LE private address. - - - - - Enumeration for the Bluetooth LePacket types. - - - - - The Bluetooth LE advertising packet. - - - - - The Bluetooth LE scan response packet. - - - - - Enumeration for the Bluetooth LE data types. - - - - - The Bluetooth LE packet data list 16 bit service uuid. - - - - - The Bluetooth LE packet manufacturer data. - - - - - Enumeration for the Bluetooth LE advertising mode types. - - - - - The Bluetooth LE advertising balanced mode. - - - - - The Bluetooth LE advertising low latency mode. - - - - - The Bluetooth LE advertising low energy mode. - - - - - Enumeration for the Bluetooth LE advertising mode type. - - - - - The Bluetooth LE advertising stopped. - - - - - The Bluetooth LE advertising started. - - - - - Enumeration for the integer type for GATT handle's values. - - - - - The 8-bit signed integer type. - - - - - The 16-bit signed integer type. - - - - - The 32-bit signed integer type. - - - - - The 8-bit unsigned integer type. - - - - - The 16-bit unsigned integer type. - - - - - The 32-bit unsigned integer type. - - - - - Enumerations of the float type for GATT handle's values. - - - - - The 32-bit float type. - - - - - The 16-bit float type. - - - - - Enumeration for the GATT handle's types. - - - - - The GATT service type. - - - - - The GATT characteristic type. - - - - - The GATT descriptor type. - - - - - Enumeration for the service types. - - - - - The GATT primary service type. - - - - - The GATT secondary service type. - - - - - Enumeration for the characteristic's property. - - - - - The broadcast property. - - - - - The read property. - - - - - The write without response property. - - - - - The write property. - - - - - The notify property. - - - - - The indicate property. - - - - - The authenticated signed writes property. - - - - - The extended properties. - - - - - Enumeration for the Bluetooth GATT permission types. - - - - - Read permission. - - - - - Write permission. - - - - - Enumeration for the write types. - - - - - The write without response. - - - - - The write with response. - - - - - Enumeration for the remote device request types for attributes. - - - - - Read requested. - - - - - Write requested. - - - - - An extended EventArgs class contains the changed Bluetooth state. - - - - - The state of Bluetooth. - - - - - The BluetoothError result. - - - - - An extended EventArgs class contains the changed Bluetooth name. - - - - - The name of the device. - - - - - An extended EventArgs class contains the changed Bluetooth visibility mode. - - - - - The visibility mode. - - - - - The BluetoothError result. - - - - - An extended EventArgs class contains the duration until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable. - - - - - The duration. - - - - - An extended EventArgs class contains the changed Bluetooth device discovery state and the discovered device information. - - - - - The BluetoothError result. - - - - - The state of the discovery. - - - - - The remote device found. - - - - - An extended EventArgs class contains the bonded device information. - - - - - The BluetoothError result. - - - - - The remote device. - - - - - An extended EventArgs class contains the address of the remote Bluetooth device to destroy bond with. - - - - - The BluetoothError result. - - - - - The remote device address. - - The device address. - - - - An extended EventArgs class contains the authorization state and the address of the remote Bluetooth device. - - - - - The authorization. - - - - - The device address. - - - - - An extended EventArgs class contains the service lists found on the remote Bluetooth device. - - - - - The BluetoothError result. - - - - - The sdp data. - - - - - An extended EventArgs class contains the connection state and the connection information of the remote device. - - - - - A value indicating whether the device is connected. - - - - - The device connection data. - - - - - An extended EventArgs class contains the data received information. - - - - - The socket data. - - - - - An extended EventArgs class contains the changed connection state. - - - - - The BluetoothError result. - - - - - The socket state. - - - - - The socket connection. - - - - - The BluetoothError result. - - - - - The socket state. - - - - - The socket connection. - - - - - The server socket instance. - - - - - An extended EventArgs class contains the connection state, remote address, and the type of audio profile. - - - - - The result. - - - - - A value indicating whether this instance is connected. - - - - - The address. - - - - - The type of the audio profile. - - - - - An extended EventArgs class contains the connection state and the address of the remote Bluetooth device. - - - - - The result. - - - - - A value indicating whether this instance is connected. - - - - - The address. - - - - - An extended EventArgs class contains the changed equalizer state. - - - - - The state of the equalizer. - - - - - An extended EventArgs class contains the changed repeat mode. - - - - - The repeat mode. - - - - - An extended EventArgs class contains the changed shuffle mode. - - - - - The shuffle mode. - - - - - An extended EventArgs class contains the changed scan mode. - - - - - The scan mode. - - - - - An extended EventArgs class contains the connection state and the remote device address. - - - - - A value indicating whether this instance is connected. - - - - - The address. - - - - - An extended EventArgs class contains the changed Bluetooth LE advertising state changed information. - - - - - The result. - - - - - The advertiser handle. - - - - - The LE advertising state. - - - - - An extended EventArgs class contains the changed Bluetooth LE scan result information. - - - - - The result. - - - - - The LE device data. - - - - - An extended EventArgs class contains the changed Bluetooth LE GATT connection state. - - - - - The result. - - - - - A value indicating whether this instance is connected. - - - - - The remote address. - - - - - An extended EventArgs class contains the changed attribute value. - - - - - The attribute value. - - - - - An extended EventArgs class contains the read value request data. - - - - - The GATT server instance. - - - - - The client address. - - - - - The request identifier. - - - - - The offset. - - - - - An extended EventArgs class contains the read value request data. - - - - - The GATT server instance. - - - - - The client address. - - - - - The request identifier. - - - - - The read value. - - - - - The offset. - - - - - Indicates whether a response is required by the remote device. - - - - - An extended EventArgs class contains the client preference to enable or disable the Notification/Indication. - - - - - The GATT server instance. - - - - - A value indicating whether the notification is enabled. - - - - - An extended EventArgs class contains the read value request data. - - - - - The GATT server instance. - - - - - The client address. - - - - - The result. - - - - - Gets a value indicating whether the notification sent is completed. - - - - - The Bluetooth GATT server. - - - - - (event) This event is called when the indication acknowledgement is received for each notified client. - - - - - Creates the Bluetooth GATT server. - - - Thrown when the BT/BTLE is not supported. - Thrown when the create GATT server fails. - - - - Registers the server along with the GATT services of the application it is hosting. - - Thrown when the BT/BTLE is not supported. - Thrown when the register server application fails. - - - - Registers a specified service to this server. - - The service, which needs to be registered with this server. - Thrown when the BT/BTLE is not supported. - Thrown when the register service fails. - - - - Unregisters a specified service from this server. - - The service, which needs to be unregistered from this server. - - Once unregistered, the service object will become invalid and should not be used to access sevices or any children attribute's methods/members. - - Thrown when the BT/BTLE is not supported. - Thrown when the unregister service fails. - - - - Unregisters all services from this server. - - - Once unregistered, servicees will become invalid and should not be used to access sevices or any children attribute's methods/members. - - Thrown when the BT/BTLE is not supported. - Thrown when the unregister all services fail. - - - - Gets service with given UUID that belongs to this server. - - The UUID for the service to get. - The Service with the given UUID if it exists, null otherwise. - - - - Gets the list of services that belongs to this server. - - The list of services that belongs to this server. - - - - Sends indication for the value change of the characteristic to the remote devices. - - The characteristic whose the value is changed. - The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. - - - - Sends the notification for the value change of the characteristic to the remote devices. - - The characteristic, which has a changed value. - The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. - - - - Sends a response to the remote device as a result of a read/write request. - - The identification of a read/write request. - The request type for read/write. - The error value in case of failure, 0 for success. - The value to be sent. - The offset from where the value is read. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or the send response procedure fails. - - - - The Bluetooth GATT client. - - - - - The address of the remote device. - - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected. - - - - Gets the service with the given UUID that belongs to the remote device. - - The UUID for the service to get. - The service with the given UUID if it exists, null otherwise. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when the get service fails. - - - - Gets list of services that belongs to the remote device. - - The list of services that belongs to the remote device. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when the get service fails. - - - - Reads the value of a given characteristic from the remote device asynchronously. - - The characteristic to be read. - true on success, false otherwise. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when the read attribute value fails. - - - - Reads the value of the given descriptor from the remote device asynchronously. - - The descriptor to be read. - true on success, false otherwise. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when the read attribute value fails. - - - - Writes the value of a given characteristic to the remote device asynchronously. - - The characteristic to be written. - true on success, false otherwise. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected or when the write attribute value fails. - - - - Writes the value of the given descriptor to the remote device asynchronously. - - The descriptor to be written. - true on success, false otherwise. - Thrown when the BT/BTLE is not enabled - or when the remote device is disconnected, or when the write attribute value fails. - - - - The Bluetooth GATT service. - - - - - The constructor. - - The UUID of the service. - The type of service. - Thrown when the create GATT service procedure fails. - - - - Specification name from the UUID. - - - - - Adds a characteristic to this service. - - The characteristic to be added. - true on success, false otherwise. - Thrown when the add GATT characteristic procedure fails. - - - - Gets the characteristic with the given UUID that belongs to this service. - - The UUID for the characteristic to get. - The characteristic with a given UUID if it exists, null otherwise. - - - - Gets list of the characteristic that belongs to this service. - - The list of the characteristic that belongs to this service. - - - - Includes a service to this service. - - The service to be included. - true on success, false otherwise - Thrown when the add GATT service procedure fails./// - - - - Gets the included service. - - The UUID for the service to get. - The service with a given UUID if it exists, null otherwise. - - - - Gets the included service list of this service. - - The included service list of this service. - - - - Gets the server instance which the specified service belongs to. - - The server instance which the specified service belongs to. - - - - Gets the client instance which the specified service belongs to. - - The client instance which the specified service belongs to. - - - - The Bluetooth GATT characteristic. - - - - - - The CharacteristicValueChanged event is raised when the server notifies for change in this characteristic value. - - - Adding the event handle on characteristic on the server side will not have any effect. - - - - - The NotificationStateChanged event is called when the client enables or disables the Notification/Indication for particular characteristics. - - - Adding event handle on the characteristic on the client side will not have any effect. - - - - - The property for this characteristic. - - - - - The write type to be used for write operations. - - - - - Adds a descriptor to this characteristic. - - The descriptor to be added. - true on success, false otherwise. - Thrown when the add GATT descriptor procedure fails. - - - - Gets the descriptor with the given UUID that belongs to this characteristic. - - The UUID for the descriptor to get. - The descriptor with a given UUID if it exists, null otherwise. - - - - Gets the list of descriptors that belongs to this characteristic. - - The list of descriptors that belongs to this characteristic. - - - - Gets the service instance, which the specified characterstic belongs to. - - The characteristic instance, the specified characterstic belongs to. - - - - The Bluetooth GATT descriptor. - - - - - The constructor. - - The UUID of the descriptor. - Permissions for the descriptor. - The value associated with the descriptor. - throws in case of internal error. - Thrown when the create GATT descriptor procedure fails. - - - - Gets the characteristic instance, which the specified descriptor belongs to. - - The characteristic instance, the specified descriptor belongs to. - - - - The Bluetooth GATT attribute. - - - - - This event is called when the client request to read the value of a characteristic or a descriptor. - - Thrown when the set read value requested callback procedure fails. - - - - This event is called when a value of a characteristic or a descriptor has been changed by a client. - - Thrown when the set write value requested callback procedure fails. - - - - The attribute's UUID. - - - - - Permissions for this attribute. - - - - - The value of this descriptor. - - - - - Returns a string value at the specified offset. - - - The string value at specified offset. - - - - Sets the string value as a specified offset. - - value to set - Throws exception if the value is null. - - - - Returns a value at specified offset as the int value of the specified type. - - The type of the int value. - An offset in the attribute value buffer. - The int value at given offset. - Throws exception if (offset + size of int value) is greater than the length of the value buffer. - - - - Updates a value at the specified offset by the int value of the specified type. - - The type of the int value. - The value to set. - An offset in the attribute value buffer. - Throws exception if (offset + size of int value) is greater than the length of the value buffer. - - - - Returns a value at the specified offset as the float value of the specified type. - - The type of the float value. - An offset in the attribute value buffer. - The float value at given offset. - Throws exception if (offset + size of float value) is greater than the length of the value buffer. - - - - Updates the value at the specified offset by the float value of the specified type. - - The type of the float value. - The mantissa of the float value. - An exponent of the float value. - An offset in the attribute value buffer. - Throws exception if (offset + size of float value) is greater than the length of the value buffer. - - - - A class which is used to handle the connection to Bluetooth HID like keyboards and mouse. - - http://tizen.org/privilege/bluetooth - - - - The HidConnectionStateChanged event is called when the HID host connection state is changed. - - - - - Connects the remote device with the HID service. - - - The device must be bonded with the remote device by CreateBond(). - If connection request succeeds, the HidConnectionStateChanged event will be invoked. - - Thrown when the Bluetooth is not enabled - or when the connection attempt to the remote device fails. - - - - Disconnects the remote device with the HID service. - - Thrown when the Bluetooth is not enabled - or when the disconnection attempt to the remote device fails. - - - - This is the BluetoothLeAdvertiser class. It handles the LE advertising operation amd callback. - - - - - This event is called when the LE advertising state changes. - - - - - Starts advertising using the advertise data object. - - - The Bluetooth must be enabled. - - The advertiser object carrying information of the advertising. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Stops the advertising. - - - The Bluetooth must be enabled. - - The advertiser object carrying information of the advertising. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - This is the BluetoothLeDevice class. - It handles the LE device operations like getting data from the scan result information. - - - - - This event is called when the GATT client connects/disconnects with the server. - - - - - The remote address. - - - - - The type of the address. - - - - - The rssi value. - - - - - The advertsing data information. - - - - - The scan data information. - - - - - The type of the packet. - - - - - Gets the service UUIDs list from the LE scan result information. - - Gets the list of the string service UUIDs. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Gets the device name from the LE scan result information. - - Gets the device name. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Gets the transmission power level from the LE scan result information. - - Gets the transmission power level in dB. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Gets the service solicitation UUID list from the scan result information. - - Gets the list of the service solicitation UUIDs. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Gets the manufacturer data from the scan result information. - - Gets the appearance value. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Gets the manufacturer data from the scan result information. - - Gets the manufacturer data containing the manucturer data and ID information. - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled./// - - - - Gets the service data list from the scan result information. - - - The Bluetooth must be enabled. - - Returns the service data list. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled. - - - - Creates a GATT connection with the remote device. - - - The Bluetooth must be enabled. - - The auto connect flag. - client instance - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the gatt connection attempt to remote device fails. - - - - Disconnects a GATT connection with the remote device. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the GATT disconnection attempt to remote device fails. - - - - Bluetooth LE advertise data. Handles the data advertising. - - - - - The default constructor initializes an object of the BluetoothLeAdvertiseData. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when create advertiser fails. - - - - The advertising mode to control the advertising power and latency. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the set advertising mode fails. - - - - The advertising connectable type. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the set advertising connectable mode fails. - - - - The type of the packet. - - - - - Sets the external appearance of this device to the advertise or the scan response data. - Please refer to the adopted Bluetooth specification for the appearance. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the set appearance fails. - - - - Sets whether the device name has to be included in the advertise or the scan response data. - The maximum advertised or responded data size is 31 bytes including the data type and the system wide data. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the set advertising device name fails. - - - - Sets whether the transmission power level should be included in the advertise or the scan response data. - The maximum advertised or responded data size is 31 bytes including the data type and the system wide data. - - - The Bluetooth must be enabled. - - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the set advertising TC power level fails. - - - - Adds a service UUID to the advertise or the scan response data. - The maximum advertised or responded data size is 31 bytes - including the data type and the system wide data. - - - The Bluetooth must be enabled. - - The packet type. - The service UUID to add to advertise data. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the add advertising service UUID procedure fails. - - - - Adds a service solicitation UUID to advertise or scan the response data. - The maximum advertised or responded data size is 31 bytes - including the data type and the system wide data. - - - The Bluetooth must be enabled. - - The packet type. - The service solicitation UUID to add to advertise data. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the add advertising service solicitation UUID procedure fails. - - - - Adds a service data to the advertise or the scan response data. - The maximum advertised or responded data size is 31 bytes - including data type and system wide data. - - - The Bluetooth must be enabled. - - The packet type. - The service data to be added to advertising. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the add advertising data procedure fails. - - - - Adds the manufacturer specific data to the advertise or the scan response data. - Please refer to the adopted Bluetooth specification for the the appearance. - - - The Bluetooth must be enabled. - - The packet type. - The manufacturer specific data. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the add advertising manufacturer data procedure fails. - - - - Clears all data to be advertised or responded to the scan request from the LE scanning device. - - - The Bluetooth must be enabled. - - The packet type to be cleared. - Thrown when the Bluetooth LE is not supported. - Thrown when the Bluetooth LE is not enabled - or when the clear advertising data procedure fails. - - - - - The BluetoothSocket provides functions for managing connections to other devices and exchanging data. - - - - - The AcceptStateChanged event is raised when the socket connection state is changed. - - Thrown when the Bluetooth is not enabled - or when the register accpet state changed callback fails. - - - - Starts listening on the passed RFCOMM socket and accepts connection requests. - - - The socket must be created with CreateServerSocket(). This API invokes the ConnectionStateChanged event. - - Thrown when the Bluetooth is not enabled - or when the listen on socket procedure fails. - - - - The IBluetoothServerSocket interface handles the server socket operations. - - - - - The IBluetoothClientSocket interface handles the client socket operations. - - - - - This event occurs when the socket server receives data from the client. - - Thrown when the Bluetooth is not enabled - or when the register data received callback fails. - - - - This event occurs when the connection state between two devices is changed. - - Thrown when the Bluetooth is not enabled - or when the register connection changed callback fails. - - - - Connects to a specific RFCOMM based service on a remote Bluetooth device UUID. - - - The bluetooth must be enabled, discoverable with StartDiscovery(), and bonded with the remote device using CreateBond(). The ConnectionStateChanged event is raised once this API is called. - - The address of the remote Bluetooth device. - The UUID of the service provided by the remote Bluetooth device. - Thrown when the Bluetooth is not enabled - or when the connect socket attempt to remote device fails, or when the service UUID is not supported by the remote device. - - - - Disconnects the RFCOMM connection with the given file descriptor of the conneted socket. - - - The connection must be established. - - The file descriptor of the socket to close. - Thrown when the Bluetooth is not enabled - or when the socket disconnect to remote device fails. - - - - Sends data to the connected device. - - The number of bytes written (zero indicates nothing was written). - - The connection must be established. - - The file descriptor of the connected socket. - The data to be sent. - Thrown when the Bluetooth is not enabled - or when the remote device is not connected, or the send data procedure fails. - - - - The structure of the device class type and service. - - - - - The type of the major device class. - - - - - The type of the minor device class. - - - - - The major service class mask. - - - - - This structure contains the information of the Bluetooth device. - - - - - The address of the device. - - - - - The name of the device. - - - - - The class of the device. - - - - - The service UUID list of the device. - - - - - The service count of the device. - - - - - The paired state of the device. - - - - - The connection state of the device. - - - - - The authorization state of the device. - - - - - The length of the manufacturer the data. - - - - - The manufacturer data. - - - - - - The Bluetooth LE service UUID. - - - - - The Bluetooth LE service data. - - - - + + + + Tizen.Network.Bluetooth + + + + + + A property to check whether the Bluetooth is enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + The local adapter address. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + The name of the local adapter. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + The visibility mode of the Bluetooth adapter. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + A property to check whether the device discovery process is in progress. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + The remaining time, in seconds, until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + The StateChanged event is raised when the Bluetooth adapter state is changed. + + + + + The NameChanged event is raised when the Bluetooth adapter name is changed. + + + + + The VisibilityModeChanged event is raised when the Bluetooth adapter visibility mode is changed. + + + + + The VisibilityDurationChanged event is raised very second until the visibility mode is changed to NonDiscoverable. + + + + + The DiscoveryStateChanged event is raised when the device discovery state is changed. + + + + + This event is called when the LE scan result is obtained. + + + + + Starts the device discovery process. + + + The Bluetooth must be enabled and the device discovery process can be stopped by StopDiscovery(). + If this succeeds, the DiscoveryStateChanged event will be invoked. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or the start discovery fails. + + + + Stops the device discovery process. + + + The device discovery process must be in progress with StartDiscovery(). + If this succeeds, the DiscoveryStateChanged event will be invoked. + + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled or + the discovery process is not is progress. + + + + Retrieves the device information of all bonded devices. + + + The Bluetooth must be enabled. + + The list of the bonded BluetoothDeviceInfo objects. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or reading the Bonded devices list is failed. + + + + Gets the device information of a bonded device. + + + The Bluetooth must be enabled. + + Information of the bonded BluetoothDeviceInfo object. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or reading the bonded device information fails. + + + + Checks whether the UUID of service is used or not. + + true if the specified serviceUuid is used, otherwise false. + The UUID of Service. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + + + + Gets the hash and the randomizer value of the local OOB data object. + + + The Bluetooth must be enabled. + + The BluetoothOobData object. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or the read OObData procedure is failed. + + + + Sets the hash and the randmoizer value of the OOB data into the remote device. + + + The Bluetooth must be enabled. + + The remote device address. + The BluetoothOobData object. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or the set OobData procedure is failed. + + + + Removes the hash and the randomizer value of the OOB data from the remote device. + + + The Bluetooth must be enabled. + + The remote device address. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled. + or if the Remove Oobdata procedure is failed. + + + + Starts the Bluetooth LE scan operation to discover BLE devices + + + The Bluetooth must be enabled. + The result of the operation StartLeScan. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or the Start LE scan is failed. + + + + Stops the Bluetooth LE scan operation. + + + The Bluetooth must be enabled. + The result of the operation stopLescan. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or the Stop LE scan is failed. + + + + Returns the BluetoothLeAdvertiser instance. + + + The Bluetooth must be enabled before calling this API. + + The BluetoothLeAdvertiser instance. + + + + Registers a rfcomm server socket with a specific UUID. + + + The Bluetooth must be enabled before calling this API. + + The BluetoothServerSocket instance. + The UUID of service to provide. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or the socket create error occurs. + + + + Removes the rfcomm server socket which was created using CreateServerSocket(). + + + The socket must be created with CreateServerSocket(). The ConnectionStateChanged event is raised after this API is called. + + The server socket instance is created using CreateServerSocket(). + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or the socket destroy error occurs. + + + + This class is used to handle the connection with other Bluetooth audio devices + like headset, hands-free, and headphone. + + http://tizen.org/privilege/bluetooth + + + + The AudioConnectionStateChanged event is called when the audio connection state is changed. + + + + + + + This class is used to notify changes of the target device (For example, media player) to the control device (For example, headset). + + http://tizen.org/privilege/bluetooth + + + + The TargetConnectionStateChanged event is invoked when the connection state is changed. + + + + + The EqualizerStateChanged event is invoked when the equalizer state is changed by the remote control device. + + + + + The RepeatModeChanged event is invoked when the repeat mode is changed by the remote control device. + + + + + The ShuffleModeChanged event is invoked when the shuffle mode is changed by the remote control device. + + + + + The ScanModeChanged event is invoked when the scan mode is changed by the remote control device. + + + + + Notifies the equalize state to the remote device. + + + The remote device must be connected. + + The equalizer state. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the equalizer state to the remote device fails. + + + + + Notifies the shuffle mode to the remote device. + + + The remote device must be connected. + + The shuffle mode. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the shuffle mode state to the remote device fails. + + + + Notifies the scan mode to the remote device. + + + The remote device must be connected. + + The scan mode. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the scan mode state to the remote device fails. + + + + Notifies the player state to the remote device. + + + The remote device must be connected. + + The player state. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the player state to the remote device fails. + + + + Notifies the current position of the song to the remote device. + + + The remote device must be connected. + + The current position in milliseconds. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the current position state to the remote device fails. + + + + Notifies the track to the remote device. + + + The remote device must be connected. + + The data of the track. + Thrown when the Bluetooth is not supported. + Thrown when the Bluetooth is not enabled + or when notifying the shuffle track state to the remote device fails. + + + + This class is used to handle the device class types and the service. + + + + + The type of the major device class. + + + + + The type of the minor device class. + + + + + The major service class mask. + + + + + This class contains the information of the Bluetooth OOB data. + + + + + The default constructor. Initializes an object of the BluetoothOobData. + + + + + The hash value. + + + + + The randomizer value. + + + + + This class contains the information of the Bluetooth device SDP data. + + + + + The device address. + + + + + The service UUID. + + + + + This class contains the information of the Bluetooth device connection data. + + + + + The device address. + + + + + The type of the connection link. + + + + + The disconnect reason. + + + + + This class contains the information of the track data. + + + + + The default constructor. Initializes an object of the track. + + + + + The title of the track. + + + + + The artist of the track. + + + + + The album of the track. + + + + + The genre of the track. + + + + + The track number. + + + + + The number of all tracks. + + + + + The duration of the track in milliseconds. + + + + + This class contains the information of the manufacturer data. + + + + + The default Constructor. Initializes an object of the ManufacturerData. + + + + + The manufacturer ID. + + + + + The length of the manufacturer data. + + + + + The manufacturer data. + + + + + This class contains the information of the Bluetooth service data. + + + + + The default constructor. Initializes an object of the BluetoothServiceData. + + + + + The UUID of the service. + + + + + The data length of the service data. + + + + + The service data. + + + + + This class contains the service data information. + + + + + The Bluetooth LE service UUID. + + + + + The Bluetooth LE service data. + + + + + The length of the service data. + + + + + This class contains the information of the socket data. + + + + + The socket FD. + + + + + The length of the received data. + + + + + The received data. + + + + + This class contains the information of the socket connection. + + + + + The connected socket FD. + + + + + The remote device address. + + + + + The service UUID. + + + + + + The address of the device. + + + + + The name of the device. + + + + + The strength indicator of received signal of the device. + + + + + The class of the device. + + + + + The service UUID list of the device. + + + + + The number of services. + + + + + The paired state of the device. + + + + + The connection state of the device. + + + + + The authorization state of the device. + + + + + The Bluetooth appearance. + + + + + The length of the manufacturer data. + + + + + The manufacturer data. + + + + + The BondCreated event is raised when the process of creating the bond is finished. + + + + + The BondDestroyed event is raised when the bond is destroyed. + + + + + The AuthorizationChanged event is raised when the authorization of the device is changed. + + + + + The ServiceSearched event is raised when the process of service searched is finished. + + + + + The ConnectionStateChanged event is raised when the connection state is changed. + + + + + Creates a bond with the remote Bluetooth device. + + + The Bluetooth must be enabled and the remote device must be discoverable by StartDiscovery(). The bond can be destroyed by DestroyBond(). + The bonding request can be cancelled by CancelBonding(). If this succeeds, the BondCreated event will be invoked. + + Thrown when the BT/BTLE is not enabled + or when the create bonding process to the remote device fails. + + + + Cancels the bonding process. + + + Bonding must be in progress by CreateBond(). + + Thrown when the BT/BTLE is not enabled + or when the cancel bonding procedure to remote device fails. + + + + Destroys the bond. + + + The Bluetooth must be enabled and the bond must be created by CreateBond(). + If this succeeds, the BondDestroyed event will be invoked. + + Thrown when the BT/BTLE is not enabled + or when the destroy bonding procedure fails. + + + + Sets an alias for the bonded device. + + + The Bluetooth must be enabled and the bond must be created by CreateBond(). + + The alias name of the remote device. + Thrown when the BT/BTLE is not enabled + or when the set alias name to remote device fails. + + + + Sets the authorization of a bonded device. + + + The Bluetooth must be enabled and the bond must be created by CreateBond(). + If this succeeds, the AuthorizationChanged event will be invoked. + + The authorization state. + Thrown when the BT/BTLE is not enabled + or when the set authorization to remote device fails. + + + + Gets the mask from the UUID. + + The service mask list converted from the given UUID list. + The UUID list of the device. + Thrown when the BT/BTLE is not enabled + or when the get Mask from UUID fails. + + + + Starts the search for services supported by the specified device. + + + The Bluetooth must be enabled and remote device must be discoverable by StartDiscovery(). The bond must be created by CreateBond(). + If this succeeds, the ServiceSearched event will be invoked. + + Thrown when the BT/BTLE is not enabled + or when the remote device service search fails. + + + + Gets the connected profiles. + + + The Bluetooth must be enabled. + + The connected Bluetooth profiles. + Thrown when the BT/BTLE is not enabled + or when there is no BT connection. + + + + Determines if profile is connected to the specified remote device. + + + The Bluetooth must be enabled. + + true if profile is connected, otherwise false. + The Bluetooth profile type. + Thrown when the BT/BTLE is not enabled + or when there is no BT connection. + + + + Returns the instance of the Bluetooth profile type. + + + The Bluetooth must be enabled. + + + + + Creates the client socket. + + The IBluetoothClientSocket instance. + The UUID of the service. + + + + Enumeration for the Bluetooth states. + + + + + The disabled state. + + + + + The enabled state. + + + + + Enumeration for the Bluetooth errors. + + + + + Successful. + + + + + Operation canceled. + + + + + Invalid parameter. + + + + + Out of memory. + + + + + Device or resource busy. + + + + + Timeout error. + + + + + Operation now in progress. + + + + + Bluetooth is not supported. + + + + + Permission denied. + + + + + Quota exceeded. + + + + + No data available. + + + + + Local adapter not initialized. + + + + + Local adapter not enabled. + + + + + Operation already done. + + + + + Operation failed. + + + + + Operation not in progress. + + + + + Remote device not bonded. + + + + + Authentication rejected. + + + + + Authentication failed. + + + + + Remote device not found. + + + + + Service search failed. + + + + + Remote device is not connected. + + + + + Resource temporarily unavailable. + + + + + Service Not Found. + + + + + Enumeration for the Bluetooth visibility modes. + + + + + The non-discoverable mode. + + + + + The discoverable mode. + + + + + The discoverable mode with limited time. + + + + + Enumeration for the Bluetooth major device class types. + + + + + The miscellaneous major class type. + + + + + The computer major class type. + + + + + The phone major class type. + + + + + The LAN/Network access point major class type. + + + + + The audio/video major class type. + + + + + The peripheral major class type. + + + + + The imaging major class type. + + + + + The wearable major class type. + + + + + The toy major class type. + + + + + The health major class type. + + + + + The uncategorized major class type. + + + + + Enumeration for the Bluetooth minor device class types. + + + + + The uncategorized computer minor class type. + + + + + The desktop workstation computer minor class type. + + + + + The server computer minor class type. + + + + + The laptop computer minor class type. + + + + + The handheld PC/PDA computer minor class type. + + + + + The palm sized PC/PDA computer minor class type. + + + + + The wearable computer minor class type. + + + + + The unclassified phone minor class type. + + + + + The cellular phone minor class type. + + + + + The cordless phone minor class type. + + + + + The smartphone phone minor class type. + + + + + The wired modem or voice gateway phone minor class type. + + + + + The ISDN phone minor class type. + + + + + Fully available LAN/Network access point minor class type. + + + + + 1-17% utilized LAN/Network access point minor class type. + + + + + 17-33% utilized LAN/Network access point minor class type. + + + + + 33-50% utilized LAN/Network access point minor class type. + + + + + 50-67% utilized LAN/Network access point minor class type. + + + + + 67-83% utilized LAN/Network access point minor class type. + + + + + 83-99% utilized LAN/Network access point minor class type. + + + + + No service available LAN/Network access point minor class type. + + + + + The uncategorized audio/video minor class type. + + + + + The wearable headset audio/video minor class type. + + + + + The hands free audio/video minor class type. + + + + + The microphone audio/video minor class type. + + + + + The loudspeaker audio/video minor class type. + + + + + The headphones audio/video minor class type. + + + + + The portable audio audio/video minor class type. + + + + + The car audio audio/video minor class type. + + + + + The SetTopbox audio/video minor class type. + + + + + The Hi-Fi audio/video minor class type. + + + + + The VCR audio/video minor class type. + + + + + The video camera audio/video minor class type. + + + + + Camcorder audio/video minor class type. + + + + + The video monitor audio/video minor class type. + + + + + The video display and loudspeaker audio/video minor class type. + + + + + The video conferencing audio/video minor class type. + + + + + The gaming/toy audio/video minor class type. + + + + + The uncategorized peripheral minor class type. + + + + + The keyboard peripheral minor class type. + + + + + The pointing device peripheral minor class type. + + + + + The combo keyboard peripheral minor class type. + + + + + The joystick peripheral minor class type. + + + + + The game pad peripheral minor class type. + + + + + The remote control peripheral minor class type. + + + + + The sensing device peripheral minor class type. + + + + + The digitizer peripheral minor class type. + + + + + The card reader peripheral minor class type. + + + + + The digital pen peripheral minor class type. + + + + + The handheld scanner peripheral minor class type. + + + + + The handheld gestural input computer minor class type. + + + + + The display imaging minor class type. + + + + + The camera imaging minor class type. + + + + + The scanner imaging minor class type. + + + + + The printer imaging minor class type. + + + + + The wrist watch wearable minor class type. + + + + + The pager wearable minor class type. + + + + + The jacket wearable minor class type. + + + + + The helmet wearable minor class type. + + + + + The glasses wearable minor class type. + + + + + The robot toy minor class type. + + + + + The vehicle toy minor class type. + + + + + The doll toy minor class type. + + + + + The controller toy minor class type. + + + + + The game toy minor class type. + + + + + The uncategorized health minor class type. + + + + + The BP monitor health minor class type. + + + + + The thermometer health minor class type. + + + + + The scale health minor class type. + + + + + The glucose meter health minor class type. + + + + + The pulse oximeter health minor class type. + + + + + The heart/pulse rate monitor health minor class type. + + + + + The display health minor class type. + + + + + The step counter health minor class type. + + + + + The body composition analyzer health minor class type. + + + + + The peak flow monitor health minor class type. + + + + + The medication monitor health minor class type. + + + + + The knee prosthesis health minor class type. + + + + + The ankle prosthesis health minor class type. + + + + + Enumeration for the Bluetooth device discovery states. + + + + + The device discovery is started. + + + + + The device discovery is finished. + + + + + The remote device is found. + + + + + Enumeration for the Bluetooth appearance types. + + + + + Unknown. + + + + + Generic phone. + + + + + Generic computer. + + + + + Generic watch. + + + + + Enumeration for the Bluetooth audio profile types. + + + + + All supported profiles of audio. + + + + + The Headset and Hands-Free profile. + + + + + The Advanced Audio Distribution profile. + + + + + The Audio Gateway profile. + + + + + The Advanced Audio Distribution profile sink role. + + + + + Enumeration for the Bluetooth service class types. + + + + + No service class. + + + + + The RES service class. + + + + + The SPP service class. + + + + + The DUN service class. + + + + + The FAX service class. + + + + + The LAP service class. + + + + + The HSP service class. + + + + + The HFPservice class. + + + + + The OPP service class. + + + + + The FTP service class. + + + + + The CTP service class. + + + + + The ICP service class. + + + + + The Sync service class. + + + + + The BPP service class. + + + + + The BIP service class. + + + + + The PANU service class. + + + + + The NAP service class. + + + + + The GN service class. + + + + + The SAP service class. + + + + + The A2DP service class. + + + + + The AVRCP service class. + + + + + The PBAP service class. + + + + + The HID service class. + + + + + The A2DP Source service class. + + + + + All service class. + + + + + The Max service class. + + + + + Enumeration for the Bluetooth profile types. + + + + + The RFCOMM profile. + + + + + The Advanced Audio Distribution Profile Source role. + + + + + The Headset profile. + + + + + The Human Interface Device profile. + + + + + The Network Access Point profile. + + + + + The Audio Gateway profile. + + + + + The Generic Attribute profile. + + + + + The NAP Server profile. + + + + + The advanced Audio Distribution profile sink role. + + + + + Enumeration for the Bluetooth authorization types. + + + + + The authorized type. + + + + + The unauthorized type. + + + + + Enumeration for the Bluetooth connection link types. + + + + + The BR/EDR link. + + + + + The LE link. + + + + + The default connection type. + + + + + Enumeration for the Bluetooth disconnect reason. + + + + + The disconnected by unknown reason. + + + + + The disconnected by timeout. + + + + + The disconnected by local host. + + + + + The disconnected by remote. + + + + + Enumeration for the connected Bluetooth device event roles. + + + + + Unknown role. + + + + + The server role. + + + + + The client role. + + + + + Enumeration for the Bluetooth socket connection states. + + + + + The RFCOMM is connected. + + + + + The RFCOMM is disconnected. + + + + + Enumeration for the equalizer states. + + + + + Equalizer Off. + + + + + Equalizer On. + + + + + Enumeration for the repeat modes. + + + + + Repeat off. + + + + + Single track repeat. + + + + + All track repeat. + + + + + Group repeat. + + + + + Enumeration for the shuffle modes. + + + + + Shuffle off. + + + + + All tracks shuffle. + + + + + Group shuffle. + + + + + Enumeration for the scan modes. + + + + + Scan off. + + + + + All tracks scan. + + + + + Group scan. + + + + + Enumeration for the player states. + + + + + The stopped state. + + + + + The playing state. + + + + + The paused state. + + + + + The seek forward state. + + + + + The seek rewind state. + + + + + Enumeration for the Bluetooth LE device address types. + + + + + The Buetooth LE public address. + + + + + The Bluetooth LE private address. + + + + + Enumeration for the Bluetooth LePacket types. + + + + + The Bluetooth LE advertising packet. + + + + + The Bluetooth LE scan response packet. + + + + + Enumeration for the Bluetooth LE data types. + + + + + The Bluetooth LE packet data list 16 bit service uuid. + + + + + The Bluetooth LE packet manufacturer data. + + + + + Enumeration for the Bluetooth LE advertising mode types. + + + + + The Bluetooth LE advertising balanced mode. + + + + + The Bluetooth LE advertising low latency mode. + + + + + The Bluetooth LE advertising low energy mode. + + + + + Enumeration for the Bluetooth LE advertising mode type. + + + + + The Bluetooth LE advertising stopped. + + + + + The Bluetooth LE advertising started. + + + + + Enumeration for the integer type for GATT handle's values. + + + + + The 8-bit signed integer type. + + + + + The 16-bit signed integer type. + + + + + The 32-bit signed integer type. + + + + + The 8-bit unsigned integer type. + + + + + The 16-bit unsigned integer type. + + + + + The 32-bit unsigned integer type. + + + + + Enumerations of the float type for GATT handle's values. + + + + + The 32-bit float type. + + + + + The 16-bit float type. + + + + + Enumeration for the GATT handle's types. + + + + + The GATT service type. + + + + + The GATT characteristic type. + + + + + The GATT descriptor type. + + + + + Enumeration for the service types. + + + + + The GATT primary service type. + + + + + The GATT secondary service type. + + + + + Enumeration for the characteristic's property. + + + + + The broadcast property. + + + + + The read property. + + + + + The write without response property. + + + + + The write property. + + + + + The notify property. + + + + + The indicate property. + + + + + The authenticated signed writes property. + + + + + The extended properties. + + + + + Enumeration for the Bluetooth GATT permission types. + + + + + Read permission. + + + + + Write permission. + + + + + Enumeration for the write types. + + + + + The write without response. + + + + + The write with response. + + + + + Enumeration for the remote device request types for attributes. + + + + + Read requested. + + + + + Write requested. + + + + + An extended EventArgs class contains the changed Bluetooth state. + + + + + The state of Bluetooth. + + + + + The BluetoothError result. + + + + + An extended EventArgs class contains the changed Bluetooth name. + + + + + The name of the device. + + + + + An extended EventArgs class contains the changed Bluetooth visibility mode. + + + + + The visibility mode. + + + + + The BluetoothError result. + + + + + An extended EventArgs class contains the duration until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable. + + + + + The duration. + + + + + An extended EventArgs class contains the changed Bluetooth device discovery state and the discovered device information. + + + + + The BluetoothError result. + + + + + The state of the discovery. + + + + + The remote device found. + + + + + An extended EventArgs class contains the bonded device information. + + + + + The BluetoothError result. + + + + + The remote device. + + + + + An extended EventArgs class contains the address of the remote Bluetooth device to destroy bond with. + + + + + The BluetoothError result. + + + + + The remote device address. + + The device address. + + + + An extended EventArgs class contains the authorization state and the address of the remote Bluetooth device. + + + + + The authorization. + + + + + The device address. + + + + + An extended EventArgs class contains the service lists found on the remote Bluetooth device. + + + + + The BluetoothError result. + + + + + The sdp data. + + + + + An extended EventArgs class contains the connection state and the connection information of the remote device. + + + + + A value indicating whether the device is connected. + + + + + The device connection data. + + + + + An extended EventArgs class contains the data received information. + + + + + The socket data. + + + + + An extended EventArgs class contains the changed connection state. + + + + + The BluetoothError result. + + + + + The socket state. + + + + + The socket connection. + + + + + The BluetoothError result. + + + + + The socket state. + + + + + The socket connection. + + + + + The server socket instance. + + + + + An extended EventArgs class contains the connection state, remote address, and the type of audio profile. + + + + + The result. + + + + + A value indicating whether this instance is connected. + + + + + The address. + + + + + The type of the audio profile. + + + + + An extended EventArgs class contains the connection state and the address of the remote Bluetooth device. + + + + + The result. + + + + + A value indicating whether this instance is connected. + + + + + The address. + + + + + An extended EventArgs class contains the changed equalizer state. + + + + + The state of the equalizer. + + + + + An extended EventArgs class contains the changed repeat mode. + + + + + The repeat mode. + + + + + An extended EventArgs class contains the changed shuffle mode. + + + + + The shuffle mode. + + + + + An extended EventArgs class contains the changed scan mode. + + + + + The scan mode. + + + + + An extended EventArgs class contains the connection state and the remote device address. + + + + + A value indicating whether this instance is connected. + + + + + The address. + + + + + An extended EventArgs class contains the changed Bluetooth LE advertising state changed information. + + + + + The result. + + + + + The advertiser handle. + + + + + The LE advertising state. + + + + + An extended EventArgs class contains the changed Bluetooth LE scan result information. + + + + + The result. + + + + + The LE device data. + + + + + An extended EventArgs class contains the changed Bluetooth LE GATT connection state. + + + + + The result. + + + + + A value indicating whether this instance is connected. + + + + + The remote address. + + + + + An extended EventArgs class contains the changed attribute value. + + + + + The attribute value. + + + + + An extended EventArgs class contains the read value request data. + + + + + The GATT server instance. + + + + + The client address. + + + + + The request identifier. + + + + + The offset. + + + + + An extended EventArgs class contains the read value request data. + + + + + The GATT server instance. + + + + + The client address. + + + + + The request identifier. + + + + + The read value. + + + + + The offset. + + + + + Indicates whether a response is required by the remote device. + + + + + An extended EventArgs class contains the client preference to enable or disable the Notification/Indication. + + + + + The GATT server instance. + + + + + A value indicating whether the notification is enabled. + + + + + An extended EventArgs class contains the read value request data. + + + + + The GATT server instance. + + + + + The client address. + + + + + The result. + + + + + Gets a value indicating whether the notification sent is completed. + + + + + The Bluetooth GATT server. + + + + + (event) This event is called when the indication acknowledgement is received for each notified client. + + + + + Creates the Bluetooth GATT server. + + + Thrown when the BT/BTLE is not supported. + Thrown when the create GATT server fails. + + + + Registers the server along with the GATT services of the application it is hosting. + + Thrown when the BT/BTLE is not supported. + Thrown when the register server application fails. + + + + Registers a specified service to this server. + + The service, which needs to be registered with this server. + Thrown when the BT/BTLE is not supported. + Thrown when the register service fails. + + + + Unregisters a specified service from this server. + + The service, which needs to be unregistered from this server. + + Once unregistered, the service object will become invalid and should not be used to access sevices or any children attribute's methods/members. + + Thrown when the BT/BTLE is not supported. + Thrown when the unregister service fails. + + + + Unregisters all services from this server. + + + Once unregistered, servicees will become invalid and should not be used to access sevices or any children attribute's methods/members. + + Thrown when the BT/BTLE is not supported. + Thrown when the unregister all services fail. + + + + Gets service with given UUID that belongs to this server. + + The UUID for the service to get. + The Service with the given UUID if it exists, null otherwise. + + + + Gets the list of services that belongs to this server. + + The list of services that belongs to this server. + + + + Sends indication for the value change of the characteristic to the remote devices. + + The characteristic whose the value is changed. + The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. + + + + Sends the notification for the value change of the characteristic to the remote devices. + + The characteristic, which has a changed value. + The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. + + + + Sends a response to the remote device as a result of a read/write request. + + The identification of a read/write request. + The request type for read/write. + The error value in case of failure, 0 for success. + The value to be sent. + The offset from where the value is read. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or the send response procedure fails. + + + + The Bluetooth GATT client. + + + + + The address of the remote device. + + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected. + + + + Gets the service with the given UUID that belongs to the remote device. + + The UUID for the service to get. + The service with the given UUID if it exists, null otherwise. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when the get service fails. + + + + Gets list of services that belongs to the remote device. + + The list of services that belongs to the remote device. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when the get service fails. + + + + Reads the value of a given characteristic from the remote device asynchronously. + + The characteristic to be read. + true on success, false otherwise. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when the read attribute value fails. + + + + Reads the value of the given descriptor from the remote device asynchronously. + + The descriptor to be read. + true on success, false otherwise. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when the read attribute value fails. + + + + Writes the value of a given characteristic to the remote device asynchronously. + + The characteristic to be written. + true on success, false otherwise. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected or when the write attribute value fails. + + + + Writes the value of the given descriptor to the remote device asynchronously. + + The descriptor to be written. + true on success, false otherwise. + Thrown when the BT/BTLE is not enabled + or when the remote device is disconnected, or when the write attribute value fails. + + + + The Bluetooth GATT service. + + + + + The constructor. + + The UUID of the service. + The type of service. + Thrown when the create GATT service procedure fails. + + + + Specification name from the UUID. + + + + + Adds a characteristic to this service. + + The characteristic to be added. + true on success, false otherwise. + Thrown when the add GATT characteristic procedure fails. + + + + Gets the characteristic with the given UUID that belongs to this service. + + The UUID for the characteristic to get. + The characteristic with a given UUID if it exists, null otherwise. + + + + Gets list of the characteristic that belongs to this service. + + The list of the characteristic that belongs to this service. + + + + Includes a service to this service. + + The service to be included. + true on success, false otherwise + Thrown when the add GATT service procedure fails./// + + + + Gets the included service. + + The UUID for the service to get. + The service with a given UUID if it exists, null otherwise. + + + + Gets the included service list of this service. + + The included service list of this service. + + + + Gets the server instance which the specified service belongs to. + + The server instance which the specified service belongs to. + + + + Gets the client instance which the specified service belongs to. + + The client instance which the specified service belongs to. + + + + The Bluetooth GATT characteristic. + + + + + + The CharacteristicValueChanged event is raised when the server notifies for change in this characteristic value. + + + Adding the event handle on characteristic on the server side will not have any effect. + + + + + The NotificationStateChanged event is called when the client enables or disables the Notification/Indication for particular characteristics. + + + Adding event handle on the characteristic on the client side will not have any effect. + + + + + The property for this characteristic. + + + + + The write type to be used for write operations. + + + + + Adds a descriptor to this characteristic. + + The descriptor to be added. + true on success, false otherwise. + Thrown when the add GATT descriptor procedure fails. + + + + Gets the descriptor with the given UUID that belongs to this characteristic. + + The UUID for the descriptor to get. + The descriptor with a given UUID if it exists, null otherwise. + + + + Gets the list of descriptors that belongs to this characteristic. + + The list of descriptors that belongs to this characteristic. + + + + Gets the service instance, which the specified characterstic belongs to. + + The characteristic instance, the specified characterstic belongs to. + + + + The Bluetooth GATT descriptor. + + + + + The constructor. + + The UUID of the descriptor. + Permissions for the descriptor. + The value associated with the descriptor. + throws in case of internal error. + Thrown when the create GATT descriptor procedure fails. + + + + Gets the characteristic instance, which the specified descriptor belongs to. + + The characteristic instance, the specified descriptor belongs to. + + + + The Bluetooth GATT attribute. + + + + + This event is called when the client request to read the value of a characteristic or a descriptor. + + Thrown when the set read value requested callback procedure fails. + + + + This event is called when a value of a characteristic or a descriptor has been changed by a client. + + Thrown when the set write value requested callback procedure fails. + + + + The attribute's UUID. + + + + + Permissions for this attribute. + + + + + The value of this descriptor. + + + + + Returns a string value at the specified offset. + + + The string value at specified offset. + + + + Sets the string value as a specified offset. + + value to set + Throws exception if the value is null. + + + + Returns a value at specified offset as the int value of the specified type. + + The type of the int value. + An offset in the attribute value buffer. + The int value at given offset. + Throws exception if (offset + size of int value) is greater than the length of the value buffer. + + + + Updates a value at the specified offset by the int value of the specified type. + + The type of the int value. + The value to set. + An offset in the attribute value buffer. + Throws exception if (offset + size of int value) is greater than the length of the value buffer. + + + + Returns a value at the specified offset as the float value of the specified type. + + The type of the float value. + An offset in the attribute value buffer. + The float value at given offset. + Throws exception if (offset + size of float value) is greater than the length of the value buffer. + + + + Updates the value at the specified offset by the float value of the specified type. + + The type of the float value. + The mantissa of the float value. + An exponent of the float value. + An offset in the attribute value buffer. + Throws exception if (offset + size of float value) is greater than the length of the value buffer. + + + + A class which is used to handle the connection to Bluetooth HID like keyboards and mouse. + + http://tizen.org/privilege/bluetooth + + + + The HidConnectionStateChanged event is called when the HID host connection state is changed. + + + + + Connects the remote device with the HID service. + + + The device must be bonded with the remote device by CreateBond(). + If connection request succeeds, the HidConnectionStateChanged event will be invoked. + + Thrown when the Bluetooth is not enabled + or when the connection attempt to the remote device fails. + + + + Disconnects the remote device with the HID service. + + Thrown when the Bluetooth is not enabled + or when the disconnection attempt to the remote device fails. + + + + This is the BluetoothLeAdvertiser class. It handles the LE advertising operation amd callback. + + + + + This event is called when the LE advertising state changes. + + + + + Starts advertising using the advertise data object. + + + The Bluetooth must be enabled. + + The advertiser object carrying information of the advertising. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Stops the advertising. + + + The Bluetooth must be enabled. + + The advertiser object carrying information of the advertising. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + This is the BluetoothLeDevice class. + It handles the LE device operations like getting data from the scan result information. + + + + + This event is called when the GATT client connects/disconnects with the server. + + + + + The remote address. + + + + + The type of the address. + + + + + The rssi value. + + + + + The advertsing data information. + + + + + The scan data information. + + + + + The type of the packet. + + + + + Gets the service UUIDs list from the LE scan result information. + + Gets the list of the string service UUIDs. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Gets the device name from the LE scan result information. + + Gets the device name. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Gets the transmission power level from the LE scan result information. + + Gets the transmission power level in dB. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Gets the service solicitation UUID list from the scan result information. + + Gets the list of the service solicitation UUIDs. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Gets the manufacturer data from the scan result information. + + Gets the appearance value. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Gets the manufacturer data from the scan result information. + + Gets the manufacturer data containing the manucturer data and ID information. + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled./// + + + + Gets the service data list from the scan result information. + + + The Bluetooth must be enabled. + + Returns the service data list. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled. + + + + Creates a GATT connection with the remote device. + + + The Bluetooth must be enabled. + + The auto connect flag. + client instance + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the gatt connection attempt to remote device fails. + + + + Disconnects a GATT connection with the remote device. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the GATT disconnection attempt to remote device fails. + + + + Bluetooth LE advertise data. Handles the data advertising. + + + + + The default constructor initializes an object of the BluetoothLeAdvertiseData. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when create advertiser fails. + + + + The advertising mode to control the advertising power and latency. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the set advertising mode fails. + + + + The advertising connectable type. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the set advertising connectable mode fails. + + + + The type of the packet. + + + + + Sets the external appearance of this device to the advertise or the scan response data. + Please refer to the adopted Bluetooth specification for the appearance. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the set appearance fails. + + + + Sets whether the device name has to be included in the advertise or the scan response data. + The maximum advertised or responded data size is 31 bytes including the data type and the system wide data. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the set advertising device name fails. + + + + Sets whether the transmission power level should be included in the advertise or the scan response data. + The maximum advertised or responded data size is 31 bytes including the data type and the system wide data. + + + The Bluetooth must be enabled. + + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the set advertising TC power level fails. + + + + Adds a service UUID to the advertise or the scan response data. + The maximum advertised or responded data size is 31 bytes + including the data type and the system wide data. + + + The Bluetooth must be enabled. + + The packet type. + The service UUID to add to advertise data. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the add advertising service UUID procedure fails. + + + + Adds a service solicitation UUID to advertise or scan the response data. + The maximum advertised or responded data size is 31 bytes + including the data type and the system wide data. + + + The Bluetooth must be enabled. + + The packet type. + The service solicitation UUID to add to advertise data. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the add advertising service solicitation UUID procedure fails. + + + + Adds a service data to the advertise or the scan response data. + The maximum advertised or responded data size is 31 bytes + including data type and system wide data. + + + The Bluetooth must be enabled. + + The packet type. + The service data to be added to advertising. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the add advertising data procedure fails. + + + + Adds the manufacturer specific data to the advertise or the scan response data. + Please refer to the adopted Bluetooth specification for the the appearance. + + + The Bluetooth must be enabled. + + The packet type. + The manufacturer specific data. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the add advertising manufacturer data procedure fails. + + + + Clears all data to be advertised or responded to the scan request from the LE scanning device. + + + The Bluetooth must be enabled. + + The packet type to be cleared. + Thrown when the Bluetooth LE is not supported. + Thrown when the Bluetooth LE is not enabled + or when the clear advertising data procedure fails. + + + + + The BluetoothSocket provides functions for managing connections to other devices and exchanging data. + + + + + The AcceptStateChanged event is raised when the socket connection state is changed. + + Thrown when the Bluetooth is not enabled + or when the register accpet state changed callback fails. + + + + Starts listening on the passed RFCOMM socket and accepts connection requests. + + + The socket must be created with CreateServerSocket(). This API invokes the ConnectionStateChanged event. + + Thrown when the Bluetooth is not enabled + or when the listen on socket procedure fails. + + + + The IBluetoothServerSocket interface handles the server socket operations. + + + + + The IBluetoothClientSocket interface handles the client socket operations. + + + + + This event occurs when the socket server receives data from the client. + + Thrown when the Bluetooth is not enabled + or when the register data received callback fails. + + + + This event occurs when the connection state between two devices is changed. + + Thrown when the Bluetooth is not enabled + or when the register connection changed callback fails. + + + + Connects to a specific RFCOMM based service on a remote Bluetooth device UUID. + + + The bluetooth must be enabled, discoverable with StartDiscovery(), and bonded with the remote device using CreateBond(). The ConnectionStateChanged event is raised once this API is called. + + The address of the remote Bluetooth device. + The UUID of the service provided by the remote Bluetooth device. + Thrown when the Bluetooth is not enabled + or when the connect socket attempt to remote device fails, or when the service UUID is not supported by the remote device. + + + + Disconnects the RFCOMM connection with the given file descriptor of the conneted socket. + + + The connection must be established. + + The file descriptor of the socket to close. + Thrown when the Bluetooth is not enabled + or when the socket disconnect to remote device fails. + + + + Sends data to the connected device. + + The number of bytes written (zero indicates nothing was written). + + The connection must be established. + + The file descriptor of the connected socket. + The data to be sent. + Thrown when the Bluetooth is not enabled + or when the remote device is not connected, or the send data procedure fails. + + + + The structure of the device class type and service. + + + + + The type of the major device class. + + + + + The type of the minor device class. + + + + + The major service class mask. + + + + + This structure contains the information of the Bluetooth device. + + + + + The address of the device. + + + + + The name of the device. + + + + + The class of the device. + + + + + The service UUID list of the device. + + + + + The service count of the device. + + + + + The paired state of the device. + + + + + The connection state of the device. + + + + + The authorization state of the device. + + + + + The length of the manufacturer the data. + + + + + The manufacturer data. + + + + + + The Bluetooth LE service UUID. + + + + + The Bluetooth LE service data. + + + + diff --git a/Artifacts/bin/Tizen.Network.Connection.dll b/Artifacts/bin/Tizen.Network.Connection.dll index 485f6e7..e1b9dca 100644 Binary files a/Artifacts/bin/Tizen.Network.Connection.dll and b/Artifacts/bin/Tizen.Network.Connection.dll differ diff --git a/Artifacts/bin/Tizen.Network.Connection.pdb b/Artifacts/bin/Tizen.Network.Connection.pdb index 284dfd4..fd9be1f 100644 Binary files a/Artifacts/bin/Tizen.Network.Connection.pdb and b/Artifacts/bin/Tizen.Network.Connection.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Connection.xml b/Artifacts/bin/Tizen.Network.Connection.xml index 2c61eba..0e40ffa 100644 --- a/Artifacts/bin/Tizen.Network.Connection.xml +++ b/Artifacts/bin/Tizen.Network.Connection.xml @@ -1,1176 +1,1176 @@ - - - - Tizen.Network.Connection - - - - - This is the CellularProfile class. It provides functions to manage the cellular profile. - - 3 - - - - The APN (access point name). - - 3 - Cellular access point name. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a value is null. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The home URL. - - 3 - Cellular home URL. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a value is null. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The service type. - - 3 - Cellular service type. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The cellular pdn type. - - 3 - Cellular pdn type. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The cellular roaming pdn type. - - 3 - Cellular roaming pdn type. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when a operation is performed on a disposed object. - - - - The cellular authentication information. - - 3 - Instance of CellularAuthInformation. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a value is null. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - Checks whether the profile is hidden. - - 3 - True if the cellular profile is hidden, otherwise false. - - - - Checks whether the profile is editable. - - 3 - True if the cellular profile is editable, otherwise false. - - - - Checks whether the profile is default. - - 3 - True if the cellular profile is default, otherwise false. - - - - This is the CellularAuthInformation class. It provides the properties to get and set the cellular authentication information. - - 3 - - - - Default constructor. Initializes an object of the CellularAuthInformation. - - - - - The user name. - - 3 - Cellular user name. - - - - The password. - - 3 - Cellular password. - - - - The authentication type. - - 3 - Cellular authentication type. - - - - This class manages the connection handle resources. - - - - - Checks whether the handle value is valid or not. - - True if the handle is invalid, otherwise false. - - - - Frees the handle. - - True if the handle is released successfully, otherwise false. - - - - This is the ConnectionManager class. It provides functions to manage data connections. - - 3 - - - - An event is called when the type of the current connection is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - - - - An event for the ethernet cable is plugged [in/out] event. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - - - - An event is called when the IP address is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - - - - An event is called when the proxy address is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - - - - Gets the connection handle. - - 3 - Instance of SafeConnectionHandle. - - - - Gets the IP address of the current connection. - - 3 - The address family. - IP address of the connection (global address in case of IPv6). - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Gets all the IPv6 addresses of the current connection. - - 3 - The type of current network connection. - A list of IPv6 addresses of the connection. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Gets the proxy address of the current connection. - - 3 - The address family. - Proxy address of the connection. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Gets the MAC address of the Wi-Fi or ethernet. - - 3 - The type of current network connection. - MAC address of the Wi-Fi or ethernet. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Gets the statistics information. - - 3 - The type of connection (only WiFi and Cellular are supported). - The type of statistics. - The statistics information associated with statisticsType. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to invalid operation. - - - - Resets the statistics information. - - 3 - The type of connection (only WiFi and Cellular are supported). - The type of statistics. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.set - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Adds a route to the routing table. - - The address family. - The name of the network interface. - The IP address of the host. - The gateway address. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.set - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when an interfaceName or a hostAddress or a gateway is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Removes a route from the routing table. - - The address family. - The name of network interface. - The IP address of the host. - The gateway address. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.set - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when an interfaceName or a hostAddress or a gateway is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - The type and state of the current profile for data connection. - - 3 - Instance of ConnectionItem. - - - - Creates a cellular profile handle. - - 3 - The type of profile. Cellular profile type is supported. - The keyword included in profile name. - CellularProfile object. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a keyword value is null. - Thrown when a method fails due to invalid operation. - - - - The state of the cellular connection. - - 3 - Cellular network state. - http://tizen.org/privilege/network.get - - - - The state of the Wi-Fi connection. - - 3 - WiFi connection state. - http://tizen.org/privilege/network.get - - - - The state of the Bluetooth connection. - - 3 - Bluetooth connection state. - http://tizen.org/privilege/network.get - - - - The Ethernet connection state. - - 3 - Ethernet connection state. - http://tizen.org/privilege/network.get - - - - Checks if the ethernet cable is attached or not. - - 3 - Ethernet cable state. - http://tizen.org/privilege/network.get - - - - This class contains connection information, such as connection type and state. - - 3 - - - - The type of the current profile for data connection. - - 3 - Data connection current profile. - http://tizen.org/privilege/network.get - - - - The state of the current profile for data connection. - - 3 - Connection state of the current connection type. - http://tizen.org/privilege/network.get - - - - An extended EventArgs class, which contains changed connection type. - - 3 - - - - The connection type. - - 3 - Type of the connection. - - - - An extended EventArgs class, which contains changed ethernet cable state. - - 3 - - - - The ethernet cable state. - - 3 - Attached or detached state of the ethernet cable. - - - - An extended EventArgs class, which contains changed address. - - 3 - - - - The IPV4 address. - - 3 - IP address in the format of the IPV4 syntax. - - - - The IPV6 address. - - 3 - IP address in the format of the IPV6 syntax. - - - - This is the ConnectionProfile class. It provides event and propeties of the connection profile. - - 3 - - - - The event is called when the state of profile is changed. - - 3 - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - - - - Disposes the memory allocated to unmanaged resources. - - 3 - - - - The profile ID. - - 3 - Unique ID of the profile. - - - - The profile name. - - 3 - User friendly name of the profile. - - - - The network type. - - 3 - Profile type of the network connection. - - - - The name of the network interface. - - 3 - Network interface name, for example, eth0 and pdp0. - - - - Refreshes the profile information. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - Gets the network state. - - 3 - The address family. - The network state. - http://tizen.org/feature/network.ethernet - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a value is an invalid parameter. - Thrown when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The Proxy type. - - 3 - Proxy type of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown during set when a operation is performed on a disposed object. - - - - The proxy address. - - 3 - Proxy address of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a value is null. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - - The address information (IPv4). - - 3 - Instance of IAddressInformation with IPV4 address. - - - - The address information (IPv6). - - 3 - Instance of IAddressInformation with IPV6 address. - - - - An extended EventArgs class, which contains changed profile state. - - 3 - - - - The profile state. - - 3 - State type of the connection profile. - - - - This is the ConnectionProfileManager class. It provides functions to add, get, connect, or modify the connection profile. - - 3 - - - - Adds a new profile. - - 3 - The cellular profile object. - http://tizen.org/privilege/network.profile - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when connection or profile instance is invalid or when a method fails due to an invalid operation. - - - - Gets the list of the profile with the profile list type. - - 3 - The type of profile. - List of connection profile objects. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance has been disposed. - - - - Opens a connection of profile asynchronously. - - 3 - The connection profile object. - A task indicates whether the ConnectProfileAsync method is done successfully or not. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.set - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. - - - - Closes a connection of profile. - - 3 - The connection profile object. - A task indicates whether the DisconnectProfileAsync method is done successfully or not. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.set - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. - - - - Removes an existing profile. - - 3 - The connection profile object. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.profile - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. - - - - Updates an existing profile. - When a profile is changed, these changes will be not applied to the ConnectionProfileManager immediately. - When you call this function, your changes affect the ConnectionProfileManager and the existing profile is updated. - - 3 - The connection profile object. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.profile - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. - - - - Gets the name of the default profile. - - 3 - Connection profile object. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Gets the default profile, which provides the given cellular service. - - 3 - The cellular service type. - Connection profile object. - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when memory is not enough to continue execution. - Thrown when a connection instance is invalid or when a method fails due to an invalid operation. - - - - Sets the default profile, which provides the given cellular service. - - 3 - The cellular service type. - The connection profile object. - A task indicates whether the SetDefaultCellularProfile method is done successfully or not. - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.profile - http://tizen.org/feature/network.telephony - http://tizen.org/feature/network.wifi - http://tizen.org/feature/network.tethering.bluetooth - http://tizen.org/feature/network.ethernet - Thrown when a feature is not supported. - Thrown when a permission is denied. - Thrown when a value is an invalid parameter. - Thrown when a value is null. - Thrown when memory is not enough to continue execution. - Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. - - - - An extended EventArgs class, which contains the state of changed connection profile. - - 3 - - - - The connection profile state. - - 3 - State of the connection profile. - - - - Enumeration for the connection type. - - 3 - - - - - - - - - Enumeration for the address family. - - 3 - - - - - Enumeration for the cellular network state. - - 3 - - - - - - - - - Enumeration for the connection state. - - 3 - - - - - - Enumeration for the attached or detached state of the ethernet cable. - - 3 - - - - - Enumeration for the statistics type. - - 3 - - - - - - - Enumeration for the network connection type. - - 3 - - - - - - - Enumeration for the profile state type. - - 3 - - - - - - - Enumeration for the proxy method type. - - 3 - - - - - - Enumeration for the IP configuration type. - - 3 - - - - - - - - Enumeration for the cellular service type. - - 3 - - - - - - - - - - Enumeration for the cellular pdn type. - - 3 - - - - - - - Enumeration for the DNS configuration type. - - 3 - - - - - - Enumeration for the connection errors. - - 3 - - - - - - - - - - - Now in progress - - - - - - - - - - Enumeration for the profile list type. - - 3 - - - - - - Enumeration for the security type of Wi-Fi. - - 3 - - - - - - - - Enumeration for the encryption modes. - - 3 - - - - - - - - Enumeration for the connection profile state. - - 3 - - - - - - - Enumeration for the cellular authentication type. - - 3 - - - - - - This interface provides properties to manage address information of the connection. - - 3 - - - - The DNS address. - - 3 - First DNS address of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The DNS address. - - 3 - Second DNS address of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The gateway address. - - 3 - Gateway address of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The subnet mask address. - - 3 - Subnet mask of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The IP address. - - 3 - IP address of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The type of IP config. - - 3 - IP config type of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The prefix length. - - 3 - Prefix length of the connection. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The DNS config type. - - 3 - Config type of the DNS. - Thrown during set when a feature is not supported. - Thrown during set when a value is an invalid parameter. - Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. - - - - The DHCP server address. It is only supported for the IPV4 address family. - - Server address of the DHCP. - - - - This is the WiFiProfile class. It provides functions to manage the WiFi profile. - - 3 - - - - The ESSID (Extended Service Set Identifier). - - 3 - ESSID of the WiFi. - - - - The BSSID (Basic Service Set Identifier). - - 3 - BSSID of the WiFi. - - - - The RSSI. - - 3 - RSSI of the WiFi. - - - - The frequency (MHz). - - 3 - Frequency of the WiFi. - - - - The max speed (Mbps). - - 3 - Maximum speed of the WiFi. - - - - The security type of WiFi. - - 3 - Security type of the WiFi. - - - - The encryption type of WiFi. - - 3 - Encryption mode of the WiFi. - - - - Checks whether passphrase is required. - - 3 - True if a passphrase is required, otherwise false. - This property is not valid if WiFiSecurityType is Eap. - - - - Checks whether the WPS (Wi-Fi Protected Setup) is supported. - - 3 - True if WPS is supported, otherwise false. - - - - Sets the passphrase of the Wi-Fi WPA. - - 3 - The passphrase of Wi-Fi security. - http://tizen.org/feature/network.wifi - Thrown when a feature is not supported. - Thrown when a value is an invalid parameter. - Thrown when a passphrase is null. - Thrown when a profile instance is invalid or when a method fails due to an invalid operation. - Thrown when an operation is performed on a disposed object. - - - + + + + Tizen.Network.Connection + + + + + This is the CellularProfile class. It provides functions to manage the cellular profile. + + 3 + + + + The APN (access point name). + + 3 + Cellular access point name. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a value is null. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The home URL. + + 3 + Cellular home URL. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a value is null. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The service type. + + 3 + Cellular service type. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The cellular pdn type. + + 3 + Cellular pdn type. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The cellular roaming pdn type. + + 3 + Cellular roaming pdn type. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when a operation is performed on a disposed object. + + + + The cellular authentication information. + + 3 + Instance of CellularAuthInformation. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a value is null. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + Checks whether the profile is hidden. + + 3 + True if the cellular profile is hidden, otherwise false. + + + + Checks whether the profile is editable. + + 3 + True if the cellular profile is editable, otherwise false. + + + + Checks whether the profile is default. + + 3 + True if the cellular profile is default, otherwise false. + + + + This is the CellularAuthInformation class. It provides the properties to get and set the cellular authentication information. + + 3 + + + + Default constructor. Initializes an object of the CellularAuthInformation. + + + + + The user name. + + 3 + Cellular user name. + + + + The password. + + 3 + Cellular password. + + + + The authentication type. + + 3 + Cellular authentication type. + + + + This class manages the connection handle resources. + + + + + Checks whether the handle value is valid or not. + + True if the handle is invalid, otherwise false. + + + + Frees the handle. + + True if the handle is released successfully, otherwise false. + + + + This is the ConnectionManager class. It provides functions to manage data connections. + + 3 + + + + An event is called when the type of the current connection is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + + + + An event for the ethernet cable is plugged [in/out] event. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + + + + An event is called when the IP address is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + + + + An event is called when the proxy address is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + + + + Gets the connection handle. + + 3 + Instance of SafeConnectionHandle. + + + + Gets the IP address of the current connection. + + 3 + The address family. + IP address of the connection (global address in case of IPv6). + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Gets all the IPv6 addresses of the current connection. + + 3 + The type of current network connection. + A list of IPv6 addresses of the connection. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Gets the proxy address of the current connection. + + 3 + The address family. + Proxy address of the connection. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Gets the MAC address of the Wi-Fi or ethernet. + + 3 + The type of current network connection. + MAC address of the Wi-Fi or ethernet. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Gets the statistics information. + + 3 + The type of connection (only WiFi and Cellular are supported). + The type of statistics. + The statistics information associated with statisticsType. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to invalid operation. + + + + Resets the statistics information. + + 3 + The type of connection (only WiFi and Cellular are supported). + The type of statistics. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.set + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Adds a route to the routing table. + + The address family. + The name of the network interface. + The IP address of the host. + The gateway address. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.set + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when an interfaceName or a hostAddress or a gateway is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Removes a route from the routing table. + + The address family. + The name of network interface. + The IP address of the host. + The gateway address. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.set + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when an interfaceName or a hostAddress or a gateway is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + The type and state of the current profile for data connection. + + 3 + Instance of ConnectionItem. + + + + Creates a cellular profile handle. + + 3 + The type of profile. Cellular profile type is supported. + The keyword included in profile name. + CellularProfile object. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a keyword value is null. + Thrown when a method fails due to invalid operation. + + + + The state of the cellular connection. + + 3 + Cellular network state. + http://tizen.org/privilege/network.get + + + + The state of the Wi-Fi connection. + + 3 + WiFi connection state. + http://tizen.org/privilege/network.get + + + + The state of the Bluetooth connection. + + 3 + Bluetooth connection state. + http://tizen.org/privilege/network.get + + + + The Ethernet connection state. + + 3 + Ethernet connection state. + http://tizen.org/privilege/network.get + + + + Checks if the ethernet cable is attached or not. + + 3 + Ethernet cable state. + http://tizen.org/privilege/network.get + + + + This class contains connection information, such as connection type and state. + + 3 + + + + The type of the current profile for data connection. + + 3 + Data connection current profile. + http://tizen.org/privilege/network.get + + + + The state of the current profile for data connection. + + 3 + Connection state of the current connection type. + http://tizen.org/privilege/network.get + + + + An extended EventArgs class, which contains changed connection type. + + 3 + + + + The connection type. + + 3 + Type of the connection. + + + + An extended EventArgs class, which contains changed ethernet cable state. + + 3 + + + + The ethernet cable state. + + 3 + Attached or detached state of the ethernet cable. + + + + An extended EventArgs class, which contains changed address. + + 3 + + + + The IPV4 address. + + 3 + IP address in the format of the IPV4 syntax. + + + + The IPV6 address. + + 3 + IP address in the format of the IPV6 syntax. + + + + This is the ConnectionProfile class. It provides event and propeties of the connection profile. + + 3 + + + + The event is called when the state of profile is changed. + + 3 + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + + + + Disposes the memory allocated to unmanaged resources. + + 3 + + + + The profile ID. + + 3 + Unique ID of the profile. + + + + The profile name. + + 3 + User friendly name of the profile. + + + + The network type. + + 3 + Profile type of the network connection. + + + + The name of the network interface. + + 3 + Network interface name, for example, eth0 and pdp0. + + + + Refreshes the profile information. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + Gets the network state. + + 3 + The address family. + The network state. + http://tizen.org/feature/network.ethernet + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a value is an invalid parameter. + Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The Proxy type. + + 3 + Proxy type of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown during set when a operation is performed on a disposed object. + + + + The proxy address. + + 3 + Proxy address of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a value is null. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + + The address information (IPv4). + + 3 + Instance of IAddressInformation with IPV4 address. + + + + The address information (IPv6). + + 3 + Instance of IAddressInformation with IPV6 address. + + + + An extended EventArgs class, which contains changed profile state. + + 3 + + + + The profile state. + + 3 + State type of the connection profile. + + + + This is the ConnectionProfileManager class. It provides functions to add, get, connect, or modify the connection profile. + + 3 + + + + Adds a new profile. + + 3 + The cellular profile object. + http://tizen.org/privilege/network.profile + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when connection or profile instance is invalid or when a method fails due to an invalid operation. + + + + Gets the list of the profile with the profile list type. + + 3 + The type of profile. + List of connection profile objects. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance has been disposed. + + + + Opens a connection of profile asynchronously. + + 3 + The connection profile object. + A task indicates whether the ConnectProfileAsync method is done successfully or not. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.set + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. + + + + Closes a connection of profile. + + 3 + The connection profile object. + A task indicates whether the DisconnectProfileAsync method is done successfully or not. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.set + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. + + + + Removes an existing profile. + + 3 + The connection profile object. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.profile + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. + + + + Updates an existing profile. + When a profile is changed, these changes will be not applied to the ConnectionProfileManager immediately. + When you call this function, your changes affect the ConnectionProfileManager and the existing profile is updated. + + 3 + The connection profile object. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.profile + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation. + + + + Gets the name of the default profile. + + 3 + Connection profile object. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Gets the default profile, which provides the given cellular service. + + 3 + The cellular service type. + Connection profile object. + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when memory is not enough to continue execution. + Thrown when a connection instance is invalid or when a method fails due to an invalid operation. + + + + Sets the default profile, which provides the given cellular service. + + 3 + The cellular service type. + The connection profile object. + A task indicates whether the SetDefaultCellularProfile method is done successfully or not. + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.profile + http://tizen.org/feature/network.telephony + http://tizen.org/feature/network.wifi + http://tizen.org/feature/network.tethering.bluetooth + http://tizen.org/feature/network.ethernet + Thrown when a feature is not supported. + Thrown when a permission is denied. + Thrown when a value is an invalid parameter. + Thrown when a value is null. + Thrown when memory is not enough to continue execution. + Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation. + + + + An extended EventArgs class, which contains the state of changed connection profile. + + 3 + + + + The connection profile state. + + 3 + State of the connection profile. + + + + Enumeration for the connection type. + + 3 + + + + + + + + + Enumeration for the address family. + + 3 + + + + + Enumeration for the cellular network state. + + 3 + + + + + + + + + Enumeration for the connection state. + + 3 + + + + + + Enumeration for the attached or detached state of the ethernet cable. + + 3 + + + + + Enumeration for the statistics type. + + 3 + + + + + + + Enumeration for the network connection type. + + 3 + + + + + + + Enumeration for the profile state type. + + 3 + + + + + + + Enumeration for the proxy method type. + + 3 + + + + + + Enumeration for the IP configuration type. + + 3 + + + + + + + + Enumeration for the cellular service type. + + 3 + + + + + + + + + + Enumeration for the cellular pdn type. + + 3 + + + + + + + Enumeration for the DNS configuration type. + + 3 + + + + + + Enumeration for the connection errors. + + 3 + + + + + + + + + + + Now in progress + + + + + + + + + + Enumeration for the profile list type. + + 3 + + + + + + Enumeration for the security type of Wi-Fi. + + 3 + + + + + + + + Enumeration for the encryption modes. + + 3 + + + + + + + + Enumeration for the connection profile state. + + 3 + + + + + + + Enumeration for the cellular authentication type. + + 3 + + + + + + This interface provides properties to manage address information of the connection. + + 3 + + + + The DNS address. + + 3 + First DNS address of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The DNS address. + + 3 + Second DNS address of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The gateway address. + + 3 + Gateway address of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The subnet mask address. + + 3 + Subnet mask of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The IP address. + + 3 + IP address of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The type of IP config. + + 3 + IP config type of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The prefix length. + + 3 + Prefix length of the connection. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The DNS config type. + + 3 + Config type of the DNS. + Thrown during set when a feature is not supported. + Thrown during set when a value is an invalid parameter. + Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation. + + + + The DHCP server address. It is only supported for the IPV4 address family. + + Server address of the DHCP. + + + + This is the WiFiProfile class. It provides functions to manage the WiFi profile. + + 3 + + + + The ESSID (Extended Service Set Identifier). + + 3 + ESSID of the WiFi. + + + + The BSSID (Basic Service Set Identifier). + + 3 + BSSID of the WiFi. + + + + The RSSI. + + 3 + RSSI of the WiFi. + + + + The frequency (MHz). + + 3 + Frequency of the WiFi. + + + + The max speed (Mbps). + + 3 + Maximum speed of the WiFi. + + + + The security type of WiFi. + + 3 + Security type of the WiFi. + + + + The encryption type of WiFi. + + 3 + Encryption mode of the WiFi. + + + + Checks whether passphrase is required. + + 3 + True if a passphrase is required, otherwise false. + This property is not valid if WiFiSecurityType is Eap. + + + + Checks whether the WPS (Wi-Fi Protected Setup) is supported. + + 3 + True if WPS is supported, otherwise false. + + + + Sets the passphrase of the Wi-Fi WPA. + + 3 + The passphrase of Wi-Fi security. + http://tizen.org/feature/network.wifi + Thrown when a feature is not supported. + Thrown when a value is an invalid parameter. + Thrown when a passphrase is null. + Thrown when a profile instance is invalid or when a method fails due to an invalid operation. + Thrown when an operation is performed on a disposed object. + + + diff --git a/Artifacts/bin/Tizen.Network.IoTConnectivity.dll b/Artifacts/bin/Tizen.Network.IoTConnectivity.dll index 5f325c8..0d2455d 100644 Binary files a/Artifacts/bin/Tizen.Network.IoTConnectivity.dll and b/Artifacts/bin/Tizen.Network.IoTConnectivity.dll differ diff --git a/Artifacts/bin/Tizen.Network.IoTConnectivity.pdb b/Artifacts/bin/Tizen.Network.IoTConnectivity.pdb index b7b070e..a11ebbe 100644 Binary files a/Artifacts/bin/Tizen.Network.IoTConnectivity.pdb and b/Artifacts/bin/Tizen.Network.IoTConnectivity.pdb differ diff --git a/Artifacts/bin/Tizen.Network.IoTConnectivity.xml b/Artifacts/bin/Tizen.Network.IoTConnectivity.xml index 3ede3b1..3cae5c2 100644 --- a/Artifacts/bin/Tizen.Network.IoTConnectivity.xml +++ b/Artifacts/bin/Tizen.Network.IoTConnectivity.xml @@ -1,2238 +1,2238 @@ - - - - Tizen.Network.IoTConnectivity - - - - - This class represents current attributes of a resource. - It provides API to manage attributes. - This class is accessed by using a constructor to create a new instance of this object. - - 3 - - - - The Attributes constructor. - - 3 - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); - - - - - Destructor of the Attributes class. - - - - - Gets the number of keys. - - 3 - The number of keys. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - attributes.Add("brightness", 50); - var count = attributes.Count; - Console.WriteLine("There are {0} keys in the attribute object", count); - - - - - Represents whether an attribute is readonly. - - 3 - Whether an attribute is readonly. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - if (attributes.IsReadOnly) - Console.WriteLine("Read only attribute"); - - - - - Contains all the attribute keys. - - 3 - All the attribute keys. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - var keys = attributes.Keys; - Console.WriteLine("Attribute contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); - - - - - Contains all the attribute values. - - 3 - All the attribute values. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - var values = attributes.Values; - Console.WriteLine("Attribute contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); - - - - - Gets or sets the attribute with the specified key. - - 3 - The attribute with the specified key. - The key of the attribute to get or set. - The element with the specified key. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); - attributes["state"] = "ON"; - Console.WriteLine("Attribute value for key 'state' : {0}", attributes["state"]); - - - - - - Adds an attribute. - - 3 - The key representing the attribute. - The value representing the attribute. - http://tizen.org/feature/iot.ocf - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); - attributes.Add("brightness", 50); - - - - - Clears attributes collection. - - 3 - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported - Thrown when the operation is invalid - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); - attributes.Add("brightness", 50); - attributes.Clear(); - - - - - - Checks whether the given key exists in attributes collection. - - 3 - The status key to look for. - true if exists. Otherwise, false. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - if (attributes.ContainsKey("dim")) - Console.WriteLine("Attribute conatins key : dim"); - - - - - - - - Removes an attribute from collection using a key. - - 3 - The attributes element to remove. - true if operation is successful, otherwise, false. - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported - Thrown when there is an invalid parameter - Thrown when the operation is invalid - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - if (attributes.Remove("state")) - Console.WriteLine("Remove was successful"); - - - - - Gets the value associated with the specified key. - - 3 - The key whose value to get. - The value associated with the specified key. - true if the attributes collection contains an element with the specified key, otherwise, false. - - Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { - { "state", "ON" } - }; - object value; - var isPresent = attributes.TryGetValue("state", out value); - if (isPresent) - Console.WriteLine("value : {0}", value); - - - - - Returns an enumerator that iterates through the collection. - - 3 - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - This class represents event arguments of the CacheUpdated event. - - 3 - - - - Indicates the updated representation of the resource. - - 3 - The updated representation of the resource. - - - - This class represents event arguments of the DeviceInformationFound event. - - 3 - - - - The request ID. - - 3 - The request ID. - - - - Indicates to continuously receive the event for finding device information. - - 3 - Continuously receive the event for finding device information. - - - - Indicates the human friendly name for device. - - 3 - Human friendly name for device. - - - - Indicates the spec version of the core specification. - - 3 - Spec version of the core specification. - - - - Indicates an unique identifier for the OIC device. - - 3 - Unique identifier for OIC device. - - - - Indicates version of the specs this device data model is implemented to. - - 3 - Version of the specs this device data model is implemented to. - - - - Enumeration for resource found errors. - - - - - I/O error. - - - - - Out of memory. - - - - - Permission denied. - - - - - Not supported. - - - - - Invalid parameter. - - - - - No data available. - - - - - Time out. - - - - - IoTivity errors. - - - - - Representation errors. - - - - - Invalid type. - - - - - Already. - - - - - System errors. - - - - - This class represents event arguments of the FindingErrorOccurred event. - - 3 - - - - The request ID of the operation, which caused this error. - - 3 - The request ID of the operation, which caused this error. - - - - Contains error details. - - 3 - Error details. - - - - IoT connectivity client manager consists of client side APIs. - - 3 - - - - The IP Address for multicast. - - 3 - - - - PresenceReceived event. This event occurs when server starts sending presence of a resource. - - 3 - - - - ResourceFound event. This event occurs when a resource is found from the remote server - after sending request using API StartFindingResource(). - - 3 - - - - PlatformInformationFound event. This event occurs when platform information is found - after sending request using API StartFindingPlatformInformation(). - - 3 - - - - DeviceInformationFound event. This event occurs when device information is found - after sending request using API StartFindingDeviceInformation(). - - 3 - - - - FindingError event. This event occurs when an error is found. - - 3 - - - - Timeout in seconds. - - 3 - - Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.\n - Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(), - RemoteResource.GetAsync(), RemoteResource.PutAsync(), RemoteResource.PostAsync() and RemoteResource.DeleteAsync() APIs.\n - Setter can throw exception. - - 
-            Initialize() should be called to initialize.
-
- - IoTConnectivityClientManager.Initialize(); - IoTConnectivityClientManager.TimeOut = 120; - - - - - Polling interval of IoTConnectivity. - - 3 - - Sets/Gets the polling inerval(milliseconds) of IoTCon. Default value is 100 milliseconds. - Value to be set must be in range from 1 to 999. The closer to 0, the faster it operates. - Setter is invoked immediately for changing the interval. - If you want the faster operation, we recommend you set 10 milliseconds for polling interval. - Setter can throw exception. - - 
-            Initialize() should be called to initialize.
-
- - IoTConnectivityClientManager.Initialize(); - IoTConnectivityClientManager.PollingInterval = 100; - - - - - Initializes IoTCon. - Call this function to start IoTCon. - - 3 - - @a filePath point to a file for handling secure virtual resources. - The file that is CBOR(Concise Binary Object Representation)-format must already exist - in @a filePath. We recommend to use application-local file for @a filePath. - - - http://tizen.org/privilege/network.get \n - http://tizen.org/privilege/internet - - public - The file path to point to storage for handling secure virtual resources. - http://tizen.org/feature/iot.ocf - - You must call Deinitialize() if IoTCon API is no longer needed. - - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when an application does not have privilege to access. - - string filePath = "../../res/iotcon-test-svr-db-client.dat"; - IoTConnectivityClientManager.Initialize(filePath); - - - - - Deinitializes IoTCon. - - 3 - - This API must be called if IoTCon API is no longer needed. - - http://tizen.org/feature/iot.ocf - 
-            Initialize() should be called to initialize.
-
- - - - IoTConnectivityClientManager.Deinitialize(); - - - - - Invokes a next message from a queue for receiving messages from others, immediately. - - 3 - - This API invokes a next message from a queue for receiving messages from others, immediately. - After calling the API, it continues the polling with existing interval. - - http://tizen.org/feature/iot.ocf - 
-            Initialize() should be called to initialize.
-
- Thrown when the iotcon is not supported. - - IoTConnectivityClientManager.InvokePolling(); - - - - - - - - - - IoT connectivity server manager consists of server side APIs. - - 3 - - - - Initializes IoTCon. Calls this API to start IoTCon. - - 3 - - @a filePath point to a file for handling secure virtual resources. - The file that is CBOR(Concise Binary Object Representation)-format must already exist - in @a filePath. We recommend to use application-local file for @a filePath. - - - http://tizen.org/privilege/network.get \n - http://tizen.org/privilege/internet - - public - The file path to point to storage for handling secure virtual resources. - http://tizen.org/feature/iot.ocf - - You must call Deinitialize() if IoTCon API is no longer needed. - - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when an application does not have privilege to access - - string filePath = "../../res/iotcon-test-svr-db-server.dat"; - IoTConnectivityServerManager.Initialize(filePath); - - - - - Deinitializes IoTCon. - - 3 - - This API must be called if IoTCon API is no longer needed. - - http://tizen.org/feature/iot.ocf - 
-            Initialize() should be called to initialize.
-
- - - IoTConnectivityServerManager.Deinitialize(); - - - - - - - Starts presence of a server. - - 3 - - Use this API to send server's announcements to clients. - Server can call this API when online for the first time or come back from offline to online.\n - If @a time is 0, server will set default value as 60 seconds.\n - If @a time is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours). - - - http://tizen.org/privilege/internet - - public - The interval of announcing presence in seconds. - http://tizen.org/feature/iot.ocf - 
-            Initialize() should be called to initialize.
-
- - - - - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - - try { - IoTConnectivityServerManager.StartSendingPresence(120); - } catch(Exception ex) { - Console.Log("Exception caught : " + ex.Message); - } - - - - - Stops presence of a server. - - 3 - - Use this API to stop sending server's announcements to clients. - Server can call this API when terminating, entering to offline or out of network. - - - http://tizen.org/privilege/internet - - public - http://tizen.org/feature/iot.ocf - 
-            Initialize() should be called to initialize.
-
- - - - - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - - IoTConnectivityServerManager.StopSendingPresence(); - - - - - Sets the device name. - - 3 - - This API sets the name of the local device (the device calling the API).\n - If the device name is set, clients can get the name using . - - The device name. - http://tizen.org/feature/iot.ocf - - - - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - - IoTConnectivityServerManager.SetDeviceName("my-tizen"); - - - - - This class represents a lite resource. - It provides APIs to encapsulate resources. - This class is accessed by using a constructor to create a new instance of this object. - - 3 - - - - - - Decides whether to accept or reject a post request. - - 3 - - Child classes of this class can override this method to accept or reject post request. - - The new attributes of the lite resource. - true to accept post request, false to reject it. - - public class MyLightResource : LiteResource - { - protected override bool OnPost(Attributes attributes) - { - object newAttributes; - attributes.TryGetValue("LIGHT_ATTRIBUTE", out newAttributes); - if((int)newAttributes == 1) - return true; - return false; - } - } - - - - @cond - - - - Enumeration for the policy of observation. - - 3 - - - - Indicates the observation request for the most up-to-date notifications only. - - 3 - - - - Indicates the observation request for all notifications including state notifications. - - 3 - - - - This class represents event arguments of the ObserverNotified event. - - 3 - - - - Result of the observe response. - - 3 - Result of the observe response. - - - - Representation of the resource being observed. - - 3 - Representation of the resource being observed. - - - - Enumeration for the type of observation. - - 3 - - - - No observe action. - - 3 - - - - Indicates an action of the registering observation. - - 3 - - - - Indicates an action of unregistering observation. - - 3 - - - - This class represents event arguments of the PlatformInformationFound event. - - 3 - - - - Indicates the request ID. - - 3 - The request ID. - - - - Indicates to continuously receive the event for finding the platform information. - - 3 - Continuously receive the event for finding the platform information. - - - - Indicates the platform identifier. - - 3 - The platform identifier. - - - - Indicates the name of the manufacturer. - - 3 - The name of the manufacturer. - - - - Indicates the URL of the manufacturer. - - 3 - The URL of the manufacturer. - - - - Indicates the model number as designated by the manufacturer. - - 3 - The model number as designated by the manufacturer. - - - - Indicates the manufacturing date of the device. - - 3 - The manufacturing date of the device. - - - - Indicates the version of the platfrom defined by the manufacturer. - - 3 - The version of platfrom defined by manufacturer. - - - - Indicates the version of the platfrom resident OS. - - 3 - The version of the platfrom resident OS. - - - - Indicates the version of the platform Hardware. - - 3 - The version of the platform Hardware. - - - - Indicates the version of the device firmware. - - 3 - The version of the device firmware. - - - - Indicates the URL that points to support information from the manufacturer. - - 3 - The URL that points to support information from the manufacturer. - - - - Indicates the reference time of the device. - - 3 - The reference time of the device. - - - - Enumeration for operation of presence response. - - 3 - - - - Indicates the resource creation operation of the server. - - 3 - - - - Indicates the resource updation operation of the server. - - 3 - - - - Indicates the resource destruction operation of the server. - - 3 - - - - This class represents event arguments of the PresenceReceived event. - - 3 - - - - Indicates the request ID of the presence event. - - 3 - The request ID of the presence event. - - - - Indicates the event type. - - 3 - The event type. - - - - Indicates the host address of resource. - - 3 - The host address of resource. - - - - Indicates the type of the resource. - - 3 - The type of the resource. - - - - Enumeration for states of remote resource. - - 3 - - - - Indicates the low quality of service. - - 3 - - - - Indicates the high quality of service. - - 3 - - - - This class represents a remote resource. - It provides APIs to manage remote resource. - - 3 - - - - Creates a remote resource instance. - - 3 - - To use this API, you should provide all the details required to correctly contact and - observe the object.\n - If not, you should discover the resource object manually.\n - The @a policy can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable. - - The host address of the resource. - The URI path of the resource. - The policies of the resource. - The resource types of the resource. - The resource interfaces of the resource. - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - Thrown when there is an invalid parameter. - - - - Destructor of the RemoteResource class. - - - - - The event is invoked with cached resource attributes. - - 3 - - - - Observe an event on the resource sent by the server. - - 3 - - - - The event is called when remote resource's state are changed. - - 3 - - - - The host address of the resource. - - 3 - The host address of the resource. - - - - The URI path of the resource. - - 3 - The URI path of the resource. - - - - The resource types of the remote resource. - - 3 - The resource types of the remote resource. - - - - The interfaces of the resource. - - 3 - The interfaces of the resource. - - - - The policy of the resource. - - 3 - The policy of the resource. - - - - The header options of the resource. - - 3 - The header options of the resource. - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - - - - Indicates the CacheEnabled status of the remote resource. - - 3 - - Client can start caching only when this is set true. Set it to false to stop caching the resource attributes. - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - Thrown when there is not enough memory. - - - - Time interval of monitoring and caching API. - - 3 - - Default time interval is 10 seconds. - Seconds for time interval (must be in range from 1 to 3600). - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - - - - The device ID of the resource. - - 3 - The device ID of the resource. - - - - Gets cached representation from the remote resource. - - 3 - cached representation from the remote resource. - http://tizen.org/feature/iot.ocf - - - - Starts observing on the resource. - - 3 - - When server sends notification message, will be called. - - - http://tizen.org/privilege/internet - - public - The type to specify how client wants to observe. - The query to send to server. - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - Thrown when there is not enough memory. - - - - Stops observing on the resource. - - 3 - - http://tizen.org/privilege/internet - - public - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when an application does not have privilege to access. - - - - Gets the attributes of a resource asynchronously. - - 3 - - http://tizen.org/privilege/internet - - public - The ResourceQuery to send to server. - Remote response with result and representation. - http://tizen.org/feature/iot.ocf - - - - Puts the representation of a resource asynchronously. - - 3 - - http://tizen.org/privilege/internet - - public - Resource representation to put. - The ResourceQuery to send to server. - Remote response with result and representation. - http://tizen.org/feature/iot.ocf - - - - Posts request on a resource asynchronously. - - 3 - - http://tizen.org/privilege/internet - - public - Resource representation of request. - The ResourceQuery to send to server. - Remote response with result and representation. - http://tizen.org/feature/iot.ocf - - - - Deletes the resource asynchronously. - - 3 - - http://tizen.org/privilege/internet - - public - Remote response with result and representation. - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - This class represents a remote response. - It represents the response of all CRUD operations. - - 3 - - - - Indicates the result of the response. - - 3 - The result of the response. - - - - Indicates representation of the response. - - 3 - Representation of the response. - - - - Indicates header options of the response. - - 3 - Header options of the response. - - - - This class provides APIs to manage representation. - A representation is a payload of a request or a response. - - 3 - - - - The Representation constructor. - - 3 - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - Thrown when there is an invalid parameter. - - Representation repr = new Representation(); - - - - - Destructor of the Representation class. - - - - - The URI path of resource. - - 3 - - The URI path of resource. - Setter can throw exceptions. - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - Representation repr = new Representation(); - repr.UriPath = "/a/light"; - Console.WriteLine("URI is {0}", repr.UriPath); //Getter - - - - - - - Current attributes of the resource. - - 3 - Current attributes of the resource. - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - Representation repr = new Representation(); - Attributes attributes = new Attributes() { - { "state", "ON" }, - { "dim", 10 } - }; - repr.Attributes = attributes; - var newAttributes = repr.Attributes; // Getter - string strval = newAttributes["state"] as string; - int intval = (int)newAttributes["dim"]; - Console.WriteLine("attributes are {0} and {1}", strval, intval); - - - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - Class respresenting request to a resource. - It provides APIs to manage client's request. - - 3 - - - - Destructor of the Request class. - - - - - The host address of the request. - - 3 - The host address of the request. - - - - The representation of the request. - - 3 - The representation of the request. - - - - The query of the request. - - 3 - The query of the request. - - - - The options related to the request. - - 3 - The options related to the request. - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - Abstract class respresenting a resource. - All resources need to inherit from this class. - - 3 - - - - - Destructor of the Resource class. - - - - - Type details of the resource. - - 3 - Type details of the resource. - - - - Interface details of the resource. - - 3 - Interface details of the resource. - - - - The policies of the resource. - - 3 - The policies of the resource. - - - - URI path of the resource. - - 3 - URI path of the resource. - - - - List of Child resources. - - 3 - List of Child resources. - - - - - This is called when the client performs get operation on this resource. - - 3 - A request from client. - A response having the representation and the result. - - - - This is called when the client performs put operation on this resource. - - 3 - A request from client. - A response. - - - - This is called when the client performs post operation on this resource. - - 3 - A request from client. - A response having the representation and the result. - - - - This is called when the client performs delete operation on this resource. - - 3 - A request from client. - A response. - - - - Called on the observing event. - - 3 - A request from client. - Observer type. - Observe identifier. - Returns true if it wants to be observed, else false. - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - This class represents event arguments of the ResourceFound event. - - 3 - - - - Indicates the request ID. - This is the same request ID returned by the API. - - 3 - The request ID. - - - - Indicates to continuously receive the event for finding resource. - - 3 - Continuously receive the event for finding resource. - - - - Remote resource, which is found after . - - 3 - Remote resource which is found after . - - - - - - This class contains resource interfaces and provides APIs to manage, add, or remove those interfaces. - A resource interface indicates a class or category of resources. - - 3 - - - - Default Interface. - - 3 - - - - List Links Interface, which is used to list the references to other resources contained in a resource. - - 3 - - - - Batch Interface, which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource. - - 3 - - - - Group Interface, which is used to manipulate (GET, PUT, POST) a group of remote resources. - - 3 - - - - Read-Only Interface, which is used to limit the methods that can be applied to a resource to GET only. - - 3 - - - - Constructor of ResourceInterfaces. - - 3 - http://tizen.org/feature/iot.ocf - - - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - - ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); - - - - - - Destructor of the ResourceInterfaces class. - - - - - - Adds a resource interface into the list. - - 3 - - @a item could be a value, such as . - - The string data to insert into the resource interfaces. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - Thrown when there is an invalid parameter. - - ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); - resourceInterfaces.Add(ResourceInterfaces.BatchInterface); - - - - - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - This class represents resource options. It provides APIs to manage them.\n - The iotcon options API provides methods for managing vendor specific options of coap packet.\n - See more about coap packet in http://tools.ietf.org/html/rfc7252. - - 3 - - - - The resource options constructor. - - 3 - http://tizen.org/feature/iot.ocf - - - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - - ResourceOptions options = new ResourceOptions(); - - - - - Destructor of the ResourceOptions class. - - - - - Contains all the Option keys. - - 3 - All the Option keys. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "sample-data"); - options.Add(2055, "sample value"); - var keys = options.Keys; - Console.WriteLine("Resource options contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); - - - - - Contains all the Option values. - - 3 - All the Option values. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "sample-data"); - options.Add(2055, "sample value"); - var values = options.Values; - Console.WriteLine("Resource options contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); - - - - - Gets the number of options. - - 3 - The number of options. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "sample-data"); - options.Add(2055, "sample value"); - var count = options.Count; - Console.WriteLine("There are {0} keys in the options object", count); - - - - - Represents whether the collection is readonly. - - 3 - Whether the collection is readonly. - - ResourceOptions options = new ResourceOptions(); - if (options.IsReadOnly) - Console.WriteLine("Read only options"); - - - - - Gets or sets the option data. - - 3 - The option data. - The option ID to get or set. - The option with the specified ID. - - ResourceOptions options = new ResourceOptions(); - options[2055] = "sample-data"; - Console.WriteLine("Option has : {0}", options[2055]); - - - - - Checks whether the given key exists in Options collection. - - 3 - The key to look for. - true if exists. Otherwise, false. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "sample-data"); - if (options.ContainsKey(2050)) - Console.WriteLine("options conatins key : 2050"); - - - - - Adds a new ID and a correspoding data into the options. - - 3 - - ResourceOptions can have up to 2 options. \n - key is always situated between 2048 and 3000. \n - Length of option data is less than or equal to 15. - - The ID of the option to insert. - The string data to insert into the options. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "sample-data"); - - - - - Removes the ID and its associated data from the options. - - 3 - The ID of the option to delete. - True if operation is successful. Otherwise, false. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "12345"); - var result = options.Remove(2050); - - - - - Gets the value associated with the specified key. - - 3 - The option ID. - Value corresponding to option ID. - True if the key exists, false otherwise. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "12345"); - string value; - var isPresent = options.TryGetValue(2050, out value); - if (isPresent) - Console.WriteLine("value : {0}", value); - - - - - - Clears the Options collection. - - 3 - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - - ResourceOptions options = new ResourceOptions(); - options.Add(2050, "12345"); - options.Add(2055, "sample"); - options.Clear(); - - - - - - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - Enumeration for the policy, which can be held in a resource. - - 3 - - - - Indicates resource uninitialized. - - 3 - - - - Indicates resource that is allowed to be discovered. - - 3 - - - - Indicates resource that is allowed to be observed. - - 3 - - - - Indicates resource initialized and activated. - - 3 - - - - Indicates resource, which takes some delay to respond. - - 3 - - - - Indicates secure resource. - - 3 - - - - When this bit is set, the resource is allowed to be discovered only if discovery request contains an explicit querystring. - - 3 - - - - This class provides APIs to manage the query of request. - - 3 - - - - The resource query constructor. - - 3 - http://tizen.org/feature/iot.ocf - - - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - - ResourceQuery query = new ResourceQuery(); - - - - - Destructor of the ResourceQuery class. - - - - - Gets and sets the resource type of the query. - - 3 - The resource type of the query. - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - ResourceQuery query = new ResourceQuery(); - query.Type = "org.tizen.light"; - Console.WriteLine("Type of query : {0}", query.Type); - - - - - Gets and sets the resource interface of the query. - - 3 - - The resource interface of the query. - Setter value could be a value, such as . - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - ResourceQuery query = new ResourceQuery(); - query.Interface = ResourceInterfaces.LinkInterface; - - - - - Contains all the query keys. - - 3 - All the query keys. - - ResourceQuery query = new ResourceQuery(); - query.Add("key", "value"); - query.Add("newKey", "sample value"); - var keys = query.Keys; - Console.WriteLine("Resource query contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); - - - - - Contains all the query values. - - 3 - All the query values. - - ResourceQuery query = new ResourceQuery(); - query.Add("key", "value"); - query.Add("newKey", "sample value"); - var values = query.Values; - Console.WriteLine("Resource query contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); - - - - - Gets the number of query elements. - - 3 - The number of query elements. - - ResourceQuery query = new ResourceQuery(); - query.Add("key", "value"); - query.Add("newKey", "sample value"); - var count = query.Count; - Console.WriteLine("There are {0} keys in the query object", count); - - - - - Represents whether the collection is readonly. - - 3 - Whether the collection is readonly. - - ResourceQuery query = new ResourceQuery(); - if (query.IsReadOnly) - Console.WriteLine("Read only query"); - - - - - Gets or sets the query data. - - 3 - The query data. - The query key to get or set. - The query with the specified key. - - ResourceQuery query = new ResourceQuery(); - query["key1"] = "sample-data"; - Console.WriteLine("query has : {0}", query["key1"]); - - - - - Checks whether the given key exists in the query collection. - - 3 - The key to look for. - true if exists. Otherwise, false. - - ResourceQuery query = new ResourceQuery(); - query.Add("key1", "value1"); - if (query.ContainsKey("key1")) - Console.WriteLine("query conatins key : key1"); - - - - - Adds a new key and correspoding value into the query. - - 3 - - The full length of query should be less than or equal to 64. - - The key of the query to insert. - The string data to insert into the query. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - ResourceQuery query = new ResourceQuery(); - query.Add("key1", "value1"); - - - - - Removes the key and its associated value from the query. - - 3 - The ID of the query to delete. - True if operation is successful. Otherwise, false. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - ResourceQuery query = new ResourceQuery(); - query.Add("key1", "value1"); - var result = query.Remove("key1"); - - - - - Gets the value associated with the specified key. - - 3 - The query key. - Value corresponding to query key. - True if the key exists, false otherwise. - - ResourceQuery query = new ResourceQuery(); - query.Add("key1", "value1"); - string value; - var isPresent = query.TryGetValue("key1", out value); - if (isPresent) - Console.WriteLine("value : {0}", value); - - - - - - Clears the query collection. - - 3 - http://tizen.org/feature/iot.ocf - Thrown when the iotcon is not supported. - Thrown when the operation is invalid. - - ResourceQuery query = new ResourceQuery(); - query.Add("key1", "value1"); - query.Add("key2", "value2"); - query.Clear(); - - - - - - - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - Enumeration for states of the remote resource. - - 3 - - - - Indicates remote resource is alive. - - 3 - - - - Indicates remote resource is lost. - - 3 - - - - This class contains resource types and provides APIs to manage, add, or remove those types. - A resource type indicates a class or a category of resources. - - 3 - - - - Constructor of ResourceTypes. - - 3 - http://tizen.org/feature/iot.ocf - - - Thrown when the iotcon is not supported. - Thrown when there is not enough memory. - - ResourceTypes types = new ResourceTypes(); - - - - - - Destructor of the ResourceTypes class. - - - - - - Adds a resource type into the list. - - 3 - - The length of @a item should be less than or equal to 61.\n - The @a item must start with a lowercase alphabetic character, followed by a sequence - of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.\n - Duplicate strings are not allowed. - - The string data to insert into the resource types. - http://tizen.org/feature/iot.ocf - - Thrown when the iotcon is not supported. - Thrown when there is an invalid parameter. - Thrown when the operation is invalid. - - ResourceTypes resourceTypes = new ResourceTypes(); - resourceTypes.Add("org.tizen.light"); - - - - - - - - Releases any unmanaged resources used by this object. - - 3 - http://tizen.org/feature/iot.ocf - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - http://tizen.org/feature/iot.ocf - - - - This class represents response from a resource. - It provides APIs to manage response. - - 3 - - - - Constructor of Response. - - 3 - - Response response = new Response(); - - - - - Destructor of the Response class. - - - - - Gets or sets the result from/into the response. - - 3 - The result from/into the response. - - - - Gets or sets the representation from/into the response. - - 3 - The representation from/into the response. - - - - Gets or sets the options from/into the response. - - 3 - The options from/into the response. - - - - Releases any unmanaged resources used by this object. - - 3 - - - - Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. - - 3 - If true, disposes any disposable objects. If false, does not dispose disposable objects. - - - - Enumeration for the result of response. - - 3 - - - - Indicates the result of response for success. - - 3 - - - - Indicates the result of response for some error. - - 3 - - - - Indicates the result of response for created resource. - - 3 - - - - Indicates the result of response for deleted resource. - - 3 - - - - Indicates the result of response for changed resource. - - 3 - - - - Indicates the result of response for slow resource. - - 3 - - - - Indicates the result of response for accessing unauthorized resource. - - 3 - - - - This class represents event arguments of the StateChanged event. - - 3 - - - - Indicates the new state of the resource. - - 3 - The new state of the resource. - - - + + + + Tizen.Network.IoTConnectivity + + + + + This class represents current attributes of a resource. + It provides API to manage attributes. + This class is accessed by using a constructor to create a new instance of this object. + + 3 + + + + The Attributes constructor. + + 3 + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); + + + + + Destructor of the Attributes class. + + + + + Gets the number of keys. + + 3 + The number of keys. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + attributes.Add("brightness", 50); + var count = attributes.Count; + Console.WriteLine("There are {0} keys in the attribute object", count); + + + + + Represents whether an attribute is readonly. + + 3 + Whether an attribute is readonly. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + if (attributes.IsReadOnly) + Console.WriteLine("Read only attribute"); + + + + + Contains all the attribute keys. + + 3 + All the attribute keys. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + var keys = attributes.Keys; + Console.WriteLine("Attribute contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); + + + + + Contains all the attribute values. + + 3 + All the attribute values. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + var values = attributes.Values; + Console.WriteLine("Attribute contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); + + + + + Gets or sets the attribute with the specified key. + + 3 + The attribute with the specified key. + The key of the attribute to get or set. + The element with the specified key. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); + attributes["state"] = "ON"; + Console.WriteLine("Attribute value for key 'state' : {0}", attributes["state"]); + + + + + + Adds an attribute. + + 3 + The key representing the attribute. + The value representing the attribute. + http://tizen.org/feature/iot.ocf + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); + attributes.Add("brightness", 50); + + + + + Clears attributes collection. + + 3 + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported + Thrown when the operation is invalid + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes(); + attributes.Add("brightness", 50); + attributes.Clear(); + + + + + + Checks whether the given key exists in attributes collection. + + 3 + The status key to look for. + true if exists. Otherwise, false. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + if (attributes.ContainsKey("dim")) + Console.WriteLine("Attribute conatins key : dim"); + + + + + + + + Removes an attribute from collection using a key. + + 3 + The attributes element to remove. + true if operation is successful, otherwise, false. + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported + Thrown when there is an invalid parameter + Thrown when the operation is invalid + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + if (attributes.Remove("state")) + Console.WriteLine("Remove was successful"); + + + + + Gets the value associated with the specified key. + + 3 + The key whose value to get. + The value associated with the specified key. + true if the attributes collection contains an element with the specified key, otherwise, false. + + Tizen.Network.IoTConnectivity.Attributes attributes = new Tizen.Network.IoTConnectivity.Attributes() { + { "state", "ON" } + }; + object value; + var isPresent = attributes.TryGetValue("state", out value); + if (isPresent) + Console.WriteLine("value : {0}", value); + + + + + Returns an enumerator that iterates through the collection. + + 3 + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + This class represents event arguments of the CacheUpdated event. + + 3 + + + + Indicates the updated representation of the resource. + + 3 + The updated representation of the resource. + + + + This class represents event arguments of the DeviceInformationFound event. + + 3 + + + + The request ID. + + 3 + The request ID. + + + + Indicates to continuously receive the event for finding device information. + + 3 + Continuously receive the event for finding device information. + + + + Indicates the human friendly name for device. + + 3 + Human friendly name for device. + + + + Indicates the spec version of the core specification. + + 3 + Spec version of the core specification. + + + + Indicates an unique identifier for the OIC device. + + 3 + Unique identifier for OIC device. + + + + Indicates version of the specs this device data model is implemented to. + + 3 + Version of the specs this device data model is implemented to. + + + + Enumeration for resource found errors. + + + + + I/O error. + + + + + Out of memory. + + + + + Permission denied. + + + + + Not supported. + + + + + Invalid parameter. + + + + + No data available. + + + + + Time out. + + + + + IoTivity errors. + + + + + Representation errors. + + + + + Invalid type. + + + + + Already. + + + + + System errors. + + + + + This class represents event arguments of the FindingErrorOccurred event. + + 3 + + + + The request ID of the operation, which caused this error. + + 3 + The request ID of the operation, which caused this error. + + + + Contains error details. + + 3 + Error details. + + + + IoT connectivity client manager consists of client side APIs. + + 3 + + + + The IP Address for multicast. + + 3 + + + + PresenceReceived event. This event occurs when server starts sending presence of a resource. + + 3 + + + + ResourceFound event. This event occurs when a resource is found from the remote server + after sending request using API StartFindingResource(). + + 3 + + + + PlatformInformationFound event. This event occurs when platform information is found + after sending request using API StartFindingPlatformInformation(). + + 3 + + + + DeviceInformationFound event. This event occurs when device information is found + after sending request using API StartFindingDeviceInformation(). + + 3 + + + + FindingError event. This event occurs when an error is found. + + 3 + + + + Timeout in seconds. + + 3 + + Value to be set must be in range from 1 to 3600. Default timeout interval value is 30.\n + Sets/gets the timeout of StartFindingResource(), StartFindingDeviceInformation(), StartFindingPlatformInformation(), + RemoteResource.GetAsync(), RemoteResource.PutAsync(), RemoteResource.PostAsync() and RemoteResource.DeleteAsync() APIs.\n + Setter can throw exception. + + 
+            Initialize() should be called to initialize.
+
+ + IoTConnectivityClientManager.Initialize(); + IoTConnectivityClientManager.TimeOut = 120; + + + + + Polling interval of IoTConnectivity. + + 3 + + Sets/Gets the polling inerval(milliseconds) of IoTCon. Default value is 100 milliseconds. + Value to be set must be in range from 1 to 999. The closer to 0, the faster it operates. + Setter is invoked immediately for changing the interval. + If you want the faster operation, we recommend you set 10 milliseconds for polling interval. + Setter can throw exception. + + 
+            Initialize() should be called to initialize.
+
+ + IoTConnectivityClientManager.Initialize(); + IoTConnectivityClientManager.PollingInterval = 100; + + + + + Initializes IoTCon. + Call this function to start IoTCon. + + 3 + + @a filePath point to a file for handling secure virtual resources. + The file that is CBOR(Concise Binary Object Representation)-format must already exist + in @a filePath. We recommend to use application-local file for @a filePath. + + + http://tizen.org/privilege/network.get \n + http://tizen.org/privilege/internet + + public + The file path to point to storage for handling secure virtual resources. + http://tizen.org/feature/iot.ocf + + You must call Deinitialize() if IoTCon API is no longer needed. + + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when an application does not have privilege to access. + + string filePath = "../../res/iotcon-test-svr-db-client.dat"; + IoTConnectivityClientManager.Initialize(filePath); + + + + + Deinitializes IoTCon. + + 3 + + This API must be called if IoTCon API is no longer needed. + + http://tizen.org/feature/iot.ocf + 
+            Initialize() should be called to initialize.
+
+ + + + IoTConnectivityClientManager.Deinitialize(); + + + + + Invokes a next message from a queue for receiving messages from others, immediately. + + 3 + + This API invokes a next message from a queue for receiving messages from others, immediately. + After calling the API, it continues the polling with existing interval. + + http://tizen.org/feature/iot.ocf + 
+            Initialize() should be called to initialize.
+
+ Thrown when the iotcon is not supported. + + IoTConnectivityClientManager.InvokePolling(); + + + + + + + + + + IoT connectivity server manager consists of server side APIs. + + 3 + + + + Initializes IoTCon. Calls this API to start IoTCon. + + 3 + + @a filePath point to a file for handling secure virtual resources. + The file that is CBOR(Concise Binary Object Representation)-format must already exist + in @a filePath. We recommend to use application-local file for @a filePath. + + + http://tizen.org/privilege/network.get \n + http://tizen.org/privilege/internet + + public + The file path to point to storage for handling secure virtual resources. + http://tizen.org/feature/iot.ocf + + You must call Deinitialize() if IoTCon API is no longer needed. + + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when an application does not have privilege to access + + string filePath = "../../res/iotcon-test-svr-db-server.dat"; + IoTConnectivityServerManager.Initialize(filePath); + + + + + Deinitializes IoTCon. + + 3 + + This API must be called if IoTCon API is no longer needed. + + http://tizen.org/feature/iot.ocf + 
+            Initialize() should be called to initialize.
+
+ + + IoTConnectivityServerManager.Deinitialize(); + + + + + + + Starts presence of a server. + + 3 + + Use this API to send server's announcements to clients. + Server can call this API when online for the first time or come back from offline to online.\n + If @a time is 0, server will set default value as 60 seconds.\n + If @a time is very big, server will set maximum value as (60 * 60 * 24) seconds, (24 hours). + + + http://tizen.org/privilege/internet + + public + The interval of announcing presence in seconds. + http://tizen.org/feature/iot.ocf + 
+            Initialize() should be called to initialize.
+
+ + + + + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + + try { + IoTConnectivityServerManager.StartSendingPresence(120); + } catch(Exception ex) { + Console.Log("Exception caught : " + ex.Message); + } + + + + + Stops presence of a server. + + 3 + + Use this API to stop sending server's announcements to clients. + Server can call this API when terminating, entering to offline or out of network. + + + http://tizen.org/privilege/internet + + public + http://tizen.org/feature/iot.ocf + 
+            Initialize() should be called to initialize.
+
+ + + + + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + + IoTConnectivityServerManager.StopSendingPresence(); + + + + + Sets the device name. + + 3 + + This API sets the name of the local device (the device calling the API).\n + If the device name is set, clients can get the name using . + + The device name. + http://tizen.org/feature/iot.ocf + + + + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + + IoTConnectivityServerManager.SetDeviceName("my-tizen"); + + + + + This class represents a lite resource. + It provides APIs to encapsulate resources. + This class is accessed by using a constructor to create a new instance of this object. + + 3 + + + + + + Decides whether to accept or reject a post request. + + 3 + + Child classes of this class can override this method to accept or reject post request. + + The new attributes of the lite resource. + true to accept post request, false to reject it. + + public class MyLightResource : LiteResource + { + protected override bool OnPost(Attributes attributes) + { + object newAttributes; + attributes.TryGetValue("LIGHT_ATTRIBUTE", out newAttributes); + if((int)newAttributes == 1) + return true; + return false; + } + } + + + + @cond + + + + Enumeration for the policy of observation. + + 3 + + + + Indicates the observation request for the most up-to-date notifications only. + + 3 + + + + Indicates the observation request for all notifications including state notifications. + + 3 + + + + This class represents event arguments of the ObserverNotified event. + + 3 + + + + Result of the observe response. + + 3 + Result of the observe response. + + + + Representation of the resource being observed. + + 3 + Representation of the resource being observed. + + + + Enumeration for the type of observation. + + 3 + + + + No observe action. + + 3 + + + + Indicates an action of the registering observation. + + 3 + + + + Indicates an action of unregistering observation. + + 3 + + + + This class represents event arguments of the PlatformInformationFound event. + + 3 + + + + Indicates the request ID. + + 3 + The request ID. + + + + Indicates to continuously receive the event for finding the platform information. + + 3 + Continuously receive the event for finding the platform information. + + + + Indicates the platform identifier. + + 3 + The platform identifier. + + + + Indicates the name of the manufacturer. + + 3 + The name of the manufacturer. + + + + Indicates the URL of the manufacturer. + + 3 + The URL of the manufacturer. + + + + Indicates the model number as designated by the manufacturer. + + 3 + The model number as designated by the manufacturer. + + + + Indicates the manufacturing date of the device. + + 3 + The manufacturing date of the device. + + + + Indicates the version of the platfrom defined by the manufacturer. + + 3 + The version of platfrom defined by manufacturer. + + + + Indicates the version of the platfrom resident OS. + + 3 + The version of the platfrom resident OS. + + + + Indicates the version of the platform Hardware. + + 3 + The version of the platform Hardware. + + + + Indicates the version of the device firmware. + + 3 + The version of the device firmware. + + + + Indicates the URL that points to support information from the manufacturer. + + 3 + The URL that points to support information from the manufacturer. + + + + Indicates the reference time of the device. + + 3 + The reference time of the device. + + + + Enumeration for operation of presence response. + + 3 + + + + Indicates the resource creation operation of the server. + + 3 + + + + Indicates the resource updation operation of the server. + + 3 + + + + Indicates the resource destruction operation of the server. + + 3 + + + + This class represents event arguments of the PresenceReceived event. + + 3 + + + + Indicates the request ID of the presence event. + + 3 + The request ID of the presence event. + + + + Indicates the event type. + + 3 + The event type. + + + + Indicates the host address of resource. + + 3 + The host address of resource. + + + + Indicates the type of the resource. + + 3 + The type of the resource. + + + + Enumeration for states of remote resource. + + 3 + + + + Indicates the low quality of service. + + 3 + + + + Indicates the high quality of service. + + 3 + + + + This class represents a remote resource. + It provides APIs to manage remote resource. + + 3 + + + + Creates a remote resource instance. + + 3 + + To use this API, you should provide all the details required to correctly contact and + observe the object.\n + If not, you should discover the resource object manually.\n + The @a policy can contain multiple policies like ResourcePolicy.Discoverable | ResourcePolicy.Observable. + + The host address of the resource. + The URI path of the resource. + The policies of the resource. + The resource types of the resource. + The resource interfaces of the resource. + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + Thrown when there is an invalid parameter. + + + + Destructor of the RemoteResource class. + + + + + The event is invoked with cached resource attributes. + + 3 + + + + Observe an event on the resource sent by the server. + + 3 + + + + The event is called when remote resource's state are changed. + + 3 + + + + The host address of the resource. + + 3 + The host address of the resource. + + + + The URI path of the resource. + + 3 + The URI path of the resource. + + + + The resource types of the remote resource. + + 3 + The resource types of the remote resource. + + + + The interfaces of the resource. + + 3 + The interfaces of the resource. + + + + The policy of the resource. + + 3 + The policy of the resource. + + + + The header options of the resource. + + 3 + The header options of the resource. + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + + + + Indicates the CacheEnabled status of the remote resource. + + 3 + + Client can start caching only when this is set true. Set it to false to stop caching the resource attributes. + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + Thrown when there is not enough memory. + + + + Time interval of monitoring and caching API. + + 3 + + Default time interval is 10 seconds. + Seconds for time interval (must be in range from 1 to 3600). + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + + + + The device ID of the resource. + + 3 + The device ID of the resource. + + + + Gets cached representation from the remote resource. + + 3 + cached representation from the remote resource. + http://tizen.org/feature/iot.ocf + + + + Starts observing on the resource. + + 3 + + When server sends notification message, will be called. + + + http://tizen.org/privilege/internet + + public + The type to specify how client wants to observe. + The query to send to server. + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + Thrown when there is not enough memory. + + + + Stops observing on the resource. + + 3 + + http://tizen.org/privilege/internet + + public + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when an application does not have privilege to access. + + + + Gets the attributes of a resource asynchronously. + + 3 + + http://tizen.org/privilege/internet + + public + The ResourceQuery to send to server. + Remote response with result and representation. + http://tizen.org/feature/iot.ocf + + + + Puts the representation of a resource asynchronously. + + 3 + + http://tizen.org/privilege/internet + + public + Resource representation to put. + The ResourceQuery to send to server. + Remote response with result and representation. + http://tizen.org/feature/iot.ocf + + + + Posts request on a resource asynchronously. + + 3 + + http://tizen.org/privilege/internet + + public + Resource representation of request. + The ResourceQuery to send to server. + Remote response with result and representation. + http://tizen.org/feature/iot.ocf + + + + Deletes the resource asynchronously. + + 3 + + http://tizen.org/privilege/internet + + public + Remote response with result and representation. + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + This class represents a remote response. + It represents the response of all CRUD operations. + + 3 + + + + Indicates the result of the response. + + 3 + The result of the response. + + + + Indicates representation of the response. + + 3 + Representation of the response. + + + + Indicates header options of the response. + + 3 + Header options of the response. + + + + This class provides APIs to manage representation. + A representation is a payload of a request or a response. + + 3 + + + + The Representation constructor. + + 3 + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + Thrown when there is an invalid parameter. + + Representation repr = new Representation(); + + + + + Destructor of the Representation class. + + + + + The URI path of resource. + + 3 + + The URI path of resource. + Setter can throw exceptions. + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + Representation repr = new Representation(); + repr.UriPath = "/a/light"; + Console.WriteLine("URI is {0}", repr.UriPath); //Getter + + + + + + + Current attributes of the resource. + + 3 + Current attributes of the resource. + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + Representation repr = new Representation(); + Attributes attributes = new Attributes() { + { "state", "ON" }, + { "dim", 10 } + }; + repr.Attributes = attributes; + var newAttributes = repr.Attributes; // Getter + string strval = newAttributes["state"] as string; + int intval = (int)newAttributes["dim"]; + Console.WriteLine("attributes are {0} and {1}", strval, intval); + + + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + Class respresenting request to a resource. + It provides APIs to manage client's request. + + 3 + + + + Destructor of the Request class. + + + + + The host address of the request. + + 3 + The host address of the request. + + + + The representation of the request. + + 3 + The representation of the request. + + + + The query of the request. + + 3 + The query of the request. + + + + The options related to the request. + + 3 + The options related to the request. + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + Abstract class respresenting a resource. + All resources need to inherit from this class. + + 3 + + + + + Destructor of the Resource class. + + + + + Type details of the resource. + + 3 + Type details of the resource. + + + + Interface details of the resource. + + 3 + Interface details of the resource. + + + + The policies of the resource. + + 3 + The policies of the resource. + + + + URI path of the resource. + + 3 + URI path of the resource. + + + + List of Child resources. + + 3 + List of Child resources. + + + + + This is called when the client performs get operation on this resource. + + 3 + A request from client. + A response having the representation and the result. + + + + This is called when the client performs put operation on this resource. + + 3 + A request from client. + A response. + + + + This is called when the client performs post operation on this resource. + + 3 + A request from client. + A response having the representation and the result. + + + + This is called when the client performs delete operation on this resource. + + 3 + A request from client. + A response. + + + + Called on the observing event. + + 3 + A request from client. + Observer type. + Observe identifier. + Returns true if it wants to be observed, else false. + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + This class represents event arguments of the ResourceFound event. + + 3 + + + + Indicates the request ID. + This is the same request ID returned by the API. + + 3 + The request ID. + + + + Indicates to continuously receive the event for finding resource. + + 3 + Continuously receive the event for finding resource. + + + + Remote resource, which is found after . + + 3 + Remote resource which is found after . + + + + + + This class contains resource interfaces and provides APIs to manage, add, or remove those interfaces. + A resource interface indicates a class or category of resources. + + 3 + + + + Default Interface. + + 3 + + + + List Links Interface, which is used to list the references to other resources contained in a resource. + + 3 + + + + Batch Interface, which is used to manipulate (GET, PUT, POST, DELETE) on other resource contained in a resource. + + 3 + + + + Group Interface, which is used to manipulate (GET, PUT, POST) a group of remote resources. + + 3 + + + + Read-Only Interface, which is used to limit the methods that can be applied to a resource to GET only. + + 3 + + + + Constructor of ResourceInterfaces. + + 3 + http://tizen.org/feature/iot.ocf + + + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + + ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); + + + + + + Destructor of the ResourceInterfaces class. + + + + + + Adds a resource interface into the list. + + 3 + + @a item could be a value, such as . + + The string data to insert into the resource interfaces. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + Thrown when there is an invalid parameter. + + ResourceInterfaces resourceInterfaces = new ResourceInterfaces(); + resourceInterfaces.Add(ResourceInterfaces.BatchInterface); + + + + + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + This class represents resource options. It provides APIs to manage them.\n + The iotcon options API provides methods for managing vendor specific options of coap packet.\n + See more about coap packet in http://tools.ietf.org/html/rfc7252. + + 3 + + + + The resource options constructor. + + 3 + http://tizen.org/feature/iot.ocf + + + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + + ResourceOptions options = new ResourceOptions(); + + + + + Destructor of the ResourceOptions class. + + + + + Contains all the Option keys. + + 3 + All the Option keys. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "sample-data"); + options.Add(2055, "sample value"); + var keys = options.Keys; + Console.WriteLine("Resource options contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); + + + + + Contains all the Option values. + + 3 + All the Option values. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "sample-data"); + options.Add(2055, "sample value"); + var values = options.Values; + Console.WriteLine("Resource options contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); + + + + + Gets the number of options. + + 3 + The number of options. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "sample-data"); + options.Add(2055, "sample value"); + var count = options.Count; + Console.WriteLine("There are {0} keys in the options object", count); + + + + + Represents whether the collection is readonly. + + 3 + Whether the collection is readonly. + + ResourceOptions options = new ResourceOptions(); + if (options.IsReadOnly) + Console.WriteLine("Read only options"); + + + + + Gets or sets the option data. + + 3 + The option data. + The option ID to get or set. + The option with the specified ID. + + ResourceOptions options = new ResourceOptions(); + options[2055] = "sample-data"; + Console.WriteLine("Option has : {0}", options[2055]); + + + + + Checks whether the given key exists in Options collection. + + 3 + The key to look for. + true if exists. Otherwise, false. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "sample-data"); + if (options.ContainsKey(2050)) + Console.WriteLine("options conatins key : 2050"); + + + + + Adds a new ID and a correspoding data into the options. + + 3 + + ResourceOptions can have up to 2 options. \n + key is always situated between 2048 and 3000. \n + Length of option data is less than or equal to 15. + + The ID of the option to insert. + The string data to insert into the options. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "sample-data"); + + + + + Removes the ID and its associated data from the options. + + 3 + The ID of the option to delete. + True if operation is successful. Otherwise, false. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "12345"); + var result = options.Remove(2050); + + + + + Gets the value associated with the specified key. + + 3 + The option ID. + Value corresponding to option ID. + True if the key exists, false otherwise. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "12345"); + string value; + var isPresent = options.TryGetValue(2050, out value); + if (isPresent) + Console.WriteLine("value : {0}", value); + + + + + + Clears the Options collection. + + 3 + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + + ResourceOptions options = new ResourceOptions(); + options.Add(2050, "12345"); + options.Add(2055, "sample"); + options.Clear(); + + + + + + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + Enumeration for the policy, which can be held in a resource. + + 3 + + + + Indicates resource uninitialized. + + 3 + + + + Indicates resource that is allowed to be discovered. + + 3 + + + + Indicates resource that is allowed to be observed. + + 3 + + + + Indicates resource initialized and activated. + + 3 + + + + Indicates resource, which takes some delay to respond. + + 3 + + + + Indicates secure resource. + + 3 + + + + When this bit is set, the resource is allowed to be discovered only if discovery request contains an explicit querystring. + + 3 + + + + This class provides APIs to manage the query of request. + + 3 + + + + The resource query constructor. + + 3 + http://tizen.org/feature/iot.ocf + + + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + + ResourceQuery query = new ResourceQuery(); + + + + + Destructor of the ResourceQuery class. + + + + + Gets and sets the resource type of the query. + + 3 + The resource type of the query. + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + ResourceQuery query = new ResourceQuery(); + query.Type = "org.tizen.light"; + Console.WriteLine("Type of query : {0}", query.Type); + + + + + Gets and sets the resource interface of the query. + + 3 + + The resource interface of the query. + Setter value could be a value, such as . + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + ResourceQuery query = new ResourceQuery(); + query.Interface = ResourceInterfaces.LinkInterface; + + + + + Contains all the query keys. + + 3 + All the query keys. + + ResourceQuery query = new ResourceQuery(); + query.Add("key", "value"); + query.Add("newKey", "sample value"); + var keys = query.Keys; + Console.WriteLine("Resource query contains keys {0} and {1}", keys.ElementAt(0), keys.ElementAt(1)); + + + + + Contains all the query values. + + 3 + All the query values. + + ResourceQuery query = new ResourceQuery(); + query.Add("key", "value"); + query.Add("newKey", "sample value"); + var values = query.Values; + Console.WriteLine("Resource query contains values {0} and {1}", values.ElementAt(0), values.ElementAt(1)); + + + + + Gets the number of query elements. + + 3 + The number of query elements. + + ResourceQuery query = new ResourceQuery(); + query.Add("key", "value"); + query.Add("newKey", "sample value"); + var count = query.Count; + Console.WriteLine("There are {0} keys in the query object", count); + + + + + Represents whether the collection is readonly. + + 3 + Whether the collection is readonly. + + ResourceQuery query = new ResourceQuery(); + if (query.IsReadOnly) + Console.WriteLine("Read only query"); + + + + + Gets or sets the query data. + + 3 + The query data. + The query key to get or set. + The query with the specified key. + + ResourceQuery query = new ResourceQuery(); + query["key1"] = "sample-data"; + Console.WriteLine("query has : {0}", query["key1"]); + + + + + Checks whether the given key exists in the query collection. + + 3 + The key to look for. + true if exists. Otherwise, false. + + ResourceQuery query = new ResourceQuery(); + query.Add("key1", "value1"); + if (query.ContainsKey("key1")) + Console.WriteLine("query conatins key : key1"); + + + + + Adds a new key and correspoding value into the query. + + 3 + + The full length of query should be less than or equal to 64. + + The key of the query to insert. + The string data to insert into the query. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + ResourceQuery query = new ResourceQuery(); + query.Add("key1", "value1"); + + + + + Removes the key and its associated value from the query. + + 3 + The ID of the query to delete. + True if operation is successful. Otherwise, false. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + ResourceQuery query = new ResourceQuery(); + query.Add("key1", "value1"); + var result = query.Remove("key1"); + + + + + Gets the value associated with the specified key. + + 3 + The query key. + Value corresponding to query key. + True if the key exists, false otherwise. + + ResourceQuery query = new ResourceQuery(); + query.Add("key1", "value1"); + string value; + var isPresent = query.TryGetValue("key1", out value); + if (isPresent) + Console.WriteLine("value : {0}", value); + + + + + + Clears the query collection. + + 3 + http://tizen.org/feature/iot.ocf + Thrown when the iotcon is not supported. + Thrown when the operation is invalid. + + ResourceQuery query = new ResourceQuery(); + query.Add("key1", "value1"); + query.Add("key2", "value2"); + query.Clear(); + + + + + + + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + Enumeration for states of the remote resource. + + 3 + + + + Indicates remote resource is alive. + + 3 + + + + Indicates remote resource is lost. + + 3 + + + + This class contains resource types and provides APIs to manage, add, or remove those types. + A resource type indicates a class or a category of resources. + + 3 + + + + Constructor of ResourceTypes. + + 3 + http://tizen.org/feature/iot.ocf + + + Thrown when the iotcon is not supported. + Thrown when there is not enough memory. + + ResourceTypes types = new ResourceTypes(); + + + + + + Destructor of the ResourceTypes class. + + + + + + Adds a resource type into the list. + + 3 + + The length of @a item should be less than or equal to 61.\n + The @a item must start with a lowercase alphabetic character, followed by a sequence + of lowercase alphabetic, numeric, ".", or "-" characters, and contains no white space.\n + Duplicate strings are not allowed. + + The string data to insert into the resource types. + http://tizen.org/feature/iot.ocf + + Thrown when the iotcon is not supported. + Thrown when there is an invalid parameter. + Thrown when the operation is invalid. + + ResourceTypes resourceTypes = new ResourceTypes(); + resourceTypes.Add("org.tizen.light"); + + + + + + + + Releases any unmanaged resources used by this object. + + 3 + http://tizen.org/feature/iot.ocf + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + http://tizen.org/feature/iot.ocf + + + + This class represents response from a resource. + It provides APIs to manage response. + + 3 + + + + Constructor of Response. + + 3 + + Response response = new Response(); + + + + + Destructor of the Response class. + + + + + Gets or sets the result from/into the response. + + 3 + The result from/into the response. + + + + Gets or sets the representation from/into the response. + + 3 + The representation from/into the response. + + + + Gets or sets the options from/into the response. + + 3 + The options from/into the response. + + + + Releases any unmanaged resources used by this object. + + 3 + + + + Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. + + 3 + If true, disposes any disposable objects. If false, does not dispose disposable objects. + + + + Enumeration for the result of response. + + 3 + + + + Indicates the result of response for success. + + 3 + + + + Indicates the result of response for some error. + + 3 + + + + Indicates the result of response for created resource. + + 3 + + + + Indicates the result of response for deleted resource. + + 3 + + + + Indicates the result of response for changed resource. + + 3 + + + + Indicates the result of response for slow resource. + + 3 + + + + Indicates the result of response for accessing unauthorized resource. + + 3 + + + + This class represents event arguments of the StateChanged event. + + 3 + + + + Indicates the new state of the resource. + + 3 + The new state of the resource. + + + diff --git a/Artifacts/bin/Tizen.Network.Mtp.dll b/Artifacts/bin/Tizen.Network.Mtp.dll index 82e8983..746380d 100644 Binary files a/Artifacts/bin/Tizen.Network.Mtp.dll and b/Artifacts/bin/Tizen.Network.Mtp.dll differ diff --git a/Artifacts/bin/Tizen.Network.Mtp.pdb b/Artifacts/bin/Tizen.Network.Mtp.pdb index bcd4cea..cb963a9 100644 Binary files a/Artifacts/bin/Tizen.Network.Mtp.pdb and b/Artifacts/bin/Tizen.Network.Mtp.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Mtp.xml b/Artifacts/bin/Tizen.Network.Mtp.xml index b56e563..4039c7a 100644 --- a/Artifacts/bin/Tizen.Network.Mtp.xml +++ b/Artifacts/bin/Tizen.Network.Mtp.xml @@ -1,615 +1,615 @@ - - - - Tizen.Network.Mtp - - - - - A class for Mtp Device information. It allows applications to handle device information. - - 5 - - - - Gets the manufacturer name of the device information. - - Manufacture name of device. - 5 - - - - Gets the model name of the device information. - - Model name of device. - 5 - - - - Gets the serial number of the device information. - - Serial number of device. - 5 - - - - Gets the device version of the device information. - - Version number of device. - 5 - - - - Gets the list of storages. - - List of storage objects. - http://tizen.org/feature/network.mtp - Thrown when Mtp is not supported. - Thrown when the method failed due to invalid operation. - 5 - - - - Enumeration for Mtp storage type. - - 5 - - - - Undefined - - - - - fixed ROM - - - - - removable ROM - - - - - fixed RAM - - - - - removable RAM - - - - - Enumeration for Mtp file type. - - 5 - - - - Folder - - - - - Wav - - - - - Mp3 - - - - - Wma - - - - - Ogg - - - - - Audible - - - - - Mp4 - - - - - UndefAudio - - - - - Wmv - - - - - Avi - - - - - Mpeg - - - - - Asf - - - - - Qt - - - - - UndefVideo - - - - - Jpeg - - - - - Jfif - - - - - Tiff - - - - - Bmp - - - - - Gif - - - - - Pict - - - - - Png - - - - - Vcalendar1 - - - - - Vcalendar2 - - - - - Vcard2 - - - - - Vcard3 - - - - - WindowsImageFormat - - - - - WinExec - - - - - Text - - - - - Html - - - - - Firmware - - - - - Aac - - - - - Mediacard - - - - - Flac - - - - - Mp2 - - - - - M4a - - - - - Doc - - - - - Xml - - - - - Xls - - - - - Ppt - - - - - Mht - - - - - Jp2 - - - - - Jpx - - - - - Album - - - - - Playlist - - - - - Unknown - - - - - All (Helper type) - - - - - All Image (Helper type) - - - - - Enumeration for Mtp Event type. - - 5 - - - - Unknown - - - - - Storage Added - - - - - Storage Removed - - - - - Object Added - - - - - Object Removed - - - - - Device Added - - - - - Device Removed - - - - - Turned Off - - - - - Enumeration for Mtp Error. - - 5 - - - - An extended EventArgs class which contains Mtp event. - - 5 - - - - The Mtp event type. - - 5 - - - - The event parameter. - - 5 - - - - A class for MTP management. It allows applications to use MTP service. - - - http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - - 5 - - - - Gets the list of MTP devices. - - List of MtpDevice objects. - http://tizen.org/feature/network.mtp - Thrown when Mtp is not supported. - Thrown when the method failed due to invalid operation. - 5 - - - - MtpStateChanged is raised when the Mtp device state is changed. - - 5 - - - - A class for Mtp Object information. It allows applications to handle object information. - - 5 - - - - Gets the filename of the object information. - - File name of object. - 5 - - - - Gets the keywords of the object information. - - Keywords of object. - 5 - - - - Gets the association description of the object information. - - Association description of object. - 5 - - - - Gets the association type of the object information. - - Association type of object. - 5 - - - - Gets the size of the object information. - - Size of object. - 5 - - - - Gets the parent object handle of the object information. - - Handle of Parent object. - 5 - - - - Gets the mtp storage of the object information. - - Storage of object. - 5 - - - - Gets the object created time of the object information. - - Date created of object. - 5 - - - - Gets the object modified time of the object information. - - Date modified of object. - 5 - - - - Gets the file type of the object information. - - File type of object. - 5 - - - - Gets the image bit depth of the object information. - - Bit depth of image. - 5 - - - - Gets the image pixel width of the object information. - - Pixel width of image. - 5 - - - - Gets the image pixel height of the object information. - - Pixel height of image. - 5 - - - - Gets the thumbnail size of the object information. - - Size of thumbnail. - 5 - - - - Gets the thumbnail file type of the object information. - - File type of thumbnail. - 5 - - - - Gets the thumbnail pixel width of the object information. - - Pixel width of thumbnail. - 5 - - - - Gets the thumbnail pixel height of the object information. - - Pixel height of thumbnail. - 5 - - - - A class for Mtp Storage information. It allows applications to handle storage information. - - 5 - - - - Gets the description of the storage information. - - Description of storage. - 5 - - - - Gets the free space of the storage information in bytes. - - Free space of storage(bytes). - 5 - - - - Gets the max capacity of the storage information in bytes. - - Max capacity of storage(bytes). - 5 - - - - Gets the storage type of the storage information. - - Type of storage. - 5 - - - - Gets the volume identifier of the storage information. - - Volume identifier of stroage. - 5 - - - - Gets the root folder object. - - List of storage objects. - http://tizen.org/feature/network.mtp - - http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - - 5 - - - - Gets the list of objects. - - The parent object handle. If parentHandle is 0, it means "root folder" of mtp storage. - The file type what you want. - List of objects. - http://tizen.org/feature/network.mtp - - http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. - http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. - - Thrown when Mtp is not supported. - Thrown when method is failed due to an invalid parameter. - Thrown when the method failed due to invalid operation. - 5 - - - + + + + Tizen.Network.Mtp + + + + + A class for Mtp Device information. It allows applications to handle device information. + + 5 + + + + Gets the manufacturer name of the device information. + + Manufacture name of device. + 5 + + + + Gets the model name of the device information. + + Model name of device. + 5 + + + + Gets the serial number of the device information. + + Serial number of device. + 5 + + + + Gets the device version of the device information. + + Version number of device. + 5 + + + + Gets the list of storages. + + List of storage objects. + http://tizen.org/feature/network.mtp + Thrown when Mtp is not supported. + Thrown when the method failed due to invalid operation. + 5 + + + + Enumeration for Mtp storage type. + + 5 + + + + Undefined + + + + + fixed ROM + + + + + removable ROM + + + + + fixed RAM + + + + + removable RAM + + + + + Enumeration for Mtp file type. + + 5 + + + + Folder + + + + + Wav + + + + + Mp3 + + + + + Wma + + + + + Ogg + + + + + Audible + + + + + Mp4 + + + + + UndefAudio + + + + + Wmv + + + + + Avi + + + + + Mpeg + + + + + Asf + + + + + Qt + + + + + UndefVideo + + + + + Jpeg + + + + + Jfif + + + + + Tiff + + + + + Bmp + + + + + Gif + + + + + Pict + + + + + Png + + + + + Vcalendar1 + + + + + Vcalendar2 + + + + + Vcard2 + + + + + Vcard3 + + + + + WindowsImageFormat + + + + + WinExec + + + + + Text + + + + + Html + + + + + Firmware + + + + + Aac + + + + + Mediacard + + + + + Flac + + + + + Mp2 + + + + + M4a + + + + + Doc + + + + + Xml + + + + + Xls + + + + + Ppt + + + + + Mht + + + + + Jp2 + + + + + Jpx + + + + + Album + + + + + Playlist + + + + + Unknown + + + + + All (Helper type) + + + + + All Image (Helper type) + + + + + Enumeration for Mtp Event type. + + 5 + + + + Unknown + + + + + Storage Added + + + + + Storage Removed + + + + + Object Added + + + + + Object Removed + + + + + Device Added + + + + + Device Removed + + + + + Turned Off + + + + + Enumeration for Mtp Error. + + 5 + + + + An extended EventArgs class which contains Mtp event. + + 5 + + + + The Mtp event type. + + 5 + + + + The event parameter. + + 5 + + + + A class for MTP management. It allows applications to use MTP service. + + + http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + + 5 + + + + Gets the list of MTP devices. + + List of MtpDevice objects. + http://tizen.org/feature/network.mtp + Thrown when Mtp is not supported. + Thrown when the method failed due to invalid operation. + 5 + + + + MtpStateChanged is raised when the Mtp device state is changed. + + 5 + + + + A class for Mtp Object information. It allows applications to handle object information. + + 5 + + + + Gets the filename of the object information. + + File name of object. + 5 + + + + Gets the keywords of the object information. + + Keywords of object. + 5 + + + + Gets the association description of the object information. + + Association description of object. + 5 + + + + Gets the association type of the object information. + + Association type of object. + 5 + + + + Gets the size of the object information. + + Size of object. + 5 + + + + Gets the parent object handle of the object information. + + Handle of Parent object. + 5 + + + + Gets the mtp storage of the object information. + + Storage of object. + 5 + + + + Gets the object created time of the object information. + + Date created of object. + 5 + + + + Gets the object modified time of the object information. + + Date modified of object. + 5 + + + + Gets the file type of the object information. + + File type of object. + 5 + + + + Gets the image bit depth of the object information. + + Bit depth of image. + 5 + + + + Gets the image pixel width of the object information. + + Pixel width of image. + 5 + + + + Gets the image pixel height of the object information. + + Pixel height of image. + 5 + + + + Gets the thumbnail size of the object information. + + Size of thumbnail. + 5 + + + + Gets the thumbnail file type of the object information. + + File type of thumbnail. + 5 + + + + Gets the thumbnail pixel width of the object information. + + Pixel width of thumbnail. + 5 + + + + Gets the thumbnail pixel height of the object information. + + Pixel height of thumbnail. + 5 + + + + A class for Mtp Storage information. It allows applications to handle storage information. + + 5 + + + + Gets the description of the storage information. + + Description of storage. + 5 + + + + Gets the free space of the storage information in bytes. + + Free space of storage(bytes). + 5 + + + + Gets the max capacity of the storage information in bytes. + + Max capacity of storage(bytes). + 5 + + + + Gets the storage type of the storage information. + + Type of storage. + 5 + + + + Gets the volume identifier of the storage information. + + Volume identifier of stroage. + 5 + + + + Gets the root folder object. + + List of storage objects. + http://tizen.org/feature/network.mtp + + http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + + 5 + + + + Gets the list of objects. + + The parent object handle. If parentHandle is 0, it means "root folder" of mtp storage. + The file type what you want. + List of objects. + http://tizen.org/feature/network.mtp + + http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. + http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. + + Thrown when Mtp is not supported. + Thrown when method is failed due to an invalid parameter. + Thrown when the method failed due to invalid operation. + 5 + + + diff --git a/Artifacts/bin/Tizen.Network.Nfc.dll b/Artifacts/bin/Tizen.Network.Nfc.dll index 3bb1997..1ebe417 100644 Binary files a/Artifacts/bin/Tizen.Network.Nfc.dll and b/Artifacts/bin/Tizen.Network.Nfc.dll differ diff --git a/Artifacts/bin/Tizen.Network.Nfc.pdb b/Artifacts/bin/Tizen.Network.Nfc.pdb index decb0a6..d3ee6ef 100644 Binary files a/Artifacts/bin/Tizen.Network.Nfc.pdb and b/Artifacts/bin/Tizen.Network.Nfc.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Nfc.xml b/Artifacts/bin/Tizen.Network.Nfc.xml index 1ae94c0..f8fe2b0 100644 --- a/Artifacts/bin/Tizen.Network.Nfc.xml +++ b/Artifacts/bin/Tizen.Network.Nfc.xml @@ -1,1248 +1,1248 @@ - - - - Tizen.Network.Nfc - - - - - This structure contains the information of the Tag data. - - 3 - - - - Key value. - - 3 - - - - Information value. - - 3 - - - - This structure contains the information of the secure element AID (Application Identifier). - - 3 - - - - The Secure Element Type value. - - 3 - - - - The targeted AID (Application Identifier) value. - - 3 - - - - Read-only value. If this value is false, there are restrictions to the operation on this AID. - - 3 - - - - A class for the NFC CardEmulation mode. It allows applications to handle Card Emulation informations. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - An event that is called when receiving the Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'ESE(SmartMX)' type. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'UICC' type. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - An event that is called when receiving the HCE (Host Card Emulation) event. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - Enables the card emulation mode. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Disables the card emulation mode. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Gets the current card emulation mode. - - 3 - Enumeration value for the NfcSecureElementCardEmulationMode. - http://tizen.org/privilege/nfc.cardemulation - - - - Gives the priority to the foreground application when dispatching the transaction event. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Disables the foreground dispatch for the "EVT_TRANSACTION" to the given application. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Gets the state, whether an application to call this API is currently the activated handler for the specific AID. - - 3 - 'True' when application is currently the activated handler, otherwise 'False'. - The type of the Secure Element. - The application ID specified in the ISO/IEC 7816-4. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Gets the state, whether an application to call this API is currently the activated handler for the category. - - 3 - 'True' when application is currently the activated handler, otherwise 'False'. - The type of the secure element. - Enumeration value of the category. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Registers the AID for a specific category. - - 3 - The type of the secure element. - Enumeration value of the category. - The application ID specified in the ISO/IEC 7816-4. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Unregisters a previously registered AID for the specified category. - - 3 - The type of the secure element. - Enumeration value of the category. - The application ID specified in the ISO/IEC 7816-4. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Sets the application as a preferred handler. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Unsets the application as a preferred handler. - - 3 - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Retrieves all registered AIDs. - - 3 - The list of NfcRegisteredAidInformation objects. - The type of the secure element. - Enumeration value of the category. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Enumeration for the NFC record TNF (Type Name Format). - - 3 - - - - Empty. - - 3 - - - - The RTD (Record Type Definition) type format [NFC RTD]. - - 3 - - - - MIME media types in the RFC 2046 [RFC 2046]. - - 3 - - - - The absolute URI as defined in the RFC 3986 [RFC 3986]. - - 3 - - - - The NFC forum external type [NFC RTD]. - - 3 - - - - The payload type is unknown. - - 3 - - - - The final chunk of a chunked NDEF record. - - 3 - - - - Enumeration for the NFC encode type. - - 3 - - - - UTF-8. - - 3 - - - - UTF-16. - - 3 - - - - Enumeration for the NFC tag type. - - 3 - - - - An unknown target. - - 3 - - - - The generic PICC. - - 3 - - - - The ISO14443 A PICC. - - 3 - - - - The ISO14443 4A PICC. - - 3 - - - - The ISO14443 4A PICC. - - 3 - - - - The Mifare Mini PICC. - - 3 - - - - Mifare 1k PICC. - - 3 - - - - Mifare 4k PICC. - - 3 - - - - The Mifare Ultra PICC. - - 3 - - - - The Mifare Desfire PICC. - - 3 - - - - The Iso14443 B PICC. - - 3 - - - - Iso14443 4B PICC. - - 3 - - - - The ISO14443 B Prime PICC. - - 3 - - - - The Felica PICC. - - 3 - - - - The Jewel PICC. - - 3 - - - . - - 3 - - - - The Barcode 128 PICC. - - 3 - - - - The Barcode 256 PICC. - - 3 - - - - The NFCIP1 Target. - - 3 - - - - The NFCIP1 Initiator. - - 3 - - - - Enumeration for the NFC tag filter type. - - 3 - - - - All disable. - - 3 - - - - ISO14443A enable. - - 3 - - - - ISO14443B enable. - - 3 - - - - ISO15693 enable. - - 3 - - - - FELICA enable. - - 3 - - - - JEWEL enable. - - 3 - - - - IP enable. - - 3 - - - - All enable. - - 3 - - - - Enumeration for the NFC discovered type. - - 3 - - - - Attached, discovered, and activated event. - - 3 - - - - Detached, disappeared, and deactivated event. - - 3 - - - - Enumeration for the NFC secure element event. - - 3 - - - - Start transaction. - - 3 - - - - End transaction. - - 3 - - - - Ready signal. - - 3 - - - - The CLF (Contactless Front-end) detects a RF field. - - 3 - - - - The CLF (Contactless Front-end) detects that the RF field is off. - - 3 - - - - An external reader tries to access the secure element. - - 3 - - - - Changing the emulated secure element type. - - 3 - - - - Changing the card emulation mode. - - 3 - - - - Enumeration for the NFC filter type. - - 3 - - - - Disable card emulation. - - 3 - - - - The SmartMX type card emulation (Embedded Secure Element). - - 3 - - - - The UICC type card emulation (Universal IC Card). - - 3 - - - - The SDCARD card emulation. - - 3 - - - - The Host based card emulation. - - 3 - - - - Enumeration for the NFC discovered type. - - 3 - - - - The card emulation mode is OFF. - - 3 - - - - The card emulation mode is ON. - - 3 - - - - Enumeration for the SNEP (Simple NDEF Exchange Protocol) event. - - 3 - - - - Server or client stopped. - - 3 - - - - Server started or client connected. - - 3 - - - - Server received get request. - - 3 - - - - Server received put request. - - 3 - - - - Service registered. - - 3 - - - - Service unregistered. - - 3 - - - - Enumeration for the SNEP request type. - - 3 - - - - The get request. - - 3 - - - - The put request. - - 3 - - - - Enumeration for the NFC card emulation category type. - - 3 - - - - NFC payment services. - - 3 - - - - All other card emulation services. - - 3 - - - - Enumeration for the NFC card emulation HCE (Host Card Emulation) event type. - - 3 - - - - HCE deactivated. - - 3 - - - - HCE activated. - - 3 - - - - HCE APDU (Application Protocol Data Unit) received. - - 3 - - - - Enumeration for the NFC Error. - - 3 - - - - An extended EventArgs class which contains the changed NFC activation state. - - 3 - - - - The NFC activation state. - - 3 - - - - An extended EventArgs class which contains the changed NFC tag discovered. - - 3 - - - - The tag type. - - 3 - - - - The tag object. - - 3 - - - - An extended EventArgs class which contains the changed NFC P2P target discovered. - - 3 - - - - The P2P target type. - - 3 - - - - The P2P object. - - 3 - - - - An extended EventArgs class which contains the changed NFC NDEF discovered. - - 3 - - - - The NdefMessage object that is most recently received via the NFC P2P mode or the tag mode. - - 3 - - - - An extended EventArgs class which contains the changed secure element event. - - 3 - - - - The NFC secure element event. - - 3 - - - - An extended EventArgs class which contains the changed secure element trasaction event. - - 3 - - - - The NFC secure element type. - - 3 - - - - The NFC secure element AID. - - 3 - - - - The NFC secure element param. - - 3 - - - - An extended EventArgs class which contains the changed HCE (Host Card Emulation) event. - - 3 - - - - The NFC secure element. - - 3 - - - - The NFC HCE event. - - 3 - - - - The NFC APDU (Application Protocol Data Unit). - - 3 - - - - An extended EventArgs class which contains the changed HCE (Host Card Emulation) event. - - 3 - - - - The NFC P2P target. - - 3 - - - - The NFC NDEF message. - - 3 - - - - A class for the NFC management. It allows applications to use the NFC service. - - 3 - http://tizen.org/privilege/nfc - - - - Checks whether the NFC is supported. - - 3 - - - - The NFC Activation state. - - 3 - - - - The Tag Filter type. - - 3 - - - - The Secure Element type. - - 3 - http://tizen.org/privilege/nfc.cardemulation - - - - Enables or disables the system handling for the tag and target discovered event. - - 3 - http://tizen.org/privilege/nfc - - - - The cached NDEF message. - - 3 - - - - Gets the Tag adapter object. - - 3 - - - - Gets the P2P adapter object. - - 3 - - - - Gets the Card Emulation adapter object. - - 3 - - - - Activates the NFC asynchronously. - - 3 - A task indicates whether the Activate method is done or not. - http://tizen.org/privilege/nfc.admin - - - - The Activation changed event. - - 3 - - - - The NDEF discovered event. - - 3 - - - - A class for the NDEF Message information. It allows applications to use the NDEF Message information. - - 3 - - - - The number of records in the NDEF message. - - 3 - - - - Creates an object for the access point. - - 3 - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Appends a record into the NDEF message. - - 3 - Whether the record is appended successfully. - The NfcNdefRecord object that will be appended into the NDEF message. - - - - Inserts a record at the index into the NDEF message. - - 3 - Whether inserting the record succeeded. - The index of a record ( starts from 0 ). - The NfcNdefRecord object that will be appended into the NDEF message. - - - - Removes a record at the index into the NDEF message. - - 3 - Whether removing the record succeeded. - The index of a record ( starts from 0 ). - - - - Gets a record by the index. - - 3 - The NfcNdefRecord object. - The index of a record ( starts from 0 ). - - - - A class for the NDEF Record information. It allows applications to use the NDEF Record information. - - 3 - - - - The record ID. - - 3 - - - - The record payload. - - 3 - - - - The record type. - - 3 - - - - The record TNF (Type Name Format) value. - - 3 - - - - The text of the text type NDEF record. - - 3 - - - - The language code of the text type NDEF record. - - 3 - - - - The encoding type of the text type NDEF record. - - 3 - - - - The URI of the URI type NDEF record. - - 3 - - - - The mime type of the mime type NDEF record. - - 3 - - - - Creates a record with a given parameter value. - - 3 - The type name format. - The specified type name. - The record ID. - The payload of this record. - The byte size of the payload. - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Creates a record with the text type payload. - - 3 - The encoded text. - The language code string value followed by the IANA [RFC 3066] (ex: en-US, ko-KR). - The encoding type. - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Creates a record with the URI type payload. - - 3 - The URI string that will be stored in the payload. - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Creates a record with the mime type payload. - - 3 - The mime type [RFC 2046] (ex. text/plain, image/jpeg ). This value is stored in the type field. - The data in the form of the bytes array. - The size of the data. - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - The class for managing the P2P target information. - - 3 - - - - The event for receiving data from the NFC peer-to-peer target. - - 3 - - - - Sends data to the NFC peer-to-peer target. - - 3 - The NfcNdefMessage object. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - The class for managing the SNEP (Simple NDEF Exchange Protocol) information. - - 3 - - - - The class for the NFC P2P (Peer-to-Peer) mode. It allows applications to handle P2P informations. - - 3 - http://tizen.org/privilege/nfc - - - - The event for receiving the NFC peer-to-peer target discovered notification. - - 3 - - - - Gets the current connected P2P target. - - 3 - The NfcP2p object. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - The class for managing the Secure Element information. - - 3 - - - - Sends the APDU (Application Protocol Data Unit) response to the CLF (Contactless Front-end). - - 3 - The bytes array of the response data. - The size of the response bytes array. - http://tizen.org/privilege/nfc.cardemulation - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - The class for managing the Tag information. - - 3 - - - - The type of the NFC tag. - - 3 - - - - Whether the given NFC tag supports the NDEF messages. - - 3 - - - - The maximum NDEF message size that can be stored in the NFC tag. - - 3 - - - - The size of the NDEF message stored in the tag. - - 3 - - - - Retrieves all the tag information. - - 3 - The list of the NfcTagInformation objects. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Transceives the data of the raw format card. - - 3 - The binary data for a parameter or additional commands. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the the method fails due to an invalid operation. - - - - Reads the NDEF formatted data from the NFC tag. - - 3 - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - - Writes the NDEF formatted data. - - 3 - The NfcNdefMessage object. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Formats the detected tag that can store the NDEF message. - - 3 - The key value that may need to format the tag. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - The class for the NFC tag mode. It allows applications to handle the Tag informations. - - 3 - http://tizen.org/privilege/nfc - - - - The event for receiving the tag discovered notification. - - 3 - - - - Gets the current connected tag. - - 3 - The NfcTag object. - http://tizen.org/privilege/nfc - Thrown when the NFC is not supported. - Thrown when the method fails due to an invalid operation. - - - + + + + Tizen.Network.Nfc + + + + + This structure contains the information of the Tag data. + + 3 + + + + Key value. + + 3 + + + + Information value. + + 3 + + + + This structure contains the information of the secure element AID (Application Identifier). + + 3 + + + + The Secure Element Type value. + + 3 + + + + The targeted AID (Application Identifier) value. + + 3 + + + + Read-only value. If this value is false, there are restrictions to the operation on this AID. + + 3 + + + + A class for the NFC CardEmulation mode. It allows applications to handle Card Emulation informations. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + An event that is called when receiving the Secure Element (SIM/UICC(Universal Integrated Circuit Card)) event. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'ESE(SmartMX)' type. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + An event that is called when receiving the Secure Element (SIM/UICC (Universal Integrated Circuit Card)) transaction event for the 'UICC' type. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + An event that is called when receiving the HCE (Host Card Emulation) event. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + Enables the card emulation mode. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Disables the card emulation mode. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Gets the current card emulation mode. + + 3 + Enumeration value for the NfcSecureElementCardEmulationMode. + http://tizen.org/privilege/nfc.cardemulation + + + + Gives the priority to the foreground application when dispatching the transaction event. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Disables the foreground dispatch for the "EVT_TRANSACTION" to the given application. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Gets the state, whether an application to call this API is currently the activated handler for the specific AID. + + 3 + 'True' when application is currently the activated handler, otherwise 'False'. + The type of the Secure Element. + The application ID specified in the ISO/IEC 7816-4. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Gets the state, whether an application to call this API is currently the activated handler for the category. + + 3 + 'True' when application is currently the activated handler, otherwise 'False'. + The type of the secure element. + Enumeration value of the category. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Registers the AID for a specific category. + + 3 + The type of the secure element. + Enumeration value of the category. + The application ID specified in the ISO/IEC 7816-4. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Unregisters a previously registered AID for the specified category. + + 3 + The type of the secure element. + Enumeration value of the category. + The application ID specified in the ISO/IEC 7816-4. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Sets the application as a preferred handler. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Unsets the application as a preferred handler. + + 3 + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Retrieves all registered AIDs. + + 3 + The list of NfcRegisteredAidInformation objects. + The type of the secure element. + Enumeration value of the category. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Enumeration for the NFC record TNF (Type Name Format). + + 3 + + + + Empty. + + 3 + + + + The RTD (Record Type Definition) type format [NFC RTD]. + + 3 + + + + MIME media types in the RFC 2046 [RFC 2046]. + + 3 + + + + The absolute URI as defined in the RFC 3986 [RFC 3986]. + + 3 + + + + The NFC forum external type [NFC RTD]. + + 3 + + + + The payload type is unknown. + + 3 + + + + The final chunk of a chunked NDEF record. + + 3 + + + + Enumeration for the NFC encode type. + + 3 + + + + UTF-8. + + 3 + + + + UTF-16. + + 3 + + + + Enumeration for the NFC tag type. + + 3 + + + + An unknown target. + + 3 + + + + The generic PICC. + + 3 + + + + The ISO14443 A PICC. + + 3 + + + + The ISO14443 4A PICC. + + 3 + + + + The ISO14443 4A PICC. + + 3 + + + + The Mifare Mini PICC. + + 3 + + + + Mifare 1k PICC. + + 3 + + + + Mifare 4k PICC. + + 3 + + + + The Mifare Ultra PICC. + + 3 + + + + The Mifare Desfire PICC. + + 3 + + + + The Iso14443 B PICC. + + 3 + + + + Iso14443 4B PICC. + + 3 + + + + The ISO14443 B Prime PICC. + + 3 + + + + The Felica PICC. + + 3 + + + + The Jewel PICC. + + 3 + + + . + + 3 + + + + The Barcode 128 PICC. + + 3 + + + + The Barcode 256 PICC. + + 3 + + + + The NFCIP1 Target. + + 3 + + + + The NFCIP1 Initiator. + + 3 + + + + Enumeration for the NFC tag filter type. + + 3 + + + + All disable. + + 3 + + + + ISO14443A enable. + + 3 + + + + ISO14443B enable. + + 3 + + + + ISO15693 enable. + + 3 + + + + FELICA enable. + + 3 + + + + JEWEL enable. + + 3 + + + + IP enable. + + 3 + + + + All enable. + + 3 + + + + Enumeration for the NFC discovered type. + + 3 + + + + Attached, discovered, and activated event. + + 3 + + + + Detached, disappeared, and deactivated event. + + 3 + + + + Enumeration for the NFC secure element event. + + 3 + + + + Start transaction. + + 3 + + + + End transaction. + + 3 + + + + Ready signal. + + 3 + + + + The CLF (Contactless Front-end) detects a RF field. + + 3 + + + + The CLF (Contactless Front-end) detects that the RF field is off. + + 3 + + + + An external reader tries to access the secure element. + + 3 + + + + Changing the emulated secure element type. + + 3 + + + + Changing the card emulation mode. + + 3 + + + + Enumeration for the NFC filter type. + + 3 + + + + Disable card emulation. + + 3 + + + + The SmartMX type card emulation (Embedded Secure Element). + + 3 + + + + The UICC type card emulation (Universal IC Card). + + 3 + + + + The SDCARD card emulation. + + 3 + + + + The Host based card emulation. + + 3 + + + + Enumeration for the NFC discovered type. + + 3 + + + + The card emulation mode is OFF. + + 3 + + + + The card emulation mode is ON. + + 3 + + + + Enumeration for the SNEP (Simple NDEF Exchange Protocol) event. + + 3 + + + + Server or client stopped. + + 3 + + + + Server started or client connected. + + 3 + + + + Server received get request. + + 3 + + + + Server received put request. + + 3 + + + + Service registered. + + 3 + + + + Service unregistered. + + 3 + + + + Enumeration for the SNEP request type. + + 3 + + + + The get request. + + 3 + + + + The put request. + + 3 + + + + Enumeration for the NFC card emulation category type. + + 3 + + + + NFC payment services. + + 3 + + + + All other card emulation services. + + 3 + + + + Enumeration for the NFC card emulation HCE (Host Card Emulation) event type. + + 3 + + + + HCE deactivated. + + 3 + + + + HCE activated. + + 3 + + + + HCE APDU (Application Protocol Data Unit) received. + + 3 + + + + Enumeration for the NFC Error. + + 3 + + + + An extended EventArgs class which contains the changed NFC activation state. + + 3 + + + + The NFC activation state. + + 3 + + + + An extended EventArgs class which contains the changed NFC tag discovered. + + 3 + + + + The tag type. + + 3 + + + + The tag object. + + 3 + + + + An extended EventArgs class which contains the changed NFC P2P target discovered. + + 3 + + + + The P2P target type. + + 3 + + + + The P2P object. + + 3 + + + + An extended EventArgs class which contains the changed NFC NDEF discovered. + + 3 + + + + The NdefMessage object that is most recently received via the NFC P2P mode or the tag mode. + + 3 + + + + An extended EventArgs class which contains the changed secure element event. + + 3 + + + + The NFC secure element event. + + 3 + + + + An extended EventArgs class which contains the changed secure element trasaction event. + + 3 + + + + The NFC secure element type. + + 3 + + + + The NFC secure element AID. + + 3 + + + + The NFC secure element param. + + 3 + + + + An extended EventArgs class which contains the changed HCE (Host Card Emulation) event. + + 3 + + + + The NFC secure element. + + 3 + + + + The NFC HCE event. + + 3 + + + + The NFC APDU (Application Protocol Data Unit). + + 3 + + + + An extended EventArgs class which contains the changed HCE (Host Card Emulation) event. + + 3 + + + + The NFC P2P target. + + 3 + + + + The NFC NDEF message. + + 3 + + + + A class for the NFC management. It allows applications to use the NFC service. + + 3 + http://tizen.org/privilege/nfc + + + + Checks whether the NFC is supported. + + 3 + + + + The NFC Activation state. + + 3 + + + + The Tag Filter type. + + 3 + + + + The Secure Element type. + + 3 + http://tizen.org/privilege/nfc.cardemulation + + + + Enables or disables the system handling for the tag and target discovered event. + + 3 + http://tizen.org/privilege/nfc + + + + The cached NDEF message. + + 3 + + + + Gets the Tag adapter object. + + 3 + + + + Gets the P2P adapter object. + + 3 + + + + Gets the Card Emulation adapter object. + + 3 + + + + Activates the NFC asynchronously. + + 3 + A task indicates whether the Activate method is done or not. + http://tizen.org/privilege/nfc.admin + + + + The Activation changed event. + + 3 + + + + The NDEF discovered event. + + 3 + + + + A class for the NDEF Message information. It allows applications to use the NDEF Message information. + + 3 + + + + The number of records in the NDEF message. + + 3 + + + + Creates an object for the access point. + + 3 + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Appends a record into the NDEF message. + + 3 + Whether the record is appended successfully. + The NfcNdefRecord object that will be appended into the NDEF message. + + + + Inserts a record at the index into the NDEF message. + + 3 + Whether inserting the record succeeded. + The index of a record ( starts from 0 ). + The NfcNdefRecord object that will be appended into the NDEF message. + + + + Removes a record at the index into the NDEF message. + + 3 + Whether removing the record succeeded. + The index of a record ( starts from 0 ). + + + + Gets a record by the index. + + 3 + The NfcNdefRecord object. + The index of a record ( starts from 0 ). + + + + A class for the NDEF Record information. It allows applications to use the NDEF Record information. + + 3 + + + + The record ID. + + 3 + + + + The record payload. + + 3 + + + + The record type. + + 3 + + + + The record TNF (Type Name Format) value. + + 3 + + + + The text of the text type NDEF record. + + 3 + + + + The language code of the text type NDEF record. + + 3 + + + + The encoding type of the text type NDEF record. + + 3 + + + + The URI of the URI type NDEF record. + + 3 + + + + The mime type of the mime type NDEF record. + + 3 + + + + Creates a record with a given parameter value. + + 3 + The type name format. + The specified type name. + The record ID. + The payload of this record. + The byte size of the payload. + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Creates a record with the text type payload. + + 3 + The encoded text. + The language code string value followed by the IANA [RFC 3066] (ex: en-US, ko-KR). + The encoding type. + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Creates a record with the URI type payload. + + 3 + The URI string that will be stored in the payload. + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Creates a record with the mime type payload. + + 3 + The mime type [RFC 2046] (ex. text/plain, image/jpeg ). This value is stored in the type field. + The data in the form of the bytes array. + The size of the data. + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + The class for managing the P2P target information. + + 3 + + + + The event for receiving data from the NFC peer-to-peer target. + + 3 + + + + Sends data to the NFC peer-to-peer target. + + 3 + The NfcNdefMessage object. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + The class for managing the SNEP (Simple NDEF Exchange Protocol) information. + + 3 + + + + The class for the NFC P2P (Peer-to-Peer) mode. It allows applications to handle P2P informations. + + 3 + http://tizen.org/privilege/nfc + + + + The event for receiving the NFC peer-to-peer target discovered notification. + + 3 + + + + Gets the current connected P2P target. + + 3 + The NfcP2p object. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + The class for managing the Secure Element information. + + 3 + + + + Sends the APDU (Application Protocol Data Unit) response to the CLF (Contactless Front-end). + + 3 + The bytes array of the response data. + The size of the response bytes array. + http://tizen.org/privilege/nfc.cardemulation + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + The class for managing the Tag information. + + 3 + + + + The type of the NFC tag. + + 3 + + + + Whether the given NFC tag supports the NDEF messages. + + 3 + + + + The maximum NDEF message size that can be stored in the NFC tag. + + 3 + + + + The size of the NDEF message stored in the tag. + + 3 + + + + Retrieves all the tag information. + + 3 + The list of the NfcTagInformation objects. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Transceives the data of the raw format card. + + 3 + The binary data for a parameter or additional commands. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the the method fails due to an invalid operation. + + + + Reads the NDEF formatted data from the NFC tag. + + 3 + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + + Writes the NDEF formatted data. + + 3 + The NfcNdefMessage object. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Formats the detected tag that can store the NDEF message. + + 3 + The key value that may need to format the tag. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + The class for the NFC tag mode. It allows applications to handle the Tag informations. + + 3 + http://tizen.org/privilege/nfc + + + + The event for receiving the tag discovered notification. + + 3 + + + + Gets the current connected tag. + + 3 + The NfcTag object. + http://tizen.org/privilege/nfc + Thrown when the NFC is not supported. + Thrown when the method fails due to an invalid operation. + + + diff --git a/Artifacts/bin/Tizen.Network.Nsd.dll b/Artifacts/bin/Tizen.Network.Nsd.dll index daf1800..46d5ae7 100644 Binary files a/Artifacts/bin/Tizen.Network.Nsd.dll and b/Artifacts/bin/Tizen.Network.Nsd.dll differ diff --git a/Artifacts/bin/Tizen.Network.Nsd.pdb b/Artifacts/bin/Tizen.Network.Nsd.pdb index b4ef4e7..9b02046 100644 Binary files a/Artifacts/bin/Tizen.Network.Nsd.pdb and b/Artifacts/bin/Tizen.Network.Nsd.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Nsd.xml b/Artifacts/bin/Tizen.Network.Nsd.xml index 75fd7c3..c56e5b3 100644 --- a/Artifacts/bin/Tizen.Network.Nsd.xml +++ b/Artifacts/bin/Tizen.Network.Nsd.xml @@ -1,486 +1,486 @@ - - - - Tizen.Network.Nsd - - - - - Interop class for Nsd - - - - - Nsd Native Apis - - - - - This class is used for managing network service discovery using DNSSD. - - 4 - - - - This event is raised when a DNSSD service is found during service discovery. - - 4 - - - - A public constructor for DnssdBrowser class to create a DnssdBrowser instance for the given service type. - - The DNSSD service type - 4 - http://tizen.org/feature/network.dnssd - Thrown when serviceType is null. - Thrown when DNSSD is not supported. - - - - Starts browsing the DNSSD remote service. - - - If there are any services available, ServiceFound event will be invoked. - Application will keep browsing for available/unavailable services until it calls StopDiscovery(). - - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.dnssd - Thrown when any other error occurred. - Thrown when DNSSD is not supported. - Thrown when permission is denied. - - - - Stops browsing the DNSSD remote service. - - 4 - http://tizen.org/feature/network.dnssd - Thrown when any other error occurred. - Thrown when DNSSD is not supported. - - - - This class is used for managing local service registration and its properties using DNSSD. - - 4 - - - - Constructor to create DnssdService instance that sets the serviceType to a given value. - - 4 - The DNSSD service type. It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp"). - It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens. - - http://tizen.org/feature/network.dnssd - Thrown while setting this property when DNSSD is not supported. - Thrown when serviceType is set to null. - - - - Name of DNSSD service. - - - Set Name for only unregistered service created locally. - It may be up to 63 bytes. - In case of error, null will be returned during get and exception will be thrown during set. - - 4 - http://tizen.org/feature/network.dnssd - Thrown while setting this property when DNSSD is not supported. - Thrown when Name value is set to null. - Thrown while setting this property when any other error occurred. - - - - Type of DNSSD local/remote service. - - - It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp"). - It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens. - In case of error, null will be returned. - - 4 - - - - Port number of DNSSD local/remote service. - - - Set Port for only unregistered service created locally. The default value of Port is 0. - In case of error, -1 will be returned during get and exception will be thrown during set. - - 4 - http://tizen.org/feature/network.dnssd - Thrown while setting this property when DNSSD is not supported. - Thrown if value of Port is set to less than 0 or more than 65535. - Thrown while setting this property when any other error occurred. - - - - IP address of DNSSD remote service. - - - If the remote service has no IPv4 Address, then IPv4Address would contain null and if it has no IPv6 Address, then IPv6Address would contain null. - In case of error, null object will be returned. - - 4 - - - - Adds the TXT record. - - - TXT record should be added after registering local service using RegisterService(). - - 4 - The key of the TXT record. It must be a null-terminated string with 9 characters or fewer excluding null. It is case insensitive. - The value of the TXT record.If null, then "key" will be added with no value. If non-null but value_length is zero, then "key=" will be added with empty value. - http://tizen.org/feature/network.dnssd - Thrown when DNSSD is not supported. - Thrown when value of key is null. - Thrown when any other error occurred. - - - - Removes the TXT record. - - 4 - The key of the TXT record to be removed. - http://tizen.org/feature/network.dnssd - Thrown when DNSSD is not supported. - Thrown when value of key is null. - Thrown when any other error occurred. - - - - Registers the DNSSD local service for publishing. - - Name of the service must be set. - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.dnssd - Thrown when any other error occurred. - Thrown when DNSSD is not supported. - Thrown when permission is denied. - - - - Deregisters the DNSSD local service. - - - A local service registered using RegisterService() must be passed. - - 4 - http://tizen.org/feature/network.dnssd - Thrown when any other error occurred. - Thrown when DNSSD is not supported. - - - - Disposes the memory allocated to unmanaged resources. - - 4 - - - - This class manages the IP address properties of DNSSD service. - - 4 - - - - The IP version 4 address of DNSSD service. - - 4 - - - - The IP version 6 address of DNSSD service. - - 4 - - - - This interface is used for managing network service discovery using DNSSD/SSDP. - - - - - Starts browsing the DNSSD/SSDP remote service. - - - If there are any services available, ServiceFound event will be invoked. - Application will keep browsing for available/unavailable services until it calls StopDiscovery(). - - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.dnssd - http://tizen.org/feature/network.ssdp - Thrown when any other error occured. - Thrown when DNSSD/SSDP is not supported. - Thrown when permission is denied. - - - - Stops browsing the DNSSD/SSDP remote service. - - 4 - http://tizen.org/feature/network.dnssd - http://tizen.org/feature/network.ssdp - Thrown when any other error occured. - Thrown when DNSSD/SSDP is not supported. - - - - This interface is used for managing local service registration using DNSSD/SSDP. - - - - - Registers the DNSSD/SSDP local service for publishing. - - - A service created locally must be passed. - - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.dnssd - http://tizen.org/feature/network.ssdp - Thrown when any other error occurred. - Thrown when DNSSD/SSDP is not supported. - Thrown when permission is denied. - - - - Deregisters the DNSSD/SSDP local service. - - - A local service registered using RegisterService() must be passed. - - 4 - http://tizen.org/feature/network.dnssd - http://tizen.org/feature/network.ssdp - Thrown when any other error occurred. - Thrown when DNSSD/SSDP is not supported. - - - - Enumeration for DNS-SD service state. - - 4 - - - - Available DNS-SD service found. - - - - - DNS-SD service not available. - - - - - Lookup failure for service name. - - - - - Lookup failure for host name and port number. - - - - - Lookup failure for IP address. - - - - - Enumeration for SSDP service state. - - 4 - - - - Available SSDP service found. - - - - - SSDP service not available. - - - - - An extended EventArgs class which contains changed service state during service discovery using DNSSD. - - 4 - - - - DNSSD service state. - - 4 - - - - DNSSD service instance. - - 4 - - - - An extended EventArgs class which contains changed service state during service discovery using SSDP. - - 4 - - - - SSDP service state. - - 4 - - - - SSDP service instance. - - 4 - - - - This class is used for managing network service discovery using SSDP. - - 4 - - - - This event is raised when service has become available or unavailable during service discovery using SSDP. - - 4 - - - - A public constructor for SsdpBrowser class to create a SsdpBrowser instance for the given target. - - 4 - The target to browse for the service. - http://tizen.org/feature/network.ssdp - Thrown when target is null. - Thrown when SSDP is not supported. - - - - Starts browsing the SSDP remote service. - - - If there are any services available, ServiceFound event will be invoked. - Application will keep browsing for available/unavailable services until it calls StopDiscovery(). - - 4 - http://tizen.org/feature/network.ssdp - Thrown when any other error occured. - Thrown when SSDP is not supported. - - - - Stops browsing the SSDP remote service. - - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.ssdp - Thrown when any other error occured. - Thrown when SSDP is not supported. - Thrown when permission is denied. - - - - This class is used for managing local service registration and its properties using SSDP. - - 4 - - - - Constructor to create SsdpService instance that sets the target to a given value. - - 4 - The SSDP local service's target. It may be a device type or a service type. - http://tizen.org/feature/network.ssdp - Thrown while setting this property when SSDP is not supported. - Thrown when target is set to null. - - - - Unique Service Name of SSDP service. - - - Set Usn for only unregistered service created locally. If service is already registered, Usn will not be set. - In case of error, null will be returned during get and exception will be thrown during set. - - 4 - http://tizen.org/feature/network.ssdp - Thrown while setting this property when SSDP is not supported. - Thrown when Usn value is set to null. - Thrown while setting this property when any other error occurred. - - - - Target of SSDP service. - - - It may be a device type or a service type specified in UPnP forum (http://upnp.org). - In case of error, null will be returned. - - 4 - - - - URL of SSDP service. - - - Set Url for only unregistered service created locally. If service is already registered, Url will not be set. - In case of error, null will be returned during get and exception will be thrown during set. - - 4 - http://tizen.org/feature/network.ssdp - Thrown while setting this property when SSDP is not supported. - Thrown when Url value is set to null. - Thrown while setting this property when any other error occurred. - - - - Registers the SSDP local service for publishing. - - - A service created locally must be passed. - Url and Usn of the service must be set before RegisterService is called. - - 4 - http://tizen.org/privilege/internet - http://tizen.org/feature/network.ssdp - Thrown when any other error occurred. - Thrown when SSDP is not supported. - Thrown when permission is denied. - - - - Deregisters the SSDP local service. - - - A local service registered using RegisterService() must be passed. - - 4 - http://tizen.org/feature/network.ssdp - Thrown when any other error occurred. - Thrown when SSDP is not supported. - - - - Disposes the memory allocated to unmanaged resources. - - 4 - - - + + + + Tizen.Network.Nsd + + + + + Interop class for Nsd + + + + + Nsd Native Apis + + + + + This class is used for managing network service discovery using DNSSD. + + 4 + + + + This event is raised when a DNSSD service is found during service discovery. + + 4 + + + + A public constructor for DnssdBrowser class to create a DnssdBrowser instance for the given service type. + + The DNSSD service type + 4 + http://tizen.org/feature/network.dnssd + Thrown when serviceType is null. + Thrown when DNSSD is not supported. + + + + Starts browsing the DNSSD remote service. + + + If there are any services available, ServiceFound event will be invoked. + Application will keep browsing for available/unavailable services until it calls StopDiscovery(). + + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.dnssd + Thrown when any other error occurred. + Thrown when DNSSD is not supported. + Thrown when permission is denied. + + + + Stops browsing the DNSSD remote service. + + 4 + http://tizen.org/feature/network.dnssd + Thrown when any other error occurred. + Thrown when DNSSD is not supported. + + + + This class is used for managing local service registration and its properties using DNSSD. + + 4 + + + + Constructor to create DnssdService instance that sets the serviceType to a given value. + + 4 + The DNSSD service type. It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp"). + It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens. + + http://tizen.org/feature/network.dnssd + Thrown while setting this property when DNSSD is not supported. + Thrown when serviceType is set to null. + + + + Name of DNSSD service. + + + Set Name for only unregistered service created locally. + It may be up to 63 bytes. + In case of error, null will be returned during get and exception will be thrown during set. + + 4 + http://tizen.org/feature/network.dnssd + Thrown while setting this property when DNSSD is not supported. + Thrown when Name value is set to null. + Thrown while setting this property when any other error occurred. + + + + Type of DNSSD local/remote service. + + + It is expressed as type followed by protocol, separated by a dot(e.g. "_ftp._tcp"). + It must begin with an underscore, followed by 1-15 characters which may be letters, digits or hyphens. + In case of error, null will be returned. + + 4 + + + + Port number of DNSSD local/remote service. + + + Set Port for only unregistered service created locally. The default value of Port is 0. + In case of error, -1 will be returned during get and exception will be thrown during set. + + 4 + http://tizen.org/feature/network.dnssd + Thrown while setting this property when DNSSD is not supported. + Thrown if value of Port is set to less than 0 or more than 65535. + Thrown while setting this property when any other error occurred. + + + + IP address of DNSSD remote service. + + + If the remote service has no IPv4 Address, then IPv4Address would contain null and if it has no IPv6 Address, then IPv6Address would contain null. + In case of error, null object will be returned. + + 4 + + + + Adds the TXT record. + + + TXT record should be added after registering local service using RegisterService(). + + 4 + The key of the TXT record. It must be a null-terminated string with 9 characters or fewer excluding null. It is case insensitive. + The value of the TXT record.If null, then "key" will be added with no value. If non-null but value_length is zero, then "key=" will be added with empty value. + http://tizen.org/feature/network.dnssd + Thrown when DNSSD is not supported. + Thrown when value of key is null. + Thrown when any other error occurred. + + + + Removes the TXT record. + + 4 + The key of the TXT record to be removed. + http://tizen.org/feature/network.dnssd + Thrown when DNSSD is not supported. + Thrown when value of key is null. + Thrown when any other error occurred. + + + + Registers the DNSSD local service for publishing. + + Name of the service must be set. + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.dnssd + Thrown when any other error occurred. + Thrown when DNSSD is not supported. + Thrown when permission is denied. + + + + Deregisters the DNSSD local service. + + + A local service registered using RegisterService() must be passed. + + 4 + http://tizen.org/feature/network.dnssd + Thrown when any other error occurred. + Thrown when DNSSD is not supported. + + + + Disposes the memory allocated to unmanaged resources. + + 4 + + + + This class manages the IP address properties of DNSSD service. + + 4 + + + + The IP version 4 address of DNSSD service. + + 4 + + + + The IP version 6 address of DNSSD service. + + 4 + + + + This interface is used for managing network service discovery using DNSSD/SSDP. + + + + + Starts browsing the DNSSD/SSDP remote service. + + + If there are any services available, ServiceFound event will be invoked. + Application will keep browsing for available/unavailable services until it calls StopDiscovery(). + + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.dnssd + http://tizen.org/feature/network.ssdp + Thrown when any other error occured. + Thrown when DNSSD/SSDP is not supported. + Thrown when permission is denied. + + + + Stops browsing the DNSSD/SSDP remote service. + + 4 + http://tizen.org/feature/network.dnssd + http://tizen.org/feature/network.ssdp + Thrown when any other error occured. + Thrown when DNSSD/SSDP is not supported. + + + + This interface is used for managing local service registration using DNSSD/SSDP. + + + + + Registers the DNSSD/SSDP local service for publishing. + + + A service created locally must be passed. + + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.dnssd + http://tizen.org/feature/network.ssdp + Thrown when any other error occurred. + Thrown when DNSSD/SSDP is not supported. + Thrown when permission is denied. + + + + Deregisters the DNSSD/SSDP local service. + + + A local service registered using RegisterService() must be passed. + + 4 + http://tizen.org/feature/network.dnssd + http://tizen.org/feature/network.ssdp + Thrown when any other error occurred. + Thrown when DNSSD/SSDP is not supported. + + + + Enumeration for DNS-SD service state. + + 4 + + + + Available DNS-SD service found. + + + + + DNS-SD service not available. + + + + + Lookup failure for service name. + + + + + Lookup failure for host name and port number. + + + + + Lookup failure for IP address. + + + + + Enumeration for SSDP service state. + + 4 + + + + Available SSDP service found. + + + + + SSDP service not available. + + + + + An extended EventArgs class which contains changed service state during service discovery using DNSSD. + + 4 + + + + DNSSD service state. + + 4 + + + + DNSSD service instance. + + 4 + + + + An extended EventArgs class which contains changed service state during service discovery using SSDP. + + 4 + + + + SSDP service state. + + 4 + + + + SSDP service instance. + + 4 + + + + This class is used for managing network service discovery using SSDP. + + 4 + + + + This event is raised when service has become available or unavailable during service discovery using SSDP. + + 4 + + + + A public constructor for SsdpBrowser class to create a SsdpBrowser instance for the given target. + + 4 + The target to browse for the service. + http://tizen.org/feature/network.ssdp + Thrown when target is null. + Thrown when SSDP is not supported. + + + + Starts browsing the SSDP remote service. + + + If there are any services available, ServiceFound event will be invoked. + Application will keep browsing for available/unavailable services until it calls StopDiscovery(). + + 4 + http://tizen.org/feature/network.ssdp + Thrown when any other error occured. + Thrown when SSDP is not supported. + + + + Stops browsing the SSDP remote service. + + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.ssdp + Thrown when any other error occured. + Thrown when SSDP is not supported. + Thrown when permission is denied. + + + + This class is used for managing local service registration and its properties using SSDP. + + 4 + + + + Constructor to create SsdpService instance that sets the target to a given value. + + 4 + The SSDP local service's target. It may be a device type or a service type. + http://tizen.org/feature/network.ssdp + Thrown while setting this property when SSDP is not supported. + Thrown when target is set to null. + + + + Unique Service Name of SSDP service. + + + Set Usn for only unregistered service created locally. If service is already registered, Usn will not be set. + In case of error, null will be returned during get and exception will be thrown during set. + + 4 + http://tizen.org/feature/network.ssdp + Thrown while setting this property when SSDP is not supported. + Thrown when Usn value is set to null. + Thrown while setting this property when any other error occurred. + + + + Target of SSDP service. + + + It may be a device type or a service type specified in UPnP forum (http://upnp.org). + In case of error, null will be returned. + + 4 + + + + URL of SSDP service. + + + Set Url for only unregistered service created locally. If service is already registered, Url will not be set. + In case of error, null will be returned during get and exception will be thrown during set. + + 4 + http://tizen.org/feature/network.ssdp + Thrown while setting this property when SSDP is not supported. + Thrown when Url value is set to null. + Thrown while setting this property when any other error occurred. + + + + Registers the SSDP local service for publishing. + + + A service created locally must be passed. + Url and Usn of the service must be set before RegisterService is called. + + 4 + http://tizen.org/privilege/internet + http://tizen.org/feature/network.ssdp + Thrown when any other error occurred. + Thrown when SSDP is not supported. + Thrown when permission is denied. + + + + Deregisters the SSDP local service. + + + A local service registered using RegisterService() must be passed. + + 4 + http://tizen.org/feature/network.ssdp + Thrown when any other error occurred. + Thrown when SSDP is not supported. + + + + Disposes the memory allocated to unmanaged resources. + + 4 + + + diff --git a/Artifacts/bin/Tizen.Network.Smartcard.dll b/Artifacts/bin/Tizen.Network.Smartcard.dll index fd9bd58..0f4c087 100644 Binary files a/Artifacts/bin/Tizen.Network.Smartcard.dll and b/Artifacts/bin/Tizen.Network.Smartcard.dll differ diff --git a/Artifacts/bin/Tizen.Network.Smartcard.pdb b/Artifacts/bin/Tizen.Network.Smartcard.pdb index 86daf4a..26b4bf9 100644 Binary files a/Artifacts/bin/Tizen.Network.Smartcard.pdb and b/Artifacts/bin/Tizen.Network.Smartcard.pdb differ diff --git a/Artifacts/bin/Tizen.Network.Smartcard.xml b/Artifacts/bin/Tizen.Network.Smartcard.xml index 6b0629c..cf0e3ca 100644 --- a/Artifacts/bin/Tizen.Network.Smartcard.xml +++ b/Artifacts/bin/Tizen.Network.Smartcard.xml @@ -1,187 +1,187 @@ - - - - Tizen.Network.Smartcard - - - - - The class for Smartcard channel information. It allows applications to handle the channel information. - - 3 - http://tizen.org/privilege/secureelement - - - - Whether the kind of channel is basic. - - 3 - - - - Whether the kind of channel is logical. - - 3 - - - - Whether the channel is closed. - - 3 - - - - The session that has opened the given channel. - - 3 - - - - Closes the given channel to the Secure Element. - - 3 - Thrown when the Smartcard is not supported. - Thrown when the method failed due to an invalid operation. - - - - Gets the response to the select command. - - 3 - Byte array to retrieve the select response. - - - - Transmits the APDU command (as per ISO/IEC 7816-4) to the secure element. - - 3 - Byte array for the response APDU plus status words. - Command APDU to be sent to the secure element. - - - - Helper function to retrieve the response APDU of the previous transmit() call. - - 3 - Byte array for the response APDU plus status words. - - - - Performs a selection of the next applet on the given channel that matches to the partial application ID (AID). - - 3 - True or false depending whether another applet with the partial application ID (AID). - - - - The class for Smartcard management. It allows applications to use the Smartcard service. - - 3 - http://tizen.org/privilege/secureelement - - - - Gets the list of available secure element readers. - - 3 - List of SmartcardReader objects. - - - - The class for Smartcard reader information. It allows applications to handle the reader information. - - 3 - http://tizen.org/privilege/secureelement - - - - The name of the reader. - - 3 - - - - The existence of a secure element. - - 3 - - - - Connects to a secure element in the given reader. - - 3 - The SmartcardSession object. - - - - Closes all the sessions opened on the given reader. - - 3 - Thrown when the Smartcard is not supported. - Thrown when the method failed due to an invalid operation. - - - - The class for the Smartcard session information. It allows applications to handle the session information. - - 3 - http://tizen.org/privilege/secureelement - - - - The reader object that provides the given session. - - 3 - - - - The Answer to Reset (ATR) of this secure element. - - 3 - - - - Whether the session is closed. - - 3 - - - - Closes the connection with the secure element. - - 3 - Thrown when the Smartcard is not supported. - Thrown when the method failed due to invalid operation. - - - - Closes any channel opened on the given session. - - 3 - Thrown when the Smartcard is not supported. - Thrown when the method failed due to an invalid operation. - - - - Gets an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has number 0). - - 3 - The SmartcardChannel object for the basic channel. - The byte array containing the Application ID(AID) to be selected on the given channel. - P2 byte of the SELECT command if executed. - Thrown when the Smartcard is not supported. - Thrown when the method failed due to invalid operation. - - - - Open a logical channel with the secure element, selecting the Applet represented by the given application ID (AID). - - 3 - The SmartcardChannel object for the logical channel. - The byte array containing the Application ID(AID) to be selected on the given channel. - P2 byte of the SELECT command if executed. - Thrown when the Smartcard is not supported. - Thrown when the method failed due to an invalid operation. - - - + + + + Tizen.Network.Smartcard + + + + + The class for Smartcard channel information. It allows applications to handle the channel information. + + 3 + http://tizen.org/privilege/secureelement + + + + Whether the kind of channel is basic. + + 3 + + + + Whether the kind of channel is logical. + + 3 + + + + Whether the channel is closed. + + 3 + + + + The session that has opened the given channel. + + 3 + + + + Closes the given channel to the Secure Element. + + 3 + Thrown when the Smartcard is not supported. + Thrown when the method failed due to an invalid operation. + + + + Gets the response to the select command. + + 3 + Byte array to retrieve the select response. + + + + Transmits the APDU command (as per ISO/IEC 7816-4) to the secure element. + + 3 + Byte array for the response APDU plus status words. + Command APDU to be sent to the secure element. + + + + Helper function to retrieve the response APDU of the previous transmit() call. + + 3 + Byte array for the response APDU plus status words. + + + + Performs a selection of the next applet on the given channel that matches to the partial application ID (AID). + + 3 + True or false depending whether another applet with the partial application ID (AID). + + + + The class for Smartcard management. It allows applications to use the Smartcard service. + + 3 + http://tizen.org/privilege/secureelement + + + + Gets the list of available secure element readers. + + 3 + List of SmartcardReader objects. + + + + The class for Smartcard reader information. It allows applications to handle the reader information. + + 3 + http://tizen.org/privilege/secureelement + + + + The name of the reader. + + 3 + + + + The existence of a secure element. + + 3 + + + + Connects to a secure element in the given reader. + + 3 + The SmartcardSession object. + + + + Closes all the sessions opened on the given reader. + + 3 + Thrown when the Smartcard is not supported. + Thrown when the method failed due to an invalid operation. + + + + The class for the Smartcard session information. It allows applications to handle the session information. + + 3 + http://tizen.org/privilege/secureelement + + + + The reader object that provides the given session. + + 3 + + + + The Answer to Reset (ATR) of this secure element. + + 3 + + + + Whether the session is closed. + + 3 + + + + Closes the connection with the secure element. + + 3 + Thrown when the Smartcard is not supported. + Thrown when the method failed due to invalid operation. + + + + Closes any channel opened on the given session. + + 3 + Thrown when the Smartcard is not supported. + Thrown when the method failed due to an invalid operation. + + + + Gets an access to the basic channel, as defined in the ISO/IEC 7816-4 specification (the one that has number 0). + + 3 + The SmartcardChannel object for the basic channel. + The byte array containing the Application ID(AID) to be selected on the given channel. + P2 byte of the SELECT command if executed. + Thrown when the Smartcard is not supported. + Thrown when the method failed due to invalid operation. + + + + Open a logical channel with the secure element, selecting the Applet represented by the given application ID (AID). + + 3 + The SmartcardChannel object for the logical channel. + The byte array containing the Application ID(AID) to be selected on the given channel. + P2 byte of the SELECT command if executed. + Thrown when the Smartcard is not supported. + Thrown when the method failed due to an invalid operation. + + + diff --git a/Artifacts/bin/Tizen.Network.WiFi.dll b/Artifacts/bin/Tizen.Network.WiFi.dll index 326c305..27ef4a3 100644 Binary files a/Artifacts/bin/Tizen.Network.WiFi.dll and b/Artifacts/bin/Tizen.Network.WiFi.dll differ diff --git a/Artifacts/bin/Tizen.Network.WiFi.pdb b/Artifacts/bin/Tizen.Network.WiFi.pdb index 986349c..ef556d2 100644 Binary files a/Artifacts/bin/Tizen.Network.WiFi.pdb and b/Artifacts/bin/Tizen.Network.WiFi.pdb differ diff --git a/Artifacts/bin/Tizen.Network.WiFi.xml b/Artifacts/bin/Tizen.Network.WiFi.xml index 70ff6c9..183d69c 100644 --- a/Artifacts/bin/Tizen.Network.WiFi.xml +++ b/Artifacts/bin/Tizen.Network.WiFi.xml @@ -1,1140 +1,1140 @@ - - - - Tizen.Network.WiFi - - - - - An extended EventArgs class which contains the changed connection state. - - 3 - - - - The Wi-Fi connection state. - - 3 - - - - The access point. - - 3 - - - - An extended EventArgs class which contains the changed device state. - - 3 - - - - The Wi-Fi device state. - - 3 - - - - An abstract class for the Wi-Fi EAP information. - - 3 - - - - The file path of CA Certificate of EAP. - - 3 - - - - The EAP type of the Wi-Fi. - - 3 - - - - The type of EAP phase2 authentication of the Wi-Fi. - - 3 - - - - An extended EventArgs class which contains the changed RSSI level. - - 3 - - - - The Wi-Fi RSSI level. - - 3 - - - - DHCP server address. It is only supported for IPv4 address family. - - Represents DHCP server address. - - - - A class for managing the network information of the access point (AP). - - 3 - - - - The network information of the access point (AP). - - 3 - The WiFiNetwork instance containing the network information of the AP. - - - - The security information of the access point (AP). - - 3 - The WiFiSecurity instance containing security information of the AP. - - - - Creates an object for the access point. - - 3 - The Extended Service Set Identifier of the access point. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the ESSID is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid operation. - - - - Creates an object for the hidden access point. - - 3 - The Extended Service Set Identifier of the access point. - The value to set a hidden AP. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the ESSID is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid operation. - - - - A method to destroy the managed WiFiAP objects. - - 3 - - - - Refreshes the access point information. - - 3 - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the object instance is disposed or released. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Connects the access point asynchronously. - - 3 - A task indicating whether the connect method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the object instance is disposed or released. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Connects the access point with the WPS asynchronously. - - 3 - A WpsInfo instance which is type of WpsPbcInfo or WpsPinInfo. - A task indicating whether the ConnectWps method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.profile - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the object instance is disposed or released. - Thrown when the WpsPinInfo object is constructed with a null pin. - Thrown when the WpsPinInfo object is constructed with a pin which is an empty string or more than 7 characters. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Connects the access point with WPS without SSID asynchronously. - - 3 - A WpsInfo instance which is of type WpsPbcInfo or WpsPinInfo. - A task which contains Connected access point information. - - If WpsPinInfo is used, its object has to be constructed with a pin which must be 4 or 8 characters long. - - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - http://tizen.org/privilege/network.profile - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the WpsPinInfo object is constructed with a null pin. - Thrown when the WpsPinInfo object is constructed with a pin which is not of 4 or 8 characters long. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Disconnects the access point asynchronously. - - 3 - A task indicating whether the disconnect method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the object instance is disposed or released. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - - An abstract class which is used to represent the WPS information of the access point. - - 3 - - - - A class which is used to represent WPS PBC information of the access point. - - - - - A class which is used to represent WPS PIN information of the access point. - - - - - A public constructor which instantiates WpsPinInfo class with the given pin. - - 3 - WPS Pin of the access point. - - Pin should not be null or empty. It should be of less than 8 characters. - - - - - A class for managing the configuration of Wi-Fi. - - 3 - - - - The name of the access point (AP). - - 3 - Name assigned to AP in the Wi-Fi configuration. - - - - The security type of the access point (AP). - - 3 - Security type of AP in the Wi-Fi configuration. - - - - The proxy address. - - 3 - Proxy address of the access point. - Thrown while setting this property when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - A property check whether the access point (AP) is hidden. - - 3 - Boolean value indicating whether the AP is hidden. - Thrown while setting this property when the Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - EAP configuration. - - 3 - EAP configuration assigned to the Wi-Fi. - - - - Creates a WiFiConfiguration object with the given name, passphrase, and securetype. - - 3 - Name of the Wi-Fi. - Password to access the Wi-Fi. - Security type of the Wi-Fi. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when permission is denied. - Thrown when the object is constructed with name as null. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - A method to destroy the managed objects in the WiFiConfiguration. - - 3 - - - - A class for managing the EAP information of the access point (AP). - - 3 - - - - The file path of CA Certificate of EAP. - - 3 - CA certification file of EAP. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this value when the file value is null. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The EAP type of Wi-Fi. - - 3 - Type of EAP. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The type of EAP phase 2 authentication of the Wi-Fi. - - 3 - Authentication type of the Wi-Fi. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - Gets the private key file of EAP. - - 3 - The file path of private key. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the system is out of memory. - Thrown when the method fails due to an invalid parameter. - Thrown when the method fails due to an invalid operation. - - - - Sets the private key information of EAP. - - 3 - The file path of private key. - The password. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the file path of private key is null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due an to invalid operation. - - - - Gets the client certificate of EAP. - - 3 - The file path of client certificate. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due an to invalid operation. - - - - Sets the CA certificate of EAP. - - 3 - The file path of client certificate. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the file path of client certificate is null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Gets the username of EAP passphrase. - - 3 - The user name - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Returns whether the password is set or not. - - 3 - True if password is set, false if password is not set. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Sets the user name of EAP. - - 3 - The user name - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the user name is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Sets the password of EAP. - - 3 - The password - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the password is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - A class for managing the EAP configuration. - - 3 - - - - The file path of CA certificate of EAP. - - 3 - CA certification file of EAP. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The EAP type of the Wi-Fi. - - 3 - Type of EAP. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The type of EAP phase2 authentication of the Wi-Fi. - - 3 - Authentication type of the Wi-Fi. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The anonymous identity of the access point (AP). - - 3 - Represents the anonymous identity of the access point. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The identity of the access point (AP). - - 3 - Represents the identity of the access point. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The subject match of the access point (AP). - - 3 - Represents the subject match of the AP. - Thrown while setting this value when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - Gets the access point client certificate file from the configuration. - - 3 - The certification authority (CA) certificates file of the access point. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Sets the access point client certificate file to configuration. - - 3 - The private key file. - The certification authority(CA) certifies the files of access points. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Enumeration for the Wi-Fi EAP types. - - 3 - - - - EAP PEAP type. - - 3 - - - - EAP TLS type. - - 3 - - - - The EAP TTLS type. - - 3 - - - - EAP SIM type. - - 3 - - - - EAP AKA type. - - 3 - - - - Enumeration for the Wi-Fi RSSI levels. - - 3 - - - - Level 0. - - 3 - - - - Level 1. - - 3 - - - - Level 2. - - 3 - - - - Level 3. - - 3 - - - - Level 4. - - 3 - - - - Enumeration for the Wi-Fi connection states. - - 3 - - - - Connection failed state. - - 3 - - - - Disconnected state. - - 3 - - - - Association state. - - 3 - - - - Configuration state. - - 3 - - - - Connected state. - - 3 - - - - Enumeration for the Wi-Fi device states. - - 3 - - - - Wi-Fi is deactivated. - - 3 - - - - Wi-Fi is activated. - - 3 - - - - Enumeration for the Wi-Fi proxy types. - - 3 - - - - Direct connection. - - 3 - - - - Auto configuration(Use PAC file). If the URL property is not set, DHCP/WPAD auto-discover will be tried. - - 3 - - - - Manual configuration. - - 3 - - - - Enumeration for the Wi-Fi authentication types. - - 3 - - - - EAP phase 2 authentication none. - - 3 - - - - EAP phase 2 authentication PAP. - - 3 - - - - EAP phase 2 authentication MSCHAP. - - 3 - - - - EAP phase 2 authentication MSCHAPv2. - - 3 - - - - EAP phase 2 authentication GTC. - - 3 - - - - EAP phase 2 authentication MD5. - - 3 - - - - A class for managing the WiFiManager handle. - - - - - Checks the validity of the handle. - - Represents the validity of the handle. - - - - - The local MAC address. - - 3 - Represents the MAC address of the Wi-Fi. - http://tizen.org/privilege/network.get - - - - The name of the network interface. - - 3 - Interface name of the Wi-Fi. - http://tizen.org/privilege/network.get - - - - The network connection state. - - 3 - Represents the connection state of the Wi-Fi. - http://tizen.org/privilege/network.get - - - - A property to check whether Wi-Fi is activated. - - 3 - Boolean value to check whether Wi-Fi is activated or not. - http://tizen.org/privilege/network.get - - - - DeviceStateChanged is raised when the device state is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.wifi - - - - ConnectionStateChanged is raised when the connection state is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.wifi - - - - RssiLevelChanged is raised when the RSSI of the connected Wi-Fi is changed. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.wifi - - - - BackgroundScanFinished is raised when the background scan is finished. - The background scan starts automatically when Wi-Fi is activated. The callback will be invoked periodically. - - 3 - http://tizen.org/privilege/network.get - http://tizen.org/feature/network.wifi - - - - Gets the Wi-Fi safe handle. - - 3 - The instance of the SafeWiFiManagerHandle. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Gets the result of the scan. - - 3 - A list of the WiFiAP objects. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Gets the result of a specific AP scan. - - 3 - A list containing the WiFiAP objects. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Gets the list of Wi-Fi configurations. - - 3 - A list containing the WiFiConfiguration objects. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.profile - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Saves the Wi-Fi configuration of the access point. - - 3 - The configuration to be stored. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.profile - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when WiFiConfiguration is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Gets the object of the connected WiFiAP. - - 3 - The connected Wi-Fi access point (AP) information. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when system is out of memory. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Activates the Wi-Fi asynchronously. - - 3 - A task indicating whether the activate method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Activates the Wi-Fi asynchronously and displays the Wi-Fi picker (popup) when the Wi-Fi is not automatically connected. - - 3 - A task indicating whether the ActivateWithPicker method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Deactivates the Wi-Fi asynchronously. - - 3 - A task indicating whether the deactivate method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Starts the scan asynchronously. - - 3 - A task indicating whether the scan method is done or not. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - Starts a specific access point scan asynchronously. - - 3 - A task indicating whether the ScanSpecificAP method is done or not. - The ESSID of the hidden AP. - http://tizen.org/feature/network.wifi - http://tizen.org/privilege/network.set - http://tizen.org/privilege/network.get - Thrown when the Wi-Fi is not supported. - Thrown when the permission is denied. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - A class for managing the Wi-Fi network information. - - 3 - - - - The Extended Service Set Identifier (ESSID). - - 3 - ESSID of the Wi-Fi. - - - - The Basic Service Set Identifier (BSSID). - - 3 - BSSID of the Wi-Fi. - - - - The address information for IPv4. - - 3 - IP address information for IPv4 type. - - - - The address information for IPv6. - - 3 - IP address information for IPv6 type. - - - - The proxy address. - - 3 - Represents the proxy address of the Wi-Fi. - Thrown while setting this property when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The proxy type (IPv6). - - 3 - Represents the proxy type of the Wi-Fi. - Thrown while setting this property when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The frequency band (MHz). - - 3 - Represents the frequency band value. - - - - The received signal strength indicator (RSSI). - - 3 - Represents RSSI of Wi-Fi (dbm). - - - - The Received signal strength indication(RSSI). - - 3 - Represents Rssi level of WiFi. - http://tizen.org/feature/network.wifi - Thrown while setting this property when WiFi is not supported. - - - - The max speed (Mbps). - - 3 - Represents the max speed value. - - - - A property to check whether the access point is a favorite or not. - - 3 - Boolean value to check if the access point is a favorite or not. - - - - A property to check whether the access point is a passpoint or not. - - 3 - Boolean value to check if the access point is a passpoint or not. - - - - The connection state. - - 3 - Represents the connection state of the Wi-Fi. - - - - Gets all IPv6 addresses of the access point. - - 3 - A list of IPv6 addresses of the access point. - http://tizen.org/feature/network.wifi - Thrown when the Wi-Fi is not supported. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - - A class for managing the Wi-Fi security information. - - 3 - - - - The type of Wi-Fi security. - - 3 - Represents the security type of the Wi-Fi. - Thrown while setting this property when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The type of Wi-Fi encryption. - - 3 - Represents the encryption type of the Wi-Fi. - Thrown while setting this property when Wi-Fi is not supported. - Thrown while setting this property due to an invalid parameter. - Thrown while setting this value due to an invalid operation. - - - - The EAP information. - - 3 - EAP information of the Wi-Fi. - - - - A property to check whether the passphrase is required or not. - - 3 - Boolean value to check if the passphrase is required or not. - - - - A property to check whether Wi-Fi Protected Setup (WPS) is supported. - - 3 - Boolean value to check if WPS is supported. - - - - Sets the passphrase. - - 3 - The passphrase of the access point. - http://tizen.org/feature/network.wifi - Thrown when Wi-Fi is not supported. - Thrown when the passphrase is passed as null. - Thrown when the method failed due to an invalid parameter. - Thrown when the method failed due to an invalid operation. - - - + + + + Tizen.Network.WiFi + + + + + An extended EventArgs class which contains the changed connection state. + + 3 + + + + The Wi-Fi connection state. + + 3 + + + + The access point. + + 3 + + + + An extended EventArgs class which contains the changed device state. + + 3 + + + + The Wi-Fi device state. + + 3 + + + + An abstract class for the Wi-Fi EAP information. + + 3 + + + + The file path of CA Certificate of EAP. + + 3 + + + + The EAP type of the Wi-Fi. + + 3 + + + + The type of EAP phase2 authentication of the Wi-Fi. + + 3 + + + + An extended EventArgs class which contains the changed RSSI level. + + 3 + + + + The Wi-Fi RSSI level. + + 3 + + + + DHCP server address. It is only supported for IPv4 address family. + + Represents DHCP server address. + + + + A class for managing the network information of the access point (AP). + + 3 + + + + The network information of the access point (AP). + + 3 + The WiFiNetwork instance containing the network information of the AP. + + + + The security information of the access point (AP). + + 3 + The WiFiSecurity instance containing security information of the AP. + + + + Creates an object for the access point. + + 3 + The Extended Service Set Identifier of the access point. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the ESSID is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid operation. + + + + Creates an object for the hidden access point. + + 3 + The Extended Service Set Identifier of the access point. + The value to set a hidden AP. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the ESSID is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid operation. + + + + A method to destroy the managed WiFiAP objects. + + 3 + + + + Refreshes the access point information. + + 3 + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the object instance is disposed or released. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Connects the access point asynchronously. + + 3 + A task indicating whether the connect method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the object instance is disposed or released. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Connects the access point with the WPS asynchronously. + + 3 + A WpsInfo instance which is type of WpsPbcInfo or WpsPinInfo. + A task indicating whether the ConnectWps method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.profile + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the object instance is disposed or released. + Thrown when the WpsPinInfo object is constructed with a null pin. + Thrown when the WpsPinInfo object is constructed with a pin which is an empty string or more than 7 characters. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Connects the access point with WPS without SSID asynchronously. + + 3 + A WpsInfo instance which is of type WpsPbcInfo or WpsPinInfo. + A task which contains Connected access point information. + + If WpsPinInfo is used, its object has to be constructed with a pin which must be 4 or 8 characters long. + + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + http://tizen.org/privilege/network.profile + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the WpsPinInfo object is constructed with a null pin. + Thrown when the WpsPinInfo object is constructed with a pin which is not of 4 or 8 characters long. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Disconnects the access point asynchronously. + + 3 + A task indicating whether the disconnect method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the object instance is disposed or released. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + + An abstract class which is used to represent the WPS information of the access point. + + 3 + + + + A class which is used to represent WPS PBC information of the access point. + + + + + A class which is used to represent WPS PIN information of the access point. + + + + + A public constructor which instantiates WpsPinInfo class with the given pin. + + 3 + WPS Pin of the access point. + + Pin should not be null or empty. It should be of less than 8 characters. + + + + + A class for managing the configuration of Wi-Fi. + + 3 + + + + The name of the access point (AP). + + 3 + Name assigned to AP in the Wi-Fi configuration. + + + + The security type of the access point (AP). + + 3 + Security type of AP in the Wi-Fi configuration. + + + + The proxy address. + + 3 + Proxy address of the access point. + Thrown while setting this property when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + A property check whether the access point (AP) is hidden. + + 3 + Boolean value indicating whether the AP is hidden. + Thrown while setting this property when the Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + EAP configuration. + + 3 + EAP configuration assigned to the Wi-Fi. + + + + Creates a WiFiConfiguration object with the given name, passphrase, and securetype. + + 3 + Name of the Wi-Fi. + Password to access the Wi-Fi. + Security type of the Wi-Fi. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when permission is denied. + Thrown when the object is constructed with name as null. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + A method to destroy the managed objects in the WiFiConfiguration. + + 3 + + + + A class for managing the EAP information of the access point (AP). + + 3 + + + + The file path of CA Certificate of EAP. + + 3 + CA certification file of EAP. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this value when the file value is null. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The EAP type of Wi-Fi. + + 3 + Type of EAP. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The type of EAP phase 2 authentication of the Wi-Fi. + + 3 + Authentication type of the Wi-Fi. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + Gets the private key file of EAP. + + 3 + The file path of private key. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the system is out of memory. + Thrown when the method fails due to an invalid parameter. + Thrown when the method fails due to an invalid operation. + + + + Sets the private key information of EAP. + + 3 + The file path of private key. + The password. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the file path of private key is null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due an to invalid operation. + + + + Gets the client certificate of EAP. + + 3 + The file path of client certificate. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due an to invalid operation. + + + + Sets the CA certificate of EAP. + + 3 + The file path of client certificate. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the file path of client certificate is null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Gets the username of EAP passphrase. + + 3 + The user name + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Returns whether the password is set or not. + + 3 + True if password is set, false if password is not set. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Sets the user name of EAP. + + 3 + The user name + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the user name is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Sets the password of EAP. + + 3 + The password + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the password is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + A class for managing the EAP configuration. + + 3 + + + + The file path of CA certificate of EAP. + + 3 + CA certification file of EAP. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The EAP type of the Wi-Fi. + + 3 + Type of EAP. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The type of EAP phase2 authentication of the Wi-Fi. + + 3 + Authentication type of the Wi-Fi. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The anonymous identity of the access point (AP). + + 3 + Represents the anonymous identity of the access point. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The identity of the access point (AP). + + 3 + Represents the identity of the access point. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The subject match of the access point (AP). + + 3 + Represents the subject match of the AP. + Thrown while setting this value when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + Gets the access point client certificate file from the configuration. + + 3 + The certification authority (CA) certificates file of the access point. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Sets the access point client certificate file to configuration. + + 3 + The private key file. + The certification authority(CA) certifies the files of access points. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Enumeration for the Wi-Fi EAP types. + + 3 + + + + EAP PEAP type. + + 3 + + + + EAP TLS type. + + 3 + + + + The EAP TTLS type. + + 3 + + + + EAP SIM type. + + 3 + + + + EAP AKA type. + + 3 + + + + Enumeration for the Wi-Fi RSSI levels. + + 3 + + + + Level 0. + + 3 + + + + Level 1. + + 3 + + + + Level 2. + + 3 + + + + Level 3. + + 3 + + + + Level 4. + + 3 + + + + Enumeration for the Wi-Fi connection states. + + 3 + + + + Connection failed state. + + 3 + + + + Disconnected state. + + 3 + + + + Association state. + + 3 + + + + Configuration state. + + 3 + + + + Connected state. + + 3 + + + + Enumeration for the Wi-Fi device states. + + 3 + + + + Wi-Fi is deactivated. + + 3 + + + + Wi-Fi is activated. + + 3 + + + + Enumeration for the Wi-Fi proxy types. + + 3 + + + + Direct connection. + + 3 + + + + Auto configuration(Use PAC file). If the URL property is not set, DHCP/WPAD auto-discover will be tried. + + 3 + + + + Manual configuration. + + 3 + + + + Enumeration for the Wi-Fi authentication types. + + 3 + + + + EAP phase 2 authentication none. + + 3 + + + + EAP phase 2 authentication PAP. + + 3 + + + + EAP phase 2 authentication MSCHAP. + + 3 + + + + EAP phase 2 authentication MSCHAPv2. + + 3 + + + + EAP phase 2 authentication GTC. + + 3 + + + + EAP phase 2 authentication MD5. + + 3 + + + + A class for managing the WiFiManager handle. + + + + + Checks the validity of the handle. + + Represents the validity of the handle. + + + + + The local MAC address. + + 3 + Represents the MAC address of the Wi-Fi. + http://tizen.org/privilege/network.get + + + + The name of the network interface. + + 3 + Interface name of the Wi-Fi. + http://tizen.org/privilege/network.get + + + + The network connection state. + + 3 + Represents the connection state of the Wi-Fi. + http://tizen.org/privilege/network.get + + + + A property to check whether Wi-Fi is activated. + + 3 + Boolean value to check whether Wi-Fi is activated or not. + http://tizen.org/privilege/network.get + + + + DeviceStateChanged is raised when the device state is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.wifi + + + + ConnectionStateChanged is raised when the connection state is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.wifi + + + + RssiLevelChanged is raised when the RSSI of the connected Wi-Fi is changed. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.wifi + + + + BackgroundScanFinished is raised when the background scan is finished. + The background scan starts automatically when Wi-Fi is activated. The callback will be invoked periodically. + + 3 + http://tizen.org/privilege/network.get + http://tizen.org/feature/network.wifi + + + + Gets the Wi-Fi safe handle. + + 3 + The instance of the SafeWiFiManagerHandle. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Gets the result of the scan. + + 3 + A list of the WiFiAP objects. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Gets the result of a specific AP scan. + + 3 + A list containing the WiFiAP objects. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Gets the list of Wi-Fi configurations. + + 3 + A list containing the WiFiConfiguration objects. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.profile + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Saves the Wi-Fi configuration of the access point. + + 3 + The configuration to be stored. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.profile + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when WiFiConfiguration is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Gets the object of the connected WiFiAP. + + 3 + The connected Wi-Fi access point (AP) information. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when system is out of memory. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Activates the Wi-Fi asynchronously. + + 3 + A task indicating whether the activate method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Activates the Wi-Fi asynchronously and displays the Wi-Fi picker (popup) when the Wi-Fi is not automatically connected. + + 3 + A task indicating whether the ActivateWithPicker method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Deactivates the Wi-Fi asynchronously. + + 3 + A task indicating whether the deactivate method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Starts the scan asynchronously. + + 3 + A task indicating whether the scan method is done or not. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + Starts a specific access point scan asynchronously. + + 3 + A task indicating whether the ScanSpecificAP method is done or not. + The ESSID of the hidden AP. + http://tizen.org/feature/network.wifi + http://tizen.org/privilege/network.set + http://tizen.org/privilege/network.get + Thrown when the Wi-Fi is not supported. + Thrown when the permission is denied. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + A class for managing the Wi-Fi network information. + + 3 + + + + The Extended Service Set Identifier (ESSID). + + 3 + ESSID of the Wi-Fi. + + + + The Basic Service Set Identifier (BSSID). + + 3 + BSSID of the Wi-Fi. + + + + The address information for IPv4. + + 3 + IP address information for IPv4 type. + + + + The address information for IPv6. + + 3 + IP address information for IPv6 type. + + + + The proxy address. + + 3 + Represents the proxy address of the Wi-Fi. + Thrown while setting this property when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The proxy type (IPv6). + + 3 + Represents the proxy type of the Wi-Fi. + Thrown while setting this property when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The frequency band (MHz). + + 3 + Represents the frequency band value. + + + + The received signal strength indicator (RSSI). + + 3 + Represents RSSI of Wi-Fi (dbm). + + + + The Received signal strength indication(RSSI). + + 3 + Represents Rssi level of WiFi. + http://tizen.org/feature/network.wifi + Thrown while setting this property when WiFi is not supported. + + + + The max speed (Mbps). + + 3 + Represents the max speed value. + + + + A property to check whether the access point is a favorite or not. + + 3 + Boolean value to check if the access point is a favorite or not. + + + + A property to check whether the access point is a passpoint or not. + + 3 + Boolean value to check if the access point is a passpoint or not. + + + + The connection state. + + 3 + Represents the connection state of the Wi-Fi. + + + + Gets all IPv6 addresses of the access point. + + 3 + A list of IPv6 addresses of the access point. + http://tizen.org/feature/network.wifi + Thrown when the Wi-Fi is not supported. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + + A class for managing the Wi-Fi security information. + + 3 + + + + The type of Wi-Fi security. + + 3 + Represents the security type of the Wi-Fi. + Thrown while setting this property when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The type of Wi-Fi encryption. + + 3 + Represents the encryption type of the Wi-Fi. + Thrown while setting this property when Wi-Fi is not supported. + Thrown while setting this property due to an invalid parameter. + Thrown while setting this value due to an invalid operation. + + + + The EAP information. + + 3 + EAP information of the Wi-Fi. + + + + A property to check whether the passphrase is required or not. + + 3 + Boolean value to check if the passphrase is required or not. + + + + A property to check whether Wi-Fi Protected Setup (WPS) is supported. + + 3 + Boolean value to check if WPS is supported. + + + + Sets the passphrase. + + 3 + The passphrase of the access point. + http://tizen.org/feature/network.wifi + Thrown when Wi-Fi is not supported. + Thrown when the passphrase is passed as null. + Thrown when the method failed due to an invalid parameter. + Thrown when the method failed due to an invalid operation. + + + diff --git a/Artifacts/bin/Tizen.Network.WiFiDirect.dll b/Artifacts/bin/Tizen.Network.WiFiDirect.dll index 376ddfa..be68990 100644 Binary files a/Artifacts/bin/Tizen.Network.WiFiDirect.dll and b/Artifacts/bin/Tizen.Network.WiFiDirect.dll differ diff --git a/Artifacts/bin/Tizen.Network.WiFiDirect.pdb b/Artifacts/bin/Tizen.Network.WiFiDirect.pdb index 0e3eba6..0f06c7c 100644 Binary files a/Artifacts/bin/Tizen.Network.WiFiDirect.pdb and b/Artifacts/bin/Tizen.Network.WiFiDirect.pdb differ diff --git a/Artifacts/bin/Tizen.Network.WiFiDirect.xml b/Artifacts/bin/Tizen.Network.WiFiDirect.xml index 2cecbb4..fdfe990 100644 --- a/Artifacts/bin/Tizen.Network.WiFiDirect.xml +++ b/Artifacts/bin/Tizen.Network.WiFiDirect.xml @@ -1,1981 +1,1981 @@ - - - - Tizen.Network.WiFiDirect - - - - - The Interop class for Wi-Fi Direct. - - - - - The Wi-Fi Direct native APIs. - - - - - Enumeration for the Wi-Fi Direct discovery state. - - - - - Only listen has started. - - - - - Discovery started. - - - - - A remote peer is found. - - - - - Discovery finished. - - - - - A remote peer is lost. - - - - - Enumeration for the Wi-Fi Direct display device types. - - - - - Configure as the WFD source. - - - - - Configure as the WFD primary sink. - - - - - Configure as the WFD secondary sink. - - - - - Configure as the WFD dual role. - - - - - Enumeration for the Wi-Fi Discovery channel. - - - - - Scan full channel. - - - - - The social channel. - - - - - Scan channel 1. - - - - - Scan channel 6. - - - - - Scan channel 11. - - - - - Enumeration for the Wi-Fi Direct connection state. - - - - - Connection is requested. - - - - - WPS is requested. - - - - - Connection in progress. - - - - - Connected. - - - - - Disconnected by the remote group client. - - - - - Disconnected by the local device. - - - - - Disconnected by the remote group owner. - - - - - Group is created. - - - - - Group is destroyed. - - - - - Enumeration for the Wi-Fi Direct primary device type. - - - - - Computer. - - - - - Input device. - - - - - Printer. - - - - - Camera. - - - - - Storage. - - - - - Network Infrastructure. - - - - - Display. - - - - - Multimedia device. - - - - - Game device. - - - - - Telephone. - - - - - Audio. - - - - - Others. - - - - - Enumeration for the Wi-Fi Direct secondary device type. - - - - - Computer PC. - - - - - Computer server. - - - - - Computer media center. - - - - - Computer UMPC. - - - - - Computer notebook. - - - - - Computer desktop. - - - - - Computer MID. - - - - - Computer netbook. - - - - - Input keyboard. - - - - - Input mouse. - - - - - Input joystick. - - - - - Input trackball. - - - - - Input controller. - - - - - Input remote. - - - - - Input touch screen. - - - - - Input biometric reader. - - - - - Input barcode reader. - - - - - Printer. - - - - - Printer scanner. - - - - - Printer fax. - - - - - Printer copier. - - - - - Printer all-in-one. - - - - - Digital still camera. - - - - - Video camera. - - - - - Webcam. - - - - - Security camera. - - - - - Storage NAS. - - - - - Network AP. - - - - - Network router. - - - - - Network switch. - - - - - Network gateway. - - - - - Display TV. - - - - - Display picture frame. - - - - - Display projector. - - - - - Display monitor. - - - - - Multimedia DAR. - - - - - Multimedia PVR. - - - - - Multimedia MCX. - - - - - Multimedia set-top box. - - - - - Media Server/Media Adapter/Media Extender. - - - - - Multimedia portable video player. - - - - - Game xbox. - - - - - Game xbox 360. - - - - - Game play station. - - - - - Game console. - - - - - Game portable. - - - - - Windows mobile. - - - - - Phone - single mode. - - - - - Phone - dual mode. - - - - - Smartphone - single mode. - - - - - Smartphone - dual mode. - - - - - Audio tuner. - - - - - Audio speaker. - - - - - Audio PMP. - - - - - Audio headset. - - - - - Audio headphone. - - - - - Audio microphone. - - - - - Enumeration for the Wi-Fi Direct link status. - - - - - Deactivated. - - - - - Deactivating. - - - - - Activating. - - - - - Activated. - - - - - Discovering. - - - - - Connecting. - - - - - Disconnecting. - - - - - Connected. - - - - - Group owner. - - - - - Enumeration for the Wi-Fi WPS type. - - - - - No WPS type. - - - - - Push button configuration. - - - - - Display pin code. - - - - - Provide the keypad to input the pin. - - - - - Enumeration for the service discovery type. - - - - - The service discovery type All. - - - - - The service discovery type Bonjour. - - - - - The service discovery type UPNP. - - - - - The service discovery type WS Discovery. - - - - - The service discovery type Wi-Fi Display. - - - - - The service discovery type BT Address. - - - - - The service discovery type Contact Info. - - - - - The service discovery type vendor-specific. - - - - - Enumeration for the Wi-Fi Direct service discovery state. - - - - - The service discovery Started. - - - - - The service discovery Found. - - - - - The service discovery Finished. - - - - - Enumeration for the Wi-Fi Direct device state. - - - - - Activated. - - - - - Deactivated. - - - - - Enumeration for the Wi-Fi Direct error code. - - - - - Successful. - - - - - Operation not permitted. - - - - - Out of memory. - - - - - Permission denied. - - - - - Device or the resource is busy. - - - - - Invalid function parameter. - - - - - Connection timed out. - - - - - Not supported. - - - - - Not initialized. - - - - - I/O error. - - - - - Wi-Fi is being used. - - - - - Mobile AP is being used. - - - - - Connection failed. - - - - - Authentication failed. - - - - - Operation failed. - - - - - Too many clients. - - - - - Already initialized the client. - - - - - Connection cancelled by the local device. - - - - - An extended EventArgs class which contains the changed connection state during connecting or disconnecting the peer device. - - - - - The Wi-Fi Direct result. - - - - - The Wi-Fi Direct connection state of the peer. - - - - - The MacAddress of the peer. - - - - - An extended EventArgs class which contains address properties of the peer when it connects to a group owner. - - - - - The MacAddress of the connected peer. - - - - - The IpAddress of the connected peer. - - - - - The InterfaceAddress of the connected peer. - - - - - An extended EventArgs class which contains the changed Wi-Fi Direct state of the local device. - - - - - The Wi-Fi Direct state. - - - - - An extended EventArgs class which contains the changed Wi-Fi Direct discovery state during the Wi-Fi Direct scan operation. - - - - - The Wi-Fi Direct result. - - - - - The Wi-Fi Direct discovery state. - - - - - An extended EventArgs class which contains the found peer information during the Wi-Fi Direct scan operation. - - - - - The Wi-Fi Direct result. - - - - - The Wi-Fi Direct discovery state. - - - - - The found peer. - - - - - An extended EventArgs class which contains the changed device state during activation or deactivation. - - - - - The Wi-Fi Direct result. - - - - - The state of the device. - - - - - An extended EventArgs class which contains the changed service information during the service discovery. - - - - - The Wi-Fi Direct result. - - - - - The service discovery state. - - - - - The types of service. - - - - - The received response. - - - - - The peer servicing device. - - - - - An extended EventArgs class which contains the changed connection state during disconnecting of all peers or grouping related operations. - - - - - The Wi-Fi Direct result. - - - - - The connection state. - - - - - 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. - - - - - 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. - - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - - - 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. - - - - Gets the Ssid. - - - SSID of local device. - - - http://tizen.org/privilege/wifidirect - - - If there is any error, null will be returned. - - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - - - 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. - - - - 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. - - - - 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. - - - - Gets the MacAddress. - - - Mac address of a local device. - - - http://tizen.org/privilege/wifidirect - - - If there is any error, null will be returned. - - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - - - 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. - - - - 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. - - - - 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. - - - - 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. - - - - 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. - - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - - - 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. - - - - Gets and sets the PersistentGroupEnabled. - - - 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. - - - - Gets and sets the AutoConnect. - - - 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. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - Gets and sets the Name. - - - 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. - - - - Gets and sets the RequestedWps. - - - 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. - - - - Gets and sets the GroupOwnerIntent. - - - 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. - - - - Gets and sets the MaxClients. - - - 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. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - (event) StateChanged is raised when Wi-Fi Direct state is changed. - - - - - (event) DiscoveryStateChanged is raised when Wi-Fi Direct discovery state is changed. - - - - - (event) DeviceStateChanged is raised when device state is changed. - - - - - (event) PeerFound is raised when peer is found. - - - - - (event) ConnectionStatusChanged is raised when status of connection is changed. - - - - - Activates the Wi-Fi Direct service. - - - If this succeeds, DeviceStateChanged event will be invoked. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - Set the WPS config PBC as preferred method for connection. - - - 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. - - - - Gets the supported WPS types. - - 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. - - - - Gets the persistent groups. - - 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. - - - - Removes a persistent group. - - 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. - - - - Initializes or Deintializes the Wi-Fi 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. - - - Thrown during one of the following cases : - 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. - - - - 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. - - - Thrown during one of the following cases : - 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. - - - - 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. - - - Thrown during one of the following cases : - 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. - - - - 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. - - - Thrown during one of the following cases : - 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. - - - - 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. - - - Thrown during one of the following cases : - 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. - - - - 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. - - The object is in invalid state. - The required feature is not supported. - Thrown when application does not have privilege to access this method. - - - - 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. - - - Thrown during one of the following cases : - 1. When the wifidirect is not supported - 2. When the wifidirect service discovery is not supported - - The object is in invalid state. - Thrown when application does not have privilege to access this method. - - - - 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. - - - Thrown during one of the following cases : - 1. When the wifidirect is not supported - 2. When the wifidirect service discovery is not supported - - The object is in invalid state. - Thrown when application does not have privilege to access this method. - - - - The implementation of Wi-Fi Direct APIs. - - - - - The WiFiDirectPeer class is used to handle the connection with remote devices using Wi-Fi Direct. - - http://tizen.org/privilege/wifidirect - - - - The name of the peer device. - - - - - The IP address of the peer device. - - - - - The MAC address of the peer device. - - - - - The Interface address of the peer device. - - - - - The listening channel of the peer device. - - - - - The connected state of the peer device. - - - - - The P2P group state of the peer device. - - - - - The P2P state of the peer device. - - - - - The primary catagory of the peer device. - - - - - The sub category of the peer device. - - - - - The list of the supported WPS type of the peer device. - - - - - The P2P invitation state of the peer device. - - - - - The number of registered services of the peer device. - - - - - The list of registered services of the peer device. - - - - - Checks if the peer device is a Wi-Fi display device. - - - - - The Wi-Fi display device type of the peer device. - - - Wi-Fi Direct must be activated. - If there is any error, a default value of WiFiDirectDisplayType will be returned. - - - - - The Wi-Fi display session availability of the peer device. - - - Wi-Fi Direct must be activated. - If there is any error, false will be returned. - - - - - The HDCP information of the peer device. - - - Wi-Fi Direct must be activated. - If there is any error, -1 will be returned. - - - - - The port of the connected peer device. - - - Wi-Fi Direct must be activated. - If there is any error, -1 will be returned. - - - - - The Wi-Fi display maximum throughput of the peer device. - - - Wi-Fi Direct must be activated. - If there is any error, -1 will be returned. - - - - - The Wi-Fi RSSI value of the peer device. - - - Wi-Fi Direct must be activated. - If there is any error, -1 will be returned. - - - - - The ConnectionStateChanged event is raised when the connection state of the peer device changes. - - - - - The IpAddressAssigned event is raised when the IP address of the peer device is assigned. - - - - - The ServiceStateChanged event is raised when the state of service discovery is changed. - - - - - Connects to a specified remote device. - - - Wi-Fi Direct must be activated. - If this succeeds, the ConnectionStateChanged event will be invoked. - - Thrown when the Wi-Fi Direct is not supported - - - - Cancels the connection now in progress. - - - Wi-Fi Direct must be activated. - - Thrown when the Wi-Fi Direct is not supported. - - - - Disconnects the specified remote device. - - - Wi-Fi Direct must be activated. - If this succeeds, the ConnectionStateChanged event will be invoked. - - Thrown when the Wi-Fi Direct is not supported. - - - - Allows a device to connect automatically. - - - Wi-Fi Direct must be activated. - - Thrown when the Wi-Fi Direct is not supported. - - - - Starts the Wi-Fi Direct service discovery. - - - Wi-Fi Direct must be activated. - If this succeeds, the ServiceStateChanged event will be invoked. - - - Thrown during one of the following cases: - 1. When the Wi-Fi Direct is not supported. - 2. When the Wi-Fi Direct service discovery is not supported. - - The type of the service. - - - - Stops the Wi-Fi Direct service discovery. - - - Wi-Fi Direct must be activated. - - - Thrown during one of the following cases: - 1. When the Wi-Fi Direct is not supported. - 2. When the Wi-Fi Direct service discovery is not supported. - - The type of the service. - - - - A class to handle persistent groups. - - - - - The MAC address of the persistent group owner. - - - - - The SSID (Service Set Identifier) of the persistent group owner. - - - - + + + + Tizen.Network.WiFiDirect + + + + + The Interop class for Wi-Fi Direct. + + + + + The Wi-Fi Direct native APIs. + + + + + Enumeration for the Wi-Fi Direct discovery state. + + + + + Only listen has started. + + + + + Discovery started. + + + + + A remote peer is found. + + + + + Discovery finished. + + + + + A remote peer is lost. + + + + + Enumeration for the Wi-Fi Direct display device types. + + + + + Configure as the WFD source. + + + + + Configure as the WFD primary sink. + + + + + Configure as the WFD secondary sink. + + + + + Configure as the WFD dual role. + + + + + Enumeration for the Wi-Fi Discovery channel. + + + + + Scan full channel. + + + + + The social channel. + + + + + Scan channel 1. + + + + + Scan channel 6. + + + + + Scan channel 11. + + + + + Enumeration for the Wi-Fi Direct connection state. + + + + + Connection is requested. + + + + + WPS is requested. + + + + + Connection in progress. + + + + + Connected. + + + + + Disconnected by the remote group client. + + + + + Disconnected by the local device. + + + + + Disconnected by the remote group owner. + + + + + Group is created. + + + + + Group is destroyed. + + + + + Enumeration for the Wi-Fi Direct primary device type. + + + + + Computer. + + + + + Input device. + + + + + Printer. + + + + + Camera. + + + + + Storage. + + + + + Network Infrastructure. + + + + + Display. + + + + + Multimedia device. + + + + + Game device. + + + + + Telephone. + + + + + Audio. + + + + + Others. + + + + + Enumeration for the Wi-Fi Direct secondary device type. + + + + + Computer PC. + + + + + Computer server. + + + + + Computer media center. + + + + + Computer UMPC. + + + + + Computer notebook. + + + + + Computer desktop. + + + + + Computer MID. + + + + + Computer netbook. + + + + + Input keyboard. + + + + + Input mouse. + + + + + Input joystick. + + + + + Input trackball. + + + + + Input controller. + + + + + Input remote. + + + + + Input touch screen. + + + + + Input biometric reader. + + + + + Input barcode reader. + + + + + Printer. + + + + + Printer scanner. + + + + + Printer fax. + + + + + Printer copier. + + + + + Printer all-in-one. + + + + + Digital still camera. + + + + + Video camera. + + + + + Webcam. + + + + + Security camera. + + + + + Storage NAS. + + + + + Network AP. + + + + + Network router. + + + + + Network switch. + + + + + Network gateway. + + + + + Display TV. + + + + + Display picture frame. + + + + + Display projector. + + + + + Display monitor. + + + + + Multimedia DAR. + + + + + Multimedia PVR. + + + + + Multimedia MCX. + + + + + Multimedia set-top box. + + + + + Media Server/Media Adapter/Media Extender. + + + + + Multimedia portable video player. + + + + + Game xbox. + + + + + Game xbox 360. + + + + + Game play station. + + + + + Game console. + + + + + Game portable. + + + + + Windows mobile. + + + + + Phone - single mode. + + + + + Phone - dual mode. + + + + + Smartphone - single mode. + + + + + Smartphone - dual mode. + + + + + Audio tuner. + + + + + Audio speaker. + + + + + Audio PMP. + + + + + Audio headset. + + + + + Audio headphone. + + + + + Audio microphone. + + + + + Enumeration for the Wi-Fi Direct link status. + + + + + Deactivated. + + + + + Deactivating. + + + + + Activating. + + + + + Activated. + + + + + Discovering. + + + + + Connecting. + + + + + Disconnecting. + + + + + Connected. + + + + + Group owner. + + + + + Enumeration for the Wi-Fi WPS type. + + + + + No WPS type. + + + + + Push button configuration. + + + + + Display pin code. + + + + + Provide the keypad to input the pin. + + + + + Enumeration for the service discovery type. + + + + + The service discovery type All. + + + + + The service discovery type Bonjour. + + + + + The service discovery type UPNP. + + + + + The service discovery type WS Discovery. + + + + + The service discovery type Wi-Fi Display. + + + + + The service discovery type BT Address. + + + + + The service discovery type Contact Info. + + + + + The service discovery type vendor-specific. + + + + + Enumeration for the Wi-Fi Direct service discovery state. + + + + + The service discovery Started. + + + + + The service discovery Found. + + + + + The service discovery Finished. + + + + + Enumeration for the Wi-Fi Direct device state. + + + + + Activated. + + + + + Deactivated. + + + + + Enumeration for the Wi-Fi Direct error code. + + + + + Successful. + + + + + Operation not permitted. + + + + + Out of memory. + + + + + Permission denied. + + + + + Device or the resource is busy. + + + + + Invalid function parameter. + + + + + Connection timed out. + + + + + Not supported. + + + + + Not initialized. + + + + + I/O error. + + + + + Wi-Fi is being used. + + + + + Mobile AP is being used. + + + + + Connection failed. + + + + + Authentication failed. + + + + + Operation failed. + + + + + Too many clients. + + + + + Already initialized the client. + + + + + Connection cancelled by the local device. + + + + + An extended EventArgs class which contains the changed connection state during connecting or disconnecting the peer device. + + + + + The Wi-Fi Direct result. + + + + + The Wi-Fi Direct connection state of the peer. + + + + + The MacAddress of the peer. + + + + + An extended EventArgs class which contains address properties of the peer when it connects to a group owner. + + + + + The MacAddress of the connected peer. + + + + + The IpAddress of the connected peer. + + + + + The InterfaceAddress of the connected peer. + + + + + An extended EventArgs class which contains the changed Wi-Fi Direct state of the local device. + + + + + The Wi-Fi Direct state. + + + + + An extended EventArgs class which contains the changed Wi-Fi Direct discovery state during the Wi-Fi Direct scan operation. + + + + + The Wi-Fi Direct result. + + + + + The Wi-Fi Direct discovery state. + + + + + An extended EventArgs class which contains the found peer information during the Wi-Fi Direct scan operation. + + + + + The Wi-Fi Direct result. + + + + + The Wi-Fi Direct discovery state. + + + + + The found peer. + + + + + An extended EventArgs class which contains the changed device state during activation or deactivation. + + + + + The Wi-Fi Direct result. + + + + + The state of the device. + + + + + An extended EventArgs class which contains the changed service information during the service discovery. + + + + + The Wi-Fi Direct result. + + + + + The service discovery state. + + + + + The types of service. + + + + + The received response. + + + + + The peer servicing device. + + + + + An extended EventArgs class which contains the changed connection state during disconnecting of all peers or grouping related operations. + + + + + The Wi-Fi Direct result. + + + + + The connection state. + + + + + 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. + + + + + 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. + + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + + + 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. + + + + Gets the Ssid. + + + SSID of local device. + + + http://tizen.org/privilege/wifidirect + + + If there is any error, null will be returned. + + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + + Gets the MacAddress. + + + Mac address of a local device. + + + http://tizen.org/privilege/wifidirect + + + If there is any error, null will be returned. + + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + + + 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. + + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + + + 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. + + + + Gets and sets the PersistentGroupEnabled. + + + 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. + + + + Gets and sets the AutoConnect. + + + 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. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + Gets and sets the Name. + + + 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. + + + + Gets and sets the RequestedWps. + + + 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. + + + + Gets and sets the GroupOwnerIntent. + + + 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. + + + + Gets and sets the MaxClients. + + + 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. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + (event) StateChanged is raised when Wi-Fi Direct state is changed. + + + + + (event) DiscoveryStateChanged is raised when Wi-Fi Direct discovery state is changed. + + + + + (event) DeviceStateChanged is raised when device state is changed. + + + + + (event) PeerFound is raised when peer is found. + + + + + (event) ConnectionStatusChanged is raised when status of connection is changed. + + + + + Activates the Wi-Fi Direct service. + + + If this succeeds, DeviceStateChanged event will be invoked. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + Set the WPS config PBC as preferred method for connection. + + + 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. + + + + Gets the supported WPS types. + + 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. + + + + Gets the persistent groups. + + 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. + + + + Removes a persistent group. + + 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. + + + + Initializes or Deintializes the Wi-Fi 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. + + + Thrown during one of the following cases : + 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. + + + + 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. + + + Thrown during one of the following cases : + 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. + + + + 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. + + + Thrown during one of the following cases : + 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. + + + + 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. + + + Thrown during one of the following cases : + 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. + + + + 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. + + + Thrown during one of the following cases : + 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. + + + + 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. + + The object is in invalid state. + The required feature is not supported. + Thrown when application does not have privilege to access this method. + + + + 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. + + + Thrown during one of the following cases : + 1. When the wifidirect is not supported + 2. When the wifidirect service discovery is not supported + + The object is in invalid state. + Thrown when application does not have privilege to access this method. + + + + 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. + + + Thrown during one of the following cases : + 1. When the wifidirect is not supported + 2. When the wifidirect service discovery is not supported + + The object is in invalid state. + Thrown when application does not have privilege to access this method. + + + + The implementation of Wi-Fi Direct APIs. + + + + + The WiFiDirectPeer class is used to handle the connection with remote devices using Wi-Fi Direct. + + http://tizen.org/privilege/wifidirect + + + + The name of the peer device. + + + + + The IP address of the peer device. + + + + + The MAC address of the peer device. + + + + + The Interface address of the peer device. + + + + + The listening channel of the peer device. + + + + + The connected state of the peer device. + + + + + The P2P group state of the peer device. + + + + + The P2P state of the peer device. + + + + + The primary catagory of the peer device. + + + + + The sub category of the peer device. + + + + + The list of the supported WPS type of the peer device. + + + + + The P2P invitation state of the peer device. + + + + + The number of registered services of the peer device. + + + + + The list of registered services of the peer device. + + + + + Checks if the peer device is a Wi-Fi display device. + + + + + The Wi-Fi display device type of the peer device. + + + Wi-Fi Direct must be activated. + If there is any error, a default value of WiFiDirectDisplayType will be returned. + + + + + The Wi-Fi display session availability of the peer device. + + + Wi-Fi Direct must be activated. + If there is any error, false will be returned. + + + + + The HDCP information of the peer device. + + + Wi-Fi Direct must be activated. + If there is any error, -1 will be returned. + + + + + The port of the connected peer device. + + + Wi-Fi Direct must be activated. + If there is any error, -1 will be returned. + + + + + The Wi-Fi display maximum throughput of the peer device. + + + Wi-Fi Direct must be activated. + If there is any error, -1 will be returned. + + + + + The Wi-Fi RSSI value of the peer device. + + + Wi-Fi Direct must be activated. + If there is any error, -1 will be returned. + + + + + The ConnectionStateChanged event is raised when the connection state of the peer device changes. + + + + + The IpAddressAssigned event is raised when the IP address of the peer device is assigned. + + + + + The ServiceStateChanged event is raised when the state of service discovery is changed. + + + + + Connects to a specified remote device. + + + Wi-Fi Direct must be activated. + If this succeeds, the ConnectionStateChanged event will be invoked. + + Thrown when the Wi-Fi Direct is not supported + + + + Cancels the connection now in progress. + + + Wi-Fi Direct must be activated. + + Thrown when the Wi-Fi Direct is not supported. + + + + Disconnects the specified remote device. + + + Wi-Fi Direct must be activated. + If this succeeds, the ConnectionStateChanged event will be invoked. + + Thrown when the Wi-Fi Direct is not supported. + + + + Allows a device to connect automatically. + + + Wi-Fi Direct must be activated. + + Thrown when the Wi-Fi Direct is not supported. + + + + Starts the Wi-Fi Direct service discovery. + + + Wi-Fi Direct must be activated. + If this succeeds, the ServiceStateChanged event will be invoked. + + + Thrown during one of the following cases: + 1. When the Wi-Fi Direct is not supported. + 2. When the Wi-Fi Direct service discovery is not supported. + + The type of the service. + + + + Stops the Wi-Fi Direct service discovery. + + + Wi-Fi Direct must be activated. + + + Thrown during one of the following cases: + 1. When the Wi-Fi Direct is not supported. + 2. When the Wi-Fi Direct service discovery is not supported. + + The type of the service. + + + + A class to handle persistent groups. + + + + + The MAC address of the persistent group owner. + + + + + The SSID (Service Set Identifier) of the persistent group owner. + + + + diff --git a/Artifacts/bin/Tizen.PhonenumberUtils.dll b/Artifacts/bin/Tizen.PhonenumberUtils.dll index 6a95f64..7c8a07c 100644 Binary files a/Artifacts/bin/Tizen.PhonenumberUtils.dll and b/Artifacts/bin/Tizen.PhonenumberUtils.dll differ diff --git a/Artifacts/bin/Tizen.PhonenumberUtils.pdb b/Artifacts/bin/Tizen.PhonenumberUtils.pdb index 30a8fdd..f950b43 100644 Binary files a/Artifacts/bin/Tizen.PhonenumberUtils.pdb and b/Artifacts/bin/Tizen.PhonenumberUtils.pdb differ diff --git a/Artifacts/bin/Tizen.PhonenumberUtils.xml b/Artifacts/bin/Tizen.PhonenumberUtils.xml index 1c5d274..d009053 100644 --- a/Artifacts/bin/Tizen.PhonenumberUtils.xml +++ b/Artifacts/bin/Tizen.PhonenumberUtils.xml @@ -1,1452 +1,1452 @@ - - - - Tizen.PhonenumberUtils - - - - - The PhonenumberUtils class provides methods for parsing, formatting and normalizing phone numbers. - - - - - Releases all resources used by the PhonenumberUtils. - It should be called after finished using of the object. - - - - - Gets the location string from number, region, and language. - - The number - The region of number - The language of location - The location string - Thrown when method failed due to invalid operation - Thrown when phonenumber-utils is not supported - Thrown when input coordinates are invalid - Thrown when failed due to out of memory - - - - Gets the formatted number. - - The number - The region of number - The formatted number string - Thrown when method failed due to invalid operation - Thrown when phonenumber-utils is not supported - Thrown when input coordinates are invalid - Thrown when failed due to out of memory - - - - Gets the normalized number. - - The number - The normalized number - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when method failed due to invalid operation - Thrown when phonenumber-utils is not supported - Thrown when input coordinates are invalid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - Normalized number starts with plus('+') and country code, and excludes the separators such as dash or space. - It is a format of E.164 standard including the country code based on current network. - - - - - Enumeration for language type. - - - - - Amharic - - - - - Arabic - - - - - Belarusian - - - - - Bulgarian - - - - - Chinese - - - - - Chinese (Traditional) - - - - - Czech - - - - - Dutch - - - - - English - - - - - Finnish - - - - - French - - - - - German - - - - - Greek - - - - - Hungarian - - - - - Indonesian - - - - - Italian - - - - - Japanese - - - - - Korean - - - - - Nothern Sami - - - - - Persian - - - - - Polish - - - - - Portuguese - - - - - Romanian - - - - - Russian - - - - - Serbian - - - - - Spanish - - - - - Swedish - - - - - Thai - - - - - Turkish - - - - - Vietnamese - - - - - Current System Value - - - - - Enumeration for region type. - - - - - Aland Islands - - - - - Albania - - - - - Algeria - - - - - American Samoa - - - - - Angola - - - - - Anguilla - - - - - Argentina - - - - - Armenia - - - - - Ascension Island - - - - - Antigua and Barbuda - - - - - Austria - - - - - Bahamas - - - - - Barbados - - - - - Belarus - - - - - Belgium - - - - - Benin - - - - - Bermuda - - - - - Bonaire, Sint Eustatius and Saba - - - - - Botswana - - - - - Brazil - - - - - Bulgaria - - - - - Burkina Faso - - - - - Burundi - - - - - Cape Verde (Cabo Verde) - - - - - Cameroon - - - - - Canada - - - - - Cayman Island - - - - - Chile - - - - - China - - - - - Colombia - - - - - Comoros - - - - - Congo - - - - - Ivory Coast (Cote d'Ivoire) - - - - - Cuba - - - - - Curacao - - - - - Czech Republic - - - - - Congo, Democratic Republic of the - - - - - Dominica - - - - - Dominican Republic - - - - - Egypt - - - - - Estonia - - - - - Ethiopia - - - - - Finland - - - - - France - - - - - Gabon - - - - - Gambia - - - - - Germany - - - - - Ghana - - - - - Greece - - - - - Greenland - - - - - Grenada - - - - - Guam - - - - - Guernsey - - - - - Guinea - - - - - Guinea-Bissau - - - - - Hungary - - - - - Iceland - - - - - India - - - - - Indonesia - - - - - Ireland - - - - - Iran, Islamic Republic of - - - - - Isle of Man - - - - - Italy - - - - - Jamaica - - - - - Japan - - - - - Jersey - - - - - Jordan - - - - - Kazakhstan - - - - - Kenya - - - - - Kiribati - - - - - Latvia - - - - - Lesotho - - - - - Lithuania - - - - - Luxembourg - - - - - Madagascar - - - - - Mauritania - - - - - Mauritius - - - - - Montserrat - - - - - Morocco - - - - - Mozambique - - - - - Namibia - - - - - Netherlands - - - - - Nigeria - - - - - Northern Mariana Islands - - - - - Norway - - - - - Peru - - - - - Poland - - - - - Portugal - - - - - Puerto Rico - - - - - Korea (Republic of) - - - - - Moldova (Republic of) - - - - - Romania - - - - - Russian Federation - - - - - Saint Helena, Ascension and Tristan da Cunha - - - - - Saint Kitts and Nevis - - - - - Saint Lucia - - - - - Saint Vincent and the Grenadines - - - - - Saint Thomas And Principe (Sao Tome and Principe) - - - - - Saudi Arabia - - - - - Senegal - - - - - Serbia - - - - - Sierra Leone - - - - - Saint Martin (Sint Maarten), Dutch part - - - - - Slovakia - - - - - Somalia - - - - - South Africa - - - - - Spain - - - - - Sri Lanka - - - - - Sudan - - - - - Svalbard and Jan Mayen - - - - - Swaziland - - - - - Sweden - - - - - Switzerland - - - - - Taiwan, Province of China - - - - - Thailand - - - - - Macedonia (the Former Yugoslav Republic of) - - - - - Togo - - - - - Trinidad and Tobago - - - - - Tristan da Cunha - - - - - Tunisia - - - - - Turkey - - - - - Turks and Caicos Islands - - - - - Uganda - - - - - United Kingdom - - - - - United States of America - - - - - Venezuela - - - - - Viet Nam - - - - - Virgin Island (British) - - - - - Virgin Island (U.S.) - - - - - Western Sahara - - - - - Zambia - - - - - Zimbabwe - - - - - Andorra - - - - - United Arab Emirates - - - - - Afghanistan - - - - - Australia - - - - - Aruba - - - - - Azerbaijan - - - - - Bosnia and Herzegovina - - - - - Bangladesh - - - - - Bahrain - - - - - Saint Barthelemy, French Antilles - - - - - Brunei Darussalam - - - - - Bolivia - - - - - Bhutan - - - - - Belize - - - - - Cocos Islands - - - - - Central African Republic - - - - - Cook Islands - - - - - Costa Rica - - - - - Christmas Islands - - - - - Cyprus - - - - - Djibouti - - - - - Denmark - - - - - Ecuador - - - - - Eritrea - - - - - Fiji - - - - - Falkland Islands - - - - - Micronesia, Federated States of - - - - - Faroe Islands - - - - - Georgia - - - - - French Guiana - - - - - Gibraltar - - - - - Guadeloupe - - - - - Equatorial Guinea - - - - - Guatemala - - - - - Guyana - - - - - Hong Kong - - - - - Honduras - - - - - Croatia - - - - - Haiti - - - - - Israel - - - - - British Indian Ocean Territory / Diego Garcia - - - - - Iraq - - - - - Kyrgyzstan - - - - - Cambodia - - - - - Korea, Dem. People's Rep. of - - - - - Kuwait - - - - - Lao People's Dem. Rep. - - - - - Lebanon - - - - - Liechtenstein - - - - - Liberia - - - - - Libya (Soc. People's Libyan Arab Jamahiriva) - - - - - Monaco - - - - - Montenegro - - - - - Saint Martin, French part - - - - - Marshall Islands - - - - - Mali - - - - - Myanmar - - - - - Mongolia - - - - - Macao, China - - - - - Martinique (French Dept. of) - - - - - Malta - - - - - Maldives - - - - - Malawi - - - - - Mexico - - - - - Malaysia - - - - - New Caledonia - - - - - Niger - - - - - Norfolk Island - - - - - Nicaragua - - - - - Nepal - - - - - Nauru - - - - - Niue - - - - - New Zealand - - - - - Oman - - - - - Panama - - - - - French Polynesia - - - - - Papua New Guinea - - - - - Philippines - - - - - Pakistan - - - - - Saint Pierre and Miquelon - - - - - Palestine - - - - - Palau - - - - - Paraguay - - - - - Qatar - - - - - Reunion - - - - - Rwanda - - - - - Solomon Islands - - - - - Seychelles - - - - - Singapore - - - - - Slovenia - - - - - San Marino - - - - - Suriname - - - - - South Sudan - - - - - El Salvador - - - - - Syrian Arab Republic - - - - - Chad - - - - - Tajikistan - - - - - Tokelau - - - - - Timor-Leste (East Timor) - - - - - Turkmenistan - - - - - Tonga - - - - - Tuvalu - - - - - Tanzania - - - - - Ukraine - - - - - Uruguay - - - - - Uzbekistan - - - - - Vatican City - - - - - Vanuatu - - - - - Wallis and Futuna - - - - - Samoa - - - - - Yemen - - - - - Mayotte - - - - - Current System Value - - - - + + + + Tizen.PhonenumberUtils + + + + + The PhonenumberUtils class provides methods for parsing, formatting and normalizing phone numbers. + + + + + Releases all resources used by the PhonenumberUtils. + It should be called after finished using of the object. + + + + + Gets the location string from number, region, and language. + + The number + The region of number + The language of location + The location string + Thrown when method failed due to invalid operation + Thrown when phonenumber-utils is not supported + Thrown when input coordinates are invalid + Thrown when failed due to out of memory + + + + Gets the formatted number. + + The number + The region of number + The formatted number string + Thrown when method failed due to invalid operation + Thrown when phonenumber-utils is not supported + Thrown when input coordinates are invalid + Thrown when failed due to out of memory + + + + Gets the normalized number. + + The number + The normalized number + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when method failed due to invalid operation + Thrown when phonenumber-utils is not supported + Thrown when input coordinates are invalid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + Normalized number starts with plus('+') and country code, and excludes the separators such as dash or space. + It is a format of E.164 standard including the country code based on current network. + + + + + Enumeration for language type. + + + + + Amharic + + + + + Arabic + + + + + Belarusian + + + + + Bulgarian + + + + + Chinese + + + + + Chinese (Traditional) + + + + + Czech + + + + + Dutch + + + + + English + + + + + Finnish + + + + + French + + + + + German + + + + + Greek + + + + + Hungarian + + + + + Indonesian + + + + + Italian + + + + + Japanese + + + + + Korean + + + + + Nothern Sami + + + + + Persian + + + + + Polish + + + + + Portuguese + + + + + Romanian + + + + + Russian + + + + + Serbian + + + + + Spanish + + + + + Swedish + + + + + Thai + + + + + Turkish + + + + + Vietnamese + + + + + Current System Value + + + + + Enumeration for region type. + + + + + Aland Islands + + + + + Albania + + + + + Algeria + + + + + American Samoa + + + + + Angola + + + + + Anguilla + + + + + Argentina + + + + + Armenia + + + + + Ascension Island + + + + + Antigua and Barbuda + + + + + Austria + + + + + Bahamas + + + + + Barbados + + + + + Belarus + + + + + Belgium + + + + + Benin + + + + + Bermuda + + + + + Bonaire, Sint Eustatius and Saba + + + + + Botswana + + + + + Brazil + + + + + Bulgaria + + + + + Burkina Faso + + + + + Burundi + + + + + Cape Verde (Cabo Verde) + + + + + Cameroon + + + + + Canada + + + + + Cayman Island + + + + + Chile + + + + + China + + + + + Colombia + + + + + Comoros + + + + + Congo + + + + + Ivory Coast (Cote d'Ivoire) + + + + + Cuba + + + + + Curacao + + + + + Czech Republic + + + + + Congo, Democratic Republic of the + + + + + Dominica + + + + + Dominican Republic + + + + + Egypt + + + + + Estonia + + + + + Ethiopia + + + + + Finland + + + + + France + + + + + Gabon + + + + + Gambia + + + + + Germany + + + + + Ghana + + + + + Greece + + + + + Greenland + + + + + Grenada + + + + + Guam + + + + + Guernsey + + + + + Guinea + + + + + Guinea-Bissau + + + + + Hungary + + + + + Iceland + + + + + India + + + + + Indonesia + + + + + Ireland + + + + + Iran, Islamic Republic of + + + + + Isle of Man + + + + + Italy + + + + + Jamaica + + + + + Japan + + + + + Jersey + + + + + Jordan + + + + + Kazakhstan + + + + + Kenya + + + + + Kiribati + + + + + Latvia + + + + + Lesotho + + + + + Lithuania + + + + + Luxembourg + + + + + Madagascar + + + + + Mauritania + + + + + Mauritius + + + + + Montserrat + + + + + Morocco + + + + + Mozambique + + + + + Namibia + + + + + Netherlands + + + + + Nigeria + + + + + Northern Mariana Islands + + + + + Norway + + + + + Peru + + + + + Poland + + + + + Portugal + + + + + Puerto Rico + + + + + Korea (Republic of) + + + + + Moldova (Republic of) + + + + + Romania + + + + + Russian Federation + + + + + Saint Helena, Ascension and Tristan da Cunha + + + + + Saint Kitts and Nevis + + + + + Saint Lucia + + + + + Saint Vincent and the Grenadines + + + + + Saint Thomas And Principe (Sao Tome and Principe) + + + + + Saudi Arabia + + + + + Senegal + + + + + Serbia + + + + + Sierra Leone + + + + + Saint Martin (Sint Maarten), Dutch part + + + + + Slovakia + + + + + Somalia + + + + + South Africa + + + + + Spain + + + + + Sri Lanka + + + + + Sudan + + + + + Svalbard and Jan Mayen + + + + + Swaziland + + + + + Sweden + + + + + Switzerland + + + + + Taiwan, Province of China + + + + + Thailand + + + + + Macedonia (the Former Yugoslav Republic of) + + + + + Togo + + + + + Trinidad and Tobago + + + + + Tristan da Cunha + + + + + Tunisia + + + + + Turkey + + + + + Turks and Caicos Islands + + + + + Uganda + + + + + United Kingdom + + + + + United States of America + + + + + Venezuela + + + + + Viet Nam + + + + + Virgin Island (British) + + + + + Virgin Island (U.S.) + + + + + Western Sahara + + + + + Zambia + + + + + Zimbabwe + + + + + Andorra + + + + + United Arab Emirates + + + + + Afghanistan + + + + + Australia + + + + + Aruba + + + + + Azerbaijan + + + + + Bosnia and Herzegovina + + + + + Bangladesh + + + + + Bahrain + + + + + Saint Barthelemy, French Antilles + + + + + Brunei Darussalam + + + + + Bolivia + + + + + Bhutan + + + + + Belize + + + + + Cocos Islands + + + + + Central African Republic + + + + + Cook Islands + + + + + Costa Rica + + + + + Christmas Islands + + + + + Cyprus + + + + + Djibouti + + + + + Denmark + + + + + Ecuador + + + + + Eritrea + + + + + Fiji + + + + + Falkland Islands + + + + + Micronesia, Federated States of + + + + + Faroe Islands + + + + + Georgia + + + + + French Guiana + + + + + Gibraltar + + + + + Guadeloupe + + + + + Equatorial Guinea + + + + + Guatemala + + + + + Guyana + + + + + Hong Kong + + + + + Honduras + + + + + Croatia + + + + + Haiti + + + + + Israel + + + + + British Indian Ocean Territory / Diego Garcia + + + + + Iraq + + + + + Kyrgyzstan + + + + + Cambodia + + + + + Korea, Dem. People's Rep. of + + + + + Kuwait + + + + + Lao People's Dem. Rep. + + + + + Lebanon + + + + + Liechtenstein + + + + + Liberia + + + + + Libya (Soc. People's Libyan Arab Jamahiriva) + + + + + Monaco + + + + + Montenegro + + + + + Saint Martin, French part + + + + + Marshall Islands + + + + + Mali + + + + + Myanmar + + + + + Mongolia + + + + + Macao, China + + + + + Martinique (French Dept. of) + + + + + Malta + + + + + Maldives + + + + + Malawi + + + + + Mexico + + + + + Malaysia + + + + + New Caledonia + + + + + Niger + + + + + Norfolk Island + + + + + Nicaragua + + + + + Nepal + + + + + Nauru + + + + + Niue + + + + + New Zealand + + + + + Oman + + + + + Panama + + + + + French Polynesia + + + + + Papua New Guinea + + + + + Philippines + + + + + Pakistan + + + + + Saint Pierre and Miquelon + + + + + Palestine + + + + + Palau + + + + + Paraguay + + + + + Qatar + + + + + Reunion + + + + + Rwanda + + + + + Solomon Islands + + + + + Seychelles + + + + + Singapore + + + + + Slovenia + + + + + San Marino + + + + + Suriname + + + + + South Sudan + + + + + El Salvador + + + + + Syrian Arab Republic + + + + + Chad + + + + + Tajikistan + + + + + Tokelau + + + + + Timor-Leste (East Timor) + + + + + Turkmenistan + + + + + Tonga + + + + + Tuvalu + + + + + Tanzania + + + + + Ukraine + + + + + Uruguay + + + + + Uzbekistan + + + + + Vatican City + + + + + Vanuatu + + + + + Wallis and Futuna + + + + + Samoa + + + + + Yemen + + + + + Mayotte + + + + + Current System Value + + + + diff --git a/Artifacts/bin/Tizen.Pims.Calendar.dll b/Artifacts/bin/Tizen.Pims.Calendar.dll index df0d0d2..ce92cc7 100644 Binary files a/Artifacts/bin/Tizen.Pims.Calendar.dll and b/Artifacts/bin/Tizen.Pims.Calendar.dll differ diff --git a/Artifacts/bin/Tizen.Pims.Calendar.pdb b/Artifacts/bin/Tizen.Pims.Calendar.pdb index 7b5422d..e52393a 100644 Binary files a/Artifacts/bin/Tizen.Pims.Calendar.pdb and b/Artifacts/bin/Tizen.Pims.Calendar.pdb differ diff --git a/Artifacts/bin/Tizen.Pims.Calendar.xml b/Artifacts/bin/Tizen.Pims.Calendar.xml index 2452e62..489d4bf 100644 --- a/Artifacts/bin/Tizen.Pims.Calendar.xml +++ b/Artifacts/bin/Tizen.Pims.Calendar.xml @@ -1,2863 +1,2863 @@ - - - - Tizen.Pims.Calendar - - - - - CalendarDatabase provides methods to manage calendar information from/to the database. - - - This class allows user to access/create/update db operations for calendar information. - - - - - Delegete for detecting the calendar database changes. - - The record uri - - The delegate must be registered using AddDBChangedDelegate. - It's invoked when the designated view changes. - - - - - The calendar database version. - - The current calendar database version. - - - - Gets last successful changed calendar database version on the current connection. - - The last successful changed calendar database version on the current connection - http://tizen.org/privilege/calendar.read - Thrown when method failed due to invalid operation - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - The last successful changed calendar database version on the current connection. - - - - Inserts a record into the calendar database. - - The record to be inserted - The ID of inserted record - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Gets a record from the calendar database. - - The view URI of a record - The record ID - - The record associated with the record ID - - http://tizen.org/privilege/calendar.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Updates a record in the calendar database. - - The record to be updated - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Deletes a record from the calendar database with related child records. - - The view URI of a record - The record ID to be deleted - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Replaces a record in the calendar database. - - The record to be replaced - the record id - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Retrieves all records as a list. - - The view URI to get records from - The index from which results are received - The maximum number of results(value 0 is used for all records) - - The record list - - http://tizen.org/privilege/calendar.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Retrieves records using a query. - - The query used to filter results - The index from which results are received - The maximum number of results(value 0 is used for all records) - - CalendarList - - http://tizen.org/privilege/calendar.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Inserts multiple records into the calendar database as a batch operation. - - The record list - - The inserted record id array - - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Updates multiple records into the calendar database as a batch operation. - - The record list - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Deletes multiple records with related child records from the calendar database as a batch operation. - - The view URI of the records to delete - The record IDs to delete - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Deletes multiple records with related child records from the calendar database as a batch operation. - - The record list - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Replaces multiple records in the calendar database as a batch operation. - - The record list - The record IDs - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - - Gets the record count of a specific view. - - The view URI to get records from - - The count of records - - http://tizen.org/privilege/calendar.read - - - - Gets the record count with a query. - - The query used for filtering the results - - The count of records - - http://tizen.org/privilege/calendar.read - - - - Registers a callback function to be invoked when a record changes. - - The view URI of the record to subscribe for change notifications - The callback function to register - http://tizen.org/privilege/calendar.read - - - - Deregisters a callback function. - - The view URI of the record to subscribe for change notifications - The callback function to register - http://tizen.org/privilege/calendar.read - - - - Link a record to another record. - - The base record ID - The record ID to link to - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Unlink a record from base record. - - The record ID to unlink - http://tizen.org/privilege/calendar.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - - - - - - - - - - - - - - A filter includes the conditions for the search. - - - - - Creates a filter with a condition for a string type. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for an integer type. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for long type. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for double type. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for CalendarTime type. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destroy filter. - - - - - Enumeration for the filter match type of a string. - - - - - Full string, case-sensitive - - - - - Full string, case-insensitive - - - - - Sub string, case-insensitive - - - - - Start with, case-insensitive - - - - - End with, case-insensitive - - - - - IS NOT NUL - - - - - Enumeration for the filter match type of an integer. - - - - - '=' - - - - - '>' - - - - - '>=' - - - - - < - - - - - <= - - - - - <>, this flag can yield poor performance - - - - - IS NULL - - - - - Enumeration for a filter operator. - - - - - AND - - - - - OR - - - - - Dispose - - - - - Releases all resources used by the CalendarFilter. - It should be called after having finished using of the object. - - - - - Adds a condition for the string type. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for the integer type. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for the long type. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for the double type. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for the CalendarTime type. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a child filter to a parent filter. - - The operator type - The child filter - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - A list of records with the same type. - - - - - Creates a calendar list. - - Thrown when an invoked method is not supported - Thrown when failed due to out of memory - - - - The count of the calendar entity. - - The count of calendar entity. - - - - Destory CalendarList resource. - - - - - Disposes of the resources (other than memory) used by the CalendarList. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the CalendarList. - It should be called after having finished using of the object. - - - - - Adds a record to the calendar list. - - The record to be added - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Removes a record from the calendar list. - - The record to be removed - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Retrieves a record from the calendar list. - - - calendar record - - - - - Moves a calendar list to the previous position. - - - if cursor is moved to the end, it returns false. - - - - - Moves a calendar list to the next position. - - - if cursor is moved to the end, it returns false. - - - - - Moves a calendar list to the first position. - - - - - Moves a calendar list to the last position. - - - - - A class for managing calendar information. It allows applications to use calendar service. - - - - - Create a manager. - - Thrown when method failed due to invalid operation - - - - Destory CalendarManager resource. - - - - To detect redundant calls - - - - Disposes of the resources (other than memory) used by the CalendarManager. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the CalendarManager. - It should be called after having finished using of the object. - - - - - Get database. - - The database instance - - - - A query is used to retrieve data which satisfies given criteria. - - - A query is used to retrieve calendar data which satisfies a given criteria, - such as an integer property being greater than a given value, - or a string property containing a given substring. - A query needs a filter which can set the conditions for the search. - - - - - Creates a query. - - The view URI of a query - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destructor - - - - - Disposes of the resources (other than memory) used by the CalendarQuery. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the CalendarQuery. - It should be called after having finished using of the object. - - - - - Adds property IDs for projection. - - The property ID array - Thrown when one of the arguments provided to a method is not valid - - - - Sets the "distinct" option for projection. - - If true it is set, otherwise if false it is unset - Thrown when one of the arguments provided to a method is not valid - - - - Sets the filter for a query. - - The filter - Thrown when one of the arguments provided to a method is not valid - - - - Sets the sort mode for a query. - - The property ID to sort - If true it sorts in the ascending order, otherwise if false it sorts in the descending order - Thrown when one of the arguments provided to a method is not valid - - - - A record represents an actual record in the database - - - A record represents an actual record in the database, - but you can also consider it a piece of information, such as an alarm, attendee and extended. - A record can be a complex set of data, containing other data. - For example, a calendar record contains the alarm property, which is a reference to an alarm record. - An alarm record could belong to a event record, - and its alarm id property is set to the identifier of the corresponding event. - In this case, the alarm is the child record of the event and the event is the parent record. - - - - - Creates a record. - - The view URI - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destructor - - - - To detect redundant calls - - - - Disposes of the resources (other than memory) used by the CalendarRecord. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the CalendarRecord. - It should be called after having finished using of the object. - - - - - Makes a clone of a record. - - - A cloned record - - Thrown when failed due to out of memory - - - - Get record URI. - - The URI of the record - - - - Gets a object from a record. - - The property ID - - The value of the property corresponding to property id. - - Thrown when one of the arguments provided to a method is not valid - - - - Sets a value of the property to a record. - - The property ID - value - Thrown when one of the arguments provided to a method is not valid - - - - Adds a child record to the parent record. - - The property ID - The child record - Thrown when one of the arguments provided to a method is not valid - - - - Removes a child record from the parent record. - - The property ID - The child record - Thrown when one of the arguments provided to a method is not valid - - - - Gets a child record from the parent record - - The property ID - - The number of child records corresponding to property ID - - Thrown when one of the arguments provided to a method is not valid - - - - Gets a child record from the parent record - - The property ID - The child record index - - The record - - Thrown when one of the arguments provided to a method is not valid - - - - Clones a child record list corresponding to property ID - - The property ID - - the record list - - Thrown when one of the arguments provided to a method is not valid - - - - A class for reminder for event. - - - The client who wants to be alerted at specific time should register MIME("application/x-tizen.calendar.reminder") type in manifest.xml file. - - - - - Disposes of the resources (other than memory) used by the CalendarReminder. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Releases all resources used by the CalendarReminder. - It should be called after having finished using of the object. - - - - - Reminder event is triggered when the alarm is alerted. - - - - - A class for time to set, get or calculate. - - - - - Enumeration for the time type. - - - - - UTC time - - - - - Local time - - - - - Create UTC CalendarTime - - UTC epoch time. 0 is 1971/01/01 - - - - Create Local CalendarTime - - year - month - day - hour - minute - second - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Get UtcTime - - The Utc time - - - - Get localTime - - The localtime - - - - Compare CalendarTime - - The CalendarTime to be compared - - A 32-bit signed integer that indicates the relative order of the objects being compared. - - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - This class provides enumurations about calendar inforamtion. - - - Most enumurations are based on vcalendar, icalendar(ver 2.0) specification. - https://www.ietf.org/rfc/rfc2445.txt - - - - - Enumeration for Default book - - - - - Default event calendar book. - - - - - Default Todo calendar book. - - - - - Default Birthday calendar book. - - - - - Enumeration for Store type - - - - - Book type - - - - - Event type - - - - - Todo type - - - - - Enumeration for the book mode. - - - - - All modules can read and write records of this calendar_book - - - - - All modules can only read records of this calendar book - - - - - Enumeration for the event status. - - - - - No status - - - - - The event is tentative - - - - - The event is confirmed - - - - - The event is cancelled - - - - - Enumeration for for the status of a to-do. - - - - - No status - - - - - Needs action status - - - - - Completed status - - - - - Work in process status - - - - - Cancelled status - - - - - Enumeration for the busy status of an event. - - - - - The free status - - - - - The busy status - - - - - The unavailable status - - - - - The tentative status - - - - - Enumeration for the calendar sensitivity type. - - - - - Public Sensitivity - - - - - Private Sensitivity - - - - - Confidential Sensitivity - - - - - Enumeration for the meeting status. - - - - - No meeting - - - - - Meeting exists - - - - - Meeting received - - - - - Meeting cancelled - - - - - Enumeration for the calendar event item's priority - - - - - No priority - - - - - Low priority - - - - - Normal priority - - - - - High priority - - - - - Enumeration for the frequency of an event's recurrence. - - - - - No recurrence event - - - - - An event occurs every day - - - - - An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week - - - - - An event occurs on the same day of every month - - - - - An event occurs on the same day of every year - - - - - Enumeration for the range type. - - - - - Range until - - - - - Range count - - - - - No range - - - - - Enumeration for the system type. - - - - - Locale's default calendar - - - - - Locale's default calendar - - - - - East asian lunisolar calendar - - - - - Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on. - - - - - No reminder set - - - - - Specific in seconds - - - - - Alarm time unit in minutes - - - - - Alarm time unit in hours - - - - - Alarm time unit in days - - - - - Alarm time unit in weeks - - - - - Enumeration for weekdays. - - - - - Sunday - - - - - Monday - - - - - Tuesday - - - - - Wednesday - - - - - Thursday - - - - - Friday - - - - - Saturday - - - - - Enumeration to specify the type of calendar user specified by the property. - - - - - An individual - - - - - A group of individuals - - - - - A physical resource - - - - - A room resource - - - - - Otherwise not known - - - - - Enumeration for the attendee role. - - - - - Participation is required - - - - - Accepted status - - - - - Non-Participant - - - - - Chairperson - - - - - Enumeration for the attendee status. - - - - - Pending status - - - - - Accepted status - - - - - Declined status - - - - - Tentative status - - - - - Delegated status - - - - - Completed status - - - - - In process status - - - - - Enumeration for the alarm action. - - - - - Audio action - - - - - Display action - - - - - Email action - - - - - Parsing vcalendar file callback function. - - The record - - - - A class for parsing and composing vCalendar. - - - It's based on the vCalendar v2.0 specification - - - - - Retrieves a vcalendar stream from a calendar list. - - The calendar list - - The composed stream. - - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Retrieves all calendars from a vcalendar stream. - - The vcalendar stream - - the record list - - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Parse vcalendar file with foreach - - The file path of the vCalendar stream file - he callback function to invoke - Thrown when method failed due to invalid operation - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - data type mask 0x0FF00000 - - - property : mask 0x0000F000 - - - book - - - Event - - - Todo - - - Timezone - - - average size - - - - Describes properies of a Book record. - - - - - Identifier of this calendar book view - - - - - DB record ID of the calendar book - - - - - Unique identifier - - - - - Calendar book name - - - - - Calendar book description - - - - - Calendar book color for UX - - - - - Location of the event - - - - - Visibility of the calendar book for UX - - - - - Currently NOT Used - - - - - Account for this calendar - - - - - Type of calendar contents(refer to the CalendarTypes.StoreType) - - - - - Generic data for use by syncing - - - - - Generic data for use by syncing - - - - - Generic data for use by syncing - - - - - Generic data for use by syncing - - - - - Calendar book mode(refer to the CalendarTypes.BookMode) - - - - - Describes properies of a Event record. - - - - - Identifier of this event view - - - - - DB record ID of the event - - - - - ID of the calendar book to which the event belongs - - - - - The short description of the event - - - - - The description of the event - - - - - The location of the event - - - - - The category of the event. For example APPOINTMENT, BIRTHDAY - - - - - The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma - - - - - The status of event(refer to the CalendarTypes.EventStatus). - - - - - The priority of event(refer to the CalendarTypes.Priority). - - - - - The timezone_id of the event if it exists. - - - - - The person_id of the event if the event is a birthday. Refer to the contacts-service - - - - - The busy status of event(refer to the CalendarTypes.BusyStatus). - - - - - The Sensitivity of event(refer to the CalendarTypes.Sensitivity). - - - - - The unique ID of the event - - - - - The name of organizer of the event - - - - - The email address of the organizer of the event - - - - - The meeting status of event(refer to the CalendarTypes.MeetingStatus). - - - - - The ID of the original event if the event is an exception. - - - - - The latitude of the location of the event - - - - - The longitude of the location of the event - - - - - ID of the email_id. Refer to the email-service. - - - - - The time when the event is created - - - - - The time when the event is updated - - - - - Whether or not the event is deleted - - - - - The frequent type of event recurrence(refer to the CalendarTypes.Recurrence). - - - - - The range type of event recurrence(refer to the CalendarTypes.RangeType). - - - - - The end time of the event recurrence. Only if this is used with RangeType.Until. - - - - - The count of the event recurrence. Only if this is used with RangeType.Count. - - - - - The interval of the event recurrence - - - - - The second list of the event recurrence. The value can be from 0 to 59. The list is separated by comma - - - - - The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas - - - - - The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas - - - - - The day list of the event recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas. - - - - - The month day list of the event recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas. - - - - - The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas - - - - - The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas - - - - - The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas - - - - - The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas - - - - - The start day of the week(refer to the CalendarTypes.WeekDay). - - - - - RECURRENCE-ID of RFC #2445 - - - - - RDATE of RFC #2445 - - - - - Whether or not the event has an attendee list - - - - - Whether or not the event has an alarm list - - - - - The sync data of the event. If developer need to save some information related to the event, they can use this property - - - - - The sync data of the event. If developer need to save some information related to the event, they can use this property - - - - - The sync data of the event. If developer need to save some information related to the event, they can use this property - - - - - The sync data of the event. If developer need to save some information related to the event, they can use this property - - - - - The start time of the event - - - - - The end time of the event - - - - - The alarm list of the event. - - - - - The attendee list of the event. - - - - - The Calendar system type(refer to the CalendarTypes.SystemType). - - - - - The timezone of the start_time - - - - - The timezone of the end_time - - - - - The exception mod event list of the event - - - - - The extended property list of the event. - - - - - The event is an allday event or not - - - - - The linked event count - - - - - The event is an base linked event - - - - - Describes properies of a Todo record. - - - - - Identifier of this todo view - - - - - DB record ID of the todo - - - - - ID of the calendar book to which the todo belongs - - - - - The short description of the todo - - - - - The description of the todo - - - - - The location of the todo - - - - - The category of the todo. i.g. APPOINTMENT, BIRTHDAY - - - - - The status of todo(refer to the CalendarTypes.TodoStatus). - - - - - The Priority of todo(refer to the CalendarTypes.Priority). - - - - - The Sensitivity of todo(refer to the CalendarTypes.Sensitivity). - - - - - The unique ID of the todo - - - - - The latitude of the location of the todo - - - - - The longitude of the location of the todo - - - - - The progression of the todo. The value can be from 0 to 100 - - - - - The time when the todo is create - - - - - The time when the todo is updated - - - - - The time when the todo is completed - - - - - Whether or not the todo is deleted - - - - - The frequent type of todo recurrence(refer to the CalendarTypes.Recurrence). - - - - - The range type of todo recurrence(refer to the CalendarTypes.RangeType). - - - - - The end time of the todo recurrence. Only if this is used with RangeType.Until. - - - - - The count of the todo recurrence. Only if this is used with RangeType.Count. - - - - - The interval of the todo recurrence - - - - - The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas - - - - - The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas - - - - - The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas - - - - - The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas - - - - - The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas - - - - - The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas - - - - - The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas - - - - - The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas - - - - - The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas - - - - - The start day of the week(refer to the CalendarTypes.WeekDay). - - - - - Whether or not the todo has an alarm list - - - - - The sync data of the todo. If developers need to save some information related to the todo, they can use this property - - - - - The sync data of the todo. If developers need to save some information related to the todo, they can use this property - - - - - The sync data of the todo. If developers need to save some information related to the todo, they can use this property - - - - - The sync data of the todo. If developers need to save some information related to the todo, they can use this property - - - - - The start time of the todo - - - - - The due time of the todo - - - - - The alarm list of the todo. - - - - - The timezone of the start_time - - - - - The timezone of the due_time - - - - - The name of the organizer of the event - - - - - The email address of the organizer of the todo - - - - - Whether or not the todo has an attendee list - - - - - The attendee list of the todo. - - - - - The extended property list of the todo. - - - - - The todo is an allday event or not - - - - - Describes properies of a Timezone record. - - - - - Identifier of this timezone view - - - - - DB record ID of the timezone - - - - - UTC offset which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00) - - - - - Name of the Standard Time - - - - - Starting month of the Standard Time. Month is 0-based. eg, 0 for January - - - - - Starting day-of-week-in-month of the Standard Time. Day is 1-based - - - - - Starting day-of-week of the Standard Time. Valid values are 1(SUNDAY) to 7(SATURDAY) - - - - - Starting hour of the Standard Time. Valid values are 0 to 23 - - - - - The number of minutes added during the Standard Time - - - - - Name of Daylight - - - - - Starting month of Daylight. Month is 0-based. eg, 0 for January - - - - - Starting day-of-week-in-month of Daylight. Day is 1-based - - - - - Starting day-of-week of Daylight. Valid values are 1(SUNDAY) to 7(SATURDAY) - - - - - Starting hour of Daylight. Valid values are 0 to 23 - - - - - The number of minutes added during Daylight Time - - - - - DB record ID of a related calendar book - - - - - Describes properies of a Attendee record. - - - - - Identifier of this calendar attendee view - - - - - The number of the attendee - - - - - The type of attendee(refer to the CalendarTypes.Cutype). - - - - - CtIndex - - - - - Unique identifier - - - - - Group - - - - - The email address of the attendee - - - - - Attendee role(refer to the CalendarTypes.AttendeeRole). - - - - - Attendee status(refer to the CalendarTypes.AttendeeStatus). - - - - - RSVP invitation reply (one of true, false) - - - - - Delegatee (DELEGATED-TO) - - - - - Delegator (DELEGATED-FROM) - - - - - Attendee name - - - - - Group that the attendee belongs to - - - - - Event/TODO that the attendee belongs to - - - - - Describes properies of a Alarm record. - - - - - Identifier of this calendar alarm view - - - - - The number of unit before start time. This MUST be used with one of TickUnit. - - - - - Reminder tick time unit(refer to the CalendarTypes.TickUnit). - - - - - Alarm description - - - - - Event that the alarm belongs to - - - - - Alarm summary - - - - - Action of alarm(refer to the CalendarTypes.Action). - - - - - Alarm tone path - - - - - The alarm time - - - - - Describes properies of a InstanceUtimeBook record. - - Read only view - - - - Identifier of this instance utime book - - - - - Event id - - - - - Start time - - - - - End time - - - - - Summary - - - - - Location - - - - - Book id - - - - - Description - - - - - BusyStatus - - - - - EventStatus - - - - - Priority - - - - - Sensitivity - - - - - HasRrule - - - - - Latitude - - - - - Longitude - - - - - HasAlarm - - - - - OriginalEventId - - - - - LastModifiedtime - - - - - SyncData1 - - - - - Describes properies of a InstanceLocaltimeBook record. - - Read only view - - - - Uri - - - - - EventId - - - - - Start - - - - - End - - - - - Summary - - - - - Location - - - - - BookId - - - - - Description - - - - - BusyStatus - - - - - EventStatus - - - - - Priority - - - - - Sensitivity - - - - - HasRrule - - - - - Latitude - - - - - Longitude - - - - - HasAlarm - - - - - OriginalEventId - - - - - LastModifiedTime - - - - - SyncData1 - - - - - IsAllday - - - - - Describes properies of a InstanceUtimeBookExtended record. - - Read only view - - - - Uri - - - - - EventId - - - - - Start - - - - - End - - - - - Summary - - - - - Location - - - - - BookId - - - - - Description - - - - - BusyStatus - - - - - EventStatus - - - - - Priority - - - - - Sensitivity - - - - - HasRrule - - - - - Latitude - - - - - Longitude - - - - - HasAlarm - - - - - OriginalEventId - - - - - LastModifiedTime - - - - - SyncData1 - - - - - OrganizerName - - - - - Categories - - - - - HasAttendee - - - - - SyncData2 - - - - - SyncData3 - - - - - SyncData4 - - - - - Describes properies of a InstanceLocaltimeBookExtended record. - - Read only view - - - - Uri - - - - - EventId - - - - - Start - - - - - End - - - - - Summary - - - - - Location - - - - - BookId - - - - - Description - - - - - BusyStatus - - - - - EventStatus - - - - - Priority - - - - - Sensitivity - - - - - HasRrule - - - - - Latitude - - - - - Longitude - - - - - HasAlarm - - - - - OriginalEventId - - - - - LastModifiedTime - - - - - SyncData1 - - - - - OrganizerName - - - - - Categories - - - - - HasAttendee - - - - - SyncData2 - - - - - SyncData3 - - - - - SyncData4 - - - - - IsAllday - - - - - Describes properies of a UpdatedInfo record. - - Read only view - - - - Identifier of this updatedInfo view - - - - - Modified event(or todo) record ID - - - - - Calendar book ID of the modified event(or todo) record - - - - - Enumeration value of the modified status. - - - - - Version after change - - - - - Describes properies of a Extended record. - - - - - Identifier of this extended_property view - - - - - DB record ID of the extended_property - - - - - Related record ID - - - - - Enumeration value of the record type. - - - - - The key of the property - - - - - The value of the property - - - - - Event arguments passed when alarm is alerted. - - - - - The paramter which data is combinded(Value string like id=value&time=value&tick=value&unit=value&type=value) - - - - + + + + Tizen.Pims.Calendar + + + + + CalendarDatabase provides methods to manage calendar information from/to the database. + + + This class allows user to access/create/update db operations for calendar information. + + + + + Delegete for detecting the calendar database changes. + + The record uri + + The delegate must be registered using AddDBChangedDelegate. + It's invoked when the designated view changes. + + + + + The calendar database version. + + The current calendar database version. + + + + Gets last successful changed calendar database version on the current connection. + + The last successful changed calendar database version on the current connection + http://tizen.org/privilege/calendar.read + Thrown when method failed due to invalid operation + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + The last successful changed calendar database version on the current connection. + + + + Inserts a record into the calendar database. + + The record to be inserted + The ID of inserted record + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Gets a record from the calendar database. + + The view URI of a record + The record ID + + The record associated with the record ID + + http://tizen.org/privilege/calendar.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Updates a record in the calendar database. + + The record to be updated + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Deletes a record from the calendar database with related child records. + + The view URI of a record + The record ID to be deleted + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Replaces a record in the calendar database. + + The record to be replaced + the record id + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Retrieves all records as a list. + + The view URI to get records from + The index from which results are received + The maximum number of results(value 0 is used for all records) + + The record list + + http://tizen.org/privilege/calendar.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Retrieves records using a query. + + The query used to filter results + The index from which results are received + The maximum number of results(value 0 is used for all records) + + CalendarList + + http://tizen.org/privilege/calendar.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Inserts multiple records into the calendar database as a batch operation. + + The record list + + The inserted record id array + + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Updates multiple records into the calendar database as a batch operation. + + The record list + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Deletes multiple records with related child records from the calendar database as a batch operation. + + The view URI of the records to delete + The record IDs to delete + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Deletes multiple records with related child records from the calendar database as a batch operation. + + The record list + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Replaces multiple records in the calendar database as a batch operation. + + The record list + The record IDs + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + + Gets the record count of a specific view. + + The view URI to get records from + + The count of records + + http://tizen.org/privilege/calendar.read + + + + Gets the record count with a query. + + The query used for filtering the results + + The count of records + + http://tizen.org/privilege/calendar.read + + + + Registers a callback function to be invoked when a record changes. + + The view URI of the record to subscribe for change notifications + The callback function to register + http://tizen.org/privilege/calendar.read + + + + Deregisters a callback function. + + The view URI of the record to subscribe for change notifications + The callback function to register + http://tizen.org/privilege/calendar.read + + + + Link a record to another record. + + The base record ID + The record ID to link to + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Unlink a record from base record. + + The record ID to unlink + http://tizen.org/privilege/calendar.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + + + + + + + + + + + + + + A filter includes the conditions for the search. + + + + + Creates a filter with a condition for a string type. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for an integer type. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for long type. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for double type. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for CalendarTime type. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destroy filter. + + + + + Enumeration for the filter match type of a string. + + + + + Full string, case-sensitive + + + + + Full string, case-insensitive + + + + + Sub string, case-insensitive + + + + + Start with, case-insensitive + + + + + End with, case-insensitive + + + + + IS NOT NUL + + + + + Enumeration for the filter match type of an integer. + + + + + '=' + + + + + '>' + + + + + '>=' + + + + + < + + + + + <= + + + + + <>, this flag can yield poor performance + + + + + IS NULL + + + + + Enumeration for a filter operator. + + + + + AND + + + + + OR + + + + + Dispose + + + + + Releases all resources used by the CalendarFilter. + It should be called after having finished using of the object. + + + + + Adds a condition for the string type. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for the integer type. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for the long type. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for the double type. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for the CalendarTime type. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a child filter to a parent filter. + + The operator type + The child filter + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + A list of records with the same type. + + + + + Creates a calendar list. + + Thrown when an invoked method is not supported + Thrown when failed due to out of memory + + + + The count of the calendar entity. + + The count of calendar entity. + + + + Destory CalendarList resource. + + + + + Disposes of the resources (other than memory) used by the CalendarList. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the CalendarList. + It should be called after having finished using of the object. + + + + + Adds a record to the calendar list. + + The record to be added + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Removes a record from the calendar list. + + The record to be removed + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Retrieves a record from the calendar list. + + + calendar record + + + + + Moves a calendar list to the previous position. + + + if cursor is moved to the end, it returns false. + + + + + Moves a calendar list to the next position. + + + if cursor is moved to the end, it returns false. + + + + + Moves a calendar list to the first position. + + + + + Moves a calendar list to the last position. + + + + + A class for managing calendar information. It allows applications to use calendar service. + + + + + Create a manager. + + Thrown when method failed due to invalid operation + + + + Destory CalendarManager resource. + + + + To detect redundant calls + + + + Disposes of the resources (other than memory) used by the CalendarManager. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the CalendarManager. + It should be called after having finished using of the object. + + + + + Get database. + + The database instance + + + + A query is used to retrieve data which satisfies given criteria. + + + A query is used to retrieve calendar data which satisfies a given criteria, + such as an integer property being greater than a given value, + or a string property containing a given substring. + A query needs a filter which can set the conditions for the search. + + + + + Creates a query. + + The view URI of a query + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destructor + + + + + Disposes of the resources (other than memory) used by the CalendarQuery. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the CalendarQuery. + It should be called after having finished using of the object. + + + + + Adds property IDs for projection. + + The property ID array + Thrown when one of the arguments provided to a method is not valid + + + + Sets the "distinct" option for projection. + + If true it is set, otherwise if false it is unset + Thrown when one of the arguments provided to a method is not valid + + + + Sets the filter for a query. + + The filter + Thrown when one of the arguments provided to a method is not valid + + + + Sets the sort mode for a query. + + The property ID to sort + If true it sorts in the ascending order, otherwise if false it sorts in the descending order + Thrown when one of the arguments provided to a method is not valid + + + + A record represents an actual record in the database + + + A record represents an actual record in the database, + but you can also consider it a piece of information, such as an alarm, attendee and extended. + A record can be a complex set of data, containing other data. + For example, a calendar record contains the alarm property, which is a reference to an alarm record. + An alarm record could belong to a event record, + and its alarm id property is set to the identifier of the corresponding event. + In this case, the alarm is the child record of the event and the event is the parent record. + + + + + Creates a record. + + The view URI + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destructor + + + + To detect redundant calls + + + + Disposes of the resources (other than memory) used by the CalendarRecord. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the CalendarRecord. + It should be called after having finished using of the object. + + + + + Makes a clone of a record. + + + A cloned record + + Thrown when failed due to out of memory + + + + Get record URI. + + The URI of the record + + + + Gets a object from a record. + + The property ID + + The value of the property corresponding to property id. + + Thrown when one of the arguments provided to a method is not valid + + + + Sets a value of the property to a record. + + The property ID + value + Thrown when one of the arguments provided to a method is not valid + + + + Adds a child record to the parent record. + + The property ID + The child record + Thrown when one of the arguments provided to a method is not valid + + + + Removes a child record from the parent record. + + The property ID + The child record + Thrown when one of the arguments provided to a method is not valid + + + + Gets a child record from the parent record + + The property ID + + The number of child records corresponding to property ID + + Thrown when one of the arguments provided to a method is not valid + + + + Gets a child record from the parent record + + The property ID + The child record index + + The record + + Thrown when one of the arguments provided to a method is not valid + + + + Clones a child record list corresponding to property ID + + The property ID + + the record list + + Thrown when one of the arguments provided to a method is not valid + + + + A class for reminder for event. + + + The client who wants to be alerted at specific time should register MIME("application/x-tizen.calendar.reminder") type in manifest.xml file. + + + + + Disposes of the resources (other than memory) used by the CalendarReminder. + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Releases all resources used by the CalendarReminder. + It should be called after having finished using of the object. + + + + + Reminder event is triggered when the alarm is alerted. + + + + + A class for time to set, get or calculate. + + + + + Enumeration for the time type. + + + + + UTC time + + + + + Local time + + + + + Create UTC CalendarTime + + UTC epoch time. 0 is 1971/01/01 + + + + Create Local CalendarTime + + year + month + day + hour + minute + second + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Get UtcTime + + The Utc time + + + + Get localTime + + The localtime + + + + Compare CalendarTime + + The CalendarTime to be compared + + A 32-bit signed integer that indicates the relative order of the objects being compared. + + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + This class provides enumurations about calendar inforamtion. + + + Most enumurations are based on vcalendar, icalendar(ver 2.0) specification. + https://www.ietf.org/rfc/rfc2445.txt + + + + + Enumeration for Default book + + + + + Default event calendar book. + + + + + Default Todo calendar book. + + + + + Default Birthday calendar book. + + + + + Enumeration for Store type + + + + + Book type + + + + + Event type + + + + + Todo type + + + + + Enumeration for the book mode. + + + + + All modules can read and write records of this calendar_book + + + + + All modules can only read records of this calendar book + + + + + Enumeration for the event status. + + + + + No status + + + + + The event is tentative + + + + + The event is confirmed + + + + + The event is cancelled + + + + + Enumeration for for the status of a to-do. + + + + + No status + + + + + Needs action status + + + + + Completed status + + + + + Work in process status + + + + + Cancelled status + + + + + Enumeration for the busy status of an event. + + + + + The free status + + + + + The busy status + + + + + The unavailable status + + + + + The tentative status + + + + + Enumeration for the calendar sensitivity type. + + + + + Public Sensitivity + + + + + Private Sensitivity + + + + + Confidential Sensitivity + + + + + Enumeration for the meeting status. + + + + + No meeting + + + + + Meeting exists + + + + + Meeting received + + + + + Meeting cancelled + + + + + Enumeration for the calendar event item's priority + + + + + No priority + + + + + Low priority + + + + + Normal priority + + + + + High priority + + + + + Enumeration for the frequency of an event's recurrence. + + + + + No recurrence event + + + + + An event occurs every day + + + + + An event occurs on the same day of every week. According to the week flag, the event will recur every day of the week + + + + + An event occurs on the same day of every month + + + + + An event occurs on the same day of every year + + + + + Enumeration for the range type. + + + + + Range until + + + + + Range count + + + + + No range + + + + + Enumeration for the system type. + + + + + Locale's default calendar + + + + + Locale's default calendar + + + + + East asian lunisolar calendar + + + + + Enumeration for the alarm time unit type of an event, such as minutes, hours, days, and so on. + + + + + No reminder set + + + + + Specific in seconds + + + + + Alarm time unit in minutes + + + + + Alarm time unit in hours + + + + + Alarm time unit in days + + + + + Alarm time unit in weeks + + + + + Enumeration for weekdays. + + + + + Sunday + + + + + Monday + + + + + Tuesday + + + + + Wednesday + + + + + Thursday + + + + + Friday + + + + + Saturday + + + + + Enumeration to specify the type of calendar user specified by the property. + + + + + An individual + + + + + A group of individuals + + + + + A physical resource + + + + + A room resource + + + + + Otherwise not known + + + + + Enumeration for the attendee role. + + + + + Participation is required + + + + + Accepted status + + + + + Non-Participant + + + + + Chairperson + + + + + Enumeration for the attendee status. + + + + + Pending status + + + + + Accepted status + + + + + Declined status + + + + + Tentative status + + + + + Delegated status + + + + + Completed status + + + + + In process status + + + + + Enumeration for the alarm action. + + + + + Audio action + + + + + Display action + + + + + Email action + + + + + Parsing vcalendar file callback function. + + The record + + + + A class for parsing and composing vCalendar. + + + It's based on the vCalendar v2.0 specification + + + + + Retrieves a vcalendar stream from a calendar list. + + The calendar list + + The composed stream. + + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Retrieves all calendars from a vcalendar stream. + + The vcalendar stream + + the record list + + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Parse vcalendar file with foreach + + The file path of the vCalendar stream file + he callback function to invoke + Thrown when method failed due to invalid operation + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + data type mask 0x0FF00000 + + + property : mask 0x0000F000 + + + book + + + Event + + + Todo + + + Timezone + + + average size + + + + Describes properies of a Book record. + + + + + Identifier of this calendar book view + + + + + DB record ID of the calendar book + + + + + Unique identifier + + + + + Calendar book name + + + + + Calendar book description + + + + + Calendar book color for UX + + + + + Location of the event + + + + + Visibility of the calendar book for UX + + + + + Currently NOT Used + + + + + Account for this calendar + + + + + Type of calendar contents(refer to the CalendarTypes.StoreType) + + + + + Generic data for use by syncing + + + + + Generic data for use by syncing + + + + + Generic data for use by syncing + + + + + Generic data for use by syncing + + + + + Calendar book mode(refer to the CalendarTypes.BookMode) + + + + + Describes properies of a Event record. + + + + + Identifier of this event view + + + + + DB record ID of the event + + + + + ID of the calendar book to which the event belongs + + + + + The short description of the event + + + + + The description of the event + + + + + The location of the event + + + + + The category of the event. For example APPOINTMENT, BIRTHDAY + + + + + The exception list of the event. If this event has a recurrence rule, the instance of the exdate is removed. Format is "YYYYMMDD"(allday event) or "YYYYMMDDTHHMMSS". Multiple exceptions can be included with a comma + + + + + The status of event(refer to the CalendarTypes.EventStatus). + + + + + The priority of event(refer to the CalendarTypes.Priority). + + + + + The timezone_id of the event if it exists. + + + + + The person_id of the event if the event is a birthday. Refer to the contacts-service + + + + + The busy status of event(refer to the CalendarTypes.BusyStatus). + + + + + The Sensitivity of event(refer to the CalendarTypes.Sensitivity). + + + + + The unique ID of the event + + + + + The name of organizer of the event + + + + + The email address of the organizer of the event + + + + + The meeting status of event(refer to the CalendarTypes.MeetingStatus). + + + + + The ID of the original event if the event is an exception. + + + + + The latitude of the location of the event + + + + + The longitude of the location of the event + + + + + ID of the email_id. Refer to the email-service. + + + + + The time when the event is created + + + + + The time when the event is updated + + + + + Whether or not the event is deleted + + + + + The frequent type of event recurrence(refer to the CalendarTypes.Recurrence). + + + + + The range type of event recurrence(refer to the CalendarTypes.RangeType). + + + + + The end time of the event recurrence. Only if this is used with RangeType.Until. + + + + + The count of the event recurrence. Only if this is used with RangeType.Count. + + + + + The interval of the event recurrence + + + + + The second list of the event recurrence. The value can be from 0 to 59. The list is separated by comma + + + + + The minute list of the event recurrence. The value can be from 0 to 59. The list is separated by commas + + + + + The hour list of the event recurrence. The value can be from 0 to 23. The list is separated by commas + + + + + The day list of the event recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas. + + + + + The month day list of the event recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas. + + + + + The year day list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + + + + + The week number list of the event recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas + + + + + The month list of the event recurrence. The value can be from 1 to 12. The list is separated by commas + + + + + The position list of the event recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + + + + + The start day of the week(refer to the CalendarTypes.WeekDay). + + + + + RECURRENCE-ID of RFC #2445 + + + + + RDATE of RFC #2445 + + + + + Whether or not the event has an attendee list + + + + + Whether or not the event has an alarm list + + + + + The sync data of the event. If developer need to save some information related to the event, they can use this property + + + + + The sync data of the event. If developer need to save some information related to the event, they can use this property + + + + + The sync data of the event. If developer need to save some information related to the event, they can use this property + + + + + The sync data of the event. If developer need to save some information related to the event, they can use this property + + + + + The start time of the event + + + + + The end time of the event + + + + + The alarm list of the event. + + + + + The attendee list of the event. + + + + + The Calendar system type(refer to the CalendarTypes.SystemType). + + + + + The timezone of the start_time + + + + + The timezone of the end_time + + + + + The exception mod event list of the event + + + + + The extended property list of the event. + + + + + The event is an allday event or not + + + + + The linked event count + + + + + The event is an base linked event + + + + + Describes properies of a Todo record. + + + + + Identifier of this todo view + + + + + DB record ID of the todo + + + + + ID of the calendar book to which the todo belongs + + + + + The short description of the todo + + + + + The description of the todo + + + + + The location of the todo + + + + + The category of the todo. i.g. APPOINTMENT, BIRTHDAY + + + + + The status of todo(refer to the CalendarTypes.TodoStatus). + + + + + The Priority of todo(refer to the CalendarTypes.Priority). + + + + + The Sensitivity of todo(refer to the CalendarTypes.Sensitivity). + + + + + The unique ID of the todo + + + + + The latitude of the location of the todo + + + + + The longitude of the location of the todo + + + + + The progression of the todo. The value can be from 0 to 100 + + + + + The time when the todo is create + + + + + The time when the todo is updated + + + + + The time when the todo is completed + + + + + Whether or not the todo is deleted + + + + + The frequent type of todo recurrence(refer to the CalendarTypes.Recurrence). + + + + + The range type of todo recurrence(refer to the CalendarTypes.RangeType). + + + + + The end time of the todo recurrence. Only if this is used with RangeType.Until. + + + + + The count of the todo recurrence. Only if this is used with RangeType.Count. + + + + + The interval of the todo recurrence + + + + + The second list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas + + + + + The minute list of the todo recurrence. The value can be from 0 to 59. The list is separated by commas + + + + + The hour list of the todo recurrence. The value can be from 0 to 23. The list is separated by commas + + + + + The day list of the todo recurrence. The value can be SU, MO, TU, WE, TH, FR, SA. The list is separated by commas + + + + + The month day list of the todo recurrence. The value can be from 1 to 31 and from -31 to -1. The list is separated by commas + + + + + The year day list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + + + + + The week number list of the todo recurrence. The value can be from 1 to 53 and from -53 to -1. The list is separated by commas + + + + + The month list of the todo recurrence. The value can be from 1 to 12. The list is separated by commas + + + + + The position list of the todo recurrence. The value can be from 1 to 366 and from -366 to -1. The list is separated by commas + + + + + The start day of the week(refer to the CalendarTypes.WeekDay). + + + + + Whether or not the todo has an alarm list + + + + + The sync data of the todo. If developers need to save some information related to the todo, they can use this property + + + + + The sync data of the todo. If developers need to save some information related to the todo, they can use this property + + + + + The sync data of the todo. If developers need to save some information related to the todo, they can use this property + + + + + The sync data of the todo. If developers need to save some information related to the todo, they can use this property + + + + + The start time of the todo + + + + + The due time of the todo + + + + + The alarm list of the todo. + + + + + The timezone of the start_time + + + + + The timezone of the due_time + + + + + The name of the organizer of the event + + + + + The email address of the organizer of the todo + + + + + Whether or not the todo has an attendee list + + + + + The attendee list of the todo. + + + + + The extended property list of the todo. + + + + + The todo is an allday event or not + + + + + Describes properies of a Timezone record. + + + + + Identifier of this timezone view + + + + + DB record ID of the timezone + + + + + UTC offset which is in use when the onset of this time zone observance begins. Valid values are -720(-12:00) to 840(+14:00) + + + + + Name of the Standard Time + + + + + Starting month of the Standard Time. Month is 0-based. eg, 0 for January + + + + + Starting day-of-week-in-month of the Standard Time. Day is 1-based + + + + + Starting day-of-week of the Standard Time. Valid values are 1(SUNDAY) to 7(SATURDAY) + + + + + Starting hour of the Standard Time. Valid values are 0 to 23 + + + + + The number of minutes added during the Standard Time + + + + + Name of Daylight + + + + + Starting month of Daylight. Month is 0-based. eg, 0 for January + + + + + Starting day-of-week-in-month of Daylight. Day is 1-based + + + + + Starting day-of-week of Daylight. Valid values are 1(SUNDAY) to 7(SATURDAY) + + + + + Starting hour of Daylight. Valid values are 0 to 23 + + + + + The number of minutes added during Daylight Time + + + + + DB record ID of a related calendar book + + + + + Describes properies of a Attendee record. + + + + + Identifier of this calendar attendee view + + + + + The number of the attendee + + + + + The type of attendee(refer to the CalendarTypes.Cutype). + + + + + CtIndex + + + + + Unique identifier + + + + + Group + + + + + The email address of the attendee + + + + + Attendee role(refer to the CalendarTypes.AttendeeRole). + + + + + Attendee status(refer to the CalendarTypes.AttendeeStatus). + + + + + RSVP invitation reply (one of true, false) + + + + + Delegatee (DELEGATED-TO) + + + + + Delegator (DELEGATED-FROM) + + + + + Attendee name + + + + + Group that the attendee belongs to + + + + + Event/TODO that the attendee belongs to + + + + + Describes properies of a Alarm record. + + + + + Identifier of this calendar alarm view + + + + + The number of unit before start time. This MUST be used with one of TickUnit. + + + + + Reminder tick time unit(refer to the CalendarTypes.TickUnit). + + + + + Alarm description + + + + + Event that the alarm belongs to + + + + + Alarm summary + + + + + Action of alarm(refer to the CalendarTypes.Action). + + + + + Alarm tone path + + + + + The alarm time + + + + + Describes properies of a InstanceUtimeBook record. + + Read only view + + + + Identifier of this instance utime book + + + + + Event id + + + + + Start time + + + + + End time + + + + + Summary + + + + + Location + + + + + Book id + + + + + Description + + + + + BusyStatus + + + + + EventStatus + + + + + Priority + + + + + Sensitivity + + + + + HasRrule + + + + + Latitude + + + + + Longitude + + + + + HasAlarm + + + + + OriginalEventId + + + + + LastModifiedtime + + + + + SyncData1 + + + + + Describes properies of a InstanceLocaltimeBook record. + + Read only view + + + + Uri + + + + + EventId + + + + + Start + + + + + End + + + + + Summary + + + + + Location + + + + + BookId + + + + + Description + + + + + BusyStatus + + + + + EventStatus + + + + + Priority + + + + + Sensitivity + + + + + HasRrule + + + + + Latitude + + + + + Longitude + + + + + HasAlarm + + + + + OriginalEventId + + + + + LastModifiedTime + + + + + SyncData1 + + + + + IsAllday + + + + + Describes properies of a InstanceUtimeBookExtended record. + + Read only view + + + + Uri + + + + + EventId + + + + + Start + + + + + End + + + + + Summary + + + + + Location + + + + + BookId + + + + + Description + + + + + BusyStatus + + + + + EventStatus + + + + + Priority + + + + + Sensitivity + + + + + HasRrule + + + + + Latitude + + + + + Longitude + + + + + HasAlarm + + + + + OriginalEventId + + + + + LastModifiedTime + + + + + SyncData1 + + + + + OrganizerName + + + + + Categories + + + + + HasAttendee + + + + + SyncData2 + + + + + SyncData3 + + + + + SyncData4 + + + + + Describes properies of a InstanceLocaltimeBookExtended record. + + Read only view + + + + Uri + + + + + EventId + + + + + Start + + + + + End + + + + + Summary + + + + + Location + + + + + BookId + + + + + Description + + + + + BusyStatus + + + + + EventStatus + + + + + Priority + + + + + Sensitivity + + + + + HasRrule + + + + + Latitude + + + + + Longitude + + + + + HasAlarm + + + + + OriginalEventId + + + + + LastModifiedTime + + + + + SyncData1 + + + + + OrganizerName + + + + + Categories + + + + + HasAttendee + + + + + SyncData2 + + + + + SyncData3 + + + + + SyncData4 + + + + + IsAllday + + + + + Describes properies of a UpdatedInfo record. + + Read only view + + + + Identifier of this updatedInfo view + + + + + Modified event(or todo) record ID + + + + + Calendar book ID of the modified event(or todo) record + + + + + Enumeration value of the modified status. + + + + + Version after change + + + + + Describes properies of a Extended record. + + + + + Identifier of this extended_property view + + + + + DB record ID of the extended_property + + + + + Related record ID + + + + + Enumeration value of the record type. + + + + + The key of the property + + + + + The value of the property + + + + + Event arguments passed when alarm is alerted. + + + + + The paramter which data is combinded(Value string like id=value&time=value&tick=value&unit=value&type=value) + + + + diff --git a/Artifacts/bin/Tizen.Pims.Contacts.dll b/Artifacts/bin/Tizen.Pims.Contacts.dll index 41880e0..0f28a58 100644 Binary files a/Artifacts/bin/Tizen.Pims.Contacts.dll and b/Artifacts/bin/Tizen.Pims.Contacts.dll differ diff --git a/Artifacts/bin/Tizen.Pims.Contacts.pdb b/Artifacts/bin/Tizen.Pims.Contacts.pdb index 96fef2c..9fe12af 100644 Binary files a/Artifacts/bin/Tizen.Pims.Contacts.pdb and b/Artifacts/bin/Tizen.Pims.Contacts.pdb differ diff --git a/Artifacts/bin/Tizen.Pims.Contacts.xml b/Artifacts/bin/Tizen.Pims.Contacts.xml index 077a842..dc8dd99 100644 --- a/Artifacts/bin/Tizen.Pims.Contacts.xml +++ b/Artifacts/bin/Tizen.Pims.Contacts.xml @@ -1,4519 +1,4519 @@ - - - - Tizen.Pims.Contacts - - - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - - - Contacts Interop Class - - - - - Contacts Interop Class - - - - - Delegate for detecting the contacts database changes - - The contacts view URI - - The delegate must be registered using AddDBChangedDelegate. - It's invoked when the designated view changes. - - - - - ContactsDatabase provides methods to manage contacts information from/to the database. - - - This class allows user to access/create/update db operations for contacts information. - - - - - Enumeration for contacts database status. - - - - - Normal - - - - - Changing collation. - - - - - Enumeration for Contacts search range. - - - - - None - - - - - Search record from name - - - - - Search record from number - - - - - Search record from data - - - - - Search record from email. Now, support only PersonEmail view - - - - - Occurs when contacts database status is changed. - - - - - The current contacts database version. - - The current contacts database version. - - - - The last successful changed contacts database version on the current connection. - - The last successful changed contacts database version on the current connection. - - - - The contacts database status. - - The contacts database status. - - - - Inserts a record into the contacts database. - - The record to insert - The ID of inserted record - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Inserts multiple records into the contacts database as a batch operation. - - The record list - The inserted record ID array - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Gets a record from the contacts database. - - The view URI of a record - The record ID - The record associated with the record ID - http://tizen.org/privilege/contact.read - http://tizen.org/privilege/callhistory.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Updates a record in the contacts database. - - The record to update - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Updates multiple records in the contacts database as a batch operation. - - The record list - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Deletes a record from the contacts database with related child records. - - The view URI of a record - The record ID to delete - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Deletes multiple records with related child records from the contacts database as a batch operation. - - The view URI of the records to delete - The record IDs to delete - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Replaces a record in the contacts database. - - The record to replace - the record ID to be replaced - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Replaces multiple records in the contacts database as a batch operation. - - The record list to replace - The record IDs to be replaced - http://tizen.org/privilege/contact.write - http://tizen.org/privilege/callhistory.write - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Retrieves all records as a list. - - The view URI to get records - The index from which results - The number to limit results(value 0 is used for all records) - - The record list - - http://tizen.org/privilege/contact.read - http://tizen.org/privilege/callhistory.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Retrieves records using a query. - - The query to filter the results - The index from which to get results - The number to limit results(value 0 is used for get all records) - - The record list - - http://tizen.org/privilege/contact.read - http://tizen.org/privilege/callhistory.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Retrieves records changes since the given database version. - - The view URI to get records - The address book ID to filter - The contacts database version - The current contacts database version - - The record list - - http://tizen.org/privilege/contact.read - Thrown when method failed due to invalid operation - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - Thrown when application does not have proper privileges - - - - Finds records based on a given keyword. - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - - The view URI to find records - The keyword - The index from which to get results - The number to limit results(value 0 is used for get all records) - The record list - http://tizen.org/privilege/contact.read - - - - Finds records based on given query and keyword. - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - - The query to filter - The keyword - The index from which to get results - The number to limit results(value 0 used for get all records) - The record list - - - - Finds records based on a keyword and range. - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail - - The view URI - The keyword - The index from which to get results - The number to limit results(value 0 is used for get all records) - The search range, it should be a element of SearchRange or bitwise OR operation of them - The record list - - - - Finds records based on a given keyword for snippet - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit). - - The view URI to find records - The keyword - The index from which to get results - The number to limit results(value 0 used for get all records) - The text which is inserted into the fragment before the keyword(If NULL, default is "[") - The text which is inserted into the fragment after the keyword(If NULL, default is "]") - The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - The record list - - - - Finds records based on given query and keyword for snippet. - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. - Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(ContactsQuery query, string keyword, int offset, int limit). - - The query to filter - The keyword - The index from which to get results - The number to limit results(value 0 used for get all records) - The text which is inserted into the fragment before the keyword(If NULL, default is "[") - The text which is inserted into the fragment after the keyword(If NULL, default is "]") - The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - The record list - - - - Finds records based on a keyword and range for snippet. - - - This API works only for the Views below. - Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail - Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit, int range). - - The view URI - The keyword - The index from which to get results - The number to limit results(value 0 is used for get all records) - The search range, it should be a element of SearchRange or bitwise OR operation of them - The text which is inserted into the fragment before the keyword(If NULL, default is "[") - The text which is inserted into the fragment after the keyword(If NULL, default is "]") - The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") - The record list - - - - Gets the number of records in a specific view - - The view URI - The count of records - - - - Gets the number of records matching a query. - - The query used for filtering the results - The count of records - - - - Registers a callback function to be invoked when a record changes. - - The view URI of records whose changes are monitored - The callback function to register - - - - Deregisters a callback function. - - The view URI of records whose changes are monitored - The callback function to register - - - - A filter includes the conditions for the search - - - - - Creates a filter with a condition for a string type property. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for an integer type property. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for a long type property. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for a double type property. - - The view URI of a filter - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Creates a filter with a condition for a boolean type property. - - The view URI of a filter - The property ID to add a condition - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destructor - - - - - Enumeration for the filter match type of a string. - - - - - Full string, case-sensitive - - - - - Full string, case-insensitive - - - - - Sub string, case-insensitive - - - - - Start with, case-insensitive - - - - - End with, case-insensitive - - - - - IS NOT NUL - - - - - Enumeration for the filter match type of an integer. - - - - - = - - - - - > - - - - - >= - - - - - < - - - - - <= - - - - - <>, this flag can yield poor performance - - - - - IS NULL - - - - - Enumeration for a filter operator. - - - - - AND - - - - - OR - - - - - Releases all resources used by the ContactsFilter. - - Disposing by User - - - - Releases all resources used by the ContactsFilter. - It should be called after finished using of the object. - - - - - Adds a condition for a string type property. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for a integer type property. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for a long type property. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for a double type property. - - The operator type - The property ID to add a condition - The match flag - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a condition for a boolean type property. - - The operator type - The property ID to add a condition - The match value - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Adds a child filter to a parent filter. - - The operator type - The child filter - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - A list of records with the same type - - - - - Creates a contacts record list. - - Thrown when an invoked method is not supported - Thrown when failed due to out of memory - - - - Destructor - - - - - The count of contact entity. - - The count of contact entity. - - - - Releases all resources used by the ContactsList. - - Disposing by User - - - - Releases all resources used by the ContactsList. - It should be called after finished using of the object. - - - - - Adds a record to the contacts list. - - The record to add - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Removes a record from the contacts list. - - The record to remove - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - - - - Retrieves a record from the contacts list. - - - contacts record - - - - - Moves a contacts list to the previous position. - - - When the cursor is already at the first position, it returns false. - - - - - Moves a contacts list to the next position. - - - When the cursor is already at the last position, it returns false. - - - - - Moves a contacts list to the first position. - - - - - Moves a contacts list to the last position. - - - - - Enumeration for name display order. - - - - - First name comes at the first - - - - - First name comes at the last - - - - - Enumeration for name sorting order. - - - - - Contacts are first sorted based on the first name - - - - - Contacts are first sorted based on the last name - - - - - A class for managing contact information. It allows applications to access contacts database. - - - - - Creates a ContactsManager. - - Thrown when method failed due to invalid operation - - - - Destructor - - - - - Releases all resources used by the ContactsManager. - - Disposing by User - - - - Releases all resources used by the ContactsManager. - It should be called after finished using of the object. - - - - - (event) NameDisplayOrderChanged is raised when changing setting value of contacts name display order - - http://tizen.org/privilege/contact.read - - - - (event) NameSortingOrderChanged is raised when changing setting value of contacts name sorting order - - http://tizen.org/privilege/contact.read - - - - A ContactsDatabase - - A ContactsDatabase - - - - A setting value of contacts name display order - - A setting value of contacts name display order - - DisplayName of contacts returned from database are determined by this property - - http://tizen.org/privilege/contact.read - http://tizen.org/privilege/contact.write - - - - A setting value of contacts name sorting order - - A setting value of contacts name sorting order - - Contacts returned from database are first sorted based on the first name or last name by this property - - http://tizen.org/privilege/contact.read - http://tizen.org/privilege/contact.write - - - - A query is used to retrieve data which satisfies given criteria - - - A query is used to retrieve person, group, speed dial, and log data which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. - A query needs a filter which can set the conditions for the search. - - - - - Creates a query. - - The view URI of a query - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destructor - - - - - Releases all resources used by the ContactsQuery. - - Disposing by User - - - - Releases all resources used by the ContactsQuery. - It should be called after finished using of the object. - - - - - Adds property IDs for projection. - - The property ID array - Thrown when one of the arguments provided to a method is not valid - - - - Sets the "distinct" option for projection. - - If true it is set, otherwise if false it is unset - Thrown when one of the arguments provided to a method is not valid - - - - Sets the filter for a query. - - The filter - Thrown when one of the arguments provided to a method is not valid - - - - Sets the sort mode for a query. - - The property ID to sort - If true it sorts in the ascending order, otherwise if false it sorts in the descending order - Thrown when one of the arguments provided to a method is not valid - - - - A record represents an actual record in the database - - - A record represents an actual record in the database, but you can also consider it a piece of information, such as an address, a phone number, or a group of contacts. - A record can be a complex set of data, containing other data. For example, a contact record contains the address property, which is a reference to an address record. - An address record belongs to a contact record, and its ContactId property is set to the identifier of the corresponding contact. In this case, the address is the child record of the contact and the contact is the parent record. - - - - - Creates a record. - - The view URI - Thrown when an invoked method is not supported - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Destructor - - - - - The URI of the record - - The URI of the record - - - - Releases all resources used by the ContactsRecord. - - Disposing by User - - - - Releases all resources used by the ContactsRecord. - It should be called after finished using of the object. - - - - - Makes a clone of a record. - - A cloned record - Thrown when failed due to out of memory - - - - Gets a value of the property from a record. - - The property ID - - The value of the property corresponding to property id. - - Thrown when one of the arguments provided to a method is not valid - - - - Sets a value of the property to a record. - - The property ID - The value to set - Thrown when one of the arguments provided to a method is not valid - - - - Adds a child record to the parent record. - - The property ID - The child record to add to parent record - Thrown when one of the arguments provided to a method is not valid - - - - Removes a child record from the parent record. - - The property ID - The child record to remove from parent record - Thrown when one of the arguments provided to a method is not valid - - - - Gets the number of child records of a parent record. - - The property ID - The number of child records corresponding to property ID - Thrown when one of the arguments provided to a method is not valid - - - - Gets a child record from the parent record - - The property ID - The index of child record - The record - Thrown when one of the arguments provided to a method is not valid - - - - Clones a child record list corresponding to property ID - - The property ID - - The record list - - Thrown when one of the arguments provided to a method is not valid - - - - Delegate for getting a record parsed from a vCard file - - The contacts record - - - - - A class for parsing and making vCards. - - - It's based on the vCard v3.0 specification - - - - - Retrieves the vCard stream from a contacts record. - - The contacts record - - The vCard stream. - - http://tizen.org/privilege/contact.read - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Retrieves all contacts with a contacts list from a vCard stream - - The vCard stream - - The contacts list - - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Retrieves all contacts with a record from a vCard file. - - The file path of vCard stream file - The callback function to invoke - Thrown when method failed due to invalid operation - Thrown when one of the arguments provided to a method is not valid - Thrown when failed due to out of memory - - - - Enumeration for contact change state. - - - - - Inserted - - - - - Updated - - - - - Deleted - - - - - Describes properties of a Address book record. - - - - - Identifier of this contacts address book view - - - - - integer, read only, DB record ID of the address book - - - - - integer, read/write once, Account ID that the address book belongs to - - - - - string, read/write, It cannot be NULL. Duplicate names are not allowed. - - - - - integer, read/write, AddressBook mode, refer to the ModeValue - - - - - Enumeration for Address book mode. - - - - - All module can read and write contacts of this address_book - - - - - All module can only read contacts of this address_book - - - - - Describes properties of a Group record. - - - - - Identifier of this contacts group view - - - - - DB record ID of the group - - - - - AddressBook ID that the group belongs to - - - - - Group name - - - - - Ringtone path of the group - - - - - Image path of the group - - - - - Vibration path of the group - - - - - Extra data for default group name - - - - - The group is read only or not - - - - - Message alert path of the group - - - - - Describes properties of a Person record. - - - - - Identifier of this contacts person view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to - - - - - Ringtone path of the person - - - - - Image thumbnail path of the person - - - - - Vibration path of the person - - - - - Message alert path of the person - - - - - Status of social account - - - - - The person is favorite or not - - - - - The priority of favorite contacts. it can be used as sorting key - - - - - Link count of contact records (projection) - - - - - AddressBook IDs that the person belongs to (projection) - - - - - The person has phone number or not - - - - - The person has email or not - - - - - keyword matched data type - - - - - keyword matched data string - - - - - Describes properties of a Contact record. - - - - - Identifier of this contact view - - - - - DB record ID of the contact - - - - - Display name of the contact - - - - - The source type of display name, refer to the DisplayNameSourceType - - - - - AddressBook ID that the contact belongs to - - - - - Ringtone path of the contact - - - - - Image thumbnail path of the contact - - - - - The contact is favorite or not - - - - - The contact has phone number or not - - - - - The contact has email or not - - - - - Person ID that the contact belongs to. If set when inserting, a contact will be linked to person - - - - - Unique identifier - - - - - Vibration path of the contact - - - - - Message alert path of the contact - - - - - Last changed contact time - - - - - The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored - - - - - Name child record (single) - - - - - Company child record (multiple) - - - - - Note child record (multiple) - - - - - Number child record (multiple) - - - - - Email child record (multiple) - - - - - Event child record (multiple) - - - - - Messenger child record (multiple) - - - - - Address child record (multiple) - - - - - URL child record (multiple) - - - - - Nickname child record (multiple) - - - - - Profile child record (multiple) - - - - - Relationship child record (multiple) - - - - - Image child record (multiple) - - - - - GroupRelation child record (multiple) - - - - - Extension child record (multiple) - - - - - Sip child record (multiple) - - - - - Enumeration for link mode when inserting contact. - - - - - Auto link immediately - - - - - Do not auto link when the contact is inserted - - - - - Enumeration for Contact display name source type. - - - - - Invalid source of display name - - - - - Produced display name from email record - - - - - Produced display name from number record - - - - - Produced display name from nickname record - - - - - Produced display name from company record - - - - - Produced display name from name record - - - - - Enumeration for contacts data type. - - - - - None - - - - - Name - - - - - Address - - - - - Messenger - - - - - URL - - - - - Event - - - - - Company - - - - - Nickname - - - - - Number - - - - - Email - - - - - Profile - - - - - Relationship - - - - - Note - - - - - Image - - - - - SIP - - - - - Extension - - - - - Describes properties of a Simple contact record. - - - - - Identifier of this simple contact view - - - - - DB record ID of the contact - - - - - Display name of the contact - - - - - The source type of display name, refer to the Contact.DisplayNameSourceType - - - - - AddressBook that the contact belongs to - - - - - Ringtone path of the contact - - - - - Image thumbnail path of the contact - - - - - The contact is favorite or not - - - - - The contact has phone number or not - - - - - The contact has email or not - - - - - Person ID that the contact belongs to - - - - - Unique identifier - - - - - Vibration path of the contact - - - - - Message alert path of the contact - - - - - Last changed contact time - - - - - Describes properties of a My profile record. - - - - - Identifier of this my profile view - - - - - DB record ID of the my profile - - - - - Display name of the profile - - - - - AddressBook ID that the profile belongs to - - - - - Image thumbnail path of the profile - - - - - Unique identifier - - - - - Last changed profile time - - - - - Name child record (single) - - - - - Company child record (multiple) - - - - - Note child record (multiple) - - - - - Number child record (multiple) - - - - - Email child record (multiple) - - - - - Event child record (multiple) - - - - - Messenger child record (multiple) - - - - - Address child record (multiple) - - - - - URL child record (multiple) - - - - - Nickname child record (multiple) - - - - - Profile child record (multiple) - - - - - Relationship child record (multiple) - - - - - Image child record (multiple) - - - - - Extension child record (multiple) - - - - - Sip child record (multiple) - - - - - Describes properties of a Name record. - - - - - Identifier of this contacts name view - - - - - DB record ID of the name - - - - - Contacts ID that the name record belongs to - - - - - First name - - - - - Last name - - - - - Middle name - - - - - Suffix - - - - - Prefix - - - - - Pronounce the first name - - - - - Pronounce the middle name - - - - - Pronounce the last name - - - - - Describes properties of a Number record. - - - - - Identifier of this contacts number view - - - - - DB record ID of the number - - - - - Contact ID that the number belongs to - - - - - Number type, refer to the Types - - - - - Custom number type label, when the number type is Types.Custom - - - - - The number is default number or not - - - - - Number - - - - - You can only use this property for search filter. - - - - - You can only use this property for search filter. - - - - - You can only use this property for search filter. - - - - - Enumeration for number type. - - - - - Other number type - - - - - Custom number type - - - - - A telephone number associated with a residence - - - - - A telephone number associated with a place of work - - - - - A voice telephone number - - - - - A facsimile telephone number - - - - - The telephone number has voice messaging support - - - - - A cellular telephone number - - - - - A paging device telephone number - - - - - A bulletin board system telephone number - - - - - A MODEM connected telephone number - - - - - A car-phone telephone number - - - - - An ISDN service telephone number - - - - - A video conferencing telephone number - - - - - A personal communication services telephone number - - - - - A company main number - - - - - A radio phone number - - - - - An additional type for main - - - - - An additional type for assistant - - - - - Describes properties of a Email record. - - - - - Identifier of this contacts email view - - - - - DB record ID of the email - - - - - Contact ID that the email belongs to - - - - - Email type, refer to the Types - - - - - Custom mail type label, when the email type is Types.Custom - - - - - The email is default email or not - - - - - Email address - - - - - Enumeration for Contact email type. - - - - - Other email type - - - - - Custom email type - - - - - An email address associated with a residence - - - - - An email address associated with a place of work - - - - - A mobile email address - - - - - Describes properties of a Address record. - - - - - Identifier of this contacts address view - - - - - DB record ID of the address - - - - - Contact ID that the address belongs to - - - - - Address type, refer to the Types - - - - - Address type label, when the address type is Types.Custom - - - - - Post office box - - - - - Postal code - - - - - Region - - - - - Locality - - - - - Street - - - - - Country - - - - - Extended address - - - - - The address is default or not - - - - - Enumeration for Contact address type. - - - - - Other address type - - - - - Custom address type - - - - - A delivery address for a residence - - - - - A delivery address for a place of work - - - - - A domestic delivery address - - - - - An international delivery address - - - - - A postal delivery address - - - - - A parcel delivery address - - - - - Describes properties of a Note record. - - - - - Identifier of this contacts note view - - - - - DB record ID of the note - - - - - Contact ID that the note belongs to - - - - - Note contents - - - - - Describes properties of a URL record. - - - - - Identifier of this contacts URL view - - - - - DB record ID of the URL - - - - - Contact ID that the URL belongs to - - - - - URL type, refer to the TypeValue - - - - - Custom URL type label, when the URL type is TypeValue.Custom - - - - - URL - - - - - Enumeration for Contact URL type. - - - - - Other URL type - - - - - Custom URL type - - - - - Home URL type - - - - - Work URL type - - - - - Describes properties of a Event record. - - - - - Identifier of this contacts event view - - - - - DB record ID of the event - - - - - Contact ID that the event belongs to - - - - - Event type, refer to the TypeValue - - - - - Custom event type label, when the event type is TypeValue.Custom - - - - - Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date - - - - - Calendar type, refer to the CalendarType - - - - - Enumeration for Contact event type. - - - - - Other event type - - - - - Custom event type - - - - - Birthday event type - - - - - Anniversary event type - - - - - Enumeration for Contact event calendar type. - - - - - Gregorian calendar - - - - - Chinese calendar - - - - - Describes properties of a Relationship record. - - - - - Identifier of this relationship view - - - - - DB record ID of the relationship - - - - - Contact ID that the relationship belongs to - - - - - Relationship type, refer to the TypeValue - - - - - Custom relationship type label, when the relationship type is TypeValue.Custom - - - - - Selected contact name that the relationship belongs to - - - - - Enumeration for Contact relationship type. - - - - - Other relationship type - - - - - Assistant type - - - - - Brother type - - - - - Child type - - - - - Domestic Partner type - - - - - Father type - - - - - Friend type - - - - - Manager type - - - - - Mother type - - - - - Parent type - - - - - Partner type - - - - - Referred by type - - - - - Relative type - - - - - Sister type - - - - - Spouse type - - - - - Custom type - - - - - Describes properties of a Image record. - - - - - Identifier of this contacts image view - - - - - DB record ID of the image - - - - - Contact ID that the image belongs to - - - - - Image type, refer to the TypeValue - - - - - Custom image type label, when the image type is TypeValue.Custom - - - - - Image thumbnail path - - - - - The Image is default or not - - - - - Enumeration for Contact image type. - - - - - Other type - - - - - Custom type - - - - - Describes properties of a Company record. - - - - - Identifier of this contacts company view - - - - - DB record ID of the company - - - - - Contact ID that the company belongs to - - - - - Company type, refer to the TypeValue - - - - - Custom company type label, when the company type is TypeValue.Custom - - - - - Company name - - - - - Department - - - - - Job title - - - - - Assistant name - - - - - Role - - - - - Company logo image file path - - - - - Company location - - - - - Description - - - - - Pronounce the company name - - - - - Enumeration for Contact company type. - - - - - Other type - - - - - Custom type - - - - - Work type - - - - - Describes properties of a Nickname record. - - - - - Identifier of this contacts nickname view - - - - - DB record ID of the nickname - - - - - Contact ID that the nickname belongs to - - - - - Nickname - - - - - Describes properties of a Messenger record. - - - - - Identifier of this contacts messenger view - - - - - DB record ID of the messenger - - - - - Contact ID that the messenger belongs to - - - - - Messenger type, refer to the TypeValue - - - - - Custom messenger type label, when the messenger type is TypeValue.Custom - - - - - Messenger ID (email address or email ID...) - - - - - Enumeration for Contact messenger type. - - - - - Other messenger type - - - - - Custom messenger type - - - - - Google messenger type - - - - - Windows live messenger type - - - - - Yahoo messenger type - - - - - Facebook messenger type - - - - - ICQ type - - - - - AOL instance messenger type - - - - - QQ type - - - - - Jabber type - - - - - Skype type - - - - - IRC type - - - - - Describes properties of a Profile record. - - - - - Identifier of this contacts profile view - - - - - DB record ID of profile - - - - - Contacts ID that the profile belongs to - - - - - Unique identifier - - - - - Profile contents - - - - - Priority to display the profile - - - - - Data for app_control_set_operation - - - - - Data for app_control_set_mime - - - - - Data for app_control_set_app_id - - - - - Data for app_control_set_uri - - - - - Data for app_control_set_category - - - - - It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value - - - - - Describes properties of a Sip record. - - - - - Identifier of this contacts sip view - - - - - DB record ID of the sip - - - - - Contact ID that the sip belongs to - - - - - SIP address - - - - - sip type, refer to the TypeValue - - - - - Custom sip type label, when the sip type is TypeValue.Custom - - - - - Enumeration for Contact SIP type. - - - - - Other SIP type - - - - - Custom SIP type - - - - - Home SIP type - - - - - Work SIP type - - - - - Describes properties of a Extension record. - - - - - Identifier of this contacts extension view - - - - - DB record ID of the contact extension - - - - - Contact ID that the contact extension belongs to - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - The extra child record format for non-provided from contacts-service - - - - - Describes properties of a Group relation record. - - - - - Identifier of this relationship view - - - - - DB record ID of the group relation (can not be used as filter) - - - - - DB record ID of the group - - - - - DB record ID of the contact - - - - - Group name - - - - - Describes properties of a Speed dial record. - - - - - Identifier of this contact speed dial view - - - - - Stored speed dial number - - - - - Number ID that the speed dial belongs to - - - - - Contact number of specified speed dial - - - - - Contact number label of specified speed dial, when the number type is Number.Types.Custom - - - - - Contact number type, refer to the Number.Types - - - - - Person ID that the speed dial belongs to - - - - - Display name that the speed dial belongs to - - - - - Image thumbnail path that the speed dial belongs to - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly - - - - - Describes properties of a Phone log record. - - - - - Identifier of this phone log view - - - - - DB record ID of phone log - - - - - Person ID that the phone log belongs to - - - - - Number or Email that the phone log displays - - - - - Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) - - - - - Log type, refer to the Type - - - - - You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) - - - - - You can set the related string data (e.g. short message, subject) - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - You can set the related SIM slot number. SimSlotNo 0 means first SIM card, SimSlotNo 1 means second SIM. - - - - - Enumeration for Phone log type. - - - - - None - - - - - Incoming call - - - - - Outgoing call - - - - - Incoming video call - - - - - Outgoing video call - - - - - Not confirmed missed call - - - - - Confirmed missed call - - - - - Not confirmed missed video call - - - - - Confirmed missed video call - - - - - Rejected call - - - - - Rejected video call - - - - - Blocked call - - - - - Blocked video call - - - - - Incoming MMS - - - - - Outgoing MMS - - - - - Incoming SMS - - - - - Outgoing SMS - - - - - Blocked SMS - - - - - Blocked MMS - - - - - Received email - - - - - Sent email - - - - - Describes properties of a Contact updated information record. - - Read only view - - - - Identifier of this contact updated info view - - - - - Updated contact ID - - - - - AddressBook ID that the updated contact belongs to - - - - - Contact change type, refer to the ContactsViews.ChangeType - - - - - Updated version - - - - - Contact image is changed or not - - - - - Describes properties of a My profile updated information record. - - Read only view - - - - Identifier of this my profile updated info view - - - - - Address book ID that the updated my profile belongs to - - - - - MyProfile change type, refer to the ContactsViews.ChangeType - - - - - Updated version - - - - - Describes properties of a Group updated information record. - - Read only view - - - - Identifier of this group updated info view - - - - - Updated group ID - - - - - Address book ID that the updated group belongs to - - - - - Group change type, refer to the ContactsViews.ChangeType - - - - - Updated version - - - - - Describes properties of a Group Member updated information record. - - Read only view - - - - Identifier of this group member updated info view - - - - - Updated group ID - - - - - Address book ID that the updated group belongs to - - - - - Updated version - - - - - Describes properties of a Relation updated information record. - - Read only view - - - - Identifier of this group relation updated info view - - - - - Group ID of group relation - - - - - Contact ID of the updated group relation - - - - - Address book ID of contact that the updated group relation - - - - - Group relation change type, refer to the ContactsViews.ChangeType - - - - - Updated version - - - - - Describes properties of a PersonContact record. - - Read only view - - - - Identifier of this person contact view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - Status of social account (projection) - - - - - The person is favorite or not - - - - - Link count of contact records (projection) - - - - - Contact ID that the person belongs to - - - - - AddressBook IDs that the person belongs to (projection) - - - - - The person has phone number or not - - - - - The person has email or not - - - - - AddressBook ID that the person belongs to - - - - - AddressBook mode, refer to the AddressBook.Mode - - - - - AddressBook name that the person belongs to - - - - - keyword matched data type, refer to the Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonNumber record. - - Read only view - - - - Identifier of this person number view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Number ID that the person belongs to - - - - - Number type, refer to the Number.Types (projection) - - - - - Custom number type label, when the number type is Number.Types.Custom (projection) - - - - - The number is default number or not - - - - - Number - - - - - If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - keyword matched data type, refer to they Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonEmail record. - - Read only view - - - - Identifier of this person email view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Email ID that the person belongs to - - - - - Email type, refer to the Email.Types (projection) - - - - - Custom mail type label, when the email type is Email.Types.Custom (projection) - - - - - The email is default email or not - - - - - Email address - - - - - keyword matched data type, refer to they Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonGroupRelation record. - - Read only view - - - - Identifier of this person group relation view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - Status of social account (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Link count of contact records (projection) - - - - - AddressBook IDs that the person belongs to (projection) - - - - - AddressBook ID that the person belongs to - - - - - AddressBook name that the person belongs to - - - - - AddressBook mode, refer to the AddressBook.Mode - - - - - Group ID that the person belongs to - - - - - Contact ID that the person belongs to (projection) - - - - - keyword matched data type, refer to they Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonGroupAssignedrecord. - - Read only view - - - - Identifier of this person group assigned view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - Status of social account (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Link count of contact records (projection) - - - - - AddressBook IDs that the linked person belongs to (projection) - - - - - AddressBook ID that the person belongs to - - - - - AddressBook mode, refer to the AddressBook.Mode - - - - - Group ID that the person belongs to - - - - - Contact ID that the person belongs to (projection) - - - - - keyword matched data type, refer to they Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonGroupNotAssigned record. - - Read only view - - - - Identifier of this person group not assigned view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - Status of social account (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Link count of contact records (projection) - - - - - AddressBook IDs that the linked person belongs to (projection) - - - - - AddressBook ID that the person belongs to - - - - - AddressBook mode, refer to the AddressBook.Mode - - - - - Contact ID that the person belongs to (projection) - - - - - keyword matched data type, refer to they Contact.DataType - - - - - keyword matched data string - - - - - Describes properties of a PersonPhoneLog record. - - Read only view - - - - Identifier of this phone log view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - Image thumbnail path of the person (projection) - - - - - DB record ID of phone log - - - - - Number or Email that the phone log displays - - - - - Number or Email type (projection) - - - - - Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) - - - - - Log type, refer to the PhoneLog.Types - - - - - You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection) - - - - - You can set the related string data (e.g. short message, subject) (projection) - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - It is related to the SIM slot number. SimSlotNo 0 means first SIM card, SimSlotNo 1 means second SIM. - - - - - Describes properties of a Person Usage record. - - Read only view - - - - Identifier of this person usage view - - - - - DB record ID of the person - - - - - Display name of the person - - - - - The first character of first string for grouping. This is normalized using ICU (projection) - - - - - Display contact ID that the person belongs to (projection) - - - - - Ringtone path of the person (projection) - - - - - Image thumbnail path of the person (projection) - - - - - Vibration path of the person (projection) - - - - - Message alert path of the person (projection) - - - - - The person is favorite or not - - - - - The person has phone number or not - - - - - The person has email or not - - - - - Usage type, refer to the Type - - - - - Usage number of person - - - - - Enumeration for Person usage type. - - - - - None - - - - - Outgoing call - - - - - Outgoing message - - - - - Outgoing email - - - - - Incoming call - - - - - Incoming message - - - - - Incoming email - - - - - Missed call - - - - - Rejected call - - - - - Blocked call - - - - - Blocked message - - - - - Describes properties of a ContactNumber record. - - Read only view - - - - Identifier of this contacts number view - - - - - Contact ID that the number belongs to - - - - - Display name of contact that the number belongs to - - - - - The source type of display name, refer to the Contact.DisplayNameSourceType (projection) - - - - - AddressBook ID that the number belongs to - - - - - Person ID that the number belongs to - - - - - Ringtone path that the number belongs to (projection) - - - - - Image thumbnail path that the number belongs to (projection) - - - - - DB record ID of the number - - - - - Number type, refer to the Number.Types (projection) - - - - - Custom number type label, when the number type is Number.Types.Custom (projection) - - - - - The number is default number or not - - - - - Number - - - - - If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly - - - - - You can only use this property for search filter - - - - - You can only use this property for search filter - - - - - Describes properties of a ContactEmail record. - - Read only view - - - - Identifier of this contacts email view - - - - - Contact ID that the number belongs to - - - - - Display name of contact that the number belongs to - - - - - The source type of display name, refer to the Contact.DisplayNameSourceType (projection) - - - - - AddressBook ID that the number belongs to - - - - - Person ID that the number belongs to - - - - - Ringtone path that the number belongs to (projection) - - - - - Image thumbnail path that the number belongs to (projection) - - - - - DB record ID of the email - - - - - Email type, refer to the Email.Types (projection) - - - - - Custom mail type label, when the email type is Email.Types.Custom (projection) - - - - - Email is default email or not - - - - - Email address - - - - - Describes properties of a ContactGroupRelation record. - - Read only view - - - - Identifier of this contact group relation view - - - - - Contact ID that the number belongs to - - - - - Display name of contact that the number belongs to - - - - - The source type of display name, refer to the Contact.DisplayNameSourceType (projection) - - - - - AddressBook ID that the number belongs to - - - - - Person ID that the number belongs to - - - - - Ringtone path that the number belongs to (projection) - - - - - Image thumbnail path that the number belongs to (projection) - - - - - DB record ID of the group relation - - - - - Group name (projection) - - - - - Describes properties of a Phone Log Statistics record. - - Read only view - - - - Identifier of this log statistics view - - - - - Log count (projection) - - - - - Log type, see the contacts_phone_log_type_e - - - - - It is related to the SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() - - - - - Event arguments passed when contacts database status is changed - - - - - The contacts database status. - - - - - Event arguments passed when setting value of contacts name display order is changed - - - - - A setting value of contacts name display order - - - - - Event arguments passed when setting value of contacts name sorting order is changed - - - - - A setting value of contacts name sorting order - - - - + + + + Tizen.Pims.Contacts + + + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + + + Contacts Interop Class + + + + + Contacts Interop Class + + + + + Delegate for detecting the contacts database changes + + The contacts view URI + + The delegate must be registered using AddDBChangedDelegate. + It's invoked when the designated view changes. + + + + + ContactsDatabase provides methods to manage contacts information from/to the database. + + + This class allows user to access/create/update db operations for contacts information. + + + + + Enumeration for contacts database status. + + + + + Normal + + + + + Changing collation. + + + + + Enumeration for Contacts search range. + + + + + None + + + + + Search record from name + + + + + Search record from number + + + + + Search record from data + + + + + Search record from email. Now, support only PersonEmail view + + + + + Occurs when contacts database status is changed. + + + + + The current contacts database version. + + The current contacts database version. + + + + The last successful changed contacts database version on the current connection. + + The last successful changed contacts database version on the current connection. + + + + The contacts database status. + + The contacts database status. + + + + Inserts a record into the contacts database. + + The record to insert + The ID of inserted record + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Inserts multiple records into the contacts database as a batch operation. + + The record list + The inserted record ID array + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Gets a record from the contacts database. + + The view URI of a record + The record ID + The record associated with the record ID + http://tizen.org/privilege/contact.read + http://tizen.org/privilege/callhistory.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Updates a record in the contacts database. + + The record to update + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Updates multiple records in the contacts database as a batch operation. + + The record list + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Deletes a record from the contacts database with related child records. + + The view URI of a record + The record ID to delete + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Deletes multiple records with related child records from the contacts database as a batch operation. + + The view URI of the records to delete + The record IDs to delete + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Replaces a record in the contacts database. + + The record to replace + the record ID to be replaced + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Replaces multiple records in the contacts database as a batch operation. + + The record list to replace + The record IDs to be replaced + http://tizen.org/privilege/contact.write + http://tizen.org/privilege/callhistory.write + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Retrieves all records as a list. + + The view URI to get records + The index from which results + The number to limit results(value 0 is used for all records) + + The record list + + http://tizen.org/privilege/contact.read + http://tizen.org/privilege/callhistory.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Retrieves records using a query. + + The query to filter the results + The index from which to get results + The number to limit results(value 0 is used for get all records) + + The record list + + http://tizen.org/privilege/contact.read + http://tizen.org/privilege/callhistory.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Retrieves records changes since the given database version. + + The view URI to get records + The address book ID to filter + The contacts database version + The current contacts database version + + The record list + + http://tizen.org/privilege/contact.read + Thrown when method failed due to invalid operation + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + Thrown when application does not have proper privileges + + + + Finds records based on a given keyword. + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + + The view URI to find records + The keyword + The index from which to get results + The number to limit results(value 0 is used for get all records) + The record list + http://tizen.org/privilege/contact.read + + + + Finds records based on given query and keyword. + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + + The query to filter + The keyword + The index from which to get results + The number to limit results(value 0 used for get all records) + The record list + + + + Finds records based on a keyword and range. + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail + + The view URI + The keyword + The index from which to get results + The number to limit results(value 0 is used for get all records) + The search range, it should be a element of SearchRange or bitwise OR operation of them + The record list + + + + Finds records based on a given keyword for snippet + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit). + + The view URI to find records + The keyword + The index from which to get results + The number to limit results(value 0 used for get all records) + The text which is inserted into the fragment before the keyword(If NULL, default is "[") + The text which is inserted into the fragment after the keyword(If NULL, default is "]") + The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + The record list + + + + Finds records based on given query and keyword for snippet. + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned and PersonGroupNotAssigned. + Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(ContactsQuery query, string keyword, int offset, int limit). + + The query to filter + The keyword + The index from which to get results + The number to limit results(value 0 used for get all records) + The text which is inserted into the fragment before the keyword(If NULL, default is "[") + The text which is inserted into the fragment after the keyword(If NULL, default is "]") + The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + The record list + + + + Finds records based on a keyword and range for snippet. + + + This API works only for the Views below. + Person, PersonContact, PersonGroupRelation, PersonGroupAssigned, PersonGroupNotAssigned, PersonNumber and PersonEmail + Because start match and end match are needed to be composed with keyword, this API performance is lower than Search(string viewUri, string keyword, int offset, int limit, int range). + + The view URI + The keyword + The index from which to get results + The number to limit results(value 0 is used for get all records) + The search range, it should be a element of SearchRange or bitwise OR operation of them + The text which is inserted into the fragment before the keyword(If NULL, default is "[") + The text which is inserted into the fragment after the keyword(If NULL, default is "]") + The one side extra number of tokens near keyword(If negative value, full sentence is printed. e.g. if token number is 3 with 'abc' keyword, "my name is [abc]de and my home") + The record list + + + + Gets the number of records in a specific view + + The view URI + The count of records + + + + Gets the number of records matching a query. + + The query used for filtering the results + The count of records + + + + Registers a callback function to be invoked when a record changes. + + The view URI of records whose changes are monitored + The callback function to register + + + + Deregisters a callback function. + + The view URI of records whose changes are monitored + The callback function to register + + + + A filter includes the conditions for the search + + + + + Creates a filter with a condition for a string type property. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for an integer type property. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for a long type property. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for a double type property. + + The view URI of a filter + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Creates a filter with a condition for a boolean type property. + + The view URI of a filter + The property ID to add a condition + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destructor + + + + + Enumeration for the filter match type of a string. + + + + + Full string, case-sensitive + + + + + Full string, case-insensitive + + + + + Sub string, case-insensitive + + + + + Start with, case-insensitive + + + + + End with, case-insensitive + + + + + IS NOT NUL + + + + + Enumeration for the filter match type of an integer. + + + + + = + + + + + > + + + + + >= + + + + + < + + + + + <= + + + + + <>, this flag can yield poor performance + + + + + IS NULL + + + + + Enumeration for a filter operator. + + + + + AND + + + + + OR + + + + + Releases all resources used by the ContactsFilter. + + Disposing by User + + + + Releases all resources used by the ContactsFilter. + It should be called after finished using of the object. + + + + + Adds a condition for a string type property. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for a integer type property. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for a long type property. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for a double type property. + + The operator type + The property ID to add a condition + The match flag + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a condition for a boolean type property. + + The operator type + The property ID to add a condition + The match value + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Adds a child filter to a parent filter. + + The operator type + The child filter + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + A list of records with the same type + + + + + Creates a contacts record list. + + Thrown when an invoked method is not supported + Thrown when failed due to out of memory + + + + Destructor + + + + + The count of contact entity. + + The count of contact entity. + + + + Releases all resources used by the ContactsList. + + Disposing by User + + + + Releases all resources used by the ContactsList. + It should be called after finished using of the object. + + + + + Adds a record to the contacts list. + + The record to add + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Removes a record from the contacts list. + + The record to remove + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + + + + Retrieves a record from the contacts list. + + + contacts record + + + + + Moves a contacts list to the previous position. + + + When the cursor is already at the first position, it returns false. + + + + + Moves a contacts list to the next position. + + + When the cursor is already at the last position, it returns false. + + + + + Moves a contacts list to the first position. + + + + + Moves a contacts list to the last position. + + + + + Enumeration for name display order. + + + + + First name comes at the first + + + + + First name comes at the last + + + + + Enumeration for name sorting order. + + + + + Contacts are first sorted based on the first name + + + + + Contacts are first sorted based on the last name + + + + + A class for managing contact information. It allows applications to access contacts database. + + + + + Creates a ContactsManager. + + Thrown when method failed due to invalid operation + + + + Destructor + + + + + Releases all resources used by the ContactsManager. + + Disposing by User + + + + Releases all resources used by the ContactsManager. + It should be called after finished using of the object. + + + + + (event) NameDisplayOrderChanged is raised when changing setting value of contacts name display order + + http://tizen.org/privilege/contact.read + + + + (event) NameSortingOrderChanged is raised when changing setting value of contacts name sorting order + + http://tizen.org/privilege/contact.read + + + + A ContactsDatabase + + A ContactsDatabase + + + + A setting value of contacts name display order + + A setting value of contacts name display order + + DisplayName of contacts returned from database are determined by this property + + http://tizen.org/privilege/contact.read + http://tizen.org/privilege/contact.write + + + + A setting value of contacts name sorting order + + A setting value of contacts name sorting order + + Contacts returned from database are first sorted based on the first name or last name by this property + + http://tizen.org/privilege/contact.read + http://tizen.org/privilege/contact.write + + + + A query is used to retrieve data which satisfies given criteria + + + A query is used to retrieve person, group, speed dial, and log data which satisfies a given criteria, such as an integer property being greater than a given value, or a string property containing a given substring. + A query needs a filter which can set the conditions for the search. + + + + + Creates a query. + + The view URI of a query + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destructor + + + + + Releases all resources used by the ContactsQuery. + + Disposing by User + + + + Releases all resources used by the ContactsQuery. + It should be called after finished using of the object. + + + + + Adds property IDs for projection. + + The property ID array + Thrown when one of the arguments provided to a method is not valid + + + + Sets the "distinct" option for projection. + + If true it is set, otherwise if false it is unset + Thrown when one of the arguments provided to a method is not valid + + + + Sets the filter for a query. + + The filter + Thrown when one of the arguments provided to a method is not valid + + + + Sets the sort mode for a query. + + The property ID to sort + If true it sorts in the ascending order, otherwise if false it sorts in the descending order + Thrown when one of the arguments provided to a method is not valid + + + + A record represents an actual record in the database + + + A record represents an actual record in the database, but you can also consider it a piece of information, such as an address, a phone number, or a group of contacts. + A record can be a complex set of data, containing other data. For example, a contact record contains the address property, which is a reference to an address record. + An address record belongs to a contact record, and its ContactId property is set to the identifier of the corresponding contact. In this case, the address is the child record of the contact and the contact is the parent record. + + + + + Creates a record. + + The view URI + Thrown when an invoked method is not supported + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Destructor + + + + + The URI of the record + + The URI of the record + + + + Releases all resources used by the ContactsRecord. + + Disposing by User + + + + Releases all resources used by the ContactsRecord. + It should be called after finished using of the object. + + + + + Makes a clone of a record. + + A cloned record + Thrown when failed due to out of memory + + + + Gets a value of the property from a record. + + The property ID + + The value of the property corresponding to property id. + + Thrown when one of the arguments provided to a method is not valid + + + + Sets a value of the property to a record. + + The property ID + The value to set + Thrown when one of the arguments provided to a method is not valid + + + + Adds a child record to the parent record. + + The property ID + The child record to add to parent record + Thrown when one of the arguments provided to a method is not valid + + + + Removes a child record from the parent record. + + The property ID + The child record to remove from parent record + Thrown when one of the arguments provided to a method is not valid + + + + Gets the number of child records of a parent record. + + The property ID + The number of child records corresponding to property ID + Thrown when one of the arguments provided to a method is not valid + + + + Gets a child record from the parent record + + The property ID + The index of child record + The record + Thrown when one of the arguments provided to a method is not valid + + + + Clones a child record list corresponding to property ID + + The property ID + + The record list + + Thrown when one of the arguments provided to a method is not valid + + + + Delegate for getting a record parsed from a vCard file + + The contacts record + + + + + A class for parsing and making vCards. + + + It's based on the vCard v3.0 specification + + + + + Retrieves the vCard stream from a contacts record. + + The contacts record + + The vCard stream. + + http://tizen.org/privilege/contact.read + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Retrieves all contacts with a contacts list from a vCard stream + + The vCard stream + + The contacts list + + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Retrieves all contacts with a record from a vCard file. + + The file path of vCard stream file + The callback function to invoke + Thrown when method failed due to invalid operation + Thrown when one of the arguments provided to a method is not valid + Thrown when failed due to out of memory + + + + Enumeration for contact change state. + + + + + Inserted + + + + + Updated + + + + + Deleted + + + + + Describes properties of a Address book record. + + + + + Identifier of this contacts address book view + + + + + integer, read only, DB record ID of the address book + + + + + integer, read/write once, Account ID that the address book belongs to + + + + + string, read/write, It cannot be NULL. Duplicate names are not allowed. + + + + + integer, read/write, AddressBook mode, refer to the ModeValue + + + + + Enumeration for Address book mode. + + + + + All module can read and write contacts of this address_book + + + + + All module can only read contacts of this address_book + + + + + Describes properties of a Group record. + + + + + Identifier of this contacts group view + + + + + DB record ID of the group + + + + + AddressBook ID that the group belongs to + + + + + Group name + + + + + Ringtone path of the group + + + + + Image path of the group + + + + + Vibration path of the group + + + + + Extra data for default group name + + + + + The group is read only or not + + + + + Message alert path of the group + + + + + Describes properties of a Person record. + + + + + Identifier of this contacts person view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to + + + + + Ringtone path of the person + + + + + Image thumbnail path of the person + + + + + Vibration path of the person + + + + + Message alert path of the person + + + + + Status of social account + + + + + The person is favorite or not + + + + + The priority of favorite contacts. it can be used as sorting key + + + + + Link count of contact records (projection) + + + + + AddressBook IDs that the person belongs to (projection) + + + + + The person has phone number or not + + + + + The person has email or not + + + + + keyword matched data type + + + + + keyword matched data string + + + + + Describes properties of a Contact record. + + + + + Identifier of this contact view + + + + + DB record ID of the contact + + + + + Display name of the contact + + + + + The source type of display name, refer to the DisplayNameSourceType + + + + + AddressBook ID that the contact belongs to + + + + + Ringtone path of the contact + + + + + Image thumbnail path of the contact + + + + + The contact is favorite or not + + + + + The contact has phone number or not + + + + + The contact has email or not + + + + + Person ID that the contact belongs to. If set when inserting, a contact will be linked to person + + + + + Unique identifier + + + + + Vibration path of the contact + + + + + Message alert path of the contact + + + + + Last changed contact time + + + + + The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored + + + + + Name child record (single) + + + + + Company child record (multiple) + + + + + Note child record (multiple) + + + + + Number child record (multiple) + + + + + Email child record (multiple) + + + + + Event child record (multiple) + + + + + Messenger child record (multiple) + + + + + Address child record (multiple) + + + + + URL child record (multiple) + + + + + Nickname child record (multiple) + + + + + Profile child record (multiple) + + + + + Relationship child record (multiple) + + + + + Image child record (multiple) + + + + + GroupRelation child record (multiple) + + + + + Extension child record (multiple) + + + + + Sip child record (multiple) + + + + + Enumeration for link mode when inserting contact. + + + + + Auto link immediately + + + + + Do not auto link when the contact is inserted + + + + + Enumeration for Contact display name source type. + + + + + Invalid source of display name + + + + + Produced display name from email record + + + + + Produced display name from number record + + + + + Produced display name from nickname record + + + + + Produced display name from company record + + + + + Produced display name from name record + + + + + Enumeration for contacts data type. + + + + + None + + + + + Name + + + + + Address + + + + + Messenger + + + + + URL + + + + + Event + + + + + Company + + + + + Nickname + + + + + Number + + + + + Email + + + + + Profile + + + + + Relationship + + + + + Note + + + + + Image + + + + + SIP + + + + + Extension + + + + + Describes properties of a Simple contact record. + + + + + Identifier of this simple contact view + + + + + DB record ID of the contact + + + + + Display name of the contact + + + + + The source type of display name, refer to the Contact.DisplayNameSourceType + + + + + AddressBook that the contact belongs to + + + + + Ringtone path of the contact + + + + + Image thumbnail path of the contact + + + + + The contact is favorite or not + + + + + The contact has phone number or not + + + + + The contact has email or not + + + + + Person ID that the contact belongs to + + + + + Unique identifier + + + + + Vibration path of the contact + + + + + Message alert path of the contact + + + + + Last changed contact time + + + + + Describes properties of a My profile record. + + + + + Identifier of this my profile view + + + + + DB record ID of the my profile + + + + + Display name of the profile + + + + + AddressBook ID that the profile belongs to + + + + + Image thumbnail path of the profile + + + + + Unique identifier + + + + + Last changed profile time + + + + + Name child record (single) + + + + + Company child record (multiple) + + + + + Note child record (multiple) + + + + + Number child record (multiple) + + + + + Email child record (multiple) + + + + + Event child record (multiple) + + + + + Messenger child record (multiple) + + + + + Address child record (multiple) + + + + + URL child record (multiple) + + + + + Nickname child record (multiple) + + + + + Profile child record (multiple) + + + + + Relationship child record (multiple) + + + + + Image child record (multiple) + + + + + Extension child record (multiple) + + + + + Sip child record (multiple) + + + + + Describes properties of a Name record. + + + + + Identifier of this contacts name view + + + + + DB record ID of the name + + + + + Contacts ID that the name record belongs to + + + + + First name + + + + + Last name + + + + + Middle name + + + + + Suffix + + + + + Prefix + + + + + Pronounce the first name + + + + + Pronounce the middle name + + + + + Pronounce the last name + + + + + Describes properties of a Number record. + + + + + Identifier of this contacts number view + + + + + DB record ID of the number + + + + + Contact ID that the number belongs to + + + + + Number type, refer to the Types + + + + + Custom number type label, when the number type is Types.Custom + + + + + The number is default number or not + + + + + Number + + + + + You can only use this property for search filter. + + + + + You can only use this property for search filter. + + + + + You can only use this property for search filter. + + + + + Enumeration for number type. + + + + + Other number type + + + + + Custom number type + + + + + A telephone number associated with a residence + + + + + A telephone number associated with a place of work + + + + + A voice telephone number + + + + + A facsimile telephone number + + + + + The telephone number has voice messaging support + + + + + A cellular telephone number + + + + + A paging device telephone number + + + + + A bulletin board system telephone number + + + + + A MODEM connected telephone number + + + + + A car-phone telephone number + + + + + An ISDN service telephone number + + + + + A video conferencing telephone number + + + + + A personal communication services telephone number + + + + + A company main number + + + + + A radio phone number + + + + + An additional type for main + + + + + An additional type for assistant + + + + + Describes properties of a Email record. + + + + + Identifier of this contacts email view + + + + + DB record ID of the email + + + + + Contact ID that the email belongs to + + + + + Email type, refer to the Types + + + + + Custom mail type label, when the email type is Types.Custom + + + + + The email is default email or not + + + + + Email address + + + + + Enumeration for Contact email type. + + + + + Other email type + + + + + Custom email type + + + + + An email address associated with a residence + + + + + An email address associated with a place of work + + + + + A mobile email address + + + + + Describes properties of a Address record. + + + + + Identifier of this contacts address view + + + + + DB record ID of the address + + + + + Contact ID that the address belongs to + + + + + Address type, refer to the Types + + + + + Address type label, when the address type is Types.Custom + + + + + Post office box + + + + + Postal code + + + + + Region + + + + + Locality + + + + + Street + + + + + Country + + + + + Extended address + + + + + The address is default or not + + + + + Enumeration for Contact address type. + + + + + Other address type + + + + + Custom address type + + + + + A delivery address for a residence + + + + + A delivery address for a place of work + + + + + A domestic delivery address + + + + + An international delivery address + + + + + A postal delivery address + + + + + A parcel delivery address + + + + + Describes properties of a Note record. + + + + + Identifier of this contacts note view + + + + + DB record ID of the note + + + + + Contact ID that the note belongs to + + + + + Note contents + + + + + Describes properties of a URL record. + + + + + Identifier of this contacts URL view + + + + + DB record ID of the URL + + + + + Contact ID that the URL belongs to + + + + + URL type, refer to the TypeValue + + + + + Custom URL type label, when the URL type is TypeValue.Custom + + + + + URL + + + + + Enumeration for Contact URL type. + + + + + Other URL type + + + + + Custom URL type + + + + + Home URL type + + + + + Work URL type + + + + + Describes properties of a Event record. + + + + + Identifier of this contacts event view + + + + + DB record ID of the event + + + + + Contact ID that the event belongs to + + + + + Event type, refer to the TypeValue + + + + + Custom event type label, when the event type is TypeValue.Custom + + + + + Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date + + + + + Calendar type, refer to the CalendarType + + + + + Enumeration for Contact event type. + + + + + Other event type + + + + + Custom event type + + + + + Birthday event type + + + + + Anniversary event type + + + + + Enumeration for Contact event calendar type. + + + + + Gregorian calendar + + + + + Chinese calendar + + + + + Describes properties of a Relationship record. + + + + + Identifier of this relationship view + + + + + DB record ID of the relationship + + + + + Contact ID that the relationship belongs to + + + + + Relationship type, refer to the TypeValue + + + + + Custom relationship type label, when the relationship type is TypeValue.Custom + + + + + Selected contact name that the relationship belongs to + + + + + Enumeration for Contact relationship type. + + + + + Other relationship type + + + + + Assistant type + + + + + Brother type + + + + + Child type + + + + + Domestic Partner type + + + + + Father type + + + + + Friend type + + + + + Manager type + + + + + Mother type + + + + + Parent type + + + + + Partner type + + + + + Referred by type + + + + + Relative type + + + + + Sister type + + + + + Spouse type + + + + + Custom type + + + + + Describes properties of a Image record. + + + + + Identifier of this contacts image view + + + + + DB record ID of the image + + + + + Contact ID that the image belongs to + + + + + Image type, refer to the TypeValue + + + + + Custom image type label, when the image type is TypeValue.Custom + + + + + Image thumbnail path + + + + + The Image is default or not + + + + + Enumeration for Contact image type. + + + + + Other type + + + + + Custom type + + + + + Describes properties of a Company record. + + + + + Identifier of this contacts company view + + + + + DB record ID of the company + + + + + Contact ID that the company belongs to + + + + + Company type, refer to the TypeValue + + + + + Custom company type label, when the company type is TypeValue.Custom + + + + + Company name + + + + + Department + + + + + Job title + + + + + Assistant name + + + + + Role + + + + + Company logo image file path + + + + + Company location + + + + + Description + + + + + Pronounce the company name + + + + + Enumeration for Contact company type. + + + + + Other type + + + + + Custom type + + + + + Work type + + + + + Describes properties of a Nickname record. + + + + + Identifier of this contacts nickname view + + + + + DB record ID of the nickname + + + + + Contact ID that the nickname belongs to + + + + + Nickname + + + + + Describes properties of a Messenger record. + + + + + Identifier of this contacts messenger view + + + + + DB record ID of the messenger + + + + + Contact ID that the messenger belongs to + + + + + Messenger type, refer to the TypeValue + + + + + Custom messenger type label, when the messenger type is TypeValue.Custom + + + + + Messenger ID (email address or email ID...) + + + + + Enumeration for Contact messenger type. + + + + + Other messenger type + + + + + Custom messenger type + + + + + Google messenger type + + + + + Windows live messenger type + + + + + Yahoo messenger type + + + + + Facebook messenger type + + + + + ICQ type + + + + + AOL instance messenger type + + + + + QQ type + + + + + Jabber type + + + + + Skype type + + + + + IRC type + + + + + Describes properties of a Profile record. + + + + + Identifier of this contacts profile view + + + + + DB record ID of profile + + + + + Contacts ID that the profile belongs to + + + + + Unique identifier + + + + + Profile contents + + + + + Priority to display the profile + + + + + Data for app_control_set_operation + + + + + Data for app_control_set_mime + + + + + Data for app_control_set_app_id + + + + + Data for app_control_set_uri + + + + + Data for app_control_set_category + + + + + It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value + + + + + Describes properties of a Sip record. + + + + + Identifier of this contacts sip view + + + + + DB record ID of the sip + + + + + Contact ID that the sip belongs to + + + + + SIP address + + + + + sip type, refer to the TypeValue + + + + + Custom sip type label, when the sip type is TypeValue.Custom + + + + + Enumeration for Contact SIP type. + + + + + Other SIP type + + + + + Custom SIP type + + + + + Home SIP type + + + + + Work SIP type + + + + + Describes properties of a Extension record. + + + + + Identifier of this contacts extension view + + + + + DB record ID of the contact extension + + + + + Contact ID that the contact extension belongs to + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + The extra child record format for non-provided from contacts-service + + + + + Describes properties of a Group relation record. + + + + + Identifier of this relationship view + + + + + DB record ID of the group relation (can not be used as filter) + + + + + DB record ID of the group + + + + + DB record ID of the contact + + + + + Group name + + + + + Describes properties of a Speed dial record. + + + + + Identifier of this contact speed dial view + + + + + Stored speed dial number + + + + + Number ID that the speed dial belongs to + + + + + Contact number of specified speed dial + + + + + Contact number label of specified speed dial, when the number type is Number.Types.Custom + + + + + Contact number type, refer to the Number.Types + + + + + Person ID that the speed dial belongs to + + + + + Display name that the speed dial belongs to + + + + + Image thumbnail path that the speed dial belongs to + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly + + + + + Describes properties of a Phone log record. + + + + + Identifier of this phone log view + + + + + DB record ID of phone log + + + + + Person ID that the phone log belongs to + + + + + Number or Email that the phone log displays + + + + + Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) + + + + + Log type, refer to the Type + + + + + You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) + + + + + You can set the related string data (e.g. short message, subject) + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + You can set the related SIM slot number. SimSlotNo 0 means first SIM card, SimSlotNo 1 means second SIM. + + + + + Enumeration for Phone log type. + + + + + None + + + + + Incoming call + + + + + Outgoing call + + + + + Incoming video call + + + + + Outgoing video call + + + + + Not confirmed missed call + + + + + Confirmed missed call + + + + + Not confirmed missed video call + + + + + Confirmed missed video call + + + + + Rejected call + + + + + Rejected video call + + + + + Blocked call + + + + + Blocked video call + + + + + Incoming MMS + + + + + Outgoing MMS + + + + + Incoming SMS + + + + + Outgoing SMS + + + + + Blocked SMS + + + + + Blocked MMS + + + + + Received email + + + + + Sent email + + + + + Describes properties of a Contact updated information record. + + Read only view + + + + Identifier of this contact updated info view + + + + + Updated contact ID + + + + + AddressBook ID that the updated contact belongs to + + + + + Contact change type, refer to the ContactsViews.ChangeType + + + + + Updated version + + + + + Contact image is changed or not + + + + + Describes properties of a My profile updated information record. + + Read only view + + + + Identifier of this my profile updated info view + + + + + Address book ID that the updated my profile belongs to + + + + + MyProfile change type, refer to the ContactsViews.ChangeType + + + + + Updated version + + + + + Describes properties of a Group updated information record. + + Read only view + + + + Identifier of this group updated info view + + + + + Updated group ID + + + + + Address book ID that the updated group belongs to + + + + + Group change type, refer to the ContactsViews.ChangeType + + + + + Updated version + + + + + Describes properties of a Group Member updated information record. + + Read only view + + + + Identifier of this group member updated info view + + + + + Updated group ID + + + + + Address book ID that the updated group belongs to + + + + + Updated version + + + + + Describes properties of a Relation updated information record. + + Read only view + + + + Identifier of this group relation updated info view + + + + + Group ID of group relation + + + + + Contact ID of the updated group relation + + + + + Address book ID of contact that the updated group relation + + + + + Group relation change type, refer to the ContactsViews.ChangeType + + + + + Updated version + + + + + Describes properties of a PersonContact record. + + Read only view + + + + Identifier of this person contact view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + Status of social account (projection) + + + + + The person is favorite or not + + + + + Link count of contact records (projection) + + + + + Contact ID that the person belongs to + + + + + AddressBook IDs that the person belongs to (projection) + + + + + The person has phone number or not + + + + + The person has email or not + + + + + AddressBook ID that the person belongs to + + + + + AddressBook mode, refer to the AddressBook.Mode + + + + + AddressBook name that the person belongs to + + + + + keyword matched data type, refer to the Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonNumber record. + + Read only view + + + + Identifier of this person number view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Number ID that the person belongs to + + + + + Number type, refer to the Number.Types (projection) + + + + + Custom number type label, when the number type is Number.Types.Custom (projection) + + + + + The number is default number or not + + + + + Number + + + + + If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + keyword matched data type, refer to they Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonEmail record. + + Read only view + + + + Identifier of this person email view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Email ID that the person belongs to + + + + + Email type, refer to the Email.Types (projection) + + + + + Custom mail type label, when the email type is Email.Types.Custom (projection) + + + + + The email is default email or not + + + + + Email address + + + + + keyword matched data type, refer to they Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonGroupRelation record. + + Read only view + + + + Identifier of this person group relation view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + Status of social account (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Link count of contact records (projection) + + + + + AddressBook IDs that the person belongs to (projection) + + + + + AddressBook ID that the person belongs to + + + + + AddressBook name that the person belongs to + + + + + AddressBook mode, refer to the AddressBook.Mode + + + + + Group ID that the person belongs to + + + + + Contact ID that the person belongs to (projection) + + + + + keyword matched data type, refer to they Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonGroupAssignedrecord. + + Read only view + + + + Identifier of this person group assigned view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + Status of social account (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Link count of contact records (projection) + + + + + AddressBook IDs that the linked person belongs to (projection) + + + + + AddressBook ID that the person belongs to + + + + + AddressBook mode, refer to the AddressBook.Mode + + + + + Group ID that the person belongs to + + + + + Contact ID that the person belongs to (projection) + + + + + keyword matched data type, refer to they Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonGroupNotAssigned record. + + Read only view + + + + Identifier of this person group not assigned view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + Status of social account (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Link count of contact records (projection) + + + + + AddressBook IDs that the linked person belongs to (projection) + + + + + AddressBook ID that the person belongs to + + + + + AddressBook mode, refer to the AddressBook.Mode + + + + + Contact ID that the person belongs to (projection) + + + + + keyword matched data type, refer to they Contact.DataType + + + + + keyword matched data string + + + + + Describes properties of a PersonPhoneLog record. + + Read only view + + + + Identifier of this phone log view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + Image thumbnail path of the person (projection) + + + + + DB record ID of phone log + + + + + Number or Email that the phone log displays + + + + + Number or Email type (projection) + + + + + Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) + + + + + Log type, refer to the PhoneLog.Types + + + + + You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection) + + + + + You can set the related string data (e.g. short message, subject) (projection) + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + It is related to the SIM slot number. SimSlotNo 0 means first SIM card, SimSlotNo 1 means second SIM. + + + + + Describes properties of a Person Usage record. + + Read only view + + + + Identifier of this person usage view + + + + + DB record ID of the person + + + + + Display name of the person + + + + + The first character of first string for grouping. This is normalized using ICU (projection) + + + + + Display contact ID that the person belongs to (projection) + + + + + Ringtone path of the person (projection) + + + + + Image thumbnail path of the person (projection) + + + + + Vibration path of the person (projection) + + + + + Message alert path of the person (projection) + + + + + The person is favorite or not + + + + + The person has phone number or not + + + + + The person has email or not + + + + + Usage type, refer to the Type + + + + + Usage number of person + + + + + Enumeration for Person usage type. + + + + + None + + + + + Outgoing call + + + + + Outgoing message + + + + + Outgoing email + + + + + Incoming call + + + + + Incoming message + + + + + Incoming email + + + + + Missed call + + + + + Rejected call + + + + + Blocked call + + + + + Blocked message + + + + + Describes properties of a ContactNumber record. + + Read only view + + + + Identifier of this contacts number view + + + + + Contact ID that the number belongs to + + + + + Display name of contact that the number belongs to + + + + + The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + + + + + AddressBook ID that the number belongs to + + + + + Person ID that the number belongs to + + + + + Ringtone path that the number belongs to (projection) + + + + + Image thumbnail path that the number belongs to (projection) + + + + + DB record ID of the number + + + + + Number type, refer to the Number.Types (projection) + + + + + Custom number type label, when the number type is Number.Types.Custom (projection) + + + + + The number is default number or not + + + + + Number + + + + + If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly + + + + + You can only use this property for search filter + + + + + You can only use this property for search filter + + + + + Describes properties of a ContactEmail record. + + Read only view + + + + Identifier of this contacts email view + + + + + Contact ID that the number belongs to + + + + + Display name of contact that the number belongs to + + + + + The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + + + + + AddressBook ID that the number belongs to + + + + + Person ID that the number belongs to + + + + + Ringtone path that the number belongs to (projection) + + + + + Image thumbnail path that the number belongs to (projection) + + + + + DB record ID of the email + + + + + Email type, refer to the Email.Types (projection) + + + + + Custom mail type label, when the email type is Email.Types.Custom (projection) + + + + + Email is default email or not + + + + + Email address + + + + + Describes properties of a ContactGroupRelation record. + + Read only view + + + + Identifier of this contact group relation view + + + + + Contact ID that the number belongs to + + + + + Display name of contact that the number belongs to + + + + + The source type of display name, refer to the Contact.DisplayNameSourceType (projection) + + + + + AddressBook ID that the number belongs to + + + + + Person ID that the number belongs to + + + + + Ringtone path that the number belongs to (projection) + + + + + Image thumbnail path that the number belongs to (projection) + + + + + DB record ID of the group relation + + + + + Group name (projection) + + + + + Describes properties of a Phone Log Statistics record. + + Read only view + + + + Identifier of this log statistics view + + + + + Log count (projection) + + + + + Log type, see the contacts_phone_log_type_e + + + + + It is related to the SIM slot number. sim_slot_no 0 means first SIM card, sim_slot_no 1 means second SIM. It is same with handle index of telephony handle list. Refer to the telephony_init() + + + + + Event arguments passed when contacts database status is changed + + + + + The contacts database status. + + + + + Event arguments passed when setting value of contacts name display order is changed + + + + + A setting value of contacts name display order + + + + + Event arguments passed when setting value of contacts name sorting order is changed + + + + + A setting value of contacts name sorting order + + + + diff --git a/Artifacts/bin/Tizen.Security.SecureRepository.dll b/Artifacts/bin/Tizen.Security.SecureRepository.dll index 9535703..0814642 100644 Binary files a/Artifacts/bin/Tizen.Security.SecureRepository.dll and b/Artifacts/bin/Tizen.Security.SecureRepository.dll differ diff --git a/Artifacts/bin/Tizen.Security.SecureRepository.pdb b/Artifacts/bin/Tizen.Security.SecureRepository.pdb index c9922db..e3206be 100644 Binary files a/Artifacts/bin/Tizen.Security.SecureRepository.pdb and b/Artifacts/bin/Tizen.Security.SecureRepository.pdb differ diff --git a/Artifacts/bin/Tizen.Security.SecureRepository.xml b/Artifacts/bin/Tizen.Security.SecureRepository.xml index 80b26db..88bd3c9 100644 --- a/Artifacts/bin/Tizen.Security.SecureRepository.xml +++ b/Artifacts/bin/Tizen.Security.SecureRepository.xml @@ -1,1352 +1,1352 @@ - - - - Tizen.Security.SecureRepository - - - - - Class that represents a certificate. - - 3 - - - - Load Certificate from the given file path. - - 3 - The path of certificate file to be loaded. - Loaded certificate class instance. - - filePath should not be null - - - Invalid certificate file format. Provided file path does not exist or - cannot be accessed. - - - - - A constructor of Certificate that takes the binary and its format. - - 3 - The binary data of a certificate. - The format of the binary data. - - - - The binary value of a certificate. - - 3 - - - - The format of the binary value. - - 3 - - - - This class provides the methods handling certificates. - - 3 - - - - Gets a certificate from secure repository. - - 3 - The name of a certificate to retrieve. - - The password used in decrypting a certificate value. If password of - policy is provided in SaveCertificate(), the same password should be - provided. - - A certificate specified by alias. - - Alias argument is null - - - Alias argument is invalid format. - - - Certificate does not exist with the alias or certificate-protecting - password isn't matched. - - - - - Gets all alias of certificates which the client can access. - - 3 - All alias of certificates which the client can access. - No alias to get. - - - - Stores a certificate inside secure repository based on the provided policy. - - 3 - The name of a certificate to be stored. - The certificate's binary value to be stored. - - The policy about how to store a certificate securely. - - - Any of argument is null. - - - Alias argument is invalid format. cert argument is invalid format. - - - Certificate with alias does already exist. - - - - - Verifies a certificate chain and returns that chain. - - 3 - The certificate to be verified. - - The untrusted CA certificates to be used in verifying a certificate chain. - - A newly created certificate chain. - - certificate argument is null. - - - Some of certificate in arguments is invalid. - - - Some of certificate in arguments is expired or not valid yet. - Certificate cannot build chain. - Root certificate is not in trusted system certificate store. - - - The trusted root certificate of the chain should exist in the system's - certificate storage. - - - The trusted root certificate of the chain in system's certificate storage - is added to the certificate chain. - - - - - Verifies a certificate chain and returns that chain using user entered - trusted and untrusted CA certificates. - - 3 - The certificate to be verified. - - The untrusted CA certificates to be used in verifying a certificate chain. - - - The trusted CA certificates to be used in verifying a certificate chain. - - - The flag indicating the use of the trusted root certificates in the - system's certificate storage. - - A newly created certificate chain. - - certificate argument is null. - - - Some of certificate in arguments is invalid. - - - Some of certificate in arguments is expired or not valid yet. - Certificate cannot build chain. - Root certificate is not in trusted system certificate store. - - - The trusted root certificate of the chain in system's certificate storage - is added to the certificate chain. - - - - - Perform OCSP which checks certificate is whether revoked or not. - - 3 - - Valid certificate chain to perform OCSP check. - - A status result of OCSP check. - - certificateChain argument is null. - - - certificateChain is not valid chain or certificate. - - - some of certificate in chain is expired or not valid yet. - - - - - A class holding parameters for AES algorithm with CBC mode. - - 3 - - - - A default constructor - - 3 - The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCbc. - - - - A class holding parameters for AES algorithm with CFB mode. - - 3 - - - - A default constructor - - 3 - The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCfb. - - - - A abstract class holding parameters for AES algorithm. - - 3 - - - - An initialization vector. - - 3 - - - - A class holding parameters for AES algorithm with counter mode. - - 3 - - - - A default constructor - - 3 - The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr. - - - - Length of counter block in bits. - - 3 - Optional, only 128b is supported at the moment. - value should be positive. - - - - A class holding parameters for AES algorithm with GCM mode. - - 3 - - - - A default constructor - - 3 - The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesGcm. - - - - GCM tag length in bits. - - 3 - One of {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used. - TagLength should be one of {32, 64, 96, 104, 112, 120, 128} - - - - Additional authentication data(optional) - - 3 - - - - This class provides the methods encrypting and decrypting data. - - 3 - - - - A constructor of Cipher that takes the algorithm specific parameters. - - 3 - The algorithm specific parameters. - - - - The algorithm specific parameters. - - 3 - - - - Decrypts data using selected key and algorithm. - - 3 - Alias of the key to be used for decryption. - - The password used in decrypting a key value. If password of policy is - provided in SaveKey(), the same password should be provided - - - Data to be decrypted (some algorithms may require additional information - embedded in encrypted data.AES GCM is an example). - - Decrypted data. - - keyAlias or cipherText is null. - - - Mandatory algorithm parameter is missing or invalid. - Optional algorithm parameter is invalid. - - - Key-protecting password isn't matched. - Key does not exist with keyAlias. - - - The key type specified by keyAlias should be compatible with the algorithm - specified in Parameters. - - - - - Encrypts data using selected key and algorithm. - - 3 - Alias of the key to be used for encryption. - - The password used in decrypting a key value. If password of policy is - provided in SaveKey(), the same password should be provided. - - - Data to be encrypted. In case of AES algorithm there are no restrictions on - the size of data. For RSA the size must be smaller or equal to (key_size_in - bytes - 42). Example: for 1024 RSA key the maximum data size is - 1024/8 - 42 = 86. - - Encrypted data. - - keyAlias or plainText is null. - - - Mandatory algorithm parameter is missing or invalid. - Optional algorithm parameter is invalid. - - - Key-protecting password isn't matched. - Key does not exist with keyAlias. - - - The key type specified by keyAlias should be compatible with the algorithm - specified in Parameters. - - - - - Enumeration for crypto cipher algorithm types. - - 3 - - - - AES-CTR algorithm - Supported parameters: - - ParameterName.AlgorithmType = AesCtr(mandatory), - - ParameterName.IV = 16 - byte initialization vector(mandatory) - - ParameterName.CounterLength = length of counter block in bits - (optional, only 128b is supported at the moment) - - - - - AES-CBC algorithm - Supported parameters: - - ParameterName.AlgorithmType = AesCbc(mandatory), - - ParameterName.IV = 16-byte initialization vector(mandatory) - - - - - AES-GCM algorithm - Supported parameters: - - ParameterName.AlgorithmType = AesGcm(mandatory), - - ParameterName.IV = initialization vector(mandatory) - - ParameterName.TagLength = GCM tag length in bits. One of - {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used) - - CKMC_PARAM_ED_AAD = additional authentication data(optional) - - - - - AES-CFB algorithm - Supported parameters: - - ParameterName.AlgorithmType = AesCfb(mandatory), - - ParameterName.IV = 16-byte initialization vector(mandatory) - - - - - RSA-OAEP algorithm - Supported parameters: - - ParameterName.AlgorithmType = RsaOaep(required), - - ParameterName.Label = label to be associated with the message - (optional, not supported at the moment) - - - - - Enumeration for cipher algorithm parameters. - - 3 - - - - Algorithm Type - - - - - Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM) - - - - - Integer - ctr length in bits - - - - - Additional authenticated data(AAD) - - - - - Tag Length - - - - - Label - - - - - A abstract class holding parameters for encryption and decryption. - - 3 - - - - Cipher algorithm type. - - 3 - - - - A class holding parameters for DSA signature algorithm. - - 3 - - - - A default constructor - - 3 - - - - A class holding parameters for ECDSA signature algorithm. - - 3 - - - - A default constructor - - 3 - - - - Enumeration for hash algorithm - - 3 - - - - No Hash Algorithm - - - - - Hash Algorithm SHA1 - - - - - Hash Algorithm SHA256 - - - - - Hash Algorithm SHA384 - - - - - Hash Algorithm SHA512 - - - - - A class holding parameters for RSA algorithm with OAEP mode. - - 3 - - - - A default constructor - - 3 - The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.RsaOaep. - - - - Enumeration for RSA padding algorithm - - 3 - - - - No Padding - - - - - PKCS#1 Padding - - - - - X9.31 padding - - - - - A class holding parameters for RSA signature algorithm. - - 3 - - - - A default constructor - - 3 - The RsaPadding is set to RsaPaddingAlgorithm.None. - - - - RSA padding algorithm - - 3 - - - - This class provides the methods creating and verifying a signature. - - 3 - - - - A constructor of Signature that takes the algorithm specific parameters. - - 3 - The algorithm specific parameters. - - - - The algorithm specific parameters. - - 3 - - - - Creates a signature on a given message using a private key and returns - the signature. - - 3 - The name of private key. - - The password used in decrypting a private key value. - - The message that is signed with a private key. - A newly created signature. - - privateKeyAlias or message is null. - - - privateKeyAlias is invalid format. - - - Key-protecting password isn't matched. - Key does not exist with privateKeyAlias. - - - The key type specified by privateKeyAlias should be compatible with the - algorithm specified in Parameters. - - - If password of policy is provided during storing a key, the same password - should be provided. - - - - - Verifies a given signature on a given message using a public key and returns - the signature status. - - 3 - The name of public key. - - The password used in decrypting a public key value. - - The input on which the signature is created. - The signature that is verified with public key. - - The signature status. True is returned when the signature is valid. - - - publicKeyAlias, message or signature is null. - - - publicKeyAlias is invalid format. - - - Key-protecting password isn't matched. - Key does not exist with publicKeyAlias. - - - The key type specified by publicKeyAlias should be compatible with the - algorithm specified in Parameters. - - - If password of policy is provided during storing a key, the same password - should be provided. - - - - - Enumeration for signature algorithm types. - - 3 - - - - RSA signature algorithm - - - - - DSA signature algorithm - - - - - ECDSA signature algorithm - - - - - Enumeration for signature algorithm parameters. - - 3 - - - - Signaturea Algorithm Type - - - - - Hash Algorithm Type - - - - - RSA Padding Algorithm Type - - - - - A abstract class holding parameters for signing and verification. - - 3 - - - - Signature algorithm type. - - 3 - - - - Hash algorithm used in signing anve verification. - - 3 - - - - Enumeration for data format - - 3 - - - - DER format base64 encoded data - - - - - DER encoded data - - - - - PEM encoded data. It consists of the DER format base64 encoded - with additional header and footer lines. - - - - - This class provides the methods storing and retrieving data. - - 3 - - - - Gets data from secure repository. - - 3 - The name of a certificate to retrieve. - - The password used in decrypting a data value. - If password of policy is provided in SaveData(), the same password should - be provided. - - Data specified by alias. - - Alias argument is null. - - - Alias argument is invalid format. - - - Data does not exist with the alias or data-protecting password isn't matched. - - - - - Gets all alias of data which the client can access. - - 3 - All alias of data which the client can access. - No alias to get. - - - - Stores data inside secure repository based on the provided policy. - - 3 - The name of data to be stored. - The binary value to be stored. - The policy about how to store data securely. - - Any of argument is null. - - - Alias argument is invalid format. Data policy cannot be unextractable. - - - Data with alias does already exist. - - - - - Enumeration for elliptic curve - - 3 - - - - Elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain - - - - - "SEC 2" recommended elliptic curve domain - secp256r1 - - - - - NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2 - - - - - Class that represents a key. - - 3 - - - - A constructor of Key that takes the binary, its type, and optional password - of binary. - - 3 - - The binary value of a key. This binary may be encrypted with binaryPassword. - - The key's type. - - The password used to decrypt binary when binary is encrypted. - - - - - The binary value of a key. - - 3 - - - - The key's type. - - 3 - - - - The password used to decrypt binary when binary is encrypted. It's optional. - - 3 - - - - This class provides the methods storing, retrieving, and creating keys. - - 3 - - - - Gets a key from secure repository. - - 3 - The name of a key to retrieve. - - The password used in decrypting a key value. - If password of policy is provided in SaveKey(), the same password should - be provided. - - A key specified by alias. - - Alias argument is null. - - - Alias argument is invalid format. - - - Key does not exist with the alias or key-protecting password isn't matched. - - - - - Gets all alias of keys which the client can access. - - 3 - All alias of keys which the client can access. - No alias to get. - - - - Stores a key inside secure repository based on the provided policy. - - 3 - The name of a key to be stored. - The key's binary value to be stored. - The policy about how to store a key securely. - - Any of argument is null. - - - Alias argument is invalid format. key argument is invalid format. - - - Key with alias does already exist. - - - Type in key may be set to KeyType.None as an input. - Type is determined inside secure reposioty during storing keys. - - - If password in policy is provided, the key is additionally encrypted with - the password in policy. - - - - - Creates RSA private/public key pair and stores them inside secure repository - based on each policy. - - 3 - - The size of key strength to be created. 1024, 2048, and 4096 are supported. - - The name of private key to be stored. - The name of public key to be stored. - - The policy about how to store a private key securely. - - - The policy about how to store a public key securely. - - - Any of argument is null. - - - size is invalid. privateKeyAlias or publicKeyAlias is invalid format. - - - Key with privateKeyAlias or publicKeyAlias does already exist. - - - If password in policy is provided, the key is additionally encrypted with the - password in policy. - - - - - Creates DSA private/public key pair and stores them inside secure repository - based on each policy. - - 3 - - The size of key strength to be created. 1024, 2048, 3072, and 4096 are - supported. - - The name of private key to be stored. - The name of public key to be stored. - - The policy about how to store a private key securely. - - - The policy about how to store a public key securely. - - - Any of argument is null. - - - size is invalid. privateKeyAlias or publicKeyAlias is invalid format. - - - Key with privateKeyAlias or publicKeyAlias does already exist. - - - If password in policy is provided, the key is additionally encrypted with - the password in policy. - - - - - Creates ECDSA private/public key pair and stores them inside secure repository - based on each policy. - - 3 - The type of elliptic curve of ECDSA. - The name of private key to be stored. - The name of public key to be stored. - - The policy about how to store a private key securely. - - - The policy about how to store a public key securely. - - - Any of argument is null. - - - Elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is - invalid format. - - - Key with privateKeyAlias or publicKeyAlias does already exist. - - - If password in policy is provided, the key is additionally encrypted with - the password in policy. - - - - - Creates AES key and stores it inside secure repository based on each policy. - - 3 - - The size of key strength to be created. 128, 192 and 256 are supported. - - The name of key to be stored. - The policy about how to store the key securely. - - keyAlias or policy is null. - - - Key size is invalid. keyAlias is invalid format. - - - Key with privateKeyAlias or publicKeyAlias does already exist. - - - If password in policy is provided, the key is additionally encrypted with - the password in policy. - - - - - Enumeration for key types of key manager. - - 3 - - - - Key type not specified - - - - - RSA public key - - - - - RSA private key - - - - - ECDSA public key - - - - - ECDSA private key - - - - - DSA public key - - - - - DSA private key - - - - - AES key - - - - - This class is a base class of XxxManager classes. It provides the common methods - for all sub classes. - - 3 - - - - Creates a new full alias which is concatenation of owner id and alias. - - 3 - Data owner's id. This should be package id if data - owner is application. If you want to access data stored by system services, - use CreateFullSystemAlias() instead. - Data alias. - - - - Creates a new full alias which is concatenation of system service's - owner id and alias. - - 3 - Data alias which is owned by system service. - - - - Removes a an entry (no matter of type) from the key manager. - - 3 - Item alias to be removed. - alias is null. - alias is invalid format. - alias does not exist. - - To remove item, client must have remove permission to the specified item. - - The item owner can remove by default. - - - - Allows another application to access client's application data. - - 3 - Item alias for which access will be granted. - - Package id of the application that will gain access rights. - - - Mask of permissions(Permission enum) granted for an application with - otherPackageId. - - - alias or otherPackageId is null. - - - alias or otherPackageId is invalid format. - - alias does not exist. - Data identified by alias should exist. - The item owner can set permissions. - - - - Enumeration for OCSP status. - - 3 - - - - OCSP status is good - - - - - The certificate is revoked - - - - - Unknown error - - - - - The certificate does not provide OCSP extension - - - - - The invalid URL in certificate OCSP extension - - - - - The invalid response from OCSP server - - - - - OCSP remote server error - - - - - Network connection error - - - - - Internal error - - - - - Enumeration for permissions to access/modify alias. - - 3 - - - - Clear permissions - - - - - Eead allowed - - - - - Remove allowed - - - - - Class that represents a PKCS#12 contents. - It has a private key or its certificate or all the members of a chain of trust. - - 3 - - - - Load Pkcs12 from the given PKCS#12 file path. - - 3 - The path of PKCS12 file to be loaded. - The passphrase used to decrypt the PCKS12 file. - If PKCS12 file is not encrypted, passphrase can be null. - filePath is null. - - No file on filePath. - No permission to access file. - File is invalid PKCS12 format. - File cannot be extracted with provided filePassword. - - - - - A constructor of Key that takes a private key. - - 3 - A private key. - - - - A constructor of Key that takes a private key, its corresponding certicate, - and CA's certificate chain. - - 3 - A private key. - A certificate corresponding the private key - - A certificate chain of CA(Certificate Authority) that issued the certificate. - - - - - A private key. - - 3 - - - - A certificate corresponding the private key. - - 3 - - - - A certificate chain of CA(Certificate Authority) that issued the certificate. - - 3 - - - - This class provides the methods storing, retrieving Pkcs12 contents. - - 3 - - - - Gets Pkcs12 contents from secure repository. - - 3 - The name of data to retrieve. - - The password used in decrypting a private key value. If password of - keyPolicy is provided in SavePkcs12(), the same password should be provided - - - The password used in decrypting a certificate value. If password of - certificatePolicy is provided in SavePkcs12(), the same password should be - provided - - A Pkcs12 data specified by alias. - Alias argument is null. - - Alias argument is invalid format. - - - Pkcs12 does not exist with the alias. - Optional password of key in Pkcs12 isn't matched. - Optional password of certificate in Pkcs12 isn't matched. - - - - - Stores PKCS12's contents inside key manager based on the provided policies. - All items from the PKCS12 will use the same alias. - - 3 - The name of a data to be stored. - The pkcs12 data to be stored. - - The policy about how to store pkcs's private key. - - - The policy about how to store pkcs's certificate. - - Any of argument is null. - - Alias argument is invalid format. Pkcs12 argument is invalid format. - - - Pkcs12 with alias does already exist. - - - - - A class for a policy for storing key, certificate, and binary data. - - 3 - - - - A default constructor of Policy with default policy. - - 3 - The default value for Password is null and the default value for Extractabl is false. - - - - A constructor of Key that takes the password and the flag for extractable. - - 3 - Used to encrypt data secure repository. - If true key may be extracted from secure repository. - - - - Used to encrypt data secure repository. If it is not null, the data - (or key, or certificate) is stored encrypted with this password inside secure repository - - 3 - - - - If true key may be extracted from secure repository. - - 3 - - - + + + + Tizen.Security.SecureRepository + + + + + Class that represents a certificate. + + 3 + + + + Load Certificate from the given file path. + + 3 + The path of certificate file to be loaded. + Loaded certificate class instance. + + filePath should not be null + + + Invalid certificate file format. Provided file path does not exist or + cannot be accessed. + + + + + A constructor of Certificate that takes the binary and its format. + + 3 + The binary data of a certificate. + The format of the binary data. + + + + The binary value of a certificate. + + 3 + + + + The format of the binary value. + + 3 + + + + This class provides the methods handling certificates. + + 3 + + + + Gets a certificate from secure repository. + + 3 + The name of a certificate to retrieve. + + The password used in decrypting a certificate value. If password of + policy is provided in SaveCertificate(), the same password should be + provided. + + A certificate specified by alias. + + Alias argument is null + + + Alias argument is invalid format. + + + Certificate does not exist with the alias or certificate-protecting + password isn't matched. + + + + + Gets all alias of certificates which the client can access. + + 3 + All alias of certificates which the client can access. + No alias to get. + + + + Stores a certificate inside secure repository based on the provided policy. + + 3 + The name of a certificate to be stored. + The certificate's binary value to be stored. + + The policy about how to store a certificate securely. + + + Any of argument is null. + + + Alias argument is invalid format. cert argument is invalid format. + + + Certificate with alias does already exist. + + + + + Verifies a certificate chain and returns that chain. + + 3 + The certificate to be verified. + + The untrusted CA certificates to be used in verifying a certificate chain. + + A newly created certificate chain. + + certificate argument is null. + + + Some of certificate in arguments is invalid. + + + Some of certificate in arguments is expired or not valid yet. + Certificate cannot build chain. + Root certificate is not in trusted system certificate store. + + + The trusted root certificate of the chain should exist in the system's + certificate storage. + + + The trusted root certificate of the chain in system's certificate storage + is added to the certificate chain. + + + + + Verifies a certificate chain and returns that chain using user entered + trusted and untrusted CA certificates. + + 3 + The certificate to be verified. + + The untrusted CA certificates to be used in verifying a certificate chain. + + + The trusted CA certificates to be used in verifying a certificate chain. + + + The flag indicating the use of the trusted root certificates in the + system's certificate storage. + + A newly created certificate chain. + + certificate argument is null. + + + Some of certificate in arguments is invalid. + + + Some of certificate in arguments is expired or not valid yet. + Certificate cannot build chain. + Root certificate is not in trusted system certificate store. + + + The trusted root certificate of the chain in system's certificate storage + is added to the certificate chain. + + + + + Perform OCSP which checks certificate is whether revoked or not. + + 3 + + Valid certificate chain to perform OCSP check. + + A status result of OCSP check. + + certificateChain argument is null. + + + certificateChain is not valid chain or certificate. + + + some of certificate in chain is expired or not valid yet. + + + + + A class holding parameters for AES algorithm with CBC mode. + + 3 + + + + A default constructor + + 3 + The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCbc. + + + + A class holding parameters for AES algorithm with CFB mode. + + 3 + + + + A default constructor + + 3 + The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCfb. + + + + A abstract class holding parameters for AES algorithm. + + 3 + + + + An initialization vector. + + 3 + + + + A class holding parameters for AES algorithm with counter mode. + + 3 + + + + A default constructor + + 3 + The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesCtr. + + + + Length of counter block in bits. + + 3 + Optional, only 128b is supported at the moment. + value should be positive. + + + + A class holding parameters for AES algorithm with GCM mode. + + 3 + + + + A default constructor + + 3 + The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.AesGcm. + + + + GCM tag length in bits. + + 3 + One of {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used. + TagLength should be one of {32, 64, 96, 104, 112, 120, 128} + + + + Additional authentication data(optional) + + 3 + + + + This class provides the methods encrypting and decrypting data. + + 3 + + + + A constructor of Cipher that takes the algorithm specific parameters. + + 3 + The algorithm specific parameters. + + + + The algorithm specific parameters. + + 3 + + + + Decrypts data using selected key and algorithm. + + 3 + Alias of the key to be used for decryption. + + The password used in decrypting a key value. If password of policy is + provided in SaveKey(), the same password should be provided + + + Data to be decrypted (some algorithms may require additional information + embedded in encrypted data.AES GCM is an example). + + Decrypted data. + + keyAlias or cipherText is null. + + + Mandatory algorithm parameter is missing or invalid. + Optional algorithm parameter is invalid. + + + Key-protecting password isn't matched. + Key does not exist with keyAlias. + + + The key type specified by keyAlias should be compatible with the algorithm + specified in Parameters. + + + + + Encrypts data using selected key and algorithm. + + 3 + Alias of the key to be used for encryption. + + The password used in decrypting a key value. If password of policy is + provided in SaveKey(), the same password should be provided. + + + Data to be encrypted. In case of AES algorithm there are no restrictions on + the size of data. For RSA the size must be smaller or equal to (key_size_in + bytes - 42). Example: for 1024 RSA key the maximum data size is + 1024/8 - 42 = 86. + + Encrypted data. + + keyAlias or plainText is null. + + + Mandatory algorithm parameter is missing or invalid. + Optional algorithm parameter is invalid. + + + Key-protecting password isn't matched. + Key does not exist with keyAlias. + + + The key type specified by keyAlias should be compatible with the algorithm + specified in Parameters. + + + + + Enumeration for crypto cipher algorithm types. + + 3 + + + + AES-CTR algorithm + Supported parameters: + - ParameterName.AlgorithmType = AesCtr(mandatory), + - ParameterName.IV = 16 - byte initialization vector(mandatory) + - ParameterName.CounterLength = length of counter block in bits + (optional, only 128b is supported at the moment) + + + + + AES-CBC algorithm + Supported parameters: + - ParameterName.AlgorithmType = AesCbc(mandatory), + - ParameterName.IV = 16-byte initialization vector(mandatory) + + + + + AES-GCM algorithm + Supported parameters: + - ParameterName.AlgorithmType = AesGcm(mandatory), + - ParameterName.IV = initialization vector(mandatory) + - ParameterName.TagLength = GCM tag length in bits. One of + {32, 64, 96, 104, 112, 120, 128} (optional, if not present the length 128 is used) + - CKMC_PARAM_ED_AAD = additional authentication data(optional) + + + + + AES-CFB algorithm + Supported parameters: + - ParameterName.AlgorithmType = AesCfb(mandatory), + - ParameterName.IV = 16-byte initialization vector(mandatory) + + + + + RSA-OAEP algorithm + Supported parameters: + - ParameterName.AlgorithmType = RsaOaep(required), + - ParameterName.Label = label to be associated with the message + (optional, not supported at the moment) + + + + + Enumeration for cipher algorithm parameters. + + 3 + + + + Algorithm Type + + + + + Initial Vector, 16B buffer (up to 2^64-1 bytes long in case of AES GCM) + + + + + Integer - ctr length in bits + + + + + Additional authenticated data(AAD) + + + + + Tag Length + + + + + Label + + + + + A abstract class holding parameters for encryption and decryption. + + 3 + + + + Cipher algorithm type. + + 3 + + + + A class holding parameters for DSA signature algorithm. + + 3 + + + + A default constructor + + 3 + + + + A class holding parameters for ECDSA signature algorithm. + + 3 + + + + A default constructor + + 3 + + + + Enumeration for hash algorithm + + 3 + + + + No Hash Algorithm + + + + + Hash Algorithm SHA1 + + + + + Hash Algorithm SHA256 + + + + + Hash Algorithm SHA384 + + + + + Hash Algorithm SHA512 + + + + + A class holding parameters for RSA algorithm with OAEP mode. + + 3 + + + + A default constructor + + 3 + The CipherAlgorithmType in CipherParameters is set to CipherAlgorithmType.RsaOaep. + + + + Enumeration for RSA padding algorithm + + 3 + + + + No Padding + + + + + PKCS#1 Padding + + + + + X9.31 padding + + + + + A class holding parameters for RSA signature algorithm. + + 3 + + + + A default constructor + + 3 + The RsaPadding is set to RsaPaddingAlgorithm.None. + + + + RSA padding algorithm + + 3 + + + + This class provides the methods creating and verifying a signature. + + 3 + + + + A constructor of Signature that takes the algorithm specific parameters. + + 3 + The algorithm specific parameters. + + + + The algorithm specific parameters. + + 3 + + + + Creates a signature on a given message using a private key and returns + the signature. + + 3 + The name of private key. + + The password used in decrypting a private key value. + + The message that is signed with a private key. + A newly created signature. + + privateKeyAlias or message is null. + + + privateKeyAlias is invalid format. + + + Key-protecting password isn't matched. + Key does not exist with privateKeyAlias. + + + The key type specified by privateKeyAlias should be compatible with the + algorithm specified in Parameters. + + + If password of policy is provided during storing a key, the same password + should be provided. + + + + + Verifies a given signature on a given message using a public key and returns + the signature status. + + 3 + The name of public key. + + The password used in decrypting a public key value. + + The input on which the signature is created. + The signature that is verified with public key. + + The signature status. True is returned when the signature is valid. + + + publicKeyAlias, message or signature is null. + + + publicKeyAlias is invalid format. + + + Key-protecting password isn't matched. + Key does not exist with publicKeyAlias. + + + The key type specified by publicKeyAlias should be compatible with the + algorithm specified in Parameters. + + + If password of policy is provided during storing a key, the same password + should be provided. + + + + + Enumeration for signature algorithm types. + + 3 + + + + RSA signature algorithm + + + + + DSA signature algorithm + + + + + ECDSA signature algorithm + + + + + Enumeration for signature algorithm parameters. + + 3 + + + + Signaturea Algorithm Type + + + + + Hash Algorithm Type + + + + + RSA Padding Algorithm Type + + + + + A abstract class holding parameters for signing and verification. + + 3 + + + + Signature algorithm type. + + 3 + + + + Hash algorithm used in signing anve verification. + + 3 + + + + Enumeration for data format + + 3 + + + + DER format base64 encoded data + + + + + DER encoded data + + + + + PEM encoded data. It consists of the DER format base64 encoded + with additional header and footer lines. + + + + + This class provides the methods storing and retrieving data. + + 3 + + + + Gets data from secure repository. + + 3 + The name of a certificate to retrieve. + + The password used in decrypting a data value. + If password of policy is provided in SaveData(), the same password should + be provided. + + Data specified by alias. + + Alias argument is null. + + + Alias argument is invalid format. + + + Data does not exist with the alias or data-protecting password isn't matched. + + + + + Gets all alias of data which the client can access. + + 3 + All alias of data which the client can access. + No alias to get. + + + + Stores data inside secure repository based on the provided policy. + + 3 + The name of data to be stored. + The binary value to be stored. + The policy about how to store data securely. + + Any of argument is null. + + + Alias argument is invalid format. Data policy cannot be unextractable. + + + Data with alias does already exist. + + + + + Enumeration for elliptic curve + + 3 + + + + Elliptic curve domain "secp192r1" listed in "SEC 2" recommended elliptic curve domain + + + + + "SEC 2" recommended elliptic curve domain - secp256r1 + + + + + NIST curve P-384(covers "secp384r1", the elliptic curve domain listed in See SEC 2 + + + + + Class that represents a key. + + 3 + + + + A constructor of Key that takes the binary, its type, and optional password + of binary. + + 3 + + The binary value of a key. This binary may be encrypted with binaryPassword. + + The key's type. + + The password used to decrypt binary when binary is encrypted. + + + + + The binary value of a key. + + 3 + + + + The key's type. + + 3 + + + + The password used to decrypt binary when binary is encrypted. It's optional. + + 3 + + + + This class provides the methods storing, retrieving, and creating keys. + + 3 + + + + Gets a key from secure repository. + + 3 + The name of a key to retrieve. + + The password used in decrypting a key value. + If password of policy is provided in SaveKey(), the same password should + be provided. + + A key specified by alias. + + Alias argument is null. + + + Alias argument is invalid format. + + + Key does not exist with the alias or key-protecting password isn't matched. + + + + + Gets all alias of keys which the client can access. + + 3 + All alias of keys which the client can access. + No alias to get. + + + + Stores a key inside secure repository based on the provided policy. + + 3 + The name of a key to be stored. + The key's binary value to be stored. + The policy about how to store a key securely. + + Any of argument is null. + + + Alias argument is invalid format. key argument is invalid format. + + + Key with alias does already exist. + + + Type in key may be set to KeyType.None as an input. + Type is determined inside secure reposioty during storing keys. + + + If password in policy is provided, the key is additionally encrypted with + the password in policy. + + + + + Creates RSA private/public key pair and stores them inside secure repository + based on each policy. + + 3 + + The size of key strength to be created. 1024, 2048, and 4096 are supported. + + The name of private key to be stored. + The name of public key to be stored. + + The policy about how to store a private key securely. + + + The policy about how to store a public key securely. + + + Any of argument is null. + + + size is invalid. privateKeyAlias or publicKeyAlias is invalid format. + + + Key with privateKeyAlias or publicKeyAlias does already exist. + + + If password in policy is provided, the key is additionally encrypted with the + password in policy. + + + + + Creates DSA private/public key pair and stores them inside secure repository + based on each policy. + + 3 + + The size of key strength to be created. 1024, 2048, 3072, and 4096 are + supported. + + The name of private key to be stored. + The name of public key to be stored. + + The policy about how to store a private key securely. + + + The policy about how to store a public key securely. + + + Any of argument is null. + + + size is invalid. privateKeyAlias or publicKeyAlias is invalid format. + + + Key with privateKeyAlias or publicKeyAlias does already exist. + + + If password in policy is provided, the key is additionally encrypted with + the password in policy. + + + + + Creates ECDSA private/public key pair and stores them inside secure repository + based on each policy. + + 3 + The type of elliptic curve of ECDSA. + The name of private key to be stored. + The name of public key to be stored. + + The policy about how to store a private key securely. + + + The policy about how to store a public key securely. + + + Any of argument is null. + + + Elliptic curve type is invalid. privateKeyAlias or publicKeyAlias is + invalid format. + + + Key with privateKeyAlias or publicKeyAlias does already exist. + + + If password in policy is provided, the key is additionally encrypted with + the password in policy. + + + + + Creates AES key and stores it inside secure repository based on each policy. + + 3 + + The size of key strength to be created. 128, 192 and 256 are supported. + + The name of key to be stored. + The policy about how to store the key securely. + + keyAlias or policy is null. + + + Key size is invalid. keyAlias is invalid format. + + + Key with privateKeyAlias or publicKeyAlias does already exist. + + + If password in policy is provided, the key is additionally encrypted with + the password in policy. + + + + + Enumeration for key types of key manager. + + 3 + + + + Key type not specified + + + + + RSA public key + + + + + RSA private key + + + + + ECDSA public key + + + + + ECDSA private key + + + + + DSA public key + + + + + DSA private key + + + + + AES key + + + + + This class is a base class of XxxManager classes. It provides the common methods + for all sub classes. + + 3 + + + + Creates a new full alias which is concatenation of owner id and alias. + + 3 + Data owner's id. This should be package id if data + owner is application. If you want to access data stored by system services, + use CreateFullSystemAlias() instead. + Data alias. + + + + Creates a new full alias which is concatenation of system service's + owner id and alias. + + 3 + Data alias which is owned by system service. + + + + Removes a an entry (no matter of type) from the key manager. + + 3 + Item alias to be removed. + alias is null. + alias is invalid format. + alias does not exist. + + To remove item, client must have remove permission to the specified item. + + The item owner can remove by default. + + + + Allows another application to access client's application data. + + 3 + Item alias for which access will be granted. + + Package id of the application that will gain access rights. + + + Mask of permissions(Permission enum) granted for an application with + otherPackageId. + + + alias or otherPackageId is null. + + + alias or otherPackageId is invalid format. + + alias does not exist. + Data identified by alias should exist. + The item owner can set permissions. + + + + Enumeration for OCSP status. + + 3 + + + + OCSP status is good + + + + + The certificate is revoked + + + + + Unknown error + + + + + The certificate does not provide OCSP extension + + + + + The invalid URL in certificate OCSP extension + + + + + The invalid response from OCSP server + + + + + OCSP remote server error + + + + + Network connection error + + + + + Internal error + + + + + Enumeration for permissions to access/modify alias. + + 3 + + + + Clear permissions + + + + + Eead allowed + + + + + Remove allowed + + + + + Class that represents a PKCS#12 contents. + It has a private key or its certificate or all the members of a chain of trust. + + 3 + + + + Load Pkcs12 from the given PKCS#12 file path. + + 3 + The path of PKCS12 file to be loaded. + The passphrase used to decrypt the PCKS12 file. + If PKCS12 file is not encrypted, passphrase can be null. + filePath is null. + + No file on filePath. + No permission to access file. + File is invalid PKCS12 format. + File cannot be extracted with provided filePassword. + + + + + A constructor of Key that takes a private key. + + 3 + A private key. + + + + A constructor of Key that takes a private key, its corresponding certicate, + and CA's certificate chain. + + 3 + A private key. + A certificate corresponding the private key + + A certificate chain of CA(Certificate Authority) that issued the certificate. + + + + + A private key. + + 3 + + + + A certificate corresponding the private key. + + 3 + + + + A certificate chain of CA(Certificate Authority) that issued the certificate. + + 3 + + + + This class provides the methods storing, retrieving Pkcs12 contents. + + 3 + + + + Gets Pkcs12 contents from secure repository. + + 3 + The name of data to retrieve. + + The password used in decrypting a private key value. If password of + keyPolicy is provided in SavePkcs12(), the same password should be provided + + + The password used in decrypting a certificate value. If password of + certificatePolicy is provided in SavePkcs12(), the same password should be + provided + + A Pkcs12 data specified by alias. + Alias argument is null. + + Alias argument is invalid format. + + + Pkcs12 does not exist with the alias. + Optional password of key in Pkcs12 isn't matched. + Optional password of certificate in Pkcs12 isn't matched. + + + + + Stores PKCS12's contents inside key manager based on the provided policies. + All items from the PKCS12 will use the same alias. + + 3 + The name of a data to be stored. + The pkcs12 data to be stored. + + The policy about how to store pkcs's private key. + + + The policy about how to store pkcs's certificate. + + Any of argument is null. + + Alias argument is invalid format. Pkcs12 argument is invalid format. + + + Pkcs12 with alias does already exist. + + + + + A class for a policy for storing key, certificate, and binary data. + + 3 + + + + A default constructor of Policy with default policy. + + 3 + The default value for Password is null and the default value for Extractabl is false. + + + + A constructor of Key that takes the password and the flag for extractable. + + 3 + Used to encrypt data secure repository. + If true key may be extracted from secure repository. + + + + Used to encrypt data secure repository. If it is not null, the data + (or key, or certificate) is stored encrypted with this password inside secure repository + + 3 + + + + If true key may be extracted from secure repository. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Security.TEEC.dll b/Artifacts/bin/Tizen.Security.TEEC.dll index d199274..fa61871 100644 Binary files a/Artifacts/bin/Tizen.Security.TEEC.dll and b/Artifacts/bin/Tizen.Security.TEEC.dll differ diff --git a/Artifacts/bin/Tizen.Security.TEEC.pdb b/Artifacts/bin/Tizen.Security.TEEC.pdb index 58f8c07..9467ab8 100644 Binary files a/Artifacts/bin/Tizen.Security.TEEC.pdb and b/Artifacts/bin/Tizen.Security.TEEC.pdb differ diff --git a/Artifacts/bin/Tizen.Security.TEEC.xml b/Artifacts/bin/Tizen.Security.TEEC.xml index ead170c..ec60a55 100644 --- a/Artifacts/bin/Tizen.Security.TEEC.xml +++ b/Artifacts/bin/Tizen.Security.TEEC.xml @@ -1,537 +1,537 @@ - - - - Tizen.Security.TEEC - - - - - This function initializes a new TEE Context, forming a connection between this client application and the - TEE identified by the string identifier name. - The client application may pass a name with a value of null, which means that the implementation must - select a default TEE to connect to. The supported name strings, the mapping of these names to a specific - TEE, and the nature of the default TEE are implementation-defined. - - - - - This function destroys an initialized TEE Context, closing the connection between the client application - and the TEE. The client application must only call this function when all sessions inside this TEE - context have been closed and all shared memory blocks have been released. - The implementation of this function must not fail; after this function returns, the client - application must be able to consider that the context has been closed. - The function implementation must do nothing if the value of the context pointer is null. - - - - - This function registers a block of existing client application memory as a block of shared memory within - the scope of the specified TEE Context, in accordance with the parameters which have been set by the - client application inside the shared memory structure. - The input context must point to an initialized TEE Context. - The input shared Memory must point to the shared memory structure defining the memory region to register. - - - - - This function allocates a new block of memory as a block of shared memory within the scope of the - specified TEE Context, in accordance with the parameters which have been set by the client application - inside the shared memory structure. - The input context must point to an initialized TEE Context. - The input shared memory must point to the shared memory structure defining the region to allocate. - - - - - This function deregisters or deallocates a previously initialized block of the shared memory. - For a memory buffer allocated using AllocateSharedMemory, the implementation must free the - underlying memory and the client application must not access this region after this function has been - called. In this case, the implementation must set the buffer and size fields of the shared memory - structure to null and 0 respectively before returning. - For memory registered using RegisterSharedMemory, the implementation must deregister the - underlying memory from the TEE, but the memory region will stay available to the client application for - other purposes as the memory is owned by it. - The implementation must do nothing if the value of the shared memory parameter is null. - - - - - This function opens a new session between the client application and the specified trusted application. - The implementation must assume that all fields of this session structure are in an undefined state. - When this function returns TEEC_SUCCESS, the implementation must have populated this structure with - any information necessary for subsequent operations within the session. - The target trusted application is identified by the UUID passed in the parameter destination. - - - - - This function closes a session which has been opened with a trusted application. - All commands within the session must have completed before this function can be called. - The implementation must do nothing if the input session parameter is null. - The implementation of this function must not fail; after this function returns, the Client - Application must be able to consider that the session has been closed. - - - - - This function invokes a command within the specified session. - The parameter session must point to a valid open session. - The parameter commandID is an identifier that is used to indicate which of the exposed Trusted - Application functions should be invoked. The supported command identifier values are defined by the - trusted application's protocol. - - - - - This function requests the cancelation of a pending open session operation or a command invocation - operation. As this is a synchronous API, this function must be called from a thread other than the one - executing the OpenSession or InvokeCommand function. - This function just sends a cancelation signal to the TEE and returns immediately; the operation is not - guaranteed to have been canceled when this function returns. In addition, the cancelation request is just - a hint; the TEE or the trusted application may ignore the cancelation request. - - - - - This type denotes the Session Login Method used in OpenSession. - - 3 - - - No login data is provided. - - - Login data about the user running the client application process is provided. - - - Login data about the group running the client application process is provided. - - - Login data about the running client application itself is provided. - - - - This type denotes the Value parameter. - - 3 - - - The parameter is a ValueType tagged as the input. - - - The parameter is a ValueType tagged as the output. - - - The parameter is a ValueType tagged as both the input and the output. - - - - This type denotes the TempMemoryReference parameter - describing a region of memory which needs to be temporarily registered for the duration of the operation. - - 3 - - - The parameter is a TempMemoryType and is tagged as the input. - - - Same as the input, but the Memory Reference is tagged as the output. - - - A Temporary Memory Reference tagged as both the input and the output. - - - - This type denotes the SharedMemoryReference parameter. - - 3 - - - The parameter is a registered memory reference that refers to the entirety of its parent shared memory block. - - - A registered memory reference structure that refers to a partial region of its parent shared mMemory block and is tagged as the input. - - - A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as the output. - - - A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as both the input and the output. - - - - This type denotes the SharedMemory access direction. - - 3 - - - A flag indicates the shared memory can be read. - - - A flag indicates the shared memory can be written. - - - A flag indicates the shared memory can be read and written. - - - - This type denotes a shared memory block which has been either registered - with the implementation or allocated by it. - - 3 - - - - This property represents the shared memory size in bytes. - - 3 - - - - This property represents the start address of the shared memory block. - - 3 - - - - This function makes a copy and is designed for convenient operations on small buffers. - For large buffers, the direct address should be used. - - 3 - The source data buffer to copy data from. - The starting offset in the destination shared memory. - The operation is invalid. - - - - This function makes a copy and is designed for convenient operations on small buffers. - For large buffers, the direct address should be used. - - 3 - The destination data buffer to copy data into. - The starting offset in the source shared memory. - The operation is invalid. - - - - This type defines the payload of either an open session operation or an invoke command operation. It is - also used for cancelation of operations, which may be desirable even if no payload is passed. - Parameters are used to exchange data between CA and TA. - - 3 - - - - This type defines a template for the parameter types. - - 3 - - - - This property represents the access type to this parameter. - - 3 - - - - This type defines a temporary memory reference. - - 3 - - - - Constructs a parameter object which holds information about the temporary memory copied to or from TA. - - 3 - The address of the allocated memory buffer. - The size of the buffer. - The kind of access allowed for TA . - - - - This property represents the memory address of the buffer. - - 3 - - - - This property represents the size of the buffer. - - 3 - - - - This type defines a memory reference that uses a pre-registered or pre-allocated shared memory block. - - 3 - - - - Constructs a parameter object which holds information about the registered memory shared with TA. - - 3 - The shared memory - registered or allocated. - The size of the buffer part. - The offset of the buffer in the shared memory. - The kind of access allowed for TA . - - - - This property represents the shared memory that is referred to. - - 3 - - - - This property represents the size (in bytes) of the shared memory. - - 3 - - - - This property represents the offset (in bytes) from the start of the shared memory. - - 3 - - - - This type defines a parameter that is not referencing the shared memory, but carries instead small raw data - passed by a value. - - 3 - - - - Constructs a parameter object which holds information about integer values copied to or from TA. - - 3 - User paramter A. - User paramter B. - The kind of access allowed for TA . - - - - This property represents an unsigned integer A. - - 3 - - - - This property represents an unsigned integer B. - - 3 - - - - This type denotes a TEE Session, the logical container linking a client application with a particular trusted application. - - 3 - - - - This function closes a session which has been opened with a trusted application. - All commands within the session must be completed before this function can be called. - - 3 - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - - - - This function invokes a command within the specified session. - The parameter commandID is an identifier that is used to indicate which of the exposed trusted - application functions should be invoked. The supported command identifier values are defined by the - trusted application's protocol. - There can be up to four parameter objects given in the array. - - 3 - The command. - The array of parameters. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - The argument is wrong. - - - - The asynchronous version of the InvokeCommand. - - 3 - The command. - The array of parameters. - The token for task manipulation. - Returns a task executing an invoke command in the background. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - One of the arguments is wrong. - - - - This type denotes a TEE Context, the main logical container linking a Client Application with a particular TEE. - - 3 - - - - This function (constructor) initializes a new TEE Context, forming a connection between this client application and the - TEE identified by the string identifier name (empty or null name denotes a default TEE). - - 3 - The TEE name. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - - - - This function implements the IDisposable interface. - - 3 - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - - - - This function opens a new session between the client application and the specified trusted application. - The target trusted application is identified by an UUID passed in the parameter destination. - There can be up to four parameter objects given in the array. - - 3 - The UUID of the destination TA. - The authentication algorithm . - The data to be verified by a given login method. - The parameters to be passed to TA open-session-callback. - Returns opened session. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - One of the arguments is wrong. - - - - @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). - - 3 - The UUID of the destination TA. - Returns opened session. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - - - - The asynchronous version of the OpenSession. - @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). - - 3 - The UUID of the destination TA. - The authentication algorithm . - The data to be verified by a given login method. - The parameters to be passed to the TA open-session-callback. - The token for the task manipulation. - Returns a Task executing the session open in the background. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - One of the arguments is wrong. - - - - The asynchronous version of the OpenSession. - @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). - - 3 - The UUID of the destination TA. - The token for a task manipulation. - Returns a task executing session open in the background. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - - - - This function registers a block of the existing client application memory as a block of shared memory within - the scope of the specified context, in accordance with the parameters. - The input must point to the shared memory region to register. - - 3 - The address of the shared memory. - The size of the shared memory. - The flags describing the access modes (Input and/or Output). - Returns the SharedMemory handler. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - The argument is wrong. - - - - This function allocates a new block of memory as a block of shared memory within the scope of the - specified context, in accordance with the parameters. - - 3 - The size of shared memory. - The flags describing access modes (Input and/or Output). - Returns the Shared Memory handler. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - - - - This function deregisters or deallocates a previously initialized block of the shared memory. - - - For a memory buffer allocated using AllocateSharedMemory, the implementation must free the - underlying memory and the client application must not access this region after this function has been - called. In this case, the implementation must clear the buffer and size fields of the shared memory - structure before returning. - For memory registered using RegisterSharedMemory, the implementation must deregister the - underlying memory from the TEE, but the memory region will stay available to the client application for - other purposes as the memory is owned by it. - - 3 - The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory. - http://tizen.org/privilege/tee.client - partner - http://tizen.org/feature/security.tee - Thrown when an application does not have the privilege to access this method. - The required feature is not supported. - The operation is invalid. - The argument is wrong. - - - + + + + Tizen.Security.TEEC + + + + + This function initializes a new TEE Context, forming a connection between this client application and the + TEE identified by the string identifier name. + The client application may pass a name with a value of null, which means that the implementation must + select a default TEE to connect to. The supported name strings, the mapping of these names to a specific + TEE, and the nature of the default TEE are implementation-defined. + + + + + This function destroys an initialized TEE Context, closing the connection between the client application + and the TEE. The client application must only call this function when all sessions inside this TEE + context have been closed and all shared memory blocks have been released. + The implementation of this function must not fail; after this function returns, the client + application must be able to consider that the context has been closed. + The function implementation must do nothing if the value of the context pointer is null. + + + + + This function registers a block of existing client application memory as a block of shared memory within + the scope of the specified TEE Context, in accordance with the parameters which have been set by the + client application inside the shared memory structure. + The input context must point to an initialized TEE Context. + The input shared Memory must point to the shared memory structure defining the memory region to register. + + + + + This function allocates a new block of memory as a block of shared memory within the scope of the + specified TEE Context, in accordance with the parameters which have been set by the client application + inside the shared memory structure. + The input context must point to an initialized TEE Context. + The input shared memory must point to the shared memory structure defining the region to allocate. + + + + + This function deregisters or deallocates a previously initialized block of the shared memory. + For a memory buffer allocated using AllocateSharedMemory, the implementation must free the + underlying memory and the client application must not access this region after this function has been + called. In this case, the implementation must set the buffer and size fields of the shared memory + structure to null and 0 respectively before returning. + For memory registered using RegisterSharedMemory, the implementation must deregister the + underlying memory from the TEE, but the memory region will stay available to the client application for + other purposes as the memory is owned by it. + The implementation must do nothing if the value of the shared memory parameter is null. + + + + + This function opens a new session between the client application and the specified trusted application. + The implementation must assume that all fields of this session structure are in an undefined state. + When this function returns TEEC_SUCCESS, the implementation must have populated this structure with + any information necessary for subsequent operations within the session. + The target trusted application is identified by the UUID passed in the parameter destination. + + + + + This function closes a session which has been opened with a trusted application. + All commands within the session must have completed before this function can be called. + The implementation must do nothing if the input session parameter is null. + The implementation of this function must not fail; after this function returns, the Client + Application must be able to consider that the session has been closed. + + + + + This function invokes a command within the specified session. + The parameter session must point to a valid open session. + The parameter commandID is an identifier that is used to indicate which of the exposed Trusted + Application functions should be invoked. The supported command identifier values are defined by the + trusted application's protocol. + + + + + This function requests the cancelation of a pending open session operation or a command invocation + operation. As this is a synchronous API, this function must be called from a thread other than the one + executing the OpenSession or InvokeCommand function. + This function just sends a cancelation signal to the TEE and returns immediately; the operation is not + guaranteed to have been canceled when this function returns. In addition, the cancelation request is just + a hint; the TEE or the trusted application may ignore the cancelation request. + + + + + This type denotes the Session Login Method used in OpenSession. + + 3 + + + No login data is provided. + + + Login data about the user running the client application process is provided. + + + Login data about the group running the client application process is provided. + + + Login data about the running client application itself is provided. + + + + This type denotes the Value parameter. + + 3 + + + The parameter is a ValueType tagged as the input. + + + The parameter is a ValueType tagged as the output. + + + The parameter is a ValueType tagged as both the input and the output. + + + + This type denotes the TempMemoryReference parameter + describing a region of memory which needs to be temporarily registered for the duration of the operation. + + 3 + + + The parameter is a TempMemoryType and is tagged as the input. + + + Same as the input, but the Memory Reference is tagged as the output. + + + A Temporary Memory Reference tagged as both the input and the output. + + + + This type denotes the SharedMemoryReference parameter. + + 3 + + + The parameter is a registered memory reference that refers to the entirety of its parent shared memory block. + + + A registered memory reference structure that refers to a partial region of its parent shared mMemory block and is tagged as the input. + + + A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as the output. + + + A registered memory reference structure that refers to a partial region of its parent shared memory block and is tagged as both the input and the output. + + + + This type denotes the SharedMemory access direction. + + 3 + + + A flag indicates the shared memory can be read. + + + A flag indicates the shared memory can be written. + + + A flag indicates the shared memory can be read and written. + + + + This type denotes a shared memory block which has been either registered + with the implementation or allocated by it. + + 3 + + + + This property represents the shared memory size in bytes. + + 3 + + + + This property represents the start address of the shared memory block. + + 3 + + + + This function makes a copy and is designed for convenient operations on small buffers. + For large buffers, the direct address should be used. + + 3 + The source data buffer to copy data from. + The starting offset in the destination shared memory. + The operation is invalid. + + + + This function makes a copy and is designed for convenient operations on small buffers. + For large buffers, the direct address should be used. + + 3 + The destination data buffer to copy data into. + The starting offset in the source shared memory. + The operation is invalid. + + + + This type defines the payload of either an open session operation or an invoke command operation. It is + also used for cancelation of operations, which may be desirable even if no payload is passed. + Parameters are used to exchange data between CA and TA. + + 3 + + + + This type defines a template for the parameter types. + + 3 + + + + This property represents the access type to this parameter. + + 3 + + + + This type defines a temporary memory reference. + + 3 + + + + Constructs a parameter object which holds information about the temporary memory copied to or from TA. + + 3 + The address of the allocated memory buffer. + The size of the buffer. + The kind of access allowed for TA . + + + + This property represents the memory address of the buffer. + + 3 + + + + This property represents the size of the buffer. + + 3 + + + + This type defines a memory reference that uses a pre-registered or pre-allocated shared memory block. + + 3 + + + + Constructs a parameter object which holds information about the registered memory shared with TA. + + 3 + The shared memory - registered or allocated. + The size of the buffer part. + The offset of the buffer in the shared memory. + The kind of access allowed for TA . + + + + This property represents the shared memory that is referred to. + + 3 + + + + This property represents the size (in bytes) of the shared memory. + + 3 + + + + This property represents the offset (in bytes) from the start of the shared memory. + + 3 + + + + This type defines a parameter that is not referencing the shared memory, but carries instead small raw data + passed by a value. + + 3 + + + + Constructs a parameter object which holds information about integer values copied to or from TA. + + 3 + User paramter A. + User paramter B. + The kind of access allowed for TA . + + + + This property represents an unsigned integer A. + + 3 + + + + This property represents an unsigned integer B. + + 3 + + + + This type denotes a TEE Session, the logical container linking a client application with a particular trusted application. + + 3 + + + + This function closes a session which has been opened with a trusted application. + All commands within the session must be completed before this function can be called. + + 3 + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + + + + This function invokes a command within the specified session. + The parameter commandID is an identifier that is used to indicate which of the exposed trusted + application functions should be invoked. The supported command identifier values are defined by the + trusted application's protocol. + There can be up to four parameter objects given in the array. + + 3 + The command. + The array of parameters. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + The argument is wrong. + + + + The asynchronous version of the InvokeCommand. + + 3 + The command. + The array of parameters. + The token for task manipulation. + Returns a task executing an invoke command in the background. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + One of the arguments is wrong. + + + + This type denotes a TEE Context, the main logical container linking a Client Application with a particular TEE. + + 3 + + + + This function (constructor) initializes a new TEE Context, forming a connection between this client application and the + TEE identified by the string identifier name (empty or null name denotes a default TEE). + + 3 + The TEE name. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + + + + This function implements the IDisposable interface. + + 3 + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + + + + This function opens a new session between the client application and the specified trusted application. + The target trusted application is identified by an UUID passed in the parameter destination. + There can be up to four parameter objects given in the array. + + 3 + The UUID of the destination TA. + The authentication algorithm . + The data to be verified by a given login method. + The parameters to be passed to TA open-session-callback. + Returns opened session. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + One of the arguments is wrong. + + + + @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). + + 3 + The UUID of the destination TA. + Returns opened session. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + + + + The asynchronous version of the OpenSession. + @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). + + 3 + The UUID of the destination TA. + The authentication algorithm . + The data to be verified by a given login method. + The parameters to be passed to the TA open-session-callback. + The token for the task manipulation. + Returns a Task executing the session open in the background. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + One of the arguments is wrong. + + + + The asynchronous version of the OpenSession. + @see OpenSession (Guid destination, uint connectionMethod, byte[] connectionData, Parameter[] paramlist, CancellationToken token). + + 3 + The UUID of the destination TA. + The token for a task manipulation. + Returns a task executing session open in the background. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + + + + This function registers a block of the existing client application memory as a block of shared memory within + the scope of the specified context, in accordance with the parameters. + The input must point to the shared memory region to register. + + 3 + The address of the shared memory. + The size of the shared memory. + The flags describing the access modes (Input and/or Output). + Returns the SharedMemory handler. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + The argument is wrong. + + + + This function allocates a new block of memory as a block of shared memory within the scope of the + specified context, in accordance with the parameters. + + 3 + The size of shared memory. + The flags describing access modes (Input and/or Output). + Returns the Shared Memory handler. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + + + + This function deregisters or deallocates a previously initialized block of the shared memory. + + + For a memory buffer allocated using AllocateSharedMemory, the implementation must free the + underlying memory and the client application must not access this region after this function has been + called. In this case, the implementation must clear the buffer and size fields of the shared memory + structure before returning. + For memory registered using RegisterSharedMemory, the implementation must deregister the + underlying memory from the TEE, but the memory region will stay available to the client application for + other purposes as the memory is owned by it. + + 3 + The shared memory object returned by RegisterSharedMemory or AllocateSharedMemory. + http://tizen.org/privilege/tee.client + partner + http://tizen.org/feature/security.tee + Thrown when an application does not have the privilege to access this method. + The required feature is not supported. + The operation is invalid. + The argument is wrong. + + + diff --git a/Artifacts/bin/Tizen.Security.dll b/Artifacts/bin/Tizen.Security.dll index 0f633fb..5adcf42 100644 Binary files a/Artifacts/bin/Tizen.Security.dll and b/Artifacts/bin/Tizen.Security.dll differ diff --git a/Artifacts/bin/Tizen.Security.pdb b/Artifacts/bin/Tizen.Security.pdb index 8886db6..dedeae9 100644 Binary files a/Artifacts/bin/Tizen.Security.pdb and b/Artifacts/bin/Tizen.Security.pdb differ diff --git a/Artifacts/bin/Tizen.Security.xml b/Artifacts/bin/Tizen.Security.xml index 7e8d3ed..1a97d04 100644 --- a/Artifacts/bin/Tizen.Security.xml +++ b/Artifacts/bin/Tizen.Security.xml @@ -1,98 +1,98 @@ - - - - Tizen.Security - - - - - The class provides the information of the given privilege and API version. - - 3 - - - - Gets the display name of the given privilege. - - 3 - If there's no matching privilege then it returns last token of given privilege. - The api version - The privilege - The display name of given privilege at given api version - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - - Gets the display name of the given privilege. - - 3 - If there's no matching privilege then it returns last token of given privilege. - The api version - The privilege - The type of application package - The display name of given privilege at given api version and the package type - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - - Gets the description of the given privilege. - - 3 - If there's no matching privilege then it returns description string for undefined privilege. - The api version - The privilege - The description of given privilege at given api version - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - - Gets the description of the given privilege. - - 3 - If there's no matching privilege then it returns description string for undefined privilege. - The api version - The privilege - The type of application package - The description of given privilege at given api version and the package type - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - - Gets the display name of the privacy group in which the given privilege is included. - - 3 - The privilege - The privilege must be privacy related. - The privacy group's display name that the given privilege is included in - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - - Gets the status of the given privacy related privilege. - - 3 - The privilege - The privilege must be privacy related. - status true if the privilege is on and false if the privilege is off. - Thrown when there is a null parameter. - Thrown when there is an invalid parameter. - Thrown when out of memory occurs - Thrown when internal error occurs. - - - + + + + Tizen.Security + + + + + The class provides the information of the given privilege and API version. + + 3 + + + + Gets the display name of the given privilege. + + 3 + If there's no matching privilege then it returns last token of given privilege. + The api version + The privilege + The display name of given privilege at given api version + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + + Gets the display name of the given privilege. + + 3 + If there's no matching privilege then it returns last token of given privilege. + The api version + The privilege + The type of application package + The display name of given privilege at given api version and the package type + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + + Gets the description of the given privilege. + + 3 + If there's no matching privilege then it returns description string for undefined privilege. + The api version + The privilege + The description of given privilege at given api version + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + + Gets the description of the given privilege. + + 3 + If there's no matching privilege then it returns description string for undefined privilege. + The api version + The privilege + The type of application package + The description of given privilege at given api version and the package type + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + + Gets the display name of the privacy group in which the given privilege is included. + + 3 + The privilege + The privilege must be privacy related. + The privacy group's display name that the given privilege is included in + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + + Gets the status of the given privacy related privilege. + + 3 + The privilege + The privilege must be privacy related. + status true if the privilege is on and false if the privilege is off. + Thrown when there is a null parameter. + Thrown when there is an invalid parameter. + Thrown when out of memory occurs + Thrown when internal error occurs. + + + diff --git a/Artifacts/bin/Tizen.Sensor.dll b/Artifacts/bin/Tizen.Sensor.dll index 78cf527..608f527 100644 Binary files a/Artifacts/bin/Tizen.Sensor.dll and b/Artifacts/bin/Tizen.Sensor.dll differ diff --git a/Artifacts/bin/Tizen.Sensor.pdb b/Artifacts/bin/Tizen.Sensor.pdb index ce9dc83..71594e9 100644 Binary files a/Artifacts/bin/Tizen.Sensor.pdb and b/Artifacts/bin/Tizen.Sensor.pdb differ diff --git a/Artifacts/bin/Tizen.Sensor.xml b/Artifacts/bin/Tizen.Sensor.xml index d8749ac..9900dea 100644 --- a/Artifacts/bin/Tizen.Sensor.xml +++ b/Artifacts/bin/Tizen.Sensor.xml @@ -1,2649 +1,2649 @@ - - - - Tizen.Sensor - - - - - Accelerometer changed event arguments. Class for storing the data returned by accelerometer - - - - - Gets the X component of the acceleration. - - 3 - X - - - - Gets the Y component of the acceleration. - - 3 - Y - - - - Gets the Z component of the acceleration. - - 3 - Z - - - - FaceDownGestureDetector changed event arguments. Class for storing the data returned by face down gesture detector. - - - - - Gets the face down state. - - 3 - Face down state - - - - GravitySensor changed event arguments. Class for storing the data returned by gravity sensor - - - - - Gets the X component of the gravity. - - 3 - X - - - - Gets the Y component of the gravity. - - 3 - Y - - - - Gets the Z component of the gravity. - - 3 - Z - - - - Gyroscope changed event arguments. Class for storing the data returned by gyroscope - - - - - Gets the X component of the gyroscope data. - - 3 - X - - - - Gets the Y component of the gyroscope data. - - 3 - Y - - - - Gets the Z component of the gyroscope data. - - 3 - Z - - - - GyroscopeRotationVectorSensor changed event arguments. Class for storing the data returned by gyroscope rotation vector sensor - - - - - Gets the X component of the gyroscope rotation vector. - - 3 - X - - - - Gets the Y component of the gyroscope rotation vector. - - 3 - Y - - - - Gets the Z component of the gyroscope rotation vector. - - 3 - Z - - - - Gets the W component of the gyroscope rotation vector. - - 3 - W - - - - Gets the accuracy of the gyroscope rotation vector data. - - 3 - Accuracy - - - - HeartRateMonitor changed event arguments. Class for storing the data returned by heart rate monitor - - - - - Gets the value of the heartRate. - - 3 - Heart rate - - - - HumiditySensor changed event arguments. Class for storing the data returned by humidity sensor - - - - - Gets the value of the humidity. - - 3 - Humidity - - - - InVehicleActivityDetector changed event arguments. Class for storing the data returned by in-vehicle activity detector - - - - - Gets the in-vehicle state. - - 3 - In-vehicle state - - - - LightSensor changed event arguments. Class for storing the data returned by light sensor - - - - - Gets the level of the light. - - 3 - Light level - - - - LinearAccelerationSensor changed event arguments. Class for storing the data returned by linear acceleration sensor - - - - - Gets the X component of the linear acceleration. - - 3 - X - - - - Gets the Y component of the linear acceleration. - - 3 - Y - - - - Gets the Z component of the linear acceleration. - - 3 - Z - - - - Magnetometer changed event arguments. Class for storing the data returned by magnetometer sensor - - - - - Gets the X component of the magnetometer. - - 3 - X - - - - Gets the Y component of the magnetometer. - - 3 - Y - - - - Gets the Z component of the magnetometer. - - 3 - Z - - - - MagnetometerRotationVectorSensor changed event arguments. Class for storing the data returned by magnetometer rotation vector sensor - - - - - Gets the X component of the magnetometer rotation vector. - - 3 - X - - - - Gets the Y component of the magnetometer rotation vector. - - 3 - Y - - - - Gets the Z component of the magnetometer rotation vector. - - 3 - Z - - - - Gets the W component of the magnetometer rotation vector. - - 3 - W - - - - Gets the accuracy of the magnetometer rotation vector data. - - 3 - Accuracy - - - - OrientationSensor changed event arguments. Class for storing the data returned by orientation sensor - - - - - Gets the azimuth component of the orientation. - - 3 - Azimuth - - - - Gets the pitch component of the orientation. - - 3 - Pitch - - - - Gets the roll component of the orientation. - - 3 - Roll - - - - Pedometer changed event arguments. Class for storing the data returned by pedometer - - - - - Gets the step count - - 3 - Step count - - - - Gets the walking step count - - 3 - Walk step count - - - - Gets the running step count - - 3 - Run step count - - - - Gets the moving distance - - 3 - Moving distance - - - - Gets the calorie burned - - 3 - Calorie burned - - - - Gets the last speed - - 3 - Last speed - - - - Gets the last stepping frequency - - 3 - Last stepping frequency - - - - Gets the last step status - - 3 - Last stepping status - - - - PickUpGestureDetector changed event arguments. Class for storing the data returned by pick up gesture detector - - - - - Gets the pick up state. - - 3 - Pick up state - - - - PressureSensor changed event arguments. Class for storing the data returned by pressure sensor - - - - - Gets the value of the pressure. - - 3 - Pressure - - - - ProximitySensor changed event arguments. Class for storing the data returned by proximity sensor - - - - - Gets the proximity state. - - 3 - Proximity state - - - - RotationVectorSensor changed event arguments. Class for storing the data returned by rotation vector sensor - - - - - Gets the X component of the rotation vector. - - 3 - X - - - - Gets the Y component of the rotation vector. - - 3 - Y - - - - Gets the Z component of the rotation vector. - - 3 - Z - - - - Gets the W component of the rotation vector. - - 3 - W - - - - Gets the accuracy of the rotation vector data. - - 3 - Accuracy - - - - RunningActivityDetector changed event arguments. Class for storing the data returned by running activity detector - - - - - Gets the running state. - - 3 - Running state - - - - Sensor accuracy changed event arguments Class. Contains the parameters to be returned through accuracy callback - - - - - Gets the time stamp. - - 3 - Time span - - - - Gets the accuracy. - - 3 - Accuracy - - - - SleepMonitor changed event arguments. Class for storing the data returned by sleep monitor - - - - - Gets the value of the sleep state. - - 3 - Sleep state - - - - StationaryActivityDetector changed event arguments. Class for storing the data returned by stationary activity detector - - - - - Gets the stationary state. - - 3 - Stationary state - - - - TemperatureSensor changed event arguments. Class for storing the data returned by temperature sensor - - - - - Gets the value of the temperature. - - 3 - Temperature - - - - UltravioletSensor changed event arguments. Class for storing the data returned by ultraviolet sensor - - - - - Gets the value of the ultraviolet index. - - 3 - Ultraviolet index - - - - UncalibratedGyroscope changed event arguments. Class for storing the data returned by uncalibrated gyroscope - - - - - Gets the X component of the uncalibrated gyroscope data. - - 3 - X - - - - Gets the Y component of the uncalibrated gyroscope data. - - 3 - Y - - - - Gets the Z component of the uncalibrated gyroscope data. - - 3 - Z - - - - Gets the BiasX component of the uncalibrated gyroscope data. - - 3 - X bias - - - - Gets the BiasY component of the uncalibrated gyroscope data. - - 3 - Y bias - - - - Gets the BiasZ component of the uncalibrated gyroscope data. - - 3 - Z bias - - - - UncalibratedMagnetometer changed event arguments. Class for storing the data returned by uncalibrated magnetometer - - - - - Gets the X component of the uncalibrated magnetometer data. - - 3 - X - - - - Gets the Y component of the uncalibrated magnetometer data. - - 3 - Y - - - - Gets the Z component of the uncalibrated magnetometer data. - - 3 - Z - - - - Gets the BiasX component of the uncalibrated magnetometer data. - - 3 - X bias - - - - Gets the BiasY component of the uncalibrated magnetometer data. - - 3 - Y bias - - - - Gets the BiasZ component of the uncalibrated magnetometer data. - - 3 - Z bias - - - - WalkingActivityDetector changed event arguments. Class for storing the data returned by walking activity detector - - - - - Gets the walking state. - - 3 - Walking state - - - - WristUpGestureDetector changed event arguments. Class for storing the data returned by wrist up gesture detector - - - - - Gets the wrist up state. - - 3 - Wrist up state - - - - Accelerometer Sensor Class. Used for registering callbacks for accelerometer and getting accelerometer data - - - - - Gets the X component of the acceleration. - - 3 - X - - - - Gets the Y component of the acceleration. - - 3 - Y - - - - Gets the Z component of the acceleration. - - 3 - Z - - - - Returns true or false based on whether accelerometer sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of accelerometer sensors available on the device. - - 3 - The count of accelerometer sensors - Thrown when the operation is invalid for the current state - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.accelerometer - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in accelerometer sensor data. - - 3 - - - - Activity Detector class for storing common activity information - - - - - Gets the activity accuracy of activity detector - - 3 - Activity accuracy - - - - FaceDownGestureDetector Class. Used for registering callbacks for face down gesture detector and getting the face down state - - - - - Gets the state of the face down gesture. - - 3 - Face down state - - - - Returns true or false based on whether face down gesture detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of face down gesture detectors available on the device. - - 3 - The count of face down gesture detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gesture_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in face down gesture detector data. - - 3 - - - - GravitySensor Class. Used for registering callbacks for gravity sensor and getting gravity data - - - - - Gets the X component of the gravity. - - 3 - X - - - - Gets the Y component of the gravity. - - 3 - Y - - - - Gets the Z component of the gravity. - - 3 - Z - - - - Returns true or false based on whether gravity sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of gravity sensors available on the device. - - 3 - The count of gravity sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gravity - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in gravity sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - Gyroscope Sensor Class. Used for registering callbacks for gyroscope and getting gyroscope data - - - - - Gets the X component of the acceleration. - - 3 - X - - - - Gets the Y component of the acceleration. - - 3 - Y - - - - Gets the Z component of the acceleration. - - 3 - Z - - - - Returns true or false based on whether gyroscope sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of gyroscope sensors available on the device. - - 3 - The count of gyroscope sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gyroscope - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in gyroscope sensor data. - - 3 - - - - GyroscopeRotationVectorSensor Class. Used for registering callbacks for gyroscope rotation vector sensor and getting gyroscope rotation vector data - - - - - Gets the X component of the gyroscope rotation vector. - - 3 - X - - - - Gets the Y component of the gyroscope rotation vector. - - 3 - Y - - - - Gets the Z component of the gyroscope rotation vector. - - 3 - Z - - - - Gets the W component of the gyroscope rotation vector. - - 3 - W - - - - Gets the Accuracy of the gyroscope rotation vector data. - - 3 - Accuracy - - - - Returns true or false based on whether gyroscope rotation vector sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of gyroscope rotation vector sensors available on the device. - - 3 - The count of accelerometer rotation vector sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gyroscope_rotation_vector - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in gyroscope rotation vector sensor data. - - 3 - - - - HeartRateMonitor Class. Used for registering callbacks for heart rate monitor and getting heart rate data - - - - - Gets the value of the heart rate monitor. - - 3 - Heart rate - - - - Returns true or false based on whether heart rate monitor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of heart rate monitors available on the device. - - 3 - The count of heart rate monitors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/privilege/healthinfo - public - http://tizen.org/feature/sensor.heart_rate_monitor - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the app has no privilege to use the sensor - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data. - - 3 - - - - HumiditySensor Class. Used for registering callbacks for humidity sensor and getting humidity data - - - - - Gets the value of the humidity sensor. - - 3 - Humidity - - - - Returns true or false based on whether humidity sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of humidity sensors available on the device. - - 3 - The count of humidity sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.humidity - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in humidity sensor data. - - 3 - - - - InVehicleActivityDetector Class. Used for registering callbacks for in vehicle activity detector and getting the in vehicle state - - - - - Gets the state of in-vehicle activity detector - - 3 - In-vehicle state - - - - Returns true or false based on whether in-vehicle activity detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of in-vehicle activity detectors available on the device. - - 3 - The count of in-vehicle activity detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.activity_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in in-vehicle activity detector data. - - 3 - - - - LightSensor Class. Used for registering callbacks for light sensor and getting light data - - - - - Gets the Level of the light. - - 3 - Light level - - - - Returns true or false based on whether light sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of light sensors available on the device. - - 3 - The count of light sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.photometer - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in light sensor data. - - 3 - - - - LinearAccelerationSensor Class. Used for registering callbacks for linear acceleration sensor and getting linear acceleration data - - - - - Gets the X component of the linear acceleration. - - 3 - X - - - - Gets the Y component of the linear acceleration. - - 3 - Y - - - - Gets the Z component of the linear acceleration. - - 3 - Z - - - - Returns true or false based on whether linear acceleration sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of linear acceleration sensors available on the device. - - 3 - The count of linear acceleration sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.linear_acceleration - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in linear acceleration sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - Magnetometer Class. Used for registering callbacks for magnetometer and getting magnetometer data - - - - - Gets the X component of the magnetometer. - - 3 - X - - - - Gets the Y component of the magnetometer. - - 3 - Y - - - - Gets the Z component of the magnetometer. - - 3 - Z - - - - Returns true or false based on whether magnetometer is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of magnetometers available on the device. - - 3 - The count of magnetometers - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.magnetometer - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in magnetometer data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - MagnetometerRotationVectorSensor Class. Used for registering callbacks for magnetometer rotation vector sensor and getting magnetometer rotation vector data - - - - - Gets the X component of the magnetometer rotation vector. - - 3 - X - - - - Gets the Y component of the magnetometer rotation vector. - - 3 - Y - - - - Gets the Z component of the magnetometer rotation vector. - - 3 - Z - - - - Gets the W component of the magnetometer rotation vector. - - 3 - W - - - - Gets the Accuracy of the magnetometer rotation vector data. - - 3 - Accuracy - - - - Returns true or false based on whether magnetometer rotation vector sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of magnetometer rotation vector sensors available on the device. - - 3 - The count of magnetometer rotation vector sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.geomagnetic_rotation_vector - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in magnetometer rotation vector sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - OrientationSensor Class. Used for registering callbacks for orientation sensor and getting orientation data - - - - - Gets the Azimuth component of the orientation. - - 3 - Azimuth - - - - Gets the Pitch component of the orientation. - - 3 - Pitch - - - - Gets the Roll component of the orientation. - - 3 - Roll - - - - Returns true or false based on whether orientation sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of orientation sensors available on the device. - - 3 - The count of orientation sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.tiltmeter - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in orientation sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - Pedometer Sensor Class. Used for registering callbacks for pedometer and getting pedometer data - - - - - Gets the step count - - 3 - Step count - - - - Gets the walking step count - - 3 - Walk step count - - - - Gets the running step count - - 3 - Run step count - - - - Gets the moving distance - - 3 - Moving distance - - - - Gets the calorie burned - - 3 - Calorie Burned - - - - Gets the last speed - - 3 - Last speed - - - - Gets the last stepping frequency - - 3 - Last stepping frequency - - - - Gets the last step status - - 3 - Last step status - - - - Returns true or false based on whether pedometer sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of pedometer sensors available on the device. - - 3 - The count of pedometer sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/privilege/healthinfo - public - http://tizen.org/feature/sensor.pedometer - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the app has no privilege to use the sensor - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in pedometer sensor data. - - 3 - - - - PickUpGestureDetector Class. Used for registering callbacks for pick up activity detector and getting the pick up state - - - - - Gets the state of the pick up gesture. - - 3 - Pick up state - - - - Returns true or false based on whether pick up gesture detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of pick up gesture detectors available on the device. - - 3 - The count of pick up gesture detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gesture_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in pick up gesture detector data. - - 3 - - - - PressureSensor Class. Used for registering callbacks for pressure sensor and getting pressure data - - - - - Gets the value of the pressure sensor. - - 3 - Pressure - - - - Returns true or false based on whether pressure sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of pressure sensors available on the device. - - 3 - The count of pressure sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.barometer - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in pressure sensor data. - - 3 - - - - ProximitySensor Class. Used for registering callbacks for proximity sensor and getting proximity data - - - - - Gets the proximity state. - - 3 - Proximity state - - - - Returns true or false based on whether proximity sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of proximity sensors available on the device. - - 3 - The count of proximity sensors - - - - Initializes a new instance of the class. - - 3 - 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 - - Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in proximity sensor data. - - 3 - - - - RotationVectorSensor Class. Used for registering callbacks for rotation vector sensor and getting rotation vector data - - - - - Gets the X component of the rotation vector. - - 3 - X - - - - Gets the Y component of the rotation vector. - - 3 - Y - - - - Gets the Z component of the rotation vector. - - 3 - Z - - - - Gets the W component of the rotation vector. - - 3 - W - - - - Gets the Accuracy of the rotation vector data. - - 3 - Accuracy - - - - Returns true or false based on whether rotation vector sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of rotation vector sensors available on the device. - - 3 - The count of rotation vector sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.rotation_vector - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in rotation vector sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - RunningActivityDetector Class. Used for registering callbacks for running activity detector and getting the running state - - - - - Gets the state of running activity detector - - 3 - Running state - - - - Returns true or false based on whether running activity detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of running activity detector available on the device. - - 3 - The count of running activity detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.activity_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in running activity detector data. - - 3 - - - - SleepMonitor Class. Used for registering callbacks for sleep monitor and getting sleep data - - - - - Gets the value of the sleep state. - - 3 - Sleep state - - - - Returns true or false based on whether sleep monitor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of sleep monitors available on the device. - - 3 - The count of sleep monitors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/privilege/healthinfo - public - http://tizen.org/feature/sensor.sleep_monitor - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the app has no privilege to use the sensor - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in sleep monitor data. - - 3 - - - - StationaryActivityDetector Class. Used for registering callbacks for stationary activity detector and getting the stationary state - - - - - Gets the state of stationary activity detector - - 3 - Stationary state - - - - Returns true or false based on whether stationary activity detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of stationary activity detectors available on the device. - - 3 - The count of stationary activity detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.activity_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in stationary activity detector data. - - 3 - - - - TemperatureSensor Class. Used for registering callbacks for temperature sensor and getting temperature data - - - - - Gets the value of the temperature sensor. - - 3 - Temperature (Celsius) - - - - Returns true or false based on whether temperature sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of temperature sensors available on the device. - - 3 - The count of temperature sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.temperature - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in temperature sensor data. - - 3 - - - - UltravioletSensor Class. Used for registering callbacks for ultraviolet sensor and getting ultraviolet data - - - - - Gets the value of the ultraviolet sensor. - - 3 - Ultraviolet index - - - - Returns true or false based on whether ultraviolet sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of ultraviolet sensors available on the device. - - 3 - The count of ultraviolet sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.ultraviolet - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in ultraviolet sensor data. - - 3 - - - - UncalibratedGyroscope Sensor Class. Used for registering callbacks for uncalibrated gyroscope and getting uncalibrated gyroscope data - - - - - Gets the X component of the acceleration. - - 3 - X - - - - Gets the Y component of the acceleration. - - 3 - Y - - - - Gets the Z component of the acceleration. - - 3 - Z - - - - Gets the BiasX component of the uncalibrated gyroscope data. - - 3 - X bias - - - - Gets the BiasY component of the uncalibrated gyroscope data. - - 3 - Y bias - - - - Gets the BiasZ component of the uncalibrated gyroscope data. - - 3 - Z bias - - - - Returns true or false based on whether uncalibrated gyroscope sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of uncalibrated gyroscope sensors available on the device. - - 3 - The count of uncalibrated gyroscope sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.gyroscope.uncalibrated - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in uncalibrated gyroscope sensor data. - - 3 - - - - UncalibratedMagnetometer Sensor Class. Used for registering callbacks for uncalibrated magnetometer and getting uncalibrated magnetometer data - - - - - Gets the X component of the acceleration. - - 3 - X - - - - Gets the Y component of the acceleration. - - 3 - Y - - - - Gets the Z component of the acceleration. - - 3 - Z - - - - Gets the BiasX component of the uncalibrated magnetometer data. - - 3 - X bias - - - - Gets the BiasY component of the uncalibrated magnetometer data. - - 3 - Y bias - - - - Gets the BiasZ component of the uncalibrated magnetometer data. - - 3 - Z bias - - - - Returns true or false based on whether uncalibrated magnetometer sensor is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of uncalibrated magnetometer sensors available on the device. - - 3 - The count of uncalibrated magnetometer sensors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.magnetometer.uncalibrated - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors - - - - - Event Handler for storing the callback functions for event corresponding to change in uncalibrated magnetometer sensor data. - - 3 - - - - Event handler for accuracy changed events. - - 3 - - - - WalkingActivityDetector Class. Used for registering callbacks for walking activity detector and getting the walking state - - - - - Gets the state of walking activity detector - - 3 - Walking state - - - - Returns true or false based on whether walking activity detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of walking activity detectors available on the device. - - 3 - The count of walking activity detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.activity_recognition - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in walking activity gesture detector data. - - 3 - - - - WristUpGestureDetector Class. Used for registering callbacks for wrist up gesture detector and getting the wrist up state - - - - - Gets the state of the wrist up gesture. - - 3 - Wrist up state - - - - Returns true or false based on whether wrist up gesture detector is supported by device. - - 3 - true if supported; otherwise, false. - - - - Returns the number of wrist up gesture detectors available on the device. - - 3 - The count of wrist up gesture detectors - - - - Initializes a new instance of the class. - - 3 - http://tizen.org/feature/sensor.wrist_up - Thrown when an invalid argument is used - Thrown when the sensor is not supported - Thrown when the operation is invalid for the current state - - Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors. - - - - - Event Handler for storing the callback functions for event corresponding to change in wrist up gesture detector data. - - 3 - - - - Sensor class for storing hardware information about a particular sensor - - - - - Property: For getting the name of the sensor - - 3 - The name of sensor - - - - Property: Gets the vendor. - - 3 - The vendor name of sensor - - - - Property: Gets the minimum value of range of sensor data. - - 3 - The lower bound of range of sensor reading - - - - Property: Gets the maximum value of range of sensor data. - - 3 - The upper bound of range of sensor reading - - - - Property: Gets the resolution. - - 3 - The resolution - - - - Property: Gets the minimum interval. - - 3 - The minimum update interval - - - - Property: Gets the fifo count. - - 3 - The size of the hardware FIFO - - - - Property: Gets the maximum batch count. - - 3 - The maximum batch count - - - - Sets the interval of the sensor for sensor data event - Callbacks will be called at frequency of this interval - - 3 - Thrown when the operation is invalid for the current state - The interval of the sensor - - - - Sets the max batch latency for the sensor corresponding to the sensor data event. - - 3 - Thrown when the operation is invalid for the current state - The max batch latency - - - - Sets the pause policy of the sensor. - - 3 - The pause policy - Thrown when the operation is invalid for the current state - The pause policy - - - - Gets or sets the time span. - - 3 - The time span - - - - Indicates whether this sensor is sensing. - - 3 - true if this sensor is sensing; otherwise, false. - - - - Starts the sensor. - After this the event handlers will start receiving events. - - 3 - Thrown when the operation is invalid for the current state - - - - Stop the sensor. - After this the event handlers will stop receiving the events - - 3 - Thrown when the operation is invalid for the current state - - - - The SensorType Enum defintion for all sensor types. - - - - - All sensors. This can be used to retrieve Sensor class object for all available sensors. - - - - - Accelerometer sensor. - - - - - Gravity sensor. - - - - - Linear Acceleration sensor. - - - - - Magnetometer sensor. - - - - - Rotation Vector sensor. - - - - - Orientation sensor. - - - - - Gyroscope sensor. - - - - - Light sensor. - - - - - Proximity sensor. - - - - - Pressure sensor. - - - - - Ultraviolet sensor. - - - - - Temperature sensor. - - - - - Humidity sensor. - - - - - Hear rate monitor sensor. - - - - - Uncalibrated Gyroscope sensor. - - - - - Uncalibrated Geomagnetic sensor. - - - - - Gyroscope-based rotation vector sensor. - - - - - Geomagnetic-based rotation vector sensor. - - - - - Pedometer sensor. - - - - - Sleep monitor sensor. - - - - - Walking activity detector. - - - - - Running activity detector. - - - - - Stationary activity detector. - - - - - InVehicle activity detector. - - - - - Wrist up gesture detector. - - - - - Pick up gesture detector. - - - - - Face down gesture detector. - - - - - Sensor attribute. - - - - - The axis orientation. - - - - - The pause policy. - - - - - SensorDataAccuracy Enum definition for all possible sensor data accuracy Values. - - 3 - - - - Undefined sensor data accuracy. - - 3 - - - - Sensor data not accurate. - - 3 - - - - Moderately accurate sensor data. - - 3 - - - - Highly accurate sensor data. - - 3 - - - - Very highly accurate sensor data. - - 3 - - - - Sensor Option Enum definition for sensor option Values - - 3 - - - - Does not receive data when the LCD is off and in the power save mode. - - 3 - - - - Receives data when the LCD is off. - - 3 - - - - Receives data in the power save mode. - - 3 - - - - Receives data when the LCD is off and in the power save mode. - - 3 - - - - Pedometer state. - - 3 - - - - Unknown. - - 3 - - - - Stop state. - - 3 - - - - Walking state. - - 3 - - - - Running state. - - 3 - - - - Sleep monitor state. - - 3 - - - - Unknown. - - 3 - - - - The wake state. - - 3 - - - - The sleeping state. - - 3 - - - - Proximity sensor state. - - 3 - - - - Unknown. - - 3 - - - - Near sate. - - 3 - - - - Far state. - - 3 - - - - Detector sensor state. - - 3 - - - - Unknown. - - 3 - - - - None sate. - - 3 - - - - Detected state. - - 3 - - - + + + + Tizen.Sensor + + + + + Accelerometer changed event arguments. Class for storing the data returned by accelerometer + + + + + Gets the X component of the acceleration. + + 3 + X + + + + Gets the Y component of the acceleration. + + 3 + Y + + + + Gets the Z component of the acceleration. + + 3 + Z + + + + FaceDownGestureDetector changed event arguments. Class for storing the data returned by face down gesture detector. + + + + + Gets the face down state. + + 3 + Face down state + + + + GravitySensor changed event arguments. Class for storing the data returned by gravity sensor + + + + + Gets the X component of the gravity. + + 3 + X + + + + Gets the Y component of the gravity. + + 3 + Y + + + + Gets the Z component of the gravity. + + 3 + Z + + + + Gyroscope changed event arguments. Class for storing the data returned by gyroscope + + + + + Gets the X component of the gyroscope data. + + 3 + X + + + + Gets the Y component of the gyroscope data. + + 3 + Y + + + + Gets the Z component of the gyroscope data. + + 3 + Z + + + + GyroscopeRotationVectorSensor changed event arguments. Class for storing the data returned by gyroscope rotation vector sensor + + + + + Gets the X component of the gyroscope rotation vector. + + 3 + X + + + + Gets the Y component of the gyroscope rotation vector. + + 3 + Y + + + + Gets the Z component of the gyroscope rotation vector. + + 3 + Z + + + + Gets the W component of the gyroscope rotation vector. + + 3 + W + + + + Gets the accuracy of the gyroscope rotation vector data. + + 3 + Accuracy + + + + HeartRateMonitor changed event arguments. Class for storing the data returned by heart rate monitor + + + + + Gets the value of the heartRate. + + 3 + Heart rate + + + + HumiditySensor changed event arguments. Class for storing the data returned by humidity sensor + + + + + Gets the value of the humidity. + + 3 + Humidity + + + + InVehicleActivityDetector changed event arguments. Class for storing the data returned by in-vehicle activity detector + + + + + Gets the in-vehicle state. + + 3 + In-vehicle state + + + + LightSensor changed event arguments. Class for storing the data returned by light sensor + + + + + Gets the level of the light. + + 3 + Light level + + + + LinearAccelerationSensor changed event arguments. Class for storing the data returned by linear acceleration sensor + + + + + Gets the X component of the linear acceleration. + + 3 + X + + + + Gets the Y component of the linear acceleration. + + 3 + Y + + + + Gets the Z component of the linear acceleration. + + 3 + Z + + + + Magnetometer changed event arguments. Class for storing the data returned by magnetometer sensor + + + + + Gets the X component of the magnetometer. + + 3 + X + + + + Gets the Y component of the magnetometer. + + 3 + Y + + + + Gets the Z component of the magnetometer. + + 3 + Z + + + + MagnetometerRotationVectorSensor changed event arguments. Class for storing the data returned by magnetometer rotation vector sensor + + + + + Gets the X component of the magnetometer rotation vector. + + 3 + X + + + + Gets the Y component of the magnetometer rotation vector. + + 3 + Y + + + + Gets the Z component of the magnetometer rotation vector. + + 3 + Z + + + + Gets the W component of the magnetometer rotation vector. + + 3 + W + + + + Gets the accuracy of the magnetometer rotation vector data. + + 3 + Accuracy + + + + OrientationSensor changed event arguments. Class for storing the data returned by orientation sensor + + + + + Gets the azimuth component of the orientation. + + 3 + Azimuth + + + + Gets the pitch component of the orientation. + + 3 + Pitch + + + + Gets the roll component of the orientation. + + 3 + Roll + + + + Pedometer changed event arguments. Class for storing the data returned by pedometer + + + + + Gets the step count + + 3 + Step count + + + + Gets the walking step count + + 3 + Walk step count + + + + Gets the running step count + + 3 + Run step count + + + + Gets the moving distance + + 3 + Moving distance + + + + Gets the calorie burned + + 3 + Calorie burned + + + + Gets the last speed + + 3 + Last speed + + + + Gets the last stepping frequency + + 3 + Last stepping frequency + + + + Gets the last step status + + 3 + Last stepping status + + + + PickUpGestureDetector changed event arguments. Class for storing the data returned by pick up gesture detector + + + + + Gets the pick up state. + + 3 + Pick up state + + + + PressureSensor changed event arguments. Class for storing the data returned by pressure sensor + + + + + Gets the value of the pressure. + + 3 + Pressure + + + + ProximitySensor changed event arguments. Class for storing the data returned by proximity sensor + + + + + Gets the proximity state. + + 3 + Proximity state + + + + RotationVectorSensor changed event arguments. Class for storing the data returned by rotation vector sensor + + + + + Gets the X component of the rotation vector. + + 3 + X + + + + Gets the Y component of the rotation vector. + + 3 + Y + + + + Gets the Z component of the rotation vector. + + 3 + Z + + + + Gets the W component of the rotation vector. + + 3 + W + + + + Gets the accuracy of the rotation vector data. + + 3 + Accuracy + + + + RunningActivityDetector changed event arguments. Class for storing the data returned by running activity detector + + + + + Gets the running state. + + 3 + Running state + + + + Sensor accuracy changed event arguments Class. Contains the parameters to be returned through accuracy callback + + + + + Gets the time stamp. + + 3 + Time span + + + + Gets the accuracy. + + 3 + Accuracy + + + + SleepMonitor changed event arguments. Class for storing the data returned by sleep monitor + + + + + Gets the value of the sleep state. + + 3 + Sleep state + + + + StationaryActivityDetector changed event arguments. Class for storing the data returned by stationary activity detector + + + + + Gets the stationary state. + + 3 + Stationary state + + + + TemperatureSensor changed event arguments. Class for storing the data returned by temperature sensor + + + + + Gets the value of the temperature. + + 3 + Temperature + + + + UltravioletSensor changed event arguments. Class for storing the data returned by ultraviolet sensor + + + + + Gets the value of the ultraviolet index. + + 3 + Ultraviolet index + + + + UncalibratedGyroscope changed event arguments. Class for storing the data returned by uncalibrated gyroscope + + + + + Gets the X component of the uncalibrated gyroscope data. + + 3 + X + + + + Gets the Y component of the uncalibrated gyroscope data. + + 3 + Y + + + + Gets the Z component of the uncalibrated gyroscope data. + + 3 + Z + + + + Gets the BiasX component of the uncalibrated gyroscope data. + + 3 + X bias + + + + Gets the BiasY component of the uncalibrated gyroscope data. + + 3 + Y bias + + + + Gets the BiasZ component of the uncalibrated gyroscope data. + + 3 + Z bias + + + + UncalibratedMagnetometer changed event arguments. Class for storing the data returned by uncalibrated magnetometer + + + + + Gets the X component of the uncalibrated magnetometer data. + + 3 + X + + + + Gets the Y component of the uncalibrated magnetometer data. + + 3 + Y + + + + Gets the Z component of the uncalibrated magnetometer data. + + 3 + Z + + + + Gets the BiasX component of the uncalibrated magnetometer data. + + 3 + X bias + + + + Gets the BiasY component of the uncalibrated magnetometer data. + + 3 + Y bias + + + + Gets the BiasZ component of the uncalibrated magnetometer data. + + 3 + Z bias + + + + WalkingActivityDetector changed event arguments. Class for storing the data returned by walking activity detector + + + + + Gets the walking state. + + 3 + Walking state + + + + WristUpGestureDetector changed event arguments. Class for storing the data returned by wrist up gesture detector + + + + + Gets the wrist up state. + + 3 + Wrist up state + + + + Accelerometer Sensor Class. Used for registering callbacks for accelerometer and getting accelerometer data + + + + + Gets the X component of the acceleration. + + 3 + X + + + + Gets the Y component of the acceleration. + + 3 + Y + + + + Gets the Z component of the acceleration. + + 3 + Z + + + + Returns true or false based on whether accelerometer sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of accelerometer sensors available on the device. + + 3 + The count of accelerometer sensors + Thrown when the operation is invalid for the current state + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.accelerometer + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular accelerometer sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in accelerometer sensor data. + + 3 + + + + Activity Detector class for storing common activity information + + + + + Gets the activity accuracy of activity detector + + 3 + Activity accuracy + + + + FaceDownGestureDetector Class. Used for registering callbacks for face down gesture detector and getting the face down state + + + + + Gets the state of the face down gesture. + + 3 + Face down state + + + + Returns true or false based on whether face down gesture detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of face down gesture detectors available on the device. + + 3 + The count of face down gesture detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gesture_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular face down gesture detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in face down gesture detector data. + + 3 + + + + GravitySensor Class. Used for registering callbacks for gravity sensor and getting gravity data + + + + + Gets the X component of the gravity. + + 3 + X + + + + Gets the Y component of the gravity. + + 3 + Y + + + + Gets the Z component of the gravity. + + 3 + Z + + + + Returns true or false based on whether gravity sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of gravity sensors available on the device. + + 3 + The count of gravity sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gravity + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular gravity sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in gravity sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + Gyroscope Sensor Class. Used for registering callbacks for gyroscope and getting gyroscope data + + + + + Gets the X component of the acceleration. + + 3 + X + + + + Gets the Y component of the acceleration. + + 3 + Y + + + + Gets the Z component of the acceleration. + + 3 + Z + + + + Returns true or false based on whether gyroscope sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of gyroscope sensors available on the device. + + 3 + The count of gyroscope sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gyroscope + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular gyroscope sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in gyroscope sensor data. + + 3 + + + + GyroscopeRotationVectorSensor Class. Used for registering callbacks for gyroscope rotation vector sensor and getting gyroscope rotation vector data + + + + + Gets the X component of the gyroscope rotation vector. + + 3 + X + + + + Gets the Y component of the gyroscope rotation vector. + + 3 + Y + + + + Gets the Z component of the gyroscope rotation vector. + + 3 + Z + + + + Gets the W component of the gyroscope rotation vector. + + 3 + W + + + + Gets the Accuracy of the gyroscope rotation vector data. + + 3 + Accuracy + + + + Returns true or false based on whether gyroscope rotation vector sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of gyroscope rotation vector sensors available on the device. + + 3 + The count of accelerometer rotation vector sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gyroscope_rotation_vector + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular gyroscope rotation vector sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in gyroscope rotation vector sensor data. + + 3 + + + + HeartRateMonitor Class. Used for registering callbacks for heart rate monitor and getting heart rate data + + + + + Gets the value of the heart rate monitor. + + 3 + Heart rate + + + + Returns true or false based on whether heart rate monitor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of heart rate monitors available on the device. + + 3 + The count of heart rate monitors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/privilege/healthinfo + public + http://tizen.org/feature/sensor.heart_rate_monitor + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the app has no privilege to use the sensor + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular heart rate monitor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in heart rate monitor data. + + 3 + + + + HumiditySensor Class. Used for registering callbacks for humidity sensor and getting humidity data + + + + + Gets the value of the humidity sensor. + + 3 + Humidity + + + + Returns true or false based on whether humidity sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of humidity sensors available on the device. + + 3 + The count of humidity sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.humidity + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular humidity sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in humidity sensor data. + + 3 + + + + InVehicleActivityDetector Class. Used for registering callbacks for in vehicle activity detector and getting the in vehicle state + + + + + Gets the state of in-vehicle activity detector + + 3 + In-vehicle state + + + + Returns true or false based on whether in-vehicle activity detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of in-vehicle activity detectors available on the device. + + 3 + The count of in-vehicle activity detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.activity_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular in-vehicle activity detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in in-vehicle activity detector data. + + 3 + + + + LightSensor Class. Used for registering callbacks for light sensor and getting light data + + + + + Gets the Level of the light. + + 3 + Light level + + + + Returns true or false based on whether light sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of light sensors available on the device. + + 3 + The count of light sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.photometer + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular light sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in light sensor data. + + 3 + + + + LinearAccelerationSensor Class. Used for registering callbacks for linear acceleration sensor and getting linear acceleration data + + + + + Gets the X component of the linear acceleration. + + 3 + X + + + + Gets the Y component of the linear acceleration. + + 3 + Y + + + + Gets the Z component of the linear acceleration. + + 3 + Z + + + + Returns true or false based on whether linear acceleration sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of linear acceleration sensors available on the device. + + 3 + The count of linear acceleration sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.linear_acceleration + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular linear acceleration sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in linear acceleration sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + Magnetometer Class. Used for registering callbacks for magnetometer and getting magnetometer data + + + + + Gets the X component of the magnetometer. + + 3 + X + + + + Gets the Y component of the magnetometer. + + 3 + Y + + + + Gets the Z component of the magnetometer. + + 3 + Z + + + + Returns true or false based on whether magnetometer is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of magnetometers available on the device. + + 3 + The count of magnetometers + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.magnetometer + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular magnetometer in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in magnetometer data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + MagnetometerRotationVectorSensor Class. Used for registering callbacks for magnetometer rotation vector sensor and getting magnetometer rotation vector data + + + + + Gets the X component of the magnetometer rotation vector. + + 3 + X + + + + Gets the Y component of the magnetometer rotation vector. + + 3 + Y + + + + Gets the Z component of the magnetometer rotation vector. + + 3 + Z + + + + Gets the W component of the magnetometer rotation vector. + + 3 + W + + + + Gets the Accuracy of the magnetometer rotation vector data. + + 3 + Accuracy + + + + Returns true or false based on whether magnetometer rotation vector sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of magnetometer rotation vector sensors available on the device. + + 3 + The count of magnetometer rotation vector sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.geomagnetic_rotation_vector + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular magnetometer rotation vector sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in magnetometer rotation vector sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + OrientationSensor Class. Used for registering callbacks for orientation sensor and getting orientation data + + + + + Gets the Azimuth component of the orientation. + + 3 + Azimuth + + + + Gets the Pitch component of the orientation. + + 3 + Pitch + + + + Gets the Roll component of the orientation. + + 3 + Roll + + + + Returns true or false based on whether orientation sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of orientation sensors available on the device. + + 3 + The count of orientation sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.tiltmeter + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular orientation sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in orientation sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + Pedometer Sensor Class. Used for registering callbacks for pedometer and getting pedometer data + + + + + Gets the step count + + 3 + Step count + + + + Gets the walking step count + + 3 + Walk step count + + + + Gets the running step count + + 3 + Run step count + + + + Gets the moving distance + + 3 + Moving distance + + + + Gets the calorie burned + + 3 + Calorie Burned + + + + Gets the last speed + + 3 + Last speed + + + + Gets the last stepping frequency + + 3 + Last stepping frequency + + + + Gets the last step status + + 3 + Last step status + + + + Returns true or false based on whether pedometer sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of pedometer sensors available on the device. + + 3 + The count of pedometer sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/privilege/healthinfo + public + http://tizen.org/feature/sensor.pedometer + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the app has no privilege to use the sensor + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular pedometer sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in pedometer sensor data. + + 3 + + + + PickUpGestureDetector Class. Used for registering callbacks for pick up activity detector and getting the pick up state + + + + + Gets the state of the pick up gesture. + + 3 + Pick up state + + + + Returns true or false based on whether pick up gesture detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of pick up gesture detectors available on the device. + + 3 + The count of pick up gesture detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gesture_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular pick up gesture detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in pick up gesture detector data. + + 3 + + + + PressureSensor Class. Used for registering callbacks for pressure sensor and getting pressure data + + + + + Gets the value of the pressure sensor. + + 3 + Pressure + + + + Returns true or false based on whether pressure sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of pressure sensors available on the device. + + 3 + The count of pressure sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.barometer + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular pressure sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in pressure sensor data. + + 3 + + + + ProximitySensor Class. Used for registering callbacks for proximity sensor and getting proximity data + + + + + Gets the proximity state. + + 3 + Proximity state + + + + Returns true or false based on whether proximity sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of proximity sensors available on the device. + + 3 + The count of proximity sensors + + + + Initializes a new instance of the class. + + 3 + 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 + + Index. Default value for this is 0. Index refers to a particular proximity sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in proximity sensor data. + + 3 + + + + RotationVectorSensor Class. Used for registering callbacks for rotation vector sensor and getting rotation vector data + + + + + Gets the X component of the rotation vector. + + 3 + X + + + + Gets the Y component of the rotation vector. + + 3 + Y + + + + Gets the Z component of the rotation vector. + + 3 + Z + + + + Gets the W component of the rotation vector. + + 3 + W + + + + Gets the Accuracy of the rotation vector data. + + 3 + Accuracy + + + + Returns true or false based on whether rotation vector sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of rotation vector sensors available on the device. + + 3 + The count of rotation vector sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.rotation_vector + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular rotation vector sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in rotation vector sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + RunningActivityDetector Class. Used for registering callbacks for running activity detector and getting the running state + + + + + Gets the state of running activity detector + + 3 + Running state + + + + Returns true or false based on whether running activity detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of running activity detector available on the device. + + 3 + The count of running activity detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.activity_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular running activity detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in running activity detector data. + + 3 + + + + SleepMonitor Class. Used for registering callbacks for sleep monitor and getting sleep data + + + + + Gets the value of the sleep state. + + 3 + Sleep state + + + + Returns true or false based on whether sleep monitor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of sleep monitors available on the device. + + 3 + The count of sleep monitors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/privilege/healthinfo + public + http://tizen.org/feature/sensor.sleep_monitor + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the app has no privilege to use the sensor + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular sleep monitor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in sleep monitor data. + + 3 + + + + StationaryActivityDetector Class. Used for registering callbacks for stationary activity detector and getting the stationary state + + + + + Gets the state of stationary activity detector + + 3 + Stationary state + + + + Returns true or false based on whether stationary activity detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of stationary activity detectors available on the device. + + 3 + The count of stationary activity detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.activity_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular stationary activity detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in stationary activity detector data. + + 3 + + + + TemperatureSensor Class. Used for registering callbacks for temperature sensor and getting temperature data + + + + + Gets the value of the temperature sensor. + + 3 + Temperature (Celsius) + + + + Returns true or false based on whether temperature sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of temperature sensors available on the device. + + 3 + The count of temperature sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.temperature + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular temperature sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in temperature sensor data. + + 3 + + + + UltravioletSensor Class. Used for registering callbacks for ultraviolet sensor and getting ultraviolet data + + + + + Gets the value of the ultraviolet sensor. + + 3 + Ultraviolet index + + + + Returns true or false based on whether ultraviolet sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of ultraviolet sensors available on the device. + + 3 + The count of ultraviolet sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.ultraviolet + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular ultraviolet sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in ultraviolet sensor data. + + 3 + + + + UncalibratedGyroscope Sensor Class. Used for registering callbacks for uncalibrated gyroscope and getting uncalibrated gyroscope data + + + + + Gets the X component of the acceleration. + + 3 + X + + + + Gets the Y component of the acceleration. + + 3 + Y + + + + Gets the Z component of the acceleration. + + 3 + Z + + + + Gets the BiasX component of the uncalibrated gyroscope data. + + 3 + X bias + + + + Gets the BiasY component of the uncalibrated gyroscope data. + + 3 + Y bias + + + + Gets the BiasZ component of the uncalibrated gyroscope data. + + 3 + Z bias + + + + Returns true or false based on whether uncalibrated gyroscope sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of uncalibrated gyroscope sensors available on the device. + + 3 + The count of uncalibrated gyroscope sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.gyroscope.uncalibrated + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular uncalibrated gyroscope sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in uncalibrated gyroscope sensor data. + + 3 + + + + UncalibratedMagnetometer Sensor Class. Used for registering callbacks for uncalibrated magnetometer and getting uncalibrated magnetometer data + + + + + Gets the X component of the acceleration. + + 3 + X + + + + Gets the Y component of the acceleration. + + 3 + Y + + + + Gets the Z component of the acceleration. + + 3 + Z + + + + Gets the BiasX component of the uncalibrated magnetometer data. + + 3 + X bias + + + + Gets the BiasY component of the uncalibrated magnetometer data. + + 3 + Y bias + + + + Gets the BiasZ component of the uncalibrated magnetometer data. + + 3 + Z bias + + + + Returns true or false based on whether uncalibrated magnetometer sensor is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of uncalibrated magnetometer sensors available on the device. + + 3 + The count of uncalibrated magnetometer sensors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.magnetometer.uncalibrated + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular uncalibrated magnetometer sensor in case of multiple sensors + + + + + Event Handler for storing the callback functions for event corresponding to change in uncalibrated magnetometer sensor data. + + 3 + + + + Event handler for accuracy changed events. + + 3 + + + + WalkingActivityDetector Class. Used for registering callbacks for walking activity detector and getting the walking state + + + + + Gets the state of walking activity detector + + 3 + Walking state + + + + Returns true or false based on whether walking activity detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of walking activity detectors available on the device. + + 3 + The count of walking activity detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.activity_recognition + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular walking activity detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in walking activity gesture detector data. + + 3 + + + + WristUpGestureDetector Class. Used for registering callbacks for wrist up gesture detector and getting the wrist up state + + + + + Gets the state of the wrist up gesture. + + 3 + Wrist up state + + + + Returns true or false based on whether wrist up gesture detector is supported by device. + + 3 + true if supported; otherwise, false. + + + + Returns the number of wrist up gesture detectors available on the device. + + 3 + The count of wrist up gesture detectors + + + + Initializes a new instance of the class. + + 3 + http://tizen.org/feature/sensor.wrist_up + Thrown when an invalid argument is used + Thrown when the sensor is not supported + Thrown when the operation is invalid for the current state + + Index. Default value for this is 0. Index refers to a particular wrist up gesture detector in case of multiple sensors. + + + + + Event Handler for storing the callback functions for event corresponding to change in wrist up gesture detector data. + + 3 + + + + Sensor class for storing hardware information about a particular sensor + + + + + Property: For getting the name of the sensor + + 3 + The name of sensor + + + + Property: Gets the vendor. + + 3 + The vendor name of sensor + + + + Property: Gets the minimum value of range of sensor data. + + 3 + The lower bound of range of sensor reading + + + + Property: Gets the maximum value of range of sensor data. + + 3 + The upper bound of range of sensor reading + + + + Property: Gets the resolution. + + 3 + The resolution + + + + Property: Gets the minimum interval. + + 3 + The minimum update interval + + + + Property: Gets the fifo count. + + 3 + The size of the hardware FIFO + + + + Property: Gets the maximum batch count. + + 3 + The maximum batch count + + + + Sets the interval of the sensor for sensor data event + Callbacks will be called at frequency of this interval + + 3 + Thrown when the operation is invalid for the current state + The interval of the sensor + + + + Sets the max batch latency for the sensor corresponding to the sensor data event. + + 3 + Thrown when the operation is invalid for the current state + The max batch latency + + + + Sets the pause policy of the sensor. + + 3 + The pause policy + Thrown when the operation is invalid for the current state + The pause policy + + + + Gets or sets the time span. + + 3 + The time span + + + + Indicates whether this sensor is sensing. + + 3 + true if this sensor is sensing; otherwise, false. + + + + Starts the sensor. + After this the event handlers will start receiving events. + + 3 + Thrown when the operation is invalid for the current state + + + + Stop the sensor. + After this the event handlers will stop receiving the events + + 3 + Thrown when the operation is invalid for the current state + + + + The SensorType Enum defintion for all sensor types. + + + + + All sensors. This can be used to retrieve Sensor class object for all available sensors. + + + + + Accelerometer sensor. + + + + + Gravity sensor. + + + + + Linear Acceleration sensor. + + + + + Magnetometer sensor. + + + + + Rotation Vector sensor. + + + + + Orientation sensor. + + + + + Gyroscope sensor. + + + + + Light sensor. + + + + + Proximity sensor. + + + + + Pressure sensor. + + + + + Ultraviolet sensor. + + + + + Temperature sensor. + + + + + Humidity sensor. + + + + + Hear rate monitor sensor. + + + + + Uncalibrated Gyroscope sensor. + + + + + Uncalibrated Geomagnetic sensor. + + + + + Gyroscope-based rotation vector sensor. + + + + + Geomagnetic-based rotation vector sensor. + + + + + Pedometer sensor. + + + + + Sleep monitor sensor. + + + + + Walking activity detector. + + + + + Running activity detector. + + + + + Stationary activity detector. + + + + + InVehicle activity detector. + + + + + Wrist up gesture detector. + + + + + Pick up gesture detector. + + + + + Face down gesture detector. + + + + + Sensor attribute. + + + + + The axis orientation. + + + + + The pause policy. + + + + + SensorDataAccuracy Enum definition for all possible sensor data accuracy Values. + + 3 + + + + Undefined sensor data accuracy. + + 3 + + + + Sensor data not accurate. + + 3 + + + + Moderately accurate sensor data. + + 3 + + + + Highly accurate sensor data. + + 3 + + + + Very highly accurate sensor data. + + 3 + + + + Sensor Option Enum definition for sensor option Values + + 3 + + + + Does not receive data when the LCD is off and in the power save mode. + + 3 + + + + Receives data when the LCD is off. + + 3 + + + + Receives data in the power save mode. + + 3 + + + + Receives data when the LCD is off and in the power save mode. + + 3 + + + + Pedometer state. + + 3 + + + + Unknown. + + 3 + + + + Stop state. + + 3 + + + + Walking state. + + 3 + + + + Running state. + + 3 + + + + Sleep monitor state. + + 3 + + + + Unknown. + + 3 + + + + The wake state. + + 3 + + + + The sleeping state. + + 3 + + + + Proximity sensor state. + + 3 + + + + Unknown. + + 3 + + + + Near sate. + + 3 + + + + Far state. + + 3 + + + + Detector sensor state. + + 3 + + + + Unknown. + + 3 + + + + None sate. + + 3 + + + + Detected state. + + 3 + + + diff --git a/Artifacts/bin/Tizen.System.Feedback.dll b/Artifacts/bin/Tizen.System.Feedback.dll index b4c0354..241ed05 100644 Binary files a/Artifacts/bin/Tizen.System.Feedback.dll and b/Artifacts/bin/Tizen.System.Feedback.dll differ diff --git a/Artifacts/bin/Tizen.System.Feedback.pdb b/Artifacts/bin/Tizen.System.Feedback.pdb index d71c74a..78094cb 100644 Binary files a/Artifacts/bin/Tizen.System.Feedback.pdb and b/Artifacts/bin/Tizen.System.Feedback.pdb differ diff --git a/Artifacts/bin/Tizen.System.Feedback.xml b/Artifacts/bin/Tizen.System.Feedback.xml index 808c513..b90a48c 100644 --- a/Artifacts/bin/Tizen.System.Feedback.xml +++ b/Artifacts/bin/Tizen.System.Feedback.xml @@ -1,168 +1,168 @@ - - - - Tizen.System.Feedback - - - - - The class for constants. - - - - - The Feedback API provides functions to control haptic and sound. - The Feedback API provides the way to play and stop feedback, and get the information whether a specific pattern is supported. - Below is the supported pattern string: - Tap - SoftInputPanel - Key0 - Key1 - Key2 - Key3 - Key4 - Key5 - Key6 - Key7 - Key8 - Key9 - KeyStar - KeySharp - KeyBack - Hold - HardwareKeyPressed - HardwareKeyHold - Message - Email - WakeUp - Schedule - Timer - General - PowerOn - PowerOff - ChargerConnected - ChargingError - FullyCharged - LowBattery - Lock - UnLock - VibrationModeAbled - SilentModeDisabled - BluetoothDeviceConnected - BluetoothDeviceDisconnected - ListReorder - ListSlider - VolumeKeyPressed - - - For controlling the haptic device: - http://tizen.org/privilege/haptic - For controlling the sound, privilege is not needed. - - - Feedback feedback = new Feedback(); - bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap"); - - - - - Gets the supported information about a specific type and pattern. - - - Now, IsSupportedPattern is not working for FeedbackType.All. - This API is working for FeedbackType.Sound and FeedbackType.Vibration only. - If you use FeedbackType.All for type parameter, this API will throw ArgumentException. - To get the supported information for Vibration type, the application should have http://tizen.org/privilege/haptic privilege. - - 3 - The feedback type. - The feedback pattern string. - Information whether a pattern is supported. - Thrown when failed because the feedback is not initialized. - Thrown when failed because of an invalid arguament. - Thrown when failed becuase the device (haptic, sound) is not supported. - Thrown when failed because the access is not granted (No privilege). - Thrown when failed because of a system error. - http://tizen.org/privilege/haptic - - - Feedback feedback = new Feedback(); - bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap"); - - - - - - Plays a specific feedback pattern. - - - To play Vibration type, app should have http://tizen.org/privilege/haptic privilege. - - 3 - The feedback type. - The feedback pattern string. - Thrown when failed because feedback is not initialized. - Thrown when failed because of an invalid arguament. - Thrown when failed because the device (haptic, sound) or a specific pattern is not supported. - Thrown when failed because the access is not granted(No privilege) - Thrown when failed because of a system error. - http://tizen.org/privilege/haptic - - - Feedback feedback = new Feedback(); - feedback.Play(FeedbackType.All, "Tap"); - - - - - - Stops to play the feedback. - - - To stop vibration, the application should have http://tizen.org/privilege/haptic privilege. - - 3 - Thrown when failed because the feedback is not initialized. - Thrown when failed because of an invalid arguament - Thrown when failed because the device (haptic, sound) or a specific pattern is not supported. - Thrown when failed because the access is not granted (No privilege). - Thrown when failed because of a system error. - http://tizen.org/privilege/haptic - - - Feedback Feedback1 = new Feedback(); - Feedback1.Stop(); - - - - - - String and enumeration for feedback patterns. - - - - - Enumeration for feedback device types. - - 3 - - - - Sound and vibration. - - 3 - - - - Sound feedback. - - 3 - - - - Vibration feedback. - /// - 3 - - - + + + + Tizen.System.Feedback + + + + + The class for constants. + + + + + The Feedback API provides functions to control haptic and sound. + The Feedback API provides the way to play and stop feedback, and get the information whether a specific pattern is supported. + Below is the supported pattern string: + Tap + SoftInputPanel + Key0 + Key1 + Key2 + Key3 + Key4 + Key5 + Key6 + Key7 + Key8 + Key9 + KeyStar + KeySharp + KeyBack + Hold + HardwareKeyPressed + HardwareKeyHold + Message + Email + WakeUp + Schedule + Timer + General + PowerOn + PowerOff + ChargerConnected + ChargingError + FullyCharged + LowBattery + Lock + UnLock + VibrationModeAbled + SilentModeDisabled + BluetoothDeviceConnected + BluetoothDeviceDisconnected + ListReorder + ListSlider + VolumeKeyPressed + + + For controlling the haptic device: + http://tizen.org/privilege/haptic + For controlling the sound, privilege is not needed. + + + Feedback feedback = new Feedback(); + bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap"); + + + + + Gets the supported information about a specific type and pattern. + + + Now, IsSupportedPattern is not working for FeedbackType.All. + This API is working for FeedbackType.Sound and FeedbackType.Vibration only. + If you use FeedbackType.All for type parameter, this API will throw ArgumentException. + To get the supported information for Vibration type, the application should have http://tizen.org/privilege/haptic privilege. + + 3 + The feedback type. + The feedback pattern string. + Information whether a pattern is supported. + Thrown when failed because the feedback is not initialized. + Thrown when failed because of an invalid arguament. + Thrown when failed becuase the device (haptic, sound) is not supported. + Thrown when failed because the access is not granted (No privilege). + Thrown when failed because of a system error. + http://tizen.org/privilege/haptic + + + Feedback feedback = new Feedback(); + bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap"); + + + + + + Plays a specific feedback pattern. + + + To play Vibration type, app should have http://tizen.org/privilege/haptic privilege. + + 3 + The feedback type. + The feedback pattern string. + Thrown when failed because feedback is not initialized. + Thrown when failed because of an invalid arguament. + Thrown when failed because the device (haptic, sound) or a specific pattern is not supported. + Thrown when failed because the access is not granted(No privilege) + Thrown when failed because of a system error. + http://tizen.org/privilege/haptic + + + Feedback feedback = new Feedback(); + feedback.Play(FeedbackType.All, "Tap"); + + + + + + Stops to play the feedback. + + + To stop vibration, the application should have http://tizen.org/privilege/haptic privilege. + + 3 + Thrown when failed because the feedback is not initialized. + Thrown when failed because of an invalid arguament + Thrown when failed because the device (haptic, sound) or a specific pattern is not supported. + Thrown when failed because the access is not granted (No privilege). + Thrown when failed because of a system error. + http://tizen.org/privilege/haptic + + + Feedback Feedback1 = new Feedback(); + Feedback1.Stop(); + + + + + + String and enumeration for feedback patterns. + + + + + Enumeration for feedback device types. + + 3 + + + + Sound and vibration. + + 3 + + + + Sound feedback. + + 3 + + + + Vibration feedback. + /// + 3 + + + diff --git a/Artifacts/bin/Tizen.System.Information.dll b/Artifacts/bin/Tizen.System.Information.dll index 23f6684..d3300d6 100644 Binary files a/Artifacts/bin/Tizen.System.Information.dll and b/Artifacts/bin/Tizen.System.Information.dll differ diff --git a/Artifacts/bin/Tizen.System.Information.pdb b/Artifacts/bin/Tizen.System.Information.pdb index ba57ea3..e0691e0 100644 Binary files a/Artifacts/bin/Tizen.System.Information.pdb and b/Artifacts/bin/Tizen.System.Information.pdb differ diff --git a/Artifacts/bin/Tizen.System.Information.xml b/Artifacts/bin/Tizen.System.Information.xml index 53c9629..66dc2f6 100644 --- a/Artifacts/bin/Tizen.System.Information.xml +++ b/Artifacts/bin/Tizen.System.Information.xml @@ -1,504 +1,504 @@ - - - - Tizen.System.Information - - - - - The structure for CPU usage. - - - - - Running time of un-niced user processes (Percent). - - - - - Running time of kernel processes (Percent). - - - - - Running time of niced user processes (Percent). - - - - - Time waiting for I/O completion (Percent). - - - - - The structure for CPU usage per process. - - - - - The amount of time this process has been scheduled in user mode (clock ticks). - - - - - The amount of time this process has been scheduled in kernel mode (clock ticks). - - - - - Enumeration for the runtime information key. - - - - - Indicates whether Bluetooth is enabled. - - - - - Indicates whether Wi-Fi hotspot is enabled. - - - - - - Indicates whether Bluetooth tethering is enabled. - - - - - Indicates whether USB tethering is enabled. - - - - - Indicates whether packet data through 3G network is enabled. - - - - - Indicates whether data roaming is enabled. - - - - - Indicates whether vibration is enabled. - - - - - Indicates whether audio jack is connected. - - - - - Indicates the current status of GPS. - - - - - - Indicates whether the battery is currently charging. - - - - - Indicates whether TV out is connected. - - - - - Indicates change in the audio jack connector type. - - - - - - Indicates whether the charger is connected. - - - - - Indicates whether auto rotation is enabled. - - - - - Enumeration for the Wi-Fi status. - - - - - The Wi-Fi is disabled. - - - - - The Wi-Fi is enabled and the network connection is not established. - - - - - The network connection is established in a Wi-Fi network. - - - - - Enumeration for the GPS status. - - - - - The GPS is disabled. - - - - - The GPS is searching for satellites. - - - - - The GPS connection is established. - - - - - Enumeration for the type of audio jack connected. - - - - - The audio jack is not connected. - - - - - The 3-conductor wire is connected. - - - - - The 4-conductor wire is connected. - - - - - Memory information. - - - - - Total memory (KiB). - - - - - Used memory (KiB). - - - - - Free memory (KiB). - - - - - Cache memory (KiB). - - - - - Swap memory (KiB). - - - - - Memory information per process. - - - - - Virtual memory size (KiB). - - - - - Resident set size (KiB). - - - - - Proportional set size (KiB). - - - - - Not modified and mapped by other processes (KiB). - - - - - Modified and mapped by other processes (KiB). - - - - - Not modified and available only to that process (KiB). - - - - - Modified and available only to that process (KiB). - - - - - The RuntimeInformation provides functions to obtain the runtime information of various system preferences. - - - - - Validates the data type of the status represented by the runtime key. - Note that this is a generic method. - - 3 - The generic type to validate. - The runtime information key for which the status type is validated. - True if the data type matches. - Thrown when the is invalid. - - - - Gets the status of runtime key. - Note that this is a generic method. - - 3 - The generic type to return. - The runtime information key for which the current should be read. - The current status of the given key.. - Thrown when the is invalid. - Thrown when I/O error occurs while reading from the system. - Thrown when the feature related is not supported. - - - - Gets the system memory information. - - 3 - The system memory information structure. - Thrown when I/O error occurs while reading from the system. - - - - Gets the memory information per process. - - 3 - List of unique process ids. - List of memory information per process. - http://tizen.org/privilege/systemmonitor - Thrown when the is empty. - Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. - Thrown when the memory is not enough to allocate. - Thrown when the caller does not have privilege to use this method. - - - - Gets the system CPU usage time. - - 3 - The system CPU usage time structure. - Thrown when an I/O error occurs while reading from the system. - - - - Gets the CPU usage time per process. - - 3 - List of unique process ids. - List of CPU usage information per process. - http://tizen.org/privilege/systemmonitor - Thrown when the is empty. - Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. - Thrown when the memory is not enough to allocate. - Thrown when the caller does not have privilege to use this method. - - - - Gets the number of processors. - - The number of processors. - Thrown when an I/O error occurs while reading from system. - - - - Gets the current frequency of the processor. - - 3 - The index (from 0) of the CPU core that you want to know the frequency of. - The current frequency(MHz) of processor. - Thrown when the is invalid. - Thrown when an I/O error occurs while reading from system. - Thrown when this system does not store the current CPU frequency. - - - - Gets the max frequency of the processor. - - 3 - The index (from 0) of CPU core that you want to know the frequency of. - The max frequency(MHz) of processor. - Thrown when the is invalid. - Thrown when an I/O error occurs while reading from system. - Thrown when this system does not store the max CPU frequency. - - - - (event) BluetoothEnabled is raised when the system preference for Bluetooth is changed. - - - - - (event) WifiHotspotEnabled is raised when the system preference for Wi-Fi is changed. - - - - - (event) BluetoothTetheringEnabled is raised when the system preference for bluetooth tethering is changed. - - - - - (event) UsbTetheringEnabled is raised when the system preference for USB tethering is changed. - - - - - (event) PacketDataEnabled is raised when the system preference for package data through 3G network is changed. - - - - - (event) DataRoamingEnabled is raised when the system preference for data roaming is changed. - - - - - (event) VibrationEnabled is raised when the system preference for vibration is changed. - - - - - (event) AudioJackConnected is raised when the audio jack is connected/disconnected. - - - - - (event) GpsStatusChanged is raised when the status of GPS is changed. - - - - - (event) BatteryIsCharging is raised when the battery is currently charging. - - - - - (event) TvOutConnected is raised when TV out is connected/disconnected. - - - - - (event) AudioJackConnectorChanged is raised when the audio jack connection changes. - - - - - (event) ChargerConnected is raised when the charger is connected/disconnected. - - - - - (event) AutoRotationEnabled is raised when the system preference for auto rotation is changed. - - - - - RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. - - - - - The key indicating the runtime system preference which was changed. - - - - - System Information class. This class has methods which can be used to obtain device information. - - - - - Checks if the type of value for the given feature is T. - - 3 - Type of value for the feature key. - The name of the feature. - True if type of value for the given feature is T, otherwise false. - - - - Checks if the given key is a valid feature. - - 3 - The name of the feature. - True if the key is valid, otherwise false. - - - - Gets the value of the feature. - - 3 - Type of key value. - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the bool value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the int value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the double value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the string value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - + + + + Tizen.System.Information + + + + + The structure for CPU usage. + + + + + Running time of un-niced user processes (Percent). + + + + + Running time of kernel processes (Percent). + + + + + Running time of niced user processes (Percent). + + + + + Time waiting for I/O completion (Percent). + + + + + The structure for CPU usage per process. + + + + + The amount of time this process has been scheduled in user mode (clock ticks). + + + + + The amount of time this process has been scheduled in kernel mode (clock ticks). + + + + + Enumeration for the runtime information key. + + + + + Indicates whether Bluetooth is enabled. + + + + + Indicates whether Wi-Fi hotspot is enabled. + + + + + + Indicates whether Bluetooth tethering is enabled. + + + + + Indicates whether USB tethering is enabled. + + + + + Indicates whether packet data through 3G network is enabled. + + + + + Indicates whether data roaming is enabled. + + + + + Indicates whether vibration is enabled. + + + + + Indicates whether audio jack is connected. + + + + + Indicates the current status of GPS. + + + + + + Indicates whether the battery is currently charging. + + + + + Indicates whether TV out is connected. + + + + + Indicates change in the audio jack connector type. + + + + + + Indicates whether the charger is connected. + + + + + Indicates whether auto rotation is enabled. + + + + + Enumeration for the Wi-Fi status. + + + + + The Wi-Fi is disabled. + + + + + The Wi-Fi is enabled and the network connection is not established. + + + + + The network connection is established in a Wi-Fi network. + + + + + Enumeration for the GPS status. + + + + + The GPS is disabled. + + + + + The GPS is searching for satellites. + + + + + The GPS connection is established. + + + + + Enumeration for the type of audio jack connected. + + + + + The audio jack is not connected. + + + + + The 3-conductor wire is connected. + + + + + The 4-conductor wire is connected. + + + + + Memory information. + + + + + Total memory (KiB). + + + + + Used memory (KiB). + + + + + Free memory (KiB). + + + + + Cache memory (KiB). + + + + + Swap memory (KiB). + + + + + Memory information per process. + + + + + Virtual memory size (KiB). + + + + + Resident set size (KiB). + + + + + Proportional set size (KiB). + + + + + Not modified and mapped by other processes (KiB). + + + + + Modified and mapped by other processes (KiB). + + + + + Not modified and available only to that process (KiB). + + + + + Modified and available only to that process (KiB). + + + + + The RuntimeInformation provides functions to obtain the runtime information of various system preferences. + + + + + Validates the data type of the status represented by the runtime key. + Note that this is a generic method. + + 3 + The generic type to validate. + The runtime information key for which the status type is validated. + True if the data type matches. + Thrown when the is invalid. + + + + Gets the status of runtime key. + Note that this is a generic method. + + 3 + The generic type to return. + The runtime information key for which the current should be read. + The current status of the given key.. + Thrown when the is invalid. + Thrown when I/O error occurs while reading from the system. + Thrown when the feature related is not supported. + + + + Gets the system memory information. + + 3 + The system memory information structure. + Thrown when I/O error occurs while reading from the system. + + + + Gets the memory information per process. + + 3 + List of unique process ids. + List of memory information per process. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + Gets the system CPU usage time. + + 3 + The system CPU usage time structure. + Thrown when an I/O error occurs while reading from the system. + + + + Gets the CPU usage time per process. + + 3 + List of unique process ids. + List of CPU usage information per process. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + Gets the number of processors. + + The number of processors. + Thrown when an I/O error occurs while reading from system. + + + + Gets the current frequency of the processor. + + 3 + The index (from 0) of the CPU core that you want to know the frequency of. + The current frequency(MHz) of processor. + Thrown when the is invalid. + Thrown when an I/O error occurs while reading from system. + Thrown when this system does not store the current CPU frequency. + + + + Gets the max frequency of the processor. + + 3 + The index (from 0) of CPU core that you want to know the frequency of. + The max frequency(MHz) of processor. + Thrown when the is invalid. + Thrown when an I/O error occurs while reading from system. + Thrown when this system does not store the max CPU frequency. + + + + (event) BluetoothEnabled is raised when the system preference for Bluetooth is changed. + + + + + (event) WifiHotspotEnabled is raised when the system preference for Wi-Fi is changed. + + + + + (event) BluetoothTetheringEnabled is raised when the system preference for bluetooth tethering is changed. + + + + + (event) UsbTetheringEnabled is raised when the system preference for USB tethering is changed. + + + + + (event) PacketDataEnabled is raised when the system preference for package data through 3G network is changed. + + + + + (event) DataRoamingEnabled is raised when the system preference for data roaming is changed. + + + + + (event) VibrationEnabled is raised when the system preference for vibration is changed. + + + + + (event) AudioJackConnected is raised when the audio jack is connected/disconnected. + + + + + (event) GpsStatusChanged is raised when the status of GPS is changed. + + + + + (event) BatteryIsCharging is raised when the battery is currently charging. + + + + + (event) TvOutConnected is raised when TV out is connected/disconnected. + + + + + (event) AudioJackConnectorChanged is raised when the audio jack connection changes. + + + + + (event) ChargerConnected is raised when the charger is connected/disconnected. + + + + + (event) AutoRotationEnabled is raised when the system preference for auto rotation is changed. + + + + + RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. + + + + + The key indicating the runtime system preference which was changed. + + + + + System Information class. This class has methods which can be used to obtain device information. + + + + + Checks if the type of value for the given feature is T. + + 3 + Type of value for the feature key. + The name of the feature. + True if type of value for the given feature is T, otherwise false. + + + + Checks if the given key is a valid feature. + + 3 + The name of the feature. + True if the key is valid, otherwise false. + + + + Gets the value of the feature. + + 3 + Type of key value. + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the bool value of the feature. + + 3 + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the int value of the feature. + + 3 + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the double value of the feature. + + 3 + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the string value of the feature. + + 3 + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + diff --git a/Artifacts/bin/Tizen.System.MediaKey.dll b/Artifacts/bin/Tizen.System.MediaKey.dll index edfe250..aee04af 100644 Binary files a/Artifacts/bin/Tizen.System.MediaKey.dll and b/Artifacts/bin/Tizen.System.MediaKey.dll differ diff --git a/Artifacts/bin/Tizen.System.MediaKey.pdb b/Artifacts/bin/Tizen.System.MediaKey.pdb index 32519fc..06e4e02 100644 Binary files a/Artifacts/bin/Tizen.System.MediaKey.pdb and b/Artifacts/bin/Tizen.System.MediaKey.pdb differ diff --git a/Artifacts/bin/Tizen.System.MediaKey.xml b/Artifacts/bin/Tizen.System.MediaKey.xml index 6c5fbbd..c1e50db 100644 --- a/Artifacts/bin/Tizen.System.MediaKey.xml +++ b/Artifacts/bin/Tizen.System.MediaKey.xml @@ -1,114 +1,114 @@ - - - - Tizen.System.MediaKey - - - - - The class for event arguments of the media key. - - - - - Enumeration for the key value. - - 3 - - - - The play key. - - - - - The stop key. - - - - - The pause key. - - - - - The previous key. - - - - - The next key. - - - - - The fast forward key. - - - - - The rewind key. - - - - - The play-pause key. - - - - - The media key for the earjack. - - - - - The unknown key. - - - - - Enumeration for the key status. - - 3 - - - - The pressed status. - - - - - The released status. - - - - - The unknown status. - - - - - The key value. - - 3 - - - - The key status. - - 3 - - - - The class for receiving events of media keys. - - - - - Adds or removes events for all media keys. - - 3 - Failed to reserve or release the key. - - - + + + + Tizen.System.MediaKey + + + + + The class for event arguments of the media key. + + + + + Enumeration for the key value. + + 3 + + + + The play key. + + + + + The stop key. + + + + + The pause key. + + + + + The previous key. + + + + + The next key. + + + + + The fast forward key. + + + + + The rewind key. + + + + + The play-pause key. + + + + + The media key for the earjack. + + + + + The unknown key. + + + + + Enumeration for the key status. + + 3 + + + + The pressed status. + + + + + The released status. + + + + + The unknown status. + + + + + The key value. + + 3 + + + + The key status. + + 3 + + + + The class for receiving events of media keys. + + + + + Adds or removes events for all media keys. + + 3 + Failed to reserve or release the key. + + + diff --git a/Artifacts/bin/Tizen.System.PlatformConfig.dll b/Artifacts/bin/Tizen.System.PlatformConfig.dll index faa7828..8af66fa 100644 Binary files a/Artifacts/bin/Tizen.System.PlatformConfig.dll and b/Artifacts/bin/Tizen.System.PlatformConfig.dll differ diff --git a/Artifacts/bin/Tizen.System.PlatformConfig.pdb b/Artifacts/bin/Tizen.System.PlatformConfig.pdb index 58c23f7..c78fbd6 100644 Binary files a/Artifacts/bin/Tizen.System.PlatformConfig.pdb and b/Artifacts/bin/Tizen.System.PlatformConfig.pdb differ diff --git a/Artifacts/bin/Tizen.System.PlatformConfig.xml b/Artifacts/bin/Tizen.System.PlatformConfig.xml index 9df0404..08f6a69 100644 --- a/Artifacts/bin/Tizen.System.PlatformConfig.xml +++ b/Artifacts/bin/Tizen.System.PlatformConfig.xml @@ -1,8 +1,8 @@ - - - - Tizen.System.PlatformConfig - - - - + + + + Tizen.System.PlatformConfig + + + + diff --git a/Artifacts/bin/Tizen.System.Storage.dll b/Artifacts/bin/Tizen.System.Storage.dll index 5b15ae6..a04d8e8 100644 Binary files a/Artifacts/bin/Tizen.System.Storage.dll and b/Artifacts/bin/Tizen.System.Storage.dll differ diff --git a/Artifacts/bin/Tizen.System.Storage.pdb b/Artifacts/bin/Tizen.System.Storage.pdb index e516084..a5e79ee 100644 Binary files a/Artifacts/bin/Tizen.System.Storage.pdb and b/Artifacts/bin/Tizen.System.Storage.pdb differ diff --git a/Artifacts/bin/Tizen.System.Storage.xml b/Artifacts/bin/Tizen.System.Storage.xml index d08cda8..92e75d7 100644 --- a/Artifacts/bin/Tizen.System.Storage.xml +++ b/Artifacts/bin/Tizen.System.Storage.xml @@ -1,216 +1,216 @@ - - - - Tizen.System.Storage - - - - - Enumeration for the DirectoryType storage. - - 3 - - - - Image directory. - - 3 - - - - Sounds directory. - - 3 - - - - Videos directory. - - 3 - - - - Camera directory. - - 3 - - - - Downloads directory. - - 3 - - - - Music directory. - - 3 - - - - Documents directory. - - 3 - - - - Others directory. - - 3 - - - - System ringtones directory is only available for an internal storage. - - 3 - - - - The class to access the storage device information. - - - - - StorageStateChanged event. This event is occurred when a storage state changes. - - - The storage state will be updated before calling the event handler. - - 3 - - - myStorage.StorageStateChanged += (s, e) => - { - var storage = s as Storage; - Console.WriteLine(string.Format("State Changed to {0}", storage.State)); - } - - - - - - The storage ID. - - 3 - - - - The type of storage. - - 3 - - - - The root directory for the storage. - - 3 - - - - The total storage size in bytes. - - 3 - - - - The StorageState. - - 3 - - - - The available storage size in bytes. - - 3 - - - - Absolute path for a given directory type in the storage. - - - The returned directory path may not exist, so you must make sure that it exists before using it. - For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege. - For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege. - For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege. - - 3 - Directory type. - Absolute path for a given directory type in the storage. - Thrown when failed because of an invalid argument. - Thrown when failed due to out of memory exception. - Thrown when failed if the storage is not supported or the application does not have the permission to access the directory path. - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/systemsettings - http://tizen.org/privilege/externalstorage - - - // To get the video directories for all the supported storage, - var storageList = StorageManager.Storages as List<Storage>; - foreach (var storage in storageList) - { - string pathForVideoDir = storage.GetAbsolutePath(DirectoryType.Videos); - } - - - - - - Enumeration for the storage area types. - - 3 - - - - Internal device storage (built-in storage in a device, non-removable). - - 3 - - - - External storage. - - 3 - - - - The StorageManager provides the properties or methods to access storage in the device. - - - - - List of all storage in the device. - - 3 - - - - Enumeration for the state of storage devices. - - 3 - - - - The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted. - - 3 - - - - The storage is not present or removed. - - 3 - - - - The storage is mounted with read/write access. - - 3 - - - - The storage is mounted with read-only access. - - 3 - - - + + + + Tizen.System.Storage + + + + + Enumeration for the DirectoryType storage. + + 3 + + + + Image directory. + + 3 + + + + Sounds directory. + + 3 + + + + Videos directory. + + 3 + + + + Camera directory. + + 3 + + + + Downloads directory. + + 3 + + + + Music directory. + + 3 + + + + Documents directory. + + 3 + + + + Others directory. + + 3 + + + + System ringtones directory is only available for an internal storage. + + 3 + + + + The class to access the storage device information. + + + + + StorageStateChanged event. This event is occurred when a storage state changes. + + + The storage state will be updated before calling the event handler. + + 3 + + + myStorage.StorageStateChanged += (s, e) => + { + var storage = s as Storage; + Console.WriteLine(string.Format("State Changed to {0}", storage.State)); + } + + + + + + The storage ID. + + 3 + + + + The type of storage. + + 3 + + + + The root directory for the storage. + + 3 + + + + The total storage size in bytes. + + 3 + + + + The StorageState. + + 3 + + + + The available storage size in bytes. + + 3 + + + + Absolute path for a given directory type in the storage. + + + The returned directory path may not exist, so you must make sure that it exists before using it. + For accessing internal storage except the ringtones directory, the application should have http://tizen.org/privilege/mediastorage privilege. + For accessing ringtones directory, the application should have http://tizen.org/privilege/systemsettings privilege. + For accessing external storage, the application should have http://tizen.org/privilege/externalstorage privilege. + + 3 + Directory type. + Absolute path for a given directory type in the storage. + Thrown when failed because of an invalid argument. + Thrown when failed due to out of memory exception. + Thrown when failed if the storage is not supported or the application does not have the permission to access the directory path. + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/systemsettings + http://tizen.org/privilege/externalstorage + + + // To get the video directories for all the supported storage, + var storageList = StorageManager.Storages as List<Storage>; + foreach (var storage in storageList) + { + string pathForVideoDir = storage.GetAbsolutePath(DirectoryType.Videos); + } + + + + + + Enumeration for the storage area types. + + 3 + + + + Internal device storage (built-in storage in a device, non-removable). + + 3 + + + + External storage. + + 3 + + + + The StorageManager provides the properties or methods to access storage in the device. + + + + + List of all storage in the device. + + 3 + + + + Enumeration for the state of storage devices. + + 3 + + + + The storage is present but cannot be mounted. Typically, it happens if the file system of the storage is corrupted. + + 3 + + + + The storage is not present or removed. + + 3 + + + + The storage is mounted with read/write access. + + 3 + + + + The storage is mounted with read-only access. + + 3 + + + diff --git a/Artifacts/bin/Tizen.System.SystemSettings.dll b/Artifacts/bin/Tizen.System.SystemSettings.dll index c0b7c6b..c531cba 100644 Binary files a/Artifacts/bin/Tizen.System.SystemSettings.dll and b/Artifacts/bin/Tizen.System.SystemSettings.dll differ diff --git a/Artifacts/bin/Tizen.System.SystemSettings.pdb b/Artifacts/bin/Tizen.System.SystemSettings.pdb index af75126..04f0aa5 100644 Binary files a/Artifacts/bin/Tizen.System.SystemSettings.pdb and b/Artifacts/bin/Tizen.System.SystemSettings.pdb differ diff --git a/Artifacts/bin/Tizen.System.SystemSettings.xml b/Artifacts/bin/Tizen.System.SystemSettings.xml index a444c63..526cb9a 100644 --- a/Artifacts/bin/Tizen.System.SystemSettings.xml +++ b/Artifacts/bin/Tizen.System.SystemSettings.xml @@ -1,1039 +1,1039 @@ - - - - Tizen.System.SystemSettings - - - - - The System Settings API provides APIs for sharing the configuration over a system. - - - The System Settings API provides functions for getting the system configuration related to user preferences. - The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and so on. - - - - - The file path of the current ringtone. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The file path of the current home-screen wallpaper. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The file path of the current lock-screen wallpaper. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The current system font size. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The current system font type. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the motion service is activated. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The file path of the current email alert ringtone. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the USB debugging is enabled. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the 3G data network is enabled. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the lock-screen application package name. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The current system default font type (only supports Get). - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. - The country setting is in the ISO 639-2 format, - and the region setting is in the ISO 3166-1 alpha-2 format. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. - The language setting is in the ISO 639-2 format, - and the region setting is in the ISO 3166-1 alpha-2 format. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the 24-hour clock is used. - If the value is false, the 12-hour clock is used. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the current time zone, for example, Pacific/Tahiti. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Once the system changes time, this event occurs to notify the time change. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the device is in the silent mode. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the screen touch sound is enabled on the device. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the rotation control is automatic. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the device name. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the device user has enabled the motion feature. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether Wi-Fi related notifications are enabled on the device. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates whether the device is in the flight mode. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the file path of the current notification tone set by the user. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the time period for notification repetitions. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the current lock state. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The current system ADS ID. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - Indicates the time period for notification repetitions. - - http://tizen.org/privilege/systemsettings.admin - platform - - - - The IncomingCallRingtoneChanged event is triggered when the file path of the incoming ringtone is changed. - - - The IncomingCallRingtoneChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - THe WallpaperHomeScreenChanged event is triggered when the file path of the current home screen wallpaper is changed. - - - The WallpaperHomeScreenChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The WallpaperLockScreenChanged event is triggered when the file path of the current lock screen wallpaper is changed. - - - The WallpaperLockScreenChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The FontSizeChanged event is triggered when the current system font size is changed. - - - The FontSizeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The FontTypeChanged event is triggered when the current system font type is changed. - - - The FontTypeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The MotionActivationChanged event is triggered when the motion service status is changed. - - - The MotionActivationChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The EmailAlertRingtoneChanged event is triggered when the file path of the current email alert ringtone is changed. - - - The EmailAlertRingtoneChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The UsbDebuggingSettingChangedEventArgs event is triggered when the USB debugging status is changed. - - - The UsbDebuggingSettingChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The Data3GNetworkSettingChanged event is triggered when the 3G data network status is changed. - - - The Data3GNetworkSettingChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LockscreenAppChanged event is triggered when the lockscreen application package name is changed. - - - The LockscreenAppChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LocaleCountryChanged event is triggered when the current country setting in the <LANGUAGE>_<REGION> syntax, is changed. - - - The LocaleCountryChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LocaleLanguageChanged event is triggered when the current language setting in the <LANGUAGE>_<REGION> syntax, is changed. - - - The LocaleLanguageChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LocaleTimeFormat24HourChanged event is triggered when the time format is changed. - - - The LocaleTimeFormat24HourChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LocaleTimeZoneChanged event is triggered when the current time zone is changed. - - - The LocaleTimeZoneChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The TimeChanged event is triggered when the system time is changed. - - - The TimeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The SoundLockChanged event is triggered when the screen lock sound enabled status is changed. - - - The SoundLockChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The SoundSilentModeChanged event is triggered when the silent mode status is changed. - - - The SoundSilentModeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - THe SoundTouchChanged event is triggered when the screen touch sound enabled status is changed. - - - The SoundTouchChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The DisplayScreenRotationAutoChanged event is triggered when the automatic rotation control status is changed. - - - The DisplayScreenRotationAutoChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The DeviceNameChanged event is triggered when the device name is changed. - - - The DeviceNameChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The MotionSettingChanged event is triggered when the motion feature enabled status is changed. - - - The MotionSettingChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The NetworkWifiNotificationChanged event is triggered when the WiFi-related notifications enabled status is changed. - - - The NetworkWifiNotificationChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The NetworkFlightModeChanged event is triggered when the flight mode status is changed. - - - The NetworkFlightModeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - THe ScreenBacklightTimeChanged event is triggered when the backlight time is changed. - - - The ScreenBacklightTimeChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The SoundNotificationChanged event is triggered when the file path of the current notification tone set by the user is changed. - - - The SoundNotificationChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The SoundNotificationRepetitionPeriodChanged event is triggered when the time period for notification repetitions is changed. - - - The SoundNotificationRepetitionPeriodChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The LockStateChanged event is triggered when the current lock state is changed. - - - The LockStateChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The AdsIdChanged event is triggered when the current ADS ID state is changed. - - - The AdsIdChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The UltraDataSaveChanged event is triggered when the current Ultra Data Save state is changed. - - - The UltraDataSaveChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - The UltraDataSavePackageListChanged event is triggered when the current ADS ID state is changed. - - - The UltraDataSavePackageListChangedEventArgs object that contains the key and the changed value. - http://tizen.org/privilege/systemsettings.admin - platform - - - - Enumeration for all the available system settings. - - - - - GET (string) The file path of the current ringtone. - - - - - GET (string) The file path of the current home-screen wallpaper. - - - - - GET (string) The file path of the current lock-screen wallpaper. - - - - - GET (int) The current system font size. - - - - - GET (string) The current system font type. - - - - - GET (bool) Indicates whether the motion service is activated. - - - - - GET (string) The file path of the current email alert ringtone. - - - - - GET (bool) Indicates whether the USB debugging is enabled. - - - - - GET (bool) Indicates whether the 3G-data network is enabled. - - - - - GET (string) Indicates the lock-screen application package name. - - - - - GET (string) The current system default font type (only supports Get). - - - - - GET (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. - The country setting is in the ISO 639-2 format, - and the region setting is in the ISO 3166-1 alpha-2 format. - - - - - GET (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. - The language setting is in the ISO 639-2 format, - and the region setting is in the ISO 3166-1 alpha-2 format. - - - - - GET (bool) Indicates whether the 24-hour clock is used. - If the value is false, the 12-hour clock is used. - - - - - GET (string) Indicates the current time zone, for example, Pacific/Tahiti. - - - - - GET (int) Once system changes the time, this event occurs to notify the time change. - - - - - GET (bool) Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. - - - - - GET (bool) Indicates whether the device is in the silent mode. - - - - - GET (bool) Indicates whether the screen touch sound is enabled on the device. - - - - - GET (bool) Indicates whether the rotation control is automatic. - - - - - GET (string) Indicates the device name. - - - - - GET (bool) Indicates whether the device user has the enabled motion feature. - - - - - GET (bool) Indicates whether WiFi-related notifications are enabled on the device. - - - - - GET (bool) Indicates whether the device is in the flight mode. - - - - - GET (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600. - - - - - GET (string) Indicates the file path of the current notification tone set by the user. - - - - - GET (int) Indicates the time period for notification repetitions. - - - - - GET (int) Indicates the current lock state. - - - - - GET (string) Indicates the ADS ID for each device. - - - - - GET (int) Indicates the Ultra Data Save status, one of the #SystemSettingsUdsState values. - - - - - GET (string) Indicates the Ultra Data Save Package List. Since 4.0, the list is a string containing whitelisted package names separated with semicolons (;). - - - - - Enumeration for the Idle Lock State. - - - - - The device is unlocked. - - - - - The device is locked. - - - - - The device is being locked. - - - - - Enumeration for the font size. - - - - - A small size. - - - - - A normal size. - - - - - A large size. - - - - - A huge size. - - - - - A giant size. - - - - - Enumeration for the ultra data save. - - - - - UDS Off. - - - - - UDS On. - - - - - UDS On and the application is whitelisted. - - - - - EventArgs type for the IncomingCallRingtoneChanged event. - - - - - The file path of the current ringtone. - - - - - EventArgs type for the WallpaperHomeScreenChanged event. - - - - - The file path of the current home screen wallpaper. - - - - - EventArgs type for the WallpaperLockScreenChanged event. - - - - - The file path of the current lock screen wallpaper. - - - - - EventArgs type for the FontSizeChanged event. - - - - - The current system font size. - - - - - EventArgs type for the FontTypeChanged event. - - - - - The current system font type. - - - - - EventArgs type for the MotionActivationChanged event. - - - - - Indicates whether the motion service is activated. - - - - - EventArgs type for the EmailAlertRingtoneChanged event. - - - - - The file path of the current email alert ringtone. - - - - - EventArgs type for the UsbDebuggingSettingChanged event. - - - - - Indicates whether the USB debugging is enabled. - - - - - EventArgs type for the Data3GNetworkSettingChanged event. - - - - - Indicates whether the 3G data network is enabled. - - - - - EventArgs type for the LockscreenAppChanged event. - - - - - Indicates the lock screen application package name. - - - - - EventArgs type for the LocaleCountryChanged event. - - - - - Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. - The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format. - - - - - EventArgs type for the LocaleLanguageChanged event. - - - - - Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. - The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format. - - - - - EventArgs type for the LocaleTimeFormat24HourChanged event. - - - - - Indicates whether the 24-hour clock is used. If the value is false, the 12-hour clock is used. - - - - - EventArgs type for the LocaleTimeZoneChanged event. - - - - - Indicates the current time zone. - - - - - EventArgs type for the TimeChanged event. - - - - - Indicates the current time. - - - - - EventArgs type for the SoundLockChanged event. - - - - - Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. - - - - - EventArgs type for the SoundSilentModeChanged event. - - - - - Indicates whether the device is in the silent mode. - - - - - EventArgs type for the SoundTouchChanged event. - - - - - Indicates whether the screen touch sound is enabled on the device. - - - - - EventArgs type for the DisplayScreenRotationAutoChanged event. - - - - - Indicates whether the rotation control is automatic. - - - - - EventArgs type for the DeviceNameChanged event. - - - - - Indicates the device name. - - - - - EventArgs type for the MotionSettingChanged event. - - - - - Indicates whether the device user has enabled the motion feature. - - - - - EventArgs type for the NetworkWifiNotificationChanged event. - - - - - Indicates whether Wi-Fi-related notifications are enabled on the device. - - - - - EventArgs type for the NetworkFlightModeChanged event. - - - - - Indicates whether the device is in the flight mode. - - - - - EventArgs type for the ScreenBacklightTimeChanged event. - - - - - Indicates the backlight time (in seconds). - - - - - EventArgs type for the SoundNotificationChanged event. - - - - - Indicates the file path of the current notification tone set by the user. - - - - - EventArgs type for the SoundNotificationRepetitionPeriodChanged event. - - - - - Indicates the time period for notification repetitions. - - - - - EventArgs type for the LockStateChanged event. - - - - - Indicates the current lock state. - - - - - EventArgs type for the AdsIdChanged event. - - - - - Indicates the current lock state. - - - - - EventArgs type for the UltraDataSaveChanged event. - - - - - Indicates the current lock state. - - - - - EventArgs type for the UltraDataSavePackageListChanged event. - - - - - Indicates the current lock state. - - - - + + + + Tizen.System.SystemSettings + + + + + The System Settings API provides APIs for sharing the configuration over a system. + + + The System Settings API provides functions for getting the system configuration related to user preferences. + The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and so on. + + + + + The file path of the current ringtone. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The file path of the current home-screen wallpaper. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The file path of the current lock-screen wallpaper. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The current system font size. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The current system font type. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the motion service is activated. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The file path of the current email alert ringtone. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the USB debugging is enabled. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the 3G data network is enabled. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the lock-screen application package name. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The current system default font type (only supports Get). + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. + The country setting is in the ISO 639-2 format, + and the region setting is in the ISO 3166-1 alpha-2 format. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. + The language setting is in the ISO 639-2 format, + and the region setting is in the ISO 3166-1 alpha-2 format. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the 24-hour clock is used. + If the value is false, the 12-hour clock is used. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the current time zone, for example, Pacific/Tahiti. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Once the system changes time, this event occurs to notify the time change. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the device is in the silent mode. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the screen touch sound is enabled on the device. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the rotation control is automatic. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the device name. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the device user has enabled the motion feature. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether Wi-Fi related notifications are enabled on the device. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates whether the device is in the flight mode. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the file path of the current notification tone set by the user. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the time period for notification repetitions. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the current lock state. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The current system ADS ID. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + Indicates the time period for notification repetitions. + + http://tizen.org/privilege/systemsettings.admin + platform + + + + The IncomingCallRingtoneChanged event is triggered when the file path of the incoming ringtone is changed. + + + The IncomingCallRingtoneChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + THe WallpaperHomeScreenChanged event is triggered when the file path of the current home screen wallpaper is changed. + + + The WallpaperHomeScreenChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The WallpaperLockScreenChanged event is triggered when the file path of the current lock screen wallpaper is changed. + + + The WallpaperLockScreenChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The FontSizeChanged event is triggered when the current system font size is changed. + + + The FontSizeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The FontTypeChanged event is triggered when the current system font type is changed. + + + The FontTypeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The MotionActivationChanged event is triggered when the motion service status is changed. + + + The MotionActivationChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The EmailAlertRingtoneChanged event is triggered when the file path of the current email alert ringtone is changed. + + + The EmailAlertRingtoneChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The UsbDebuggingSettingChangedEventArgs event is triggered when the USB debugging status is changed. + + + The UsbDebuggingSettingChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The Data3GNetworkSettingChanged event is triggered when the 3G data network status is changed. + + + The Data3GNetworkSettingChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LockscreenAppChanged event is triggered when the lockscreen application package name is changed. + + + The LockscreenAppChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LocaleCountryChanged event is triggered when the current country setting in the <LANGUAGE>_<REGION> syntax, is changed. + + + The LocaleCountryChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LocaleLanguageChanged event is triggered when the current language setting in the <LANGUAGE>_<REGION> syntax, is changed. + + + The LocaleLanguageChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LocaleTimeFormat24HourChanged event is triggered when the time format is changed. + + + The LocaleTimeFormat24HourChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LocaleTimeZoneChanged event is triggered when the current time zone is changed. + + + The LocaleTimeZoneChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The TimeChanged event is triggered when the system time is changed. + + + The TimeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The SoundLockChanged event is triggered when the screen lock sound enabled status is changed. + + + The SoundLockChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The SoundSilentModeChanged event is triggered when the silent mode status is changed. + + + The SoundSilentModeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + THe SoundTouchChanged event is triggered when the screen touch sound enabled status is changed. + + + The SoundTouchChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The DisplayScreenRotationAutoChanged event is triggered when the automatic rotation control status is changed. + + + The DisplayScreenRotationAutoChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The DeviceNameChanged event is triggered when the device name is changed. + + + The DeviceNameChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The MotionSettingChanged event is triggered when the motion feature enabled status is changed. + + + The MotionSettingChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The NetworkWifiNotificationChanged event is triggered when the WiFi-related notifications enabled status is changed. + + + The NetworkWifiNotificationChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The NetworkFlightModeChanged event is triggered when the flight mode status is changed. + + + The NetworkFlightModeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + THe ScreenBacklightTimeChanged event is triggered when the backlight time is changed. + + + The ScreenBacklightTimeChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The SoundNotificationChanged event is triggered when the file path of the current notification tone set by the user is changed. + + + The SoundNotificationChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The SoundNotificationRepetitionPeriodChanged event is triggered when the time period for notification repetitions is changed. + + + The SoundNotificationRepetitionPeriodChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The LockStateChanged event is triggered when the current lock state is changed. + + + The LockStateChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The AdsIdChanged event is triggered when the current ADS ID state is changed. + + + The AdsIdChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The UltraDataSaveChanged event is triggered when the current Ultra Data Save state is changed. + + + The UltraDataSaveChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + The UltraDataSavePackageListChanged event is triggered when the current ADS ID state is changed. + + + The UltraDataSavePackageListChangedEventArgs object that contains the key and the changed value. + http://tizen.org/privilege/systemsettings.admin + platform + + + + Enumeration for all the available system settings. + + + + + GET (string) The file path of the current ringtone. + + + + + GET (string) The file path of the current home-screen wallpaper. + + + + + GET (string) The file path of the current lock-screen wallpaper. + + + + + GET (int) The current system font size. + + + + + GET (string) The current system font type. + + + + + GET (bool) Indicates whether the motion service is activated. + + + + + GET (string) The file path of the current email alert ringtone. + + + + + GET (bool) Indicates whether the USB debugging is enabled. + + + + + GET (bool) Indicates whether the 3G-data network is enabled. + + + + + GET (string) Indicates the lock-screen application package name. + + + + + GET (string) The current system default font type (only supports Get). + + + + + GET (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. + The country setting is in the ISO 639-2 format, + and the region setting is in the ISO 3166-1 alpha-2 format. + + + + + GET (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. + The language setting is in the ISO 639-2 format, + and the region setting is in the ISO 3166-1 alpha-2 format. + + + + + GET (bool) Indicates whether the 24-hour clock is used. + If the value is false, the 12-hour clock is used. + + + + + GET (string) Indicates the current time zone, for example, Pacific/Tahiti. + + + + + GET (int) Once system changes the time, this event occurs to notify the time change. + + + + + GET (bool) Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. + + + + + GET (bool) Indicates whether the device is in the silent mode. + + + + + GET (bool) Indicates whether the screen touch sound is enabled on the device. + + + + + GET (bool) Indicates whether the rotation control is automatic. + + + + + GET (string) Indicates the device name. + + + + + GET (bool) Indicates whether the device user has the enabled motion feature. + + + + + GET (bool) Indicates whether WiFi-related notifications are enabled on the device. + + + + + GET (bool) Indicates whether the device is in the flight mode. + + + + + GET (int) Indicates the backlight time (in seconds). The following values can be used: 15, 30, 60, 120, 300, and 600. + + + + + GET (string) Indicates the file path of the current notification tone set by the user. + + + + + GET (int) Indicates the time period for notification repetitions. + + + + + GET (int) Indicates the current lock state. + + + + + GET (string) Indicates the ADS ID for each device. + + + + + GET (int) Indicates the Ultra Data Save status, one of the #SystemSettingsUdsState values. + + + + + GET (string) Indicates the Ultra Data Save Package List. Since 4.0, the list is a string containing whitelisted package names separated with semicolons (;). + + + + + Enumeration for the Idle Lock State. + + + + + The device is unlocked. + + + + + The device is locked. + + + + + The device is being locked. + + + + + Enumeration for the font size. + + + + + A small size. + + + + + A normal size. + + + + + A large size. + + + + + A huge size. + + + + + A giant size. + + + + + Enumeration for the ultra data save. + + + + + UDS Off. + + + + + UDS On. + + + + + UDS On and the application is whitelisted. + + + + + EventArgs type for the IncomingCallRingtoneChanged event. + + + + + The file path of the current ringtone. + + + + + EventArgs type for the WallpaperHomeScreenChanged event. + + + + + The file path of the current home screen wallpaper. + + + + + EventArgs type for the WallpaperLockScreenChanged event. + + + + + The file path of the current lock screen wallpaper. + + + + + EventArgs type for the FontSizeChanged event. + + + + + The current system font size. + + + + + EventArgs type for the FontTypeChanged event. + + + + + The current system font type. + + + + + EventArgs type for the MotionActivationChanged event. + + + + + Indicates whether the motion service is activated. + + + + + EventArgs type for the EmailAlertRingtoneChanged event. + + + + + The file path of the current email alert ringtone. + + + + + EventArgs type for the UsbDebuggingSettingChanged event. + + + + + Indicates whether the USB debugging is enabled. + + + + + EventArgs type for the Data3GNetworkSettingChanged event. + + + + + Indicates whether the 3G data network is enabled. + + + + + EventArgs type for the LockscreenAppChanged event. + + + + + Indicates the lock screen application package name. + + + + + EventArgs type for the LocaleCountryChanged event. + + + + + Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. + The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format. + + + + + EventArgs type for the LocaleLanguageChanged event. + + + + + Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. + The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format. + + + + + EventArgs type for the LocaleTimeFormat24HourChanged event. + + + + + Indicates whether the 24-hour clock is used. If the value is false, the 12-hour clock is used. + + + + + EventArgs type for the LocaleTimeZoneChanged event. + + + + + Indicates the current time zone. + + + + + EventArgs type for the TimeChanged event. + + + + + Indicates the current time. + + + + + EventArgs type for the SoundLockChanged event. + + + + + Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. + + + + + EventArgs type for the SoundSilentModeChanged event. + + + + + Indicates whether the device is in the silent mode. + + + + + EventArgs type for the SoundTouchChanged event. + + + + + Indicates whether the screen touch sound is enabled on the device. + + + + + EventArgs type for the DisplayScreenRotationAutoChanged event. + + + + + Indicates whether the rotation control is automatic. + + + + + EventArgs type for the DeviceNameChanged event. + + + + + Indicates the device name. + + + + + EventArgs type for the MotionSettingChanged event. + + + + + Indicates whether the device user has enabled the motion feature. + + + + + EventArgs type for the NetworkWifiNotificationChanged event. + + + + + Indicates whether Wi-Fi-related notifications are enabled on the device. + + + + + EventArgs type for the NetworkFlightModeChanged event. + + + + + Indicates whether the device is in the flight mode. + + + + + EventArgs type for the ScreenBacklightTimeChanged event. + + + + + Indicates the backlight time (in seconds). + + + + + EventArgs type for the SoundNotificationChanged event. + + + + + Indicates the file path of the current notification tone set by the user. + + + + + EventArgs type for the SoundNotificationRepetitionPeriodChanged event. + + + + + Indicates the time period for notification repetitions. + + + + + EventArgs type for the LockStateChanged event. + + + + + Indicates the current lock state. + + + + + EventArgs type for the AdsIdChanged event. + + + + + Indicates the current lock state. + + + + + EventArgs type for the UltraDataSaveChanged event. + + + + + Indicates the current lock state. + + + + + EventArgs type for the UltraDataSavePackageListChanged event. + + + + + Indicates the current lock state. + + + + diff --git a/Artifacts/bin/Tizen.System.dll b/Artifacts/bin/Tizen.System.dll index 6e9f04a..3fd7083 100644 Binary files a/Artifacts/bin/Tizen.System.dll and b/Artifacts/bin/Tizen.System.dll differ diff --git a/Artifacts/bin/Tizen.System.pdb b/Artifacts/bin/Tizen.System.pdb index bab1e68..7d9a537 100644 Binary files a/Artifacts/bin/Tizen.System.pdb and b/Artifacts/bin/Tizen.System.pdb differ diff --git a/Artifacts/bin/Tizen.System.xml b/Artifacts/bin/Tizen.System.xml index d0a26d8..963c2ff 100644 --- a/Artifacts/bin/Tizen.System.xml +++ b/Artifacts/bin/Tizen.System.xml @@ -1,473 +1,473 @@ - - - - Tizen.System - - - - - Enumeration for the battery levels. - - 3 - - - - The battery goes empty. - Prepare for the safe termination of the application, - because the device starts a shutdown process soon - after entering this level. - - 3 - - - - The battery charge is at a critical state. - You may have to stop using the multimedia features, - because they are not guaranteed to work correctly - with this battery status. - - 3 - - - - The battery has little charge left. - - 3 - - - - The battery status is not to be careful. - - 3 - - - - The battery status is fully charged. - It means no more charge. - - 3 - - - - The Battery class provides the properties and events for the device battery. - - - The Battery API provides the way to get the current battery capacity value (Percent), - the battery state, and the charging state. It also provides the events for an application - to receive the battery status change events from the device. - To receive the battery event, the application should register with the respective EventHandler. - - - Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging); - Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent); - - - - - Gets the battery charge percentage. - - 3 - It returns an integer value from 0 to 100 that indicates the remaining - battery charge as a percentage of the maximum level. - - - - Gets the current battery level. - - 3 - - - - Gets the current charging state. - - 3 - - - - - - - BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class. - - - - - The current capacity of the battery. - Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level. - - 3 - - - - BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class. - - - - - The level indicates the current battery level status which is a type of the BatteryLevelStatus. - - 3 - - - - BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class. - - - - - The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status. - - 3 - - - - DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class. - - - - - The state indicates the current display state of the device which is an enumeration of the type DisplayState. - - 3 - - - - LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class. - - - - - Brightness indicates the current brightness level of the display as an integer. - - 3 - - - - Enumeration for the available display states. - An application cannot put the device into the power off state or the suspend state. - - 3 - - - - Normal state. - - 3 - - - - Screen dim state. - - 3 - - - - Screen off state. - - 3 - - - - The Display class provides the properties and events to control the display status and brightness. - - - The Display API provides the way to get the current display brightness value, - the display state, and the total number of available displays. - It also provides the events for an application to receive the display state change events from the device. - To receive the display event, the application should register with an associated EventHandler. - - - http://tizen.org/privilege/display - - - Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State); - Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays); - - - - - The number of available display devices. - - 3 - - - - Gets all the available displays. - The display at the index zero is always assigned to the main display. - - 3 - - - - The maximum brightness value that can be set for the specific display. - - 3 - - Display display = Display.Displays[0]; - Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness); - - - - - The brightness value of the display. - - - The brightness value should be less than or equal to the MaxBrightness value. - - 3 - When an invalid parameter value is set. - If the privilege is not set. - - Display display = Display.Displays[0]; - Console.WriteLine("Display current Brightness is: {0}", display.Brightness); - - - - - The current device display state. - - 3 - - - - - The Vibrator class provides the properties and methods to control a vibrator. - - - The Vibrator API provides the way to access the vibrators in the device. - It allows the management of the device's vibrator parameters, such as the vibration count and level. - It provides the methods to vibrate and stop the vibration. - - - http://tizen.org/privilege/haptic - - - Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators); - - - - - Gets the number of the available vibrators. - - 3 - - - - Gets all the available vibrators. - - 3 - - - - Vibrates during the specified time with a constant intensity. - This function can be used to start monotonous vibration for the specified time. - - 3 - The play duration in milliseconds. - The amount of the intensity variation (0 ~ 100). - When an invalid parameter value is set. - If the privilege is not set. - In case of any system error. - In case the device does not support this behavior. - - Vibrator vibrator = Vibrator.Vibrators[0]; - try - { - vibrator.Vibrate(2000, 70); - } - Catch(Exception e) - { - } - - - - - Stops all the vibration effects which are being played. - This function can be used to stop all the effects started by Vibrate(). - - 3 - In case an invalid vibrator instance is used. - If the privilege is not set. - In case of any system error. - In case the device does not support this behavior. - - Vibrator vibrator = Vibrator.Vibrators[0]; - try - { - vibrator.Stop(); - } - Catch(Exception e) - { - } - - - - - Dispose API for closing the internal resources. - This function can be used to stop all the effects started by Vibrate(). - - 3 - - - - The IR API provides the functions to control the IR transmitter. - The IR API provides the way to get the information if IR is available and then transmit the IR command. - - - http://tizen.org/privilege/use_ir - - - Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable); - - - - - Gets the information whether the IR module is available. - - 3 - - - - - The LED class provides the properties and methods to control the attached LED device. - - - The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device. - Related features: - http://tizen.org/feature/led - http://tizen.org/feature/camera.back.flash - It is recommended to design the feature related codes in your application for reliability. - You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application. - - - http://tizen.org/privilege/led - - - Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness); - Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); - - - - - Gets the maximum brightness value of the LED that is located next to the camera. - 3 - When an invalid parameter value is set. - If the privilege is not set. - In case the device does not support this behavior. - - - - - Gets the brightness value of the LED that is located next to the camera. - - The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value. - Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any). - - 3 - When an invalid parameter value is set. - If the privilege is not set. - In case the device does not support this behavior. - - Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); - Tizen.System.Led.Brightness = 50; - Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); - - - - - Plays the LED that is located at the front of the device. - - 3 - Turn on time in milliseconds. - Turn off time in milliseconds. - - The Color value - The first byte means opaque and the other 3 bytes are the RGB values. - - When an invalid parameter value is set. - If the privilege is not set. - In case of any system error. - In case the device does not support this behavior. - - try - { - Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1)); - } - Catch(Exception e) - { - } - - - - - Stops the LED that is located at the front of the device. - - 3 - If the privilege is not set. - In case of any system error. - In case the device does not support this behavior. - - try - { - Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1)); - //wait for a while and stop... - Led.Stop(); - } - Catch(Exception e) - { - } - - - - - StateChanged is raised when the LED state is changed. - - 3 - The source of the event. - LedBrightnessChangedEventArgs is an object that contains the changed brightness. - - - - The Power class provides methods to control the power service. - - - The Power API provides the way to control the power service. - It can be made to hold the specific state to avoid the CPU state internally. - - - http://tizen.org/privilege/display - - - - - Locks the CPU for a specified time. - After the given timeout (in milliseconds), unlock the given lock state automatically. - - - If the process dies, then every lock will be removed. - - 3 - - The positive number in milliseconds or 0 for the permanent lock. - So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero. - - When an invalid parameter value is set. - If the privilege is not set. - In case of any system error. - - Tizen.System.Power.RequestCpuLock(2000); - - - - - Releases the CPU lock state. - - 3 - If the privilege is not set. - In case of any system error. - - Tizen.System.Power.ReleaseCpuLock(); - - - - + + + + Tizen.System + + + + + Enumeration for the battery levels. + + 3 + + + + The battery goes empty. + Prepare for the safe termination of the application, + because the device starts a shutdown process soon + after entering this level. + + 3 + + + + The battery charge is at a critical state. + You may have to stop using the multimedia features, + because they are not guaranteed to work correctly + with this battery status. + + 3 + + + + The battery has little charge left. + + 3 + + + + The battery status is not to be careful. + + 3 + + + + The battery status is fully charged. + It means no more charge. + + 3 + + + + The Battery class provides the properties and events for the device battery. + + + The Battery API provides the way to get the current battery capacity value (Percent), + the battery state, and the charging state. It also provides the events for an application + to receive the battery status change events from the device. + To receive the battery event, the application should register with the respective EventHandler. + + + Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging); + Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent); + + + + + Gets the battery charge percentage. + + 3 + It returns an integer value from 0 to 100 that indicates the remaining + battery charge as a percentage of the maximum level. + + + + Gets the current battery level. + + 3 + + + + Gets the current charging state. + + 3 + + + + + + + BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class. + + + + + The current capacity of the battery. + Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level. + + 3 + + + + BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class. + + + + + The level indicates the current battery level status which is a type of the BatteryLevelStatus. + + 3 + + + + BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class. + + + + + The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status. + + 3 + + + + DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class. + + + + + The state indicates the current display state of the device which is an enumeration of the type DisplayState. + + 3 + + + + LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class. + + + + + Brightness indicates the current brightness level of the display as an integer. + + 3 + + + + Enumeration for the available display states. + An application cannot put the device into the power off state or the suspend state. + + 3 + + + + Normal state. + + 3 + + + + Screen dim state. + + 3 + + + + Screen off state. + + 3 + + + + The Display class provides the properties and events to control the display status and brightness. + + + The Display API provides the way to get the current display brightness value, + the display state, and the total number of available displays. + It also provides the events for an application to receive the display state change events from the device. + To receive the display event, the application should register with an associated EventHandler. + + + http://tizen.org/privilege/display + + + Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State); + Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays); + + + + + The number of available display devices. + + 3 + + + + Gets all the available displays. + The display at the index zero is always assigned to the main display. + + 3 + + + + The maximum brightness value that can be set for the specific display. + + 3 + + Display display = Display.Displays[0]; + Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness); + + + + + The brightness value of the display. + + + The brightness value should be less than or equal to the MaxBrightness value. + + 3 + When an invalid parameter value is set. + If the privilege is not set. + + Display display = Display.Displays[0]; + Console.WriteLine("Display current Brightness is: {0}", display.Brightness); + + + + + The current device display state. + + 3 + + + + + The Vibrator class provides the properties and methods to control a vibrator. + + + The Vibrator API provides the way to access the vibrators in the device. + It allows the management of the device's vibrator parameters, such as the vibration count and level. + It provides the methods to vibrate and stop the vibration. + + + http://tizen.org/privilege/haptic + + + Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators); + + + + + Gets the number of the available vibrators. + + 3 + + + + Gets all the available vibrators. + + 3 + + + + Vibrates during the specified time with a constant intensity. + This function can be used to start monotonous vibration for the specified time. + + 3 + The play duration in milliseconds. + The amount of the intensity variation (0 ~ 100). + When an invalid parameter value is set. + If the privilege is not set. + In case of any system error. + In case the device does not support this behavior. + + Vibrator vibrator = Vibrator.Vibrators[0]; + try + { + vibrator.Vibrate(2000, 70); + } + Catch(Exception e) + { + } + + + + + Stops all the vibration effects which are being played. + This function can be used to stop all the effects started by Vibrate(). + + 3 + In case an invalid vibrator instance is used. + If the privilege is not set. + In case of any system error. + In case the device does not support this behavior. + + Vibrator vibrator = Vibrator.Vibrators[0]; + try + { + vibrator.Stop(); + } + Catch(Exception e) + { + } + + + + + Dispose API for closing the internal resources. + This function can be used to stop all the effects started by Vibrate(). + + 3 + + + + The IR API provides the functions to control the IR transmitter. + The IR API provides the way to get the information if IR is available and then transmit the IR command. + + + http://tizen.org/privilege/use_ir + + + Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable); + + + + + Gets the information whether the IR module is available. + + 3 + + + + + The LED class provides the properties and methods to control the attached LED device. + + + The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device. + Related features: + http://tizen.org/feature/led + http://tizen.org/feature/camera.back.flash + It is recommended to design the feature related codes in your application for reliability. + You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application. + + + http://tizen.org/privilege/led + + + Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness); + Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); + + + + + Gets the maximum brightness value of the LED that is located next to the camera. + 3 + When an invalid parameter value is set. + If the privilege is not set. + In case the device does not support this behavior. + + + + + Gets the brightness value of the LED that is located next to the camera. + + The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value. + Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any). + + 3 + When an invalid parameter value is set. + If the privilege is not set. + In case the device does not support this behavior. + + Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); + Tizen.System.Led.Brightness = 50; + Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); + + + + + Plays the LED that is located at the front of the device. + + 3 + Turn on time in milliseconds. + Turn off time in milliseconds. + + The Color value + The first byte means opaque and the other 3 bytes are the RGB values. + + When an invalid parameter value is set. + If the privilege is not set. + In case of any system error. + In case the device does not support this behavior. + + try + { + Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1)); + } + Catch(Exception e) + { + } + + + + + Stops the LED that is located at the front of the device. + + 3 + If the privilege is not set. + In case of any system error. + In case the device does not support this behavior. + + try + { + Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1)); + //wait for a while and stop... + Led.Stop(); + } + Catch(Exception e) + { + } + + + + + StateChanged is raised when the LED state is changed. + + 3 + The source of the event. + LedBrightnessChangedEventArgs is an object that contains the changed brightness. + + + + The Power class provides methods to control the power service. + + + The Power API provides the way to control the power service. + It can be made to hold the specific state to avoid the CPU state internally. + + + http://tizen.org/privilege/display + + + + + Locks the CPU for a specified time. + After the given timeout (in milliseconds), unlock the given lock state automatically. + + + If the process dies, then every lock will be removed. + + 3 + + The positive number in milliseconds or 0 for the permanent lock. + So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero. + + When an invalid parameter value is set. + If the privilege is not set. + In case of any system error. + + Tizen.System.Power.RequestCpuLock(2000); + + + + + Releases the CPU lock state. + + 3 + If the privilege is not set. + In case of any system error. + + Tizen.System.Power.ReleaseCpuLock(); + + + + diff --git a/Artifacts/bin/Tizen.Tapi.dll b/Artifacts/bin/Tizen.Tapi.dll index dd7967a..53fa9fc 100644 Binary files a/Artifacts/bin/Tizen.Tapi.dll and b/Artifacts/bin/Tizen.Tapi.dll differ diff --git a/Artifacts/bin/Tizen.Tapi.pdb b/Artifacts/bin/Tizen.Tapi.pdb index 5d5591a..4eef42b 100644 Binary files a/Artifacts/bin/Tizen.Tapi.pdb and b/Artifacts/bin/Tizen.Tapi.pdb differ diff --git a/Artifacts/bin/Tizen.Tapi.xml b/Artifacts/bin/Tizen.Tapi.xml index ee13f7a..ba64682 100644 --- a/Artifacts/bin/Tizen.Tapi.xml +++ b/Artifacts/bin/Tizen.Tapi.xml @@ -1,12561 +1,12561 @@ - - - - Tizen.Tapi - - - - - Interop class for Tapi - - - - - Tapi Native Apis - - - - - This class provides functions to manage call related setup and methods. - - - - - A public constructor for Call class to create a Call instance for the given tapi handle. - - The tapi handle. - - - - Setup the call to be dialled asynchronously. - - Information of call type and number. - A task indicating whether the DialCall method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when CallInformation argument is null. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Supports answering the incoming call by accepting or rejecting the call asynchronously. - - Unique handle that refer to the call. - The answer type. - The call id of answer call. This call handle is available to the application through an incoming call(IncomingVoiceCall) event. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - There can be a maximum of one existing call. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Releases the call asynchronously irrespective of whether the call is in the hold or active state. - - Unique handle that refer to the call. - The end call type. - Instance of CallEndData. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - There should be an existing call in the active/hold state. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Puts the given call on hold asynchoronously. - - Unique handle for referring the call. - The call id of hold call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - The call should be in the active state. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Retrieves the call being held asynchoronously. - - Unique handle for referring the call. - The call id of active call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - Call should be in the held state in order to retrieve it into the active state unless no active call is present. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Swaps calls asynchoronously. This is only for calls dialed or answered with Telephony. - - Active call. - Held call. - The call id of swap call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Starts continuous dtmf by sending a single digit during the call asynchronously. - - The dtmf digit to be sent. - A task indicating whether the StartContDtmfCall method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - An active call should be present. This is to be invoked in the following cases: - i. Key Release (post key press) during on-going call. - ii. Dtmf digits passed with PAUSE(,) or WAIT(;). - In case of PAUSE and WAIT, every StartContDtmfCall() call needs to be followed by StopContDtmfCall() sequentially (for every digit) without waiting for response from StartContDtmfCall(). - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Stops continuous dtmf during the call asynchronously. - - A task indicating whether the StopContDtmfCall method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - An active call should be present. This is to be invoked in the following cases: - i. Key Release (post key press) during on-going call. - ii. Dtmf digits passed with PAUSE(,) or WAIT(;). - Every StartContDtmfCall() call needs to be followed by StopContDtmfCall() sequentially. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Send one or more dtmf digits during the call asynchronously. - - A burst dtmf info containing dtmf string, pulse width, and inter digit interval. - A task indicating whether the SendBurstDtmfCall method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - There will be a single asynchronous notification for all the dtmf digits sent. If the users of this API need an asynchronous - response for each dtmf digit then the user has to call this API multiple times passing each single dtmf digit in CallBurstDtmfData. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when CallBurstDtmfData argument is null. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Joins the given two calls (one call in the active conversation state and the other call in the held state) into conference asynchronously. - - Unique handle which is either an active call or a held call. - Unique call handle. - The call id of join call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - For a multiparty call or for joining two calls into conference, there should be one call in the active state and another call in the held state. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Triggers splitting a private call from a multiparty call asynchronously. - - The handle of the call to be made private. The call handle referring to the call that is to be split from the conference. - The call id of split call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - The call should be in a multiparty conference call.The split call will be the active call and the conference call will be the held call. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Triggers making an explicit call transfer by connecting the two parties where one party is being active(active state) and another party is being held(held state) asynchronously. - - The call handle of an active call. - The call id of transferred call. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - - In order to transfer call, served mobile subscriber should have 2 calls, one in the active state and another one in the held state. - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Redirects the incoming call to another subscriber asynchronously. - - Incoming call handle. - The destination number. - A task indicating whether the DeflectCall method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when destinationNumber argument is invalid. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Gets the status of the current call. - - A unique handle for referring the call. - The call status information like destination number, call direction, call type, whether call is in the conference state or not. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Get the list of status of the current call. - - List of CallStatus. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Get the call volume asynchronously. - - The sound device. - The sound type. - Instance of CallVolumeInfo. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Set the call volume asynchronously. - - The call volume information. - A task indicating whether the SetCallVolumeInfo method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when CallVolumeRecord argument is null. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Set the call sound path asynchronously. - - The call sound path information. - A task indicating whether the SetCallSoundPath method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when CallSoundPathInfo argument is null. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Set the call mute state asynchronously. - - The call mute status information. - A task indicating whether the SetCallMuteStatus method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when CallMuteStatusRecord argument is null. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Get the call mute state asynchronously. - - Instance of CallMuteStatusRecord. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Get the voice privacy mode in the phone asynchronously. - - CallPrivacyMode value. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Set the voice privacy mode in the phone asynchronously. It is available only where a call exists. - - Voice privacy option mode value. - A task indicating whether the SetCallPrivacyMode method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Set the preferred voice subscription asynchronously. - - Preferred voice subscription value. - A task indicating whether the SetCallPreferredVoiceSubscription method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Get the preferred voice subscription. - - CallPreferredVoiceSubscription value. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - A class containing information about call idle status notification data. - - - - - Notification id. - - Notificatio id in unsigned integer format. - - - - End cause for the call indicates whether the call is released normally or due to some other cause. - - En cause enum value. - - - - A class which contains calling name information. - - - - - Display mode of the name. - - Enum value for call name mode - - - - Calling party name string. - - String value representing calling party name. - - - - A class which contains details about call information. - - - - - Call handle indicates the handle of the call for the application. - - Call handle represented in unsigned integer format. - - - - Call type. - - Call type indicating whether the requested call is a voice or video call. - - - - Caller number, null terminated ASCII. - - A string representing calling party number. - - - - Call name info. If there is no information from the network, this information will be null. - - A CallerNameInfo which contains information about the calling party name. - - - - CLI mode. - - Enum value representing CLI mode. - - - - No CLI cause. - - Enum value representing the cause for no CLI. - - - - Checks whether the incoming call is a forwarded call or not. - - True or false. If the incoming call is a forwarded call, then true else false. - - - - Current Active Line. - - Enum value representing call active line. - - - - A class which contains information about call line control. - - - - - Polarity included. - - Polarity value represented in byte format. - - - - Toggle mode. - - Toggle mode represented in byte format. - - - - Reverse polarity. - - Reverse polarity value represented in byte format. - - - - Power denial time. - - Time value in byte which represents power denial time. - - - - A class which contains information about call record. - - - - - Call id - - Call id which is represented in unsigned integer format. - - - - Call record type. - - An enum value representing the call record type. - - - - Name record. - - - This value will be filled only if CallRecordType is Name, otherwise it is null. - - Name record represented in string. - - - - Number record. - - - This value will be filled only if CallRecordType is Record, otherwise it is null. - - Number record reprensented in string. - - - - Gets the line control info. - - - This value will be filled only if CallRecordType is LineControl, otherwise it is null. - - An instance of CallRecordLineControl class. - - - - A class which contains information about call signal notification. - - - - - Gets the call signal type. - - Signal type of the call represented as CallAlertSignal enum. - - - - Gets the call pitch type. - - Pitch type of the call represented as CallAlertPitch enum. - - - - Gets the call signal tone type. - - - This value will be filled only if SignalType is Tone. - - Signal tone type of the call represented in CallToneSignal enum. - - - - Gets the signal ISDN Alert type. - - - This value will be filled only if SignalType is IsdnAlert. - - Signal ISDN alert type of the call represented in CallIsdnAlertSignal enum. - - - - Gets the signal IS54B alert type. - - - This value will be filled only if SignalType is Is54bAlert. - - Signal IS54B alerty type of the call represented in CallIs54bAlertSignal enum. - - - - A class which contains information about call upgrade/downgrade request of VoLTE call. - - - - - Gets the call handle. - - Call handle value represented in integer format. - - - - Gets the call upgrade/downgrade config type. - - Call upgrade/downgrade type represented in CallConfigType enum. - - - - A class which contains information about an outgoing call. - - - - - A parameterized constructor of CallInformation. - - Type of call(voice, data, video, emergency). - Emergency category. - Destination phone number. - - - - A class which contains information about call end response data. - - - - - End type. - - - - - Id. - - - - - A class which contains information about burst DTMF in CDMA. - - - - - A parameterized constructor of CallBurstDtmfData. - - Burst DTMF string. - DTMF Pulse Width. - DTMF Inter Digit Interval. - - - - A class which contains information about call status. - - - - - Call handle. - - - - - Status will be true for MO calls. If MT call, then its false. - - - - - Mobile number. - - - - - Type of call(voice, data, emergency). - - - - - Current call state. - - - - - Whether call is in conference state. - - - - - Whether call is volte call. - - - - - A class that contains call volume info. - - - - - A parameterized constructor of CallVolumeRecord. - - Call sound device. - Call sound type. - Call sound volume. - - - - Call sound device info. - - - - - Call sound type info. - - - - - Call sound volume info. - - - - - A class which contains call volume info reponse data. - - - - - Record number. - - - - - Volume info record. - - - - - A class which contains call sound path and volume information. - - - - - A parameterized constructor of CallSoundPathInfo. - - Sound path. - Extra volume status. - - - - A class which contains call mute status reponse data. - - - - - A parameterized constructor of CallMuteStatusRecord. - - Mute path. - Mute status. - - - - Enumeration for call end cause. - - - - - No Cause. - - - - - Unassigned Number. - - - - - No Route to Destination. - - - - - Channel Unacceptable. - - - - - Operator Determined Barring. - - - - - Normal Call Clearing. - - - - - User Busy. - - - - - No user responding. - - - - - User Alerting no Answer. - - - - - Call Rejected. - - - - - Number Changed. - - - - - Non Selected User Clearing. - - - - - Destination out of Order. - - - - - Invalid Number Format. - - - - - Facility Rejected. - - - - - Response to Status Enquiry. - - - - - Normal Unspecified. - - - - - No Circuit Channel Available. - - - - - Network out of Order. - - - - - Temporary Failure. - - - - - Switching Equipment Congestion. - - - - - Access Information Discarded. - - - - - Requested Circuit channel not available. - - - - - Resources unavailable and unspecified. - - - - - Quality of service unavailable. - - - - - Requested facility not subscribed. - - - - - Incoming call barred within CUG. - - - - - Bearer capability not Authorised. - - - - - Bearer capability not presently Available. - - - - - Service or Option not available. - - - - - Service not implemented. - - - - - ACM GEQ ACMAX. - - - - - Requested facility not implemented. - - - - - Restricted digital info BC not available - - - - - Service or Option not Implemented. - - - - - Transaction ID value. - - - - - Not a member of CUG. - - - - - Incompatible Destination. - - - - - Transit Network selection. - - - - - Semantically Incorrect message. - - - - - Invalid Mandatory Message. - - - - - Message Type Non Existent. - - - - - Message type not compatible with Prot state. - - - - - IE non exitent or not implemented. - - - - - Conditional IE error. - - - - - Not Compatible with protocol state. - - - - - Recovery on timer expiry. - - - - - Protocol error unspecified. - - - - - Interworking unspecified. - - - - - Reorder. - - - - - End unspecified. - - - - - IMSI unknown in HLR. - - - - - Illegal MS. - - - - - IMSI unknown in VLR. - - - - - IMEI not accepted. - - - - - Illegal ME. - - - - - GPRS service not allowed. - - - - - GPRS services and Non-GPRS services not allowed. - - - - - MS device cannot be derived by the network. - - - - - Implicitly detached. - - - - - PLMN not allowed. - - - - - LA not allowed. - - - - - National roaming not allowed. - - - - - GPRS services not allowed in this PLMN. - - - - - No suitable cells in the LA. - - - - - MSC temporarily not reachable. - - - - - Network unavailable. - - - - - MAC failure. - - - - - SYNCH failure. - - - - - Congestion. - - - - - GSM Auth unaccepted. - - - - - Service option not supported. - - - - - REQ_SERV option not suscribed. - - - - - Service OPT out of order. - - - - - Call cannot be identified. - - - - - No PDP context Activated. - - - - - Retry upon entry into a new call min value. - - - - - Retry upon entry into a new call max value. - - - - - Semantically incorret message. - - - - - Invalid mandatory information. - - - - - Message type non-existant. - - - - - Message type not COMP PRT ST. - - - - - IE non existent. - - - - - MSG not compatible protocol state. - - - - - REJ unspecified. - - - - - RR release indication. - - - - - Random Access Failure. - - - - - RRC release indication. - - - - - RRC close session indication. - - - - - RRC open session failure. - - - - - Low level failure. - - - - - Low level failure redial not alowed. - - - - - Low level immediate retry. - - - - - Invalid SIM. - - - - - No service. - - - - - Timer T3230 expiry. - - - - - No cell available. - - - - - Wrong state. - - - - - Access class blocked. - - - - - Abort Message received. - - - - - Other cause. - - - - - Timer T303 expiry. - - - - - Rejected due to unavailibilty of resources. - - - - - MM release pending. - - - - - Invalid user data. - - - - - Maximum End Cause limit for GSM/WCDMA. - - - - - Call Released by User. - - - - - Call Released by Network. - - - - - Call Released because the network is busy. - - - - - Call Released because of No Service area. - - - - - Call Released because of Fading. - - - - - Call Released because of reorder. - - - - - Call Released because of intercept. - - - - - Call Released because of silent zone retry. - - - - - Call Released because of OTA call failure. - - - - - Call Released because phone is offline. - - - - - Call Released because CDMA is locked. - - - - - Call Released because of the flash-is-in-progress error. - - - - - Call Released because of the e911 mode. - - - - - Call Released by Others. - - - - - Maximum End Cause limit for CDMA. - - - - - Enumeration for call type to be used by applications. - - - - - Voice call type. - - - - - Data call type - (for modem, fax, packet, and other such calls). - - - - - Emergency call type. - - - - - Enumeration for the call name mode. - - - - - This identifier refers to presenting the calling party's name identity to the called party. - - - - - This identifier refers to restricting the name identity of the calling party from being presented to the called party. - - - - - This identifier refers to the unavailability of the calling party's name identity from being offered to the called party. - - - - - This identifier refers to offering the calling party's name identity to the called party with which the presentation restriction is overridden. - - - - - Enumeration for the "Cli mode" value. - - - - - Presentation Allowed. - - - - - Presentation Restricted. - - - - - Number not available. - - - - - Presentation default. - - - - - Enumeration for "No Cli cause" value. - - - - - None. - - - - - Unavailable. - - - - - Rejected by user. - - - - - Other services. - - - - - Coin line phone. - - - - - Enumeration for call active line(IN GSM ONLY: call identification number). - - - - - Line 1. - - - - - Line 2. - - - - - Enumeration for the call record info type. - - - - - Name type. - - - - - Number type. - - - - - Line control type. - - - - - Enumeration for the voice privacy option mode. (CDMA only). - - - - - Standard mode. - - - - - Enhanced mode. - - - - - Enumeration for the OTASP Status. (CDMA only) - - - - - SPL unlocked ok. - - - - - A-Key excess ok. - - - - - SSD update ok. - - - - - NAM download ok. - - - - - MDN download ok. - - - - - IMSI download ok. - - - - - PRL download ok. - - - - - Commit ok. - - - - - Programming ok. - - - - - Success. - - - - - Unsuccess. - - - - - OTAPA verify ok. - - - - - Progress. - - - - - SPC excess failure. - - - - - Lock code password set. - - - - - Enumeration for the OTAPA status. (CDMA only) - - - - - Stop. - - - - - Start. - - - - - Enumeration for call sound path. - - - - - Audio path is handset. - - - - - Audio path is handset. - - - - - Audio path is Handsfree. - - - - - Audio path is bluetooth. - - - - - Audio path is stereo bluetooth. - - - - - Audio path is speaker phone. - - - - - Audio path is headset_3_5PI. - - - - - Audio path Bluetooth NSEC is off. - - - - - Audio path Mic one. - - - - - Audio path Bluetooth Mic two. - - - - - Audio path is Bluetooth WB. - - - - - Audio path is BT nsec off WB. - - - - - Audio path is headset HAC. - - - - - Audio path is Bikemode Near. - - - - - Audio path is Bikemode Far. - - - - - Audio path is VoLTE handset. - - - - - Audio path is VoLTE headset. - - - - - Audio path is VoLTE Handsfree. - - - - - Audio path is VoLTE bluetooth. - - - - - Audio path is VoLTE stereo bluetooth. - - - - - Audio path is VoLTE speaker phone. - - - - - Audio path is VoLTE headset_3_5PI. - - - - - Audio path VoLTE Bluetooth NSEC is off. - - - - - Audio path is VoLTE Bluetooth WB. - - - - - Audio path is VoLTE BT nsec off WB. - - - - - Audio path is VoLTE handset HAC. - - - - - Audio path is call forwarding. - - - - - Audio path is Loopback Mic1+Ear. - - - - - Audio path is Loopback Mic2+Ear. - - - - - Audio path is Loopback Mic3+Ear. - - - - - Enumeration for the Alert Signal Type. (CDMA only) - - - - - Tone. - - - - - ISDN Alerting. - - - - - IS54B Alerting. - - - - - Reserved. - - - - - Enumeration for the Alert Pitch Type. (CDMA only) - - - - - Alert Pitch Medium. - - - - - Alert Pitch High. - - - - - Alert Pitch Low. - - - - - Reserved. - - - - - Enumeration for the signals specific to the alert signal type. (CDMA only) - - - - - Dial. - - - - - Ringback Tone ON. - - - - - Intercept Tone ON. - - - - - Abbreviation Tone. - - - - - Network Congestion Tone ON. - - - - - Abbreviation Network Congestion. - - - - - Busy Tone ON> - - - - - CFRM Tone ON. - - - - - Answer Tone ON. - - - - - Call Waiting Tone ON. - - - - - Pipe Tone ON. - - - - - Tone OFF. - - - - - Enumeration for the call ISDN Alert signal. (CDMA only) - - - - - Normal. - - - - - Inter group. - - - - - Special Priority. - - - - - ISDN Reserved1. - - - - - Ping Ring. - - - - - ISDN Reserved2. - - - - - ISDN Reserved3. - - - - - ISDN Reserved4. - - - - - Alert OFF. - - - - - Enumeration for the call IS54B Alert signal types. - - - - - No Tone. - - - - - Long. - - - - - Short Short. - - - - - Short Short Long. - - - - - Short Short 2. - - - - - Short Long Short. - - - - - Short Short Short Short. - - - - - PBX Long. - - - - - PBX(Private Branch Exchange) Short Short. - - - - - PBX Short Short Long. - - - - - PBX Short Long Short. - - - - - PBX Short Short Short Short. - - - - - PIP PIP PIP PIP. - - - - - Enumeration for call sound ringback tone notification data. - - - - - Ringback Tone End. - - - - - Ringback Tone Start. - - - - - Enumeration for call sound WBAMR notification data. - - - - - Status OFF. - - - - - Status ON. - - - - - Status OFF 16k. - - - - - Status ON 8k. - - - - - Enumeration for call sound noise reduction. - - - - - Sound noise reduction off. - - - - - Sound noise reduction on. - - - - - Enumeration for call preferred voice subscription. - - - - - Unknown status. - - - - - Current network. - - - - - Ask Always. - - - - - Sim 1. - - - - - Sim 2. - - - - - Enumeration for specifying type for call upgrade/downgrade. - - - - - Call type is invalid. - - - - - Call type is Audio. - - - - - Call type is Video Share TX. - - - - - Call type is Video Share RX. - - - - - Call type is Inbound Video Call. - - - - - Call type is HD Video. - - - - - Call type is Video Conference. - - - - - Call type is QCIF Video Conference. - - - - - Call type is QVGA. - - - - - Call type is QCIF Video. - - - - - Call type is tty Full. - - - - - Call type is tty HCO. - - - - - Call type is tty VCO. - - - - - Call type USSD. - - - - - Call type is HDVideo Land. - - - - - Call type is E911 - Emergency Call. - - - - - Call type is Audio conference. - - - - - Call type is E911 Emergency video call. - - - - - Call type is E911 Emergency video call HD. - - - - - Call type is E911 Emergency video call HD Land. - - - - - Call type is E911 Emergency video call Land. - - - - - Call type is E911 Emergency video call HD QVGA Land. - - - - - Call type is CIF Video Call. - - - - - Call type is HD 720 video call. - - - - - Call type is E911 video hold call. - - - - - Call type is switch VOIP to VT call. - - - - - Enumeration for the emergency call category type. - - - - - Default case - - - - - Police emergency - - - - - Ambulance emergency - - - - - Firebrigade emergency - - - - - Marineguard emergency - - - - - Mountain rescue emergency - - - - - Manual emergency call - - - - - Automatic emergency call - - - - - Unspecified emergency - - - - - Enumeration for the call answer type. - - - - - Answer an incoming call when there are no current active calls. - - - - - Reject the incoming call. - - - - - Release current active call and accept the waiting call. - - - - - Hold the current active call, and accept the waiting call. - - - - - Enumeration for the call end type. - - - - - End specific call. - - - - - End all calls. - - - - - End all active calls. - - - - - End all held calls. - - - - - Enumeration for the onlength to send DTMF. - - - - - 95 ms. - - - - - 150 ms. - - - - - 200 ms. - - - - - 250 ms. - - - - - 300 ms. - - - - - 350 ms. - - - - - Sms. - - - - - Enumeration for the offlength to send DTMF. - - - - - 60 ms. - - - - - 100 ms. - - - - - 150 ms. - - - - - 200 ms. - - - - - Enumeration for call states. - - - - - Idle state - i.e. no call. - - - - - Connected and conversation state. - - - - - Held State. - - - - - Dialing state. - - - - - Alerting state. - - - - - Incoming state. - - - - - Answered state, and waiting for connected indication event. - - - - - Unknown state. - - - - - Enumeration for call sound device type. - - - - - Device type receiver. - - - - - Device type speaker. - - - - - Device type handsfree. - - - - - Device type headset. - - - - - Device type bluetooth. - - - - - Device type external. - - - - - Enumeration for call sound type. - - - - - Sound type voice. - - - - - Sound type keytone. - - - - - Sound type bell. - - - - - Sound type message - - - - - Sound type alarm - - - - - Sound type PDA miscellaneous. - - - - - Enumeration for call sound volume level. - - - - - Sound is mute. - - - - - Volume level is 1. - - - - - Volume level is 2. - - - - - Volume level is 3. - - - - - Volume level is 4. - - - - - Volume level is 5. - - - - - Volume level is 6. - - - - - Volume level is 7. - - - - - Volume level is 8. - - - - - Volume level is 9. - - - - - Enumeration for call extra volume. - - - - - Off. - - - - - On. - - - - - Enumeration for call sound mute status. - - - - - Off. - - - - - On. - - - - - Enumeration for call sound mute path. - - - - - Transmit. - - - - - Receiver. - - - - - All. - - - - - This class provides functions for modem services. - - - - - A public constructor for Modem class to create a Modem instance for the given tapi handle. - - The tapi handle. - - - - Turn the modem on/off asynchronously. - - Power command value. - A task indicating whether the ProcessPowerCommand method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Switch the flight mode on/off asynchronously. - - Flight mode request value. - A task indicating whether the SetFlightMode method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Get the flight mode asynchronously. - - If flight mode is On, it returns true else it returns false. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Get Me version information asynchronously. - - Instance of MiscVersionInformation. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Misc me version information. - - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Returns null in case of failure. - - - - Get the Me Esn/Meid for each phone type asynchronously. - - Instance of MiscSerialNumberInformation. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Misc me serial number information. - - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Returns null in case of failure. - - - - Get the Misc Me Imei asynchronously. - - The imei string. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Misc me Imei information. - - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Returns null in case of failure. - - - - Check the modem power status. - - Phone power status value. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - Get device vendor name and device name of cellular dongle. - - Instance of MiscDeviceInfo. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - - Result can be delivered with only cellular dongle insertion. - - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when modem instance is invalid or when method failed due to invalid operation. - - - - A class containing information about mobile equipment version. - - - - - Version mask. - - - - - Software version. - - - - - Hardware version. - - - - - Calculation date. - - - - - Product code. - - - - - Model id. - - - - - Number of prl nam fields. - - - - - Prl version (only for CDMA). - - - - - Number of Eri nam fields. - - - - - Eri version. - - - - - A class containing information about mobile serial number. - - - - - Esn number. - - - - - Meid number. - - - - - Imei number. - - - - - Imeisv number. - - - - - A class containing device information of cellular dongle. - - - - - Vendor name. - - - - - Device name. - - - - - Enumeration for the phone power status values. - - - - - Unknown. - - - - - Power on. - - - - - Power off. - - - - - Power reset. - - - - - Power low. - - - - - Error. - - - - - Enumeration for the phone power reset commands. - - - - - On. - - - - - Off. - - - - - Reset. - - - - - Low value. - - - - - Max value. - - - - - Enumeration for flight mode request type. - - - - - Off. - - - - - On. - - - - - Max value. - - - - - Enumeration for flight mode request type. - - - - - Flight mode on success. - - - - - Flight mode off success. - - - - - Flight mode request fail. - - - - - Max value. - - - - - This class provides functions for managing telephony service network. - - - - - A public constructor for Network class to create a Network instance for the given tapi handle. - - The tapi handle. - - - - Request the lower layers to select the network automatically asynchronously. - - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Request the lower layers to select the network which is selected by the user from the network list asynchronously. - - The user selected plmn. - The user selected access technology. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Sends a request to do manual search for the available networks and provides the Network List to the user asynchronously. - - Instance of NetworkPlmnList. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the present network selection mode i.e. automatic or manual asynchronously. - - Value of NetworkSelectionMode. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Set the network preferred plmn asynchronously. - - The operation to be done on the preferred plmn. - The preferred plmn info. - A task indicating whether the SetNetworkPreferredPlmn method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when NetworkPreferredPlmnInfo argument is null. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the preferred plmn list asynchronously. - - List of NetworkPreferredPlmnInfo. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Cancel the triggered manual network search asynchronously. - - A task indicating whether the CancelNetworkManualSearch method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the network serving information asynchronously. - - Instance of NetworkServing. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Set the network mode asynchronously. - - The network mode. - A task indicating whether the SetNetworkMode method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the network mode asynchronously. - - Value of NetworkMode. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the neighboring cell info asynchronously. - - Instance of NetworkNeighboringCell. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Enters or exits the emergency callback mode asynchronously. - - The emergency callback mode. - A task indicating whether the SetEmergencyCallbackMode method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Set the network roaming preference asynchronously. - - The network roaming preference. - A task indicating whether the SetRoamingPreference method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the network roaming preference asynchronously. - - Value of NetworkPreferred. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Set the default data subscription asynchronously. - - A task indicating whether the SetDefaultDataSubscription method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the default data subscription. - - Value of NetworkDefaultDataSubscription. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Set the default subscription for voice asynchronously. - - A task indicating whether the SetNetworkDefaultSubscription method is done or not. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - Get the default subscription for voice. - - Value of NetworkDefaultSubscription. - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when network instance is invalid or when method failed due to invalid operation. - - - - A class which defines network registration status. - - - - - Circuit Switched status. - - Status of circuit switched data. - - - - Packet Switched status. - - Status of packet switched data. - - - - Registration service type. - - Service type represented in NetworkServiceType enum. - - - - Roaming status - - Boolean value to check the roaming status. - - - - A class which defines network cell info notification. - - - - - Location Area Code (In case of LTE network, it represents Tracking Area Code). - - Location area code represented in integer. - - - - Cell ID. - - Cell id represented in integer. - - - - A class which defines network change notification. - - - - - Access technology. - - Access technology represented in NetworkSystemType enum. - - - - Network PLMN. - - Plmn value represented as string. - - - - A class which defines network time notification. - - - - - Date time information. - - An instance of DateTime representing date time information. - - - - Wday information. - - Wday info represented in integer. - - - - GMT Off. - - GMT off info represented in integer. - - - - DST Off. - - DST off info represented in integer. - - - - Flag for checking if it is DST. - - Boolean value to check if the time is DST or not. - - - - Network PLMN. - - PLMN value represented in string. - - - - A class which defines network identity notification. - - - - - Network PLMN. - - Plmn value represented in string. - - - - Short network name. - - Short name of the network in string. - - - - Full network name. - - Full name of the network in string. - - - - A class which defines network VoLTE status notification. - - - - - VoLTE status. - - Boolean value to check if it is registered. - - - - Services registered for. - - Service mask represented in integer. - - - - Network on which VoLTE is registered. - - Type of VoLTE network represented in VolteNetworkType enum. - - - - A class which defines network identity. - - - - - Network name. - - - - - Service provider name. - - - - - Network plmn. - - - - - Plmn Id. - - - - - Plmn type. - - - - - Access technology. - - - - - A class for the network plmn list. - - - - - Network plmn count. - - Count of the network plmn. - - - - Network list. - - List of NetworkIdentity. - - - - A class which defines the preferred plmn information. - - - - - Preferred plmn list index. - - Index of preferred plmn list. - - - - Preferred plmn. - - Plmn string. - - - - Network name. - - Name of network. - - - - Service provider name. - - Name of service provider. - - - - System type of network. - - System type of network. - - - - A class containing information related to a cdma system. - - - - - Cdma carrier. - - Cdma carrier. - - - - System Id. - - System Id. - - - - Network Id. - - Id of network. - - - - Base station Id. - - Id of base station. - - - - Latitude of the current base station. - - Latitude of the current base station. - - - - Longitude of the current base station. - - Longitude of the current base station. - - - - Registration zone. - - Registration zone. - - - - Pilot offset. - - Offset of pilot. - - - - A class containing information about network area. - - - - - Location area code. - - Area code of location. - - - - Instance of NetworkCdmaSysInfo. - - Instance of NetworkCdmaSysInfo. - - - - A class containing information of serving network. - - - - - Access technology. - - System type of network. - - - - Network plmn. - - Plmn of network. - - - - Area information of network. - - Instance of NetworkAreaInfo. - - - - A class containing information of cdma cell. - - - - - System Id info. - - System Id. - - - - Network Id. - - Network Id. - - - - Base station Id. - - Base station id. - - - - Reference pn. - - Reference pn. - - - - Latitude of the current base station. - - Latitude of the current base station. - - - - Longitude of the current base station. - - Longitude of the current base station. - - - - A class containing information of lte cell. - - - - - Value of cell Id. -1 indicates that cell Id information is not present. - - Cell Id. - - - - Location area code. This field is ignored when CellId is not present. - - Code of area. - - - - Physical cell id info. - - Physical cell id. - - - - E-Utra absolute rf channel number. - - E-Utra absolute rf channel number. - - - - Tracking area code. - - Area code for tracking. - - - - Rssi in dBm(signed) - - Rssi in dBm. - - - - A class containing information of umts cell. - - - - - Ucid. -1 indicates that cell Id information is not present. - - RNCID + Cell ID(16 bit). - - - - Location area code. This field is ignored when CellId is not present. - - Code of area. - - - - Utra absolute rf channel number. - - Utra absolute rf channel number. - - - - Primary scrambling code. - - Primary scrambling code. - - - - Received signal code power. Valid values are (0-96, 255). - - Power of received signal code. - - - - A class containing information of geran cell. - - - - - Value of cell Id. -1 indicates that cell Id information is not present. - - Cell Id. - - - - Location area code. This field is ignored when CellId is not present. - - Code of area. - - - - Broadcast control channel frequency number. - - Broadcast control channel frequency number. - - - - Base station identification code. - - Id code of base station. - - - - Received signal strength level. Valid values are (0-63, 99). - - Strength of received signal. - - - - A class which contains geran, umts, cdma and lte cell information. - - - - - Geran cell information. - - Instance of NetworkGeranCell. - - - - Cdma cell information. - - Instance of NetworkCdmaCell. - - - - Umts cell information. - - Instance of NetworkUmtsCell. - - - - Lte cell information. - - Instance of NetworkLteCell. - - - - A class which contains serving cell information. - - - - - Access technology. - - Network system type. - - - - Mobile country code. - - Country code of the mobile. - - - - Mobile network code. - - Network code of the mobile. - - - - Information of cell. - - Instance of Cell. - - - - A class which contains neighboring cell information. - - - - - Serving cell information. - - Instance of NetworkServingCell. - - - - Geran cell info list. - - List of NetworkGeranCell. - - - - Umts cell info list. - - List of NetworkUmtsCell. - - - - Lte cell info list. - - List of NetworkLteCell. - - - - Enumeration for the status of the network service. - - - - - No service available in the network ME is camped. - - - - - Only emergency service available in the network ME is camped. - - - - - FULL service available in the network ME is camped - - - - - Searching for service. - - - - - Enumeration for the service types of TAPI. - - - - - Service type is Unknown. - - - - - No Service available. - - - - - Service type is Emergency. - - - - - Service type is Searching. - - - - - Service type is 2G. In case of CDMA, service type is set to 2G when System Type is IS95A/IS95B/CDMA_1X. - - - - - Service type is 2.5G. - - - - - Service type is 2.5G (EDGE). - - - - - Service type is 3G. In case of CDMA, service type is set to 3G when System Type is EVDO_REV_0/REV_A/REV_B/EHRPD. - - - - - Service type is HSDPA. - - - - - Service type is LTE. - - - - - Enumeration for the system types of network. - - - - - No Service available. - - - - - Available service is GSM. - - - - - Available service is GPRS. - - - - - Available service is EGPRS. - - - - - Available service is PCS1900 band. - - - - - Available service is UMTS. - - - - - Both GSM and UMTS systems available. - - - - - Available service is HSDPA. - - - - - Available service is IS95A. - - - - - Available service is IS95B. - - - - - Available service is CDMA 1X. - - - - - Available service is EV-DO rev0. - - - - - Available service is 1X and EV-DO rev0. - - - - - Available service is EV-DO revA. - - - - - Available service is 1X and EV-DO revA. - - - - - Available service is EV-DO revB. - - - - - Available service is 1X and EV-DO revB. - - - - - Available service is EV-DV. - - - - - Available service is EHRPD. - - - - - Available service is LTE. - - - - - Enumeration for the network emergency callback mode states (3GPP2 specific enum). - - - - - Enter emergency callback mode. - - - - - Exit emergency callback mode. - - - - - Enumeration for the possible default Data Subscriptions. - - - - - Unknown status. - - - - - SIM 1. - - - - - SIM 2. - - - - - Enumeration for the possible default Subscriptions for CS (Voice). - - - - - Unknown status. - - - - - SIM 1 network. - - - - - SIM 2 network. - - - - - Enumeration for type of network on which VoLTE is registered. - - - - - Unknown. - - - - - Mobile. - - - - - WiFi. - - - - - Enumeration for the packet service protocol type. - - - - - Unknown PS type. - - - - - HSDPA. - - - - - HSUPA. - - - - - HSPA. - - - - - HSPAP. - - - - - Enumeration for the network name display condition type. - - - - - Invalid Display Condition. - - - - - Display Condition is SPN. - - - - - Display Condition is PLMN. - - - - - Display Condition is SPN or PLMN. - - - - - Enumeration for the different serving network LTE band type. - - - - - Unknown. - - - - - FDD. - - - - - TDD. - - - - - Enumeration for the operation that can be done on a preferred PLMN. - - - - - Addition to the Network Preferred PLMN list. - - - - - Edit the network Preferred PLMN list. - - - - - Delete the entry to the network Preferred PLMN list. - - - - - Enumeration for the CDMA Preferred Network Type(CDMA only). - - - - - Home only. - - - - - Affiliated. - - - - - Automatic. - - - - - Automatic-A. - - - - - Automatic-B. - - - - - Roam domestic. - - - - - Roam international. - - - - - Roam dual. - - - - - Blank. - - - - - Enumeration for the different network operation causes. - - - - - No error for any operation. - - - - - Aborted. - - - - - Error. - - - - - Phone is in use(eg: Voice / Data call in progress). - - - - - Phone is in offline mode. - - - - - Modem is unable to process the config settings information. - - - - - Internal failure. - - - - - Memory is full. - - - - - Enumeration for the network plmn type. - - - - - Unknown. - - - - - Home plmn. - - - - - Available. - - - - - Forbidden. - - - - - Enumeration for the network selection mode. - - - - - Automatic selection mode. - - - - - Manual selection mode (Not applicable to CDMA). - - - - - Enumeration for the different network modes. - - - - - Auto. - - - - - Gsm. - - - - - Wcdma. - - - - - Rtt1x. - - - - - Lte. - - - - - Evdo. - - - - - Cdma. - - - - - This class provides functions for sending oem related data. - - - - - A public constructor for Oem class to create a Oem instance for the given tapi handle. - - The tapi handle. - - - - Sends oem data directly. - - Oem id for user specification. - Oem data for sending. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when oem instance is invalid or when method failed due to invalid operation. - - - - Sends oem data directly. - - Oem id for user specification. - Oem data for sending. - The oem data which is sent. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - Sends oem data directly. - - Oem id for user specification. - Oem data for sending. - The oem data which is sent. - http://tizen.org/privilege/telephony.admin - platform - http://tizen.org/feature/network.telephony - Thrown when feature is not supported. - Thrown when privilege access is denied. - Thrown when call instance is invalid or when method failed due to invalid operation. - - - - A class which defines OEM data base structure. - - - - - Oem ID. - - Oem id represented in unsigned integer. - - - - Oem data. - - Oem data represented in byte array. - - - - A class which manages sim phonebook record information. - - - - - Gets the instance of Phonebook class. - - An instance of TapiHandle obtained from InitTapi in TapiManager API. - Thrown when handle is passed as null. - - - - Gets the current inserted SIM phonebook init status, available phonebook list, and first valid index in case of FDN, ADN, and 3G phonebook. - - An instance of SimPhonebookStatus containing init status and phonebook list information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the number of used records and total records of a specific SIM phonebook type. - - The different storage types to be selected in the SIM. - A task containing an instance of PhonebookStorageInfo. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the max text length and max number length supported by the SIM phone book elementary file. - - The different storage types to be selected in the SIM. - A task containing an instance of PhonebookMetaInfo. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM 3G phonebook supported EFs like ANR, SNE, GRP, EMAIL and the corresponding EFs max text length, number length, and size. - - A task containing an instance of PhonebookMetaInfo3G. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Reads SIM phone book entry information from the given storage type and index. - - The different storage types to be selected in the SIM. - The index for accessing the SIM data. - A task containing an instance of PhonebookRecord. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Adds or edits SIM phone book record entry information. - - The phonebook data to be updated or added. - A task indicating whether the updation is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when record is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Deletes a SIM phonebook record. - - The different storage types to be selected in the SIM. - The index of the record to be deleted. - A task indicating whether deletion is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - A class which defines the list of phone book availability of the current SIM. - - - - - Fixed Dialing Number. - - Fdn represented in integer format. - - - - SIM - ADN(2G phonebook, Under DF phonebook). - - Adn represented in integer format. - - - - Service Dialing Number. - - Sdn represented in integer format. - - - - USIM - 3G phonebook. - - Usim represented in integer format. - - - - Additional number Alpha String phonebook. - - Aas represented in integer format. - - - - Grouping information Alpha String phonebook. - - Gas represented in integer format. - - - - A class which defines phone book status of the current SIM. - - - - - Init completed or not. - - Boolean value to check the status of Init. - - - - List of phonebook. - - An instance of SimPhonebookList containing the list of available phone book. - - - - A class which defines phonebook contact change information. - - - - - Storage file type. - - Type of phonebook storage represented as PhonebookType enum. - - - - Changed index. - - Index value represented in unsigned short. - - - - Phonebook operation. - - Operation indicating the action on phonebook contact. - - - - A class which defines phone book storage count information. - - - - - Storage file type. - - Type of phone book storage file. - - - - Total record count. - - Count of total phonebook record. - - - - Used record count. - - Number of used phonebook record. - - - - A class which defines phone book entry information. - - - - - Storage file type. - - Type of phonebook storage. - - - - Phone book minimum index. - - Minimum index value of the phone book record. - - - - Phone book maximum index. - - Maximum index value of the phone book record. - - - - Phone number's maximum length - - Maximum length of the phone number. - - - - Text's maximum length. - - Maximum length of the text. - - - - Phone book used record count. - - Number of used phone book record. - - - - A class which defines 3G phone book capability information. - - - - - 3G phonebook file type. - - File type of the 3G phonebook. - - - - Max index. - - Maximum index value present in 3G phonebook. - - - - Max text length. - - Maximum text length in unsigned short. - - - - Used record count. - - Number of used record in 3G phonebook. - - - - A class which manages Sim phonebook and its capabilities information. - - - - - Phonebook file type count. - - Filetype count of the 3G phonebook. - - - - Phonebook file type information. - - A list of FileTypeCapabilityInfo3G instances. - - - - A class which contains information about phonebook record. - - - - - Phonebook type. - - Type of the phonebook used. - - - - Index. - - Index value represented in unsigned short. - - - - Next index (This field is not used in the add/update case). - - Next index represented in unsigned short. - - - - Name. - - Name in phonebook record. - - - - Dcs. - - Sim encryption type. - - - - Number. - - Number in phonebook record. - - - - Ton. - - Sim type of number. - - - - SNE(Second Name Entry). - - Second name entry in byte array. - - - - SNE DCS. - - SNE text encryption type. - - - - Additional Number1. - - Additional number1 represented in byte array. - - - - ANR1 TON. - - Additional number1 type of number. - - - - Additional Number2. - - Additional number2 represented in byte array. - - - - ANR2 TON. - - Additional number2 type of number. - - - - Additional number3. - - Additional number3 represented in byte array. - - - - ANR3 TON. - - Additional number3 type of number. - - - - Email1. - - Email1 represented in byte array. - - - - Email2. - - Email2 represented in byte array. - - - - Email3. - - Email3 represented in byte array. - - - - Email4. - - Email4 reprensented in byte array. - - - - Group index. - - Group index represented in unsigned short. - - - - Phonebook control. - - Phonebook control represented in unsigned short. - - - - Enumeration for the storage types to be selected in the SIM or USIM. - - - - - Fixed Dialing Number. - - - - - Sim - ADN. - - - - - Service Dialing Number. - - - - - USIM - 3G phone book. - - - - - Additional number Alpha String. - - - - - Grouping identifier Alpha String. - - - - - Unknown file type. - - - - - Enumeration for the phonebook operation types. - - - - - Contact added or updated. - - - - - Existing contact deleted. - - - - - Max value. - - - - - Enumeration for the storage field types in the 3G Phone book. - - - - - Name. - - - - - Number. - - - - - First Another number. - - - - - Second Another number. - - - - - Third Another number. - - - - - First Email. - - - - - Second Email. - - - - - Third Email. - - - - - Fourth Email. - - - - - Second name entry of the main name. - - - - - Group. - - - - - 1 byte control info and 1 byte hidden info. - - - - - Enumeration for the text encryption type. - - - - - ASCII Encoding. - - - - - GSM 7 Bit Encoding. - - - - - UCS2 Encoding. - - - - - HEX Encoding. - - - - - Enumeration for the phonebook access result. - - - - - SIM phonebook operation successful. - - - - - SIM phonebook operation failure. - - - - - The index passed is not a valid index. - - - - - The number length exceeds the max length allowed (or 0). - - - - - The name length exceeds the max length allowed (or 0). - - - - - Access condition for PB file is not satisfied. - - - - - A class which defines SAT main menu info. - - - - - Proactive command number sent by USIM. - - Command number represented in integer format. - - - - Flag for checking whether main menu is present or not. - - Boolean value checking the presence of main menu. - - - - Menu title text. - - Title text of the menu item represented in string. - - - - Menu items. - - List of SatMenuInfo objects. - - - - Number of menu itmes. - - An unsigned value representing the number of menu items. - - - - Flag for a help information request. - - Boolean value for checking the flag for help information request. - - - - Updated Sat main menu or not. - - Boolean value to check whether Sat main menu is updated or not. - - - - Icon Identifier. - - An instance of SatIconIdInfo class representing the icon identifier. - - - - List of Icon Identifiers. - - An instance of SatIconIdListInfo class representing the icon identifier list. - - - - A class which contains menu item information for the setup menu. - - - - - Menu item character data. - - Menu item data represented in string. - - - - Identifies the item on the menu that the user selected. - - Item identifier value represented as a character. - - - - A class defining the icon data object. - - - - - Flag for checking whether the icon identifier exists. - - Boolean value representing if the icon exists or not. - - - - Icon qualifier type. - - Icon qualifier type represented as SatIconQualifierType enum. - - - - Icon identifier. - - A byte value representing the icon identifier. - - - - Icon info. - - An instance of SatIconInfo class. - - - - A class containing the definition of icon info object. - - - - - Icon width. - - Width of the icon represented in byte. - - - - Icon height. - - Height of the icon represented in byte. - - - - Image coding scheme. - - Image coding scheme represented as SatImageCodingScheme enum. - - - - Icon data length. - - Data length of the icon represented in ushort. - - - - Clut data length. - - Data length of the clut represented in ushort. - - - - Icon file. - - Icon file string. - - - - Clut file. - - Clut file string. - - - - A class which defines the icon identifier data object. - - - - - Flag for checking whether the icon identifier exists. - - Boolean value indicating the presence of icon. - - - - Icon list qualifier. - - Icon list qualifier represented in SatIconQualifierType enum. - - - - Number of icons. - - Byte value indicating the number of icons. - - - - Icon identifier list. - - A byte array containing the list of Icon identifier. - - - - Icon list info. - - List of icon info. - - - - A class containing display text proactive command for SAT UI. - - - - - Proactive command number sent by USIM. - - Command id in integer format. - - - - Character data to display on screen. - - An instance of SatTextInfo containing text information. - - - - Duration of the display. - - Duration in integer format. - - - - Flag that indicates whether text is to be displayed if some other app is using the screen. - - Boolean value checking the priority of the display. - - - - Flag that indicates whether user response is required. - - Boolean value to check the need of user response. - - - - Flag for checking whether immediate response is required. - - Boolean value to check the immediate response status. - - - - Icon Identifier. - - An instance of SatIconIdInfo class. - - - - A class defining character data for the SAT engine data structure. - - - - - Character data length. - - An unsigned short value representing the string length. - - - - Character data. - - A byte array representing the string data. - - - - A class which defines select item proactive command data for SAT UI. - - - - - Proactive command number sent by USIM. - - Command id represented in integer format. - - - - Flag for a help information request. - - Boolean value to check whether help information is availale or not. - - - - Menu title text. - - An instance of SatTextInfo class containing the text information. - - - - Selected default item. - - Default item index of the given items. - - - - Number of menu items. - - Menu items count represented as a character. - - - - Menu items. - - A list of SatMenuItemInfo objects. - - - - Icon Identifier. - - An instance of SatIconIdInfo class. - - - - List of Icon Identifiers. - - An instance of SatIconIdListInfo class containing the list of icon identifiers. - - - - A class which defines the menu item data object. - - - - - Item identifier. - - Item Id represented in byte. - - - - Text length. - - Length of the text represented in byte. - - - - Text information. - - A byte array of length TextLength containing the text information. - - - - A class which defines get inkey proactive command data for SAT UI. - - - - - Proactive command number sent by USIM. - - Command id represented in integer format. - - - - Input Type. - - Character Set or Yes/No. - - - - Input character mode. - - SMS default, UCS2. - - - - Flag for checking whether input character is numeric. - - Boolean value for checking whether input character is numeric or not. - - - - Help info request flag. - - Boolean value for checking whether help info is available or not. - - - - Character data to display on the screen. - - An instance of SatTextInfo class containing the text information. - - - - Duration of the display. - - Display duration represented in unsigned integer. - - - - Icon identifier. - - An instance of SatIconIdInfo class containing the Icon identifier information. - - - - A class which defines get input proactive command data for SAT UI. - - - - - Proactive command number sent by USIM. - - Command id represented in integer format. - - - - Input character mode. - - SMS default, UCS2. - - - - Flag to check whether input character is numeric. - - Boolean value to check the nature of input character. - - - - Help info request flag. - - Boolean value to check help information availability. - - - - Flag that indicates whether to show input data on the screen. - - Boolean value to check the availability of input data on the screen. - - - - Character data to display on the screen. - - An instance of SatTextInfo. - - - - Input data min, max length. - - An instance of SatResponseLengthInfo. - - - - Default input character data. - - An instance of SatTextInfo. - - - - Icon identifier. - - An instance of SatIconIdInfo. - - - - A class which defines expected user response length. - - - - - User response length's minimum value. - - Minimum value represented in byte. - - - - User response length's maximum value. - - Maximum value represented in byte. - - - - A class which defines refresh proactive command data for applications that are concerned with files residing on USIM. - - - - - Proactive command number sent by USIM. - - Command id represented in integer format. - - - - Concerned application type. - - Refresh app type represented in SatRefreshAppType enum. - - - - Refresh mode. - - Refresh mode represented in SatCmdQualiRefresh enum. - - - - Refresh file count. - - File count represented in byte. - - - - Refresh file identifiers. - - A list of SimFileId enums. - - - - A class which defines send SMS proactive command data for the SMS application. - - - - - Proactive Command Number sent by USIM. - - Command id represented in integer. - - - - Flag to check if packing is required for SMS Tpdu. - - Boolean value to check the need of packing in SMS Tpdu data. - - - - Destination address. - - An instance of SatAddressData containing the address info. - - - - SMS Tpdu data. - - An instance of SatSmsTpduInfo. - - - - A class which defines SAT address data object. - - - - - Type of number. - - Sim type of number represented in SimTypeOfNumber enum. - - - - Number plan identity. - - Sim number plan represented in SimNumberPlanIdentity enum. - - - - Length of dialling number. - - Dialling number length represented in byte. - - - - Dialling number. - - Dialling number represented in string. - - - - A class which defines the Result data object. - - - - - SMS TPDU type. - - Tpdu type represented in SatSmsTpduType. - - - - SMS TPDU data length. - - Length of Tpdu data represented in byte. - - - - SMS TPDU data. - - An array of bytes representing TPDU data. - - - - A class which defines Event list info. - - - - - Flag to check if the event download is acive. - - Boolean value to check for active event download. - - - - Flag to check if the event is about Mt call event. - - Boolean value to check the event for Mt call event. - - - - Flag to check if the call is connected. - - Boolean value to check the connection of call. - - - - Flag to check if the call is disconnected. - - Boolean value to check the call disconnection. - - - - Flag to check if the event is aboout locaion status. - - Boolean value to check the presence of location status in the event. - - - - Flag to check if the event is about user activity. - - Boolean value to check the presence of user activity. - - - - Flag to check if idle screen is available. - - Boolean value to check the availability of idle screen. - - - - Flag to check if the event is about card reader status. - - Boolean value to check the status of card reader. - - - - Flag to check if the event is about language selection. - - Boolean value to check if the event is language selection. - - - - Flag to check if the browser is terminated. - - Boolean value to check the termination of browser. - - - - Flag to check if the data is available. - - Boolean value to check availablility of data. - - - - Flag to check if the event has channel status. - - Boolean value to check if this field is a channel status. - - - - A class which defines send DTMF proactive command data for the DTMF application. - - - - - Proactive Command Number sent by USIM - - Command id represented in integer. - - - - Hidden mode flag. - - Flag to check if the data is in hidden mode. - - - - DTMF string data. - - An instance of SatTextInfo containing DTMF string data. - - - - A class which defines call control confirm data for Call/Ss. - - - - - Call destination address. - - An instance of SatTextInfo class. - - - - Call SUB address. - - An instance of SatTextInfo class. - - - - BC repeat indicator. - - SatBcRepeatIndicatorType enum representing Bc repeat indicator. - - - - Configuration Capability Parameter 1. - - An instance of SatTextInfo class. - - - - Configuration Capability Parameter 2. - - An instance of SatTextInfo class. - - - - A class which defines common call control confirm data. - - - - - Call control confirm type - call, SS or USSD. - - Type of call represented in SatCallType enum. - - - - Call control result type. - - Type of call control result represented in SatCallCtrlResultType enum. - - - - Call control display data. - - An instance of SatTextInfo class containing information about call control display data. - - - - Flag for checking existence of call control display. - - Boolean value to check existence of user info display. - - - - Call control call address. - - - This value will be filled only if CallType is MoVoice. Otherwise it will be null. - - An instance of SatCallCtrlData containing call control call address. - - - - Call control SS string. - - - This value will be filled only if CallType is Ss. Otherwise it will be null. - - An instance of SatCallCtrlData containing call control SS string. - - - - Call control USSD string. - - - This value will be filled only if CallType is Ussd. Otherwise it will be null. - - An instance of SatTextInfo class containing call control USSD string. - - - - A class which defines the data coding scheme object. - - - - - Flag to verify the compressed format. - - Boolean value to check the compressed value. - - - - Alphabet format type. - - Represented in SatAlphabetFormat enum. - - - - Type of message class. - - Message class represented in SatMsgClassType enum. - - - - Raw DCS info. - - Dcs info stored in byte. - - - - A class which defines text string data object. - - - - - Flag for checking whether only digits are used. - - Boolean value for checking the usage of only digits. - - - - Data coding scheme. - - An instance of SatDataCodingScheme class. - - - - Text length. - - Length of the string in unsigned short format. - - - - Text string. - - Text represented in string. - - - - A class which defines MO SMS control confirm data. - - - - - Envelope result. - - Result of MO SMS control confirm data. - - - - Display present flag. - - Boolean value to check the presence of user information display. - - - - Display data for sending SMS. - - An instance of SatTextTypeInfo containing display data for sending SMS. - - - - The RP destination address of the service center. - - An instance of SatTextTypeInfo containing RP destination address. - - - - The TP destinationn address. - - An instance of SatTextTypeInfo containing TP destination address. - - - - A class which defines setup call proactive command data for the call application. - - - - - Proactive Command Number sent by USIM. - - Command Id represented in integer format. - - - - Call type - - Type of call represented in SatCmdQualiSetupCall enum. - - - - Display data for calling. - - An instance of SatTextInfo containing display data for calling. - - - - Call number. - - An instance of SatTextInfo containing call number information. - - - - Maximum repeat duration. - - Max repeat duration represented in unsigned integer format. - - - - Icon identifier for the call application. - - An instance of SatIconIdInfo containing Icon id information. - - - - A class which defines Send SS notification proactive command data for the applicaiton. - - - - - Proactive Command Number sent by USIM. - - Command id represented in integer format. - - - - Type of Number. - - TON represented in SimTypeOfNumber enum. - - - - Numbering Plan Identity. - - NPI reprensented in SimNumberPlanIdentity enum. - - - - SS string length. - - Length of SS string represented in byte. - - - - SS string. - - Text string represented in string. - - - - A class which defines send USSD notification proactive command data for the application. - - - - - Proactive Command Number sent by USIM. - - Command id represented in integer format. - - - - Raw DCS info. - - Raw DCS information represented in byte. - - - - USSD string length. - - Length of USSD string in byte. - - - - USSD string. - - Ussd text represented in string format. - - - - Enumeration for the UI display status. - - - - - Infoms about UI display success. - - - - - Informs about UI display failure. - - - - - Enumeration for the command qualifier values of the refresh command. - - - - - Command qualifier for Refresh SIM Init And Full File Change Notification. - - - - - Command qualifier for Refresh File Change Notification. - - - - - Command qualifier for Refresh SIM Init And File Change Notification. - - - - - Command qualifier for Refresh Sim Init. - - - - - Command qualifier for Refresh Sim Reset. - - - - - Command qualifier for Refresh 3G Application Reset. - - - - - Command qualifier for Refresh 3G Session Reset. - - - - - Command qualifier for Refresh Reserved. - - - - - Enumeration for the icon qualifier. - - - - - Icon Quali Self Explanatory. - - - - - Icon Quali Not Self Explanatory. - - - - - Reserved. - - - - - Enumeration for the SIM image coding scheme type. - - - - - Basic coding scheme. - - - - - Colour coding scheme. - - - - - Reserved. - - - - - Enumeration for the inkey type. - - - - - Command qualifier for Inkey type character set enabled. - - - - - Command qualifier for Inkey type Yes No requested. - - - - - Enumeration for the user input type. - - - - - SMS default. - - - - - UCS2 alphabet type. - - - - - Enumeration for the refresh application type. - - - - - Phonebook type. - - - - - SMS type. - - - - - Other. - - - - - Maximum value. - - - - - Enumeration for the SMS TPDU type. - - - - - Deliver TPDU type. - - - - - Deliver RPT type. - - - - - Submit TPDU type. - - - - - Submit RPT type. - - - - - Status RPT type. - - - - - TPDU CMD type. - - - - - Enumeration for the type of command and the next action indicator. - - - - - None. - - - - - Refresh. - - - - - More time. - - - - - Setup event list. - - - - - Setup call. - - - - - Send SS. - - - - - Send USSD. - - - - - Send SMS. - - - - - Send DTMF. - - - - - Launch browser. - - - - - Play tone. - - - - - Display text. - - - - - Get inkey. - - - - - Get input. - - - - - Select item. - - - - - Setup menu. - - - - - Provide local info. - - - - - Setup idle mode text. - - - - - Language notification. - - - - - Open channel - class e. - - - - - Close channel - class e. - - - - - Receive data - class e. - - - - - Send data. - - - - - Get channel status - class e. - - - - - Inform to end the execution of a proactive command. - - - - - Inform end proactive session. - - - - - Reserved. - - - - - Enumeration for the SAT call type. - - - - - MO voice. - - - - - MO SMS. - - - - - SS. - - - - - USSD. - - - - - PDP context action. - - - - - Max. - - - - - Enumeration for the result of call control by SIM. - - - - - Allowed with no mod. - - - - - Not allowed. - - - - - Allowed with mod. - - - - - Reserved. - - - - - Enumeration for the SIM ATK BC repeat indicator type. - - - - - Alternate mode. - - - - - Sequential mode. - - - - - Reserved. - - - - - Enumeration for alphabet format. - - - - - SMS default. - - - - - 8Bit data. - - - - - UCS2. - - - - - Reserved. - - - - - Enumeration for the message class. - - - - - None. - - - - - Class 0. - - - - - Class 1 Default meaning: ME - specific. - - - - - Class 2 SIM specific message. - - - - - Class 3 Default meaning : TE specific. - - - - - Reserved. - - - - - Enumeration for the command qualifier values of the setup call command. - - - - - Command qualifier for setup call if another call is not busy. - - - - - Command qualifier for setup call if another call is not busy with redial. - - - - - Command qualifier for setup call putting all other calls on hold. - - - - - Command qualifier for setup call putting all other calls on hold with redial. - - - - - Command qualifier for setup call disconnecting all other calls. - - - - - Command qualifier for setup call disconnecting all other calls with redial. - - - - - Reserved. - - - - - A class which manages SIM card services. - - - - - A constructor to instantiate Sim class using the Tapi handle. - - An instance of TapiHandle obtained from InitTapi in TapiManager API. - Thrown when handle is passed as null. - - - - Gets SIM card initialization status and SIM card identification. - - An instance of SimInitInfo class in case of success. Null in case of failure. - - - - Gets the card type (SIM/USIM). - - - - - Gets SIM IMSI information. - - - - - Gets ECC(SIM) or UECC(USIM) data. - - - - - Gets the list of application on UICC. - - A byte containing the masking value for SimAppType. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the unique identification number of the (U)ICC. - - A task containing ICCID information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets language preference(indication) information. - - A task containing information about SIM language preference. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Updates language preference information to the SIM card. - - The language preference information. - A task indicating whether setting of language preference is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM call forwarding indication related data(EF-CFIS and CPHS case). - - A task containing call forward response information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Sets SIM call forwarding indication related data(EF-CFIS and CPHS case). - - The data requesting for call forwarding. - A task indicating whether setting call forward info is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when call forward request is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM message waiting indication related data(EF-MWIS and CPHS case). - - A task containing message waiting response information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Sets SIM message waiting indication related data(EF-MWIS and CPHS case). - - The data requesting for message waiting. - A task indicating whether setting message waiting info is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when message waiting request is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM mailbox related data(EF-MBDN, MBDI, and CPHS case). - - A task containing SimMailboxList information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Sets SIM mailbox related data(EF-MBDN, MBDI and CPHS case). - - The data requesting for mailbox info. - A task indicating whether setting mailbox info is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when mailbox number is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM CPHS specific data. - - A task containing SimCphs information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the SIM Service Table. - - A task containing SIM service table information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM MSISDN data. - - A task containing SimMsisdnList information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM OPLMNWACT(Operator controlled PLMN Selector with Access Technology) data. - - A task containing SimOplmnwactList information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM SPN data. - - A task containing SimSpn information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM CPHS NETNAME data. - - A task containing SimCphsNetName information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Executes an authentication procedure by using SIM. - - The authentication code to be validated by the ISIM, 3G, and GSM application in the SIM card. - A task containing SimAuthenticationResponse information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when authentication data is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Performs PIN1/PIN2/SIM LOCK verification. - - The PIN code. - A task containing SimPinResult information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when pin data is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Performs PIN1/PIN2 unblocking operation based on PUK information. - - The unblocking PIN password. - The PIN password to use after the unblocking operation. - A task containing SimPinResult information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when either of pukData or newPinData is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Changes the PIN1/PIN2 code based on the PIN type passed along with old PIN data and new PIN data. - - The old PIN code entered by the user. - The new PIN code entered by the user. - A task containing SimPinResult information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when either of oldPin or newPin is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Disables the SIM facility. - - An object which contains the facility type and password. - A task containing SIM facility result information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when SIM facility info is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Enables the SIM facility. - - An object which contains the facility type and password. - A task containing SIM facility result information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when SIM facility info is passed as null. - Thrown when the system runs out of memory. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the SIM facility. - - The type of security lock. - A task containing SIM facility information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets SIM lock type info. - - The type of security lock. - A task containing SIM lock information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Sets the SIM power state. - - The state of SIM to be set. - A task indicating whether setting SIM power state is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Provides a common interface for accessing SIM data. - - The APDU data. - A task containing SIM APDU response information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when SIM APDU is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Provides a common interface to get the SIM ATR(Answer To Reset) value. - - A task containing SIM ATR response information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the IMPI(IMS private user identity). (ISIM only). - - A task containing IMPI string. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the IMPU(IMS public user identity). (ISIM only). - - A task containing SIM IMPU list information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the Domain(Home Network Domain Name). (ISIM only) - - A task containing domain string. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the P-CSCF(Proxy Call Session Control Function). (ISIM only) - - A task containing SIM PCSCF list information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the ISIM service table. (ISIM only). - - A task containing a byte array in which mask value of SimIsimService enum will be stored. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - A class which defines SIM card initialization information. - - - - - The SIM initialization status from the Telephony server boot up time. - - - - - The SIM card identification value. It will be true when the current inserted SIM card differs from the previous SIM. False otherwise. - - - - - A class which defines data for IMSI information. - - - - - Mobile Country Code. - - - - - Mobile Network Code. - - - - - Mobile Station Identification Number. - - - - - A class which defines data for ECC information of GSM/USIM/CDMA SIM. - - - - - Name. Applicable only for USIM(3G) SIM. - - - - - Number. - - - - - Emergency service type. Applicable only for USIM(3G) SIM. - - - - - A class which defines ECC information list. - - - - - ECC count. - - - - - List of ECC. - - - - - A class which defines ICCID(Integrated Circuit Card Identifier). - - - - - Integrated Circuit Card number length. - - - - - Integrated Circuit Card number. - - - - - A class which defines call forwarding indication status data. - - - - - Record index. - - - - - MSP number. - - - - - Call forwarding unconditional indication status. - - - - - SIM Type of number. - - - - - SIM numbering plan identity. - - - - - Dialing Number/SSC String. - - - - - Capability/Configuration 2 Record Identifier. - - - - - Extension 7 Record Identifier. - - - - - A class which defines call forwarding indication status list. - - - - - Profile count. - - - - - List of CFIS. - - - - - A class which defines CPHS call forwarding status data. - - - - - CallForwardUnconditionalLine 1. - - - - - CallForwardUnconditionalLine 2. - - - - - CallForwardUnconditional Fax. - - - - - CallForwardUnconditional data. - - - - - A class which defines call forwarding response. - - - - - CPHS or not. - - - - - List of CFIS. - - - - - CPHS CF. - - - - - A class which defines call forwarding request. - - - - - CPHS or not. - - - - - CFIS. - - - This should be filled only if IsCphs is false. - - - - - CPHS CF. - - - This should be filled only if IsCphs is true. - - - - - A class which defines message waiting indication status data. - - - - - Record index. - - - - - Indicator type. - - - - - VoiceMail count. - - - - - Fax count. - - - - - Email count. - - - - - Other count. - - - - - VideoMail count. - - - - - A class which defines message waiting indication status list. - - - - - Profile count. - - - - - List of MWIS. - - - - - A class which defines CPHS message waiting status data. - - - - - VoiceMsgLine1 message waiting flag. - - - - - VoiceMsgLine2 message waiting flag. - - - - - FAX message waiting flag. - - - - - Data message waiting flag. - - - - - A class which defines message waiting reponse. - - - - - CPHS or not. - - - - - List of MWIS. - - - - - CPHS MW. - - - - - A class which defines message waiting request. - - - - - CPHS or not. - - - - - MWIS. - - - This should be filled only if IsCphs is false. - - - - - CPHS MW. - - - This should be filled only if IsCphs is true. - - - - - A class which defines mailbox dialing number data. - - - - - CPHS or not. - - - - - Index which stands for the location where the record is saved in SIM. - - - - - SIM profile index. - - - - - Mailbox type. - - - - - Alpha max length in SIM. - - - - - Alpha Identifier. - - - - - Type Of Number. - - - - - Number Plan Identity. - - - - - Dialing Number/SSC String. - - - - - Capability/Configuration Identifier. - - - - - Extension 1 Record Identifier. - - - - - A class which defines mailbox dialing number list. - - - - - Mailbox count. - - - - - List of mailbox. - - - - - A class which defines available optional CPHS SIM files. - - - - - Customer Service Profile (CSP). - - - - - Service String Table (SST). - - - - - MailBoxNumbers. - - - - - Short form of operator name. - - - - - Information numbers. - - - - - A class which defines CPHS information data. - - - - - CPHS phase type. - - - - - CPHS service table. - - - - - A class which defines CSIM service table. - - - - - Cdma service table; - - - - - Cdma service. Gives mask value of SimCdmaService enum. - - - This will be filled only if CdmaSvcTable is Cdma. - - - - - Csim service. Gives mask value of SimCsimService enum. - - - This will be filled only if CdmaSvcTable is Csim. - - - - - A class which defines SIM service table. - - - - - SIM card type. - - - - - SIM service table. Gives mask value of SimSstService enum. - - - This will be filled only if SimType is Gsm. - - - - - USIM service table. Gives mask value of SimUstService enum. - - - This will be filled only if SimType is Usim. - - - - - CSIM service table. - - - This will be filled only if SimType is Ruim. - - - - - A class which defines MSISDN information of the GSM/CDMA SIM. - - - - - MSISDN number. If it does not exist, a null string will be returned - - - - - MSISDN name. If it does not exist, a null string will be returned. Not applicable for CDMA. - - - - - A class which defines MSISDN list. - - - - - Count. - - - - - List of subscriber info. - - - - - A class which defines OPLMNwACT data. - - - - - PLMN. - - - - - UMTS or not. - - - - - GSM or not. - - - - - A class which defines OPLMNwACT list. - - - - - Count. - - - - - List of OPLMNWACT. - - - - - A class which defines SPN(Service Provider Name). - - - - - Display condition. - - - - - Service Provider Name. - - - - - A class which defines CPHS network name. - - - - - Full name. - - - - - Short name. - - - - - A class which defines authentication request data. - - - - - A constructor to instantiate SimAuthenticationData class with necessary parameters. - - Authentication type. - The length of RAND. - The length of AUTN. It is not used in case of GSM AUTH. - RAND data. - AUTN data. It is not used in case of GSM AUTH. - - - - A class which defines authentication result data. - - - - - Authentication type. - - - - - Authentication result. - - - - - Response length. - - - - - Response data. - - - - - The length of the authentication key. - - - - - The data of the authentication key. - - - - - The length of the cipher key. - - - - - Cipher key. - - - - - The length of the integrity key. - - - - - Integrity key. - - - - - A class which defines information about SIM PIN data. - - - - - A constructor to instantiate SimPinData class which necessary parameters. - - PIN type. - PIN code. - PIN code length. - - - - A class which defines PIN information. - - - - - Specifies the PIN or PUK type. - - - - - Number of attempts remaining for PIN/PUK verification. - - - - - A class which is used to used to enable/disable facility. - - - - - A constructor to instantiate SimFacility class with necessary parameters. - - Facility type. - Password. - Password length. - - - - A class which defines facility result data. - - - - - Specifies the PIN or PUK type. - - - - - Number of attempts remaining for PIN/PUK verification. - - - - - A class which defines facility info data. - - - - - Lock type. - - - - - Facility status. - - - - - A class which defines information about lock type. - - - - - Lock type. - - - - - Lock status. - - - - - Retry counts. - - - - - A class which defines APDU information. - - - - - A constructor to instantiate SimApdu class with necessary parameters. - - APDU. - - - - A class which defines the response of sending APDU. - - - - - Length of response APDU. - - - - - Response APDU. - - - - - A class which defines the response of sending ATR. - - - - - Length of response ATR. - - - - - Response ATR. - - - - - A class which defines ISIM IMPU list data. - - - - - ISIM IMPU data count. - - - - - ISIM IMPU list. - - - - - A class which defines ISIM P-CSCF data. - - - - - ISIM P-CSCF type. - - - - - ISIM P-CSCF data. - - - - - A class which defines ISIM P-CSCF list data. - - - - - ISIM P-CSCF data count. - - - - - ISIM P-CSCF list. - - - - - Enumeration for the SIM card status. - - - - - Bad card / On the fly SIM gone bad. - - - - - Card not present. - - - - - SIM is in the Initializing state. - - - - - SIM Initialization ok. - - - - - PIN required state. - - - - - PUK required state. - - - - - PIN/PUK blocked(permanently blocked- All the attempts for PIN/PUK failed). - - - - - Network Control Key required state. - - - - - Network Subset Control Key required state. - - - - - Service Provider Control Key required state. - - - - - Corporate Control Key required state. - - - - - Card removed. - - - - - PH-SIM (phone-SIM) locked state. - - - - - Runtime SIM card error. - - - - - SIM card Powered OFF. - - - - - Unknown status. It can be the initial status. - - - - - Enumeration for the SIM card type. - - - - - Unknown card. - - - - - SIM(GSM) card. - - - - - USIM card. - - - - - CDMA card. - - - - - CDMA NV SIM. - - - - - IMS card. - - - - - Enumeration for the language preference code. - - - - - German. - - - - - English. - - - - - Italian. - - - - - French. - - - - - Spanish. - - - - - Dutch. - - - - - Swedish. - - - - - Danish. - - - - - Portuguese. - - - - - Finnish. - - - - - Norwegian. - - - - - Greek. - - - - - Turkish. - - - - - Hungarian. - - - - - Polish. - - - - - Korean. - - - - - Chinese. - - - - - Russian. - - - - - Japanese. - - - - - Unspecified. - - - - - Enumeration for the security lock type. - - - - - PH-SIM (phone-SIM) locked. Lock Phone to SIM/UICC card. - - - - - PH-FSIM (phone-first-SIM) Lock Phone to the very first inserted SIM/UICC card. - - - - - SIM Lock (PIN, PIN2, PUK, PUK2) Lock SIM/UICC card. - - - - - FDN - SIM card or active application in the UICC (GSM or USIM). - - - - - Network Personalization. - - - - - Network subset Personalization. - - - - - Service Provider Personalization. - - - - - Corporate Personalization. - - - - - Enumeration for the power state of the SIM. - - - - - Off state. - - - - - On state. - - - - - Unspecified state. - - - - - Enumeration for the file ID. - - - - - Root Directory for the USIM. - - - - - The ICC Identification file. - - - - - The IMSI file. - - - - - The SIM Service Table file. - - - - - The Enabled Service Table file. - - - - - The OPLMN List file. - - - - - The Group Identifier Level 1. - - - - - The Group Identifier Level 2. - - - - - The Extended Language Preference file. - - - - - SIM: Language preference. - - - - - The Emergency Call Codes. - - - - - The Service Provider Name. - - - - - The Service provider display information. - - - - - The PLMN Network Name File. - - - - - The Operator PLMN List File. - - - - - MSISDN. - - - - - Short Messages file. - - - - - SMS Parameter. - - - - - SMS Status. - - - - - Cell Broadcast Message Identifier. - - - - - SIM Mail Box Dialing Number file. - - - - - Mailbox Identifier - linear fixed. - - - - - Message Waiting Indication Status - linear fixed. - - - - - Call forward indication status - linear fixed. - - - - - CPHS voice MSG waiting indication. - - - - - CPHS service string table. - - - - - CPHS call forward flags. - - - - - CPHS operator name string. - - - - - CPHS customer service profile. - - - - - CPHS information. - - - - - CPHS mail box numbers. - - - - - CPHS operator name short form string. - - - - - CPHS information numbers. - - - - - CPHS Dynamics flags. - - - - - CPHS Dynamics2 flags. - - - - - CPHS CSP2. - - - - - Invalid file. - - - - - Element to indicate an unknown file. - - - - - Enumeration for the SIM number type. - - - - - Unknown. - - - - - International number. - - - - - National number. - - - - - Network specific number. - - - - - Subscriber number. - - - - - Alphanumeric, GSM 7-bit default alphabet. - - - - - Abbreviated number - - - - - Reserved for extension. - - - - - Enumeration for the numbering plan identifier. - - - - - Unknown. - - - - - ISDN/Telephone numbering plan. - - - - - Data numbering plan - - - - - Telex numbering plan - - - - - Service Center Specific plan. - - - - - Service Center Specific plan 2. - - - - - National numbering plan. - - - - - Private numbering plan. - - - - - ERMES numbering plan. - - - - - Reserved for extension. - - - - - Enumeration for the emergency service type. - - - - - Police. - - - - - Ambulance. - - - - - Fire brigade. - - - - - Marine guard. - - - - - Mountain rescue. - - - - - Spare. - - - - - Enumeration for the SIM app type. - - - - - SIM application. - - - - - USIM application. - - - - - CSIM application. - - - - - ISIM application. - - - - - Enumeration for the SIM access result from the lower layers. - - - - - Access to file is successful. - - - - - SIM card error. - - - - - File not found. - - - - - Access condition is not fulfilled. - - - - - Access failed. - - - - - Enumeration for the mailbox type. - - - - - Voicemail. - - - - - Fax. - - - - - Email. - - - - - Other. - - - - - Videomail. - - - - - Data. - - - - - Enumeration for the current CPHS phase of the SIM card. - - - - - Phase 1. - - - - - Phase 2. - - - - - RFU. - - - - - Enumeration for CDMA service table. - - - - - CDMA service table. - - - - - CSIM service table. - - - - - MAX value. - - - - - Enumeration for the SIM Authentication type. - - - - - IMS Authentication. - - - - - GSM Authentication. - - - - - 3G Authentication. - - - - - CDMA CAVE Authentication. - - - - - CDMA CHAP Authentication. - - - - - CDMA MNHA Authentication. - - - - - CDMA MIPRRQ Authentication. - - - - - CDMA MNAAA Authentication. - - - - - CDMA HRPD Authentication. - - - - - MAX value. - - - - - Enumeration for the SIM Authentication result. - - - - - Status - no error. - - - - - Status - can't perform authentication. - - - - - Status - skip authentication response. - - - - - Status - MAK(Multiple Activation Key) code failure. - - - - - Status - SQN(SeQuenceNumber) failure. - - - - - Status - synch failure. - - - - - Status - unsupported context. - - - - - Status - default error. - - - - - MAX value. - - - - - Enumeration for the PIN type. - - - - - PIN 1 code. - - - - - PIN 2 code. - - - - - PUK 1 code. - - - - - PUK 2 code. - - - - - Universal PIN - Unused now. - - - - - Administrator - Unused now. - - - - - SIM Lock code. - - - - - Enumeration for the PIN status. - - - - - Facility disabled. - - - - - Facility enabled. - - - - - Facility unknown. - - - - - Enumeration for the security lock key information. - - - - - Key not needed. - - - - - PIN required. - - - - - PUK required. - - - - - PIN2 required. - - - - - PUK2 required. - - - - - Permanent block SIM. - - - - - Enumeration for P-CSCF type. - - - - - Fully Qualified Domain Name. - - - - - IPv4. - - - - - IPv6. - - - - - Enumeration for the SIM power set result from the lower layers. - - - - - Power Set is successful. - - - - - Power Set failure. - - - - - Enumeration for the list of IST services in the ISIM Service Table (ISIM). - - - - - P-CSCF address. - - - - - Generic Bootstrapping Architecture. - - - - - HTTP Digest. - - - - - GBA-based Local Key Establishment Mechanism. - - - - - Support of P-CSCF discovery for IMS Local Break Out. - - - - - Short Message Storage. - - - - - Short Message Status Reports. - - - - - Support for SM-over-IP including data download via SMS-PP as defined in TS 31.111 [31] - - - - - Communication Control for IMS by ISIM. - - - - - Support of UICC access to IMS. - - - - - URI support by UICC. - - - - - Enumeration for the list of SST services in the SIM Service Table (GSM). - - - - - CHV1 disable function. - - - - - Abbreviated Dialing number. - - - - - Fixed Dialing number. - - - - - Short message storage. - - - - - Advice of charge. - - - - - Capability configuration parameters. - - - - - PLMN selector. - - - - - RFU. - - - - - MSISDN. - - - - - Extension 1. - - - - - Extension 2. - - - - - SMS parameters. - - - - - Last number dialed. - - - - - Cell broadcast message identifier. - - - - - Group identifier level 1. - - - - - Group identifier level 2. - - - - - Service provider name. - - - - - Service Dialing number. - - - - - Extension3. - - - - - RFU. - - - - - VGCS group identifier (EF-VGCS, EF-VGCSS). - - - - - VBS group identifier (EF-VBS, EF-VBSS). - - - - - Enhanced multi-level precedence and pre-emption service. - - - - - Automatic answer for EMLPP. - - - - - Data download via SMS-CB. - - - - - Data download via SMS-PP. - - - - - Menu selection. - - - - - Call control. - - - - - Proactive SIM command. - - - - - Cell broadcast message identifier ranges. - - - - - Barred Dialing numbers. - - - - - Extension 4. - - - - - De-personalization control keys. - - - - - Co-operative network list. - - - - - Short message status reports. - - - - - Network's indication of alerting in the MS (NIA). - - - - - Mobile-originated short message control by SIM. - - - - - GPRS. - - - - - Image. - - - - - Support of local service area. - - - - - USSD string data object supported in call control. - - - - - Run at COMMAND command. - - - - - User controlled PLMN selector with Access technology. - - - - - Operator controlled PLMN selector with Access technology. - - - - - HPLMN selector with access technology. - - - - - CPBCCH information. - - - - - Investigation scan. - - - - - Extended capability configuration parameters. - - - - - MExE. - - - - - RPLMN last used access technology. - - - - - PLMN Network Name. - - - - - Operator PLMN List. - - - - - Mailbox Dialling Numbers. - - - - - Message Waiting Indication Status. - - - - - Call Forwarding Indication Status. - - - - - Service Provider Display Information. - - - - - Enumeration for the list of UST services in the SIM Service Table (USIM). - - - - - Local phone book. - - - - - Fixed Dialing number. - - - - - Extension 2. - - - - - Service Dialing number. - - - - - Extension 3. - - - - - Barred Dialing numbers. - - - - - Extension 4. - - - - - Outgoing call information. - - - - - Incoming call information. - - - - - Short message storage. - - - - - Short message status reports. - - - - - SMS parameters. - - - - - Advice of charge. - - - - - Capability configuration parameters. - - - - - Cell broadcast message identifier. - - - - - Cell broadcast message identifier ranges. - - - - - Group identifier level 1. - - - - - Group identifier level 2. - - - - - Service provider name. - - - - - User controlled PLMN selector with Access technology. - - - - - MSISDN. - - - - - Image. - - - - - Support of local service area. - - - - - Enhanced multi-level precedence and pre-emption service. - - - - - Automatic answer for EMLPP. - - - - - RFU. - - - - - GSM access. - - - - - Data download via SMS-PP. - - - - - Data download via SMS-CB. - - - - - Call control by USIM. - - - - - Mobile-originated short message control by USIM. - - - - - Run at COMMAND command. - - - - - Shall be set to 1. - - - - - Enabled service table. - - - - - APN control list. - - - - - De-personalization control keys. - - - - - Co-operative network list. - - - - - GSM security context. - - - - - CPBCCH information. - - - - - Investigation scan. - - - - - MExE. - - - - - Operator controlled PLMN selector with Access technology. - - - - - HPLMN selector with access technology. - - - - - Extension 5. - - - - - PLMN Network Name. - - - - - Operator PLMN List. - - - - - Mailbox Dialling Numbers. - - - - - Message Waiting Indication Status. - - - - - Call Forwarding Indication Status. - - - - - RPLMN last used access technology. - - - - - Service Provider Display Information. - - - - - Multi media messaging service. - - - - - Extension 8. - - - - - Call control on GPRS by USIM. - - - - - MMS user connectivity parameters. - - - - - Network's indication of alerting in the MS (NIA). - - - - - VGCS group identifier List (EF-VGCS, EF-VGCSS). - - - - - VBS group identifier List (EF-VBS, EF-VBSS). - - - - - Pseudonym. - - - - - User controlled PLMN selector for I-WLAN access. - - - - - Operator controlled PLMN selector for I-WLAN access. - - - - - User controlled WSID list. - - - - - Opertor controlled Wsid list. - - - - - VGCS security. - - - - - Enumeration for the list of CST services in the CDMA Service Table. - - - - - CHV Disable Option. - - - - - Abbreviated Dialing number. - - - - - Fixed Dialing number. - - - - - Short message storage. - - - - - HRPD. - - - - - Enhanced Phone Book. - - - - - Multimedia domain. - - - - - SF_EUIMID- based EUIMID. - - - - - MEID. - - - - - Extension 1. - - - - - Extension 2. - - - - - SMS parameters. - - - - - Last number dialled. - - - - - Service Category Program for BC-SMS. - - - - - RFU. - - - - - RFU. - - - - - CDMA Home Service Provider Name. - - - - - Service Dialing number. - - - - - Extension 3. - - - - - 3GPD-SIP. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - Data download by SMS broadcast. - - - - - Data download by SMS PP. - - - - - Menu Selection. - - - - - Call Control. - - - - - Proactive RUIM. - - - - - AKA. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - RFU. - - - - - 3GPD- MIP. - - - - - BCMCS. - - - - - Multimedia messaging service. - - - - - Extension 8. - - - - - MMS User Connectivity Parameters. - - - - - Application Authentication. - - - - - Group Identifier Level 1. - - - - - Group Identifier Level 2. - - - - - Depersonalisation control keys. - - - - - Co-operative Network List. - - - - - Enumeration for the list of CST services in the CSIM Service Table (CSIM). - - - - - Local Phone book. - - - - - Fixed Dialing Numbers (FDN). - - - - - Extension 2. - - - - - Service Dialing Numbers (SDN). - - - - - Extension 3. - - - - - Short Message Storage (SMS). - - - - - Short Message Parameters. - - - - - HRPD. - - - - - Service Category Program for BC-SMS. - - - - - CDMA Home Service Provider Name. - - - - - Data Download via SMS Broadcast. - - - - - Data Download via SMS-PP. - - - - - Call Control. - - - - - 3GPD-SIP. - - - - - 3GPD-MIP. - - - - - AKA. - - - - - IP-based Location Services (LCS). - - - - - BCMCS. - - - - - Multimedia Messaging Service (MMS). - - - - - Extension 8. - - - - - MMS User Connectivity Parameters. - - - - - Application Authentication. - - - - - Group Identifier Level 1. - - - - - Group Identifier Level 2. - - - - - De-Personalization Control Keys. - - - - - Cooperative Network List. - - - - - Outgoing Call Information (OCI). - - - - - Incoming Call Information (ICI). - - - - - Extension 5. - - - - - Multimedia Storage. - - - - - Image (EFIMG). - - - - - Enabled Services Table. - - - - - Capability Configuration Parameters (CCP). - - - - - SF_EUIMID-based EUIMID. - - - - - Messaging and 3GPD Extensions. - - - - - Root Certificates. - - - - - WAP Browser. - - - - - Java. - - - - - Reserved for CDG. - - - - - Reserved for CDG. - - - - - IPv6. - - - - - A class which defines incoming SMS message notification data. - - - - - SCA. - - Sca value represented in string. - - - - Message length. - - Length of incoming message. - - - - Data. - - Data representing incoming message information. - - - - SMS format. - - Format of the incoming SMS. - - - - A class which defines incoming CB message notification data. - - - - - Cell Broadcast message type. - - Type of cell broadcast message. - - - - Size of MsgData (which is the actual TPDU message). - - Length of message data. - - - - Cell broadcast message data. - - Message data representing cell broadcast message. - - - - A class which defines incoming ETWS message notification data. - - - - - ETWS message type. - - Type of ETWS message. - - - - Size of MsgData (which is the actual TPDU message). - - Length of message data. - - - - ETWS message data. - - Message data representing ETWS message. - - - - Enumeration for the type of sms network. - - - - - Network type is 3gpp. - - - - - Network type is 3gpp2 (CDMA). - - - - - Enumeration for different CB message types. - - - - - GSM Cell broadcast message. - - - - - UMTSCell broadcast message. - - - - - CDMA broadcast message. - - - - - Enumeration for different ETWS message types. - - - - - Primary ETWS message. - - - - - GSM Secondary ETWS message. - - - - - UMTS Secondary ETWS message. - - - - - CDMA Seconday ETWS message. - - - - - Enumeration for memory status type. - - - - - PDA memory is available. - - - - - PDA memory is full. - - - - - Phone memory is available. - - - - - Phone memory is full. - - - - - Enumeration for the sms ready status type. - - - - - Non Ready Status. - - - - - SMS 3GPP Ready. - - - - - SMS 3GPP2 Ready. - - - - - SMS 3GPP and 3GPP2 Ready. - - - - - Enumeration for sms status type. - - - - - MT message, stored and read. - - - - - MT message, stored and unread. - - - - - MO message, stored and sent. - - - - - MO message, stored but not sent. - - - - - Delivered at destination. - - - - - Service centre forwarded message but is unable to confirm delivery. - - - - - Message has been replaced. - - - - - Reserved for future use. - - - - - Enumeration for different response types that come in the sent status acknowledgement/notification after sending a message to the network. - - - - - Message sent successfully. - - - - - Message routing not available. - - - - - Invalid parameter present in TPDU - - - - - Device failure. - - - - - Reserved Service. - - - - - Invalid location. - - - - - No SIM error. - - - - - SIM not ready error. - - - - - No response from network. - - - - - Destination address restricted. - - - - - Service center address restricted. - - - - - Resend an already done operation. - - - - - SCA address not available. - - - - - Unassigned number. - - - - - Operator determined barring. - - - - - Call barred. - - - - - Message transfer rejected. - - - - - Message capacity exceeded/memory full. - - - - - Destination number out of service. - - - - - Unspecified subscriber. - - - - - Facility rejected. - - - - - Unknown subscriber. - - - - - Network out of order. - - - - - Temporary failure. - - - - - Congestion occured. - - - - - Resource unavilable. - - - - - Facility not subscribed by the user. - - - - - Facility not implemented. - - - - - Invalid reference value. - - - - - Invalid message. - - - - - Invalid mandatory information. - - - - - Message type not implemented. - - - - - Message not compact protocol. - - - - - Information element not implemented. - - - - - Protocol error. - - - - - Networking error. - - - - - Sms ME full. - - - - - Sms sim full. - - - - - Timeout error. - - - - - A class which manages Supplementary Services of the SIM. - - - - - A constructor to instantiate Ss class using the Tapi handle. - - An instance of TapiHandle obtained from InitTapi in TapiManager API. - Thrown when handle is passed as null. - - - - Sends a request to activate/deactivate call barring. - - The information about call barring. - A task containing an instance of SsBarringResponse which contains information about barring response. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when barring info is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets call barring status. - - The type of call. - The barring type. - A task containing information about barring response. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Allows changing of the barring password in the network. - - The old password set for Barring in the Network. - The new password set for Barring in the Network. - The new password again. - A task indicating whether the change of password is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when any of the parameter is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Allows to set the (register/erase/activate/deactivate) call forwarding option at the network. - - The Call forward information such as a forward mode, a forward type, and so on. - A task containing information about SS forward response. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when forward info is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Provides an option to get the call forwarding status of different calls from the Network. - - The Forward call type. - The forward condition. - A task containing SS forward response information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Activates/deactivates the call waiting service. - - The status of call-waiting service. - A task containing SS waiting response information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when waiting info is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the status of the call waiting service. - - The call types. - A task containing information about SS waiting response. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Activates/deactivates the status of the calling line identity service. - - The Cli service type. - The Cli Status. - A task indicating whether setting of CLI status is done or not. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the status of the calling line identity service. - - The Cli service type. - A task containing SS CLI response information. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Sends a USSD string or User response to the Network. - - The data coding scheme used - A task containing SS USSD response information. - http://tizen.org/feature/network.telephony - platform - http://tizen.org/privilege/telephony.admin - Thrown when telephony feature is not supported. - Thrown when privilege access is denied. - Thrown when Ussd message info is passed as null. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - A class which defines values for USSD request type. Applicable to 3GPP(GSM/UMTS/LET) only. - - - - - USSD type. - - Type of USSD represented in SsUssdType enum. - - - - DCS. - - Dcs value represented in byte. - - - - USSD string length. - - Length of USSD string in integer. - - - - USSD string. - - Ussd string represented in string. - - - - A class which defines release complete message notification type. - - - - - Specifies the Release complete messageg length. - - Length of release complete message in byte. - - - - Specifies the release complete message. - - Release complete message represented in byte array. - - - - A class which defines SS forward record information. - - - - - SS class - - SS class type. - - - - Call forwarding SS status. - - Status of SS call forwarding. - - - - Call forward types providing various conditions when a call can be forwarded. - - Forwarding condition of SS call forward. - - - - Flag that indicates whether call forwarding number is present. - - Boolean value to check the presence of call forwarding number. - - - - No reply time. - - Waiting time when there is no reply. - - - - Type of number. - - SS call forward type of number. - - - - Numbering Plan Identity. - - SS call forward numbering plan identity. - - - - Forwarded number. - - Call forwarding number. - - - - A class which defines values for SS call forwarding record. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Record number. - - Record value represented in integer. - - - - Specifies the maximum of SS forward records. - - A list of instances of SsForwardRecord. - - - - A class which defines SS call barring record information. - - - - - SS class - - SS class type. - - - - SS status. - - Status of SS call barring. - - - - Call barring types providing various barring conditions on which calls are barred. - - Type of SS call barring. - - - - A class which defines values for SS call barring record. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Record number. - - Record value represented in integer. - - - - Specifies the maximum of SS barring records. - - A list of instances of SsBarringRecord. - - - - A class which defines SS waiting record information. - - - - - SS class - - SS class type. - - - - SS status. - - Status of SS call waiting. - - - - A class which defines values for SS call waiting record. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Record number. - - Record value represented in integer. - - - - Specifies the maximum of SS waiting records. - - A list of instances of SsWaitingRecord. - - - - A class which defines SUPS information message notification type. - - - - - SS error cause. - - Ss request result. - - - - SUPS information. - - Ss information type. - - - - A class which defines parameters related to call barring. - - - - - A constructor for instantiating SsBarringInfo class with the necessary parameters. - - Call type. - Barring mode. - Barring type. - Password (3GPP(GSM/UMTS/LTE) Specific). - - - - A class which defines the parameters related to forward info. - - - - - A constructor for instantiating SsForwardInfo class with the necessary parameters. - - SS Class. - Forward Mode. - Forward Condition. - No reply wait time 5-30 secs in intervals of 5(3GPP(GSM/UMTS/LTE) Specific). - Type of number. - Numbering plan identity. - Phone number. - - - - A class which defines parameters related to call waiting. - - - - - A constructor for instantiating SsWaitingInfo class with necessary parameters. - - Call type. - Call waiting mode. - - - - A class which defines values for calling line identity service. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Various line identification types. - - - - - Line identification status from the network. - - - - - A class which defines USSD response data. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - USSD Type. - - - - - USSD Status. - - - - - DCS. - - - - - USSD string length. - - - - - USSD String. - - - - - Enumeration for the SS class type. - - - - - All Teleservices. - - - - - Voice (Telephony). - - - - - All Data Teleservices. - - - - - Fax Service. - - - - - SMS Service. - - - - - Voice Group Call Service. - - - - - Voice Broadcast. - - - - - All teleservices except SMS. - - - - - All Bearer services. - - - - - All Async services. - - - - - All Sync services. - - - - - All Circuit switched sync services. - - - - - All Circuit switched async services. - - - - - All Dedicated Packet Access. - - - - - All Dedicated PAD Access. - - - - - All Data CDA. - - - - - All PLMN specific teleservices. - - - - - PLMN specific teleservice 1. - - - - - PLMN specific teleservice 2. - - - - - PLMN specific teleservice 3. - - - - - PLMN specific teleservice 4. - - - - - PLMN specific teleservice 5. - - - - - PLMN specific teleservice 6. - - - - - PLMN specific teleservice 7. - - - - - PLMN specific teleservice 8. - - - - - PLMN specific teleservice 9. - - - - - PLMN specific teleservice 10. - - - - - PLMN specific teleservice 11. - - - - - PLMN specific teleservice 12. - - - - - PLMN specific teleservice 13. - - - - - PLMN specific teleservice 14. - - - - - PLMN specific teleservice 15. - - - - - All PLMN specific bearer services. - - - - - PLMN specific bearer service 1. - - - - - PLMN specific bearer service 2. - - - - - PLMN specific bearer service 3. - - - - - PLMN specific bearer service 4. - - - - - PLMN specific bearer service 5. - - - - - PLMN specific bearer service 6. - - - - - PLMN specific bearer service 7. - - - - - PLMN specific bearer service 8. - - - - - PLMN specific bearer service 9. - - - - - PLMN specific bearer service 10. - - - - - PLMN specific bearer service 11. - - - - - PLMN specific bearer service 12. - - - - - PLMN specific bearer service 13. - - - - - PLMN specific bearer service 14. - - - - - PLMN specific bearer service 15. - - - - - Auxiliary Voice (Auxiliary telephony). - - - - - All GPRS bearer services. - - - - - All tele and bearer services. - - - - - Enumeration for various types of call barring. - - - - - Barring All Outgoing Calls. - - - - - Barring Outgoing International Calls. - - - - - Barring Outgoing International Calls except Home Country. - - - - - Barring All Incoming Calls. - - - - - Barring Incoming Calls when roaming outside the Home Country. - - - - - All Barring Services. - - - - - All Outgoing Barring Services. - - - - - All Incoming Barring Services. - - - - - Barring Incoming Calls which is not stored in the SIM memory. - - - - - Maximum Barring type. - - - - - Enumeration for the CLI service type. - - - - - Calling Line Identification Presentation. - - - - - Calling Line Identification Restriction. - - - - - Connected Line Identification Presentation. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Connected Line Identification Restriction. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Called Line Identification Presentation. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Calling Name Presentation. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Enumeration for the CLI service status. - - - - - Service not provided by the service provider. - - - - - Service is provided by the service provider. - - - - - Service is activated at the network. - - - - - Service status is unknown. - - - - - Service is temporarily restricted. - - - - - Service is temporarily allowed. - - - - - Enumeration for the call forwarding condition. - - - - - Call Forwarding Unconditional. - - - - - Call Forwarding Mobile Busy. - - - - - Call Forwarding No Reply. - - - - - Call Forwarding Not Reachable. - - - - - All Call Forwarding. - - - - - All Conditional Call Forwarding. - - - - - Max. - - - - - Enumeration for the USSD type. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - USSD request type - User Initiated. - - - - - USSD request type - User Response. - - - - - USSD request type - User Release. - - - - - Enumeration for the status of a supplementary service feature (e.g. call forwarding or call barring). - - - These enumerated values should be used as masks. - - - - - - Provisioned but not registered (or active/active-quiescent). - - - - - - - Not provisioned. - - - - - Enumeration for no-reply time. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Timer value set to 5secs. - - - - - Timer value set to 10secs. - - - - - Timer value set to 15secs. - - - - - Timer value set to 20secs. - - - - - Timer value set to 25secs. - - - - - Timer value set to 30secs. - - - - - Enumeration for the call forwarding type of number. - - - - - Unknown. - - - - - International number. - - - - - National number. - - - - - Network specific number. - - - - - Subscriber number. - - - - - Alphanumeric, GSM 7-bit default alphabet. - - - - - Abbreviated number. - - - - - Reserved for extension. - - - - - Enumeration for the call forward numbering plan identity. - - - - - Unknown. - - - - - ISDN/Telephone numbering plan. - - - - - Data numbering plan. - - - - - Telex numbering plan. - - - - - Service Center Specific plan. - - - - - Service Center Specific plan2. - - - - - National numbering plan. - - - - - Private numbering plan. - - - - - ERMES numbering plan. - - - - - Reserved for extension. - - - - - Enumeration for the supplementary service request results. - - - - - SS operation is successful. - - - - - SS error indicating unknown/illegal subscriber - - - - - This error is returned when illegality of the access has been established by use of an authentication procedure. - - - - - The network returns this error when it is requested to perform an operation on a supplementary service. - - - - - The network returns this error when it is requested to perform an operation on a supplementary service. - - - - - This error is returned when the IMEI check procedure has shown that the IMEI is blacklisted or it is not whitelisted. - - - - - This error is returned by the network to the MS when call independent subscriber control procedures are barred by the operator. - - - - - This error is returned by the network when it is requested to perform an illegal operation which is defined as not applicable for the relevant supplementary service. - - - - - This error is returned by the network when it is requested to perform an operation which is not compatible with the current status of the relevant supplementary service. - - - - - SS not available in the network. - - - - - SS service subscription violation. - - - - - This error is returned by the network when it is requested for a supplementary service operation that is incompatible with the status of another supplementary service or with the teleservice or bearer service for which the operation is requested. - - - - - SS service facility not supported. - - - - - This error is returned when the subscriber has activated the detach service or the system detects the absence condition. - - - - - This error is returned by the network, when it cannot perform an operation because of a failure in the network. - - - - - This error is returned by the network when an optional parameter is missing in an invoke component or an inner data structure, while it is required by the context of the request. - - - - - SS error indicating an unexpected data value on the network side. - - - - - SS error indicating a change password failure. - - - - - SS error indicating a negative password check. - - - - - SS error indicating violation in barring password attempts. - - - - - SS error indicating unknown SS data coding of an alphabet. - - - - - SS error indicating USSD Busy(Already SS / USSD is ongoing). - - - - - SS error indicating Dialing number is not FDN. - - - - - SS operation rejected by the user. - - - - - SS operation rejected by the network. - - - - - This error is returned if a diversion to the served subscriber's number is requested. - - - - - This error is returned if a diversion to a special service code is requested. - - - - - SS error indicating invalid deflected to a number. - - - - - SS error indicating Maximum MPTY is reached. - - - - - SS error indicating resources not available in the network. - - - - - SS error indicating resources not available in the network. - - - - - SS operation timer expired on the network. - - - - - SS operation is not allowed by the network. - - - - - SS error indicating an unknown error. - - - - - If OEM does not support any SS requests, then this error will be returned. - - - - - Enumeration for SS info type. - - - - - Barring. - - - - - Forwarding. - - - - - Waiting. - - - - - CLI. - - - - - Send Ussd. - - - - - Max value. - - - - - Enumeration for the call barring operation mode. - - - - - Activate call barring. - - - - - Deactivate call barring. - - - - - Enumeration for the forward mode. - - - - - Deactivate call forwarding. - - - - - Activate call forwarding. - - - - - Register call forwarding. - - - - - Deregister call forwarding. - - - - - Enumeration for the call waiting mode. - - - - - Activate call waiting. - - - - - Deactivate call waiting. - - - - - Enumeration for the types of identity presentation / restriction services. - - - - - Identify the party calling this phone. - - - - - Hide the identity of this phone when calling others. - - - - - Identify the party to whom the calling party (this phone) is connected. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Restrict yourself from being identified by incoming calls, such as forwarded calls. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Called line identity presentation. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Calling Name Presentation. 3GPP(GSM/UMTS/LTE) Specific. - - - - - Enumeration for the USSD indication type. Applicable to 3GPP(GSM/UMTS/LTE) only. - - - - - Notify : to display USSD data to the user. - - - - - No further user action required. - - - - - Further user action required. - - - - - USSD terminated by the network. - - - - - Other local client has responded. - - - - - Operation not supported. - - - - - Time out when there is no response from the network. - - - - - Enumerations for the types of Notification. - - - - - Voice call idle status notification. - - Instance of CallIdleStatusNotificationData will be stored in Data property of NotificationChangedEventArgs. - - - - Voice call active status notification. - - Active call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Voice call held status notification. - - Held call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Voice call dialing status notification. - - Dialing call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Voice call alerting status notification. - - Alert call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Voice call incoming status notification. - - Instance of CallIncomingInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Video call idle status notification. - - Instance of CallIdleStatusNotificationData will be stored in Data property of NotificationChangedEventArgs. - - - - Video call active status notification. - - Active call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Video call dialing status notification. - - Dialing call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Video call alerting status notification. - - Alert call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Video call incoming status notification. - - Instance of CallIncomingInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Outgoing call waiting nofificaiton. - - Waiting call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Outgoing call forwarded notification. - - Forward call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Incoming call barred notification. - - Barred incoming call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Outgoing call barred notification. - - Barred outgoing call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Mo call deflected notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - CLIR suppression reject notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - Unconditional call forward active notification. - - Unconditional forward call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Conditional call forward active notification. - - Conditional forward call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Incoming call forwarded notification. - - Forward call Id will be stored in Data property of NotificationChangedEventArgs. - - - - MT deflected call notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - MT transferred call notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - Call is in held notification. - - Held call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Call is in retrieved notificaiton. - - Active call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Call in in multiparty notificaiton. - - Joined call Id will be stored in Data property of NotificationChangedEventArgs. - - - - Call transfer alerting notificaiton. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - Call forward check message notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - New call information notification (CDMA only). - - Instance of CallRecord will be stored in Data property of NotificationChangedEventArgs. - - - - Call info fallback notification. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - Voice privacy mode change notification (CDMA only). - - CallPrivacyMode will be stored in Data property of NotificationChangedEventArgs. - - - - OTASP(Over The Air Service Provisioning) status notification (CDMA only). - - CallOtaspStatus will be stored in Data property of NotificationChangedEventArgs. - - - - OTAPA(Over The Air Parameter Administration) status notification (CDMA only). - - CallOtapaStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Call signal information notification (CDMA only). - - Instance of CallSignalNotification will be stored in Data property of NotificationChangedEventArgs. - - - - Call sound patch change notification. - - SoundPath will be stored in Data property of NotificationChangedEventArgs. - - - - Call ringback tone sound patch change notification. - - CallSoundRingbackNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Call sound WB-AMR(Wide Band Adaptive Multi-Rate) status notification. - - CallSoundWbamrNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Call sound noise reduction notification. - - CallSoundNoiseReduction will be stored in Data property of NotificationChangedEventArgs. - - - - Call sound clock status notification. - - Boolean status value will be stored in Data property of NotificationChangedEventArgs. - - - - Preferred voice subscription notification. - - CallPreferredVoiceSubscription will be stored in Data property of NotificationChangedEventArgs. - - - - VoLTE call which can provide upgrade/downgrade - caller/callee are all in VoLTE call. - - Nothing is stored in Data property of NotificationChangedEventArgs. - - - - VoLTE call for which upgrade call request is initiated from MT. - - CallUpgradeDowngradeRequestNoti will be stored in Data property of NotificationChangedEventArgs. - - - - VoLTE call for which downgrade call request is initiated from MT. - - CallUpgradeDowngradeRequestNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Modem power notification. - - PhonePowerStatus will be stored in Data property of NotificationChangedEventArgs. - - - - SIM status notification. - - SimCardStatus will be stored in Data property of NotificationChangedEventArgs. - - - - SIM refresh notification. - - SatCmdQualiRefresh will be stored in Data property of NotificationChangedEventArgs. - - - - Sap card status notification. - - SatCmdQualiRefresh will be stored in Data property of NotificationChangedEventArgs. - - - - Sap disconnect type notification. - - - - - Sat setup menu notification. - - Instance of SatMainMenuInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Sat display text notification. - - Instance of SatDisplayTextData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat select item notification. - - Instance of SatSelectItemData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat get inkey notification. - - Instance of SatGetInKeyData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat get input notification. - - Instance of SatGetInputData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat refresh notification. - - Instance of SatRefreshData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat send sms notification. - - Instance of SatSendSmsData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat setup event list notification. - - Instance of SatEventListData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat send dtmf notification. - - Instance of SatSendDtmfData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat end proactive session notification. - - SatCommandType will be stored in Data property of NotificationChangedEventArgs. - - - - Sat call control result notification. - - Instance of SatCallCtrlConfirmData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat mo sms control result notification. - - Instance of SatMoSmsCtrlData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat setup call notification. - - Instance of SatSetupCallData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat send SS notification. - - Instance of SatSendSsData will be stored in Data property of NotificationChangedEventArgs. - - - - Sat setup USSD notification. - - Instance of SatSetupUssdData will be stored in Data property of NotificationChangedEventArgs. - - - - Phonebook status notification. - - Instance of SimPhonebookStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Phonebook change notification. - - Instance of PhonebookContactChangeInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Network registration status notification. - - Instance of NetworkRegistrationStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Network cell information notification. - - Instance of NetworkCellNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Network change notification. - - Instance of NetworkChangeNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Network time information notification. - - Instance of NetworkTimeNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Network identity notification. - - Instance of NetworkIdentityNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Network signal strength notification. - - Signal Strength in dBm will be stored in Data property of NotificationChangedEventArgs. - - - - Network emergency callback mode notification. - - NetworkEmergencyCallbackMode will be stored in Data property of NotificationChangedEventArgs. - - - - Network default data subscription notification. - - NetworkDefaultDataSubscription will be stored in Data property of NotificationChangedEventArgs. - - - - Network default subscription notification. - - NetworkDefaultSubscription will be stored in Data property of NotificationChangedEventArgs. - - - - Network cell ID. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network LAC (Location Area Code). - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network TAC (Tracking Area Code). - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network system ID. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network network ID. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network base station ID. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network base station latitude. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network base station longitude. - - Int value will be stored in Data property of NotificationChangedEventArgs. - - - - Network VoLTE status notification. - - Instance of NetworkVolteStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Network EPDG status notification. - - Boolean value will be stored in Data property of NotificationChangedEventArgs. - - - - Ss ussd receive notification. - - Instance of SsUssdMsgInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Ss release complete notification. - - Instance of SsReleaseCompleteMsgInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Ss call forwarding status notification. - - Instance of SsForwardResponse will be stored in Data property of NotificationChangedEventArgs. - - - - Ss call barring status notification. - - Instance of SsBarringResponse will be stored in Data property of NotificationChangedEventArgs. - - - - Ss call waiting status notification. - - Instance of SsWaitingResponse will be stored in Data property of NotificationChangedEventArgs. - - - - Ss information notification. - - Instance of SsInfo will be stored in Data property of NotificationChangedEventArgs. - - - - Sms incoming message notification. - - Instance of SmsIncomingMessageNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Sms cell broadcast message incoming notification. - - Instance of SmsIncomingCbMessageNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Sms ETWS(Earthquake and Tsunami Warning System) message incoming notification. - - Instance of SmsIncomingEtwsMessageNoti will be stored in Data property of NotificationChangedEventArgs. - - - - Sms device memory status notification. - - SmsMemoryStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Sms ready notification. - - SmsReadyStatus will be stored in Data property of NotificationChangedEventArgs. - - - - Oem data notification. - - Instance of OemData will be stored in Data property of NotificationChangedEventArgs. - - - - Enumerations for the types of property definition. - - - - - Modem power property. - - PhonePowerStatus will be stored in Property property of PropertyChangedEventArgs. - - - - Modem dongle status property. - - Boolean value will be stored in Property property of PropertyChangedEventArgs. - - - - Modem dongle login property. - - Boolean value will be stored in Property property of PropertyChangedEventArgs. - - - - SIM call forward state property. - - Boolean value will be stored in Property property of PropertyChangedEventArgs. - - - - Network LAC (Location Area Code) property. - - Unsigned int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network TAC (Tracking Area Code) property (for LTE network). - - Unsigned int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network PLMN property. - - String value will be stored in Property property of PropertyChangedEventArgs. - - - - Network cell-id property. - - Unsigned int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network physical cell-id property. - - Unsigned int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network service type property. - - NetworkServiceType will be stored in Property property of PropertyChangedEventArgs. - - - - Network access technology property. - - NetworkSystemType will be stored in Property property of PropertyChangedEventArgs. - - - - Network ps type property. - - NetworkPsType will be stored in Property property of PropertyChangedEventArgs. - - - - Network circuit status property. - - NetworkServiceLevel will be stored in Property property of PropertyChangedEventArgs. - - - - Network packet status property. - - NetworkServiceLevel will be stored in Property property of PropertyChangedEventArgs. - - - - Network roaming status property. - - Boolean value will be stored in Property property of PropertyChangedEventArgs. - - - - Network name option property. - - NetworkNameDisplayCondition will be stored in Property property of PropertyChangedEventArgs. - - - - Network name property. - - String value will be stored in Property property of PropertyChangedEventArgs. - - - - SPN name property stored in SIM card. - - String value will be stored in Property property of PropertyChangedEventArgs. - - - - Network signal dbm property. - - Int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network signal level property. - - Int value will be stored in Property property of PropertyChangedEventArgs. - - - - Network ims voice support status property. - - Boolean value will be stored in Property property of PropertyChangedEventArgs. - - - - Network volte enable status notification. - - VolteNetworkType will be stored in Property property of PropertyChangedEventArgs. - - - - Network serving LTE band property. - - NetworkLteBandType will be stored in Property property of PropertyChangedEventArgs. - - - - An extended EventArgs class which contains changed tapi state. - - - - - Tapi ready state. - - - - - An extended EventArgs class which contains changed TAPI notification. - - - - - Notification Id. - - - - - Notification data. - - - - - An extended EventArgs class which contains changed TAPI property. - - - - - Property definition type. - - - - - Property data. - - - - - This class is used for managing event callbacks for notifications and properties. - - - - - This event is called for the TAPI notification change. - - - - - This event is called for the TAPI property change. - - - - - Registers a notification callback for notification change events on DBus interface. - - Notification id for which a callback has to be registered. - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Registers a notification callback for property change events on DBus interface. - - Property definition for which a callback has to be registered. - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Deregisters notification callback for notification change events on DBus interface. - - Notification id for which the callback has to be de-registered. - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Deregisters notification callback for property change events on DBus interface. - - Property definition for which the callback has to be de-registered. - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the property value in an integer format for the given property. - - The property to be retrieved from Dbus. - The property value in integer format. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when permission is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - Gets the property value in a string format for the given property. - - The property to be retrieved from Dbus. - The property value in string format. - http://tizen.org/feature/network.telephony - http://tizen.org/privilege/telephony - Thrown when telephony feature is not supported. - Thrown when permission is denied. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - - This class is used for initializing/deinitializing Tapi and manages the state of it. - - - - - Gets the state value if tapi is ready. - - The State value in integer format - 0 is False and 1 is True. Returns -1 in case of error. - - - - This event is raised when Tapi ready state changes. - - - - - Fetches a list of available CPs. - - List of available CPs in case of success. Null in case of failure. - http://tizen.org/feature/network.telephony - - - - Acquires a TAPI Handle for the specified CP name. - - The CP Name against which a TAPI handle is required (A NULL CP Name will return a #TapiHandle bound to the first CP in the list of available CPs). - Instance of TapiHandle on success, null on failure. - http://tizen.org/feature/network.telephony - - - - Deinitializes the TAPI Handle. - - http://tizen.org/feature/network.telephony - Thrown when telephony feature is not supported. - Thrown when it is failed due to invalid parameter. - Thrown when it is failed due to invalid operation. - - - + + + + Tizen.Tapi + + + + + Interop class for Tapi + + + + + Tapi Native Apis + + + + + This class provides functions to manage call related setup and methods. + + + + + A public constructor for Call class to create a Call instance for the given tapi handle. + + The tapi handle. + + + + Setup the call to be dialled asynchronously. + + Information of call type and number. + A task indicating whether the DialCall method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when CallInformation argument is null. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Supports answering the incoming call by accepting or rejecting the call asynchronously. + + Unique handle that refer to the call. + The answer type. + The call id of answer call. This call handle is available to the application through an incoming call(IncomingVoiceCall) event. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + There can be a maximum of one existing call. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Releases the call asynchronously irrespective of whether the call is in the hold or active state. + + Unique handle that refer to the call. + The end call type. + Instance of CallEndData. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + There should be an existing call in the active/hold state. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Puts the given call on hold asynchoronously. + + Unique handle for referring the call. + The call id of hold call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + The call should be in the active state. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Retrieves the call being held asynchoronously. + + Unique handle for referring the call. + The call id of active call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + Call should be in the held state in order to retrieve it into the active state unless no active call is present. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Swaps calls asynchoronously. This is only for calls dialed or answered with Telephony. + + Active call. + Held call. + The call id of swap call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Starts continuous dtmf by sending a single digit during the call asynchronously. + + The dtmf digit to be sent. + A task indicating whether the StartContDtmfCall method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + An active call should be present. This is to be invoked in the following cases: + i. Key Release (post key press) during on-going call. + ii. Dtmf digits passed with PAUSE(,) or WAIT(;). + In case of PAUSE and WAIT, every StartContDtmfCall() call needs to be followed by StopContDtmfCall() sequentially (for every digit) without waiting for response from StartContDtmfCall(). + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Stops continuous dtmf during the call asynchronously. + + A task indicating whether the StopContDtmfCall method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + An active call should be present. This is to be invoked in the following cases: + i. Key Release (post key press) during on-going call. + ii. Dtmf digits passed with PAUSE(,) or WAIT(;). + Every StartContDtmfCall() call needs to be followed by StopContDtmfCall() sequentially. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Send one or more dtmf digits during the call asynchronously. + + A burst dtmf info containing dtmf string, pulse width, and inter digit interval. + A task indicating whether the SendBurstDtmfCall method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + There will be a single asynchronous notification for all the dtmf digits sent. If the users of this API need an asynchronous + response for each dtmf digit then the user has to call this API multiple times passing each single dtmf digit in CallBurstDtmfData. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when CallBurstDtmfData argument is null. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Joins the given two calls (one call in the active conversation state and the other call in the held state) into conference asynchronously. + + Unique handle which is either an active call or a held call. + Unique call handle. + The call id of join call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + For a multiparty call or for joining two calls into conference, there should be one call in the active state and another call in the held state. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Triggers splitting a private call from a multiparty call asynchronously. + + The handle of the call to be made private. The call handle referring to the call that is to be split from the conference. + The call id of split call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + The call should be in a multiparty conference call.The split call will be the active call and the conference call will be the held call. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Triggers making an explicit call transfer by connecting the two parties where one party is being active(active state) and another party is being held(held state) asynchronously. + + The call handle of an active call. + The call id of transferred call. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + + In order to transfer call, served mobile subscriber should have 2 calls, one in the active state and another one in the held state. + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Redirects the incoming call to another subscriber asynchronously. + + Incoming call handle. + The destination number. + A task indicating whether the DeflectCall method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when destinationNumber argument is invalid. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Gets the status of the current call. + + A unique handle for referring the call. + The call status information like destination number, call direction, call type, whether call is in the conference state or not. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Get the list of status of the current call. + + List of CallStatus. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Get the call volume asynchronously. + + The sound device. + The sound type. + Instance of CallVolumeInfo. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Set the call volume asynchronously. + + The call volume information. + A task indicating whether the SetCallVolumeInfo method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when CallVolumeRecord argument is null. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Set the call sound path asynchronously. + + The call sound path information. + A task indicating whether the SetCallSoundPath method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when CallSoundPathInfo argument is null. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Set the call mute state asynchronously. + + The call mute status information. + A task indicating whether the SetCallMuteStatus method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when CallMuteStatusRecord argument is null. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Get the call mute state asynchronously. + + Instance of CallMuteStatusRecord. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Get the voice privacy mode in the phone asynchronously. + + CallPrivacyMode value. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Set the voice privacy mode in the phone asynchronously. It is available only where a call exists. + + Voice privacy option mode value. + A task indicating whether the SetCallPrivacyMode method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Register the telephony event with proper Notification enum value which is to be listened using RegisterNotiEvent. + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Set the preferred voice subscription asynchronously. + + Preferred voice subscription value. + A task indicating whether the SetCallPreferredVoiceSubscription method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Get the preferred voice subscription. + + CallPreferredVoiceSubscription value. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + A class containing information about call idle status notification data. + + + + + Notification id. + + Notificatio id in unsigned integer format. + + + + End cause for the call indicates whether the call is released normally or due to some other cause. + + En cause enum value. + + + + A class which contains calling name information. + + + + + Display mode of the name. + + Enum value for call name mode + + + + Calling party name string. + + String value representing calling party name. + + + + A class which contains details about call information. + + + + + Call handle indicates the handle of the call for the application. + + Call handle represented in unsigned integer format. + + + + Call type. + + Call type indicating whether the requested call is a voice or video call. + + + + Caller number, null terminated ASCII. + + A string representing calling party number. + + + + Call name info. If there is no information from the network, this information will be null. + + A CallerNameInfo which contains information about the calling party name. + + + + CLI mode. + + Enum value representing CLI mode. + + + + No CLI cause. + + Enum value representing the cause for no CLI. + + + + Checks whether the incoming call is a forwarded call or not. + + True or false. If the incoming call is a forwarded call, then true else false. + + + + Current Active Line. + + Enum value representing call active line. + + + + A class which contains information about call line control. + + + + + Polarity included. + + Polarity value represented in byte format. + + + + Toggle mode. + + Toggle mode represented in byte format. + + + + Reverse polarity. + + Reverse polarity value represented in byte format. + + + + Power denial time. + + Time value in byte which represents power denial time. + + + + A class which contains information about call record. + + + + + Call id + + Call id which is represented in unsigned integer format. + + + + Call record type. + + An enum value representing the call record type. + + + + Name record. + + + This value will be filled only if CallRecordType is Name, otherwise it is null. + + Name record represented in string. + + + + Number record. + + + This value will be filled only if CallRecordType is Record, otherwise it is null. + + Number record reprensented in string. + + + + Gets the line control info. + + + This value will be filled only if CallRecordType is LineControl, otherwise it is null. + + An instance of CallRecordLineControl class. + + + + A class which contains information about call signal notification. + + + + + Gets the call signal type. + + Signal type of the call represented as CallAlertSignal enum. + + + + Gets the call pitch type. + + Pitch type of the call represented as CallAlertPitch enum. + + + + Gets the call signal tone type. + + + This value will be filled only if SignalType is Tone. + + Signal tone type of the call represented in CallToneSignal enum. + + + + Gets the signal ISDN Alert type. + + + This value will be filled only if SignalType is IsdnAlert. + + Signal ISDN alert type of the call represented in CallIsdnAlertSignal enum. + + + + Gets the signal IS54B alert type. + + + This value will be filled only if SignalType is Is54bAlert. + + Signal IS54B alerty type of the call represented in CallIs54bAlertSignal enum. + + + + A class which contains information about call upgrade/downgrade request of VoLTE call. + + + + + Gets the call handle. + + Call handle value represented in integer format. + + + + Gets the call upgrade/downgrade config type. + + Call upgrade/downgrade type represented in CallConfigType enum. + + + + A class which contains information about an outgoing call. + + + + + A parameterized constructor of CallInformation. + + Type of call(voice, data, video, emergency). + Emergency category. + Destination phone number. + + + + A class which contains information about call end response data. + + + + + End type. + + + + + Id. + + + + + A class which contains information about burst DTMF in CDMA. + + + + + A parameterized constructor of CallBurstDtmfData. + + Burst DTMF string. + DTMF Pulse Width. + DTMF Inter Digit Interval. + + + + A class which contains information about call status. + + + + + Call handle. + + + + + Status will be true for MO calls. If MT call, then its false. + + + + + Mobile number. + + + + + Type of call(voice, data, emergency). + + + + + Current call state. + + + + + Whether call is in conference state. + + + + + Whether call is volte call. + + + + + A class that contains call volume info. + + + + + A parameterized constructor of CallVolumeRecord. + + Call sound device. + Call sound type. + Call sound volume. + + + + Call sound device info. + + + + + Call sound type info. + + + + + Call sound volume info. + + + + + A class which contains call volume info reponse data. + + + + + Record number. + + + + + Volume info record. + + + + + A class which contains call sound path and volume information. + + + + + A parameterized constructor of CallSoundPathInfo. + + Sound path. + Extra volume status. + + + + A class which contains call mute status reponse data. + + + + + A parameterized constructor of CallMuteStatusRecord. + + Mute path. + Mute status. + + + + Enumeration for call end cause. + + + + + No Cause. + + + + + Unassigned Number. + + + + + No Route to Destination. + + + + + Channel Unacceptable. + + + + + Operator Determined Barring. + + + + + Normal Call Clearing. + + + + + User Busy. + + + + + No user responding. + + + + + User Alerting no Answer. + + + + + Call Rejected. + + + + + Number Changed. + + + + + Non Selected User Clearing. + + + + + Destination out of Order. + + + + + Invalid Number Format. + + + + + Facility Rejected. + + + + + Response to Status Enquiry. + + + + + Normal Unspecified. + + + + + No Circuit Channel Available. + + + + + Network out of Order. + + + + + Temporary Failure. + + + + + Switching Equipment Congestion. + + + + + Access Information Discarded. + + + + + Requested Circuit channel not available. + + + + + Resources unavailable and unspecified. + + + + + Quality of service unavailable. + + + + + Requested facility not subscribed. + + + + + Incoming call barred within CUG. + + + + + Bearer capability not Authorised. + + + + + Bearer capability not presently Available. + + + + + Service or Option not available. + + + + + Service not implemented. + + + + + ACM GEQ ACMAX. + + + + + Requested facility not implemented. + + + + + Restricted digital info BC not available + + + + + Service or Option not Implemented. + + + + + Transaction ID value. + + + + + Not a member of CUG. + + + + + Incompatible Destination. + + + + + Transit Network selection. + + + + + Semantically Incorrect message. + + + + + Invalid Mandatory Message. + + + + + Message Type Non Existent. + + + + + Message type not compatible with Prot state. + + + + + IE non exitent or not implemented. + + + + + Conditional IE error. + + + + + Not Compatible with protocol state. + + + + + Recovery on timer expiry. + + + + + Protocol error unspecified. + + + + + Interworking unspecified. + + + + + Reorder. + + + + + End unspecified. + + + + + IMSI unknown in HLR. + + + + + Illegal MS. + + + + + IMSI unknown in VLR. + + + + + IMEI not accepted. + + + + + Illegal ME. + + + + + GPRS service not allowed. + + + + + GPRS services and Non-GPRS services not allowed. + + + + + MS device cannot be derived by the network. + + + + + Implicitly detached. + + + + + PLMN not allowed. + + + + + LA not allowed. + + + + + National roaming not allowed. + + + + + GPRS services not allowed in this PLMN. + + + + + No suitable cells in the LA. + + + + + MSC temporarily not reachable. + + + + + Network unavailable. + + + + + MAC failure. + + + + + SYNCH failure. + + + + + Congestion. + + + + + GSM Auth unaccepted. + + + + + Service option not supported. + + + + + REQ_SERV option not suscribed. + + + + + Service OPT out of order. + + + + + Call cannot be identified. + + + + + No PDP context Activated. + + + + + Retry upon entry into a new call min value. + + + + + Retry upon entry into a new call max value. + + + + + Semantically incorret message. + + + + + Invalid mandatory information. + + + + + Message type non-existant. + + + + + Message type not COMP PRT ST. + + + + + IE non existent. + + + + + MSG not compatible protocol state. + + + + + REJ unspecified. + + + + + RR release indication. + + + + + Random Access Failure. + + + + + RRC release indication. + + + + + RRC close session indication. + + + + + RRC open session failure. + + + + + Low level failure. + + + + + Low level failure redial not alowed. + + + + + Low level immediate retry. + + + + + Invalid SIM. + + + + + No service. + + + + + Timer T3230 expiry. + + + + + No cell available. + + + + + Wrong state. + + + + + Access class blocked. + + + + + Abort Message received. + + + + + Other cause. + + + + + Timer T303 expiry. + + + + + Rejected due to unavailibilty of resources. + + + + + MM release pending. + + + + + Invalid user data. + + + + + Maximum End Cause limit for GSM/WCDMA. + + + + + Call Released by User. + + + + + Call Released by Network. + + + + + Call Released because the network is busy. + + + + + Call Released because of No Service area. + + + + + Call Released because of Fading. + + + + + Call Released because of reorder. + + + + + Call Released because of intercept. + + + + + Call Released because of silent zone retry. + + + + + Call Released because of OTA call failure. + + + + + Call Released because phone is offline. + + + + + Call Released because CDMA is locked. + + + + + Call Released because of the flash-is-in-progress error. + + + + + Call Released because of the e911 mode. + + + + + Call Released by Others. + + + + + Maximum End Cause limit for CDMA. + + + + + Enumeration for call type to be used by applications. + + + + + Voice call type. + + + + + Data call type - (for modem, fax, packet, and other such calls). + + + + + Emergency call type. + + + + + Enumeration for the call name mode. + + + + + This identifier refers to presenting the calling party's name identity to the called party. + + + + + This identifier refers to restricting the name identity of the calling party from being presented to the called party. + + + + + This identifier refers to the unavailability of the calling party's name identity from being offered to the called party. + + + + + This identifier refers to offering the calling party's name identity to the called party with which the presentation restriction is overridden. + + + + + Enumeration for the "Cli mode" value. + + + + + Presentation Allowed. + + + + + Presentation Restricted. + + + + + Number not available. + + + + + Presentation default. + + + + + Enumeration for "No Cli cause" value. + + + + + None. + + + + + Unavailable. + + + + + Rejected by user. + + + + + Other services. + + + + + Coin line phone. + + + + + Enumeration for call active line(IN GSM ONLY: call identification number). + + + + + Line 1. + + + + + Line 2. + + + + + Enumeration for the call record info type. + + + + + Name type. + + + + + Number type. + + + + + Line control type. + + + + + Enumeration for the voice privacy option mode. (CDMA only). + + + + + Standard mode. + + + + + Enhanced mode. + + + + + Enumeration for the OTASP Status. (CDMA only) + + + + + SPL unlocked ok. + + + + + A-Key excess ok. + + + + + SSD update ok. + + + + + NAM download ok. + + + + + MDN download ok. + + + + + IMSI download ok. + + + + + PRL download ok. + + + + + Commit ok. + + + + + Programming ok. + + + + + Success. + + + + + Unsuccess. + + + + + OTAPA verify ok. + + + + + Progress. + + + + + SPC excess failure. + + + + + Lock code password set. + + + + + Enumeration for the OTAPA status. (CDMA only) + + + + + Stop. + + + + + Start. + + + + + Enumeration for call sound path. + + + + + Audio path is handset. + + + + + Audio path is handset. + + + + + Audio path is Handsfree. + + + + + Audio path is bluetooth. + + + + + Audio path is stereo bluetooth. + + + + + Audio path is speaker phone. + + + + + Audio path is headset_3_5PI. + + + + + Audio path Bluetooth NSEC is off. + + + + + Audio path Mic one. + + + + + Audio path Bluetooth Mic two. + + + + + Audio path is Bluetooth WB. + + + + + Audio path is BT nsec off WB. + + + + + Audio path is headset HAC. + + + + + Audio path is Bikemode Near. + + + + + Audio path is Bikemode Far. + + + + + Audio path is VoLTE handset. + + + + + Audio path is VoLTE headset. + + + + + Audio path is VoLTE Handsfree. + + + + + Audio path is VoLTE bluetooth. + + + + + Audio path is VoLTE stereo bluetooth. + + + + + Audio path is VoLTE speaker phone. + + + + + Audio path is VoLTE headset_3_5PI. + + + + + Audio path VoLTE Bluetooth NSEC is off. + + + + + Audio path is VoLTE Bluetooth WB. + + + + + Audio path is VoLTE BT nsec off WB. + + + + + Audio path is VoLTE handset HAC. + + + + + Audio path is call forwarding. + + + + + Audio path is Loopback Mic1+Ear. + + + + + Audio path is Loopback Mic2+Ear. + + + + + Audio path is Loopback Mic3+Ear. + + + + + Enumeration for the Alert Signal Type. (CDMA only) + + + + + Tone. + + + + + ISDN Alerting. + + + + + IS54B Alerting. + + + + + Reserved. + + + + + Enumeration for the Alert Pitch Type. (CDMA only) + + + + + Alert Pitch Medium. + + + + + Alert Pitch High. + + + + + Alert Pitch Low. + + + + + Reserved. + + + + + Enumeration for the signals specific to the alert signal type. (CDMA only) + + + + + Dial. + + + + + Ringback Tone ON. + + + + + Intercept Tone ON. + + + + + Abbreviation Tone. + + + + + Network Congestion Tone ON. + + + + + Abbreviation Network Congestion. + + + + + Busy Tone ON> + + + + + CFRM Tone ON. + + + + + Answer Tone ON. + + + + + Call Waiting Tone ON. + + + + + Pipe Tone ON. + + + + + Tone OFF. + + + + + Enumeration for the call ISDN Alert signal. (CDMA only) + + + + + Normal. + + + + + Inter group. + + + + + Special Priority. + + + + + ISDN Reserved1. + + + + + Ping Ring. + + + + + ISDN Reserved2. + + + + + ISDN Reserved3. + + + + + ISDN Reserved4. + + + + + Alert OFF. + + + + + Enumeration for the call IS54B Alert signal types. + + + + + No Tone. + + + + + Long. + + + + + Short Short. + + + + + Short Short Long. + + + + + Short Short 2. + + + + + Short Long Short. + + + + + Short Short Short Short. + + + + + PBX Long. + + + + + PBX(Private Branch Exchange) Short Short. + + + + + PBX Short Short Long. + + + + + PBX Short Long Short. + + + + + PBX Short Short Short Short. + + + + + PIP PIP PIP PIP. + + + + + Enumeration for call sound ringback tone notification data. + + + + + Ringback Tone End. + + + + + Ringback Tone Start. + + + + + Enumeration for call sound WBAMR notification data. + + + + + Status OFF. + + + + + Status ON. + + + + + Status OFF 16k. + + + + + Status ON 8k. + + + + + Enumeration for call sound noise reduction. + + + + + Sound noise reduction off. + + + + + Sound noise reduction on. + + + + + Enumeration for call preferred voice subscription. + + + + + Unknown status. + + + + + Current network. + + + + + Ask Always. + + + + + Sim 1. + + + + + Sim 2. + + + + + Enumeration for specifying type for call upgrade/downgrade. + + + + + Call type is invalid. + + + + + Call type is Audio. + + + + + Call type is Video Share TX. + + + + + Call type is Video Share RX. + + + + + Call type is Inbound Video Call. + + + + + Call type is HD Video. + + + + + Call type is Video Conference. + + + + + Call type is QCIF Video Conference. + + + + + Call type is QVGA. + + + + + Call type is QCIF Video. + + + + + Call type is tty Full. + + + + + Call type is tty HCO. + + + + + Call type is tty VCO. + + + + + Call type USSD. + + + + + Call type is HDVideo Land. + + + + + Call type is E911 - Emergency Call. + + + + + Call type is Audio conference. + + + + + Call type is E911 Emergency video call. + + + + + Call type is E911 Emergency video call HD. + + + + + Call type is E911 Emergency video call HD Land. + + + + + Call type is E911 Emergency video call Land. + + + + + Call type is E911 Emergency video call HD QVGA Land. + + + + + Call type is CIF Video Call. + + + + + Call type is HD 720 video call. + + + + + Call type is E911 video hold call. + + + + + Call type is switch VOIP to VT call. + + + + + Enumeration for the emergency call category type. + + + + + Default case + + + + + Police emergency + + + + + Ambulance emergency + + + + + Firebrigade emergency + + + + + Marineguard emergency + + + + + Mountain rescue emergency + + + + + Manual emergency call + + + + + Automatic emergency call + + + + + Unspecified emergency + + + + + Enumeration for the call answer type. + + + + + Answer an incoming call when there are no current active calls. + + + + + Reject the incoming call. + + + + + Release current active call and accept the waiting call. + + + + + Hold the current active call, and accept the waiting call. + + + + + Enumeration for the call end type. + + + + + End specific call. + + + + + End all calls. + + + + + End all active calls. + + + + + End all held calls. + + + + + Enumeration for the onlength to send DTMF. + + + + + 95 ms. + + + + + 150 ms. + + + + + 200 ms. + + + + + 250 ms. + + + + + 300 ms. + + + + + 350 ms. + + + + + Sms. + + + + + Enumeration for the offlength to send DTMF. + + + + + 60 ms. + + + + + 100 ms. + + + + + 150 ms. + + + + + 200 ms. + + + + + Enumeration for call states. + + + + + Idle state - i.e. no call. + + + + + Connected and conversation state. + + + + + Held State. + + + + + Dialing state. + + + + + Alerting state. + + + + + Incoming state. + + + + + Answered state, and waiting for connected indication event. + + + + + Unknown state. + + + + + Enumeration for call sound device type. + + + + + Device type receiver. + + + + + Device type speaker. + + + + + Device type handsfree. + + + + + Device type headset. + + + + + Device type bluetooth. + + + + + Device type external. + + + + + Enumeration for call sound type. + + + + + Sound type voice. + + + + + Sound type keytone. + + + + + Sound type bell. + + + + + Sound type message + + + + + Sound type alarm + + + + + Sound type PDA miscellaneous. + + + + + Enumeration for call sound volume level. + + + + + Sound is mute. + + + + + Volume level is 1. + + + + + Volume level is 2. + + + + + Volume level is 3. + + + + + Volume level is 4. + + + + + Volume level is 5. + + + + + Volume level is 6. + + + + + Volume level is 7. + + + + + Volume level is 8. + + + + + Volume level is 9. + + + + + Enumeration for call extra volume. + + + + + Off. + + + + + On. + + + + + Enumeration for call sound mute status. + + + + + Off. + + + + + On. + + + + + Enumeration for call sound mute path. + + + + + Transmit. + + + + + Receiver. + + + + + All. + + + + + This class provides functions for modem services. + + + + + A public constructor for Modem class to create a Modem instance for the given tapi handle. + + The tapi handle. + + + + Turn the modem on/off asynchronously. + + Power command value. + A task indicating whether the ProcessPowerCommand method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Switch the flight mode on/off asynchronously. + + Flight mode request value. + A task indicating whether the SetFlightMode method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Get the flight mode asynchronously. + + If flight mode is On, it returns true else it returns false. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Get Me version information asynchronously. + + Instance of MiscVersionInformation. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Misc me version information. + + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Returns null in case of failure. + + + + Get the Me Esn/Meid for each phone type asynchronously. + + Instance of MiscSerialNumberInformation. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Misc me serial number information. + + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Returns null in case of failure. + + + + Get the Misc Me Imei asynchronously. + + The imei string. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Misc me Imei information. + + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Returns null in case of failure. + + + + Check the modem power status. + + Phone power status value. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + Get device vendor name and device name of cellular dongle. + + Instance of MiscDeviceInfo. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + + Result can be delivered with only cellular dongle insertion. + + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when modem instance is invalid or when method failed due to invalid operation. + + + + A class containing information about mobile equipment version. + + + + + Version mask. + + + + + Software version. + + + + + Hardware version. + + + + + Calculation date. + + + + + Product code. + + + + + Model id. + + + + + Number of prl nam fields. + + + + + Prl version (only for CDMA). + + + + + Number of Eri nam fields. + + + + + Eri version. + + + + + A class containing information about mobile serial number. + + + + + Esn number. + + + + + Meid number. + + + + + Imei number. + + + + + Imeisv number. + + + + + A class containing device information of cellular dongle. + + + + + Vendor name. + + + + + Device name. + + + + + Enumeration for the phone power status values. + + + + + Unknown. + + + + + Power on. + + + + + Power off. + + + + + Power reset. + + + + + Power low. + + + + + Error. + + + + + Enumeration for the phone power reset commands. + + + + + On. + + + + + Off. + + + + + Reset. + + + + + Low value. + + + + + Max value. + + + + + Enumeration for flight mode request type. + + + + + Off. + + + + + On. + + + + + Max value. + + + + + Enumeration for flight mode request type. + + + + + Flight mode on success. + + + + + Flight mode off success. + + + + + Flight mode request fail. + + + + + Max value. + + + + + This class provides functions for managing telephony service network. + + + + + A public constructor for Network class to create a Network instance for the given tapi handle. + + The tapi handle. + + + + Request the lower layers to select the network automatically asynchronously. + + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Request the lower layers to select the network which is selected by the user from the network list asynchronously. + + The user selected plmn. + The user selected access technology. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Sends a request to do manual search for the available networks and provides the Network List to the user asynchronously. + + Instance of NetworkPlmnList. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the present network selection mode i.e. automatic or manual asynchronously. + + Value of NetworkSelectionMode. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Set the network preferred plmn asynchronously. + + The operation to be done on the preferred plmn. + The preferred plmn info. + A task indicating whether the SetNetworkPreferredPlmn method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when NetworkPreferredPlmnInfo argument is null. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the preferred plmn list asynchronously. + + List of NetworkPreferredPlmnInfo. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Cancel the triggered manual network search asynchronously. + + A task indicating whether the CancelNetworkManualSearch method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the network serving information asynchronously. + + Instance of NetworkServing. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Set the network mode asynchronously. + + The network mode. + A task indicating whether the SetNetworkMode method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the network mode asynchronously. + + Value of NetworkMode. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the neighboring cell info asynchronously. + + Instance of NetworkNeighboringCell. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Enters or exits the emergency callback mode asynchronously. + + The emergency callback mode. + A task indicating whether the SetEmergencyCallbackMode method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Set the network roaming preference asynchronously. + + The network roaming preference. + A task indicating whether the SetRoamingPreference method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the network roaming preference asynchronously. + + Value of NetworkPreferred. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Set the default data subscription asynchronously. + + A task indicating whether the SetDefaultDataSubscription method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the default data subscription. + + Value of NetworkDefaultDataSubscription. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Set the default subscription for voice asynchronously. + + A task indicating whether the SetNetworkDefaultSubscription method is done or not. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + Get the default subscription for voice. + + Value of NetworkDefaultSubscription. + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when network instance is invalid or when method failed due to invalid operation. + + + + A class which defines network registration status. + + + + + Circuit Switched status. + + Status of circuit switched data. + + + + Packet Switched status. + + Status of packet switched data. + + + + Registration service type. + + Service type represented in NetworkServiceType enum. + + + + Roaming status + + Boolean value to check the roaming status. + + + + A class which defines network cell info notification. + + + + + Location Area Code (In case of LTE network, it represents Tracking Area Code). + + Location area code represented in integer. + + + + Cell ID. + + Cell id represented in integer. + + + + A class which defines network change notification. + + + + + Access technology. + + Access technology represented in NetworkSystemType enum. + + + + Network PLMN. + + Plmn value represented as string. + + + + A class which defines network time notification. + + + + + Date time information. + + An instance of DateTime representing date time information. + + + + Wday information. + + Wday info represented in integer. + + + + GMT Off. + + GMT off info represented in integer. + + + + DST Off. + + DST off info represented in integer. + + + + Flag for checking if it is DST. + + Boolean value to check if the time is DST or not. + + + + Network PLMN. + + PLMN value represented in string. + + + + A class which defines network identity notification. + + + + + Network PLMN. + + Plmn value represented in string. + + + + Short network name. + + Short name of the network in string. + + + + Full network name. + + Full name of the network in string. + + + + A class which defines network VoLTE status notification. + + + + + VoLTE status. + + Boolean value to check if it is registered. + + + + Services registered for. + + Service mask represented in integer. + + + + Network on which VoLTE is registered. + + Type of VoLTE network represented in VolteNetworkType enum. + + + + A class which defines network identity. + + + + + Network name. + + + + + Service provider name. + + + + + Network plmn. + + + + + Plmn Id. + + + + + Plmn type. + + + + + Access technology. + + + + + A class for the network plmn list. + + + + + Network plmn count. + + Count of the network plmn. + + + + Network list. + + List of NetworkIdentity. + + + + A class which defines the preferred plmn information. + + + + + Preferred plmn list index. + + Index of preferred plmn list. + + + + Preferred plmn. + + Plmn string. + + + + Network name. + + Name of network. + + + + Service provider name. + + Name of service provider. + + + + System type of network. + + System type of network. + + + + A class containing information related to a cdma system. + + + + + Cdma carrier. + + Cdma carrier. + + + + System Id. + + System Id. + + + + Network Id. + + Id of network. + + + + Base station Id. + + Id of base station. + + + + Latitude of the current base station. + + Latitude of the current base station. + + + + Longitude of the current base station. + + Longitude of the current base station. + + + + Registration zone. + + Registration zone. + + + + Pilot offset. + + Offset of pilot. + + + + A class containing information about network area. + + + + + Location area code. + + Area code of location. + + + + Instance of NetworkCdmaSysInfo. + + Instance of NetworkCdmaSysInfo. + + + + A class containing information of serving network. + + + + + Access technology. + + System type of network. + + + + Network plmn. + + Plmn of network. + + + + Area information of network. + + Instance of NetworkAreaInfo. + + + + A class containing information of cdma cell. + + + + + System Id info. + + System Id. + + + + Network Id. + + Network Id. + + + + Base station Id. + + Base station id. + + + + Reference pn. + + Reference pn. + + + + Latitude of the current base station. + + Latitude of the current base station. + + + + Longitude of the current base station. + + Longitude of the current base station. + + + + A class containing information of lte cell. + + + + + Value of cell Id. -1 indicates that cell Id information is not present. + + Cell Id. + + + + Location area code. This field is ignored when CellId is not present. + + Code of area. + + + + Physical cell id info. + + Physical cell id. + + + + E-Utra absolute rf channel number. + + E-Utra absolute rf channel number. + + + + Tracking area code. + + Area code for tracking. + + + + Rssi in dBm(signed) + + Rssi in dBm. + + + + A class containing information of umts cell. + + + + + Ucid. -1 indicates that cell Id information is not present. + + RNCID + Cell ID(16 bit). + + + + Location area code. This field is ignored when CellId is not present. + + Code of area. + + + + Utra absolute rf channel number. + + Utra absolute rf channel number. + + + + Primary scrambling code. + + Primary scrambling code. + + + + Received signal code power. Valid values are (0-96, 255). + + Power of received signal code. + + + + A class containing information of geran cell. + + + + + Value of cell Id. -1 indicates that cell Id information is not present. + + Cell Id. + + + + Location area code. This field is ignored when CellId is not present. + + Code of area. + + + + Broadcast control channel frequency number. + + Broadcast control channel frequency number. + + + + Base station identification code. + + Id code of base station. + + + + Received signal strength level. Valid values are (0-63, 99). + + Strength of received signal. + + + + A class which contains geran, umts, cdma and lte cell information. + + + + + Geran cell information. + + Instance of NetworkGeranCell. + + + + Cdma cell information. + + Instance of NetworkCdmaCell. + + + + Umts cell information. + + Instance of NetworkUmtsCell. + + + + Lte cell information. + + Instance of NetworkLteCell. + + + + A class which contains serving cell information. + + + + + Access technology. + + Network system type. + + + + Mobile country code. + + Country code of the mobile. + + + + Mobile network code. + + Network code of the mobile. + + + + Information of cell. + + Instance of Cell. + + + + A class which contains neighboring cell information. + + + + + Serving cell information. + + Instance of NetworkServingCell. + + + + Geran cell info list. + + List of NetworkGeranCell. + + + + Umts cell info list. + + List of NetworkUmtsCell. + + + + Lte cell info list. + + List of NetworkLteCell. + + + + Enumeration for the status of the network service. + + + + + No service available in the network ME is camped. + + + + + Only emergency service available in the network ME is camped. + + + + + FULL service available in the network ME is camped + + + + + Searching for service. + + + + + Enumeration for the service types of TAPI. + + + + + Service type is Unknown. + + + + + No Service available. + + + + + Service type is Emergency. + + + + + Service type is Searching. + + + + + Service type is 2G. In case of CDMA, service type is set to 2G when System Type is IS95A/IS95B/CDMA_1X. + + + + + Service type is 2.5G. + + + + + Service type is 2.5G (EDGE). + + + + + Service type is 3G. In case of CDMA, service type is set to 3G when System Type is EVDO_REV_0/REV_A/REV_B/EHRPD. + + + + + Service type is HSDPA. + + + + + Service type is LTE. + + + + + Enumeration for the system types of network. + + + + + No Service available. + + + + + Available service is GSM. + + + + + Available service is GPRS. + + + + + Available service is EGPRS. + + + + + Available service is PCS1900 band. + + + + + Available service is UMTS. + + + + + Both GSM and UMTS systems available. + + + + + Available service is HSDPA. + + + + + Available service is IS95A. + + + + + Available service is IS95B. + + + + + Available service is CDMA 1X. + + + + + Available service is EV-DO rev0. + + + + + Available service is 1X and EV-DO rev0. + + + + + Available service is EV-DO revA. + + + + + Available service is 1X and EV-DO revA. + + + + + Available service is EV-DO revB. + + + + + Available service is 1X and EV-DO revB. + + + + + Available service is EV-DV. + + + + + Available service is EHRPD. + + + + + Available service is LTE. + + + + + Enumeration for the network emergency callback mode states (3GPP2 specific enum). + + + + + Enter emergency callback mode. + + + + + Exit emergency callback mode. + + + + + Enumeration for the possible default Data Subscriptions. + + + + + Unknown status. + + + + + SIM 1. + + + + + SIM 2. + + + + + Enumeration for the possible default Subscriptions for CS (Voice). + + + + + Unknown status. + + + + + SIM 1 network. + + + + + SIM 2 network. + + + + + Enumeration for type of network on which VoLTE is registered. + + + + + Unknown. + + + + + Mobile. + + + + + WiFi. + + + + + Enumeration for the packet service protocol type. + + + + + Unknown PS type. + + + + + HSDPA. + + + + + HSUPA. + + + + + HSPA. + + + + + HSPAP. + + + + + Enumeration for the network name display condition type. + + + + + Invalid Display Condition. + + + + + Display Condition is SPN. + + + + + Display Condition is PLMN. + + + + + Display Condition is SPN or PLMN. + + + + + Enumeration for the different serving network LTE band type. + + + + + Unknown. + + + + + FDD. + + + + + TDD. + + + + + Enumeration for the operation that can be done on a preferred PLMN. + + + + + Addition to the Network Preferred PLMN list. + + + + + Edit the network Preferred PLMN list. + + + + + Delete the entry to the network Preferred PLMN list. + + + + + Enumeration for the CDMA Preferred Network Type(CDMA only). + + + + + Home only. + + + + + Affiliated. + + + + + Automatic. + + + + + Automatic-A. + + + + + Automatic-B. + + + + + Roam domestic. + + + + + Roam international. + + + + + Roam dual. + + + + + Blank. + + + + + Enumeration for the different network operation causes. + + + + + No error for any operation. + + + + + Aborted. + + + + + Error. + + + + + Phone is in use(eg: Voice / Data call in progress). + + + + + Phone is in offline mode. + + + + + Modem is unable to process the config settings information. + + + + + Internal failure. + + + + + Memory is full. + + + + + Enumeration for the network plmn type. + + + + + Unknown. + + + + + Home plmn. + + + + + Available. + + + + + Forbidden. + + + + + Enumeration for the network selection mode. + + + + + Automatic selection mode. + + + + + Manual selection mode (Not applicable to CDMA). + + + + + Enumeration for the different network modes. + + + + + Auto. + + + + + Gsm. + + + + + Wcdma. + + + + + Rtt1x. + + + + + Lte. + + + + + Evdo. + + + + + Cdma. + + + + + This class provides functions for sending oem related data. + + + + + A public constructor for Oem class to create a Oem instance for the given tapi handle. + + The tapi handle. + + + + Sends oem data directly. + + Oem id for user specification. + Oem data for sending. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when oem instance is invalid or when method failed due to invalid operation. + + + + Sends oem data directly. + + Oem id for user specification. + Oem data for sending. + The oem data which is sent. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + Sends oem data directly. + + Oem id for user specification. + Oem data for sending. + The oem data which is sent. + http://tizen.org/privilege/telephony.admin + platform + http://tizen.org/feature/network.telephony + Thrown when feature is not supported. + Thrown when privilege access is denied. + Thrown when call instance is invalid or when method failed due to invalid operation. + + + + A class which defines OEM data base structure. + + + + + Oem ID. + + Oem id represented in unsigned integer. + + + + Oem data. + + Oem data represented in byte array. + + + + A class which manages sim phonebook record information. + + + + + Gets the instance of Phonebook class. + + An instance of TapiHandle obtained from InitTapi in TapiManager API. + Thrown when handle is passed as null. + + + + Gets the current inserted SIM phonebook init status, available phonebook list, and first valid index in case of FDN, ADN, and 3G phonebook. + + An instance of SimPhonebookStatus containing init status and phonebook list information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the number of used records and total records of a specific SIM phonebook type. + + The different storage types to be selected in the SIM. + A task containing an instance of PhonebookStorageInfo. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the max text length and max number length supported by the SIM phone book elementary file. + + The different storage types to be selected in the SIM. + A task containing an instance of PhonebookMetaInfo. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM 3G phonebook supported EFs like ANR, SNE, GRP, EMAIL and the corresponding EFs max text length, number length, and size. + + A task containing an instance of PhonebookMetaInfo3G. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Reads SIM phone book entry information from the given storage type and index. + + The different storage types to be selected in the SIM. + The index for accessing the SIM data. + A task containing an instance of PhonebookRecord. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Adds or edits SIM phone book record entry information. + + The phonebook data to be updated or added. + A task indicating whether the updation is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when record is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Deletes a SIM phonebook record. + + The different storage types to be selected in the SIM. + The index of the record to be deleted. + A task indicating whether deletion is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + A class which defines the list of phone book availability of the current SIM. + + + + + Fixed Dialing Number. + + Fdn represented in integer format. + + + + SIM - ADN(2G phonebook, Under DF phonebook). + + Adn represented in integer format. + + + + Service Dialing Number. + + Sdn represented in integer format. + + + + USIM - 3G phonebook. + + Usim represented in integer format. + + + + Additional number Alpha String phonebook. + + Aas represented in integer format. + + + + Grouping information Alpha String phonebook. + + Gas represented in integer format. + + + + A class which defines phone book status of the current SIM. + + + + + Init completed or not. + + Boolean value to check the status of Init. + + + + List of phonebook. + + An instance of SimPhonebookList containing the list of available phone book. + + + + A class which defines phonebook contact change information. + + + + + Storage file type. + + Type of phonebook storage represented as PhonebookType enum. + + + + Changed index. + + Index value represented in unsigned short. + + + + Phonebook operation. + + Operation indicating the action on phonebook contact. + + + + A class which defines phone book storage count information. + + + + + Storage file type. + + Type of phone book storage file. + + + + Total record count. + + Count of total phonebook record. + + + + Used record count. + + Number of used phonebook record. + + + + A class which defines phone book entry information. + + + + + Storage file type. + + Type of phonebook storage. + + + + Phone book minimum index. + + Minimum index value of the phone book record. + + + + Phone book maximum index. + + Maximum index value of the phone book record. + + + + Phone number's maximum length + + Maximum length of the phone number. + + + + Text's maximum length. + + Maximum length of the text. + + + + Phone book used record count. + + Number of used phone book record. + + + + A class which defines 3G phone book capability information. + + + + + 3G phonebook file type. + + File type of the 3G phonebook. + + + + Max index. + + Maximum index value present in 3G phonebook. + + + + Max text length. + + Maximum text length in unsigned short. + + + + Used record count. + + Number of used record in 3G phonebook. + + + + A class which manages Sim phonebook and its capabilities information. + + + + + Phonebook file type count. + + Filetype count of the 3G phonebook. + + + + Phonebook file type information. + + A list of FileTypeCapabilityInfo3G instances. + + + + A class which contains information about phonebook record. + + + + + Phonebook type. + + Type of the phonebook used. + + + + Index. + + Index value represented in unsigned short. + + + + Next index (This field is not used in the add/update case). + + Next index represented in unsigned short. + + + + Name. + + Name in phonebook record. + + + + Dcs. + + Sim encryption type. + + + + Number. + + Number in phonebook record. + + + + Ton. + + Sim type of number. + + + + SNE(Second Name Entry). + + Second name entry in byte array. + + + + SNE DCS. + + SNE text encryption type. + + + + Additional Number1. + + Additional number1 represented in byte array. + + + + ANR1 TON. + + Additional number1 type of number. + + + + Additional Number2. + + Additional number2 represented in byte array. + + + + ANR2 TON. + + Additional number2 type of number. + + + + Additional number3. + + Additional number3 represented in byte array. + + + + ANR3 TON. + + Additional number3 type of number. + + + + Email1. + + Email1 represented in byte array. + + + + Email2. + + Email2 represented in byte array. + + + + Email3. + + Email3 represented in byte array. + + + + Email4. + + Email4 reprensented in byte array. + + + + Group index. + + Group index represented in unsigned short. + + + + Phonebook control. + + Phonebook control represented in unsigned short. + + + + Enumeration for the storage types to be selected in the SIM or USIM. + + + + + Fixed Dialing Number. + + + + + Sim - ADN. + + + + + Service Dialing Number. + + + + + USIM - 3G phone book. + + + + + Additional number Alpha String. + + + + + Grouping identifier Alpha String. + + + + + Unknown file type. + + + + + Enumeration for the phonebook operation types. + + + + + Contact added or updated. + + + + + Existing contact deleted. + + + + + Max value. + + + + + Enumeration for the storage field types in the 3G Phone book. + + + + + Name. + + + + + Number. + + + + + First Another number. + + + + + Second Another number. + + + + + Third Another number. + + + + + First Email. + + + + + Second Email. + + + + + Third Email. + + + + + Fourth Email. + + + + + Second name entry of the main name. + + + + + Group. + + + + + 1 byte control info and 1 byte hidden info. + + + + + Enumeration for the text encryption type. + + + + + ASCII Encoding. + + + + + GSM 7 Bit Encoding. + + + + + UCS2 Encoding. + + + + + HEX Encoding. + + + + + Enumeration for the phonebook access result. + + + + + SIM phonebook operation successful. + + + + + SIM phonebook operation failure. + + + + + The index passed is not a valid index. + + + + + The number length exceeds the max length allowed (or 0). + + + + + The name length exceeds the max length allowed (or 0). + + + + + Access condition for PB file is not satisfied. + + + + + A class which defines SAT main menu info. + + + + + Proactive command number sent by USIM. + + Command number represented in integer format. + + + + Flag for checking whether main menu is present or not. + + Boolean value checking the presence of main menu. + + + + Menu title text. + + Title text of the menu item represented in string. + + + + Menu items. + + List of SatMenuInfo objects. + + + + Number of menu itmes. + + An unsigned value representing the number of menu items. + + + + Flag for a help information request. + + Boolean value for checking the flag for help information request. + + + + Updated Sat main menu or not. + + Boolean value to check whether Sat main menu is updated or not. + + + + Icon Identifier. + + An instance of SatIconIdInfo class representing the icon identifier. + + + + List of Icon Identifiers. + + An instance of SatIconIdListInfo class representing the icon identifier list. + + + + A class which contains menu item information for the setup menu. + + + + + Menu item character data. + + Menu item data represented in string. + + + + Identifies the item on the menu that the user selected. + + Item identifier value represented as a character. + + + + A class defining the icon data object. + + + + + Flag for checking whether the icon identifier exists. + + Boolean value representing if the icon exists or not. + + + + Icon qualifier type. + + Icon qualifier type represented as SatIconQualifierType enum. + + + + Icon identifier. + + A byte value representing the icon identifier. + + + + Icon info. + + An instance of SatIconInfo class. + + + + A class containing the definition of icon info object. + + + + + Icon width. + + Width of the icon represented in byte. + + + + Icon height. + + Height of the icon represented in byte. + + + + Image coding scheme. + + Image coding scheme represented as SatImageCodingScheme enum. + + + + Icon data length. + + Data length of the icon represented in ushort. + + + + Clut data length. + + Data length of the clut represented in ushort. + + + + Icon file. + + Icon file string. + + + + Clut file. + + Clut file string. + + + + A class which defines the icon identifier data object. + + + + + Flag for checking whether the icon identifier exists. + + Boolean value indicating the presence of icon. + + + + Icon list qualifier. + + Icon list qualifier represented in SatIconQualifierType enum. + + + + Number of icons. + + Byte value indicating the number of icons. + + + + Icon identifier list. + + A byte array containing the list of Icon identifier. + + + + Icon list info. + + List of icon info. + + + + A class containing display text proactive command for SAT UI. + + + + + Proactive command number sent by USIM. + + Command id in integer format. + + + + Character data to display on screen. + + An instance of SatTextInfo containing text information. + + + + Duration of the display. + + Duration in integer format. + + + + Flag that indicates whether text is to be displayed if some other app is using the screen. + + Boolean value checking the priority of the display. + + + + Flag that indicates whether user response is required. + + Boolean value to check the need of user response. + + + + Flag for checking whether immediate response is required. + + Boolean value to check the immediate response status. + + + + Icon Identifier. + + An instance of SatIconIdInfo class. + + + + A class defining character data for the SAT engine data structure. + + + + + Character data length. + + An unsigned short value representing the string length. + + + + Character data. + + A byte array representing the string data. + + + + A class which defines select item proactive command data for SAT UI. + + + + + Proactive command number sent by USIM. + + Command id represented in integer format. + + + + Flag for a help information request. + + Boolean value to check whether help information is availale or not. + + + + Menu title text. + + An instance of SatTextInfo class containing the text information. + + + + Selected default item. + + Default item index of the given items. + + + + Number of menu items. + + Menu items count represented as a character. + + + + Menu items. + + A list of SatMenuItemInfo objects. + + + + Icon Identifier. + + An instance of SatIconIdInfo class. + + + + List of Icon Identifiers. + + An instance of SatIconIdListInfo class containing the list of icon identifiers. + + + + A class which defines the menu item data object. + + + + + Item identifier. + + Item Id represented in byte. + + + + Text length. + + Length of the text represented in byte. + + + + Text information. + + A byte array of length TextLength containing the text information. + + + + A class which defines get inkey proactive command data for SAT UI. + + + + + Proactive command number sent by USIM. + + Command id represented in integer format. + + + + Input Type. + + Character Set or Yes/No. + + + + Input character mode. + + SMS default, UCS2. + + + + Flag for checking whether input character is numeric. + + Boolean value for checking whether input character is numeric or not. + + + + Help info request flag. + + Boolean value for checking whether help info is available or not. + + + + Character data to display on the screen. + + An instance of SatTextInfo class containing the text information. + + + + Duration of the display. + + Display duration represented in unsigned integer. + + + + Icon identifier. + + An instance of SatIconIdInfo class containing the Icon identifier information. + + + + A class which defines get input proactive command data for SAT UI. + + + + + Proactive command number sent by USIM. + + Command id represented in integer format. + + + + Input character mode. + + SMS default, UCS2. + + + + Flag to check whether input character is numeric. + + Boolean value to check the nature of input character. + + + + Help info request flag. + + Boolean value to check help information availability. + + + + Flag that indicates whether to show input data on the screen. + + Boolean value to check the availability of input data on the screen. + + + + Character data to display on the screen. + + An instance of SatTextInfo. + + + + Input data min, max length. + + An instance of SatResponseLengthInfo. + + + + Default input character data. + + An instance of SatTextInfo. + + + + Icon identifier. + + An instance of SatIconIdInfo. + + + + A class which defines expected user response length. + + + + + User response length's minimum value. + + Minimum value represented in byte. + + + + User response length's maximum value. + + Maximum value represented in byte. + + + + A class which defines refresh proactive command data for applications that are concerned with files residing on USIM. + + + + + Proactive command number sent by USIM. + + Command id represented in integer format. + + + + Concerned application type. + + Refresh app type represented in SatRefreshAppType enum. + + + + Refresh mode. + + Refresh mode represented in SatCmdQualiRefresh enum. + + + + Refresh file count. + + File count represented in byte. + + + + Refresh file identifiers. + + A list of SimFileId enums. + + + + A class which defines send SMS proactive command data for the SMS application. + + + + + Proactive Command Number sent by USIM. + + Command id represented in integer. + + + + Flag to check if packing is required for SMS Tpdu. + + Boolean value to check the need of packing in SMS Tpdu data. + + + + Destination address. + + An instance of SatAddressData containing the address info. + + + + SMS Tpdu data. + + An instance of SatSmsTpduInfo. + + + + A class which defines SAT address data object. + + + + + Type of number. + + Sim type of number represented in SimTypeOfNumber enum. + + + + Number plan identity. + + Sim number plan represented in SimNumberPlanIdentity enum. + + + + Length of dialling number. + + Dialling number length represented in byte. + + + + Dialling number. + + Dialling number represented in string. + + + + A class which defines the Result data object. + + + + + SMS TPDU type. + + Tpdu type represented in SatSmsTpduType. + + + + SMS TPDU data length. + + Length of Tpdu data represented in byte. + + + + SMS TPDU data. + + An array of bytes representing TPDU data. + + + + A class which defines Event list info. + + + + + Flag to check if the event download is acive. + + Boolean value to check for active event download. + + + + Flag to check if the event is about Mt call event. + + Boolean value to check the event for Mt call event. + + + + Flag to check if the call is connected. + + Boolean value to check the connection of call. + + + + Flag to check if the call is disconnected. + + Boolean value to check the call disconnection. + + + + Flag to check if the event is aboout locaion status. + + Boolean value to check the presence of location status in the event. + + + + Flag to check if the event is about user activity. + + Boolean value to check the presence of user activity. + + + + Flag to check if idle screen is available. + + Boolean value to check the availability of idle screen. + + + + Flag to check if the event is about card reader status. + + Boolean value to check the status of card reader. + + + + Flag to check if the event is about language selection. + + Boolean value to check if the event is language selection. + + + + Flag to check if the browser is terminated. + + Boolean value to check the termination of browser. + + + + Flag to check if the data is available. + + Boolean value to check availablility of data. + + + + Flag to check if the event has channel status. + + Boolean value to check if this field is a channel status. + + + + A class which defines send DTMF proactive command data for the DTMF application. + + + + + Proactive Command Number sent by USIM + + Command id represented in integer. + + + + Hidden mode flag. + + Flag to check if the data is in hidden mode. + + + + DTMF string data. + + An instance of SatTextInfo containing DTMF string data. + + + + A class which defines call control confirm data for Call/Ss. + + + + + Call destination address. + + An instance of SatTextInfo class. + + + + Call SUB address. + + An instance of SatTextInfo class. + + + + BC repeat indicator. + + SatBcRepeatIndicatorType enum representing Bc repeat indicator. + + + + Configuration Capability Parameter 1. + + An instance of SatTextInfo class. + + + + Configuration Capability Parameter 2. + + An instance of SatTextInfo class. + + + + A class which defines common call control confirm data. + + + + + Call control confirm type - call, SS or USSD. + + Type of call represented in SatCallType enum. + + + + Call control result type. + + Type of call control result represented in SatCallCtrlResultType enum. + + + + Call control display data. + + An instance of SatTextInfo class containing information about call control display data. + + + + Flag for checking existence of call control display. + + Boolean value to check existence of user info display. + + + + Call control call address. + + + This value will be filled only if CallType is MoVoice. Otherwise it will be null. + + An instance of SatCallCtrlData containing call control call address. + + + + Call control SS string. + + + This value will be filled only if CallType is Ss. Otherwise it will be null. + + An instance of SatCallCtrlData containing call control SS string. + + + + Call control USSD string. + + + This value will be filled only if CallType is Ussd. Otherwise it will be null. + + An instance of SatTextInfo class containing call control USSD string. + + + + A class which defines the data coding scheme object. + + + + + Flag to verify the compressed format. + + Boolean value to check the compressed value. + + + + Alphabet format type. + + Represented in SatAlphabetFormat enum. + + + + Type of message class. + + Message class represented in SatMsgClassType enum. + + + + Raw DCS info. + + Dcs info stored in byte. + + + + A class which defines text string data object. + + + + + Flag for checking whether only digits are used. + + Boolean value for checking the usage of only digits. + + + + Data coding scheme. + + An instance of SatDataCodingScheme class. + + + + Text length. + + Length of the string in unsigned short format. + + + + Text string. + + Text represented in string. + + + + A class which defines MO SMS control confirm data. + + + + + Envelope result. + + Result of MO SMS control confirm data. + + + + Display present flag. + + Boolean value to check the presence of user information display. + + + + Display data for sending SMS. + + An instance of SatTextTypeInfo containing display data for sending SMS. + + + + The RP destination address of the service center. + + An instance of SatTextTypeInfo containing RP destination address. + + + + The TP destinationn address. + + An instance of SatTextTypeInfo containing TP destination address. + + + + A class which defines setup call proactive command data for the call application. + + + + + Proactive Command Number sent by USIM. + + Command Id represented in integer format. + + + + Call type + + Type of call represented in SatCmdQualiSetupCall enum. + + + + Display data for calling. + + An instance of SatTextInfo containing display data for calling. + + + + Call number. + + An instance of SatTextInfo containing call number information. + + + + Maximum repeat duration. + + Max repeat duration represented in unsigned integer format. + + + + Icon identifier for the call application. + + An instance of SatIconIdInfo containing Icon id information. + + + + A class which defines Send SS notification proactive command data for the applicaiton. + + + + + Proactive Command Number sent by USIM. + + Command id represented in integer format. + + + + Type of Number. + + TON represented in SimTypeOfNumber enum. + + + + Numbering Plan Identity. + + NPI reprensented in SimNumberPlanIdentity enum. + + + + SS string length. + + Length of SS string represented in byte. + + + + SS string. + + Text string represented in string. + + + + A class which defines send USSD notification proactive command data for the application. + + + + + Proactive Command Number sent by USIM. + + Command id represented in integer format. + + + + Raw DCS info. + + Raw DCS information represented in byte. + + + + USSD string length. + + Length of USSD string in byte. + + + + USSD string. + + Ussd text represented in string format. + + + + Enumeration for the UI display status. + + + + + Infoms about UI display success. + + + + + Informs about UI display failure. + + + + + Enumeration for the command qualifier values of the refresh command. + + + + + Command qualifier for Refresh SIM Init And Full File Change Notification. + + + + + Command qualifier for Refresh File Change Notification. + + + + + Command qualifier for Refresh SIM Init And File Change Notification. + + + + + Command qualifier for Refresh Sim Init. + + + + + Command qualifier for Refresh Sim Reset. + + + + + Command qualifier for Refresh 3G Application Reset. + + + + + Command qualifier for Refresh 3G Session Reset. + + + + + Command qualifier for Refresh Reserved. + + + + + Enumeration for the icon qualifier. + + + + + Icon Quali Self Explanatory. + + + + + Icon Quali Not Self Explanatory. + + + + + Reserved. + + + + + Enumeration for the SIM image coding scheme type. + + + + + Basic coding scheme. + + + + + Colour coding scheme. + + + + + Reserved. + + + + + Enumeration for the inkey type. + + + + + Command qualifier for Inkey type character set enabled. + + + + + Command qualifier for Inkey type Yes No requested. + + + + + Enumeration for the user input type. + + + + + SMS default. + + + + + UCS2 alphabet type. + + + + + Enumeration for the refresh application type. + + + + + Phonebook type. + + + + + SMS type. + + + + + Other. + + + + + Maximum value. + + + + + Enumeration for the SMS TPDU type. + + + + + Deliver TPDU type. + + + + + Deliver RPT type. + + + + + Submit TPDU type. + + + + + Submit RPT type. + + + + + Status RPT type. + + + + + TPDU CMD type. + + + + + Enumeration for the type of command and the next action indicator. + + + + + None. + + + + + Refresh. + + + + + More time. + + + + + Setup event list. + + + + + Setup call. + + + + + Send SS. + + + + + Send USSD. + + + + + Send SMS. + + + + + Send DTMF. + + + + + Launch browser. + + + + + Play tone. + + + + + Display text. + + + + + Get inkey. + + + + + Get input. + + + + + Select item. + + + + + Setup menu. + + + + + Provide local info. + + + + + Setup idle mode text. + + + + + Language notification. + + + + + Open channel - class e. + + + + + Close channel - class e. + + + + + Receive data - class e. + + + + + Send data. + + + + + Get channel status - class e. + + + + + Inform to end the execution of a proactive command. + + + + + Inform end proactive session. + + + + + Reserved. + + + + + Enumeration for the SAT call type. + + + + + MO voice. + + + + + MO SMS. + + + + + SS. + + + + + USSD. + + + + + PDP context action. + + + + + Max. + + + + + Enumeration for the result of call control by SIM. + + + + + Allowed with no mod. + + + + + Not allowed. + + + + + Allowed with mod. + + + + + Reserved. + + + + + Enumeration for the SIM ATK BC repeat indicator type. + + + + + Alternate mode. + + + + + Sequential mode. + + + + + Reserved. + + + + + Enumeration for alphabet format. + + + + + SMS default. + + + + + 8Bit data. + + + + + UCS2. + + + + + Reserved. + + + + + Enumeration for the message class. + + + + + None. + + + + + Class 0. + + + + + Class 1 Default meaning: ME - specific. + + + + + Class 2 SIM specific message. + + + + + Class 3 Default meaning : TE specific. + + + + + Reserved. + + + + + Enumeration for the command qualifier values of the setup call command. + + + + + Command qualifier for setup call if another call is not busy. + + + + + Command qualifier for setup call if another call is not busy with redial. + + + + + Command qualifier for setup call putting all other calls on hold. + + + + + Command qualifier for setup call putting all other calls on hold with redial. + + + + + Command qualifier for setup call disconnecting all other calls. + + + + + Command qualifier for setup call disconnecting all other calls with redial. + + + + + Reserved. + + + + + A class which manages SIM card services. + + + + + A constructor to instantiate Sim class using the Tapi handle. + + An instance of TapiHandle obtained from InitTapi in TapiManager API. + Thrown when handle is passed as null. + + + + Gets SIM card initialization status and SIM card identification. + + An instance of SimInitInfo class in case of success. Null in case of failure. + + + + Gets the card type (SIM/USIM). + + + + + Gets SIM IMSI information. + + + + + Gets ECC(SIM) or UECC(USIM) data. + + + + + Gets the list of application on UICC. + + A byte containing the masking value for SimAppType. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the unique identification number of the (U)ICC. + + A task containing ICCID information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets language preference(indication) information. + + A task containing information about SIM language preference. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Updates language preference information to the SIM card. + + The language preference information. + A task indicating whether setting of language preference is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM call forwarding indication related data(EF-CFIS and CPHS case). + + A task containing call forward response information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Sets SIM call forwarding indication related data(EF-CFIS and CPHS case). + + The data requesting for call forwarding. + A task indicating whether setting call forward info is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when call forward request is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM message waiting indication related data(EF-MWIS and CPHS case). + + A task containing message waiting response information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Sets SIM message waiting indication related data(EF-MWIS and CPHS case). + + The data requesting for message waiting. + A task indicating whether setting message waiting info is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when message waiting request is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM mailbox related data(EF-MBDN, MBDI, and CPHS case). + + A task containing SimMailboxList information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Sets SIM mailbox related data(EF-MBDN, MBDI and CPHS case). + + The data requesting for mailbox info. + A task indicating whether setting mailbox info is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when mailbox number is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM CPHS specific data. + + A task containing SimCphs information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the SIM Service Table. + + A task containing SIM service table information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM MSISDN data. + + A task containing SimMsisdnList information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM OPLMNWACT(Operator controlled PLMN Selector with Access Technology) data. + + A task containing SimOplmnwactList information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM SPN data. + + A task containing SimSpn information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM CPHS NETNAME data. + + A task containing SimCphsNetName information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Executes an authentication procedure by using SIM. + + The authentication code to be validated by the ISIM, 3G, and GSM application in the SIM card. + A task containing SimAuthenticationResponse information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when authentication data is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Performs PIN1/PIN2/SIM LOCK verification. + + The PIN code. + A task containing SimPinResult information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when pin data is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Performs PIN1/PIN2 unblocking operation based on PUK information. + + The unblocking PIN password. + The PIN password to use after the unblocking operation. + A task containing SimPinResult information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when either of pukData or newPinData is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Changes the PIN1/PIN2 code based on the PIN type passed along with old PIN data and new PIN data. + + The old PIN code entered by the user. + The new PIN code entered by the user. + A task containing SimPinResult information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when either of oldPin or newPin is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Disables the SIM facility. + + An object which contains the facility type and password. + A task containing SIM facility result information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when SIM facility info is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Enables the SIM facility. + + An object which contains the facility type and password. + A task containing SIM facility result information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when SIM facility info is passed as null. + Thrown when the system runs out of memory. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the SIM facility. + + The type of security lock. + A task containing SIM facility information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets SIM lock type info. + + The type of security lock. + A task containing SIM lock information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Sets the SIM power state. + + The state of SIM to be set. + A task indicating whether setting SIM power state is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Provides a common interface for accessing SIM data. + + The APDU data. + A task containing SIM APDU response information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when SIM APDU is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Provides a common interface to get the SIM ATR(Answer To Reset) value. + + A task containing SIM ATR response information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the IMPI(IMS private user identity). (ISIM only). + + A task containing IMPI string. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the IMPU(IMS public user identity). (ISIM only). + + A task containing SIM IMPU list information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the Domain(Home Network Domain Name). (ISIM only) + + A task containing domain string. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the P-CSCF(Proxy Call Session Control Function). (ISIM only) + + A task containing SIM PCSCF list information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the ISIM service table. (ISIM only). + + A task containing a byte array in which mask value of SimIsimService enum will be stored. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + A class which defines SIM card initialization information. + + + + + The SIM initialization status from the Telephony server boot up time. + + + + + The SIM card identification value. It will be true when the current inserted SIM card differs from the previous SIM. False otherwise. + + + + + A class which defines data for IMSI information. + + + + + Mobile Country Code. + + + + + Mobile Network Code. + + + + + Mobile Station Identification Number. + + + + + A class which defines data for ECC information of GSM/USIM/CDMA SIM. + + + + + Name. Applicable only for USIM(3G) SIM. + + + + + Number. + + + + + Emergency service type. Applicable only for USIM(3G) SIM. + + + + + A class which defines ECC information list. + + + + + ECC count. + + + + + List of ECC. + + + + + A class which defines ICCID(Integrated Circuit Card Identifier). + + + + + Integrated Circuit Card number length. + + + + + Integrated Circuit Card number. + + + + + A class which defines call forwarding indication status data. + + + + + Record index. + + + + + MSP number. + + + + + Call forwarding unconditional indication status. + + + + + SIM Type of number. + + + + + SIM numbering plan identity. + + + + + Dialing Number/SSC String. + + + + + Capability/Configuration 2 Record Identifier. + + + + + Extension 7 Record Identifier. + + + + + A class which defines call forwarding indication status list. + + + + + Profile count. + + + + + List of CFIS. + + + + + A class which defines CPHS call forwarding status data. + + + + + CallForwardUnconditionalLine 1. + + + + + CallForwardUnconditionalLine 2. + + + + + CallForwardUnconditional Fax. + + + + + CallForwardUnconditional data. + + + + + A class which defines call forwarding response. + + + + + CPHS or not. + + + + + List of CFIS. + + + + + CPHS CF. + + + + + A class which defines call forwarding request. + + + + + CPHS or not. + + + + + CFIS. + + + This should be filled only if IsCphs is false. + + + + + CPHS CF. + + + This should be filled only if IsCphs is true. + + + + + A class which defines message waiting indication status data. + + + + + Record index. + + + + + Indicator type. + + + + + VoiceMail count. + + + + + Fax count. + + + + + Email count. + + + + + Other count. + + + + + VideoMail count. + + + + + A class which defines message waiting indication status list. + + + + + Profile count. + + + + + List of MWIS. + + + + + A class which defines CPHS message waiting status data. + + + + + VoiceMsgLine1 message waiting flag. + + + + + VoiceMsgLine2 message waiting flag. + + + + + FAX message waiting flag. + + + + + Data message waiting flag. + + + + + A class which defines message waiting reponse. + + + + + CPHS or not. + + + + + List of MWIS. + + + + + CPHS MW. + + + + + A class which defines message waiting request. + + + + + CPHS or not. + + + + + MWIS. + + + This should be filled only if IsCphs is false. + + + + + CPHS MW. + + + This should be filled only if IsCphs is true. + + + + + A class which defines mailbox dialing number data. + + + + + CPHS or not. + + + + + Index which stands for the location where the record is saved in SIM. + + + + + SIM profile index. + + + + + Mailbox type. + + + + + Alpha max length in SIM. + + + + + Alpha Identifier. + + + + + Type Of Number. + + + + + Number Plan Identity. + + + + + Dialing Number/SSC String. + + + + + Capability/Configuration Identifier. + + + + + Extension 1 Record Identifier. + + + + + A class which defines mailbox dialing number list. + + + + + Mailbox count. + + + + + List of mailbox. + + + + + A class which defines available optional CPHS SIM files. + + + + + Customer Service Profile (CSP). + + + + + Service String Table (SST). + + + + + MailBoxNumbers. + + + + + Short form of operator name. + + + + + Information numbers. + + + + + A class which defines CPHS information data. + + + + + CPHS phase type. + + + + + CPHS service table. + + + + + A class which defines CSIM service table. + + + + + Cdma service table; + + + + + Cdma service. Gives mask value of SimCdmaService enum. + + + This will be filled only if CdmaSvcTable is Cdma. + + + + + Csim service. Gives mask value of SimCsimService enum. + + + This will be filled only if CdmaSvcTable is Csim. + + + + + A class which defines SIM service table. + + + + + SIM card type. + + + + + SIM service table. Gives mask value of SimSstService enum. + + + This will be filled only if SimType is Gsm. + + + + + USIM service table. Gives mask value of SimUstService enum. + + + This will be filled only if SimType is Usim. + + + + + CSIM service table. + + + This will be filled only if SimType is Ruim. + + + + + A class which defines MSISDN information of the GSM/CDMA SIM. + + + + + MSISDN number. If it does not exist, a null string will be returned + + + + + MSISDN name. If it does not exist, a null string will be returned. Not applicable for CDMA. + + + + + A class which defines MSISDN list. + + + + + Count. + + + + + List of subscriber info. + + + + + A class which defines OPLMNwACT data. + + + + + PLMN. + + + + + UMTS or not. + + + + + GSM or not. + + + + + A class which defines OPLMNwACT list. + + + + + Count. + + + + + List of OPLMNWACT. + + + + + A class which defines SPN(Service Provider Name). + + + + + Display condition. + + + + + Service Provider Name. + + + + + A class which defines CPHS network name. + + + + + Full name. + + + + + Short name. + + + + + A class which defines authentication request data. + + + + + A constructor to instantiate SimAuthenticationData class with necessary parameters. + + Authentication type. + The length of RAND. + The length of AUTN. It is not used in case of GSM AUTH. + RAND data. + AUTN data. It is not used in case of GSM AUTH. + + + + A class which defines authentication result data. + + + + + Authentication type. + + + + + Authentication result. + + + + + Response length. + + + + + Response data. + + + + + The length of the authentication key. + + + + + The data of the authentication key. + + + + + The length of the cipher key. + + + + + Cipher key. + + + + + The length of the integrity key. + + + + + Integrity key. + + + + + A class which defines information about SIM PIN data. + + + + + A constructor to instantiate SimPinData class which necessary parameters. + + PIN type. + PIN code. + PIN code length. + + + + A class which defines PIN information. + + + + + Specifies the PIN or PUK type. + + + + + Number of attempts remaining for PIN/PUK verification. + + + + + A class which is used to used to enable/disable facility. + + + + + A constructor to instantiate SimFacility class with necessary parameters. + + Facility type. + Password. + Password length. + + + + A class which defines facility result data. + + + + + Specifies the PIN or PUK type. + + + + + Number of attempts remaining for PIN/PUK verification. + + + + + A class which defines facility info data. + + + + + Lock type. + + + + + Facility status. + + + + + A class which defines information about lock type. + + + + + Lock type. + + + + + Lock status. + + + + + Retry counts. + + + + + A class which defines APDU information. + + + + + A constructor to instantiate SimApdu class with necessary parameters. + + APDU. + + + + A class which defines the response of sending APDU. + + + + + Length of response APDU. + + + + + Response APDU. + + + + + A class which defines the response of sending ATR. + + + + + Length of response ATR. + + + + + Response ATR. + + + + + A class which defines ISIM IMPU list data. + + + + + ISIM IMPU data count. + + + + + ISIM IMPU list. + + + + + A class which defines ISIM P-CSCF data. + + + + + ISIM P-CSCF type. + + + + + ISIM P-CSCF data. + + + + + A class which defines ISIM P-CSCF list data. + + + + + ISIM P-CSCF data count. + + + + + ISIM P-CSCF list. + + + + + Enumeration for the SIM card status. + + + + + Bad card / On the fly SIM gone bad. + + + + + Card not present. + + + + + SIM is in the Initializing state. + + + + + SIM Initialization ok. + + + + + PIN required state. + + + + + PUK required state. + + + + + PIN/PUK blocked(permanently blocked- All the attempts for PIN/PUK failed). + + + + + Network Control Key required state. + + + + + Network Subset Control Key required state. + + + + + Service Provider Control Key required state. + + + + + Corporate Control Key required state. + + + + + Card removed. + + + + + PH-SIM (phone-SIM) locked state. + + + + + Runtime SIM card error. + + + + + SIM card Powered OFF. + + + + + Unknown status. It can be the initial status. + + + + + Enumeration for the SIM card type. + + + + + Unknown card. + + + + + SIM(GSM) card. + + + + + USIM card. + + + + + CDMA card. + + + + + CDMA NV SIM. + + + + + IMS card. + + + + + Enumeration for the language preference code. + + + + + German. + + + + + English. + + + + + Italian. + + + + + French. + + + + + Spanish. + + + + + Dutch. + + + + + Swedish. + + + + + Danish. + + + + + Portuguese. + + + + + Finnish. + + + + + Norwegian. + + + + + Greek. + + + + + Turkish. + + + + + Hungarian. + + + + + Polish. + + + + + Korean. + + + + + Chinese. + + + + + Russian. + + + + + Japanese. + + + + + Unspecified. + + + + + Enumeration for the security lock type. + + + + + PH-SIM (phone-SIM) locked. Lock Phone to SIM/UICC card. + + + + + PH-FSIM (phone-first-SIM) Lock Phone to the very first inserted SIM/UICC card. + + + + + SIM Lock (PIN, PIN2, PUK, PUK2) Lock SIM/UICC card. + + + + + FDN - SIM card or active application in the UICC (GSM or USIM). + + + + + Network Personalization. + + + + + Network subset Personalization. + + + + + Service Provider Personalization. + + + + + Corporate Personalization. + + + + + Enumeration for the power state of the SIM. + + + + + Off state. + + + + + On state. + + + + + Unspecified state. + + + + + Enumeration for the file ID. + + + + + Root Directory for the USIM. + + + + + The ICC Identification file. + + + + + The IMSI file. + + + + + The SIM Service Table file. + + + + + The Enabled Service Table file. + + + + + The OPLMN List file. + + + + + The Group Identifier Level 1. + + + + + The Group Identifier Level 2. + + + + + The Extended Language Preference file. + + + + + SIM: Language preference. + + + + + The Emergency Call Codes. + + + + + The Service Provider Name. + + + + + The Service provider display information. + + + + + The PLMN Network Name File. + + + + + The Operator PLMN List File. + + + + + MSISDN. + + + + + Short Messages file. + + + + + SMS Parameter. + + + + + SMS Status. + + + + + Cell Broadcast Message Identifier. + + + + + SIM Mail Box Dialing Number file. + + + + + Mailbox Identifier - linear fixed. + + + + + Message Waiting Indication Status - linear fixed. + + + + + Call forward indication status - linear fixed. + + + + + CPHS voice MSG waiting indication. + + + + + CPHS service string table. + + + + + CPHS call forward flags. + + + + + CPHS operator name string. + + + + + CPHS customer service profile. + + + + + CPHS information. + + + + + CPHS mail box numbers. + + + + + CPHS operator name short form string. + + + + + CPHS information numbers. + + + + + CPHS Dynamics flags. + + + + + CPHS Dynamics2 flags. + + + + + CPHS CSP2. + + + + + Invalid file. + + + + + Element to indicate an unknown file. + + + + + Enumeration for the SIM number type. + + + + + Unknown. + + + + + International number. + + + + + National number. + + + + + Network specific number. + + + + + Subscriber number. + + + + + Alphanumeric, GSM 7-bit default alphabet. + + + + + Abbreviated number + + + + + Reserved for extension. + + + + + Enumeration for the numbering plan identifier. + + + + + Unknown. + + + + + ISDN/Telephone numbering plan. + + + + + Data numbering plan + + + + + Telex numbering plan + + + + + Service Center Specific plan. + + + + + Service Center Specific plan 2. + + + + + National numbering plan. + + + + + Private numbering plan. + + + + + ERMES numbering plan. + + + + + Reserved for extension. + + + + + Enumeration for the emergency service type. + + + + + Police. + + + + + Ambulance. + + + + + Fire brigade. + + + + + Marine guard. + + + + + Mountain rescue. + + + + + Spare. + + + + + Enumeration for the SIM app type. + + + + + SIM application. + + + + + USIM application. + + + + + CSIM application. + + + + + ISIM application. + + + + + Enumeration for the SIM access result from the lower layers. + + + + + Access to file is successful. + + + + + SIM card error. + + + + + File not found. + + + + + Access condition is not fulfilled. + + + + + Access failed. + + + + + Enumeration for the mailbox type. + + + + + Voicemail. + + + + + Fax. + + + + + Email. + + + + + Other. + + + + + Videomail. + + + + + Data. + + + + + Enumeration for the current CPHS phase of the SIM card. + + + + + Phase 1. + + + + + Phase 2. + + + + + RFU. + + + + + Enumeration for CDMA service table. + + + + + CDMA service table. + + + + + CSIM service table. + + + + + MAX value. + + + + + Enumeration for the SIM Authentication type. + + + + + IMS Authentication. + + + + + GSM Authentication. + + + + + 3G Authentication. + + + + + CDMA CAVE Authentication. + + + + + CDMA CHAP Authentication. + + + + + CDMA MNHA Authentication. + + + + + CDMA MIPRRQ Authentication. + + + + + CDMA MNAAA Authentication. + + + + + CDMA HRPD Authentication. + + + + + MAX value. + + + + + Enumeration for the SIM Authentication result. + + + + + Status - no error. + + + + + Status - can't perform authentication. + + + + + Status - skip authentication response. + + + + + Status - MAK(Multiple Activation Key) code failure. + + + + + Status - SQN(SeQuenceNumber) failure. + + + + + Status - synch failure. + + + + + Status - unsupported context. + + + + + Status - default error. + + + + + MAX value. + + + + + Enumeration for the PIN type. + + + + + PIN 1 code. + + + + + PIN 2 code. + + + + + PUK 1 code. + + + + + PUK 2 code. + + + + + Universal PIN - Unused now. + + + + + Administrator - Unused now. + + + + + SIM Lock code. + + + + + Enumeration for the PIN status. + + + + + Facility disabled. + + + + + Facility enabled. + + + + + Facility unknown. + + + + + Enumeration for the security lock key information. + + + + + Key not needed. + + + + + PIN required. + + + + + PUK required. + + + + + PIN2 required. + + + + + PUK2 required. + + + + + Permanent block SIM. + + + + + Enumeration for P-CSCF type. + + + + + Fully Qualified Domain Name. + + + + + IPv4. + + + + + IPv6. + + + + + Enumeration for the SIM power set result from the lower layers. + + + + + Power Set is successful. + + + + + Power Set failure. + + + + + Enumeration for the list of IST services in the ISIM Service Table (ISIM). + + + + + P-CSCF address. + + + + + Generic Bootstrapping Architecture. + + + + + HTTP Digest. + + + + + GBA-based Local Key Establishment Mechanism. + + + + + Support of P-CSCF discovery for IMS Local Break Out. + + + + + Short Message Storage. + + + + + Short Message Status Reports. + + + + + Support for SM-over-IP including data download via SMS-PP as defined in TS 31.111 [31] + + + + + Communication Control for IMS by ISIM. + + + + + Support of UICC access to IMS. + + + + + URI support by UICC. + + + + + Enumeration for the list of SST services in the SIM Service Table (GSM). + + + + + CHV1 disable function. + + + + + Abbreviated Dialing number. + + + + + Fixed Dialing number. + + + + + Short message storage. + + + + + Advice of charge. + + + + + Capability configuration parameters. + + + + + PLMN selector. + + + + + RFU. + + + + + MSISDN. + + + + + Extension 1. + + + + + Extension 2. + + + + + SMS parameters. + + + + + Last number dialed. + + + + + Cell broadcast message identifier. + + + + + Group identifier level 1. + + + + + Group identifier level 2. + + + + + Service provider name. + + + + + Service Dialing number. + + + + + Extension3. + + + + + RFU. + + + + + VGCS group identifier (EF-VGCS, EF-VGCSS). + + + + + VBS group identifier (EF-VBS, EF-VBSS). + + + + + Enhanced multi-level precedence and pre-emption service. + + + + + Automatic answer for EMLPP. + + + + + Data download via SMS-CB. + + + + + Data download via SMS-PP. + + + + + Menu selection. + + + + + Call control. + + + + + Proactive SIM command. + + + + + Cell broadcast message identifier ranges. + + + + + Barred Dialing numbers. + + + + + Extension 4. + + + + + De-personalization control keys. + + + + + Co-operative network list. + + + + + Short message status reports. + + + + + Network's indication of alerting in the MS (NIA). + + + + + Mobile-originated short message control by SIM. + + + + + GPRS. + + + + + Image. + + + + + Support of local service area. + + + + + USSD string data object supported in call control. + + + + + Run at COMMAND command. + + + + + User controlled PLMN selector with Access technology. + + + + + Operator controlled PLMN selector with Access technology. + + + + + HPLMN selector with access technology. + + + + + CPBCCH information. + + + + + Investigation scan. + + + + + Extended capability configuration parameters. + + + + + MExE. + + + + + RPLMN last used access technology. + + + + + PLMN Network Name. + + + + + Operator PLMN List. + + + + + Mailbox Dialling Numbers. + + + + + Message Waiting Indication Status. + + + + + Call Forwarding Indication Status. + + + + + Service Provider Display Information. + + + + + Enumeration for the list of UST services in the SIM Service Table (USIM). + + + + + Local phone book. + + + + + Fixed Dialing number. + + + + + Extension 2. + + + + + Service Dialing number. + + + + + Extension 3. + + + + + Barred Dialing numbers. + + + + + Extension 4. + + + + + Outgoing call information. + + + + + Incoming call information. + + + + + Short message storage. + + + + + Short message status reports. + + + + + SMS parameters. + + + + + Advice of charge. + + + + + Capability configuration parameters. + + + + + Cell broadcast message identifier. + + + + + Cell broadcast message identifier ranges. + + + + + Group identifier level 1. + + + + + Group identifier level 2. + + + + + Service provider name. + + + + + User controlled PLMN selector with Access technology. + + + + + MSISDN. + + + + + Image. + + + + + Support of local service area. + + + + + Enhanced multi-level precedence and pre-emption service. + + + + + Automatic answer for EMLPP. + + + + + RFU. + + + + + GSM access. + + + + + Data download via SMS-PP. + + + + + Data download via SMS-CB. + + + + + Call control by USIM. + + + + + Mobile-originated short message control by USIM. + + + + + Run at COMMAND command. + + + + + Shall be set to 1. + + + + + Enabled service table. + + + + + APN control list. + + + + + De-personalization control keys. + + + + + Co-operative network list. + + + + + GSM security context. + + + + + CPBCCH information. + + + + + Investigation scan. + + + + + MExE. + + + + + Operator controlled PLMN selector with Access technology. + + + + + HPLMN selector with access technology. + + + + + Extension 5. + + + + + PLMN Network Name. + + + + + Operator PLMN List. + + + + + Mailbox Dialling Numbers. + + + + + Message Waiting Indication Status. + + + + + Call Forwarding Indication Status. + + + + + RPLMN last used access technology. + + + + + Service Provider Display Information. + + + + + Multi media messaging service. + + + + + Extension 8. + + + + + Call control on GPRS by USIM. + + + + + MMS user connectivity parameters. + + + + + Network's indication of alerting in the MS (NIA). + + + + + VGCS group identifier List (EF-VGCS, EF-VGCSS). + + + + + VBS group identifier List (EF-VBS, EF-VBSS). + + + + + Pseudonym. + + + + + User controlled PLMN selector for I-WLAN access. + + + + + Operator controlled PLMN selector for I-WLAN access. + + + + + User controlled WSID list. + + + + + Opertor controlled Wsid list. + + + + + VGCS security. + + + + + Enumeration for the list of CST services in the CDMA Service Table. + + + + + CHV Disable Option. + + + + + Abbreviated Dialing number. + + + + + Fixed Dialing number. + + + + + Short message storage. + + + + + HRPD. + + + + + Enhanced Phone Book. + + + + + Multimedia domain. + + + + + SF_EUIMID- based EUIMID. + + + + + MEID. + + + + + Extension 1. + + + + + Extension 2. + + + + + SMS parameters. + + + + + Last number dialled. + + + + + Service Category Program for BC-SMS. + + + + + RFU. + + + + + RFU. + + + + + CDMA Home Service Provider Name. + + + + + Service Dialing number. + + + + + Extension 3. + + + + + 3GPD-SIP. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + Data download by SMS broadcast. + + + + + Data download by SMS PP. + + + + + Menu Selection. + + + + + Call Control. + + + + + Proactive RUIM. + + + + + AKA. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + RFU. + + + + + 3GPD- MIP. + + + + + BCMCS. + + + + + Multimedia messaging service. + + + + + Extension 8. + + + + + MMS User Connectivity Parameters. + + + + + Application Authentication. + + + + + Group Identifier Level 1. + + + + + Group Identifier Level 2. + + + + + Depersonalisation control keys. + + + + + Co-operative Network List. + + + + + Enumeration for the list of CST services in the CSIM Service Table (CSIM). + + + + + Local Phone book. + + + + + Fixed Dialing Numbers (FDN). + + + + + Extension 2. + + + + + Service Dialing Numbers (SDN). + + + + + Extension 3. + + + + + Short Message Storage (SMS). + + + + + Short Message Parameters. + + + + + HRPD. + + + + + Service Category Program for BC-SMS. + + + + + CDMA Home Service Provider Name. + + + + + Data Download via SMS Broadcast. + + + + + Data Download via SMS-PP. + + + + + Call Control. + + + + + 3GPD-SIP. + + + + + 3GPD-MIP. + + + + + AKA. + + + + + IP-based Location Services (LCS). + + + + + BCMCS. + + + + + Multimedia Messaging Service (MMS). + + + + + Extension 8. + + + + + MMS User Connectivity Parameters. + + + + + Application Authentication. + + + + + Group Identifier Level 1. + + + + + Group Identifier Level 2. + + + + + De-Personalization Control Keys. + + + + + Cooperative Network List. + + + + + Outgoing Call Information (OCI). + + + + + Incoming Call Information (ICI). + + + + + Extension 5. + + + + + Multimedia Storage. + + + + + Image (EFIMG). + + + + + Enabled Services Table. + + + + + Capability Configuration Parameters (CCP). + + + + + SF_EUIMID-based EUIMID. + + + + + Messaging and 3GPD Extensions. + + + + + Root Certificates. + + + + + WAP Browser. + + + + + Java. + + + + + Reserved for CDG. + + + + + Reserved for CDG. + + + + + IPv6. + + + + + A class which defines incoming SMS message notification data. + + + + + SCA. + + Sca value represented in string. + + + + Message length. + + Length of incoming message. + + + + Data. + + Data representing incoming message information. + + + + SMS format. + + Format of the incoming SMS. + + + + A class which defines incoming CB message notification data. + + + + + Cell Broadcast message type. + + Type of cell broadcast message. + + + + Size of MsgData (which is the actual TPDU message). + + Length of message data. + + + + Cell broadcast message data. + + Message data representing cell broadcast message. + + + + A class which defines incoming ETWS message notification data. + + + + + ETWS message type. + + Type of ETWS message. + + + + Size of MsgData (which is the actual TPDU message). + + Length of message data. + + + + ETWS message data. + + Message data representing ETWS message. + + + + Enumeration for the type of sms network. + + + + + Network type is 3gpp. + + + + + Network type is 3gpp2 (CDMA). + + + + + Enumeration for different CB message types. + + + + + GSM Cell broadcast message. + + + + + UMTSCell broadcast message. + + + + + CDMA broadcast message. + + + + + Enumeration for different ETWS message types. + + + + + Primary ETWS message. + + + + + GSM Secondary ETWS message. + + + + + UMTS Secondary ETWS message. + + + + + CDMA Seconday ETWS message. + + + + + Enumeration for memory status type. + + + + + PDA memory is available. + + + + + PDA memory is full. + + + + + Phone memory is available. + + + + + Phone memory is full. + + + + + Enumeration for the sms ready status type. + + + + + Non Ready Status. + + + + + SMS 3GPP Ready. + + + + + SMS 3GPP2 Ready. + + + + + SMS 3GPP and 3GPP2 Ready. + + + + + Enumeration for sms status type. + + + + + MT message, stored and read. + + + + + MT message, stored and unread. + + + + + MO message, stored and sent. + + + + + MO message, stored but not sent. + + + + + Delivered at destination. + + + + + Service centre forwarded message but is unable to confirm delivery. + + + + + Message has been replaced. + + + + + Reserved for future use. + + + + + Enumeration for different response types that come in the sent status acknowledgement/notification after sending a message to the network. + + + + + Message sent successfully. + + + + + Message routing not available. + + + + + Invalid parameter present in TPDU + + + + + Device failure. + + + + + Reserved Service. + + + + + Invalid location. + + + + + No SIM error. + + + + + SIM not ready error. + + + + + No response from network. + + + + + Destination address restricted. + + + + + Service center address restricted. + + + + + Resend an already done operation. + + + + + SCA address not available. + + + + + Unassigned number. + + + + + Operator determined barring. + + + + + Call barred. + + + + + Message transfer rejected. + + + + + Message capacity exceeded/memory full. + + + + + Destination number out of service. + + + + + Unspecified subscriber. + + + + + Facility rejected. + + + + + Unknown subscriber. + + + + + Network out of order. + + + + + Temporary failure. + + + + + Congestion occured. + + + + + Resource unavilable. + + + + + Facility not subscribed by the user. + + + + + Facility not implemented. + + + + + Invalid reference value. + + + + + Invalid message. + + + + + Invalid mandatory information. + + + + + Message type not implemented. + + + + + Message not compact protocol. + + + + + Information element not implemented. + + + + + Protocol error. + + + + + Networking error. + + + + + Sms ME full. + + + + + Sms sim full. + + + + + Timeout error. + + + + + A class which manages Supplementary Services of the SIM. + + + + + A constructor to instantiate Ss class using the Tapi handle. + + An instance of TapiHandle obtained from InitTapi in TapiManager API. + Thrown when handle is passed as null. + + + + Sends a request to activate/deactivate call barring. + + The information about call barring. + A task containing an instance of SsBarringResponse which contains information about barring response. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when barring info is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets call barring status. + + The type of call. + The barring type. + A task containing information about barring response. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Allows changing of the barring password in the network. + + The old password set for Barring in the Network. + The new password set for Barring in the Network. + The new password again. + A task indicating whether the change of password is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when any of the parameter is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Allows to set the (register/erase/activate/deactivate) call forwarding option at the network. + + The Call forward information such as a forward mode, a forward type, and so on. + A task containing information about SS forward response. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when forward info is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Provides an option to get the call forwarding status of different calls from the Network. + + The Forward call type. + The forward condition. + A task containing SS forward response information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Activates/deactivates the call waiting service. + + The status of call-waiting service. + A task containing SS waiting response information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when waiting info is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the status of the call waiting service. + + The call types. + A task containing information about SS waiting response. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Activates/deactivates the status of the calling line identity service. + + The Cli service type. + The Cli Status. + A task indicating whether setting of CLI status is done or not. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the status of the calling line identity service. + + The Cli service type. + A task containing SS CLI response information. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Sends a USSD string or User response to the Network. + + The data coding scheme used + A task containing SS USSD response information. + http://tizen.org/feature/network.telephony + platform + http://tizen.org/privilege/telephony.admin + Thrown when telephony feature is not supported. + Thrown when privilege access is denied. + Thrown when Ussd message info is passed as null. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + A class which defines values for USSD request type. Applicable to 3GPP(GSM/UMTS/LET) only. + + + + + USSD type. + + Type of USSD represented in SsUssdType enum. + + + + DCS. + + Dcs value represented in byte. + + + + USSD string length. + + Length of USSD string in integer. + + + + USSD string. + + Ussd string represented in string. + + + + A class which defines release complete message notification type. + + + + + Specifies the Release complete messageg length. + + Length of release complete message in byte. + + + + Specifies the release complete message. + + Release complete message represented in byte array. + + + + A class which defines SS forward record information. + + + + + SS class + + SS class type. + + + + Call forwarding SS status. + + Status of SS call forwarding. + + + + Call forward types providing various conditions when a call can be forwarded. + + Forwarding condition of SS call forward. + + + + Flag that indicates whether call forwarding number is present. + + Boolean value to check the presence of call forwarding number. + + + + No reply time. + + Waiting time when there is no reply. + + + + Type of number. + + SS call forward type of number. + + + + Numbering Plan Identity. + + SS call forward numbering plan identity. + + + + Forwarded number. + + Call forwarding number. + + + + A class which defines values for SS call forwarding record. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Record number. + + Record value represented in integer. + + + + Specifies the maximum of SS forward records. + + A list of instances of SsForwardRecord. + + + + A class which defines SS call barring record information. + + + + + SS class + + SS class type. + + + + SS status. + + Status of SS call barring. + + + + Call barring types providing various barring conditions on which calls are barred. + + Type of SS call barring. + + + + A class which defines values for SS call barring record. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Record number. + + Record value represented in integer. + + + + Specifies the maximum of SS barring records. + + A list of instances of SsBarringRecord. + + + + A class which defines SS waiting record information. + + + + + SS class + + SS class type. + + + + SS status. + + Status of SS call waiting. + + + + A class which defines values for SS call waiting record. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Record number. + + Record value represented in integer. + + + + Specifies the maximum of SS waiting records. + + A list of instances of SsWaitingRecord. + + + + A class which defines SUPS information message notification type. + + + + + SS error cause. + + Ss request result. + + + + SUPS information. + + Ss information type. + + + + A class which defines parameters related to call barring. + + + + + A constructor for instantiating SsBarringInfo class with the necessary parameters. + + Call type. + Barring mode. + Barring type. + Password (3GPP(GSM/UMTS/LTE) Specific). + + + + A class which defines the parameters related to forward info. + + + + + A constructor for instantiating SsForwardInfo class with the necessary parameters. + + SS Class. + Forward Mode. + Forward Condition. + No reply wait time 5-30 secs in intervals of 5(3GPP(GSM/UMTS/LTE) Specific). + Type of number. + Numbering plan identity. + Phone number. + + + + A class which defines parameters related to call waiting. + + + + + A constructor for instantiating SsWaitingInfo class with necessary parameters. + + Call type. + Call waiting mode. + + + + A class which defines values for calling line identity service. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Various line identification types. + + + + + Line identification status from the network. + + + + + A class which defines USSD response data. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + USSD Type. + + + + + USSD Status. + + + + + DCS. + + + + + USSD string length. + + + + + USSD String. + + + + + Enumeration for the SS class type. + + + + + All Teleservices. + + + + + Voice (Telephony). + + + + + All Data Teleservices. + + + + + Fax Service. + + + + + SMS Service. + + + + + Voice Group Call Service. + + + + + Voice Broadcast. + + + + + All teleservices except SMS. + + + + + All Bearer services. + + + + + All Async services. + + + + + All Sync services. + + + + + All Circuit switched sync services. + + + + + All Circuit switched async services. + + + + + All Dedicated Packet Access. + + + + + All Dedicated PAD Access. + + + + + All Data CDA. + + + + + All PLMN specific teleservices. + + + + + PLMN specific teleservice 1. + + + + + PLMN specific teleservice 2. + + + + + PLMN specific teleservice 3. + + + + + PLMN specific teleservice 4. + + + + + PLMN specific teleservice 5. + + + + + PLMN specific teleservice 6. + + + + + PLMN specific teleservice 7. + + + + + PLMN specific teleservice 8. + + + + + PLMN specific teleservice 9. + + + + + PLMN specific teleservice 10. + + + + + PLMN specific teleservice 11. + + + + + PLMN specific teleservice 12. + + + + + PLMN specific teleservice 13. + + + + + PLMN specific teleservice 14. + + + + + PLMN specific teleservice 15. + + + + + All PLMN specific bearer services. + + + + + PLMN specific bearer service 1. + + + + + PLMN specific bearer service 2. + + + + + PLMN specific bearer service 3. + + + + + PLMN specific bearer service 4. + + + + + PLMN specific bearer service 5. + + + + + PLMN specific bearer service 6. + + + + + PLMN specific bearer service 7. + + + + + PLMN specific bearer service 8. + + + + + PLMN specific bearer service 9. + + + + + PLMN specific bearer service 10. + + + + + PLMN specific bearer service 11. + + + + + PLMN specific bearer service 12. + + + + + PLMN specific bearer service 13. + + + + + PLMN specific bearer service 14. + + + + + PLMN specific bearer service 15. + + + + + Auxiliary Voice (Auxiliary telephony). + + + + + All GPRS bearer services. + + + + + All tele and bearer services. + + + + + Enumeration for various types of call barring. + + + + + Barring All Outgoing Calls. + + + + + Barring Outgoing International Calls. + + + + + Barring Outgoing International Calls except Home Country. + + + + + Barring All Incoming Calls. + + + + + Barring Incoming Calls when roaming outside the Home Country. + + + + + All Barring Services. + + + + + All Outgoing Barring Services. + + + + + All Incoming Barring Services. + + + + + Barring Incoming Calls which is not stored in the SIM memory. + + + + + Maximum Barring type. + + + + + Enumeration for the CLI service type. + + + + + Calling Line Identification Presentation. + + + + + Calling Line Identification Restriction. + + + + + Connected Line Identification Presentation. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Connected Line Identification Restriction. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Called Line Identification Presentation. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Calling Name Presentation. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Enumeration for the CLI service status. + + + + + Service not provided by the service provider. + + + + + Service is provided by the service provider. + + + + + Service is activated at the network. + + + + + Service status is unknown. + + + + + Service is temporarily restricted. + + + + + Service is temporarily allowed. + + + + + Enumeration for the call forwarding condition. + + + + + Call Forwarding Unconditional. + + + + + Call Forwarding Mobile Busy. + + + + + Call Forwarding No Reply. + + + + + Call Forwarding Not Reachable. + + + + + All Call Forwarding. + + + + + All Conditional Call Forwarding. + + + + + Max. + + + + + Enumeration for the USSD type. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + USSD request type - User Initiated. + + + + + USSD request type - User Response. + + + + + USSD request type - User Release. + + + + + Enumeration for the status of a supplementary service feature (e.g. call forwarding or call barring). + + + These enumerated values should be used as masks. + + + + + + Provisioned but not registered (or active/active-quiescent). + + + + + + + Not provisioned. + + + + + Enumeration for no-reply time. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Timer value set to 5secs. + + + + + Timer value set to 10secs. + + + + + Timer value set to 15secs. + + + + + Timer value set to 20secs. + + + + + Timer value set to 25secs. + + + + + Timer value set to 30secs. + + + + + Enumeration for the call forwarding type of number. + + + + + Unknown. + + + + + International number. + + + + + National number. + + + + + Network specific number. + + + + + Subscriber number. + + + + + Alphanumeric, GSM 7-bit default alphabet. + + + + + Abbreviated number. + + + + + Reserved for extension. + + + + + Enumeration for the call forward numbering plan identity. + + + + + Unknown. + + + + + ISDN/Telephone numbering plan. + + + + + Data numbering plan. + + + + + Telex numbering plan. + + + + + Service Center Specific plan. + + + + + Service Center Specific plan2. + + + + + National numbering plan. + + + + + Private numbering plan. + + + + + ERMES numbering plan. + + + + + Reserved for extension. + + + + + Enumeration for the supplementary service request results. + + + + + SS operation is successful. + + + + + SS error indicating unknown/illegal subscriber + + + + + This error is returned when illegality of the access has been established by use of an authentication procedure. + + + + + The network returns this error when it is requested to perform an operation on a supplementary service. + + + + + The network returns this error when it is requested to perform an operation on a supplementary service. + + + + + This error is returned when the IMEI check procedure has shown that the IMEI is blacklisted or it is not whitelisted. + + + + + This error is returned by the network to the MS when call independent subscriber control procedures are barred by the operator. + + + + + This error is returned by the network when it is requested to perform an illegal operation which is defined as not applicable for the relevant supplementary service. + + + + + This error is returned by the network when it is requested to perform an operation which is not compatible with the current status of the relevant supplementary service. + + + + + SS not available in the network. + + + + + SS service subscription violation. + + + + + This error is returned by the network when it is requested for a supplementary service operation that is incompatible with the status of another supplementary service or with the teleservice or bearer service for which the operation is requested. + + + + + SS service facility not supported. + + + + + This error is returned when the subscriber has activated the detach service or the system detects the absence condition. + + + + + This error is returned by the network, when it cannot perform an operation because of a failure in the network. + + + + + This error is returned by the network when an optional parameter is missing in an invoke component or an inner data structure, while it is required by the context of the request. + + + + + SS error indicating an unexpected data value on the network side. + + + + + SS error indicating a change password failure. + + + + + SS error indicating a negative password check. + + + + + SS error indicating violation in barring password attempts. + + + + + SS error indicating unknown SS data coding of an alphabet. + + + + + SS error indicating USSD Busy(Already SS / USSD is ongoing). + + + + + SS error indicating Dialing number is not FDN. + + + + + SS operation rejected by the user. + + + + + SS operation rejected by the network. + + + + + This error is returned if a diversion to the served subscriber's number is requested. + + + + + This error is returned if a diversion to a special service code is requested. + + + + + SS error indicating invalid deflected to a number. + + + + + SS error indicating Maximum MPTY is reached. + + + + + SS error indicating resources not available in the network. + + + + + SS error indicating resources not available in the network. + + + + + SS operation timer expired on the network. + + + + + SS operation is not allowed by the network. + + + + + SS error indicating an unknown error. + + + + + If OEM does not support any SS requests, then this error will be returned. + + + + + Enumeration for SS info type. + + + + + Barring. + + + + + Forwarding. + + + + + Waiting. + + + + + CLI. + + + + + Send Ussd. + + + + + Max value. + + + + + Enumeration for the call barring operation mode. + + + + + Activate call barring. + + + + + Deactivate call barring. + + + + + Enumeration for the forward mode. + + + + + Deactivate call forwarding. + + + + + Activate call forwarding. + + + + + Register call forwarding. + + + + + Deregister call forwarding. + + + + + Enumeration for the call waiting mode. + + + + + Activate call waiting. + + + + + Deactivate call waiting. + + + + + Enumeration for the types of identity presentation / restriction services. + + + + + Identify the party calling this phone. + + + + + Hide the identity of this phone when calling others. + + + + + Identify the party to whom the calling party (this phone) is connected. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Restrict yourself from being identified by incoming calls, such as forwarded calls. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Called line identity presentation. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Calling Name Presentation. 3GPP(GSM/UMTS/LTE) Specific. + + + + + Enumeration for the USSD indication type. Applicable to 3GPP(GSM/UMTS/LTE) only. + + + + + Notify : to display USSD data to the user. + + + + + No further user action required. + + + + + Further user action required. + + + + + USSD terminated by the network. + + + + + Other local client has responded. + + + + + Operation not supported. + + + + + Time out when there is no response from the network. + + + + + Enumerations for the types of Notification. + + + + + Voice call idle status notification. + + Instance of CallIdleStatusNotificationData will be stored in Data property of NotificationChangedEventArgs. + + + + Voice call active status notification. + + Active call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Voice call held status notification. + + Held call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Voice call dialing status notification. + + Dialing call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Voice call alerting status notification. + + Alert call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Voice call incoming status notification. + + Instance of CallIncomingInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Video call idle status notification. + + Instance of CallIdleStatusNotificationData will be stored in Data property of NotificationChangedEventArgs. + + + + Video call active status notification. + + Active call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Video call dialing status notification. + + Dialing call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Video call alerting status notification. + + Alert call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Video call incoming status notification. + + Instance of CallIncomingInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Outgoing call waiting nofificaiton. + + Waiting call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Outgoing call forwarded notification. + + Forward call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Incoming call barred notification. + + Barred incoming call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Outgoing call barred notification. + + Barred outgoing call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Mo call deflected notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + CLIR suppression reject notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + Unconditional call forward active notification. + + Unconditional forward call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Conditional call forward active notification. + + Conditional forward call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Incoming call forwarded notification. + + Forward call Id will be stored in Data property of NotificationChangedEventArgs. + + + + MT deflected call notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + MT transferred call notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + Call is in held notification. + + Held call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Call is in retrieved notificaiton. + + Active call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Call in in multiparty notificaiton. + + Joined call Id will be stored in Data property of NotificationChangedEventArgs. + + + + Call transfer alerting notificaiton. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + Call forward check message notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + New call information notification (CDMA only). + + Instance of CallRecord will be stored in Data property of NotificationChangedEventArgs. + + + + Call info fallback notification. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + Voice privacy mode change notification (CDMA only). + + CallPrivacyMode will be stored in Data property of NotificationChangedEventArgs. + + + + OTASP(Over The Air Service Provisioning) status notification (CDMA only). + + CallOtaspStatus will be stored in Data property of NotificationChangedEventArgs. + + + + OTAPA(Over The Air Parameter Administration) status notification (CDMA only). + + CallOtapaStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Call signal information notification (CDMA only). + + Instance of CallSignalNotification will be stored in Data property of NotificationChangedEventArgs. + + + + Call sound patch change notification. + + SoundPath will be stored in Data property of NotificationChangedEventArgs. + + + + Call ringback tone sound patch change notification. + + CallSoundRingbackNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Call sound WB-AMR(Wide Band Adaptive Multi-Rate) status notification. + + CallSoundWbamrNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Call sound noise reduction notification. + + CallSoundNoiseReduction will be stored in Data property of NotificationChangedEventArgs. + + + + Call sound clock status notification. + + Boolean status value will be stored in Data property of NotificationChangedEventArgs. + + + + Preferred voice subscription notification. + + CallPreferredVoiceSubscription will be stored in Data property of NotificationChangedEventArgs. + + + + VoLTE call which can provide upgrade/downgrade - caller/callee are all in VoLTE call. + + Nothing is stored in Data property of NotificationChangedEventArgs. + + + + VoLTE call for which upgrade call request is initiated from MT. + + CallUpgradeDowngradeRequestNoti will be stored in Data property of NotificationChangedEventArgs. + + + + VoLTE call for which downgrade call request is initiated from MT. + + CallUpgradeDowngradeRequestNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Modem power notification. + + PhonePowerStatus will be stored in Data property of NotificationChangedEventArgs. + + + + SIM status notification. + + SimCardStatus will be stored in Data property of NotificationChangedEventArgs. + + + + SIM refresh notification. + + SatCmdQualiRefresh will be stored in Data property of NotificationChangedEventArgs. + + + + Sap card status notification. + + SatCmdQualiRefresh will be stored in Data property of NotificationChangedEventArgs. + + + + Sap disconnect type notification. + + + + + Sat setup menu notification. + + Instance of SatMainMenuInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Sat display text notification. + + Instance of SatDisplayTextData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat select item notification. + + Instance of SatSelectItemData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat get inkey notification. + + Instance of SatGetInKeyData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat get input notification. + + Instance of SatGetInputData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat refresh notification. + + Instance of SatRefreshData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat send sms notification. + + Instance of SatSendSmsData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat setup event list notification. + + Instance of SatEventListData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat send dtmf notification. + + Instance of SatSendDtmfData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat end proactive session notification. + + SatCommandType will be stored in Data property of NotificationChangedEventArgs. + + + + Sat call control result notification. + + Instance of SatCallCtrlConfirmData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat mo sms control result notification. + + Instance of SatMoSmsCtrlData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat setup call notification. + + Instance of SatSetupCallData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat send SS notification. + + Instance of SatSendSsData will be stored in Data property of NotificationChangedEventArgs. + + + + Sat setup USSD notification. + + Instance of SatSetupUssdData will be stored in Data property of NotificationChangedEventArgs. + + + + Phonebook status notification. + + Instance of SimPhonebookStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Phonebook change notification. + + Instance of PhonebookContactChangeInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Network registration status notification. + + Instance of NetworkRegistrationStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Network cell information notification. + + Instance of NetworkCellNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Network change notification. + + Instance of NetworkChangeNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Network time information notification. + + Instance of NetworkTimeNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Network identity notification. + + Instance of NetworkIdentityNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Network signal strength notification. + + Signal Strength in dBm will be stored in Data property of NotificationChangedEventArgs. + + + + Network emergency callback mode notification. + + NetworkEmergencyCallbackMode will be stored in Data property of NotificationChangedEventArgs. + + + + Network default data subscription notification. + + NetworkDefaultDataSubscription will be stored in Data property of NotificationChangedEventArgs. + + + + Network default subscription notification. + + NetworkDefaultSubscription will be stored in Data property of NotificationChangedEventArgs. + + + + Network cell ID. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network LAC (Location Area Code). + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network TAC (Tracking Area Code). + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network system ID. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network network ID. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network base station ID. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network base station latitude. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network base station longitude. + + Int value will be stored in Data property of NotificationChangedEventArgs. + + + + Network VoLTE status notification. + + Instance of NetworkVolteStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Network EPDG status notification. + + Boolean value will be stored in Data property of NotificationChangedEventArgs. + + + + Ss ussd receive notification. + + Instance of SsUssdMsgInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Ss release complete notification. + + Instance of SsReleaseCompleteMsgInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Ss call forwarding status notification. + + Instance of SsForwardResponse will be stored in Data property of NotificationChangedEventArgs. + + + + Ss call barring status notification. + + Instance of SsBarringResponse will be stored in Data property of NotificationChangedEventArgs. + + + + Ss call waiting status notification. + + Instance of SsWaitingResponse will be stored in Data property of NotificationChangedEventArgs. + + + + Ss information notification. + + Instance of SsInfo will be stored in Data property of NotificationChangedEventArgs. + + + + Sms incoming message notification. + + Instance of SmsIncomingMessageNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Sms cell broadcast message incoming notification. + + Instance of SmsIncomingCbMessageNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Sms ETWS(Earthquake and Tsunami Warning System) message incoming notification. + + Instance of SmsIncomingEtwsMessageNoti will be stored in Data property of NotificationChangedEventArgs. + + + + Sms device memory status notification. + + SmsMemoryStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Sms ready notification. + + SmsReadyStatus will be stored in Data property of NotificationChangedEventArgs. + + + + Oem data notification. + + Instance of OemData will be stored in Data property of NotificationChangedEventArgs. + + + + Enumerations for the types of property definition. + + + + + Modem power property. + + PhonePowerStatus will be stored in Property property of PropertyChangedEventArgs. + + + + Modem dongle status property. + + Boolean value will be stored in Property property of PropertyChangedEventArgs. + + + + Modem dongle login property. + + Boolean value will be stored in Property property of PropertyChangedEventArgs. + + + + SIM call forward state property. + + Boolean value will be stored in Property property of PropertyChangedEventArgs. + + + + Network LAC (Location Area Code) property. + + Unsigned int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network TAC (Tracking Area Code) property (for LTE network). + + Unsigned int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network PLMN property. + + String value will be stored in Property property of PropertyChangedEventArgs. + + + + Network cell-id property. + + Unsigned int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network physical cell-id property. + + Unsigned int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network service type property. + + NetworkServiceType will be stored in Property property of PropertyChangedEventArgs. + + + + Network access technology property. + + NetworkSystemType will be stored in Property property of PropertyChangedEventArgs. + + + + Network ps type property. + + NetworkPsType will be stored in Property property of PropertyChangedEventArgs. + + + + Network circuit status property. + + NetworkServiceLevel will be stored in Property property of PropertyChangedEventArgs. + + + + Network packet status property. + + NetworkServiceLevel will be stored in Property property of PropertyChangedEventArgs. + + + + Network roaming status property. + + Boolean value will be stored in Property property of PropertyChangedEventArgs. + + + + Network name option property. + + NetworkNameDisplayCondition will be stored in Property property of PropertyChangedEventArgs. + + + + Network name property. + + String value will be stored in Property property of PropertyChangedEventArgs. + + + + SPN name property stored in SIM card. + + String value will be stored in Property property of PropertyChangedEventArgs. + + + + Network signal dbm property. + + Int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network signal level property. + + Int value will be stored in Property property of PropertyChangedEventArgs. + + + + Network ims voice support status property. + + Boolean value will be stored in Property property of PropertyChangedEventArgs. + + + + Network volte enable status notification. + + VolteNetworkType will be stored in Property property of PropertyChangedEventArgs. + + + + Network serving LTE band property. + + NetworkLteBandType will be stored in Property property of PropertyChangedEventArgs. + + + + An extended EventArgs class which contains changed tapi state. + + + + + Tapi ready state. + + + + + An extended EventArgs class which contains changed TAPI notification. + + + + + Notification Id. + + + + + Notification data. + + + + + An extended EventArgs class which contains changed TAPI property. + + + + + Property definition type. + + + + + Property data. + + + + + This class is used for managing event callbacks for notifications and properties. + + + + + This event is called for the TAPI notification change. + + + + + This event is called for the TAPI property change. + + + + + Registers a notification callback for notification change events on DBus interface. + + Notification id for which a callback has to be registered. + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Registers a notification callback for property change events on DBus interface. + + Property definition for which a callback has to be registered. + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Deregisters notification callback for notification change events on DBus interface. + + Notification id for which the callback has to be de-registered. + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Deregisters notification callback for property change events on DBus interface. + + Property definition for which the callback has to be de-registered. + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the property value in an integer format for the given property. + + The property to be retrieved from Dbus. + The property value in integer format. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when permission is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + Gets the property value in a string format for the given property. + + The property to be retrieved from Dbus. + The property value in string format. + http://tizen.org/feature/network.telephony + http://tizen.org/privilege/telephony + Thrown when telephony feature is not supported. + Thrown when permission is denied. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + + This class is used for initializing/deinitializing Tapi and manages the state of it. + + + + + Gets the state value if tapi is ready. + + The State value in integer format - 0 is False and 1 is True. Returns -1 in case of error. + + + + This event is raised when Tapi ready state changes. + + + + + Fetches a list of available CPs. + + List of available CPs in case of success. Null in case of failure. + http://tizen.org/feature/network.telephony + + + + Acquires a TAPI Handle for the specified CP name. + + The CP Name against which a TAPI handle is required (A NULL CP Name will return a #TapiHandle bound to the first CP in the list of available CPs). + Instance of TapiHandle on success, null on failure. + http://tizen.org/feature/network.telephony + + + + Deinitializes the TAPI Handle. + + http://tizen.org/feature/network.telephony + Thrown when telephony feature is not supported. + Thrown when it is failed due to invalid parameter. + Thrown when it is failed due to invalid operation. + + + diff --git a/Artifacts/bin/Tizen.Telephony.dll b/Artifacts/bin/Tizen.Telephony.dll index c04b88e..c6716fb 100644 Binary files a/Artifacts/bin/Tizen.Telephony.dll and b/Artifacts/bin/Tizen.Telephony.dll differ diff --git a/Artifacts/bin/Tizen.Telephony.pdb b/Artifacts/bin/Tizen.Telephony.pdb index 8d837c0..92401a4 100644 Binary files a/Artifacts/bin/Tizen.Telephony.pdb and b/Artifacts/bin/Tizen.Telephony.pdb differ diff --git a/Artifacts/bin/Tizen.Telephony.xml b/Artifacts/bin/Tizen.Telephony.xml index 9b48cb3..1890564 100644 --- a/Artifacts/bin/Tizen.Telephony.xml +++ b/Artifacts/bin/Tizen.Telephony.xml @@ -1,1605 +1,1605 @@ - - - - Tizen.Telephony - - - - - The Partial Interop class. - - - The Partial Interop class. - - - The Partial Interop class. - - - The Partial Interop class. - - - The Partial Interop class. - - - The Partial Interop class. - - - - - The Call Interop class. - - - - - The Libraries Interop class. - - - - - The Modem Interop class. - - - - - The Network Interop class. - - - - - The SIM Interop class. - - - - - The Telephony Interop class. - - - - - The Call APIs allow you to get the voice and video call states. - It provides the list of CallHandle which can be used to get the information about call related actions. - - - - - The public constructor. - - 3 - - SlotHandle received in the Manager.Init API. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception occurs if the handle provided is null. - - - - - Gets the current value for the preferred voice call subscription. - - 3 - http://tizen.org/privilege/telephony - - The currently set preferred voicecall subscription value. - - - - - Gets the list of the current call. - - 3 - - The list of the CallHandle for existing calls. - - http://tizen.org/privilege/telephony - http://tizen.org/feature/network.telephony - The required feature is not supported. - In case of an invalid parameter. - In case of any system error. - In case of privileges not defined. - In case of out of memory. - - - - This class provides the APIs to get the information about calls. - - - - - Enumeration for the call status. - - - - - Idle status. - - - - - Active status. - - - - - Held status. - - - - - Dialing status. - - - - - Alerting status. - - - - - Incoming status. - - - - - Unavailable. - - - - - Enumeration for the call type. - - - - - Voice call. - - - - - Video call. - - - - - Emergency call. - - - - - Unavailable. - - - - - Enumeration for the call direction. - - - - - MO(Mobile Originated) call. - - - - - MT(Mobile Terminated) call. - - - - - Unavailable. - - - - - Gets the call handle ID. - - 3 - - The ID of the call handle. - 0 if unable to complete the operation. - - - - - Gets the call number. - - 3 - - The number of the call. - Empty string if unable to complete the operation. - - - - - Gets the call type. - - 3 - - The type of the call. - - - - - Gets the call status. - - 3 - - The status of the call. - - - - - Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated) call. - - 3 - - The direction of the call. - - - This Exception can occur due to: - 1. Operation Not Supported. - - - - - Gets whether the call is a conference call or not. - - 3 - - The value whether the call is a conference call or not (true: Conference call, false: Single call). - - - - - This class contains the data related to the Notification event. - - - - - Enumeration for the Telephony Notification. - - - - - The notification to be invoked when the SIM card state changes. - SIM.State will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the SIM call forwarding indicator state changes. - 'state(bool)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the network service state changes. - Network.ServiceState will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the cell ID changes. - 'cell_id(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the roaming status changes. - 'roaming_status(bool)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the signal strength changes. - Network.Rssi will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the network name changes. - 'network_name(string)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the PS type changes. - Network.PSType will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the default data subscription changes. - Network.DefaultDataSubscription will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the default subscription changes. - Network.DefaultSubscription will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the LAC (Location Area Code) changes. - 'lac(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the TAC (Tracking Area Code) changes. - 'tac(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the system ID changes. - 'sid(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the network ID changes. - 'nid(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the base station ID changes. - 'id(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the base station latitude changes. - 'latitude(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when the base station longitude changes. - 'longitue(int)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/location.coarse - - - - - The notification to be invoked when a voice call is in the idle status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a voice call is in the active status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a voice call is in the held status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a voice call is in the dialing status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a voice call is in the alerting status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a voice call is in the incoming status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a video call is in the idle status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a video call is in the active status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a video call is in the dialing status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a video call is in the alerting status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when a video call is in the incoming status. - 'handle id(uint)' will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The notification to be invoked when the preferred voice subscription changes. - CallPreferredVoiceSubscription will be delivered in the notification data. - - 3 - - http://tizen.org/privilege/telephony - - - - - The Telephony Notification type. - - 3 - - - - The data as per the Notification type. - - 3 - - - - This class provides APIs to obtain information from the modem. - - - - - The Modem class constructor. - - 3 - - SlotHandle received in the Manager.Init API. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception occurs if the handle provided is null. - - - - - Enumeration for the Modem Power Status. - - - - - Unknown. - - - - - Modem power ON. - - - - - Modem power OFF. - - - - - Modem power RESET. - - - - - Modem power LOW. - - - - - Gets the IMEI (International Mobile Station Equipment Identity) of a mobile phone. - The IMEI number is used by a GSM network to identify valid devices and therefore, can be used for stopping a stolen phone from accessing that network. - - 3 - http://tizen.org/privilege/telephony - - The International Mobile Station Equipment Identity. - Empty string if unable to complete the operation. - - - - - Gets the power status of the modem. - - 3 - http://tizen.org/privilege/telephony - - The Modem power status (0=on,1=off,2=reset,3=low). - - - - - Gets the MEID (Mobile Equipment Identifier) of a mobile phone (for CDMA). - - 3 - http://tizen.org/privilege/telephony - - The Mobile Equipment Identifier. - Empty string if unable to complete the operation. - - - - - The Network class provides APIs to obtain information about the current telephony service network. - - - - - The Network class constructor. - - 3 - - SlotHandle received in the Manager.Init API. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception occurs if the handle provided is null. - - - - - Enumeration for the RSSI (Receive Signal Strength Indicator). - Rssi6 indicates the highest strength. - - - - - Strength 0. - - - - - Strength 1. - - - - - Strength 2. - - - - - Strength 3. - - - - - Strength 4. - - - - - Strength 5. - - - - - Strength 6. - - - - - Unavailable. - - - - - Enumeration for the network types. - - - - - Unknown. - - - - - 2G GSM network type. - - - - - 2.5G GPRS network type. - - - - - 2.5G EDGE network type. - - - - - 3G UMTS network type. - - - - - HSDPA network type. - - - - - LTE network type. - - - - - IS95A network type. - - - - - IS95B network type. - - - - - CDMA 1x network type. - - - - - EVDO revision 0 network type. - - - - - EVDO revision A network type. - - - - - EVDO revision B network type. - - - - - EVDV network type. - - - - - EHRPD network type. - - - - - Enumeration for the PS types. - - - - - Unknown. - - - - - HSDPA PS type. - - - - - HSUPA PS type. - - - - - HSPA PS type. - - - - - HSPAP PS type. - - - - - Enumeration for the network service states. - - - - - In service. - - - - - Out of service. - - - - - Only emergency call is allowed. - - - - - Unavailable. - - - - - Enumeration for the network name priority. - - - - - Unknown. - - - - - The network name displayed by the SPN. - - - - - The network name displayed by the Network. - - - - - The network name displayed by the SPN or the Network. - - - - - Enumeration for the possible 'default' Data Subscriptions for the Packet Switched(PS). - - - - - Unknown status. - - - - - SIM 1. - - - - - SIM 2. - - - - - Enumeration for defining the possible 'default' Subscriptions for the Circuit Switched(CS). - - - - - Unknown status. - - - - - SIM 1 network. - - - - - SIM 2 network. - - - - - Enumeration for the network selection modes. - - - - - Automatic mode. - - - - - Manual mode. - - - - - Unavailable. - - - - - Gets the LAC (Location Area Code) of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the GSM/WCDMA network. - - - The Location Area Code, -1 if unknown. - - - - - Gets the cell ID of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the GSM/WCDMA/LTE network. - - - The cell identification number, -1 if unknown. - - - - - Gets the RSSI (Received Signal Strength Indicator). - - 3 - http://tizen.org/privilege/telephony - - The Received Signal Strength Indicator. - Higher the received number, the stronger the signal strength. - - - - - Gets the roaming state of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - true if roaming, otherwise false if not roaming. - - - - - Gets the MCC (Mobile Country Code) of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - This API can be used in the GSM/WCDMA/LTE network. - - - The Mobile Country Code (three digits). The Mobile Country Code (MCC) identifies the country where the cell is being used. - Empty string if unknown. - - - - - Gets the MNC (Mobile Network Code) of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - This API can be used in the GSM/WCDMA/LTE network. - - - The Mobile Network Code (three digits). The Mobile Network Code (MNC) identifies the mobile phone operator and the network provider. - Empty string if unknown. - - - - - Gets the name of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - This API can be used in the GSM/WCDMA/LTE network. - - - The name of the current registered network. - Empty string if unknown. - - - - - Gets the network service type of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - This API can be used in case the network is in service. - - - The network service type. - - - - - Gets the packet service type of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - This API can be used in the HSDPA network. - - - The type of the packet service. - - - - - Gets the network name option of the current registered network. - - 3 - http://tizen.org/privilege/telephony - - The network name display option. - - - - - Gets the current network state of the telephony service. - - 3 - http://tizen.org/privilege/telephony - - The current network state. - - - - - Gets the current default subscription for the data service (Packet Switched). - - 3 - http://tizen.org/privilege/telephony - - The current default data subscription. - - - - - Gets the current default subscription for the voice service (Circuit Switched). - - 3 - http://tizen.org/privilege/telephony - - The current default voice subscription. - - - - - Gets the network selection mode. - - 3 - http://tizen.org/privilege/telephony - - The network selection mode. - - - - - Gets the TAC (Tracking Area Code) of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the LTE network. - - - The Tracking Area Code. - -1 if unknown. - - - - - Gets the system ID of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the CDMA network. - - - The system ID. - -1 if unknown. - - - - - Gets the network ID of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the CDMA network. - - - The network ID. - -1 if unknown. - - - - - Gets the base station ID of the current location. - - 3 - http://tizen.org/privilege/location.coarse> - - This API can be used in the CDMA network. - - - The base station ID. - -1 if unknown. - - - - - Gets the base station latitude of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the CDMA network. - - - The base station latitude. - 0x7FFFFFFF if unknown. - - - - - Gets the base station longitude of the current location. - - 3 - http://tizen.org/privilege/location.coarse - - This API can be used in the CDMA network. - - - The base station latitude. - 0x7FFFFFFF if unknown. - - - - - This class provides APIs that allow you to extract the information stored on a SIM card. - - - - - The SIM class constructor. - - 3 - - SlotHandle received in the Manager.Init API. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception occurs if the handle provided is null. - - - - - Enumeration for the state of the SIM card. - - - - - The SIM is not available on this device. - - - - - The SIM is locked. - - - - - The SIM is available on this device (SIM is not locked). - - - - - The SIM is in transition between states. - - - - - Enumeration for the lock state of the SIM card. - - - - - The SIM is not in lock. - - - - - The SIM is PIN (Personal Identification Number) locked. - - - - - The SIM is PUK (Personal Unblocking Code) locked. - - - - - The SIM is permanently blocked (All the attempts for PIN/PUK failed). - - - - - The SIM is NCK (Network Control Key) locked. - - - - - Enumeration for the type of the SIM card. - - - - - SIM (GSM) application. - - - - - USIM application. - - - - - CDMA application. - - - - - ISIM application. - - - - - Gets the Integrated Circuit Card IDentification (ICC-ID). - The Integrated Circuit Card Identification number internationally identifies SIM cards. - - 3 - http://tizen.org/privilege/telephony - - The Integrated Circuit Card Identification. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the SIM Operator (MCC [3 digits] + MNC [2~3 digits]). - The Operator is embedded in the SIM card. - - 3 - http://tizen.org/privilege/telephony - - The SIM Operator. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the Mobile Subscription Identification Number (MSIN [9~10 digits]) of the SIM provider. - - 3 - http://tizen.org/privilege/telephony - - The Mobile Subscription Identification Number. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the Service Provider Name (SPN) of the SIM card. - Gets Service Provider Name embedded in the SIM card. If this value is not stored in the SIM card, an empty string will be returned. - - 3 - http://tizen.org/privilege/telephony - - The Service Provider Name. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Checks whether the current SIM card is different from the previous SIM card. - - 3 - http://tizen.org/privilege/telephony - - true if the current SIM card is different from the previous SIM card, otherwise false if the SIM card is not changed. - - - The SIM state must be Available. - - - - - Gets the state of the SIM. - - 3 - http://tizen.org/privilege/telephony - - The current state of the SIM. - - - - - Gets the count of an application on the UICC. - - 3 - http://tizen.org/privilege/telephony - - The masking value for below values are provided by the enumeration ApplicationType. - 0 if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the subscriber number embedded in the SIM card. This value contains the MSISDN related to the subscriber. - If this value is not stored in SIM card, an empty string will be returned. - - 3 - http://tizen.org/privilege/telephony - - The subscriber number in the SIM. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the subscriber ID. - - 3 - http://tizen.org/privilege/telephony - - The subscriber ID. - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the lock state of the SIM. - - 3 - http://tizen.org/privilege/telephony - - The current lock state of the SIM. - - - The SIM state must be Available. - - - - - Gets the GID1 (Group Identifier Level 1). - Gets Group Identifier Level 1 (GID1) embedded in the SIM card. If this value is not stored in SIM card, an empty string will be returned. - - 3 - http://tizen.org/privilege/telephony - - The GID1 (Group Identifier Level 1). - Empty string if unable to complete the operation. - - - The SIM state must be Available. - - - - - Gets the call forwarding indicator state of the SIM. - If the state is true, the incoming call will be forwarded to the selected number. State indicates the CFU (Call Forwarding Unconditional) indicator status - Voice (3GPP TS 31.102 4.2.64 EF CFIS). - - 3 - http://tizen.org/privilege/telephony - - The value whether the incoming call will be forwarded or not (true: forwarded, false: not forwarded). - - - The SIM state must be Available. - - - - - This class provides APIs that provide functionality related to the slot handle. - - - - - The event handler for receiving the Telephony state changes. - This event will be triggered for the NotificationIds given in the SetNotificationId API. - - - - - The notification IDs for which the ChangeNotification event will be triggered. - - 3 - - The list of notification IDs for which the ChangeNotification event will be triggered. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This Exception can occur due to: - 1. Operation not supported. - 2. Operation failed. - - - - - The notification IDs for which the ChangeNotification event will not be triggered. - - 3 - - The list of notification IDs for which the ChangeNotification event will be not be triggered. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This Exception can occur due to: - 1. Operation not supported. - 2. Operation failed. - - - - - This class contains the data related to the State changed event. - - - - - The Current State. - - 3 - - - - Enumeration for the telephony states. - - - - - The telephony state is not ready. - - - - - The telephony state is ready. - - - - - Unavailable. - - - - - Enumeration for the preferred voice call subscription. - - - - - Unknown status. - - - - - Current network. - - - - - Ask Always. - - - - - SIM 1. - - - - - SIM 2. - - - - - This class provides APIs to initialize and deinitialize the framework. - It also provides APIs to get the SlotHandles, which can then be used to get other Network/Sim/Call/Modem information. - - - - - The event handler to be invoked when the telephony state changes. - - 3 - - - - Acquires the telephony state value. - - 3 - - The state value of telephony. - - - - - Acquires the number of available handles to use the telephony API. - - 3 - - A list of telephony handles. - You will get 2 SlotHandles in case of the dual SIM device. - Where, SlotHandle at Index '0' represents the primary SIM and Index '1' represents the secondary SIM. - - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception will be generated in the following cases: - 1. The system is out of memory. - 2. If the operation is not supported on the device. - 3. If the operation failed. - - - - - Deinitializes the telephony handles. - - 3 - http://tizen.org/feature/network.telephony - The required feature is not supported. - - This exception can be generated in the following cases: - 1. If the operation is not supported on the device. - 2. If the operation failed. - - - - + + + + Tizen.Telephony + + + + + The Partial Interop class. + + + The Partial Interop class. + + + The Partial Interop class. + + + The Partial Interop class. + + + The Partial Interop class. + + + The Partial Interop class. + + + + + The Call Interop class. + + + + + The Libraries Interop class. + + + + + The Modem Interop class. + + + + + The Network Interop class. + + + + + The SIM Interop class. + + + + + The Telephony Interop class. + + + + + The Call APIs allow you to get the voice and video call states. + It provides the list of CallHandle which can be used to get the information about call related actions. + + + + + The public constructor. + + 3 + + SlotHandle received in the Manager.Init API. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception occurs if the handle provided is null. + + + + + Gets the current value for the preferred voice call subscription. + + 3 + http://tizen.org/privilege/telephony + + The currently set preferred voicecall subscription value. + + + + + Gets the list of the current call. + + 3 + + The list of the CallHandle for existing calls. + + http://tizen.org/privilege/telephony + http://tizen.org/feature/network.telephony + The required feature is not supported. + In case of an invalid parameter. + In case of any system error. + In case of privileges not defined. + In case of out of memory. + + + + This class provides the APIs to get the information about calls. + + + + + Enumeration for the call status. + + + + + Idle status. + + + + + Active status. + + + + + Held status. + + + + + Dialing status. + + + + + Alerting status. + + + + + Incoming status. + + + + + Unavailable. + + + + + Enumeration for the call type. + + + + + Voice call. + + + + + Video call. + + + + + Emergency call. + + + + + Unavailable. + + + + + Enumeration for the call direction. + + + + + MO(Mobile Originated) call. + + + + + MT(Mobile Terminated) call. + + + + + Unavailable. + + + + + Gets the call handle ID. + + 3 + + The ID of the call handle. + 0 if unable to complete the operation. + + + + + Gets the call number. + + 3 + + The number of the call. + Empty string if unable to complete the operation. + + + + + Gets the call type. + + 3 + + The type of the call. + + + + + Gets the call status. + + 3 + + The status of the call. + + + + + Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated) call. + + 3 + + The direction of the call. + + + This Exception can occur due to: + 1. Operation Not Supported. + + + + + Gets whether the call is a conference call or not. + + 3 + + The value whether the call is a conference call or not (true: Conference call, false: Single call). + + + + + This class contains the data related to the Notification event. + + + + + Enumeration for the Telephony Notification. + + + + + The notification to be invoked when the SIM card state changes. + SIM.State will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the SIM call forwarding indicator state changes. + 'state(bool)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the network service state changes. + Network.ServiceState will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the cell ID changes. + 'cell_id(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the roaming status changes. + 'roaming_status(bool)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the signal strength changes. + Network.Rssi will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the network name changes. + 'network_name(string)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the PS type changes. + Network.PSType will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the default data subscription changes. + Network.DefaultDataSubscription will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the default subscription changes. + Network.DefaultSubscription will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the LAC (Location Area Code) changes. + 'lac(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the TAC (Tracking Area Code) changes. + 'tac(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the system ID changes. + 'sid(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the network ID changes. + 'nid(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the base station ID changes. + 'id(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the base station latitude changes. + 'latitude(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when the base station longitude changes. + 'longitue(int)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/location.coarse + + + + + The notification to be invoked when a voice call is in the idle status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a voice call is in the active status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a voice call is in the held status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a voice call is in the dialing status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a voice call is in the alerting status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a voice call is in the incoming status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a video call is in the idle status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a video call is in the active status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a video call is in the dialing status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a video call is in the alerting status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when a video call is in the incoming status. + 'handle id(uint)' will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The notification to be invoked when the preferred voice subscription changes. + CallPreferredVoiceSubscription will be delivered in the notification data. + + 3 + + http://tizen.org/privilege/telephony + + + + + The Telephony Notification type. + + 3 + + + + The data as per the Notification type. + + 3 + + + + This class provides APIs to obtain information from the modem. + + + + + The Modem class constructor. + + 3 + + SlotHandle received in the Manager.Init API. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception occurs if the handle provided is null. + + + + + Enumeration for the Modem Power Status. + + + + + Unknown. + + + + + Modem power ON. + + + + + Modem power OFF. + + + + + Modem power RESET. + + + + + Modem power LOW. + + + + + Gets the IMEI (International Mobile Station Equipment Identity) of a mobile phone. + The IMEI number is used by a GSM network to identify valid devices and therefore, can be used for stopping a stolen phone from accessing that network. + + 3 + http://tizen.org/privilege/telephony + + The International Mobile Station Equipment Identity. + Empty string if unable to complete the operation. + + + + + Gets the power status of the modem. + + 3 + http://tizen.org/privilege/telephony + + The Modem power status (0=on,1=off,2=reset,3=low). + + + + + Gets the MEID (Mobile Equipment Identifier) of a mobile phone (for CDMA). + + 3 + http://tizen.org/privilege/telephony + + The Mobile Equipment Identifier. + Empty string if unable to complete the operation. + + + + + The Network class provides APIs to obtain information about the current telephony service network. + + + + + The Network class constructor. + + 3 + + SlotHandle received in the Manager.Init API. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception occurs if the handle provided is null. + + + + + Enumeration for the RSSI (Receive Signal Strength Indicator). + Rssi6 indicates the highest strength. + + + + + Strength 0. + + + + + Strength 1. + + + + + Strength 2. + + + + + Strength 3. + + + + + Strength 4. + + + + + Strength 5. + + + + + Strength 6. + + + + + Unavailable. + + + + + Enumeration for the network types. + + + + + Unknown. + + + + + 2G GSM network type. + + + + + 2.5G GPRS network type. + + + + + 2.5G EDGE network type. + + + + + 3G UMTS network type. + + + + + HSDPA network type. + + + + + LTE network type. + + + + + IS95A network type. + + + + + IS95B network type. + + + + + CDMA 1x network type. + + + + + EVDO revision 0 network type. + + + + + EVDO revision A network type. + + + + + EVDO revision B network type. + + + + + EVDV network type. + + + + + EHRPD network type. + + + + + Enumeration for the PS types. + + + + + Unknown. + + + + + HSDPA PS type. + + + + + HSUPA PS type. + + + + + HSPA PS type. + + + + + HSPAP PS type. + + + + + Enumeration for the network service states. + + + + + In service. + + + + + Out of service. + + + + + Only emergency call is allowed. + + + + + Unavailable. + + + + + Enumeration for the network name priority. + + + + + Unknown. + + + + + The network name displayed by the SPN. + + + + + The network name displayed by the Network. + + + + + The network name displayed by the SPN or the Network. + + + + + Enumeration for the possible 'default' Data Subscriptions for the Packet Switched(PS). + + + + + Unknown status. + + + + + SIM 1. + + + + + SIM 2. + + + + + Enumeration for defining the possible 'default' Subscriptions for the Circuit Switched(CS). + + + + + Unknown status. + + + + + SIM 1 network. + + + + + SIM 2 network. + + + + + Enumeration for the network selection modes. + + + + + Automatic mode. + + + + + Manual mode. + + + + + Unavailable. + + + + + Gets the LAC (Location Area Code) of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the GSM/WCDMA network. + + + The Location Area Code, -1 if unknown. + + + + + Gets the cell ID of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the GSM/WCDMA/LTE network. + + + The cell identification number, -1 if unknown. + + + + + Gets the RSSI (Received Signal Strength Indicator). + + 3 + http://tizen.org/privilege/telephony + + The Received Signal Strength Indicator. + Higher the received number, the stronger the signal strength. + + + + + Gets the roaming state of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + true if roaming, otherwise false if not roaming. + + + + + Gets the MCC (Mobile Country Code) of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + This API can be used in the GSM/WCDMA/LTE network. + + + The Mobile Country Code (three digits). The Mobile Country Code (MCC) identifies the country where the cell is being used. + Empty string if unknown. + + + + + Gets the MNC (Mobile Network Code) of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + This API can be used in the GSM/WCDMA/LTE network. + + + The Mobile Network Code (three digits). The Mobile Network Code (MNC) identifies the mobile phone operator and the network provider. + Empty string if unknown. + + + + + Gets the name of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + This API can be used in the GSM/WCDMA/LTE network. + + + The name of the current registered network. + Empty string if unknown. + + + + + Gets the network service type of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + This API can be used in case the network is in service. + + + The network service type. + + + + + Gets the packet service type of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + This API can be used in the HSDPA network. + + + The type of the packet service. + + + + + Gets the network name option of the current registered network. + + 3 + http://tizen.org/privilege/telephony + + The network name display option. + + + + + Gets the current network state of the telephony service. + + 3 + http://tizen.org/privilege/telephony + + The current network state. + + + + + Gets the current default subscription for the data service (Packet Switched). + + 3 + http://tizen.org/privilege/telephony + + The current default data subscription. + + + + + Gets the current default subscription for the voice service (Circuit Switched). + + 3 + http://tizen.org/privilege/telephony + + The current default voice subscription. + + + + + Gets the network selection mode. + + 3 + http://tizen.org/privilege/telephony + + The network selection mode. + + + + + Gets the TAC (Tracking Area Code) of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the LTE network. + + + The Tracking Area Code. + -1 if unknown. + + + + + Gets the system ID of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the CDMA network. + + + The system ID. + -1 if unknown. + + + + + Gets the network ID of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the CDMA network. + + + The network ID. + -1 if unknown. + + + + + Gets the base station ID of the current location. + + 3 + http://tizen.org/privilege/location.coarse> + + This API can be used in the CDMA network. + + + The base station ID. + -1 if unknown. + + + + + Gets the base station latitude of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the CDMA network. + + + The base station latitude. + 0x7FFFFFFF if unknown. + + + + + Gets the base station longitude of the current location. + + 3 + http://tizen.org/privilege/location.coarse + + This API can be used in the CDMA network. + + + The base station latitude. + 0x7FFFFFFF if unknown. + + + + + This class provides APIs that allow you to extract the information stored on a SIM card. + + + + + The SIM class constructor. + + 3 + + SlotHandle received in the Manager.Init API. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception occurs if the handle provided is null. + + + + + Enumeration for the state of the SIM card. + + + + + The SIM is not available on this device. + + + + + The SIM is locked. + + + + + The SIM is available on this device (SIM is not locked). + + + + + The SIM is in transition between states. + + + + + Enumeration for the lock state of the SIM card. + + + + + The SIM is not in lock. + + + + + The SIM is PIN (Personal Identification Number) locked. + + + + + The SIM is PUK (Personal Unblocking Code) locked. + + + + + The SIM is permanently blocked (All the attempts for PIN/PUK failed). + + + + + The SIM is NCK (Network Control Key) locked. + + + + + Enumeration for the type of the SIM card. + + + + + SIM (GSM) application. + + + + + USIM application. + + + + + CDMA application. + + + + + ISIM application. + + + + + Gets the Integrated Circuit Card IDentification (ICC-ID). + The Integrated Circuit Card Identification number internationally identifies SIM cards. + + 3 + http://tizen.org/privilege/telephony + + The Integrated Circuit Card Identification. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the SIM Operator (MCC [3 digits] + MNC [2~3 digits]). + The Operator is embedded in the SIM card. + + 3 + http://tizen.org/privilege/telephony + + The SIM Operator. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the Mobile Subscription Identification Number (MSIN [9~10 digits]) of the SIM provider. + + 3 + http://tizen.org/privilege/telephony + + The Mobile Subscription Identification Number. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the Service Provider Name (SPN) of the SIM card. + Gets Service Provider Name embedded in the SIM card. If this value is not stored in the SIM card, an empty string will be returned. + + 3 + http://tizen.org/privilege/telephony + + The Service Provider Name. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Checks whether the current SIM card is different from the previous SIM card. + + 3 + http://tizen.org/privilege/telephony + + true if the current SIM card is different from the previous SIM card, otherwise false if the SIM card is not changed. + + + The SIM state must be Available. + + + + + Gets the state of the SIM. + + 3 + http://tizen.org/privilege/telephony + + The current state of the SIM. + + + + + Gets the count of an application on the UICC. + + 3 + http://tizen.org/privilege/telephony + + The masking value for below values are provided by the enumeration ApplicationType. + 0 if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the subscriber number embedded in the SIM card. This value contains the MSISDN related to the subscriber. + If this value is not stored in SIM card, an empty string will be returned. + + 3 + http://tizen.org/privilege/telephony + + The subscriber number in the SIM. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the subscriber ID. + + 3 + http://tizen.org/privilege/telephony + + The subscriber ID. + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the lock state of the SIM. + + 3 + http://tizen.org/privilege/telephony + + The current lock state of the SIM. + + + The SIM state must be Available. + + + + + Gets the GID1 (Group Identifier Level 1). + Gets Group Identifier Level 1 (GID1) embedded in the SIM card. If this value is not stored in SIM card, an empty string will be returned. + + 3 + http://tizen.org/privilege/telephony + + The GID1 (Group Identifier Level 1). + Empty string if unable to complete the operation. + + + The SIM state must be Available. + + + + + Gets the call forwarding indicator state of the SIM. + If the state is true, the incoming call will be forwarded to the selected number. State indicates the CFU (Call Forwarding Unconditional) indicator status - Voice (3GPP TS 31.102 4.2.64 EF CFIS). + + 3 + http://tizen.org/privilege/telephony + + The value whether the incoming call will be forwarded or not (true: forwarded, false: not forwarded). + + + The SIM state must be Available. + + + + + This class provides APIs that provide functionality related to the slot handle. + + + + + The event handler for receiving the Telephony state changes. + This event will be triggered for the NotificationIds given in the SetNotificationId API. + + + + + The notification IDs for which the ChangeNotification event will be triggered. + + 3 + + The list of notification IDs for which the ChangeNotification event will be triggered. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This Exception can occur due to: + 1. Operation not supported. + 2. Operation failed. + + + + + The notification IDs for which the ChangeNotification event will not be triggered. + + 3 + + The list of notification IDs for which the ChangeNotification event will be not be triggered. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This Exception can occur due to: + 1. Operation not supported. + 2. Operation failed. + + + + + This class contains the data related to the State changed event. + + + + + The Current State. + + 3 + + + + Enumeration for the telephony states. + + + + + The telephony state is not ready. + + + + + The telephony state is ready. + + + + + Unavailable. + + + + + Enumeration for the preferred voice call subscription. + + + + + Unknown status. + + + + + Current network. + + + + + Ask Always. + + + + + SIM 1. + + + + + SIM 2. + + + + + This class provides APIs to initialize and deinitialize the framework. + It also provides APIs to get the SlotHandles, which can then be used to get other Network/Sim/Call/Modem information. + + + + + The event handler to be invoked when the telephony state changes. + + 3 + + + + Acquires the telephony state value. + + 3 + + The state value of telephony. + + + + + Acquires the number of available handles to use the telephony API. + + 3 + + A list of telephony handles. + You will get 2 SlotHandles in case of the dual SIM device. + Where, SlotHandle at Index '0' represents the primary SIM and Index '1' represents the secondary SIM. + + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception will be generated in the following cases: + 1. The system is out of memory. + 2. If the operation is not supported on the device. + 3. If the operation failed. + + + + + Deinitializes the telephony handles. + + 3 + http://tizen.org/feature/network.telephony + The required feature is not supported. + + This exception can be generated in the following cases: + 1. If the operation is not supported on the device. + 2. If the operation failed. + + + + diff --git a/Artifacts/bin/Tizen.Tracer.dll b/Artifacts/bin/Tizen.Tracer.dll index d5b5b1f..e0c0fc1 100644 Binary files a/Artifacts/bin/Tizen.Tracer.dll and b/Artifacts/bin/Tizen.Tracer.dll differ diff --git a/Artifacts/bin/Tizen.Tracer.pdb b/Artifacts/bin/Tizen.Tracer.pdb index 434a8f8..5ca02bc 100644 Binary files a/Artifacts/bin/Tizen.Tracer.pdb and b/Artifacts/bin/Tizen.Tracer.pdb differ diff --git a/Artifacts/bin/Tizen.Tracer.xml b/Artifacts/bin/Tizen.Tracer.xml index b036dae..bd46db5 100644 --- a/Artifacts/bin/Tizen.Tracer.xml +++ b/Artifacts/bin/Tizen.Tracer.xml @@ -1,66 +1,66 @@ - - - - Tizen.Tracer - - - - - Provides functions for writing trace message to the system trace buffer. - - - - - Writes a trace event to indicate that a synchronous event has begun. - - - The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. - - The name of event (optionally containing format specifiers) - - - - - Writes a trace event to indicate that the synchronous event has ended. - - - Tizen.Tracer.End() ends the most recently called Tizen.Tracer.Begin(). - The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. - - - - - - Writes a trace event to indicate that an asynchronous event has begun. - - - The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. - - An unique identifier for distinguishing simultaneous events - The name of event (optionally containing format specifiers) - - - - - Writes a trace event to indicate that the asynchronous event has ended. - - - Tizen.Tracer.AsyncEnd() ends matched Tizen.Tracer.AsyncBegin() which has same cookie and name. - The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. - - An unique identifier for distinguishing simultaneous events - The name of event (optionally containing format specifiers) - - - - - Writes a trace event to track change of integer value. - - - The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. - - The integer variable to trace - The name of event (optionally containing format specifiers) - - - + + + + Tizen.Tracer + + + + + Provides functions for writing trace message to the system trace buffer. + + + + + Writes a trace event to indicate that a synchronous event has begun. + + + The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. + + The name of event (optionally containing format specifiers) + + + + + Writes a trace event to indicate that the synchronous event has ended. + + + Tizen.Tracer.End() ends the most recently called Tizen.Tracer.Begin(). + The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. + + + + + + Writes a trace event to indicate that an asynchronous event has begun. + + + The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. + + An unique identifier for distinguishing simultaneous events + The name of event (optionally containing format specifiers) + + + + + Writes a trace event to indicate that the asynchronous event has ended. + + + Tizen.Tracer.AsyncEnd() ends matched Tizen.Tracer.AsyncBegin() which has same cookie and name. + The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. + + An unique identifier for distinguishing simultaneous events + The name of event (optionally containing format specifiers) + + + + + Writes a trace event to track change of integer value. + + + The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. + + The integer variable to trace + The name of event (optionally containing format specifiers) + + + diff --git a/Artifacts/bin/Tizen.Uix.InputMethod.dll b/Artifacts/bin/Tizen.Uix.InputMethod.dll index ef2e3bc..490b638 100644 Binary files a/Artifacts/bin/Tizen.Uix.InputMethod.dll and b/Artifacts/bin/Tizen.Uix.InputMethod.dll differ diff --git a/Artifacts/bin/Tizen.Uix.InputMethod.pdb b/Artifacts/bin/Tizen.Uix.InputMethod.pdb index 7ef7d8a..b3a1d57 100644 Binary files a/Artifacts/bin/Tizen.Uix.InputMethod.pdb and b/Artifacts/bin/Tizen.Uix.InputMethod.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.InputMethod.xml b/Artifacts/bin/Tizen.Uix.InputMethod.xml index 18024b5..63b5ba3 100644 --- a/Artifacts/bin/Tizen.Uix.InputMethod.xml +++ b/Artifacts/bin/Tizen.Uix.InputMethod.xml @@ -1,2343 +1,2343 @@ - - - - Tizen.Uix.InputMethod - - - - - Partial Interop Class - - - Partial Interop Class - - - Partial Interop Class - - - - - EinaList Interop Class - - - - - InputMethod Interop Class - - - - - - - - - - - Partial Libraries Class - - - - - This Class contains data related to AccessibilityStateChanged Event - - - - - Accessibility option state - - - - - This Class contains data related to CursorPositionitionUpdated Event - - - - - The cursor position - - - - - This Class contains data related to DataSet Event - - - - - The specific data to be set to the input panel - - - - - The length of data, in bytes, to send to the input panel - - - - - This Class contains data related to DisplayLanaguageChanged Event - - - - - The language code - - - - - The Editor window class - - - - - This API updates the input panel window's size information. - - - http://tizen.org/privilege/ime - - The width in portrait mode - The height in portrait mode - The width in landscape mode - The height in landscape mode - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - - - This Class contains data related to FocusedIn Event - - - - - The input context identification value of an associated text input UI control - - - - - This Class contains data related to FocusedOut Event - - - - - The input context identification value of an associated text input UI control - - - - - Enumeration for Input Panel Layout - - - - - Normal - - - - - Number - - - - - Email - - - - - URL - - - - - Phone Number - - - - - IP - - - - - Month - - - - - Number Only - - - - - Invalid - - - - - HEX - - - - - Terminal - - - - - Password - - - - - Date Time - - - - - Emoticon - - - - - Voice - - - - - Undefined - - - - - Enumeration for Layout Variation - - - - - The plain normal layout - - - - - Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"' and ':' should be disabled - - - - - The name of a person - - - - - The plain normal number layout - - - - - The number layout to allow a negative sign - - - - - The number layout to allow decimal point to provide fractional value - - - - - The number layout to allow decimal point and negative sign - - - - - The normal password layout - - - - - The password layout to allow only number - - - - - Undefined - - - - - Enumeration for AutoCapital Type - - - - - None - - - - - Word - - - - - Sentence - - - - - All Character - - - - - Undefined - - - - - Enumeration for InputPanel ReturnKey Type - - - - - Default - - - - - Done - - - - - Go - - - - - Join - - - - - Login - - - - - Next - - - - - Search - - - - - Send - - - - - SignIn - - - - - Undefined - - - - - Enumeration for InputHints - - - - - None - - - - - AutoComplete - - - - - SensitiveData - - - - - Multiline - - - - - Undefined - - - - - Enumeration for BiDi Direction - - - - - Neutral - - - - - LTR - - - - - RTL - - - - - Undefined - - - - - Enumeration for InputPanel Language - - - - - Automatic - - - - - Alphabet - - - - - Undefined - - - - - This class represents the context of InputMethodEditor - - - - - Gets the layout information. - - - - - Gets the layout variation information. - - - - - Gets the cursor position information. - - - - - Gets the autocapital type information. - - - - - Gets the Return key label type information. - - - - - Gets the Return key state information. - - - - - Gets the prediction mode information. - - - - - Gets the password mode information. - - - - - Gets the input hint information. - - - - - Gets the text bidirectional information. - - - - - Gets the preferred language information. - - - - - Enumeration for Device Class - - - - - None - - - - - Seat - - - - - Keyboard - - - - - Mouse - - - - - Touch - - - - - Pen - - - - - Pointer - - - - - Gamepad - - - - - Undefined - - - - - Enumeration for Device SubClass - - - - - None - - - - - Finger - - - - - FingerNail - - - - - Knuckle - - - - - Palm - - - - - HandSIze - - - - - HandFlat - - - - - PenTip - - - - - Trackpad - - - - - Trackpoint - - - - - Trackball - - - - - Undefined - - - - - this class gives the device information, like the name, class and subclass - - - - - Gets the device name of the key event. - - - - - Gets the device class of the key event. - - - - - Gets the device subclass of the key event. - - - - - - The backspace key - - - - - The tab key - - - - - The linefeed key - - - - - The clear key - - - - - The return key - - - - - The pause key - - - - - The scroll lock key - - - - - The sys req key - - - - - The escape key - - - - - The delete key - - - - - The home key - - - - - The left directional key - - - - - The up directional key - - - - - The right directional key - - - - - The down directional key - - - - - The prior, previous key - - - - - The page up key - - - - - The next key - - - - - The page down key - - - - - The end key - - - - - The begin key - - - - - The select key - - - - - The print key - - - - - The execute, run, do key - - - - - The insert key - - - - - The undo key - - - - - The redo key - - - - - The menu key - - - - - The find key - - - - - The cancel, stop, abort, exit key - - - - - The help key - - - - - The break key - - - - - The character set switch key - - - - - The num lock key - - - - - The Numpad space key - - - - - The Numpad tab key - - - - - The Numpad enter key - - - - - The Numpad function 1 key - - - - - The Numpad function 2 key - - - - - The Numpad function 3 key - - - - - The Numpad function 4 key - - - - - The Numpad home key - - - - - The Numpad left key - - - - - The Numpad up key - - - - - The Numpad right key - - - - - The Numpad down key - - - - - The Numpad prior, previous key - - - - - The Numpad page up key - - - - - The Numpad next key - - - - - The Numpad page down key - - - - - The Numpad end key - - - - - The Numpad begin key - - - - - The Numpad insert key - - - - - The Numpad delete key - - - - - The Numpad equal key - - - - - The Numpad multiply key - - - - - The Numpad add key - - - - - The Numpad separator key - - - - - The Numpad subtract key - - - - - The Numpad decimal key - - - - - The Numpad divide key - - - - - The Numpad 0 key - - - - - The Numpad 1 key - - - - - The Numpad 2 key - - - - - The Numpad 3 key - - - - - The Numpad 4 key - - - - - The Numpad 5 key - - - - - The Numpad 6 key - - - - - The Numpad 7 key - - - - - The Numpad 8 key - - - - - The Numpad 9 key - - - - - The function 1 key - - - - - The function 2 key - - - - - The function 3 key - - - - - The function 4 key - - - - - The function 5 key - - - - - The function 6 key - - - - - The function 7 key - - - - - The function 8 key - - - - - The function 9 key - - - - - The function 10 key - - - - - The function 11 key - - - - - The function 12 key - - - - - The function 13 key - - - - - The function 14 key - - - - - The function 15 key - - - - - The function 16 key - - - - - The function 17 key - - - - - The function 18 key - - - - - The function 19 key - - - - - The function 20 key - - - - - The function 21 key - - - - - The function 22 key - - - - - The function 23 key - - - - - The function 24 key - - - - - The function 25 key - - - - - The function 26 key - - - - - The function 27 key - - - - - The function 28 key - - - - - The function 29 key - - - - - The function 30 key - - - - - The function 31 key - - - - - The function 32 key - - - - - The function 33 key - - - - - The function 34 key - - - - - The function 35 key - - - - - The left shift key - - - - - The right shift key - - - - - The left control key - - - - - The right control key - - - - - The caps lock key - - - - - The shift lock key - - - - - The left meta key - - - - - The right meta key - - - - - The left alt key - - - - - The right alt key - - - - - The left super key - - - - - The right super key - - - - - The left hyper key - - - - - The right hyper key - - - - - The space key - - - - - The exclamation key - - - - - The quotedbl key - - - - - The number sign key - - - - - The dollar key - - - - - The percent key - - - - - The ampersand key - - - - - The apostrophe key - - - - - The parenleft key - - - - - The parenright key - - - - - The asterisk key - - - - - The plus key - - - - - The comma key - - - - - The minus key - - - - - The period key - - - - - The slash key - - - - - The 0 key - - - - - The 1 key - - - - - The 2 key - - - - - The 3 key - - - - - The 4 key - - - - - The 5 key - - - - - The 6 key - - - - - The 7 key - - - - - The 8 key - - - - - The 9 key - - - - - The colon key - - - - - The semicolon key - - - - - The less key - - - - - The equal key - - - - - The greater key - - - - - The question key - - - - - The at key - - - - - The A key - - - - - The B key - - - - - The C key - - - - - The D key - - - - - The E key - - - - - The F key - - - - - The G key - - - - - The H key - - - - - The I key - - - - - The J key - - - - - The K key - - - - - The L key - - - - - The M key - - - - - The N key - - - - - The O key - - - - - The P key - - - - - The Q key - - - - - The R key - - - - - The S key - - - - - The T key - - - - - The U key - - - - - The V key - - - - - The W key - - - - - The X key - - - - - The Y key - - - - - The Z key - - - - - The left bracket key - - - - - The backslash key - - - - - The right bracket key - - - - - The circumflex key - - - - - The underscore key - - - - - The grave key - - - - - The a key - - - - - The b key - - - - - The c key - - - - - The d key - - - - - The e key - - - - - The f key - - - - - The g key - - - - - The h key - - - - - The i key - - - - - The j key - - - - - The k key - - - - - The l key - - - - - The m key - - - - - The n key - - - - - The o key - - - - - The p key - - - - - The q key - - - - - The r key - - - - - The s key - - - - - The t key - - - - - The u key - - - - - The v key - - - - - The w key - - - - - The x key - - - - - The y key - - - - - The z key - - - - - The left brace key - - - - - The bar key - - - - - The right brace key - - - - - The tilde key - - - - - Enumeration of the key masks. - The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event. - - - - - Key press event without modifier key - - - - - The Shift key is pressed down - - - - - The CapsLock key is pressed down - - - - - The Control key is pressed down - - - - - The Alt key is pressed down - - - - - The Meta key is pressed down - - - - - The Win (between Control and Alt) is pressed down - - - - - The Hyper key is pressed down - - - - - The NumLock key is pressed down - - - - - Key release event - - - - - This class contains api's related to IME(Input method editor) - - - - - Structure representing ContextId - - - - - rectangle representing the position and size of UI Control - - - - - The x position in screen - - - - - The y position in screen - - - - - The window width - - - - - The window height - - - - - An Action with 1 out parameter - - Generic Type - The out parameter - - - - An Action with an array out parameter - - Generic Type - The out parameter 1 - - - - An Action with 3 Input Parameter returning a bool - - Generic Type for Parameter 1 - Generic Type for Parameter 2 - Generic Type for Parameter 3 - The Input Parameter 1 - The Input Parameter 2 - The Input Parameter 3 - - - - - Called when an associated text input UI control has focus. - - - - - Called when an associated text input UI control loses focus. - - - - - Called when an associated text input UI control responds to a request with the surrounding text. - - - - - Called to reset the input context of an associated text input UI control. - - - - - Called when the position of the cursor in an associated text input UI control changes. - - - - - Called to set the preferred language to the input panel. - It will be only called when the client application changes the edit field's language attribute after the input panel is shown. - - - - - Called to set the application specific data to deliver to the input panel. - - - - - Called when an associated text input UI control requests the input panel to set its layout. - It will be only called when the client application changes the edit field's layout attribute after the input panel is shown. - - - - - Called when an associated text input UI control requests the input panel to set the Return key label. - The input panel can show text or image on the Return button according to the Return key action. - - - - - Called when an associated text input UI control requests the input panel to enable or disable the Return key state. - - - - - Called when the system display language is changed. - - - - - Called when the device is rotated. - - - - - Called when Accessibility in Settings application is on or off. - - - - - Called to create the option window. - - - if Input panel requests to open the option window, type will be OptionWindowType.Keyboard. - And if Settings application requests to open it, type will be OptionWindowType.SettingApplication. - - - - - Called to destroy the option window. - - - - - Sets the languageRequested Action - - - Called when an associated text input UI control requests the language from the input panel, requesting for language code. - - - - - Sets the processKey Action - If the key event is from the external device, DeviceInfo will have its name, class and subclass information. - - - The Action is alled when the key event is received from the external devices or SendKey function. - This Event processes the key event before an associated text input UI control does. - - - - - Sets the imDataRequested Action - - - Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length. - - - - - Sets the GeometryRequested Action - - - Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values. - - - - - Runs the main loop of IME application. - This function starts to run IME application's main loop. - - - http://tizen.org/privilege/ime - - - This API is a blocking call, as it starts the main loop of the application. - - This is called to initialize IME application before the main loop starts up - This is called when IME application is terminated - - This is called when IME application is shown - It provides the Context Inofrmation and the Context Id - - - This is called when IME application is hidden - It provides the Context Id - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) Operation failed - - - - - Sends a key event to the associated text input UI control. - - - This function sends key down or up event with key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly. - And if forwardKey is false, the ProcessKey event receives the key event before the edit field. - - - http://tizen.org/privilege/ime - - The key code to be sent - The modifier key mask - The flag to send the key event directly to the edit field - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - - - Sends the text to the associated text input UI control. - - - http://tizen.org/privilege/ime - - The string to be committed - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - - - Requests to show preedit string. - - - http://tizen.org/privilege/ime - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - - - Requests to hide preedit string. - - - http://tizen.org/privilege/ime - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - - - Updates a new preedit string. - - - http://tizen.org/privilege/ime - - The string to be updated in preedit - - The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color and reversal color. - The attrs list can be empty if no attributes to set - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - 3) Invalid Parameter - - - - - Requests the surrounding text from the position of the cursor, asynchronously. - - - http://tizen.org/privilege/ime - - The maximum length of string to be retrieved before the cursor, -1 means unlimited - The maximum length of string to be retrieved after the cursor, -1 means unlimited - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - - - The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set. - - - - - Requests to delete surrounding text. - - - http://tizen.org/privilege/ime - - The offset value from the cursor position - The length of the text to delete - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - 3) Invalid Parameter - - - - - Gets the surrounding text from the position of the cursor, synchronously. - - - http://tizen.org/privilege/ime - - The maximum length of string to be retrieved before the cursor, -1 means unlimited - The maximum length of string to be retrieved after the cursor, -1 means unlimited - The surrounding text - The cursor position - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - 3) Invalid Parameter - 4) Failed to obtain text due to out of memory - - - - - Requests to set selection. - - - http://tizen.org/privilege/ime - - The start cursor position in text (in characters not bytes) - The end cursor position in text (in characters not bytes) - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - 3) Invalid Parameter - - - - - This API returns the input panel main window. - - - http://tizen.org/privilege/ime - - The input panel main window object on success, otherwise null - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) IME main loop isn't started yet - 3) Operation Failed - - - - - This API requests the InputMethodEditor to initialize - - - http://tizen.org/privilege/ime - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) Operation Failed - - - - - This API requests the InputMethodEditor to finalize - - - http://tizen.org/privilege/ime - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) Operation Failed - - - - - Requests to create an option window from the input panel. - The input panel can call this function to open the option window. This function calls OptionWindowCreated Event with OptionWindowType.Keyboard. - - - http://tizen.org/privilege/ime - - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) Operation failed - 3) IME main loop isn't started yet - 4) OptionWindowCreated event has not been set - - - OptionWindowCreated and OptionWindowDestroyed event should be set - - - - - Requests to destroy an option window. - The input panel can call this function to close the option window which is created from either the input panel or Settings application. - - - http://tizen.org/privilege/ime - - The option window to destroy - - This can occur due to the following reasons: - 1) The application does not have the privilege to call this function - 2) Invalid Parameter - 3) IME main loop isn't started yet - - - OptionWindowDestroyed Event must be set. - - - This function triggers the OptionWindowDestroyed Event if it is set. - - - - - This Class contains data related to LanguageSet Event - - - - - The preferred language that the client application wants - - - - - This Class contains data related to LayoutSet Event - - - - - The input panel layout - - - - - Option window Class - - - - - The type of option window - - - - - Enumeration of the option window type. - - - - - Open from Keyboard - - - - - Open from Setting application - - - - - This class contains information related to OptionWindowCreated event - - - - - The created window object - - - - - This class contains information related to the OptionWindowDestroyed event - - - - - The window object to destroy - - - - - Enumeration for Attribute Type - - - - - No attribute - - - - - A font style attribute, e.g., underline, etc. - - - - - This class represents the attributes for preedit string. - - - - - The start position in the string of this attribute - - - - - The character length of this attribute, the range is [Start, Start+Length] - - - - - The type of this attribute - - - - - The value of this attribute - - - - - This Class contains data related to ReturnKeyStateSet Event - - - - - The bool state to disable Return key. The Return key is enabled by default - - - - - This Class contains data related to ReturnKeySet Event - - - - - The type of Return key on the input panel - - - - - This Class contains data related to RotationChanged Event - - - - - The rotation degree - - - - - This Class contains data related to SurroundingTextUpdated Event - - - - - The input context identification value of an associated text input UI control - - - - - The cursor position - - - - - The string requested - - - - + + + + Tizen.Uix.InputMethod + + + + + Partial Interop Class + + + Partial Interop Class + + + Partial Interop Class + + + + + EinaList Interop Class + + + + + InputMethod Interop Class + + + + + + + + + + + Partial Libraries Class + + + + + This Class contains data related to AccessibilityStateChanged Event + + + + + Accessibility option state + + + + + This Class contains data related to CursorPositionitionUpdated Event + + + + + The cursor position + + + + + This Class contains data related to DataSet Event + + + + + The specific data to be set to the input panel + + + + + The length of data, in bytes, to send to the input panel + + + + + This Class contains data related to DisplayLanaguageChanged Event + + + + + The language code + + + + + The Editor window class + + + + + This API updates the input panel window's size information. + + + http://tizen.org/privilege/ime + + The width in portrait mode + The height in portrait mode + The width in landscape mode + The height in landscape mode + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + + + This Class contains data related to FocusedIn Event + + + + + The input context identification value of an associated text input UI control + + + + + This Class contains data related to FocusedOut Event + + + + + The input context identification value of an associated text input UI control + + + + + Enumeration for Input Panel Layout + + + + + Normal + + + + + Number + + + + + Email + + + + + URL + + + + + Phone Number + + + + + IP + + + + + Month + + + + + Number Only + + + + + Invalid + + + + + HEX + + + + + Terminal + + + + + Password + + + + + Date Time + + + + + Emoticon + + + + + Voice + + + + + Undefined + + + + + Enumeration for Layout Variation + + + + + The plain normal layout + + + + + Filename layout; symbols such as '/', '\*', '\', '|', '<', '>', '?', '"' and ':' should be disabled + + + + + The name of a person + + + + + The plain normal number layout + + + + + The number layout to allow a negative sign + + + + + The number layout to allow decimal point to provide fractional value + + + + + The number layout to allow decimal point and negative sign + + + + + The normal password layout + + + + + The password layout to allow only number + + + + + Undefined + + + + + Enumeration for AutoCapital Type + + + + + None + + + + + Word + + + + + Sentence + + + + + All Character + + + + + Undefined + + + + + Enumeration for InputPanel ReturnKey Type + + + + + Default + + + + + Done + + + + + Go + + + + + Join + + + + + Login + + + + + Next + + + + + Search + + + + + Send + + + + + SignIn + + + + + Undefined + + + + + Enumeration for InputHints + + + + + None + + + + + AutoComplete + + + + + SensitiveData + + + + + Multiline + + + + + Undefined + + + + + Enumeration for BiDi Direction + + + + + Neutral + + + + + LTR + + + + + RTL + + + + + Undefined + + + + + Enumeration for InputPanel Language + + + + + Automatic + + + + + Alphabet + + + + + Undefined + + + + + This class represents the context of InputMethodEditor + + + + + Gets the layout information. + + + + + Gets the layout variation information. + + + + + Gets the cursor position information. + + + + + Gets the autocapital type information. + + + + + Gets the Return key label type information. + + + + + Gets the Return key state information. + + + + + Gets the prediction mode information. + + + + + Gets the password mode information. + + + + + Gets the input hint information. + + + + + Gets the text bidirectional information. + + + + + Gets the preferred language information. + + + + + Enumeration for Device Class + + + + + None + + + + + Seat + + + + + Keyboard + + + + + Mouse + + + + + Touch + + + + + Pen + + + + + Pointer + + + + + Gamepad + + + + + Undefined + + + + + Enumeration for Device SubClass + + + + + None + + + + + Finger + + + + + FingerNail + + + + + Knuckle + + + + + Palm + + + + + HandSIze + + + + + HandFlat + + + + + PenTip + + + + + Trackpad + + + + + Trackpoint + + + + + Trackball + + + + + Undefined + + + + + this class gives the device information, like the name, class and subclass + + + + + Gets the device name of the key event. + + + + + Gets the device class of the key event. + + + + + Gets the device subclass of the key event. + + + + + + The backspace key + + + + + The tab key + + + + + The linefeed key + + + + + The clear key + + + + + The return key + + + + + The pause key + + + + + The scroll lock key + + + + + The sys req key + + + + + The escape key + + + + + The delete key + + + + + The home key + + + + + The left directional key + + + + + The up directional key + + + + + The right directional key + + + + + The down directional key + + + + + The prior, previous key + + + + + The page up key + + + + + The next key + + + + + The page down key + + + + + The end key + + + + + The begin key + + + + + The select key + + + + + The print key + + + + + The execute, run, do key + + + + + The insert key + + + + + The undo key + + + + + The redo key + + + + + The menu key + + + + + The find key + + + + + The cancel, stop, abort, exit key + + + + + The help key + + + + + The break key + + + + + The character set switch key + + + + + The num lock key + + + + + The Numpad space key + + + + + The Numpad tab key + + + + + The Numpad enter key + + + + + The Numpad function 1 key + + + + + The Numpad function 2 key + + + + + The Numpad function 3 key + + + + + The Numpad function 4 key + + + + + The Numpad home key + + + + + The Numpad left key + + + + + The Numpad up key + + + + + The Numpad right key + + + + + The Numpad down key + + + + + The Numpad prior, previous key + + + + + The Numpad page up key + + + + + The Numpad next key + + + + + The Numpad page down key + + + + + The Numpad end key + + + + + The Numpad begin key + + + + + The Numpad insert key + + + + + The Numpad delete key + + + + + The Numpad equal key + + + + + The Numpad multiply key + + + + + The Numpad add key + + + + + The Numpad separator key + + + + + The Numpad subtract key + + + + + The Numpad decimal key + + + + + The Numpad divide key + + + + + The Numpad 0 key + + + + + The Numpad 1 key + + + + + The Numpad 2 key + + + + + The Numpad 3 key + + + + + The Numpad 4 key + + + + + The Numpad 5 key + + + + + The Numpad 6 key + + + + + The Numpad 7 key + + + + + The Numpad 8 key + + + + + The Numpad 9 key + + + + + The function 1 key + + + + + The function 2 key + + + + + The function 3 key + + + + + The function 4 key + + + + + The function 5 key + + + + + The function 6 key + + + + + The function 7 key + + + + + The function 8 key + + + + + The function 9 key + + + + + The function 10 key + + + + + The function 11 key + + + + + The function 12 key + + + + + The function 13 key + + + + + The function 14 key + + + + + The function 15 key + + + + + The function 16 key + + + + + The function 17 key + + + + + The function 18 key + + + + + The function 19 key + + + + + The function 20 key + + + + + The function 21 key + + + + + The function 22 key + + + + + The function 23 key + + + + + The function 24 key + + + + + The function 25 key + + + + + The function 26 key + + + + + The function 27 key + + + + + The function 28 key + + + + + The function 29 key + + + + + The function 30 key + + + + + The function 31 key + + + + + The function 32 key + + + + + The function 33 key + + + + + The function 34 key + + + + + The function 35 key + + + + + The left shift key + + + + + The right shift key + + + + + The left control key + + + + + The right control key + + + + + The caps lock key + + + + + The shift lock key + + + + + The left meta key + + + + + The right meta key + + + + + The left alt key + + + + + The right alt key + + + + + The left super key + + + + + The right super key + + + + + The left hyper key + + + + + The right hyper key + + + + + The space key + + + + + The exclamation key + + + + + The quotedbl key + + + + + The number sign key + + + + + The dollar key + + + + + The percent key + + + + + The ampersand key + + + + + The apostrophe key + + + + + The parenleft key + + + + + The parenright key + + + + + The asterisk key + + + + + The plus key + + + + + The comma key + + + + + The minus key + + + + + The period key + + + + + The slash key + + + + + The 0 key + + + + + The 1 key + + + + + The 2 key + + + + + The 3 key + + + + + The 4 key + + + + + The 5 key + + + + + The 6 key + + + + + The 7 key + + + + + The 8 key + + + + + The 9 key + + + + + The colon key + + + + + The semicolon key + + + + + The less key + + + + + The equal key + + + + + The greater key + + + + + The question key + + + + + The at key + + + + + The A key + + + + + The B key + + + + + The C key + + + + + The D key + + + + + The E key + + + + + The F key + + + + + The G key + + + + + The H key + + + + + The I key + + + + + The J key + + + + + The K key + + + + + The L key + + + + + The M key + + + + + The N key + + + + + The O key + + + + + The P key + + + + + The Q key + + + + + The R key + + + + + The S key + + + + + The T key + + + + + The U key + + + + + The V key + + + + + The W key + + + + + The X key + + + + + The Y key + + + + + The Z key + + + + + The left bracket key + + + + + The backslash key + + + + + The right bracket key + + + + + The circumflex key + + + + + The underscore key + + + + + The grave key + + + + + The a key + + + + + The b key + + + + + The c key + + + + + The d key + + + + + The e key + + + + + The f key + + + + + The g key + + + + + The h key + + + + + The i key + + + + + The j key + + + + + The k key + + + + + The l key + + + + + The m key + + + + + The n key + + + + + The o key + + + + + The p key + + + + + The q key + + + + + The r key + + + + + The s key + + + + + The t key + + + + + The u key + + + + + The v key + + + + + The w key + + + + + The x key + + + + + The y key + + + + + The z key + + + + + The left brace key + + + + + The bar key + + + + + The right brace key + + + + + The tilde key + + + + + Enumeration of the key masks. + The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event. + + + + + Key press event without modifier key + + + + + The Shift key is pressed down + + + + + The CapsLock key is pressed down + + + + + The Control key is pressed down + + + + + The Alt key is pressed down + + + + + The Meta key is pressed down + + + + + The Win (between Control and Alt) is pressed down + + + + + The Hyper key is pressed down + + + + + The NumLock key is pressed down + + + + + Key release event + + + + + This class contains api's related to IME(Input method editor) + + + + + Structure representing ContextId + + + + + rectangle representing the position and size of UI Control + + + + + The x position in screen + + + + + The y position in screen + + + + + The window width + + + + + The window height + + + + + An Action with 1 out parameter + + Generic Type + The out parameter + + + + An Action with an array out parameter + + Generic Type + The out parameter 1 + + + + An Action with 3 Input Parameter returning a bool + + Generic Type for Parameter 1 + Generic Type for Parameter 2 + Generic Type for Parameter 3 + The Input Parameter 1 + The Input Parameter 2 + The Input Parameter 3 + + + + + Called when an associated text input UI control has focus. + + + + + Called when an associated text input UI control loses focus. + + + + + Called when an associated text input UI control responds to a request with the surrounding text. + + + + + Called to reset the input context of an associated text input UI control. + + + + + Called when the position of the cursor in an associated text input UI control changes. + + + + + Called to set the preferred language to the input panel. + It will be only called when the client application changes the edit field's language attribute after the input panel is shown. + + + + + Called to set the application specific data to deliver to the input panel. + + + + + Called when an associated text input UI control requests the input panel to set its layout. + It will be only called when the client application changes the edit field's layout attribute after the input panel is shown. + + + + + Called when an associated text input UI control requests the input panel to set the Return key label. + The input panel can show text or image on the Return button according to the Return key action. + + + + + Called when an associated text input UI control requests the input panel to enable or disable the Return key state. + + + + + Called when the system display language is changed. + + + + + Called when the device is rotated. + + + + + Called when Accessibility in Settings application is on or off. + + + + + Called to create the option window. + + + if Input panel requests to open the option window, type will be OptionWindowType.Keyboard. + And if Settings application requests to open it, type will be OptionWindowType.SettingApplication. + + + + + Called to destroy the option window. + + + + + Sets the languageRequested Action + + + Called when an associated text input UI control requests the language from the input panel, requesting for language code. + + + + + Sets the processKey Action + If the key event is from the external device, DeviceInfo will have its name, class and subclass information. + + + The Action is alled when the key event is received from the external devices or SendKey function. + This Event processes the key event before an associated text input UI control does. + + + + + Sets the imDataRequested Action + + + Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length. + + + + + Sets the GeometryRequested Action + + + Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values. + + + + + Runs the main loop of IME application. + This function starts to run IME application's main loop. + + + http://tizen.org/privilege/ime + + + This API is a blocking call, as it starts the main loop of the application. + + This is called to initialize IME application before the main loop starts up + This is called when IME application is terminated + + This is called when IME application is shown + It provides the Context Inofrmation and the Context Id + + + This is called when IME application is hidden + It provides the Context Id + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) Operation failed + + + + + Sends a key event to the associated text input UI control. + + + This function sends key down or up event with key mask to the client application. If forwardKey is true, this key event goes to the edit filed directly. + And if forwardKey is false, the ProcessKey event receives the key event before the edit field. + + + http://tizen.org/privilege/ime + + The key code to be sent + The modifier key mask + The flag to send the key event directly to the edit field + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + + + Sends the text to the associated text input UI control. + + + http://tizen.org/privilege/ime + + The string to be committed + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + + + Requests to show preedit string. + + + http://tizen.org/privilege/ime + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + + + Requests to hide preedit string. + + + http://tizen.org/privilege/ime + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + + + Updates a new preedit string. + + + http://tizen.org/privilege/ime + + The string to be updated in preedit + + The list which has ime_preedit_attribute lists, strings can be composed of multiple string attributes: underline, highlight color and reversal color. + The attrs list can be empty if no attributes to set + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + 3) Invalid Parameter + + + + + Requests the surrounding text from the position of the cursor, asynchronously. + + + http://tizen.org/privilege/ime + + The maximum length of string to be retrieved before the cursor, -1 means unlimited + The maximum length of string to be retrieved after the cursor, -1 means unlimited + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + + + The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set. + + + + + Requests to delete surrounding text. + + + http://tizen.org/privilege/ime + + The offset value from the cursor position + The length of the text to delete + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + 3) Invalid Parameter + + + + + Gets the surrounding text from the position of the cursor, synchronously. + + + http://tizen.org/privilege/ime + + The maximum length of string to be retrieved before the cursor, -1 means unlimited + The maximum length of string to be retrieved after the cursor, -1 means unlimited + The surrounding text + The cursor position + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + 3) Invalid Parameter + 4) Failed to obtain text due to out of memory + + + + + Requests to set selection. + + + http://tizen.org/privilege/ime + + The start cursor position in text (in characters not bytes) + The end cursor position in text (in characters not bytes) + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + 3) Invalid Parameter + + + + + This API returns the input panel main window. + + + http://tizen.org/privilege/ime + + The input panel main window object on success, otherwise null + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) IME main loop isn't started yet + 3) Operation Failed + + + + + This API requests the InputMethodEditor to initialize + + + http://tizen.org/privilege/ime + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) Operation Failed + + + + + This API requests the InputMethodEditor to finalize + + + http://tizen.org/privilege/ime + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) Operation Failed + + + + + Requests to create an option window from the input panel. + The input panel can call this function to open the option window. This function calls OptionWindowCreated Event with OptionWindowType.Keyboard. + + + http://tizen.org/privilege/ime + + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) Operation failed + 3) IME main loop isn't started yet + 4) OptionWindowCreated event has not been set + + + OptionWindowCreated and OptionWindowDestroyed event should be set + + + + + Requests to destroy an option window. + The input panel can call this function to close the option window which is created from either the input panel or Settings application. + + + http://tizen.org/privilege/ime + + The option window to destroy + + This can occur due to the following reasons: + 1) The application does not have the privilege to call this function + 2) Invalid Parameter + 3) IME main loop isn't started yet + + + OptionWindowDestroyed Event must be set. + + + This function triggers the OptionWindowDestroyed Event if it is set. + + + + + This Class contains data related to LanguageSet Event + + + + + The preferred language that the client application wants + + + + + This Class contains data related to LayoutSet Event + + + + + The input panel layout + + + + + Option window Class + + + + + The type of option window + + + + + Enumeration of the option window type. + + + + + Open from Keyboard + + + + + Open from Setting application + + + + + This class contains information related to OptionWindowCreated event + + + + + The created window object + + + + + This class contains information related to the OptionWindowDestroyed event + + + + + The window object to destroy + + + + + Enumeration for Attribute Type + + + + + No attribute + + + + + A font style attribute, e.g., underline, etc. + + + + + This class represents the attributes for preedit string. + + + + + The start position in the string of this attribute + + + + + The character length of this attribute, the range is [Start, Start+Length] + + + + + The type of this attribute + + + + + The value of this attribute + + + + + This Class contains data related to ReturnKeyStateSet Event + + + + + The bool state to disable Return key. The Return key is enabled by default + + + + + This Class contains data related to ReturnKeySet Event + + + + + The type of Return key on the input panel + + + + + This Class contains data related to RotationChanged Event + + + + + The rotation degree + + + + + This Class contains data related to SurroundingTextUpdated Event + + + + + The input context identification value of an associated text input UI control + + + + + The cursor position + + + + + The string requested + + + + diff --git a/Artifacts/bin/Tizen.Uix.InputMethodManager.dll b/Artifacts/bin/Tizen.Uix.InputMethodManager.dll index 7ee50e6..bc1aac3 100644 Binary files a/Artifacts/bin/Tizen.Uix.InputMethodManager.dll and b/Artifacts/bin/Tizen.Uix.InputMethodManager.dll differ diff --git a/Artifacts/bin/Tizen.Uix.InputMethodManager.pdb b/Artifacts/bin/Tizen.Uix.InputMethodManager.pdb index 01bae81..09a42d6 100644 Binary files a/Artifacts/bin/Tizen.Uix.InputMethodManager.pdb and b/Artifacts/bin/Tizen.Uix.InputMethodManager.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.InputMethodManager.xml b/Artifacts/bin/Tizen.Uix.InputMethodManager.xml index d5ecaac..cc77cad 100644 --- a/Artifacts/bin/Tizen.Uix.InputMethodManager.xml +++ b/Artifacts/bin/Tizen.Uix.InputMethodManager.xml @@ -1,116 +1,116 @@ - - - - Tizen.Uix.InputMethodManager - - - - - Partial interop class. - - - Partial interop class. - - - - - InputMethodManager interop class. - - - - - - - - Partial libraries class. - - - - - This class provides the function for launching the input method editor (IME) list and selector settings. A user can manage the installed IMEs in the system. - The input method editor (IME) is an input panel that lets users provide an input and the platform to receive the text data entered. - The manager is a module for managing the installed IMEs. - IME developers can use this module to open the installed IME list or the selector menu after their IME installation, and then guide to select the installed IME. - - - - - Requests to open the installed IME list menu. - This API provides the installed IME list menu for IME developers who might want to open it to enable their IME. - - - http://tizen.org/privilege/imemanager - - - This exception can occur if: - 1) The application does not have the privilege to call this function. - 2) Operation failed. - - - - - Requests to open the IME selector menu. - This API provides the IME selector menu for the IME or other application developers who might want to change the default IME. - - - http://tizen.org/privilege/imemanager - - - This exception can occur if: - 1) The application does not have the privilege to call this function. - 2) Operation failed. - - - - - Checks if the specific IME is enabled or disabled in the system keyboard setting. - The IME developers can use this property to check if their IME is enabled or not. - - - http://tizen.org/privilege/imemanager - - The application ID of the IME. - The On (enabled) and Off (disabled) state of the IME. - - This exception can occur if an invalid parameter is provided. - - - This exception can occur if: - 1) The application does not have the privilege to call this function. - 2) Operation failed. - - - - - Checks which IME is the current activated (selected) IME. - - - http://tizen.org/privilege/imemanager - - - The current activated (selected) IME. - - - This exception can occur if: - 1) The application does not have the privilege to call this function. - 2) Operation failed. - - - - - Gets the number of IMEs that are enabled (usable). - - - http://tizen.org/privilege/imemanager - - - The number of enabled IMEs. - - - This exception can occur if: - 1) The application does not have the privilege to call this function. - 2) Operation failed. - - - - + + + + Tizen.Uix.InputMethodManager + + + + + Partial interop class. + + + Partial interop class. + + + + + InputMethodManager interop class. + + + + + + + + Partial libraries class. + + + + + This class provides the function for launching the input method editor (IME) list and selector settings. A user can manage the installed IMEs in the system. + The input method editor (IME) is an input panel that lets users provide an input and the platform to receive the text data entered. + The manager is a module for managing the installed IMEs. + IME developers can use this module to open the installed IME list or the selector menu after their IME installation, and then guide to select the installed IME. + + + + + Requests to open the installed IME list menu. + This API provides the installed IME list menu for IME developers who might want to open it to enable their IME. + + + http://tizen.org/privilege/imemanager + + + This exception can occur if: + 1) The application does not have the privilege to call this function. + 2) Operation failed. + + + + + Requests to open the IME selector menu. + This API provides the IME selector menu for the IME or other application developers who might want to change the default IME. + + + http://tizen.org/privilege/imemanager + + + This exception can occur if: + 1) The application does not have the privilege to call this function. + 2) Operation failed. + + + + + Checks if the specific IME is enabled or disabled in the system keyboard setting. + The IME developers can use this property to check if their IME is enabled or not. + + + http://tizen.org/privilege/imemanager + + The application ID of the IME. + The On (enabled) and Off (disabled) state of the IME. + + This exception can occur if an invalid parameter is provided. + + + This exception can occur if: + 1) The application does not have the privilege to call this function. + 2) Operation failed. + + + + + Checks which IME is the current activated (selected) IME. + + + http://tizen.org/privilege/imemanager + + + The current activated (selected) IME. + + + This exception can occur if: + 1) The application does not have the privilege to call this function. + 2) Operation failed. + + + + + Gets the number of IMEs that are enabled (usable). + + + http://tizen.org/privilege/imemanager + + + The number of enabled IMEs. + + + This exception can occur if: + 1) The application does not have the privilege to call this function. + 2) Operation failed. + + + + diff --git a/Artifacts/bin/Tizen.Uix.Stt.dll b/Artifacts/bin/Tizen.Uix.Stt.dll index cf3eb1c..4d89bd2 100644 Binary files a/Artifacts/bin/Tizen.Uix.Stt.dll and b/Artifacts/bin/Tizen.Uix.Stt.dll differ diff --git a/Artifacts/bin/Tizen.Uix.Stt.pdb b/Artifacts/bin/Tizen.Uix.Stt.pdb index 71d181b..0e0259c 100644 Binary files a/Artifacts/bin/Tizen.Uix.Stt.pdb and b/Artifacts/bin/Tizen.Uix.Stt.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.Stt.xml b/Artifacts/bin/Tizen.Uix.Stt.xml index 59ffa64..ef808cd 100644 --- a/Artifacts/bin/Tizen.Uix.Stt.xml +++ b/Artifacts/bin/Tizen.Uix.Stt.xml @@ -1,1126 +1,1126 @@ - - - - Tizen.Uix.Stt - - - - - Partial interop class. - - - Partial interop class. - - - - - Partial libraries class. - - - - - Stt interop class. - - - - - - - - - - - - - - - - - - - - - - - - This class holds information about the DefaultLanguageChanged event. - - 3 - - - - The previous language. - - 3 - - - - The current language. - - 3 - - - - This class holds information related to the EngineChanged event. - - 3 - - - - The Engine ID. - - 3 - - - - The default language. - - 3 - - - - The necessity of the credential. - - 3 - - - - Whether silence detection is supported or not. - - 3 - - - - This class holds information related to the STT ErrorOccurred event. - - 3 - - - - The error value. - - 3 - - - - Gets the current error message. - - 3 - - String error message. - - - - - The recognition result from the engine. - - 3 - - - - The result event. - - 3 - - - - The result text. - - 3 - - - - Returns the result text count. - - 3 - - - - The engine message. - - 3 - - - - This class represents the result of recognition result from the engine. - - 3 - - - - The result index. - - 3 - - - - The token event. - - 3 - - - - The result text. - - 3 - - - - The start time of result text. - - 3 - - - - The end time of result text. - - 3 - - - - This class holds information related to the STT StateChanged event. - - 3 - - - - The previous state. - - 3 - - - - The current state. - - 3 - - - - The token event. - - 3 - - - - Event when the recognition for full or last result is ready. - - 3 - - - - Event when the recognition for partial result is ready. - - 3 - - - - Event when the recognition has failed. - - 3 - - - - Enumeration for representing the result message. - - 3 - - - - No Error. - - 3 - - - - Recognition failed because the speech started too soon. - - 3 - - - - Recognition failed because the speech is too short. - - 3 - - - - Recognition failed because the speech is too long. - - 3 - - - - Recognition failed because the speech is too quiet to listen. - - 3 - - - - Recognition failed because the speech is too loud to listen. - - 3 - - - - Recognition failed because the speech is too fast to listen. - - 3 - - - - Enumeration for the token types. - - 3 - - - - Event when the token is beginning type. - - 3 - - - - Event when the token is middle type. - - 3 - - - - Event when the token is end type. - - 3 - - - - Enumeration for the error values that can occur. - - 3 - - - - Successful, No error. - - 3 - - - - Out of Memory. - - 3 . - - - - I/O error. - - 3 . - - - - Invalid parameter. - - 3 - - - - No answer from the STT service. - - 3 - - - - Device or resource busy. - - 3 - - - - Network is down. - - 3 - - - - Permission denied. - - 3 - - - - STT NOT supported. - - 3 - - - - Invalid state. - - 3 - - - - Invalid language. - - 3 - - - - No available engine. - - 3 - - - - Operation failed. - - 3 - - - - Not supported feature of current engine. - - 3 - - - - Recording timed out. - - 3 - - - - No speech while recording. - - 3 - - - - Progress to ready is not finished. - - 3 - - - - Progress to recording is not finished. - - 3 - - - - Progress to processing is not finished. - - 3 - - - - Service reset. - - 3 - - - - Enumeration for the recognition types. - - 3 - - - - Free form dictation. - - 3 - - - - Continuous free dictation. - - 3 - - - - Search. - - 3 - - - - Web search. - - 3 - - - - Map. - - 3 - - - - Enumeration for the state types. - - 3 - - - - Created state. - - 3 - - - - Ready state. - - 3 - - - - Recording state. - - 3 - - - - Processing state. - - 3 - - - - Unavailable. - - 3 - - - - Enumeration for the silence detection types. - - 3 - - - - Silence detection type - False. - - 3 - - - - Silence detection type - True. - - 3 - - - - Silence detection type - Auto. - - 3 - - - - A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users. - After choosing a language, the applications will start recording and recognizing. - After recording, the applications will receive the recognized result. - The STT has a client-server for the service of multi-applications. - The STT service always works in the background as a server. If the service is not working, client library will invoke it and the client will communicate with it. - The service has engines and a recorder, so that the client does not have the recorder itself. Only the client request commands to the STT service for using STT. - - 3 - - - - Constructor to create a STT instance. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to operation failed. - This exception can be due to out of memory. - This exception can be due to STT not supported. - This exception can be due to permission denied. - - - - Event to be invoked when the recognition is done. - - 3 - - - - Event to be invoked when the STT state changes. - - 3 - - - - Event to be invoked when an error occurs. - - 3 - - - - Event to be invoked when the default language changes. - - 3 - - - - Event to be invoked to detect the engine change. - - 3 - - - - Gets the default language set by the user. - The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English. - - 3 - - Default language in STT. - - - http://tizen.org/privilege/recorder - - - Default Language string value. - - - - - Gets the microphone volume during recording. - - 3 - - Recording volume in STT. - - - http://tizen.org/privilege/recorder - - 
-            The state must be recording.
-
- - - - Gets the current STT state. - - 3 - - Current state of STT. - - - http://tizen.org/privilege/recorder - - - Current STT state value. - - - - - This property can be used to get and set the current engine id. - - 3 - - Current STT engine id. - - - http://tizen.org/privilege/recorder - - - This exceptioncan occur while setting due to the following reasons: - 1. Operation Failed - 2. Invalid State - - This exception can be due to out of memory. - This exception can be due to STT not supported. - This exception can be due to permission denied. - This can happen if improper EngineId is provided while setting the value. - 
-            The state must be created.
-
- - - - Retrieves the time stamp of the current recognition result. - - 3 - - List of ResultTime. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This function should only be called in the RecognitionResult event. - - This exception can be due to operation failed. - This exception can be due to STT not supported. - This exception can be due to permission denied. - - - - Gets the private data from the STT engine. - - 3 - - The key string. - - - The data corresponding to the key is provided. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to invalid state. - This exception can be due to STT not supported. - This exception can be due to No Answer from STT Service. - 
-            The state must be ready.
-
- - - - Sets the private data to the STT engine. - - 3 - - The key string. - - - The data string. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to invalid state. - This exception can be due to STT not supported. - This exception can be due to No Answer from STT Service. - This can happen if Improper value is provided while setting the value. - 
-            The state must be ready.
-
- - - - Gets the list of supported engines. - - 3 - - IEnumerable<SupportedEngine> list of supported engines. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to operation failed. - This exception can be due to out of memory. - This exception can be due to STT not supported. - This exception can be due to permission denied. - - - - Sets the application credential. - - 3 - - The credential string. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exceptioncan be due to the following reasons: - 1. Operation Failed - 2. Invalid State - - This exception can be due to out of memory. - This exception can be due to STT not supported. - This exception can be due to permission denied. - This can happen if Improper value is provided while setting the value. - 
-            The state must be created.
-
- - - - Connects to the STT service asynchronously. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to invalid state. - This exception can be due to STT not supported. - This exception can be due to permission denied. - 
-            The state must be created.
-
- - If this function is successful, the STT state will be ready. - If this function is unsuccessful, ErrorOccurred event will be invoked. - - - - - Disconnects from the STT service. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - This exception can be due to invalid state. - This exception can be due to STT not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - If this function is successful, the STT state will be Created. - - - - - Retrieves all the supported languages of the current engine. - The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English. - - 3 - - http://tizen.org/privilege/recorder - - - List of strings for supported languages. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Engine Not Found. - 2. Operation Failed. - - This exception can be due to STT not supported. - This exception can be due to permission denied. - - - - Checks whether the recognition type is supported. - - 3 - - http://tizen.org/privilege/recorder - - - RecognitionType value. - - - Bool value indicating whether the recognition type is supported. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Engine Not Found - 3. Operation Failed - - This exception can be due to STT not supported. - 
-            The state should be ready.
-
- - - - Sets the silence detection. - - 3 - - http://tizen.org/privilege/recorder - - - SilenceDetection value. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Not supported feature of current engine - 3. Operation Failed - - This exception can be due to STT not supported. - 
-            The state should be ready.
-
- - - - Sets the sound to start recording. - Sound file type should be .wav type. - - 3 - - http://tizen.org/privilege/recorder - - - File path for the sound. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - - This exception can be due to STT not supported. - This exception can be due to permission denied. - If an Invalid Parameter is provided. - 
-            The state should be ready.
-
- - - - Unsets the sound to start recording. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - - This exception can be due to STT not supported. - This exception can be due to permission denied. - 
-            The state should be ready.
-
- - - - Sets the sound to stop recording. - Sound file type should be .wav type. - - 3 - - http://tizen.org/privilege/recorder - - - File Path for the sound. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - - This exception can be due to STT not supported. - This exception can be due to permission denied. - This exception can be due to Invalid Parameter. - 
-            The state should be ready.
-
- - - - Unsets the sound to stop recording. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - - This exception can be due to STT not supported. - his exception can be due to permission denied. - 
-            The state should be ready.
-
- - - - Starts the recording and recognition asynchronously. - This function starts recording in the STT service and sends the recording data to the engine. - This work continues until stop, cancel, or silence is detected by engine. - - 3 - - http://tizen.org/privilege/recorder - - - The language selected. - - - The type for recognition. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - 3. Recorder Busy - 4. Progress to recording is not finished - - This exception can be due to STT not supported. - This exception can be due to permission denied. - This exception can be due to an invalid language. - 
-            The state should be ready.
-
- - It will invoke the StateChanged event, if registered. - If this function succeeds, the STT state will be recording. - If you call this function again before the state changes, you will receive ErrorINProgressToRecording. - - - - - Finishes the recording and starts recognition processing in the engine asynchronously. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - 3. Progress to ready is not finished - 4. Progress to recording is not finished - 5. Progress to processing is not finished - - This exception can be due to STT not supported. - This exception can be due to permission denied. - 
-            The state should be Recording.
-
- - It will invoke the StateChanged Event, if registered. - If this function succeeds, the STT state will be processing. - If you call this function again before the state changes, you will receive ErrorINProgressToProcessing. - After processing of engine, the RecognitionResult event is invoked. - - - - - Cancels processing the recognition and recording asynchronously. - This function cancels recording and the engine cancels recognition processing. - After successful cancellation, the StateChanged event is invoked, otherwise if an error is occurs, the ErrorOccurred event is invoked. - - 3 - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failed - 3. Progress to ready is not finished - 4. Progress to recording is not finished - 5. Progress to processing is not finished - - This exception can be due to STT not supported. - This exception can be due to permission denied. - 
-            The state should be Recording or Processing.
-
- - It will invoke the StateChanged event, if registered. - If this function succeeds, the STT state will be ready. - If you call this function again before the state changes, you will receive ErrorINProgressToReady. - - - - - A method to release resources. - - - - - This class provides the information related to STT engine. - - 3 - - - - The engine ID. - - 3 - - The string engine ID. - - - - - The engine name. - - 3 - - The string engine name. - - - - + + + + Tizen.Uix.Stt + + + + + Partial interop class. + + + Partial interop class. + + + + + Partial libraries class. + + + + + Stt interop class. + + + + + + + + + + + + + + + + + + + + + + + + This class holds information about the DefaultLanguageChanged event. + + 3 + + + + The previous language. + + 3 + + + + The current language. + + 3 + + + + This class holds information related to the EngineChanged event. + + 3 + + + + The Engine ID. + + 3 + + + + The default language. + + 3 + + + + The necessity of the credential. + + 3 + + + + Whether silence detection is supported or not. + + 3 + + + + This class holds information related to the STT ErrorOccurred event. + + 3 + + + + The error value. + + 3 + + + + Gets the current error message. + + 3 + + String error message. + + + + + The recognition result from the engine. + + 3 + + + + The result event. + + 3 + + + + The result text. + + 3 + + + + Returns the result text count. + + 3 + + + + The engine message. + + 3 + + + + This class represents the result of recognition result from the engine. + + 3 + + + + The result index. + + 3 + + + + The token event. + + 3 + + + + The result text. + + 3 + + + + The start time of result text. + + 3 + + + + The end time of result text. + + 3 + + + + This class holds information related to the STT StateChanged event. + + 3 + + + + The previous state. + + 3 + + + + The current state. + + 3 + + + + The token event. + + 3 + + + + Event when the recognition for full or last result is ready. + + 3 + + + + Event when the recognition for partial result is ready. + + 3 + + + + Event when the recognition has failed. + + 3 + + + + Enumeration for representing the result message. + + 3 + + + + No Error. + + 3 + + + + Recognition failed because the speech started too soon. + + 3 + + + + Recognition failed because the speech is too short. + + 3 + + + + Recognition failed because the speech is too long. + + 3 + + + + Recognition failed because the speech is too quiet to listen. + + 3 + + + + Recognition failed because the speech is too loud to listen. + + 3 + + + + Recognition failed because the speech is too fast to listen. + + 3 + + + + Enumeration for the token types. + + 3 + + + + Event when the token is beginning type. + + 3 + + + + Event when the token is middle type. + + 3 + + + + Event when the token is end type. + + 3 + + + + Enumeration for the error values that can occur. + + 3 + + + + Successful, No error. + + 3 + + + + Out of Memory. + + 3 . + + + + I/O error. + + 3 . + + + + Invalid parameter. + + 3 + + + + No answer from the STT service. + + 3 + + + + Device or resource busy. + + 3 + + + + Network is down. + + 3 + + + + Permission denied. + + 3 + + + + STT NOT supported. + + 3 + + + + Invalid state. + + 3 + + + + Invalid language. + + 3 + + + + No available engine. + + 3 + + + + Operation failed. + + 3 + + + + Not supported feature of current engine. + + 3 + + + + Recording timed out. + + 3 + + + + No speech while recording. + + 3 + + + + Progress to ready is not finished. + + 3 + + + + Progress to recording is not finished. + + 3 + + + + Progress to processing is not finished. + + 3 + + + + Service reset. + + 3 + + + + Enumeration for the recognition types. + + 3 + + + + Free form dictation. + + 3 + + + + Continuous free dictation. + + 3 + + + + Search. + + 3 + + + + Web search. + + 3 + + + + Map. + + 3 + + + + Enumeration for the state types. + + 3 + + + + Created state. + + 3 + + + + Ready state. + + 3 + + + + Recording state. + + 3 + + + + Processing state. + + 3 + + + + Unavailable. + + 3 + + + + Enumeration for the silence detection types. + + 3 + + + + Silence detection type - False. + + 3 + + + + Silence detection type - True. + + 3 + + + + Silence detection type - Auto. + + 3 + + + + A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users. + After choosing a language, the applications will start recording and recognizing. + After recording, the applications will receive the recognized result. + The STT has a client-server for the service of multi-applications. + The STT service always works in the background as a server. If the service is not working, client library will invoke it and the client will communicate with it. + The service has engines and a recorder, so that the client does not have the recorder itself. Only the client request commands to the STT service for using STT. + + 3 + + + + Constructor to create a STT instance. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to operation failed. + This exception can be due to out of memory. + This exception can be due to STT not supported. + This exception can be due to permission denied. + + + + Event to be invoked when the recognition is done. + + 3 + + + + Event to be invoked when the STT state changes. + + 3 + + + + Event to be invoked when an error occurs. + + 3 + + + + Event to be invoked when the default language changes. + + 3 + + + + Event to be invoked to detect the engine change. + + 3 + + + + Gets the default language set by the user. + The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English. + + 3 + + Default language in STT. + + + http://tizen.org/privilege/recorder + + + Default Language string value. + + + + + Gets the microphone volume during recording. + + 3 + + Recording volume in STT. + + + http://tizen.org/privilege/recorder + + 
+            The state must be recording.
+
+ + + + Gets the current STT state. + + 3 + + Current state of STT. + + + http://tizen.org/privilege/recorder + + + Current STT state value. + + + + + This property can be used to get and set the current engine id. + + 3 + + Current STT engine id. + + + http://tizen.org/privilege/recorder + + + This exceptioncan occur while setting due to the following reasons: + 1. Operation Failed + 2. Invalid State + + This exception can be due to out of memory. + This exception can be due to STT not supported. + This exception can be due to permission denied. + This can happen if improper EngineId is provided while setting the value. + 
+            The state must be created.
+
+ + + + Retrieves the time stamp of the current recognition result. + + 3 + + List of ResultTime. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This function should only be called in the RecognitionResult event. + + This exception can be due to operation failed. + This exception can be due to STT not supported. + This exception can be due to permission denied. + + + + Gets the private data from the STT engine. + + 3 + + The key string. + + + The data corresponding to the key is provided. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to invalid state. + This exception can be due to STT not supported. + This exception can be due to No Answer from STT Service. + 
+            The state must be ready.
+
+ + + + Sets the private data to the STT engine. + + 3 + + The key string. + + + The data string. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to invalid state. + This exception can be due to STT not supported. + This exception can be due to No Answer from STT Service. + This can happen if Improper value is provided while setting the value. + 
+            The state must be ready.
+
+ + + + Gets the list of supported engines. + + 3 + + IEnumerable<SupportedEngine> list of supported engines. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to operation failed. + This exception can be due to out of memory. + This exception can be due to STT not supported. + This exception can be due to permission denied. + + + + Sets the application credential. + + 3 + + The credential string. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exceptioncan be due to the following reasons: + 1. Operation Failed + 2. Invalid State + + This exception can be due to out of memory. + This exception can be due to STT not supported. + This exception can be due to permission denied. + This can happen if Improper value is provided while setting the value. + 
+            The state must be created.
+
+ + + + Connects to the STT service asynchronously. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to invalid state. + This exception can be due to STT not supported. + This exception can be due to permission denied. + 
+            The state must be created.
+
+ + If this function is successful, the STT state will be ready. + If this function is unsuccessful, ErrorOccurred event will be invoked. + + + + + Disconnects from the STT service. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + This exception can be due to invalid state. + This exception can be due to STT not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + If this function is successful, the STT state will be Created. + + + + + Retrieves all the supported languages of the current engine. + The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English. + + 3 + + http://tizen.org/privilege/recorder + + + List of strings for supported languages. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Engine Not Found. + 2. Operation Failed. + + This exception can be due to STT not supported. + This exception can be due to permission denied. + + + + Checks whether the recognition type is supported. + + 3 + + http://tizen.org/privilege/recorder + + + RecognitionType value. + + + Bool value indicating whether the recognition type is supported. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Engine Not Found + 3. Operation Failed + + This exception can be due to STT not supported. + 
+            The state should be ready.
+
+ + + + Sets the silence detection. + + 3 + + http://tizen.org/privilege/recorder + + + SilenceDetection value. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Not supported feature of current engine + 3. Operation Failed + + This exception can be due to STT not supported. + 
+            The state should be ready.
+
+ + + + Sets the sound to start recording. + Sound file type should be .wav type. + + 3 + + http://tizen.org/privilege/recorder + + + File path for the sound. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + + This exception can be due to STT not supported. + This exception can be due to permission denied. + If an Invalid Parameter is provided. + 
+            The state should be ready.
+
+ + + + Unsets the sound to start recording. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + + This exception can be due to STT not supported. + This exception can be due to permission denied. + 
+            The state should be ready.
+
+ + + + Sets the sound to stop recording. + Sound file type should be .wav type. + + 3 + + http://tizen.org/privilege/recorder + + + File Path for the sound. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + + This exception can be due to STT not supported. + This exception can be due to permission denied. + This exception can be due to Invalid Parameter. + 
+            The state should be ready.
+
+ + + + Unsets the sound to stop recording. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + + This exception can be due to STT not supported. + his exception can be due to permission denied. + 
+            The state should be ready.
+
+ + + + Starts the recording and recognition asynchronously. + This function starts recording in the STT service and sends the recording data to the engine. + This work continues until stop, cancel, or silence is detected by engine. + + 3 + + http://tizen.org/privilege/recorder + + + The language selected. + + + The type for recognition. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + 3. Recorder Busy + 4. Progress to recording is not finished + + This exception can be due to STT not supported. + This exception can be due to permission denied. + This exception can be due to an invalid language. + 
+            The state should be ready.
+
+ + It will invoke the StateChanged event, if registered. + If this function succeeds, the STT state will be recording. + If you call this function again before the state changes, you will receive ErrorINProgressToRecording. + + + + + Finishes the recording and starts recognition processing in the engine asynchronously. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + 3. Progress to ready is not finished + 4. Progress to recording is not finished + 5. Progress to processing is not finished + + This exception can be due to STT not supported. + This exception can be due to permission denied. + 
+            The state should be Recording.
+
+ + It will invoke the StateChanged Event, if registered. + If this function succeeds, the STT state will be processing. + If you call this function again before the state changes, you will receive ErrorINProgressToProcessing. + After processing of engine, the RecognitionResult event is invoked. + + + + + Cancels processing the recognition and recording asynchronously. + This function cancels recording and the engine cancels recognition processing. + After successful cancellation, the StateChanged event is invoked, otherwise if an error is occurs, the ErrorOccurred event is invoked. + + 3 + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failed + 3. Progress to ready is not finished + 4. Progress to recording is not finished + 5. Progress to processing is not finished + + This exception can be due to STT not supported. + This exception can be due to permission denied. + 
+            The state should be Recording or Processing.
+
+ + It will invoke the StateChanged event, if registered. + If this function succeeds, the STT state will be ready. + If you call this function again before the state changes, you will receive ErrorINProgressToReady. + + + + + A method to release resources. + + + + + This class provides the information related to STT engine. + + 3 + + + + The engine ID. + + 3 + + The string engine ID. + + + + + The engine name. + + 3 + + The string engine name. + + + + diff --git a/Artifacts/bin/Tizen.Uix.SttEngine.dll b/Artifacts/bin/Tizen.Uix.SttEngine.dll index 3c589bb..25b3587 100644 Binary files a/Artifacts/bin/Tizen.Uix.SttEngine.dll and b/Artifacts/bin/Tizen.Uix.SttEngine.dll differ diff --git a/Artifacts/bin/Tizen.Uix.SttEngine.pdb b/Artifacts/bin/Tizen.Uix.SttEngine.pdb index e41fbee..5f5c79d 100644 Binary files a/Artifacts/bin/Tizen.Uix.SttEngine.pdb and b/Artifacts/bin/Tizen.Uix.SttEngine.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.SttEngine.xml b/Artifacts/bin/Tizen.Uix.SttEngine.xml index ab5d74e..baa2550 100644 --- a/Artifacts/bin/Tizen.Uix.SttEngine.xml +++ b/Artifacts/bin/Tizen.Uix.SttEngine.xml @@ -1,661 +1,661 @@ - - - - Tizen.Uix.SttEngine - - - - - Partial Interop Class - - - Partial Interop Class - - - - - Partial Libraries Class - - - - - SttEngine Interop Class - - - - - - - - - - - - - - - - Enumeration for audio type. - - - - - Signed 16bit audio type, Little endian - - - - - Unsigned 8bit audio type - - - - - Enumeration for result. - - - - - Event when either the full matched or the final result is delivered - - - - - Event when the partial matched result is delivered - - - - - Event when the recognition has failed - - - - - Enumeration for result time. - - - - - Event when the token is beginning type - - - - - Event when the token is middle type - - - - - Event when the token is end type - - - - - Enumeration for speech status. - - - - - Beginning point of speech is detected - - - - - End point of speech is detected - - - - - Enumeration representing the result message - - - - - No Error - - - - - Recognition failed because the speech started too soon. - - - - - Recognition failed because the speech is too short. - - - - - Recognition failed because the speech is too long. - - - - - Recognition failed because the speech is too quiet to listen. - - - - - Recognition failed because the speech is too loud to listen. - - - - - Recognition failed because the speech is too fast to listen. - - - - - Enum for Error values that can occur - - - - - Successful, No error - - - - - Out of Memory - - - - - I/O error - - - - - Invalid parameter - - - - - Network down(Out of network) - - - - - Invalid state - - - - - Invalid language - - - - - Operation failed - - - - - Not supported feature of current engine - - - - - NOT supported - - - - - Permission denied - - - - - Recording timed out - - - - - This Class represents the Stt Engine which has to be inherited to make the engine. - - - - - An Action with 2 Input Parameter returning a Error - - Generic Type for Parameter 1 - The Input Parameter 1 - The Input Parameter 2 - Error Value - - - - An Action with 2 Out Parameter returning a Error - - Generic Type for Parameter 1 - The Input Parameter 1 - The Input Parameter 2 - Error Value - - - - Called when Stt engine provides the time stamp of result to the engine service user. - This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. - - The result index - The token event - The result text - The time started speaking the result text - The time finished speaking the result text - The User data - true to continue with the next iteration of the loop, false to break out of the loop - SendResult() should be called. - - - - Called when Stt engine informs the engine service user about whole supported language list. - This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. - - The language is specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code - for example, "ko_KR" for Korean, "en_US" for American English - The User data - true to continue with the next iteration of the loop, false to break out of the loop - ForEachSupportedLanguages() should be called - - - - Called when the engine service user requests the basic information of Stt engine. - - - In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user. - - UUID of engine - Name of engine - The engine setting application(ui app)'s app ID - A variable for checking whether the network is used or not - - Following Error Codes can be returned - 1. None - 2. OperationFailed - 3. InvalidParameter - - - - - Called when the engine service user initializes Stt engine. - This callback function is called by the engine service user to request for Stt engine to be started. - - - Following Error Codes can be returned - 1. None - 2. InvalidParameter - 3. InvalidState - 4. OperationFailed - - - - - Called when the engine service user deinitializes Stt engine. - This callback function is called by the engine service user to request for Stt engine to be deinitialized. - - - Following Error Codes can be returned - 1. None - 2. InvalidState - - - - - Called when the engine service user gets the whole supported language list. - - - In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages - and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'. - - The callback function - The user data which must be passed to the callback delegate 'SupportedLanguages' - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. InvalidParameter - - - This callback function invokes SupportedLanguages repeatedly for getting supported languages. - - - - - Called when the engine service user checks whether the corresponding language is valid or not in Stt engine. - - The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code - For example, "ko_KR" for Korean, "en_US" for American English - A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid - - Following Error Codes can be returned - 1. None - 2. InvalidParameter - - - - - Called when the engine service user checks whether Stt engine supports silence detection. - - true to support silence detection, false not to support silence detection - - - - Called when the engine service user checks whether Stt engine supports the corresponding recognition type. - - The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - A variable for checking whether Stt engine supports the corresponding recognition type. - true to support recognition type, false not to support recognition type - - Following Error Codes can be returned - 1. None - 2. InvalidParameter - - - - - Called when the engine service user gets the proper recording format of Stt engine. - The recording format is used for creating the recorder. - - The format used by the recorder - The sample rate used by the recorder - The number of channels used by the recorder - - Following Error Codes can be returned - 1. None - 2. InvalidState - - - - - Called when the engine service user sets the silence detection. - If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it. - - A variable for setting the silence detection. true to detect the silence, false not to detect the silence - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. NotSupportedFeature - - - - - Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine. - This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine. - According to the need, the engine developer can provide some user interfaces to check the agreement. - - The Application ID - A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. NotSupportedFeature - - - - - Called when the engine service user checks whether Stt engine needs the application's credential. - - true if Stt engine needs the application's credential, otherwise false - - - - Called when the engine service user gets the result time information(stamp). - - - In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user - and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'. - timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer. - - The time information - The callback function - The user data which must be passed to the callback function ResultTime - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. InvalidParameter - - - SendResult will invoke this function - - - This function invokes ResultTime repeatedly for getting result time information. - - - - - Called when the engine service user starts to recognize the recording data. - In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult(). - Also, if Stt engine needs the application's credential, it sets the credential granted to the application. - - The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code - For example, "ko_KR" for Korean, "en_US" for American English - The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - The Application ID - The credential granted to the application - The user data to be passed to the callback function - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. InvalidParameter - 4. InvalidLanguage - 5. OperationFailed - 6. NetworkDown - - - The engine is not in recognition processing. - - - - - Called when the engine service user sets and sends the recording data for speech recognition. - This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition. - this function should be returned immediately after recording data copy. - - The recording data - The length of recording data - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. InvalidParameter - 4. OperationFailed - - - Start should succeed - - If the engine supports partial result, SendResult() should be invoked. - - - - Called when the engine service user stops to recognize the recording data. - This callback function is called by the engine service user to stop recording and to get the recognition result. - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. OperationFailed - 4. NetworkDown - - - Start should succeed - - After processing of the engine, , SendResult() should be invoked. - - - - Called when the engine service user cancels to recognize the recording data. - This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called. - - - Following Error Codes can be returned - 1. None - 2. InvalidState - - Stt engine is in recognition processing or recording. - - - - Public Constructor - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - - - Main function for Speech-To-Text (STT) engine. - This function is the main function for operating Stt engine. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - ServiceAppMain should be used for working the engine after this function. - - The Number of Arguments - The Arguments Array - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - - - Sends the recognition result to the engine service user. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user. - This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred. - The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime(). - The type of timeInfo is up to the Stt engine developer. - - The result event - The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" - Result texts - Result text count - Engine message - The time information - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - EngineMain function should be invoked before this function is called. Stop will invoke this function. - - - This function invokes ForEachResultTime - - - - - Sends the error to the engine service user. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - The Error Reason - The error message - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. - - - - - Sends the speech status to the engine service user when Stt engine notifies the change of the speech status. - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech. - - SpeechStatus - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function. - - - - - Sets a callback function for setting the private data. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - - Called when Stt engine receives the private data from the engine service user. - This callback function is called when the engine service user sends the private data to Stt engine. - In Parameters: - a = Key -- The key field of private data - b = data -- The data field of private data - Following Error Codes can be returned - 1. None - 2. InvalidParameter - 3. OperationFailed - - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. - - - - - Sets a callback delegate for requesting the private data. - - - http://tizen.org/privilege/recorder - - - http://tizen.org/feature/speech.recognition - http://tizen.org/feature/microphone - - callback function - Called when Stt engine provides the engine service user with the private data. - This callback function is called when the engine service user gets the private data from Stt engine. - Out Parameters: - a = Key -- The key field of private data - b = data -- The data field of private data - Following Error Codes can be returned - 1. None - 2. InvalidParameter - 3. OperationFailed - - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. - - - - + + + + Tizen.Uix.SttEngine + + + + + Partial Interop Class + + + Partial Interop Class + + + + + Partial Libraries Class + + + + + SttEngine Interop Class + + + + + + + + + + + + + + + + Enumeration for audio type. + + + + + Signed 16bit audio type, Little endian + + + + + Unsigned 8bit audio type + + + + + Enumeration for result. + + + + + Event when either the full matched or the final result is delivered + + + + + Event when the partial matched result is delivered + + + + + Event when the recognition has failed + + + + + Enumeration for result time. + + + + + Event when the token is beginning type + + + + + Event when the token is middle type + + + + + Event when the token is end type + + + + + Enumeration for speech status. + + + + + Beginning point of speech is detected + + + + + End point of speech is detected + + + + + Enumeration representing the result message + + + + + No Error + + + + + Recognition failed because the speech started too soon. + + + + + Recognition failed because the speech is too short. + + + + + Recognition failed because the speech is too long. + + + + + Recognition failed because the speech is too quiet to listen. + + + + + Recognition failed because the speech is too loud to listen. + + + + + Recognition failed because the speech is too fast to listen. + + + + + Enum for Error values that can occur + + + + + Successful, No error + + + + + Out of Memory + + + + + I/O error + + + + + Invalid parameter + + + + + Network down(Out of network) + + + + + Invalid state + + + + + Invalid language + + + + + Operation failed + + + + + Not supported feature of current engine + + + + + NOT supported + + + + + Permission denied + + + + + Recording timed out + + + + + This Class represents the Stt Engine which has to be inherited to make the engine. + + + + + An Action with 2 Input Parameter returning a Error + + Generic Type for Parameter 1 + The Input Parameter 1 + The Input Parameter 2 + Error Value + + + + An Action with 2 Out Parameter returning a Error + + Generic Type for Parameter 1 + The Input Parameter 1 + The Input Parameter 2 + Error Value + + + + Called when Stt engine provides the time stamp of result to the engine service user. + This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. + + The result index + The token event + The result text + The time started speaking the result text + The time finished speaking the result text + The User data + true to continue with the next iteration of the loop, false to break out of the loop + SendResult() should be called. + + + + Called when Stt engine informs the engine service user about whole supported language list. + This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. + + The language is specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code + for example, "ko_KR" for Korean, "en_US" for American English + The User data + true to continue with the next iteration of the loop, false to break out of the loop + ForEachSupportedLanguages() should be called + + + + Called when the engine service user requests the basic information of Stt engine. + + + In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. Therefore, engineSetting must be transferred to the engine service user. + + UUID of engine + Name of engine + The engine setting application(ui app)'s app ID + A variable for checking whether the network is used or not + + Following Error Codes can be returned + 1. None + 2. OperationFailed + 3. InvalidParameter + + + + + Called when the engine service user initializes Stt engine. + This callback function is called by the engine service user to request for Stt engine to be started. + + + Following Error Codes can be returned + 1. None + 2. InvalidParameter + 3. InvalidState + 4. OperationFailed + + + + + Called when the engine service user deinitializes Stt engine. + This callback function is called by the engine service user to request for Stt engine to be deinitialized. + + + Following Error Codes can be returned + 1. None + 2. InvalidState + + + + + Called when the engine service user gets the whole supported language list. + + + In this function, the engine service user's callback function 'SupportedLanguages' is invoked repeatedly for getting all supported languages + and user_data must be transferred to 'SupportedLanguages'. If 'SupportedLanguages' returns false, it should be stopped to call 'SupportedLanguages'. + + The callback function + The user data which must be passed to the callback delegate 'SupportedLanguages' + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. InvalidParameter + + + This callback function invokes SupportedLanguages repeatedly for getting supported languages. + + + + + Called when the engine service user checks whether the corresponding language is valid or not in Stt engine. + + The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code + For example, "ko_KR" for Korean, "en_US" for American English + A variable for checking whether the corresponding language is valid or not. true to be valid, false to be invalid + + Following Error Codes can be returned + 1. None + 2. InvalidParameter + + + + + Called when the engine service user checks whether Stt engine supports silence detection. + + true to support silence detection, false not to support silence detection + + + + Called when the engine service user checks whether Stt engine supports the corresponding recognition type. + + The type for recognition, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" + A variable for checking whether Stt engine supports the corresponding recognition type. + true to support recognition type, false not to support recognition type + + Following Error Codes can be returned + 1. None + 2. InvalidParameter + + + + + Called when the engine service user gets the proper recording format of Stt engine. + The recording format is used for creating the recorder. + + The format used by the recorder + The sample rate used by the recorder + The number of channels used by the recorder + + Following Error Codes can be returned + 1. None + 2. InvalidState + + + + + Called when the engine service user sets the silence detection. + If the engine service user sets this option as 'TRUE', Stt engine will detect the silence (EPD) and send the callback event about it. + + A variable for setting the silence detection. true to detect the silence, false not to detect the silence + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. NotSupportedFeature + + + + + Called when the engine service user requests for Stt engine to check whether the application agreed the usage of Stt engine. + This callback function is called when the engine service user requests for Stt engine to check the application's agreement about using the engine. + According to the need, the engine developer can provide some user interfaces to check the agreement. + + The Application ID + A variable for checking whether the application agreed to use Stt engine or not. true to agree, false to disagree + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. NotSupportedFeature + + + + + Called when the engine service user checks whether Stt engine needs the application's credential. + + true if Stt engine needs the application's credential, otherwise false + + + + Called when the engine service user gets the result time information(stamp). + + + In this function, the engine service user's callback delegate 'ResultTime' is invoked repeatedly for sending the time information to the engine service user + and user_data must be transferred to 'ResultTime'. If 'ResultTime' returns false, it should be stopped to call 'ResultTime'. + timeInfo is transferred from SendResult. The type of timeInfo is up to the Stt engine developer. + + The time information + The callback function + The user data which must be passed to the callback function ResultTime + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. InvalidParameter + + + SendResult will invoke this function + + + This function invokes ResultTime repeatedly for getting result time information. + + + + + Called when the engine service user starts to recognize the recording data. + In this callback function, Stt engine must transfer the recognition result and userData to the engine service user using SendResult(). + Also, if Stt engine needs the application's credential, it sets the credential granted to the application. + + The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code + For example, "ko_KR" for Korean, "en_US" for American English + The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" + The Application ID + The credential granted to the application + The user data to be passed to the callback function + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. InvalidParameter + 4. InvalidLanguage + 5. OperationFailed + 6. NetworkDown + + + The engine is not in recognition processing. + + + + + Called when the engine service user sets and sends the recording data for speech recognition. + This callback function is called by the engine service user to send the recording data to Stt engine.The engine receives the recording data and uses for speech recognition. + this function should be returned immediately after recording data copy. + + The recording data + The length of recording data + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. InvalidParameter + 4. OperationFailed + + + Start should succeed + + If the engine supports partial result, SendResult() should be invoked. + + + + Called when the engine service user stops to recognize the recording data. + This callback function is called by the engine service user to stop recording and to get the recognition result. + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. OperationFailed + 4. NetworkDown + + + Start should succeed + + After processing of the engine, , SendResult() should be invoked. + + + + Called when the engine service user cancels to recognize the recording data. + This callback function is called by the engine service user to cancel to recognize the recording data.Also, when starting the recorder is failed, this function is called. + + + Following Error Codes can be returned + 1. None + 2. InvalidState + + Stt engine is in recognition processing or recording. + + + + Public Constructor + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + + + Main function for Speech-To-Text (STT) engine. + This function is the main function for operating Stt engine. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + ServiceAppMain should be used for working the engine after this function. + + The Number of Arguments + The Arguments Array + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + + + Sends the recognition result to the engine service user. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This API is used in SetRecordingData() and Stop(), when Stt engine sends the recognition result to the engine service user. + This function is called in the following situations; 1) after Stop() is called, 2) the end point of speech is detected from recording, or 3) partial result is occurred. + The recognition result must be transferred to the engine service user through this function. Also, timeInfo must be transferred to ForEachResultTime(). + The type of timeInfo is up to the Stt engine developer. + + The result event + The recognition type, "stt.recognition.type.FREE" or "stt.recognition.type.FREE.PARTIAL" + Result texts + Result text count + Engine message + The time information + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + EngineMain function should be invoked before this function is called. Stop will invoke this function. + + + This function invokes ForEachResultTime + + + + + Sends the error to the engine service user. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + The Error Reason + The error message + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. + + + + + Sends the speech status to the engine service user when Stt engine notifies the change of the speech status. + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + This API is invoked when Stt engine wants to notify the change of the speech status anytime. NOTE that this API can be invoked for recognizing the speech. + + SpeechStatus + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function. + + + + + Sets a callback function for setting the private data. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + + Called when Stt engine receives the private data from the engine service user. + This callback function is called when the engine service user sends the private data to Stt engine. + In Parameters: + a = Key -- The key field of private data + b = data -- The data field of private data + Following Error Codes can be returned + 1. None + 2. InvalidParameter + 3. OperationFailed + + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. + + + + + Sets a callback delegate for requesting the private data. + + + http://tizen.org/privilege/recorder + + + http://tizen.org/feature/speech.recognition + http://tizen.org/feature/microphone + + callback function + Called when Stt engine provides the engine service user with the private data. + This callback function is called when the engine service user gets the private data from Stt engine. + Out Parameters: + a = Key -- The key field of private data + b = data -- The data field of private data + Following Error Codes can be returned + 1. None + 2. InvalidParameter + 3. OperationFailed + + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. + + + + diff --git a/Artifacts/bin/Tizen.Uix.Tts.dll b/Artifacts/bin/Tizen.Uix.Tts.dll index 62f613e..f925002 100644 Binary files a/Artifacts/bin/Tizen.Uix.Tts.dll and b/Artifacts/bin/Tizen.Uix.Tts.dll differ diff --git a/Artifacts/bin/Tizen.Uix.Tts.pdb b/Artifacts/bin/Tizen.Uix.Tts.pdb index 3155c16..a3620b5 100644 Binary files a/Artifacts/bin/Tizen.Uix.Tts.pdb and b/Artifacts/bin/Tizen.Uix.Tts.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.Tts.xml b/Artifacts/bin/Tizen.Uix.Tts.xml index d348b37..f85b124 100644 --- a/Artifacts/bin/Tizen.Uix.Tts.xml +++ b/Artifacts/bin/Tizen.Uix.Tts.xml @@ -1,723 +1,723 @@ - - - - Tizen.Uix.Tts - - - - - Partial interop class. - - - Partial interop class. - - - - - Partial libraries class. - - - - - Tts interop class. - - - - - - - - - - - - - - - - - - - This class holds information related to the DefaultVoiceChanged event. - - 3 - - - - The previous SupportedVoice. - - 3 - - - - The current SupportedVoice. - - 3 - - - - This class holds information related to the EngineChanged event. - - 3 - - - - The engine ID. - - 3 - - - - The necessity of the credential. - - 3 - - - - The supported voice. - - 3 - - - - This class holds information related to the TTS ErrorOccurred event. - - 3 - - - - The utterance ID. - - 3 - - - - The error value. - - 3 - - - - Gets the current error message. - - 3 - - String error message. - - - - - This class holds the speed range values. - - 3 - - - - The max speed range value. - - 3 - - - - The min speed range value. - - 3 - - - - The normal speed range value. - - 3 - - - - This class holds information related to the TTS StateChanged event. - - 3 - - - - The previous state. - - 3 - - - - The current state. - - 3 - - - - This class holds information about the supported voices. - - 3 - - - - Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English). - - 3 - - - - Enumeration for the states. - - 3 - - - - Created state. - - 3 - - - - Ready state. - - 3 - - - - Playing state. - - 3 - - - - Paused state. - - 3 - - - - Unavailable state. - - 3 - - - - Enumeration for TTS mode. - - 3 - - - - Default mode for normal application. - - 3 - - - - Notification mode. - - 3 - - - - Accessibility mode. - - 3 - - - - Enumeration for error values that can occur. - - 3 - - - - Successful, no error. - - 3 - - - - Out of memory. - - 3 - - - - I/O error. - - 3 - - - - Invalid parameter. - - 3 - - - - No answer from the STT service. - - 3 - - - - Network is down. - - 3 - - - - Permission denied. - - 3 - - - - STT not supported. - - 3 - - - - Invalid state. - - 3 - - - - Invalid voice. - - 3 - - - - No available engine. - - 3 - - - - Operation failed. - - 3 - - - - Audio policy blocked. - - 3 - - - - Enumeration for the voice types. - - 3 - - - - The automatic voice type. - - 3 - - - - The male voice type. - - 3 - - - - The female voice type. - - 3 - - - - The child voice type. - - 3 - - - - You can use Text-To-Speech (TTS) API's to read sound data transformed by the engine from input texts. - Applications can add input-text to queue for reading continuously and control the player that can play, pause, and stop sound data synthesized from text. - - 3 - - - - Constructor to create a TTS instance. - - 3 - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Operation Failed - 2. Engine Not Found - - This exception can be due to out Of memory. - This exception can be due to TTS not supported. - - - - Event to be invoked when TTS state changes. - - 3 - - - - Event to be invoked when the utterance starts. - - 3 - - - - Event to be invoked when the utterance completes. - - 3 - - - - Event to be invoked when an error occurs. - - 3 - - - - Event to be invoked when an error occurs. - - 3 - - - - Event to be invoked to detect engine change. - - 3 - - - - Gets the default voice set by the user. - - 3 - - The default voice in TTS. - - - The default voice SupportedVoice value. - - - - - Gets the maximum byte size for text. - - 3 - - The Maximum byte size for text. - - - The Default Voice SupportedVoice value, 0 if unable to get the value. - - 
-            The State should be ready.
-
- - - - Gets the current TTS state. - - 3 - - The current state of TTS. - - - Current TTS State value. - - - - - The TTS Mode can be set using this property. - - 3 - - The current TTS mode (default, screen-reader, notification). - - - The Mode value. - - - This exception can be due to the following reasons while setting the value: - 1. Operation Failed - 2. Engine Not Found - - This exception can be due to out Of memory. - This exception can be due to TTS not supported. - 
-            The State should be created.
-
- - - - Sets the application credential. - - 3 - . - The credential string. - - - http://tizen.org/feature/speech.synthesis - - This exception can be due to an invalid state. - This exception can be due to TTS not supported. - This exception can be due to improper value provided while setting the value. - 
-            The State should be created or ready.
-
- - - - Connects to the TTS service asynchronously. - - 3 - - http://tizen.org/feature/speech.synthesis - - This exception can be due to an invalid state. - This exception can be due to TTS not supported. - 
-            The State must be Created.
-
- - If this function is successful, the TTS state will be ready. - If this function is unsuccessful, ErrorOccurred event will be invoked. - - - - - Disconnects from the STT service. - - 3 - - http://tizen.org/feature/speech.synthesis - - This exception can be due to an invalid state. - This exception can be due to TTS not supported. - 
-            The state must be ready.
-
- - If this function is successful, the TTS state will be created. - - - - - Retrieves all supported voices of the current engine. - - 3 - - The list of SupportedVoice. - - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Engine Not Found - 2. Operation Failed - - This exception can be due to TTS not supported. - - - - Gets the private data from TTS engine. - - 3 - - The key string. - - - The data corresponding to the provided key. - - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Engine Not found - 3. Operation Failure - - This exception can be due to TTS not supported. - 
-            The state must be ready.
-
- - - - Sets the private data to tts engine. - - 3 - - The key string. - - - The data string. - - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Engine Not found - 3. Operation Failure - - This exception can be due to TTS not supported. - This exception can be due to improper value provided while setting the value. - 
-            The state must be ready.
-
- - - - Gets the speed range. - - 3 - - The SpeedRange value. - - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failure - - This exception can be due to TTS not supported. - 
-            The state must be created.
-
- - - - Adds a text to the queue. - - 3 - - Locale MUST be set for UTF-8 text validation check. - - - An input text based UTF-8. - - - The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices()(e.g. 'NULL'(Automatic),'en_US'). - - - The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices(). - - - A speaking speed (e.g.0 for Auto or the value from SpeedRange Property). - - - The utterance ID. - - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failure - 3. Invalid Voice - - This exception can be due to TTS not supported. - This exception can be due to permission denied. - This exception can be due to improper value provided while setting the value. - 
-            The state must be ready or playing or paused.
-
- - - - Starts synthesizing voice from the text and plays the synthesized audio data. - - 3 - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failure - 3. Out of Network - - This exception can be due to TTS not supported. - This exception can be due to permission denied. - 
-            The state must be ready or paused.
-
- - If this function succeeds, the TTS state will be playing. - - - - - Stops playing the utterance and clears the queue. - - 3 - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid Stat - 2. Operation Failure - - This exception can be due to TTS not supported. - 
-            The state must be ready or playing or paused.
-
- - If this function succeeds, the TTS state will be ready. - This function will remove all text added via AddText() and synthesized sound data. - - - - - Pauses the currently playing utterance. - - 3 - - http://tizen.org/feature/speech.synthesis - - - This exception can be due to the following reasons: - 1. Invalid State - 2. Operation Failure - - This exception can be due to TTS not supported. - 
-            The state must be playing.
-
- - If this function succeeds, the TTS state will be Paused. - - - - - Method to release resources. - - 3 - - - - This class holds information related to UtteranceStared and UtteranceCompleted events. - - 3 - - - - The utterance ID. - - 3 - - - + + + + Tizen.Uix.Tts + + + + + Partial interop class. + + + Partial interop class. + + + + + Partial libraries class. + + + + + Tts interop class. + + + + + + + + + + + + + + + + + + + This class holds information related to the DefaultVoiceChanged event. + + 3 + + + + The previous SupportedVoice. + + 3 + + + + The current SupportedVoice. + + 3 + + + + This class holds information related to the EngineChanged event. + + 3 + + + + The engine ID. + + 3 + + + + The necessity of the credential. + + 3 + + + + The supported voice. + + 3 + + + + This class holds information related to the TTS ErrorOccurred event. + + 3 + + + + The utterance ID. + + 3 + + + + The error value. + + 3 + + + + Gets the current error message. + + 3 + + String error message. + + + + + This class holds the speed range values. + + 3 + + + + The max speed range value. + + 3 + + + + The min speed range value. + + 3 + + + + The normal speed range value. + + 3 + + + + This class holds information related to the TTS StateChanged event. + + 3 + + + + The previous state. + + 3 + + + + The current state. + + 3 + + + + This class holds information about the supported voices. + + 3 + + + + Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English). + + 3 + + + + Enumeration for the states. + + 3 + + + + Created state. + + 3 + + + + Ready state. + + 3 + + + + Playing state. + + 3 + + + + Paused state. + + 3 + + + + Unavailable state. + + 3 + + + + Enumeration for TTS mode. + + 3 + + + + Default mode for normal application. + + 3 + + + + Notification mode. + + 3 + + + + Accessibility mode. + + 3 + + + + Enumeration for error values that can occur. + + 3 + + + + Successful, no error. + + 3 + + + + Out of memory. + + 3 + + + + I/O error. + + 3 + + + + Invalid parameter. + + 3 + + + + No answer from the STT service. + + 3 + + + + Network is down. + + 3 + + + + Permission denied. + + 3 + + + + STT not supported. + + 3 + + + + Invalid state. + + 3 + + + + Invalid voice. + + 3 + + + + No available engine. + + 3 + + + + Operation failed. + + 3 + + + + Audio policy blocked. + + 3 + + + + Enumeration for the voice types. + + 3 + + + + The automatic voice type. + + 3 + + + + The male voice type. + + 3 + + + + The female voice type. + + 3 + + + + The child voice type. + + 3 + + + + You can use Text-To-Speech (TTS) API's to read sound data transformed by the engine from input texts. + Applications can add input-text to queue for reading continuously and control the player that can play, pause, and stop sound data synthesized from text. + + 3 + + + + Constructor to create a TTS instance. + + 3 + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Operation Failed + 2. Engine Not Found + + This exception can be due to out Of memory. + This exception can be due to TTS not supported. + + + + Event to be invoked when TTS state changes. + + 3 + + + + Event to be invoked when the utterance starts. + + 3 + + + + Event to be invoked when the utterance completes. + + 3 + + + + Event to be invoked when an error occurs. + + 3 + + + + Event to be invoked when an error occurs. + + 3 + + + + Event to be invoked to detect engine change. + + 3 + + + + Gets the default voice set by the user. + + 3 + + The default voice in TTS. + + + The default voice SupportedVoice value. + + + + + Gets the maximum byte size for text. + + 3 + + The Maximum byte size for text. + + + The Default Voice SupportedVoice value, 0 if unable to get the value. + + 
+            The State should be ready.
+
+ + + + Gets the current TTS state. + + 3 + + The current state of TTS. + + + Current TTS State value. + + + + + The TTS Mode can be set using this property. + + 3 + + The current TTS mode (default, screen-reader, notification). + + + The Mode value. + + + This exception can be due to the following reasons while setting the value: + 1. Operation Failed + 2. Engine Not Found + + This exception can be due to out Of memory. + This exception can be due to TTS not supported. + 
+            The State should be created.
+
+ + + + Sets the application credential. + + 3 + . + The credential string. + + + http://tizen.org/feature/speech.synthesis + + This exception can be due to an invalid state. + This exception can be due to TTS not supported. + This exception can be due to improper value provided while setting the value. + 
+            The State should be created or ready.
+
+ + + + Connects to the TTS service asynchronously. + + 3 + + http://tizen.org/feature/speech.synthesis + + This exception can be due to an invalid state. + This exception can be due to TTS not supported. + 
+            The State must be Created.
+
+ + If this function is successful, the TTS state will be ready. + If this function is unsuccessful, ErrorOccurred event will be invoked. + + + + + Disconnects from the STT service. + + 3 + + http://tizen.org/feature/speech.synthesis + + This exception can be due to an invalid state. + This exception can be due to TTS not supported. + 
+            The state must be ready.
+
+ + If this function is successful, the TTS state will be created. + + + + + Retrieves all supported voices of the current engine. + + 3 + + The list of SupportedVoice. + + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Engine Not Found + 2. Operation Failed + + This exception can be due to TTS not supported. + + + + Gets the private data from TTS engine. + + 3 + + The key string. + + + The data corresponding to the provided key. + + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Engine Not found + 3. Operation Failure + + This exception can be due to TTS not supported. + 
+            The state must be ready.
+
+ + + + Sets the private data to tts engine. + + 3 + + The key string. + + + The data string. + + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Engine Not found + 3. Operation Failure + + This exception can be due to TTS not supported. + This exception can be due to improper value provided while setting the value. + 
+            The state must be ready.
+
+ + + + Gets the speed range. + + 3 + + The SpeedRange value. + + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failure + + This exception can be due to TTS not supported. + 
+            The state must be created.
+
+ + + + Adds a text to the queue. + + 3 + + Locale MUST be set for UTF-8 text validation check. + + + An input text based UTF-8. + + + The language selected from the SupportedVoice.Language Property obtained from GetSupportedVoices()(e.g. 'NULL'(Automatic),'en_US'). + + + The voice type selected from the SupportedVoice.VoiceType Property obtained from GetSupportedVoices(). + + + A speaking speed (e.g.0 for Auto or the value from SpeedRange Property). + + + The utterance ID. + + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failure + 3. Invalid Voice + + This exception can be due to TTS not supported. + This exception can be due to permission denied. + This exception can be due to improper value provided while setting the value. + 
+            The state must be ready or playing or paused.
+
+ + + + Starts synthesizing voice from the text and plays the synthesized audio data. + + 3 + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failure + 3. Out of Network + + This exception can be due to TTS not supported. + This exception can be due to permission denied. + 
+            The state must be ready or paused.
+
+ + If this function succeeds, the TTS state will be playing. + + + + + Stops playing the utterance and clears the queue. + + 3 + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid Stat + 2. Operation Failure + + This exception can be due to TTS not supported. + 
+            The state must be ready or playing or paused.
+
+ + If this function succeeds, the TTS state will be ready. + This function will remove all text added via AddText() and synthesized sound data. + + + + + Pauses the currently playing utterance. + + 3 + + http://tizen.org/feature/speech.synthesis + + + This exception can be due to the following reasons: + 1. Invalid State + 2. Operation Failure + + This exception can be due to TTS not supported. + 
+            The state must be playing.
+
+ + If this function succeeds, the TTS state will be Paused. + + + + + Method to release resources. + + 3 + + + + This class holds information related to UtteranceStared and UtteranceCompleted events. + + 3 + + + + The utterance ID. + + 3 + + + diff --git a/Artifacts/bin/Tizen.Uix.TtsEngine.dll b/Artifacts/bin/Tizen.Uix.TtsEngine.dll index dd26a91..a67fa59 100644 Binary files a/Artifacts/bin/Tizen.Uix.TtsEngine.dll and b/Artifacts/bin/Tizen.Uix.TtsEngine.dll differ diff --git a/Artifacts/bin/Tizen.Uix.TtsEngine.pdb b/Artifacts/bin/Tizen.Uix.TtsEngine.pdb index a19a0d3..1e369e9 100644 Binary files a/Artifacts/bin/Tizen.Uix.TtsEngine.pdb and b/Artifacts/bin/Tizen.Uix.TtsEngine.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.TtsEngine.xml b/Artifacts/bin/Tizen.Uix.TtsEngine.xml index 715e096..9996dfd 100644 --- a/Artifacts/bin/Tizen.Uix.TtsEngine.xml +++ b/Artifacts/bin/Tizen.Uix.TtsEngine.xml @@ -1,534 +1,534 @@ - - - - Tizen.Uix.TtsEngine - - - - - Partial Interop Class - - - Partial Interop Class - - - - - Partial Libraries Class - - - - - TtsEngine Interop Class - - - - - - - - - - - - - - - Enumeration for audio type. - - - - - Signed 16-bit audio type - - - - - Unsigned 8-bit audio type - - - - - Maximum Value - - - - - Enumeration for result. - - - - - Event when the voice synthesis is failed - - - - - Event when the sound data is first data by callback function - - - - - Event when the next sound data exist, not first and not last - - - - - Event when the sound data is last data or sound data is only one result - - - - - Enumeration for Voice Type - - - - - male voice type. - - - - - female voice type. - - - - - child's voice type. - - - - - Enum for Error values that can occur - - - - - Successful, No error - - - - - Out of Memory - - - - - I/O error - - - - - Invalid parameter - - - - - Network down(Out of network) - - - - - Invalid state - - - - - Invalid voice - - - - - Operation failed - - - - - Not supported feature of current engine - - - - - NOT supported - - - - - Permission denied - - - - - This Class represents the Tts Engine which has to be inherited to make the engine. - - - - - An Action with 2 Input Parameter returning a Error - - Generic Type for Parameter 1 - The Input Parameter 1 - The Input Parameter 2 - Error Value - - - - An Action with 2 Out Parameter returning a Error - - Generic Type for Parameter 1 - The Input Parameter 1 - The Input Parameter 2 - Error Value - - - - Called when TTS engine informs the engine service user about whole supported language and voice type list. - This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function. - - - This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices(). - - The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English - The voice type - The user data passed from ForEachSupportedVoices() - true to continue with the next iteration of the loop false to break out of the loop - ForEachSupportedVoices() will invoke this callback function. - - - - Called when the engine service user starts to synthesize a voice, asynchronously. - - - In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult(). - Also, if TTS engine needs the application's credential, it can set the credential granted to the application. - - The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English - The voice type - Texts - The speed of speaking - The Application ID - The credential granted to the application - The user data which must be passed to SendResult() function - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. InvalidParameter - 4. InvalidVoice - 5. OperationFailed - 6. NetworkDown - 7. PermissionDenied - - This function invokes SendResult() - - - - Called when the engine service user requests the basic information of TTS engine. - - - The allocated engineUuid, engineName, and engineSetting will be released internally. - In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. - Therefore, engineSetting must be transferred to the engine service user. - - UUID of engine - Name of engine - The engine setting application(ui app)'s app ID - The status for using network - - Following Error Codes can be returned - 1. None - 2. InvalidState - - - - - Called when the engine service user initializes TTS engine. - - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. NotSupportedFeature - 4. PermissionDenied - - - - - Called when the engine service user deinitializes TTS engine. - - - NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary. - - - Following Error Codes can be returned - 1. None - 2. InvalidState - - - - - Called when the engine service user gets the whole supported voice list. - - - In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices, - and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'. - The callback function - The user data which must be passed to SupportedVoice() - - Following Error Codes can be returned - 1. None - 2. OperationFailed - - This callback function invokes SupportedVoice() repeatedly for getting all supported voices. - - - - Called when the engine service user checks whether the voice is valid or not in TTS engine. - - The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English - The voice type - A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid - - Following Error Codes can be returned - 1. None - 2. InvalidParameter - - - - - Called when the engine service user sets the default pitch of TTS engine. - - The default pitch - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. OperationFailed - 4. InvalidParameter - - - - - Called when the engine service user requests to load the corresponding voice type for the first time. - - The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English - The voice type - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. OperationFailed - 4. InvalidVoice - 5. InvalidParameter - 6. OutOfMemory - - - - - Called when the engine service user requests to unload the corresponding voice type or to stop using voice. - - The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English - The voice type - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. OperationFailed - 4. InvalidVoice - 5. InvalidParameter - - - - - Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine. - This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine. - According to the need, the engine developer can provide some user interfaces to check the agreement. - - - If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention. - true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed. - NOTE that, however, there may be any legal issue unless the developer checks the agreement. - Therefore, we suggest that the engine developers should provide a function to check the agreement. - - The Application ID - A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree - - Following Error Codes can be returned - 1. None - 2. InvalidState - 3. NotSupportedFeature - 4. InvalidParameter - - - - - Called when the engine service user checks whether TTS engine needs the application's credential. - - true if TTS engine needs the application's credential, otherwise false - - - - Called when the engine service user cancels to synthesize a voice. - - - Following Error Codes can be returned - 1. None - 2. InvalidState - - - StartSynthesis should be performed - - - - - Public Constructor - - - http://tizen.org/feature/speech.synthesis - - - - - Main function for Text-To-Speech (TTS) engine. - This function is the main function for operating TTS engine. - - - http://tizen.org/feature/speech.synthesis - - - ServiceAppMain should be used for working the engine after this function. - - The argument count(original) - The argument(original) - Thrown in case of Invalid Parameter - Thrown in case of Not supported - thrown in case of Operation failure - - - - Gets the speed range from Tizen platform - - - http://tizen.org/feature/speech.synthesis - - - This API is used when TTS engine wants to get the speed range from Tizen platform - - The minimum speed value - The normal speed value - The maximum speed value - Thrown in case of Not supported - thrown in case of Operation failure - - - - Gets the pitch range from Tizen platform. - - - http://tizen.org/feature/speech.synthesis - - - This API is used when TTS engine wants to get the pitch range from Tizen platform. - - The minimum pitch value - The normal pitch value - The maximum pitch value - Thrown in case of Not supported - thrown in case of Operation failure - - - - Sends the synthesized result to the engine service user. - - - http://tizen.org/feature/speech.synthesis - - - This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user. - The synthesized result must be transferred to the engine service user through this function. - - The result event - Result data - Result data size - The audio type - The sample rate - Thrown in case of Invalid Parameter - Thrown in case of Not supported - thrown in case of Operation failure - - EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function. - - - - - Sends the error to the engine service user. - - - http://tizen.org/feature/speech.synthesis - - The error reason - The error message - - EngineMain function should be invoked before this function is called. - - - - - Sets a callback function for setting the private data. - - - http://tizen.org/feature/speech.synthesis - - - Called when the engine service user gets the private data from Tts engine. - In Parameters: - a = Key -- The key field of private data - b = data -- The data field of private data - Following Error Codes can be returned - 1. None - 2. InvalidParameter - 3. OperationFailed - 4. NotSupported - - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. - - - - - Sets a callback function for setting the private data. - - - http://tizen.org/feature/speech.synthesis - - callback function - Called when TTS engine receives the private data from the engine service user. - This callback function is called when the engine service user sends the private data to TTS engine. - Out Parameters: - a = Key -- The key field of private data - b = data -- The data field of private data - Following Error Codes can be returned - 1. None - 2. InvalidParameter - 3. OperationFailed - 4. NotSupported - - Thrown in case of Invalid Parameter - Thrown in case of Permission denied - Thrown in case of Not supported - thrown in case of Operation failure - - Main function should be invoked before this function is called. - - - - + + + + Tizen.Uix.TtsEngine + + + + + Partial Interop Class + + + Partial Interop Class + + + + + Partial Libraries Class + + + + + TtsEngine Interop Class + + + + + + + + + + + + + + + Enumeration for audio type. + + + + + Signed 16-bit audio type + + + + + Unsigned 8-bit audio type + + + + + Maximum Value + + + + + Enumeration for result. + + + + + Event when the voice synthesis is failed + + + + + Event when the sound data is first data by callback function + + + + + Event when the next sound data exist, not first and not last + + + + + Event when the sound data is last data or sound data is only one result + + + + + Enumeration for Voice Type + + + + + male voice type. + + + + + female voice type. + + + + + child's voice type. + + + + + Enum for Error values that can occur + + + + + Successful, No error + + + + + Out of Memory + + + + + I/O error + + + + + Invalid parameter + + + + + Network down(Out of network) + + + + + Invalid state + + + + + Invalid voice + + + + + Operation failed + + + + + Not supported feature of current engine + + + + + NOT supported + + + + + Permission denied + + + + + This Class represents the Tts Engine which has to be inherited to make the engine. + + + + + An Action with 2 Input Parameter returning a Error + + Generic Type for Parameter 1 + The Input Parameter 1 + The Input Parameter 2 + Error Value + + + + An Action with 2 Out Parameter returning a Error + + Generic Type for Parameter 1 + The Input Parameter 1 + The Input Parameter 2 + Error Value + + + + Called when TTS engine informs the engine service user about whole supported language and voice type list. + This callback function is implemented by the engine service user.Therefore, the engine developer does NOT have to implement this callback function. + + + This callback function is called by ForEachSupportedVoices() to inform the whole supported voice list. userData must be transferred from ForEachSupportedVoices(). + + The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English + The voice type + The user data passed from ForEachSupportedVoices() + true to continue with the next iteration of the loop false to break out of the loop + ForEachSupportedVoices() will invoke this callback function. + + + + Called when the engine service user starts to synthesize a voice, asynchronously. + + + In this callback function, TTS engine must transfer the synthesized result to the engine service user using SendResult(). + Also, if TTS engine needs the application's credential, it can set the credential granted to the application. + + The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English + The voice type + Texts + The speed of speaking + The Application ID + The credential granted to the application + The user data which must be passed to SendResult() function + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. InvalidParameter + 4. InvalidVoice + 5. OperationFailed + 6. NetworkDown + 7. PermissionDenied + + This function invokes SendResult() + + + + Called when the engine service user requests the basic information of TTS engine. + + + The allocated engineUuid, engineName, and engineSetting will be released internally. + In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. + Therefore, engineSetting must be transferred to the engine service user. + + UUID of engine + Name of engine + The engine setting application(ui app)'s app ID + The status for using network + + Following Error Codes can be returned + 1. None + 2. InvalidState + + + + + Called when the engine service user initializes TTS engine. + + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. NotSupportedFeature + 4. PermissionDenied + + + + + Called when the engine service user deinitializes TTS engine. + + + NOTE that the engine may be terminated automatically. When this callback function is invoked, the release of resources is necessary. + + + Following Error Codes can be returned + 1. None + 2. InvalidState + + + + + Called when the engine service user gets the whole supported voice list. + + + In this function, the engine service user's callback function 'SupportedVoice()' is invoked repeatedly for getting all supported voices, + and userData must be transferred to 'SupportedVoice()'. If 'SupportedVoice()' returns false, it should be stopped to call 'SupportedVoice()'. + The callback function + The user data which must be passed to SupportedVoice() + + Following Error Codes can be returned + 1. None + 2. OperationFailed + + This callback function invokes SupportedVoice() repeatedly for getting all supported voices. + + + + Called when the engine service user checks whether the voice is valid or not in TTS engine. + + The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English + The voice type + A variable for checking whether the corresponding voice is valid or not. true to be valid, false to be invalid + + Following Error Codes can be returned + 1. None + 2. InvalidParameter + + + + + Called when the engine service user sets the default pitch of TTS engine. + + The default pitch + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. OperationFailed + 4. InvalidParameter + + + + + Called when the engine service user requests to load the corresponding voice type for the first time. + + The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English + The voice type + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. OperationFailed + 4. InvalidVoice + 5. InvalidParameter + 6. OutOfMemory + + + + + Called when the engine service user requests to unload the corresponding voice type or to stop using voice. + + The language is specified as an ISO 3166 alpha-2 two-letter country code followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English + The voice type + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. OperationFailed + 4. InvalidVoice + 5. InvalidParameter + + + + + Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine. + This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine. + According to the need, the engine developer can provide some user interfaces to check the agreement. + + + If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as isAgreed in accordance with the intention. + true if the developer regards that every application agreed the usage of the engine, false if the developer regards that every application disagreed. + NOTE that, however, there may be any legal issue unless the developer checks the agreement. + Therefore, we suggest that the engine developers should provide a function to check the agreement. + + The Application ID + A variable for checking whether the application agreed to use TTS engine or not. true to agree, false to disagree + + Following Error Codes can be returned + 1. None + 2. InvalidState + 3. NotSupportedFeature + 4. InvalidParameter + + + + + Called when the engine service user checks whether TTS engine needs the application's credential. + + true if TTS engine needs the application's credential, otherwise false + + + + Called when the engine service user cancels to synthesize a voice. + + + Following Error Codes can be returned + 1. None + 2. InvalidState + + + StartSynthesis should be performed + + + + + Public Constructor + + + http://tizen.org/feature/speech.synthesis + + + + + Main function for Text-To-Speech (TTS) engine. + This function is the main function for operating TTS engine. + + + http://tizen.org/feature/speech.synthesis + + + ServiceAppMain should be used for working the engine after this function. + + The argument count(original) + The argument(original) + Thrown in case of Invalid Parameter + Thrown in case of Not supported + thrown in case of Operation failure + + + + Gets the speed range from Tizen platform + + + http://tizen.org/feature/speech.synthesis + + + This API is used when TTS engine wants to get the speed range from Tizen platform + + The minimum speed value + The normal speed value + The maximum speed value + Thrown in case of Not supported + thrown in case of Operation failure + + + + Gets the pitch range from Tizen platform. + + + http://tizen.org/feature/speech.synthesis + + + This API is used when TTS engine wants to get the pitch range from Tizen platform. + + The minimum pitch value + The normal pitch value + The maximum pitch value + Thrown in case of Not supported + thrown in case of Operation failure + + + + Sends the synthesized result to the engine service user. + + + http://tizen.org/feature/speech.synthesis + + + This API is used in StartSynthesis(), when TTS engine sends the synthesized result to the engine service user. + The synthesized result must be transferred to the engine service user through this function. + + The result event + Result data + Result data size + The audio type + The sample rate + Thrown in case of Invalid Parameter + Thrown in case of Not supported + thrown in case of Operation failure + + EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function. + + + + + Sends the error to the engine service user. + + + http://tizen.org/feature/speech.synthesis + + The error reason + The error message + + EngineMain function should be invoked before this function is called. + + + + + Sets a callback function for setting the private data. + + + http://tizen.org/feature/speech.synthesis + + + Called when the engine service user gets the private data from Tts engine. + In Parameters: + a = Key -- The key field of private data + b = data -- The data field of private data + Following Error Codes can be returned + 1. None + 2. InvalidParameter + 3. OperationFailed + 4. NotSupported + + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. + + + + + Sets a callback function for setting the private data. + + + http://tizen.org/feature/speech.synthesis + + callback function + Called when TTS engine receives the private data from the engine service user. + This callback function is called when the engine service user sends the private data to TTS engine. + Out Parameters: + a = Key -- The key field of private data + b = data -- The data field of private data + Following Error Codes can be returned + 1. None + 2. InvalidParameter + 3. OperationFailed + 4. NotSupported + + Thrown in case of Invalid Parameter + Thrown in case of Permission denied + Thrown in case of Not supported + thrown in case of Operation failure + + Main function should be invoked before this function is called. + + + + diff --git a/Artifacts/bin/Tizen.Uix.VoiceControl.dll b/Artifacts/bin/Tizen.Uix.VoiceControl.dll index 34a4e4c..f7c2cf9 100644 Binary files a/Artifacts/bin/Tizen.Uix.VoiceControl.dll and b/Artifacts/bin/Tizen.Uix.VoiceControl.dll differ diff --git a/Artifacts/bin/Tizen.Uix.VoiceControl.pdb b/Artifacts/bin/Tizen.Uix.VoiceControl.pdb index 84f8eb6..520174d 100644 Binary files a/Artifacts/bin/Tizen.Uix.VoiceControl.pdb and b/Artifacts/bin/Tizen.Uix.VoiceControl.pdb differ diff --git a/Artifacts/bin/Tizen.Uix.VoiceControl.xml b/Artifacts/bin/Tizen.Uix.VoiceControl.xml index df0aa65..456a0eb 100644 --- a/Artifacts/bin/Tizen.Uix.VoiceControl.xml +++ b/Artifacts/bin/Tizen.Uix.VoiceControl.xml @@ -1,1031 +1,1031 @@ - - - - Tizen.Uix.VoiceControl - - - - - Partial interop class. - - - Partial interop class. - - - Partial interop class. - - - - - Partial libraries class. - - - - - VoiceControl interop class. - - - - - - - - - - - - - - - - - - - - - - - VoiceControlCommand interop class. - - - - - This class holds information about the CurrentLanguageChanged event. - - 3 - - - - The previous language. - - 3 - - - - The current language. - - 3 - - - - This class holds information related to the VoiceControl ErrorOccured event. - - 3 - - - - The error value. - - 3 - - - - The recognition result from the engine. - If the duplicated commands are recognized, the event(e.g. Result.Rejected) of a command may be rejected - for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the CommandList has multi commands. - - 3 - - - - The result event. - - 3 - - - - The spoken text. - - 3 - - - - The recognized command list. - - 3 - - - - The recognition result from the engine. - - 3 - - - - Gets the recognition result. - - 3 - - - - This class holds information related to the VoiceControl service ServiceStateChanged event. - - 3 - - - - The previous state. - - 3 - - - - The current state. - - 3 - - - - This class holds information related to the VoiceControl client StateChanged event. - - 3 - - - - The previous state. - - 3 - - - - The current state. - - 3 - - - - Enumeration for the command format. - - 3 - - - - The fixed command format. - - - - - The fixed and variable fixed command format. - - - - - The variable fixed and fixed command format. - - - - - The fixed and non-fixed command format. - - - - - The non-fixed and fixed command format. - - - - - Undefined. - - - - - This class represents a voice command. - - 3 - - - - The public constructor. - - 3 - This exception can be due to an invalid state. - This exception can be due to out Of memory. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Gets the unfixed command. - This property should be used for commands which have non-fixed format. - An empty string will be returned in case of some internal error. - - 3 - - - - Gets or sets the command type. - - 3 - If you do not set the command type, the default value is undefined. You should set the type if the command is valid. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Gets or sets the command format. - - 3 - The default format is Fixed. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Gets or sets the command. - A get empty string will be returned in case of some internal error. - - 3 - This exception can be due to permission denied. - This exception can be due to not supported. - - - - This class represents a list of the voice commands. - - 3 - - - - The public constructor. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to out of memory. - This exception can be due to an invalid parameter. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Gets a command count of the list. - -1 is returned in case of an internal failure. - - 3 - - Command count of the list. - - - http://tizen.org/privilege/recorder - - - public - - - - - Gets the current command from the command list by index. - Null will be returned in case of an empty list. - - 3 - - Current command from the command list. - - - http://tizen.org/privilege/recorder - - - public - - - - - Adds a command to the command list. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - The command - This exception can be due to permission denied. - This exception can be due to not supported. - This will occur if the provided parameter is null. - - - - Removes a command from the command list. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - The command - This exception can be due to permission denied. - This exception can be due to not supported. - This will occur if the provided parameter is null. - - - - Retrieves all commands from the command list. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Moves an index to the first command. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to list empty. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Moves an index to the last command. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to list empty. - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Moves an index to the next command. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. List empty - 2. List reached end - - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Moves an index to the previous command. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - This exception can be due to the following reasons: - 1. List empty - 2. List reached end - - This exception can be due to permission denied. - This exception can be due to not supported. - - - - Enumeration for the error values that can occur. - - 3 - - - - Successful, no error. - - - - - Out of memory. - - - - - I/O error. - - - - - Invalid parameter. - - - - - No answer from the STT service. - - - - - Device or resource busy. - - - - - Permission denied. - - - - - VC NOT supported. - - - - - Invalid state. - - - - - Invalid language. - - - - - No available engine. - - - - - Operation failed. - - - - - Operation rejected. - - - - - List reached end. - - - - - List empty. - - - - - Service reset. - - - - - Progress to ready is not finished. - - - - - Progress to recording is not finished. - - - - - Progress to processing is not finished. - - - - - Enumeration for the client state. - - 3 - - - - 'None' state. - - - - - 'Initialized' state. - - - - - 'Ready' state. - - - - - The state cannot be determined. - - - - - Enumeration for the service state. - - 3 - - - - 'None' state. - - - - - 'Ready' state. - - - - - 'Recording' state. - - - - - 'Processing' state. - - - - - The state cannot be determined. - - - - - Enumeration for the result event. - - 3 - - - - Normal result. - - - - - Rejected result. - - - - - Enumeration for the command type. - - 3 - - - - Foreground command by the client. - - - - - Background command by the client. - - - - - The undefined command. - - - - - A main function of the voice control API registers the command and gets a notification for the recognition result. - Applications can add their own commands and provide results when their command is recognized by the user voice input. - - 3 - - - - Gets the current language. - A language is specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English. - An empty string is returned in case of some internal error. - - 3 - - The current language in voice control. - - - http://tizen.org/privilege/recorder - - 
-            The state must be initialized or ready.
-
- - - - Gets the current state of the voice control client. - - 3 - - The current state of the voice control client. - - - http://tizen.org/privilege/recorder - - 
-            The state must be initialized or ready.
-
- - - - Gets the current state of the voice control service. - - 3 - - The current state of the voice control service. - - - http://tizen.org/privilege/recorder - - 
-            The state must be ready.
-
- - - - Sets the invocation name. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - The invocation name is used to activate background commands. The invocation name can be same as the application name or any other phrase. - For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample". - In order to activate the background command, users can say "Tizen Sample, Play music". The invocation name is dependent on the current language. - For example, if the current language is "en_US"(English), the invocation name is also "en_US". - If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized. - This function should be called before the SetCommandList(). - - Invocation name to be invoked by an application. - This exception can be due to an invalid state. - This exception can be due to an invalid parameter. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - - - Initializes the voice control. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to operation failed. - This exception can be due to out Of memory. - This exception can be due to not supported. - This exception can be due to permission denied. - - The state will be initialized. - - - - - Deinitializes the voice control. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to an invalid state. - This exception can be due to operation failed. - This exception can be due to not supported. - This exception can be due to permission denied. - - - - Connects the voice control service. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to an invalid state. - This exception can be due to operation failed. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be initialized.
-
- - The state must be ready. - - - - - Disconnects the voice control service. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to an invalid state. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - The state must be initialized. - - - - - Retrieves all the supported languages. - A language is specified as an ISO 3166 alpha-2 two letter country-code - followed by ISO 639-1 for the two-letter language code. - For example, "ko_KR" for Korean, "en_US" for American English. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to an invalid state. - This exception can be due to operation failed. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready or initialized.
-
- - - - Gets the system command list. - - 3 - - The command list, else null in case of no system commands. - - - http://tizen.org/privilege/recorder - - - public. - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - In the system command list, there are system commands predefined by product manufacturers. - Those commands have the highest priority. Therefore, the user cannot set any commands similar to system commands. - - This exception can be due to an invalid state. - This exception can be due to operation failed. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - - - Requests to start the dialogue. - By using this function, the developer can start requesting the dialogue to the framework. - When the developer requests the dialogue, two types of texts, dispText and uttText can be sent by this function. dispText is a text for displaying and uttText is that for uttering. - For example, if dispText is "October 10th" and uttText is "Today is October 10th.", "October 10th" will be displayed on the screen and "Today is October 10th." will be spoken. - Also, the developer can set whether the dialogue starts automatically or not, using autoStart. - If the developer sets autoStart as True, the framework will start to record the next speech and continue the dialogue. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - If autoStart is True, the recognition will start again. In this case, it can be restarted up to 4 times. - - Text to be displayed on the screen. - Text to be spoken. - A variable for setting whether the dialog session will be restarted automatically or not. - This exception can be due to an invalid state. - This exception can be due to an invalid parameter. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - - - Sets the command list. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - - The command type is valid for CommandType 'Foreground' or 'Background'. - The matched commands of the command list should be set and they should include type and command text at least. - - Command list - Command type - This exception can be due to an invalid state. - This exception can be due to an invalid parameter. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state must be ready.
-
- - - - Unsets the command list. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - Command type - This exception can be due to an invalid state. - This exception can be due to an invalid parameter. - This exception can be due to not supported. - This exception can be due to permission denied. - 
-            The state should be ready.
-
- - - - Gets the recognition result. - - 3 - - http://tizen.org/privilege/recorder - - - public - - - http://tizen.org/feature/speech.control - http://tizen.org/feature/microphone - - This exception can be due to an invalid state. - This exception can be due to an invalid parameter. - This exception can be due to not supported. - The recognition result if possible, else a null object. - 
-            The state must be ready.
-
- - - - Event to be invoked when the recognition is done. - - 3 - 
-            The state must be initialized.
-
- - - - Event to be invoked when the VoiceControl service state changes. - - 3 - 
-            The state must be initialized.
-
- - - - Event to be invoked when the VoiceControl client state changes. - - 3 - 
-            The state must be initialized.
-
- - - - Event to be invoked when an error occurs. - - 3 - 
-            The state must be initialized.
-
- - - - Event to be invoked when the default language changes. - - 3 - 
-            The state must be initialized.
-
- - - + + + + Tizen.Uix.VoiceControl + + + + + Partial interop class. + + + Partial interop class. + + + Partial interop class. + + + + + Partial libraries class. + + + + + VoiceControl interop class. + + + + + + + + + + + + + + + + + + + + + + + VoiceControlCommand interop class. + + + + + This class holds information about the CurrentLanguageChanged event. + + 3 + + + + The previous language. + + 3 + + + + The current language. + + 3 + + + + This class holds information related to the VoiceControl ErrorOccured event. + + 3 + + + + The error value. + + 3 + + + + The recognition result from the engine. + If the duplicated commands are recognized, the event(e.g. Result.Rejected) of a command may be rejected + for selecting the command as a priority. If you set similar or same commands, or the recognized results are multi-results, the CommandList has multi commands. + + 3 + + + + The result event. + + 3 + + + + The spoken text. + + 3 + + + + The recognized command list. + + 3 + + + + The recognition result from the engine. + + 3 + + + + Gets the recognition result. + + 3 + + + + This class holds information related to the VoiceControl service ServiceStateChanged event. + + 3 + + + + The previous state. + + 3 + + + + The current state. + + 3 + + + + This class holds information related to the VoiceControl client StateChanged event. + + 3 + + + + The previous state. + + 3 + + + + The current state. + + 3 + + + + Enumeration for the command format. + + 3 + + + + The fixed command format. + + + + + The fixed and variable fixed command format. + + + + + The variable fixed and fixed command format. + + + + + The fixed and non-fixed command format. + + + + + The non-fixed and fixed command format. + + + + + Undefined. + + + + + This class represents a voice command. + + 3 + + + + The public constructor. + + 3 + This exception can be due to an invalid state. + This exception can be due to out Of memory. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Gets the unfixed command. + This property should be used for commands which have non-fixed format. + An empty string will be returned in case of some internal error. + + 3 + + + + Gets or sets the command type. + + 3 + If you do not set the command type, the default value is undefined. You should set the type if the command is valid. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Gets or sets the command format. + + 3 + The default format is Fixed. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Gets or sets the command. + A get empty string will be returned in case of some internal error. + + 3 + This exception can be due to permission denied. + This exception can be due to not supported. + + + + This class represents a list of the voice commands. + + 3 + + + + The public constructor. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to out of memory. + This exception can be due to an invalid parameter. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Gets a command count of the list. + -1 is returned in case of an internal failure. + + 3 + + Command count of the list. + + + http://tizen.org/privilege/recorder + + + public + + + + + Gets the current command from the command list by index. + Null will be returned in case of an empty list. + + 3 + + Current command from the command list. + + + http://tizen.org/privilege/recorder + + + public + + + + + Adds a command to the command list. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + The command + This exception can be due to permission denied. + This exception can be due to not supported. + This will occur if the provided parameter is null. + + + + Removes a command from the command list. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + The command + This exception can be due to permission denied. + This exception can be due to not supported. + This will occur if the provided parameter is null. + + + + Retrieves all commands from the command list. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Moves an index to the first command. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to list empty. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Moves an index to the last command. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to list empty. + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Moves an index to the next command. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. List empty + 2. List reached end + + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Moves an index to the previous command. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + This exception can be due to the following reasons: + 1. List empty + 2. List reached end + + This exception can be due to permission denied. + This exception can be due to not supported. + + + + Enumeration for the error values that can occur. + + 3 + + + + Successful, no error. + + + + + Out of memory. + + + + + I/O error. + + + + + Invalid parameter. + + + + + No answer from the STT service. + + + + + Device or resource busy. + + + + + Permission denied. + + + + + VC NOT supported. + + + + + Invalid state. + + + + + Invalid language. + + + + + No available engine. + + + + + Operation failed. + + + + + Operation rejected. + + + + + List reached end. + + + + + List empty. + + + + + Service reset. + + + + + Progress to ready is not finished. + + + + + Progress to recording is not finished. + + + + + Progress to processing is not finished. + + + + + Enumeration for the client state. + + 3 + + + + 'None' state. + + + + + 'Initialized' state. + + + + + 'Ready' state. + + + + + The state cannot be determined. + + + + + Enumeration for the service state. + + 3 + + + + 'None' state. + + + + + 'Ready' state. + + + + + 'Recording' state. + + + + + 'Processing' state. + + + + + The state cannot be determined. + + + + + Enumeration for the result event. + + 3 + + + + Normal result. + + + + + Rejected result. + + + + + Enumeration for the command type. + + 3 + + + + Foreground command by the client. + + + + + Background command by the client. + + + + + The undefined command. + + + + + A main function of the voice control API registers the command and gets a notification for the recognition result. + Applications can add their own commands and provide results when their command is recognized by the user voice input. + + 3 + + + + Gets the current language. + A language is specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English. + An empty string is returned in case of some internal error. + + 3 + + The current language in voice control. + + + http://tizen.org/privilege/recorder + + 
+            The state must be initialized or ready.
+
+ + + + Gets the current state of the voice control client. + + 3 + + The current state of the voice control client. + + + http://tizen.org/privilege/recorder + + 
+            The state must be initialized or ready.
+
+ + + + Gets the current state of the voice control service. + + 3 + + The current state of the voice control service. + + + http://tizen.org/privilege/recorder + + 
+            The state must be ready.
+
+ + + + Sets the invocation name. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + The invocation name is used to activate background commands. The invocation name can be same as the application name or any other phrase. + For example, an application "Tizen Sample" has a background command, "Play music", and the invocation name of the application is set to "Tizen Sample". + In order to activate the background command, users can say "Tizen Sample, Play music". The invocation name is dependent on the current language. + For example, if the current language is "en_US"(English), the invocation name is also "en_US". + If the current language is "ja_JP"(Japanese) and the invocation name is "en_US", the invocation name will not be recognized. + This function should be called before the SetCommandList(). + + Invocation name to be invoked by an application. + This exception can be due to an invalid state. + This exception can be due to an invalid parameter. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + + + Initializes the voice control. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to operation failed. + This exception can be due to out Of memory. + This exception can be due to not supported. + This exception can be due to permission denied. + + The state will be initialized. + + + + + Deinitializes the voice control. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to an invalid state. + This exception can be due to operation failed. + This exception can be due to not supported. + This exception can be due to permission denied. + + + + Connects the voice control service. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to an invalid state. + This exception can be due to operation failed. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be initialized.
+
+ + The state must be ready. + + + + + Disconnects the voice control service. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to an invalid state. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + The state must be initialized. + + + + + Retrieves all the supported languages. + A language is specified as an ISO 3166 alpha-2 two letter country-code + followed by ISO 639-1 for the two-letter language code. + For example, "ko_KR" for Korean, "en_US" for American English. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to an invalid state. + This exception can be due to operation failed. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready or initialized.
+
+ + + + Gets the system command list. + + 3 + + The command list, else null in case of no system commands. + + + http://tizen.org/privilege/recorder + + + public. + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + In the system command list, there are system commands predefined by product manufacturers. + Those commands have the highest priority. Therefore, the user cannot set any commands similar to system commands. + + This exception can be due to an invalid state. + This exception can be due to operation failed. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + + + Requests to start the dialogue. + By using this function, the developer can start requesting the dialogue to the framework. + When the developer requests the dialogue, two types of texts, dispText and uttText can be sent by this function. dispText is a text for displaying and uttText is that for uttering. + For example, if dispText is "October 10th" and uttText is "Today is October 10th.", "October 10th" will be displayed on the screen and "Today is October 10th." will be spoken. + Also, the developer can set whether the dialogue starts automatically or not, using autoStart. + If the developer sets autoStart as True, the framework will start to record the next speech and continue the dialogue. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + If autoStart is True, the recognition will start again. In this case, it can be restarted up to 4 times. + + Text to be displayed on the screen. + Text to be spoken. + A variable for setting whether the dialog session will be restarted automatically or not. + This exception can be due to an invalid state. + This exception can be due to an invalid parameter. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + + + Sets the command list. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + + The command type is valid for CommandType 'Foreground' or 'Background'. + The matched commands of the command list should be set and they should include type and command text at least. + + Command list + Command type + This exception can be due to an invalid state. + This exception can be due to an invalid parameter. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state must be ready.
+
+ + + + Unsets the command list. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + Command type + This exception can be due to an invalid state. + This exception can be due to an invalid parameter. + This exception can be due to not supported. + This exception can be due to permission denied. + 
+            The state should be ready.
+
+ + + + Gets the recognition result. + + 3 + + http://tizen.org/privilege/recorder + + + public + + + http://tizen.org/feature/speech.control + http://tizen.org/feature/microphone + + This exception can be due to an invalid state. + This exception can be due to an invalid parameter. + This exception can be due to not supported. + The recognition result if possible, else a null object. + 
+            The state must be ready.
+
+ + + + Event to be invoked when the recognition is done. + + 3 + 
+            The state must be initialized.
+
+ + + + Event to be invoked when the VoiceControl service state changes. + + 3 + 
+            The state must be initialized.
+
+ + + + Event to be invoked when the VoiceControl client state changes. + + 3 + 
+            The state must be initialized.
+
+ + + + Event to be invoked when an error occurs. + + 3 + 
+            The state must be initialized.
+
+ + + + Event to be invoked when the default language changes. + + 3 + 
+            The state must be initialized.
+
+ + + diff --git a/Artifacts/bin/Tizen.WebView.dll b/Artifacts/bin/Tizen.WebView.dll index 7aea2e8..a728438 100644 Binary files a/Artifacts/bin/Tizen.WebView.dll and b/Artifacts/bin/Tizen.WebView.dll differ diff --git a/Artifacts/bin/Tizen.WebView.pdb b/Artifacts/bin/Tizen.WebView.pdb index 0478261..7bf11bb 100644 Binary files a/Artifacts/bin/Tizen.WebView.pdb and b/Artifacts/bin/Tizen.WebView.pdb differ diff --git a/Artifacts/bin/Tizen.WebView.xml b/Artifacts/bin/Tizen.WebView.xml index bafe179..014cfa9 100644 --- a/Artifacts/bin/Tizen.WebView.xml +++ b/Artifacts/bin/Tizen.WebView.xml @@ -1,405 +1,405 @@ - - - - Tizen.WebView - - - - - Initializes Chromium's instance - - A reference count of Chromium's instance - - - - Decreases a reference count of WebKit's instance, possibly destroying it - - A reference count of Chromium's instance - - - - Enumeration that contains option for cache model. - - - - - The cache model. - - - The default cache model is DocumentViewer. - - - - - Gets the CookieManager object for this context. - - The CookieManager object - - - - Enumeration that contains accept policies for the cookies. - - - - - Enumeration that creates a type name for the storage of persistent cookies. - - - - - Sets the cookie acceptance policy. - - - By default, only cookies set by the main document loaded are accepted. - - The cookie acceptance policy - - - - Deletes all the cookies. - - - - - Sets the storage where non-session cookies are stored persistently to read/write the cookies. - - - http://tizen.org/privilege/mediastorage - http://tizen.org/privilege/externalstorage - - The path where to read/write Cookies - The type of storage - - - - A Script message contains information that sent from JavaScript runtime. - - - - - Obect name in JavaScript. - - - - - Gets the value of body as integer type. - - The value of body as integer type - - - - Gets the value of body as double type. - - The value of body as double type - - - - Gets the value of body as boolean type. - - The value of body as boolean type - - - - Gets the value of body as string type. - - The value of body as string type - - - - Whether JavaScript can be executable. - - - - - Whether images can be loaded automatically. - - - - - The default text encoding name. - - - - - The default font size of a pixel. - - - - - Argument from the SmartCallback. - - - - - Gets argument as integer type. - - Argument as integer type - - - - Gets argument as double type. - - Argument as double type - - - - Gets argument as boolean type. - - Argument as boolean type - - - - Gets argument as string type. - - Argument as string type - - - - Enumeration that provides an option to error codes. - - - - - Unknown - - - - - User canceled - - - - - Can't show page for this MIME Type - - - - - File IO error - - - - - Cannot connect to network - - - - - Fail to look up host from DNS - - - - - Fail to SSL/TLS handshake - - - - - Received certificate is invalid - - - - - Connection timeout - - - - - Too many redirects - - - - - Too many requests during this load - - - - - Malformed url - - - - - Unsupported scheme - - - - - User authentication failed on server - - - - - Web server has internal server error - - - - - Argument from the LoadError SmartCallback. - - - - - Failing URL for the error. - - - - - The error code. - - - - - The description for the error. - - - - - Whether the error should be treated as a cancellation. - - - - - A view used to render web contents. - - - - - Event that occurs when load started. - - - - - Event that occurs when load finished. - - - - - Event that occurs when load error. - - - - - Event that occurs when title of main frame was changed. - - - - - Event that occurs when URL of main frame was changed. - - - - - Current URL of the main frame. - - - - - Current title of the main frame. - - - - - Current user agent string of this view. - - - - - Whether a view has the focus. - - - - - Create a WebView object. - - Parent object of WebView - - - - Gets the Context object of this view. - - The Context object of this view - - - - Gets the Settings object of this view. - - The Settings object of this view - - - - Asks the object to load the given URL. - - - You can only be sure that url changed after UrlChanged event. - - The uniform resource identifier to load - - - - Loads the specified html string as the content of the view. - - HTML data to load - Base URL used for relative paths to external objects - - - - Asks the main frame to stop loading. - - - - - Asks the main frame to reload the current document. - - - - - Asks the main frame to navigate back in history. - - - - - Asks the main frame to navigate forward in history. - - - - - Checks whether it is possible to navigate backwards one item in history. - - Whether it is possible to navigate backwards one item in history - - - - Checks whether it is possible to navigate forwards one item in history. - - Whether it is possible to navigate forwards one item in history - - - - Injects the supplied javascript message handler into the view. - - The message callback - The name used to expose the object in JavaScript - 'true' on success, otherwise 'false' - - - - Requests the execution of given name and result to the JavaScript runtime. - - The name used to expose the object in JavaScript - The result to the JavaScript runtime - - - - Requests the execution of the given script. - - The JavaScript code string to execute - - - - Requests to set or unset a view as the currently focused one. - - 'true' to set the focus on the view, 'false' to remove the focus from the view - - - + + + + Tizen.WebView + + + + + Initializes Chromium's instance + + A reference count of Chromium's instance + + + + Decreases a reference count of WebKit's instance, possibly destroying it + + A reference count of Chromium's instance + + + + Enumeration that contains option for cache model. + + + + + The cache model. + + + The default cache model is DocumentViewer. + + + + + Gets the CookieManager object for this context. + + The CookieManager object + + + + Enumeration that contains accept policies for the cookies. + + + + + Enumeration that creates a type name for the storage of persistent cookies. + + + + + Sets the cookie acceptance policy. + + + By default, only cookies set by the main document loaded are accepted. + + The cookie acceptance policy + + + + Deletes all the cookies. + + + + + Sets the storage where non-session cookies are stored persistently to read/write the cookies. + + + http://tizen.org/privilege/mediastorage + http://tizen.org/privilege/externalstorage + + The path where to read/write Cookies + The type of storage + + + + A Script message contains information that sent from JavaScript runtime. + + + + + Obect name in JavaScript. + + + + + Gets the value of body as integer type. + + The value of body as integer type + + + + Gets the value of body as double type. + + The value of body as double type + + + + Gets the value of body as boolean type. + + The value of body as boolean type + + + + Gets the value of body as string type. + + The value of body as string type + + + + Whether JavaScript can be executable. + + + + + Whether images can be loaded automatically. + + + + + The default text encoding name. + + + + + The default font size of a pixel. + + + + + Argument from the SmartCallback. + + + + + Gets argument as integer type. + + Argument as integer type + + + + Gets argument as double type. + + Argument as double type + + + + Gets argument as boolean type. + + Argument as boolean type + + + + Gets argument as string type. + + Argument as string type + + + + Enumeration that provides an option to error codes. + + + + + Unknown + + + + + User canceled + + + + + Can't show page for this MIME Type + + + + + File IO error + + + + + Cannot connect to network + + + + + Fail to look up host from DNS + + + + + Fail to SSL/TLS handshake + + + + + Received certificate is invalid + + + + + Connection timeout + + + + + Too many redirects + + + + + Too many requests during this load + + + + + Malformed url + + + + + Unsupported scheme + + + + + User authentication failed on server + + + + + Web server has internal server error + + + + + Argument from the LoadError SmartCallback. + + + + + Failing URL for the error. + + + + + The error code. + + + + + The description for the error. + + + + + Whether the error should be treated as a cancellation. + + + + + A view used to render web contents. + + + + + Event that occurs when load started. + + + + + Event that occurs when load finished. + + + + + Event that occurs when load error. + + + + + Event that occurs when title of main frame was changed. + + + + + Event that occurs when URL of main frame was changed. + + + + + Current URL of the main frame. + + + + + Current title of the main frame. + + + + + Current user agent string of this view. + + + + + Whether a view has the focus. + + + + + Create a WebView object. + + Parent object of WebView + + + + Gets the Context object of this view. + + The Context object of this view + + + + Gets the Settings object of this view. + + The Settings object of this view + + + + Asks the object to load the given URL. + + + You can only be sure that url changed after UrlChanged event. + + The uniform resource identifier to load + + + + Loads the specified html string as the content of the view. + + HTML data to load + Base URL used for relative paths to external objects + + + + Asks the main frame to stop loading. + + + + + Asks the main frame to reload the current document. + + + + + Asks the main frame to navigate back in history. + + + + + Asks the main frame to navigate forward in history. + + + + + Checks whether it is possible to navigate backwards one item in history. + + Whether it is possible to navigate backwards one item in history + + + + Checks whether it is possible to navigate forwards one item in history. + + Whether it is possible to navigate forwards one item in history + + + + Injects the supplied javascript message handler into the view. + + The message callback + The name used to expose the object in JavaScript + 'true' on success, otherwise 'false' + + + + Requests the execution of given name and result to the JavaScript runtime. + + The name used to expose the object in JavaScript + The result to the JavaScript runtime + + + + Requests the execution of the given script. + + The JavaScript code string to execute + + + + Requests to set or unset a view as the currently focused one. + + 'true' to set the focus on the view, 'false' to remove the focus from the view + + + diff --git a/Artifacts/bin/Tizen.dll b/Artifacts/bin/Tizen.dll index 2b47bcc..d6b1f10 100644 Binary files a/Artifacts/bin/Tizen.dll and b/Artifacts/bin/Tizen.dll differ diff --git a/Artifacts/bin/Tizen.pdb b/Artifacts/bin/Tizen.pdb index 4670125..267f660 100644 Binary files a/Artifacts/bin/Tizen.pdb and b/Artifacts/bin/Tizen.pdb differ diff --git a/Artifacts/bin/Tizen.xml b/Artifacts/bin/Tizen.xml index 70547f0..28a9f9a 100644 --- a/Artifacts/bin/Tizen.xml +++ b/Artifacts/bin/Tizen.xml @@ -1,247 +1,247 @@ - - - - Tizen - - - - - Structure that represents a color as RGBA. - - - - - Empty color instance. All components are 0. - - - - - Transparent color instance. All components are 0. - - - - - Aqua color instance. Its RGB value is (0, 255, 255). - - - - - Black color instance. Its RGB value is (0, 0, 0). - - - - - Blue color instance. Its RGB value is (0, 0, 255). - - - - - Fuchsia color instance. Its RGB value is (255, 0, 255). - - - - - Gray color instance. Its RGB value is (128, 128, 128). - - - - - Green color instance. Its RGB value is (0, 128, 0). - - - - - Lime color instance. Its RGB value is (0, 255, 0). - - - - - Maroon color instance. Its RGB value is (128, 0, 0). - - - - - Navy color instance. Its RGB value is (0, 0, 128). - - - - - Olive color instance. Its RGB value is (128, 128, 0). - - - - - Purple color instance. Its RGB value is (128, 0, 128). - - - - - Pink color instance. Its RGB value is (255, 102, 255). - - - - - Red color instance. Its RGB value is (255, 0, 0). - - - - - Silver color instance. Its RGB value is (192, 192, 192). - - - - - Teal color instance. Its RGB value is (0, 128, 128). - - - - - White color instance. Its RGB value is (255, 255, 255). - - - - - Yellow color instance. Its RGB value is (255, 255, 0). - - - - - Initiates new Color with r,g,b,a components. - - Red (0 ~ 255) - Green (0 ~ 255) - Blue (0 ~ 255) - Alpha (0 ~ 255) - - - - Initiates new Color with r,g,b components. The alpha value will be 255 as default. - - Red (0 ~ 255) - Green (0 ~ 255) - Blue (0 ~ 255) - - - - Gets the Red component of the color. - - - - - Gets the Green component of the color. - - - - - Gets the blue component of the color. - - - - - Gets the alpha component of the color. - - - - - Returns a boolean indicating whether the two given Colors are equal. - - The first Color to compare. - The second Color to compare. - True if the Colors are equal; False otherwise. - - - - Returns a boolean indicating whether the two given Colors are not equal. - - The first Color to compare. - The second Color to compare. - True if the Colors are not equal; False if they are equal. - - - - Returns a new RGB color instance. - - The red component of the color. - The green component of the color. - The blue component of the color. - - - - - Returns a new RGBA color instance. - - The red component of the color. - The green component of the color. - The blue component of the color. - The alpha component of the color. - the RGBA color instance. - - - - Returns a new RGB Color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one. - - A string that contains the hexadecimal RGB(A) color representation. - the RGBA color instance. - - - - Gets the 32-bits RGBA value of the color. - - - - - Gets the 32-bits ARGB value of the color. - - - - - Returns a string representation in Hex. (ex: \#FFFFFFFF in RGBA order) - - The string representation in Hex. - - - - Returns a boolean indicating whether the given Color is equal to this Color instance. - - The Color to compare this instance to. - True if the other Color is equal to this instance; False otherwise. - - - - Returns a boolean indicating whether the given Object is equal to this Color instance. - - The Object to compare against. - True if the Object is equal to this Color; False otherwise. - - - - Returns a string representation of the Color. - - The string representation. - - - - Returns the hash code for this instance. - - The hash code. - - - - - - - - - - - - - - - - - - - - - + + + + Tizen + + + + + Structure that represents a color as RGBA. + + + + + Empty color instance. All components are 0. + + + + + Transparent color instance. All components are 0. + + + + + Aqua color instance. Its RGB value is (0, 255, 255). + + + + + Black color instance. Its RGB value is (0, 0, 0). + + + + + Blue color instance. Its RGB value is (0, 0, 255). + + + + + Fuchsia color instance. Its RGB value is (255, 0, 255). + + + + + Gray color instance. Its RGB value is (128, 128, 128). + + + + + Green color instance. Its RGB value is (0, 128, 0). + + + + + Lime color instance. Its RGB value is (0, 255, 0). + + + + + Maroon color instance. Its RGB value is (128, 0, 0). + + + + + Navy color instance. Its RGB value is (0, 0, 128). + + + + + Olive color instance. Its RGB value is (128, 128, 0). + + + + + Purple color instance. Its RGB value is (128, 0, 128). + + + + + Pink color instance. Its RGB value is (255, 102, 255). + + + + + Red color instance. Its RGB value is (255, 0, 0). + + + + + Silver color instance. Its RGB value is (192, 192, 192). + + + + + Teal color instance. Its RGB value is (0, 128, 128). + + + + + White color instance. Its RGB value is (255, 255, 255). + + + + + Yellow color instance. Its RGB value is (255, 255, 0). + + + + + Initiates new Color with r,g,b,a components. + + Red (0 ~ 255) + Green (0 ~ 255) + Blue (0 ~ 255) + Alpha (0 ~ 255) + + + + Initiates new Color with r,g,b components. The alpha value will be 255 as default. + + Red (0 ~ 255) + Green (0 ~ 255) + Blue (0 ~ 255) + + + + Gets the Red component of the color. + + + + + Gets the Green component of the color. + + + + + Gets the blue component of the color. + + + + + Gets the alpha component of the color. + + + + + Returns a boolean indicating whether the two given Colors are equal. + + The first Color to compare. + The second Color to compare. + True if the Colors are equal; False otherwise. + + + + Returns a boolean indicating whether the two given Colors are not equal. + + The first Color to compare. + The second Color to compare. + True if the Colors are not equal; False if they are equal. + + + + Returns a new RGB color instance. + + The red component of the color. + The green component of the color. + The blue component of the color. + + + + + Returns a new RGBA color instance. + + The red component of the color. + The green component of the color. + The blue component of the color. + The alpha component of the color. + the RGBA color instance. + + + + Returns a new RGB Color instance with the requested Red, Green, and Blue channels. The Alpha channel is set if hex contains one. + + A string that contains the hexadecimal RGB(A) color representation. + the RGBA color instance. + + + + Gets the 32-bits RGBA value of the color. + + + + + Gets the 32-bits ARGB value of the color. + + + + + Returns a string representation in Hex. (ex: \#FFFFFFFF in RGBA order) + + The string representation in Hex. + + + + Returns a boolean indicating whether the given Color is equal to this Color instance. + + The Color to compare this instance to. + True if the other Color is equal to this instance; False otherwise. + + + + Returns a boolean indicating whether the given Object is equal to this Color instance. + + The Object to compare against. + True if the Object is equal to this Color; False otherwise. + + + + Returns a string representation of the Color. + + The string representation. + + + + Returns the hash code for this instance. + + The hash code. + + + + + + + + + + + + + + + + + + + + + diff --git a/Artifacts/bin/res/maps_marker_pin_48.png b/Artifacts/bin/res/maps_marker_pin_48.png old mode 100644 new mode 100755 diff --git a/Artifacts/bin/res/maps_marker_pin_72.png b/Artifacts/bin/res/maps_marker_pin_72.png old mode 100644 new mode 100755 diff --git a/Artifacts/bin/res/maps_marker_sticker_48.png b/Artifacts/bin/res/maps_marker_sticker_48.png old mode 100644 new mode 100755 diff --git a/Artifacts/bin/res/maps_marker_sticker_72.png b/Artifacts/bin/res/maps_marker_sticker_72.png old mode 100644 new mode 100755 diff --git a/Artifacts/bin_dummy/Tizen.Account.AccountManager.dll b/Artifacts/bin_dummy/Tizen.Account.AccountManager.dll index 4ba8a29..18df893 100644 Binary files a/Artifacts/bin_dummy/Tizen.Account.AccountManager.dll and b/Artifacts/bin_dummy/Tizen.Account.AccountManager.dll differ diff --git a/Artifacts/bin_dummy/Tizen.Account.SyncManager.dll b/Artifacts/bin_dummy/Tizen.Account.SyncManager.dll new file mode 100644 index 0000000..bb902bd Binary files /dev/null and b/Artifacts/bin_dummy/Tizen.Account.SyncManager.dll differ diff --git a/packaging/csapi-tizenfx.spec b/packaging/csapi-tizenfx.spec index fdb85fb..8702ac6 100644 --- a/packaging/csapi-tizenfx.spec +++ b/packaging/csapi-tizenfx.spec @@ -10,7 +10,7 @@ Name: csapi-tizenfx Summary: Assemblies of Tizen .NET -Version: 4.0.0.134 +Version: 4.0.0.138 Release: 1 Group: Development/Libraries License: Apache-2.0 diff --git a/pkg/PlatformFileList.txt b/pkg/PlatformFileList.txt index 8d6ac20..d98f125 100644 --- a/pkg/PlatformFileList.txt +++ b/pkg/PlatformFileList.txt @@ -7,6 +7,7 @@ res/maps_marker_sticker_72.png #mobile #mobile-emul #tv Tizen.Account.AccountManager.dll #mobile #mobile-emul #ivi #wearable Tizen.Account.FidoClient.dll #mobile #mobile-emul #wearable Tizen.Account.OAuth2.dll #mobile #mobile-emul #ivi #wearable +Tizen.Account.SyncManager.dll #mobile #mobile-emul #wearable Tizen.Applications.Alarm.dll #common #mobile #mobile-emul #tv #ivi #wearable Tizen.Applications.AttachPanel.dll #mobile #mobile-emul Tizen.Applications.Badge.dll #mobile #mobile-emul #ivi @@ -35,7 +36,7 @@ Tizen.Location.Geofence.dll #mobile #mobile-emul Tizen.Log.dll #common #mobile #mobile-emul #tv #ivi #wearable Tizen.Maps.dll #mobile #mobile-emul #tv #wearable Tizen.Messaging.dll #mobile #mobile-emul #wearable -Tizen.Messaging.Push.dll #mobile #mobile-emul #tv #ivi +Tizen.Messaging.Push.dll #common #mobile #mobile-emul #tv #ivi #wearable Tizen.Multimedia.AudioIO.dll #common #mobile #mobile-emul #tv #ivi #wearable Tizen.Multimedia.Camera.dll #common #mobile #mobile-emul #tv #ivi Tizen.Multimedia.dll #common #mobile #mobile-emul #tv #ivi #wearable diff --git a/pkg/Tizen.NET.Private.sln b/pkg/Tizen.NET.Private.sln index c4448d0..8a6f048 100644 --- a/pkg/Tizen.NET.Private.sln +++ b/pkg/Tizen.NET.Private.sln @@ -13,6 +13,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tizen.Account.FidoClient", EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tizen.Account.OAuth2", "..\src\Tizen.Account.OAuth2\Tizen.Account.OAuth2.csproj", "{CDBB2633-FE0B-485E-B864-DCA9240E6F7D}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tizen.Account.SyncManager", "..\src\Tizen.Account.SyncManager\Tizen.Account.SyncManager.csproj", "{219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}" +EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tizen.Applications.Alarm", "..\src\Tizen.Applications.Alarm\Tizen.Applications.Alarm.csproj", "{6B8722E8-94A4-4739-B0E3-14F1B158BC81}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tizen.Applications.AttachPanel", "..\src\Tizen.Applications.AttachPanel\Tizen.Applications.AttachPanel.csproj", "{3BACD1BC-613C-4A68-87F2-789B5937FBF6}" @@ -240,6 +242,18 @@ Global {CDBB2633-FE0B-485E-B864-DCA9240E6F7D}.Release|x64.Build.0 = Release|x64 {CDBB2633-FE0B-485E-B864-DCA9240E6F7D}.Release|x86.ActiveCfg = Release|x86 {CDBB2633-FE0B-485E-B864-DCA9240E6F7D}.Release|x86.Build.0 = Release|x86 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|x64.ActiveCfg = Debug|x64 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|x64.Build.0 = Debug|x64 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|x86.ActiveCfg = Debug|x86 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Debug|x86.Build.0 = Debug|x86 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|Any CPU.ActiveCfg = Release|Any CPU + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|Any CPU.Build.0 = Release|Any CPU + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|x64.ActiveCfg = Release|x64 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|x64.Build.0 = Release|x64 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|x86.ActiveCfg = Release|x86 + {219B1BF6-E17C-42BC-82A3-7B0C81E23AA6}.Release|x86.Build.0 = Release|x86 {6B8722E8-94A4-4739-B0E3-14F1B158BC81}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {6B8722E8-94A4-4739-B0E3-14F1B158BC81}.Debug|Any CPU.Build.0 = Debug|Any CPU {6B8722E8-94A4-4739-B0E3-14F1B158BC81}.Debug|x64.ActiveCfg = Debug|x64 diff --git a/pkg/Tizen.NET.nuspec b/pkg/Tizen.NET.nuspec index dcd0a80..a34c60d 100644 --- a/pkg/Tizen.NET.nuspec +++ b/pkg/Tizen.NET.nuspec @@ -22,6 +22,9 @@ + + + diff --git a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs old mode 100644 new mode 100755 index 8cf026c..5347948 --- a/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs +++ b/src/ElmSharp.Wearable/ElmSharp.Wearable/CircleSlider.cs @@ -23,6 +23,9 @@ namespace ElmSharp.Wearable /// public class CircleSlider : EvasObject { + /// + /// Changed will be triggered when the circle slider value changes. + /// public event EventHandler Changed; SmartEvent _changedEvent; diff --git a/src/Tizen.Account.AccountManager/Interop/Interop.Account.cs b/src/Tizen.Account.AccountManager/Interop/Interop.Account.cs index 9789044..90489bc 100644 --- a/src/Tizen.Account.AccountManager/Interop/Interop.Account.cs +++ b/src/Tizen.Account.AccountManager/Interop/Interop.Account.cs @@ -18,127 +18,128 @@ using System; using System.Runtime.InteropServices; using Tizen.Account.AccountManager; /// -/// Interop for Account class APIs +/// Interop for Account class APIs. /// /// 3 internal static partial class Interop { /// - /// Interop for Account class APIs + /// Interop for Account class APIs. /// /// 3 internal static partial class Account { [DllImport(Libraries.AccountSvc, EntryPoint = "account_create", CallingConvention = CallingConvention.Cdecl)] - internal static extern int Create(out IntPtr handle); + internal static extern int Create(out SafeAccountHandle handle); + [DllImport(Libraries.AccountSvc, EntryPoint = "account_destroy", CallingConvention = CallingConvention.Cdecl)] internal static extern int Destroy(IntPtr handle); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_account_id", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountId(IntPtr data, out int accountId); + internal static extern int GetAccountId(SafeAccountHandle data, out int accountId); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_user_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountUserName(IntPtr data, out string userName); + internal static extern int GetAccountUserName(SafeAccountHandle data, out string userName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_user_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountUserName(IntPtr handle, string userName); + internal static extern int SetAccountUserName(SafeAccountHandle handle, string userName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_display_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountDisplayName(IntPtr handle, out string displayName); + internal static extern int GetAccountDisplayName(SafeAccountHandle handle, out string displayName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_display_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountDisplayName(IntPtr handle, string displayName); + internal static extern int SetAccountDisplayName(SafeAccountHandle handle, string displayName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_capability", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountCapability(IntPtr handle, string capabilityType, out int capabilityValue); + internal static extern int GetAccountCapability(SafeAccountHandle handle, string capabilityType, out int capabilityValue); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_capability", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountCapability(IntPtr handle, string capabilityType, int capabilityValue); + internal static extern int SetAccountCapability(SafeAccountHandle handle, string capabilityType, int capabilityValue); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_icon_path", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountIconPath(IntPtr handle, out string iconPath); + internal static extern int GetAccountIconPath(SafeAccountHandle handle, out string iconPath); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_icon_path", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountIconPath(IntPtr handle, string iconPath); + internal static extern int SetAccountIconPath(SafeAccountHandle handle, string iconPath); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_domain_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountDomainName(IntPtr handle, out string domainName); + internal static extern int GetAccountDomainName(SafeAccountHandle handle, out string domainName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_domain_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountDomainName(IntPtr handle, string domainName); + internal static extern int SetAccountDomainName(SafeAccountHandle handle, string domainName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_email_address", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountEmail(IntPtr handle, out string email); + internal static extern int GetAccountEmail(SafeAccountHandle handle, out string email); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_email_address", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountEmail(IntPtr handle, string email); + internal static extern int SetAccountEmail(SafeAccountHandle handle, string email); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_package_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountPackageName(IntPtr handle, out string name); + internal static extern int GetAccountPackageName(SafeAccountHandle handle, out string name); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_package_name", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountPackageName(IntPtr handle, string name); + internal static extern int SetAccountPackageName(SafeAccountHandle handle, string name); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_access_token", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountAccessToken(IntPtr handle, out string accessToken); + internal static extern int GetAccountAccessToken(SafeAccountHandle handle, out string accessToken); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_access_token", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountAccessToken(IntPtr handle, string accessToken); + internal static extern int SetAccountAccessToken(SafeAccountHandle handle, string accessToken); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_user_text", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountUserText(IntPtr handle, int index, out string userText); + internal static extern int GetAccountUserText(SafeAccountHandle handle, int index, out string userText); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_user_text", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountUserText(IntPtr handle, int index, string userText); + internal static extern int SetAccountUserText(SafeAccountHandle handle, int index, string userText); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_user_int", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountUserInt(IntPtr handle, int index, out int value); + internal static extern int GetAccountUserInt(SafeAccountHandle handle, int index, out int value); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_user_int", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountUserInt(IntPtr handle, int index, int value); + internal static extern int SetAccountUserInt(SafeAccountHandle handle, int index, int value); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_auth_type", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountAuthType(IntPtr handle, out int authType); + internal static extern int GetAccountAuthType(SafeAccountHandle handle, out int authType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_auth_type", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountAuthType(IntPtr handle, int authType); + internal static extern int SetAccountAuthType(SafeAccountHandle handle, int authType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_secret", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountSercet(IntPtr handle, out int secretType); + internal static extern int GetAccountSercet(SafeAccountHandle handle, out int secretType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_secret", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountSecret(IntPtr handle, int secretType); + internal static extern int SetAccountSecret(SafeAccountHandle handle, int secretType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_sync_support", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountSyncSupport(IntPtr handle, out int syncType); + internal static extern int GetAccountSyncSupport(SafeAccountHandle handle, out int syncType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_sync_support", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountSyncSupport(IntPtr handle, int syncType); + internal static extern int SetAccountSyncSupport(SafeAccountHandle handle, int syncType); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_source", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountSource(IntPtr handle, out string source); + internal static extern int GetAccountSource(SafeAccountHandle handle, out string source); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_source", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountSource(IntPtr handle, string source); + internal static extern int SetAccountSource(SafeAccountHandle handle, string source); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_custom", CallingConvention = CallingConvention.Cdecl)] - internal static extern int GetAccountCustomValue(IntPtr handle, string key, out string value); + internal static extern int GetAccountCustomValue(SafeAccountHandle handle, string key, out string value); [DllImport(Libraries.AccountSvc, EntryPoint = "account_set_custom", CallingConvention = CallingConvention.Cdecl)] - internal static extern int SetAccountCustomValue(IntPtr handle, string key, string value); + internal static extern int SetAccountCustomValue(SafeAccountHandle handle, string key, string value); [DllImport(Libraries.AccountSvc, EntryPoint = "account_update_sync_status_by_id", CallingConvention = CallingConvention.Cdecl)] internal static extern int UpdateAccountSyncStatusById(int accountId, int status); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_capability_all")] - internal static extern int GetAllAccountCapabilities(IntPtr handle, AccountCapabilityCallback callback, IntPtr userData); + internal static extern int GetAllAccountCapabilities(SafeAccountHandle handle, AccountCapabilityCallback callback, IntPtr userData); [DllImport(Libraries.AccountSvc, EntryPoint = "account_query_capability_by_account_id")] internal static extern int QueryAccountCapabilityById(AccountCapabilityCallback callback, int accountId, IntPtr userData); [DllImport(Libraries.AccountSvc, EntryPoint = "account_get_custom_all")] - internal static extern int GetAllAccountCustomValues(IntPtr handle, AccountCustomCallback callback, IntPtr userData); + internal static extern int GetAllAccountCustomValues(SafeAccountHandle handle, AccountCustomCallback callback, IntPtr userData); //Callbacks [UnmanagedFunctionPointer(CallingConvention.Cdecl)] diff --git a/src/Tizen.Account.AccountManager/Interop/Interop.AccountProvider.cs b/src/Tizen.Account.AccountManager/Interop/Interop.AccountProvider.cs index f201061..02f6314 100644 --- a/src/Tizen.Account.AccountManager/Interop/Interop.AccountProvider.cs +++ b/src/Tizen.Account.AccountManager/Interop/Interop.AccountProvider.cs @@ -19,13 +19,13 @@ using System.Runtime.InteropServices; using Tizen.Account.AccountManager; /// -/// Interop for AccountProvider class APIs +/// Interop for AccountProvider class APIs. /// /// 3 internal static partial class Interop { /// - /// Interop for AccountProvider class APIs + /// Interop for AccountProvider class APIs. /// /// 3 internal static partial class AccountProvider diff --git a/src/Tizen.Account.AccountManager/Interop/Interop.AccountService.cs b/src/Tizen.Account.AccountManager/Interop/Interop.AccountService.cs index 7bb1275..1995ce0 100644 --- a/src/Tizen.Account.AccountManager/Interop/Interop.AccountService.cs +++ b/src/Tizen.Account.AccountManager/Interop/Interop.AccountService.cs @@ -16,27 +16,28 @@ using System; using System.Runtime.InteropServices; +using Tizen.Account.AccountManager; /// -/// Interop for Account class APIs +/// Interop for Account class APIs. /// /// 3 internal static partial class Interop { /// - /// Interop for Account class APIs + /// Interop for Account class APIs. /// /// 3 internal static partial class AccountService { [DllImport(Libraries.AccountSvc, EntryPoint = "account_update_to_db_by_id", CallingConvention = CallingConvention.Cdecl)] - internal static extern int UpdateAccountToDBById(IntPtr handle, int id); + internal static extern int UpdateAccountToDBById(SafeAccountHandle handle, int id); [DllImport(Libraries.AccountSvc, EntryPoint = "account_update_to_db_by_user_name", CallingConvention = CallingConvention.Cdecl)] internal static extern int UpdateAccountToDBByUserName(IntPtr handle, string userName, string packageName); [DllImport(Libraries.AccountSvc, EntryPoint = "account_query_account_by_account_id", CallingConvention = CallingConvention.Cdecl)] - internal static extern int QueryAccountById(int accountId, out IntPtr handle); + internal static extern int QueryAccountById(int accountId, ref SafeAccountHandle handle); [DllImport(Libraries.AccountSvc, EntryPoint = "account_query_account_by_user_name", CallingConvention = CallingConvention.Cdecl)] internal static extern int QueryAccountByUserName(Interop.Account.AccountCallback callback, string userName, IntPtr userData); @@ -51,7 +52,7 @@ internal static partial class Interop internal static extern int UpdateAccountSyncStatusById(int accoutId, int status); [DllImport(Libraries.AccountSvc, EntryPoint = "account_insert_to_db", CallingConvention = CallingConvention.Cdecl)] - internal static extern int AddAccount(IntPtr handle, out int accountId); + internal static extern int AddAccount(SafeAccountHandle handle, out int accountId); [DllImport(Libraries.AccountSvc, EntryPoint = "account_delete_from_db_by_id", CallingConvention = CallingConvention.Cdecl)] internal static extern int DeleteAccountById(int accountId); diff --git a/src/Tizen.Account.AccountManager/Interop/Interop.Libraries.cs b/src/Tizen.Account.AccountManager/Interop/Interop.Libraries.cs index f1530bd..dba2781 100644 --- a/src/Tizen.Account.AccountManager/Interop/Interop.Libraries.cs +++ b/src/Tizen.Account.AccountManager/Interop/Interop.Libraries.cs @@ -15,13 +15,13 @@ */ /// -/// Interop for Library reference +/// Interop for the library reference. /// /// 3 internal static partial class Interop { /// - /// Interop for Library reference + /// Interop for the library reference. /// /// 3 internal static partial class Libraries diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/Account.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/Account.cs index df10a15..498bb84 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/Account.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/Account.cs @@ -20,29 +20,31 @@ using System.Collections.Generic; namespace Tizen.Account.AccountManager { /// - /// Represents the Account Information. + /// Represents the account information. /// /// 3 public class Account : IDisposable { - private IntPtr _handle = IntPtr.Zero; - internal Account(IntPtr handle) + private readonly SafeAccountHandle _handle; + + public Account(SafeAccountHandle handle) { - Handle = handle; + _handle = handle; } ~Account() { Dispose(false); } + /// - /// Creates a new Account instance. + /// Creates a new account instance. /// /// 3 /// Account Instance. public static Account CreateAccount() { - IntPtr handle; + SafeAccountHandle handle; AccountError err = (AccountError)Interop.Account.Create(out handle); if (err != AccountError.None) { @@ -56,7 +58,7 @@ namespace Tizen.Account.AccountManager /// Id of the Account. /// /// 3 - /// Account Id shall be created only when account is added to the database. + /// Account ID shall be created only when the account is added to the database. public int AccountId { get @@ -73,10 +75,10 @@ namespace Tizen.Account.AccountManager } /// - /// UserName of the Account. + /// UserName of the account. /// /// 3 - /// User Name of the Account. + /// User name of the account. public string UserName { get @@ -102,10 +104,10 @@ namespace Tizen.Account.AccountManager } /// - /// Display Name of the Account. + /// Display name of the account. /// /// 3 - /// DisplayName of the Account. + /// Display name of the account. public string DisplayName { get @@ -131,10 +133,10 @@ namespace Tizen.Account.AccountManager } /// - /// Icon path of the Account. + /// Icon path of the account. /// /// 3 - /// Icon path of the Account. + /// Icon path of the account. public string IconPath { get @@ -160,10 +162,10 @@ namespace Tizen.Account.AccountManager } /// - /// Domain name of the Account. + /// Domain name of the account. /// /// 3 - /// Domain name of the Account. + /// Domain name of the account. public string DomainName { get @@ -189,10 +191,10 @@ namespace Tizen.Account.AccountManager } /// - /// Email Id of the Account. + /// Email ID of the account. /// /// 3 - /// Email Id of the Account. + /// Email ID of the account. public string EmailId { get @@ -218,10 +220,10 @@ namespace Tizen.Account.AccountManager } /// - /// Package Name of the Account. + /// Package name of the account. /// /// 3 - /// Package Name. + /// Package name of the account. public string PackageName { get @@ -247,10 +249,10 @@ namespace Tizen.Account.AccountManager } /// - /// Access Token of the Account. + /// Access token of the account. /// /// 3 - /// Access Token. + /// Access token of the account. public string AccessToken { get @@ -276,10 +278,10 @@ namespace Tizen.Account.AccountManager } /// - /// Authentication type of the Account. + /// Authentication type of the account. /// /// 3 - /// Authentication type. + /// Authentication type of the account. public AccountAuthType AuthType { get @@ -305,10 +307,10 @@ namespace Tizen.Account.AccountManager } /// - /// Secrecy State of the Account. + /// Secrecy state of the account. /// /// 3 - /// Secrecy State. + /// Secrecy state of the account. public AccountSecrecyState SecrecyState { get @@ -334,10 +336,10 @@ namespace Tizen.Account.AccountManager } /// - /// Sync State of the Account. + /// Sync state of the account. /// /// 3 - /// Sync State. + /// Sync state of the account. public AccountSyncState SyncState { get @@ -363,10 +365,10 @@ namespace Tizen.Account.AccountManager } /// - /// Source of the Account . + /// Source of the account. /// /// 3 - /// Account Source. + /// Account source. public string Source { get @@ -391,25 +393,25 @@ namespace Tizen.Account.AccountManager } } - internal IntPtr Handle + /// + /// Handle of the account. + /// + /// 4 + /// Account handle. + public SafeAccountHandle SafeAccountHandle { get { return _handle; } - - set - { - _handle = value; - } } /// /// Sets the account capability. /// /// 3 - /// The Account capability type - /// The Account capability state - /// In case of invalid parameters + /// The account capability type. + /// The account capability state. + /// In case of an invalid parameter. public void SetCapability(string capabilityType, CapabilityState state) { AccountError ret = (AccountError)Interop.Account.SetAccountCapability(_handle, capabilityType, (int)state); @@ -419,12 +421,12 @@ namespace Tizen.Account.AccountManager } } /// - /// Gets all the capabilities of an account. + /// Gets all the capabilities of the account. /// /// 3 /// The capability type to get the capability value. - /// The capability value (on/off) of the specified CapabilityState . - /// In case of invalid parameters + /// The capability value (on/off) of the specified CapabilityState. + /// In case of an invalid parameter. public CapabilityState GetCapability(string capabilityType) { int type; @@ -438,10 +440,10 @@ namespace Tizen.Account.AccountManager } /// - /// Gets all the capabilities of an account. + /// Gets all the capabilities of the account. /// /// 3 - /// List of Cpabailities as Dictionary + /// List of capabilities as dictionary. public Dictionary GetAllCapabilities() { @@ -463,12 +465,12 @@ namespace Tizen.Account.AccountManager } /// - /// Sets the Custom Value to the Account. + /// Sets the custom value to the account. /// /// 3 - /// key to be added to the Account. - /// value to be updated for respective key for the Account. - /// In case of invalid parameters + /// Key to be added to the account. + /// Value to be updated for respective key for the account. + /// In case of an invalid parameter. public void SetCustomValue(string key, string value) { AccountError err = (AccountError)Interop.Account.SetAccountCustomValue(_handle, key, value); @@ -482,10 +484,10 @@ namespace Tizen.Account.AccountManager /// Gets the user specific custom text of an account key. /// /// 3 - /// The key to retrieve custom text . - /// The text of the given key - /// In case of invalid parameters - /// If there is no given capability type in the account + /// The key to retrieve custom text. + /// The text of the given key. + /// In case of an invalid parameter. + /// If there is no given capability type in the account. public string GetCustomValue(string key) { string result = ""; @@ -499,10 +501,10 @@ namespace Tizen.Account.AccountManager } /// - /// Gets All the custome values. + /// Gets all the custom values. /// /// 3 - /// List of custom key, value pairs as Dictionary. + /// List of custom key, value pairs as dictionary. public Dictionary GetAllCustomValues() { AccountError res = AccountError.None; @@ -528,9 +530,9 @@ namespace Tizen.Account.AccountManager /// Sets the user text. /// /// 3 - /// The index of the user text (must be in range from 0 to 4) - /// The text string to set as the user text - /// In case of invalid parameters + /// The index of the user text (must be in range from 0 to 4). + /// The text string to set as the user text. + /// In case of an invalid parameter. public void SetUserText(int index, string text) { AccountError err = (AccountError)Interop.Account.SetAccountUserText(_handle, index, text); @@ -544,10 +546,10 @@ namespace Tizen.Account.AccountManager /// Gets the user text. /// /// 3 - /// The index of the user text (range: 0 ~ 4) - /// The user text of the given key - /// In case of invalid parameters - /// In case of out of memory + /// The index of the user text (must be in range from 0 to 4). + /// The user text of the given key. + /// In case of an invalid parameter. + /// In case of out of memory. public string GetUserText(int index) { string result = ""; @@ -561,12 +563,12 @@ namespace Tizen.Account.AccountManager } /// - /// Gets the user int value. + /// Gets the user integer value. /// /// 3 - /// The index of the user int (range: 0 ~ 4) - /// The user int of the given key - /// In case of invalid parameters + /// The index of the user integer (must be in range from 0 to 4). + /// The user integer of the given key. + /// In case of an invalid parameter. public int GetUserInt(int index) { int result = -1; @@ -583,9 +585,9 @@ namespace Tizen.Account.AccountManager /// Sets the user integer value. /// /// 3 - /// The index of the user integer (must be in range from 0 to 4) - /// The integer to set as the user integer - /// In case of invalid parameters + /// The index of the user integer (must be in range from 0 to 4). + /// The integer to set as the user integer. + /// In case of an invalid parameter. public void SetUserInt(int index, int value) { AccountError err = (AccountError)Interop.Account.SetAccountUserInt(_handle, index, value); @@ -596,7 +598,7 @@ namespace Tizen.Account.AccountManager } /// - /// Overloaded Dispose API for destroying the Account Handle. + /// Overloaded Dispose API for destroying the account handle. /// /// 3 public void Dispose() @@ -609,10 +611,12 @@ namespace Tizen.Account.AccountManager { if (!disposing) { - if (_handle != IntPtr.Zero) - { - _handle = IntPtr.Zero; - } + //if (_handle != IntPtr.Zero) + //{ + // _handle = IntPtr.Zero; + //} + //_handle.Dispose(); + GC.SuppressFinalize(this); } } } diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs index b55a458..68a7a65 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs @@ -17,25 +17,25 @@ namespace Tizen.Account.AccountManager { /// - /// Enumeration for the state of capability + /// Enumeration for the state of capability. /// /// 3 public enum CapabilityState { /// - /// Account capability is invalid + /// Account capability is invalid. /// /// 3 InvalidState, /// - /// Account capability is disabled + /// Account capability is disabled. /// /// 3 Disabled, /// - /// Account capability is enabled + /// Account capability is enabled. /// /// 3 Enabled @@ -47,19 +47,19 @@ namespace Tizen.Account.AccountManager public enum AccountSecrecyState { /// - /// Account secrecy is invalid + /// Account secrecy is invalid. /// /// 3 InvalidState, /// - /// Account is not visible + /// Account is not visible. /// /// 3 Invisible, /// - /// Account is visible + /// Account is visible. /// /// 3 Visible @@ -72,31 +72,31 @@ namespace Tizen.Account.AccountManager public enum AccountSyncState { /// - /// Account sync is invalid + /// Account sync is invalid. /// /// 3 InvalidState, /// - /// Account sync not supported + /// Account sync not supported. /// /// 3 NotSupported, /// - /// Account sync supported but all synchronization functionalities are off + /// Account sync supported, but all the synchronization functionalities are off. /// /// 3 Off, /// - /// Account sync support and sync status is idle + /// Account sync supported and sync status is idle. /// /// 3 Idle, /// - /// Account sync support and sync status is running + /// Acount sync supported and sync status is running. /// /// 3 Running @@ -109,36 +109,36 @@ namespace Tizen.Account.AccountManager public enum AccountAuthType { /// - /// Auth type is invalid + /// Auth type is invalid. /// /// 3 Invalid, /// - /// XAuth type + /// XAuth type. /// /// 3 XAuth, /// - /// OAuth type + /// OAuth type. /// /// 3 OAuth, /// - /// Client-Login type + /// ClientLogin type. /// /// 3 ClientLogin } /// - /// Account information change notification type + /// Account information change notification types. /// /// 3 /// - /// When the account database is changed, You can distinguish one event type from the other which are set for subscribing notification. + /// When the account database is changed, you can distinguish one event type from the other which are set for subscribing notification. /// public enum AccountNotificationType { diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs index 48f9164..51c31dd 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs @@ -20,7 +20,7 @@ using Tizen; namespace Tizen.Account.AccountManager { /// - /// Enum to give the type of error occured, if any. + /// Enumeration for the types of error occured, if any. /// /// 3 public enum AccountError @@ -42,22 +42,22 @@ namespace Tizen.Account.AccountManager /// 3 OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory, /// - /// Same user name exists in your application + /// Same user name exists in your application. /// /// 3 Duplcated = -0x01000000 | 0x01, /// - /// Empty Data + /// Empty data. /// /// 3 NoData = Tizen.Internals.Errors.ErrorCode.NoData, /// - /// elated record does not exist + /// Elated record does not exist. /// /// 3 RecordNotFound = -0x01000000 | 0x03, /// - /// Invalid Operation. + /// Invalid operation. /// /// 3 InvalidOperation = Tizen.Internals.Errors.ErrorCode.InvalidOperation, @@ -72,17 +72,17 @@ namespace Tizen.Account.AccountManager /// 3 DBNotOpened = -0x01000000 | 0x05, /// - /// DB query syntax error + /// DB query syntax error. /// /// 3 QuerySyntaxError = -0x01000000 | 0x06, /// - /// Iterator has reached the end + /// Iterator has reached the end. /// /// 3 IteratorEnd = -0x01000000 | 0x07, /// - /// Notification failed + /// Notification failed. /// /// 3 NotificationFailed = -0x01000000 | 0x08, @@ -92,12 +92,12 @@ namespace Tizen.Account.AccountManager /// 3 PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied, /// - /// XML parse failed + /// XML parse failed. /// /// 3 XMLParseFailed = -0x01000000 | 0x0a, /// - /// XML File not found + /// XML file not found. /// /// 3 XMLFileNotFound = -0x01000000 | 0x0b, @@ -107,7 +107,7 @@ namespace Tizen.Account.AccountManager /// 3 EventSubscriptionFailed = -0x01000000 | 0x0c, /// - /// Account provider is not registered + /// Account provider is not registered. /// /// 3 ProviderNotRegistered = -0x01000000 | 0x0d, @@ -117,7 +117,7 @@ namespace Tizen.Account.AccountManager /// 3 MultipleNotAllowed = -0x01000000 | 0x0e, /// - /// SQLite busy handler expired + /// SQLite busy handler expired. /// /// 3 DBBusy = -0x01000000 | 0x10 diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountProvider.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountProvider.cs index 606a286..ce34491 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountProvider.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountProvider.cs @@ -21,7 +21,7 @@ using Tizen.Internals.Errors; namespace Tizen.Account.AccountManager { /// - /// Account Id. + /// The account ID. /// /// 3 public class AccountProvider : IDisposable @@ -50,7 +50,7 @@ namespace Tizen.Account.AccountManager } } /// - /// Account Id. + /// The account ID. /// /// 3 public string AppId @@ -69,7 +69,7 @@ namespace Tizen.Account.AccountManager } /// - /// Serviceprovider Id of the account provider. + /// Serviceprovider ID of the account provider. /// /// 3 public string ServiceProviderId @@ -88,7 +88,7 @@ namespace Tizen.Account.AccountManager } /// - /// Icon path of an account provider. + /// Icon path of the account provider. /// /// 3 public string IconPath @@ -107,7 +107,7 @@ namespace Tizen.Account.AccountManager } /// - /// Small icon path of an account provider. + /// Small icon path of the account provider. /// /// 3 public string SmallIconPath @@ -126,7 +126,7 @@ namespace Tizen.Account.AccountManager } /// - /// Flag for account provider If supports multiple accounts. + /// Flag for the account provider if it supports multiple accounts. /// /// 3 public bool MultipleAccountSupport @@ -149,11 +149,13 @@ namespace Tizen.Account.AccountManager /// /// 3 /// http://tizen.org/privilege/account.read + /// http://tizen.org/feature/account /// - /// list of capability information. + /// The list of capability information. /// - /// In case of any DB error + /// In case of any DB error. /// In case of privilege not defined. + /// The required feature is not supported. public IEnumerable GetAllCapabilities() { List capabilities = new List(); @@ -174,17 +176,19 @@ namespace Tizen.Account.AccountManager } /// - /// Gets the specific label information detail of an account provider. + /// Gets the specific label information detail of the account provider. /// /// 3 /// /// The locale is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. /// For example, "ko_KR" or "ko-kr" for Korean, "en_US" or "en-us" for American English. /// - /// The label text given for the locale + /// The label text given for the locale. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given locale + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given locale. /// In case of privilege not defined. + /// The required feature is not supported. public string GetLabel(string locale) { string label; @@ -198,17 +202,19 @@ namespace Tizen.Account.AccountManager } /// - /// Gets the specific label information detail of an account provider. + /// Gets the specific label information detail of the account provider. /// /// 3 /// - /// The application ID to search + /// The application ID to search. /// - /// All the labels information for the given application Id. + /// All the labels information for the given application ID. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given appid - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given the application ID. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static Dictionary GetLabelsByAppId(string appId) { @@ -229,13 +235,15 @@ namespace Tizen.Account.AccountManager } /// - /// Gets the label information detail of an account provider. + /// Gets the label information detail of the account provider. /// /// 3 /// All the labels information for the given account provider. /// http://tizen.org/privilege/account.read - /// In case of any DB error + /// http://tizen.org/feature/account + /// In case of any DB error. /// In case of privilege not defined. + /// The required feature is not supported. public Dictionary GetLabels() { @@ -262,9 +270,11 @@ namespace Tizen.Account.AccountManager /// The application ID to check. /// returns true If App is supported /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given appid - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for the given application ID. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public bool IsAppSupported(string appId) { bool isSupported = false; @@ -286,16 +296,18 @@ namespace Tizen.Account.AccountManager /// Checks whether the given application ID supports the capability. /// /// 3 - /// The application Id - /// The capability information + /// The application ID. + /// The capability information. /// /// TRUE if the application supports the given capability, /// otherwise FALSE if the application does not support the given capability /// /// http://tizen.org/privilege/account.read - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static bool IsFeatureSupportedByApp(string appId, string capability) { bool supported = Interop.AccountProvider.IsFeatureSupported(appId, capability); @@ -313,15 +325,17 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves capability information with application ID. + /// Retrieves capability information with the application ID. /// /// 3 - /// application Id + /// The application ID. /// Capability information list for the given appId. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given appid - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for the given application ID. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetFeaturesByAppId(string appId) { diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountService.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountService.cs index fc7cbd4..d335a8e 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountService.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountService.cs @@ -20,16 +20,16 @@ using System.Collections.Generic; namespace Tizen.Account.AccountManager { /// - /// The AccountManager APIs is separated into two major sections: + /// The AccountManager APIs are separated into two major sections: /// 1. Registering an account provider while an application is installed. This information will be used for the Add account screen. /// 2. Adding an account information when an application signs in successfully to share the account information to the Tizen system. This information will be shown in the Tizen settings account menu. /// /// The APIs of both of the sections consist of the following functionality: /// - /// Create an account or account provider - /// Update an account or account provider(Only available for the creator) - /// Delete an account or account provider(Only available for the creator) - /// Read an account or account provider with some filter + /// Create an account or account provider. + /// Update an account or account provider (Only available for the creator). + /// Delete an account or account provider (Only available for the creator). + /// Read an account or account provider with some filter. /// /// /// 3 @@ -37,74 +37,76 @@ namespace Tizen.Account.AccountManager public static class AccountService { /// - /// This is contact capability string. + /// This is the contact capability string. /// /// 3 public static readonly string ContactCapability = "http://tizen.org/account/capability/contact"; /// - /// This is calendar capability string. + /// This is the calendar capability string. /// /// 3 public static readonly string CalendarCapability = "http://tizen.org/account/capability/calendar"; /// - /// This is email capability string. + /// This is the email capability string. /// /// 3 public static readonly string EmailCapability = "http://tizen.org/account/capability/email"; /// - /// This is photo capability string. + /// This is the photo capability string. /// /// 3 public static readonly string PhotoCapability = "http://tizen.org/account/capability/photo"; /// - /// This is video capability string. + /// This is the video capability string. /// /// 3 public static readonly string VideoCapability = "http://tizen.org/account/capability/video"; /// - /// This is music capability string. + /// This is the music capability string. /// /// 3 public static readonly string MusicCapability = "http://tizen.org/account/capability/music"; /// - /// This is document capability string. + /// This is the document capability string. /// /// 3 public static readonly string DocumentCapability = "http://tizen.org/account/capability/document"; /// - /// This is message capability string. + /// This is the message capability string. /// /// 3 public static readonly string MessageCapability = "http://tizen.org/account/capability/message"; /// - /// This is game capability string. + /// This is the game capability string. /// /// 3 public static readonly string GameCapability = "http://tizen.org/account/capability/game"; /// - /// Retrieves all accounts details from the account database. + /// Retrieves all the accounts details from the account database. /// /// 3 - /// List of Accounts + /// List of accounts. /// http://tizen.org/privilege/account.read - /// In case of any DB error. + /// http://tizen.org/feature/account + /// In case of any DB error. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountsAsync() { List accounts = new List(); List values = new List(); Interop.Account.AccountCallback accountCallback = (IntPtr data, IntPtr userdata) => { - Account account = new Account(data); + Account account = new Account(new SafeAccountHandle(data, true)); values.Add(account.AccountId); account.Dispose(); return true; @@ -126,37 +128,42 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieve an account with the account ID. + /// Retrieves the account with the account ID. /// /// 3 - /// The account Id to be searched. - /// Account instance with reference to the given id. + /// The account ID to be searched. + /// Account instance with reference to the given ID. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given account id - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given account ID. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static Account GetAccountById(int accountId) { Account account = Account.CreateAccount(); - IntPtr handle = account.Handle; - AccountError res = (AccountError)Interop.AccountService.QueryAccountById(accountId, out handle); + SafeAccountHandle handle = account.SafeAccountHandle; + + AccountError res = (AccountError)Interop.AccountService.QueryAccountById(accountId, ref handle); if (res != AccountError.None) { throw AccountErrorFactory.CreateException(res, "Failed to get accounts from the database for account id: " + accountId); } - - account.Handle = handle; - return account; + Account ref_account = new Account(handle); + + return ref_account; } /// - /// Retrieves all AccountProviders details from the account database. + /// Retrieves all the AccountProviders details from the account database. /// /// 3 - /// List of AccountProviders + /// List of AccountProviders. /// http://tizen.org/privilege/account.read - /// In case of any DB error + /// http://tizen.org/feature/account + /// In case of any DB error. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountProviders() { List values = new List(); @@ -186,15 +193,17 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves the account provider information with application Id. + /// Retrieves the account provider information with the application ID. /// /// 3 - /// Application Id. - /// The AccountProvider instance associated with the given application Id. + /// The application ID. + /// The AccountProvider instance associated with the given application ID. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given appid - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given appid. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static AccountProvider GetAccountProviderByAppId(string appId) { IntPtr handle; @@ -214,11 +223,13 @@ namespace Tizen.Account.AccountManager /// /// 3 /// The capability value to search for account providers. - /// Retrieves AccountProviders information with the capability name. + /// Retrieves the AccountProviders information with the capability name. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given feature - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given feature. + /// In case of invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountProvidersByFeature(string feature) { List values = new List(); @@ -247,16 +258,18 @@ namespace Tizen.Account.AccountManager } /// - /// Inserts into the Database with the new account Infomration. + /// Inserts into the Database with the new account Information. /// /// 3 /// New Account instance to be added. /// http://tizen.org/privilege/account.read /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. /// In case of OutOfMemory error. + /// The required feature is not supported. public static int AddAccount(Account account) { if (account == null) @@ -265,7 +278,7 @@ namespace Tizen.Account.AccountManager } int id = -1; - AccountError err = (AccountError)Interop.AccountService.AddAccount(account.Handle, out id); + AccountError err = (AccountError)Interop.AccountService.AddAccount(account.SafeAccountHandle, out id); if (err != AccountError.None) { throw AccountErrorFactory.CreateException(err, "Failed to AddAccount"); @@ -278,13 +291,15 @@ namespace Tizen.Account.AccountManager /// Updates the account details to the account database. /// /// 3 - /// account instance to be updated. + /// Account instance to be updated. /// http://tizen.org/privilege/account.read /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. /// In case of OutOfMemory error. + /// The required feature is not supported. public static void UpdateAccount(Account account) { if (account == null) @@ -292,7 +307,7 @@ namespace Tizen.Account.AccountManager throw AccountErrorFactory.CreateException(AccountError.InvalidParameter, "Failed to UpdateAccount"); } - AccountError err = (AccountError)Interop.AccountService.UpdateAccountToDBById(account.Handle, account.AccountId); + AccountError err = (AccountError)Interop.AccountService.UpdateAccountToDBById(account.SafeAccountHandle, account.AccountId); if (err != AccountError.None) { throw AccountErrorFactory.CreateException(err, "Failed to UpdateAccount"); @@ -300,15 +315,17 @@ namespace Tizen.Account.AccountManager } /// - /// Deletes the account information from the Database. + /// Deletes the account information from the database. /// /// 3 /// Account instance to be deleted from the database. /// http://tizen.org/privilege/account.read - /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/privilege/account.write + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static void DeleteAccount(Account account) { if (account == null) @@ -324,16 +341,18 @@ namespace Tizen.Account.AccountManager } /// - /// Deletes an account from the account database by user name. + /// Deletes the account from the account database by user name. /// /// 3 /// The user name of the account to delete. /// The package name of the account to delete. /// http://tizen.org/privilege/account.read - /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/privilege/account.write + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static void DeleteAccount(string userName, string packageName) { AccountError err = (AccountError)Interop.AccountService.DeleteAccountByUser(userName, packageName); @@ -344,15 +363,17 @@ namespace Tizen.Account.AccountManager } /// - /// Deletes an account from the account database by package name. + /// Deletes the account from the account database by package name. /// /// 3 /// The package name of the account to delete. /// http://tizen.org/privilege/account.read - /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/privilege/account.write + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static void DeleteAccount(string packageName) { AccountError err = (AccountError)Interop.AccountService.DeleteAccountByPackage(packageName); @@ -364,22 +385,24 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves all accounts with the given user name. + /// Retrieves all the accounts with the given user name. /// /// 3 - /// The user name to search . - /// Accounts list matched with the user name + /// The user name to search. + /// Accounts list matched with the user name. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given username - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given username. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountsByUserName(string userName) { List accounts = new List(); List values = new List(); Interop.Account.AccountCallback accountCallback = (IntPtr handle, IntPtr data) => { - Account account = new Account(handle); + Account account = new Account(new SafeAccountHandle(handle, true)); values.Add(account.AccountId); account.Dispose(); return true; @@ -401,22 +424,24 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves all accounts with the given package name. + /// Retrieves all the accounts with the given package name. /// /// 3 - /// The package name to Search - /// Accounts list matched with the package name + /// The package name to search. + /// Accounts list matched with the package name. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given package name - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given package name. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountsByPackageName(string packageName) { List accounts = new List(); List values = new List(); Interop.Account.AccountCallback accountCallback = (IntPtr handle, IntPtr data) => { - Account account = new Account(handle); + Account account = new Account(new SafeAccountHandle(handle, true)); values.Add(account.AccountId); account.Dispose(); return true; @@ -438,22 +463,24 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves all accounts with the given cpability type. + /// Retrieves all accounts with the given capability type. /// /// 3 - /// Capability type - /// Accounts list matched with the capability type + /// Capability type. + /// Accounts list matched with the capability type. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given capability type - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for the given capability type. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static IEnumerable GetAccountsByCapabilityType(string type) { List accounts = new List(); List values = new List(); Interop.Account.AccountCallback accountCallback = (IntPtr handle, IntPtr data) => { - Account account = new Account(handle); + Account account = new Account(new SafeAccountHandle(handle, true)); values.Add(account.AccountId); account.Dispose(); return true; @@ -475,15 +502,17 @@ namespace Tizen.Account.AccountManager } /// - /// Retrieves all capabilities with the given account + /// Retrieves all the capabilities with the given account. /// /// 3 - /// account instance - /// Capabilities list as Dictionary of Capability type and State. + /// Account instance. + /// Capabilities list as dictionary of the capability type and state. /// http://tizen.org/privilege/account.read - /// In case of any DB error or record not found for given account id - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error or record not found for given account ID. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static Dictionary GetCapabilitiesById(int accountId) { Dictionary capabilities = new Dictionary(); @@ -506,10 +535,12 @@ namespace Tizen.Account.AccountManager /// Gets the count of accounts in the account database. /// /// 3 - /// The number of accounts in the database + /// The number of accounts in the database. /// http://tizen.org/privilege/account.read - /// In case of any DB error + /// http://tizen.org/feature/account + /// In case of any DB error. /// In case of privilege not defined. + /// The required feature is not supported. public static int GetAccountsCount() { int count = 0; @@ -526,13 +557,15 @@ namespace Tizen.Account.AccountManager /// Updates the sync status of the given account. /// /// 3 - /// Account for which sync status needs to be updated + /// Account for which the sync status needs to be updated. /// Sync State /// http://tizen.org/privilege/account.read /// http://tizen.org/privilege/account.write - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static void UpdateSyncStatusById(Account account, AccountSyncState status) { AccountError err = (AccountError)Interop.AccountService.UpdateAccountSyncStatusById(account.AccountId, (int)status); @@ -557,14 +590,16 @@ namespace Tizen.Account.AccountManager /// /// 3 /// - /// ContentUpdate event is triggered if the MediaInformaion updated/deleted or new Inforamtion is Inserted. + /// ContentUpdate event is triggered if the MediaInformaion updated/deleted or new information is inserted. /// /// /// A ContentUpdatedEventArgs object that contains information about the update operation. /// http://tizen.org/privilege/account.read - /// In case of any DB error - /// In case of invalid parameter + /// http://tizen.org/feature/account + /// In case of any DB error. + /// In case of an invalid parameter. /// In case of privilege not defined. + /// The required feature is not supported. public static event EventHandler AccountUpdated { add diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountSubscriberEventArgs.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountSubscriberEventArgs.cs index 153c427..2df2399 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountSubscriberEventArgs.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountSubscriberEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Account.AccountManager { /// - /// Event arguments passed when Event is triggered to notify that account is updated/removed from the account database. + /// Event arguments passed when the event is triggered to notify that the account is updated/removed from the account database. /// /// 3 public class AccountSubscriberEventArgs : EventArgs @@ -51,7 +51,7 @@ namespace Tizen.Account.AccountManager } /// - /// The account event type + /// The account event type. /// /// 3 public AccountNotificationType EventType @@ -61,7 +61,7 @@ namespace Tizen.Account.AccountManager } /// - /// The account ID to update + /// The account ID to update. /// /// 3 public int AccountId diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs new file mode 100644 index 0000000..3da224c --- /dev/null +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs @@ -0,0 +1,63 @@ +/* + * 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. + */ + +using System; +using System.Collections.Generic; +using System.Runtime.InteropServices; + +namespace Tizen.Account.AccountManager +{ + /// + /// Represents a wrapper class for a unmanaged Account handle. + /// + public sealed class SafeAccountHandle : SafeHandle + { + /// + /// Initializes a new instance of the SafeAppControlHandle class. + /// + public SafeAccountHandle() : base(IntPtr.Zero, true) + { + } + + /// + /// Initializes a new instance of the SafeAccountHandle class. + /// + /// An IntPtr object that represents the pre-existing handle to use. + /// true to reliably release the handle during the finalization phase; false to prevent reliable release. + public SafeAccountHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle) + { + SetHandle(existingHandle); + } + + /// + /// Gets a value that indicates whether the handle is invalid. + /// + public override bool IsInvalid + { + get { return this.handle == IntPtr.Zero; } + } + + /// + /// When overridden in a derived class, executes the code required to free the handle. + /// + /// true if the handle is released successfully + protected override bool ReleaseHandle() + { + this.SetHandle(IntPtr.Zero); + return true; + } + } +} diff --git a/src/Tizen.Account.SyncManager/Interop/Interop.Adapter.cs b/src/Tizen.Account.SyncManager/Interop/Interop.Adapter.cs new file mode 100755 index 0000000..9a05dbc --- /dev/null +++ b/src/Tizen.Account.SyncManager/Interop/Interop.Adapter.cs @@ -0,0 +1,28 @@ +// Copyright 2016 by Samsung Electronics, Inc., +// +// This software is the confidential and proprietary information +// of Samsung Electronics, Inc. ("Confidential Information"). You +// shall not disclose such Confidential Information and shall use +// it only in accordance with the terms of the license agreement +// you entered into with Samsung. + +using System; +using System.Runtime.InteropServices; + +internal static partial class Interop +{ + internal static partial class Adapter + { + [DllImport(Libraries.SyncManager, EntryPoint = "sync_adapter_set_callbacks")] + internal static extern int SetCallbacks(SyncAdapterStartSyncCallback onStartCb, SyncAdapterCancelSyncCallback onCancelCb); + + [DllImport(Libraries.SyncManager, EntryPoint = "sync_adapter_unset_callbacks")] + internal static extern int UnsetCallbacks(); + + [UnmanagedFunctionPointerAttribute(CallingConvention.Cdecl)] + internal delegate bool SyncAdapterStartSyncCallback(IntPtr account, string syncJobName, string syncCapability, IntPtr syncJobUserData); + + [UnmanagedFunctionPointerAttribute(CallingConvention.Cdecl)] + internal delegate void SyncAdapterCancelSyncCallback(IntPtr account, string syncJobName, string syncCapability, IntPtr syncJobUserData); + } +} diff --git a/src/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs b/src/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs new file mode 100755 index 0000000..837e50b --- /dev/null +++ b/src/Tizen.Account.SyncManager/Interop/Interop.Libraries.cs @@ -0,0 +1,28 @@ +/* + * 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. + */ + +internal static partial class Interop +{ + /// + /// Wrapper class for maintaining names of dependent native libraries. + /// + internal static partial class Libraries + { + public const string SyncManager = "libcore-sync-client.so.1"; + public const string Glib = "libglib-2.0.so.0"; + public const string Libc = "libc.so.6"; + } +} diff --git a/src/Tizen.Account.SyncManager/Interop/Interop.Manager.cs b/src/Tizen.Account.SyncManager/Interop/Interop.Manager.cs new file mode 100755 index 0000000..c269694 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Interop/Interop.Manager.cs @@ -0,0 +1,36 @@ +// Copyright 2016 by Samsung Electronics, Inc., +// +// This software is the confidential and proprietary information +// of Samsung Electronics, Inc. ("Confidential Information"). You +// shall not disclose such Confidential Information and shall use +// it only in accordance with the terms of the license agreement +// you entered into with Samsung. + +using System; +using System.Runtime.InteropServices; +using Tizen.Applications; +using Tizen.Account.AccountManager; + +internal static partial class Interop +{ + internal static partial class Manager + { + [DllImport(Libraries.SyncManager, EntryPoint = "sync_manager_on_demand_sync_job")] + internal static extern int RequestOnDemandSyncJob(SafeAccountHandle account, string syncJobName, int syncOption, SafeBundleHandle syncJobUserData, out int syncJobId); + + [DllImport(Libraries.SyncManager, EntryPoint = "sync_manager_add_periodic_sync_job")] + internal static extern int AddPeriodicSyncJob(SafeAccountHandle account, string syncJobName, int syncPeriod, int syncOption, SafeBundleHandle syncJobUserData, out int syncJobId); + + [DllImport(Libraries.SyncManager, EntryPoint = "sync_manager_add_data_change_sync_job")] + internal static extern int AddDataChangeSyncJob(SafeAccountHandle account, string syncCapability, int syncOption, SafeBundleHandle syncJobUserData, out int syncJobId); + + [DllImport(Libraries.SyncManager, EntryPoint = "sync_manager_remove_sync_job")] + internal static extern int RemoveSyncJob(int syncJobId); + + [DllImport(Libraries.SyncManager, EntryPoint = "sync_manager_foreach_sync_job")] + internal static extern int ForeachSyncJob(SyncManagerSyncJobCallback syncJobCb, IntPtr userData); + + [UnmanagedFunctionPointerAttribute(CallingConvention.Cdecl)] + internal delegate bool SyncManagerSyncJobCallback(IntPtr account, string syncJobName, string syncCapability, int syncJobId, IntPtr syncJobUserData, IntPtr userData); + } +} diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.csproj b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.csproj new file mode 100644 index 0000000..a552e3f --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.csproj @@ -0,0 +1,16 @@ + + + + + netstandard1.6 + + + + + + + + + + + diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.sln b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.sln new file mode 100755 index 0000000..14b65a7 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26430.13 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Tizen.Account.SyncManager", "Tizen.Account.SyncManager.csproj", "{16028D3D-9DA0-466A-9CE4-EE8790F450D6}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {16028D3D-9DA0-466A-9CE4-EE8790F450D6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {16028D3D-9DA0-466A-9CE4-EE8790F450D6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {16028D3D-9DA0-466A-9CE4-EE8790F450D6}.Release|Any CPU.ActiveCfg = Release|Any CPU + {16028D3D-9DA0-466A-9CE4-EE8790F450D6}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs new file mode 100755 index 0000000..4befba6 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/Enumerations.cs @@ -0,0 +1,84 @@ +/* + * 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. + */ + +using System; + +namespace Tizen.Account.SyncManager +{ + /// + /// Enumeration for the Sync option + /// + [Flags] + public enum SyncOption + { + /// + /// Sync job will be operated normally + /// + None = 0, + + /// + /// Sync job will be operated as soon as possible + /// + Expedited = 0X01, + + /// + /// Sync job will not be performed again when it fails + /// + NoRetry = 0X02, + } + + /// + /// Enumeration for the Sync period + /// + public enum SyncPeriod + { + /// + /// Sync within 30 minutes + /// + ThirtyMin = 0, + + /// + /// Sync within 1 hour + /// + OneHour, + + /// + /// Sync within 2 hours + /// + TwoHours, + + /// + /// Sync within 3 hours + /// + ThreeHours, + + /// + /// Sync within 6 hours + /// + SixHours, + + /// + /// Sync within 12 hours + /// + TwelveHours, + + /// + /// Sync within 1 day + /// + OneDay, + } +} + diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/ErrorFactory.cs b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/ErrorFactory.cs new file mode 100755 index 0000000..79f1af9 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/ErrorFactory.cs @@ -0,0 +1,90 @@ +/* + * 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. + */ + +using System; +using Tizen.Internals.Errors; + +namespace Tizen.Account.SyncManager +{ + internal enum SyncManagerErrorCode + { + None = ErrorCode.None, + NotSupported = ErrorCode.NotSupported, + OutOfMemory = ErrorCode.OutOfMemory, + InvalidParameter = ErrorCode.InvalidParameter, + InvalidOperation = ErrorCode.InvalidOperation, + PermissionDenied = ErrorCode.PermissionDenied, + IoError = ErrorCode.IoError, + AlreadyInProgress = ErrorCode.AlreadyInProgress, + QuotaExceeded = ErrorCode.QuotaExceeded, + SystemError = -0x01020000 | 0X01, + AdapterNotFound = -0x01020000 | 0X02 + } + + internal class ErrorFactory + { + internal static string LogTag = "Tizen.Account.SyncManager"; + + internal static Exception GetException(int error) + { + if ((SyncManagerErrorCode)error == SyncManagerErrorCode.NotSupported) + { + return new NotSupportedException("Not supported (%http://tizen.org/feature/account.sync)"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.OutOfMemory) + { + return new OutOfMemoryException("Out of memory"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.InvalidParameter) + { + return new ArgumentException("Invalid parameter"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.InvalidOperation) + { + return new InvalidOperationException("Invalid operation"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.PermissionDenied) + { + return new UnauthorizedAccessException("Permission denied (%http://tizen.org/privilege/alarm.set, %http://tizen.org/privilege/calendar.read, %http://tizen.org/privilege/contact.read)"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.IoError) + { + return new Exception("IO error occured"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.AlreadyInProgress) + { + return new InvalidOperationException("Sync is already in progress"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.QuotaExceeded) + { + return new InvalidOperationException("Quota for sync jobs exceeded"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.SystemError) + { + return new Exception("System error occured"); + } + else if ((SyncManagerErrorCode)error == SyncManagerErrorCode.AdapterNotFound) + { + return new InvalidOperationException("Sync adapter couldn't be found"); + } + else + { + return new Exception("Unknown error"); + } + } + } +} + diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs new file mode 100755 index 0000000..8a59593 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncAdapter.cs @@ -0,0 +1,115 @@ +/* + * 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. + */ + +using System; +using Tizen.Applications; +using Tizen.Account.AccountManager; + +namespace Tizen.Account.SyncManager +{ + /// + /// The class contains the delegates to be called upon scheduling a sync operation + /// + public class SyncAdapter + { + Interop.Adapter.SyncAdapterStartSyncCallback _startSyncCallback; + Interop.Adapter.SyncAdapterCancelSyncCallback _cancelSyncCallback; + + /// + /// Callback function for Sync Adapter's start sync request + /// + /// The sync job parameters corresponding to the sync request. + /// true if sync operation is success, @c false otherwise. + public delegate bool StartSyncCallback(SyncJobData syncParameters); + + /// + /// Callback function for Sync Adapter's cancel sync request. + /// + /// The sync job parameters corresponding to the sync request. + public delegate void CancelSyncCallback(SyncJobData syncParameters); + + /// + /// Sets client (Sync Adapter) callback functions + /// + /// A callback function to be called by Sync Manager for performing sync operation. + /// A callback function to be called by Sync Manager for cancelling sync operation. + /// Thrown when any of the arguments are null. + /// Thrown when the application calling this API cannot be a sync adapter. + public void SetSyncEventCallbacks(StartSyncCallback startSyncCb, CancelSyncCallback cancelSyncCb) + { + if (startSyncCb == null || cancelSyncCb == null) + { + throw new ArgumentNullException(); + } + + _startSyncCallback = (IntPtr accountHandle, string syncJobName, string syncCapability, IntPtr syncJobUserData) => + { + Log.Debug(ErrorFactory.LogTag, "Start sync event received"); + + AccountManager.Account account = new AccountManager.Account(new SafeAccountHandle(accountHandle, true)); + Bundle bundle = new Bundle(new SafeBundleHandle(syncJobUserData, true)); + + SyncJobData syncJobData = new SyncJobData() + { + Account = account, + SyncJobName = syncJobName, + UserData = bundle + }; + + return startSyncCb(syncJobData); + }; + + _cancelSyncCallback = (IntPtr accountHandle, string syncJobName, string syncCapability, IntPtr syncJobUserData) => + { + Log.Debug(ErrorFactory.LogTag, "cancel sync event received"); + + AccountManager.Account account = new AccountManager.Account(new SafeAccountHandle(accountHandle, true)); + Bundle bundle = new Bundle(new SafeBundleHandle(syncJobUserData, true)); + + SyncJobData syncJobData = new SyncJobData() + { + Account = account, + SyncJobName = syncJobName, + UserData = bundle + }; + + cancelSyncCb(syncJobData); + }; + + int ret = Interop.Adapter.SetCallbacks(_startSyncCallback, _cancelSyncCallback); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to set callbacks"); + throw ErrorFactory.GetException(ret); + } + } + + /// + /// Unsets client (Sync Adapter) callback functions + /// + /// Thrown when sync manager internal error occurs. + public void UnsetSyncEventCallbacks() + { + int ret = Interop.Adapter.UnsetCallbacks(); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to unset callbacks"); + throw ErrorFactory.GetException(ret); + } + } + } +} + diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs new file mode 100755 index 0000000..4c82b85 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncClient.cs @@ -0,0 +1,178 @@ +/* + * 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. + */ + +using System; +using System.Collections.Generic; +using Tizen.Applications; +using Tizen.Account.AccountManager; + +namespace Tizen.Account.SyncManager +{ + /// + /// The SyncClient APIs for managing the sync operations. Applications will call these APIs to schedule their sync operations. + /// Sync service maintains sync requests from all the applications and invokes their respective callback methods to perform account synchronization operations. + /// + public static class SyncClient + { + /// + /// The constructor + /// + static SyncClient() + { + } + + /// + /// Requests Sync Manager to perform one time sync operation + /// + /// Sync job information of the sync job request. + /// sync options determine an way to operate sync job and can be used as ORing. + /// Thrown when any of the arugments are null. + /// Thrown when the application calling this api doesn't have a sync adapter. + /// A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + public static int RequestOnDemandSyncJob(SyncJobData request, SyncOption syncOptions) + { + if (request == null || request.SyncJobName == null) + { + throw new ArgumentNullException(); + } + + SafeAccountHandle accountHandle = (request.Account != null) ? request.Account.SafeAccountHandle : new SafeAccountHandle(); + SafeBundleHandle bundleHandle = (request.UserData != null) ? request.UserData.SafeBundleHandle : new SafeBundleHandle(); + + int id = 0; + int ret = Interop.Manager.RequestOnDemandSyncJob(accountHandle, request.SyncJobName, (int)syncOptions, bundleHandle, out id); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to request on demand sync job"); + throw ErrorFactory.GetException(ret); + } + return id; + } + + /// + /// Requests Sync Manager to perform periodic sync operations + /// + /// Sync job information of the sync job request. + /// Determines time interval of periodic sync. The periodic sync operation can be triggered in that interval, but it does not guarantee exact time. The minimum value is 30 minutes. + /// sync options determine an way to operate sync job and can be used as ORing. + /// http://tizen.org/privilege/alarm.set + /// In case of privilege not defined. + /// Thrown when any of the arguments are null. + /// Thrown when the application calling this API doesn't have a sync adapter. + /// A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + public static int AddPeriodicSyncJob(SyncJobData request, SyncPeriod period, SyncOption syncOptions) + { + if (request == null || request.SyncJobName == null) + { + throw new ArgumentNullException(); + } + + SafeAccountHandle accountHandle = (request.Account != null) ? request.Account.SafeAccountHandle : new SafeAccountHandle(); + SafeBundleHandle bundleHandle = (request.UserData != null) ? request.UserData.SafeBundleHandle : new SafeBundleHandle(); + + int id = 0; + int ret = Interop.Manager.AddPeriodicSyncJob(accountHandle, request.SyncJobName, (int) period, (int)syncOptions, bundleHandle, out id); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to add periodic sync job"); + throw ErrorFactory.GetException(ret); + } + return id; + } + + /// + /// Requests Sync Manager to perform sync operations whenever corresponding DB changed + /// + /// Sync job information of the sync job request. + /// sync options determine an way to operate sync job and can be used as ORing. + /// http://tizen.org/privilege/calendar.read + /// http://tizen.org/privilege/contact.read + /// In case of privilege not defined. + /// Thrown when any of the arguments are null. + /// Thrown when the application calling this API doesn't have a sync adapter. + /// A unique value which can manage sync jobs. The number of sync job id is limited as less than a hundred. + public static int AddDataChangeSyncJob(SyncJobData request, SyncOption syncOptions) + { + if (request == null || request.SyncJobName == null) + { + throw new ArgumentNullException(); + } + + SafeAccountHandle accountHandle = (request.Account != null) ? request.Account.SafeAccountHandle : new SafeAccountHandle(); + SafeBundleHandle bundleHandle = (request.UserData != null) ? request.UserData.SafeBundleHandle : new SafeBundleHandle(); + + int id = 0; + int ret = Interop.Manager.AddDataChangeSyncJob(accountHandle, request.SyncJobName, (int)syncOptions, bundleHandle, out id); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to add data change sync job"); + throw ErrorFactory.GetException(ret); + } + return id; + } + + /// + /// Get all the sync jobs registered with the sync manager + /// + /// + /// Returns the list of SyncJobData corresponding to sync requests. + /// + public static IEnumerable> GetAllSyncJobs() + { + IDictionary syncJobs = new Dictionary(); + Interop.Manager.SyncManagerSyncJobCallback cb = (IntPtr accountHandle, string syncJobName, string syncCapability, int syncJobId, IntPtr syncJobUserData, IntPtr userData) => + { + AccountManager.Account account = new AccountManager.Account(new SafeAccountHandle(accountHandle, true)); + Bundle bundle = new Bundle(new SafeBundleHandle(syncJobUserData, true)); + + SyncJobData syncJobData = new SyncJobData(); + syncJobData.Account = account; + if (syncJobName != null) + syncJobData.SyncJobName = syncJobName; + else + syncJobData.SyncJobName = syncCapability; + syncJobData.UserData = bundle; + + syncJobs.Add(syncJobId, syncJobData); + return true; + }; + + int ret = Interop.Manager.ForeachSyncJob(cb, IntPtr.Zero); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to get registered sync job"); + throw ErrorFactory.GetException(ret); + } + return syncJobs; + } + + /// + /// Requests Sync Manager to remove corresponding sync job job based on id + /// + /// A unique value of each sync job, it can be used to search specific sync job and remove it. + /// Thrown if the input arugments is invalid. + public static void RemoveSyncJob(int id) + { + int ret = Interop.Manager.RemoveSyncJob(id); + if (ret != (int)SyncManagerErrorCode.None) + { + Log.Error(ErrorFactory.LogTag, "Failed to remove sync job"); + throw ErrorFactory.GetException(ret); + } + } + } +} + diff --git a/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs new file mode 100755 index 0000000..51c2039 --- /dev/null +++ b/src/Tizen.Account.SyncManager/Tizen.Account.SyncManager/SyncJobData.cs @@ -0,0 +1,91 @@ +/* + * 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. + */ + +using Tizen.Applications; +using Tizen.Account.AccountManager; + +namespace Tizen.Account.SyncManager +{ + /// + /// Class represents information about a sync job request + /// + public class SyncJobData + { + /// + /// Represents calendar capability + /// + /// + /// If you want to receive notification about calendar database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string CalendarCapability = "http://tizen.org/sync/capability/calendar"; + + /// + /// Represents contact capability + /// + /// + /// If you want to receive notification about contact database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string ContactCapability = "http://tizen.org/sync/capability/contact"; + + /// + /// Represents image capability + /// + /// + /// If you want to receive notification about image database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string ImageCapability = "http://tizen.org/sync/capability/image"; + + /// + /// Represents video capability + /// + /// + /// If you want to receive notification about video database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string VideoCapability = "http://tizen.org/sync/capability/video"; + + /// + /// Represents sound capability + /// + /// + /// If you want to receive notification about sound database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string SoundCapability = "http://tizen.org/sync/capability/sound"; + + /// + /// Represents music capability + /// + /// + /// If you want to receive notification about music database change, assign it to SyncJobName property of SyncJobData object. + /// + public const string MusicCapability = "http://tizen.org/sync/capability/music"; + + /// + /// The account instance on which sync operation was requested or @c null in the case of accountless sync operation + /// + public AccountManager.Account Account { get; set; } + + /// + /// User data which contains additional information related registered sync job + /// + public Bundle UserData { get; set; } + + /// + /// A string representing a sync job which has been operated or capability setting to operate data change sync job + /// + public string SyncJobName { get; set; } + } +} +