Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.Badge.xml
index 2197edd..a6235e7 100644 (file)
-<?xml version="1.0"?>
-<doc>
-    <assembly>
-        <name>Tizen.Applications.Badge</name>
-    </assembly>
-    <members>
-        <member name="T:Tizen.Applications.Badge">
-            <summary>
-            The class containing common properties of the Badge.
-            </summary>
-        </member>
-        <member name="M:Tizen.Applications.Badge.#ctor(System.String,System.Int32,System.Boolean)">
-            <summary>
-            Initializes a new instance of the Badge class.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="appId">Application ID</param>
-            <param name="count">Count value</param>
-            <param name="visible">True if it should be displayed</param>
-            <exception cref="!:ArgumentException">Thrown when failed because of invalid argument</exception>
-        </member>
-        <member name="P:Tizen.Applications.Badge.Count">
-            <summary>
-            Property for the count value of the badge.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.Applications.Badge.AppId">
-            <summary>
-            Property for the application ID of the badge.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.Applications.Badge.Visible">
-            <summary>
-            Property for display visibility. True if the badge display visible, otherwise false..
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="T:Tizen.Applications.BadgeControl">
-            <summary>
-            The class for badge operation.
-            </summary>
-        </member>
-        <member name="E:Tizen.Applications.BadgeControl.Changed">
-            <summary>
-            Event handler for receiving badge events.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.Find(System.String)">
-            <summary>
-            Gets the badge information from the application ID.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="appId">Application ID.</param>
-            <returns>The Badge object with inputted application ID</returns>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.Remove(System.String)">
-            <summary>
-            Removes the badge information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="appId">Application ID.</param>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of a an invalid argument.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.Remove(Tizen.Applications.Badge)">
-            <summary>
-            Removes the badge information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="badge">The Badge object.</param>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.Add(Tizen.Applications.Badge)">
-            <summary>
-            Adds the badge information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="badge">The Badge object.</param>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.Update(Tizen.Applications.Badge)">
-            <summary>
-            Updates the badge information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <param name="badge">The Badge object.</param>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="M:Tizen.Applications.BadgeControl.GetBadges">
-            <summary>
-            Gets all the badge information.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-            <returns>List of all Badge instances.</returns>
-            <feature>http://tizen.org/feature/badge</feature>
-            <privilege>http://tizen.org/privilege/notification</privilege>
-            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
-            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
-            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
-        </member>
-        <member name="T:Tizen.Applications.BadgeErrorFactory">
-            <summary>
-            Immutable class for getting the badge information.
-            </summary>
-        </member>
-        <member name="T:Tizen.Applications.BadgeEventArgs">
-            <summary>
-            The class for event arguments of the badge event.
-            </summary>
-        </member>
-        <member name="T:Tizen.Applications.BadgeEventArgs.Action">
-            <summary>
-            Enumeration for the badge action.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Add">
-            <summary>
-            The badge was added.
-            </summary>
-        </member>
-        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Remove">
-            <summary>
-            The badge was removed.
-            </summary>
-        </member>
-        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Update">
-            <summary>
-            The badge was updated.
-            </summary>
-        </member>
-        <member name="P:Tizen.Applications.BadgeEventArgs.Badge">
-            <summary>
-            The property for the badge object.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-        <member name="P:Tizen.Applications.BadgeEventArgs.Reason">
-            <summary>
-            The property for the action value.
-            </summary>
-            <since_tizen> 3 </since_tizen>
-        </member>
-    </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+    <assembly>\r
+        <name>Tizen.Applications.Badge</name>\r
+    </assembly>\r
+    <members>\r
+        <member name="T:Tizen.Applications.Badge">\r
+            <summary>\r
+            The class containing common properties of the Badge.\r
+            </summary>\r
+        </member>\r
+        <member name="M:Tizen.Applications.Badge.#ctor(System.String,System.Int32,System.Boolean)">\r
+            <summary>\r
+            Initializes a new instance of the Badge class.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="appId">Application ID</param>\r
+            <param name="count">Count value</param>\r
+            <param name="visible">True if it should be displayed</param>\r
+            <exception cref="!:ArgumentException">Thrown when failed because of invalid argument</exception>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Badge.Count">\r
+            <summary>\r
+            Property for the count value of the badge.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <exception cref="!:ArgumentException">Thrown when set negative number</exception>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Badge.AppId">\r
+            <summary>\r
+            Property for the application ID of the badge.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.Applications.Badge.Visible">\r
+            <summary>\r
+            Property for display visibility. True if the badge display visible, otherwise false..\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="T:Tizen.Applications.BadgeControl">\r
+            <summary>\r
+            The class for badge operation.\r
+            </summary>\r
+        </member>\r
+        <member name="E:Tizen.Applications.BadgeControl.Changed">\r
+            <summary>\r
+            Event handler for receiving badge events.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.Find(System.String)">\r
+            <summary>\r
+            Gets the badge information from the application ID.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="appId">Application ID.</param>\r
+            <returns>The Badge object with inputted application ID</returns>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.Remove(System.String)">\r
+            <summary>\r
+            Removes the badge information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="appId">Application ID.</param>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of a an invalid argument.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.Remove(Tizen.Applications.Badge)">\r
+            <summary>\r
+            Removes the badge information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="badge">The Badge object.</param>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.Add(Tizen.Applications.Badge)">\r
+            <summary>\r
+            Adds the badge information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="badge">The Badge object.</param>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.Update(Tizen.Applications.Badge)">\r
+            <summary>\r
+            Updates the badge information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <param name="badge">The Badge object.</param>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="M:Tizen.Applications.BadgeControl.GetBadges">\r
+            <summary>\r
+            Gets all the badge information.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+            <returns>List of all Badge instances.</returns>\r
+            <feature>http://tizen.org/feature/badge</feature>\r
+            <privilege>http://tizen.org/privilege/notification</privilege>\r
+            <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>\r
+            <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>\r
+            <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>\r
+        </member>\r
+        <member name="T:Tizen.Applications.BadgeErrorFactory">\r
+            <summary>\r
+            Immutable class for getting the badge information.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Applications.BadgeEventArgs">\r
+            <summary>\r
+            The class for event arguments of the badge event.\r
+            </summary>\r
+        </member>\r
+        <member name="T:Tizen.Applications.BadgeEventArgs.Action">\r
+            <summary>\r
+            Enumeration for the badge action.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Add">\r
+            <summary>\r
+            The badge was added.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Remove">\r
+            <summary>\r
+            The badge was removed.\r
+            </summary>\r
+        </member>\r
+        <member name="F:Tizen.Applications.BadgeEventArgs.Action.Update">\r
+            <summary>\r
+            The badge was updated.\r
+            </summary>\r
+        </member>\r
+        <member name="P:Tizen.Applications.BadgeEventArgs.Badge">\r
+            <summary>\r
+            The property for the badge object.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+        <member name="P:Tizen.Applications.BadgeEventArgs.Reason">\r
+            <summary>\r
+            The property for the action value.\r
+            </summary>\r
+            <since_tizen> 3 </since_tizen>\r
+        </member>\r
+    </members>\r
+</doc>\r