binaries/frameworks/Tizen.Applications.Badge.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Applications.Badge</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.Applications.Badge">
   8             <summary>
   9             The class containing common properties of the Badge.
  10             </summary>
  11         </member>
  12         <member name="M:Tizen.Applications.Badge.#ctor(System.String,System.Int32,System.Boolean)">
  13             <summary>
  14             Initializes a new instance of the Badge class.
  15             </summary>
  16             <since_tizen> 3 </since_tizen>
  17             <param name="appId">Application ID</param>
  18             <param name="count">Count value</param>
  19             <param name="visible">True if it should be displayed</param>
  20             <exception cref="!:ArgumentException">Thrown when failed because of invalid argument</exception>
  21         </member>
  22         <member name="P:Tizen.Applications.Badge.Count">
  23             <summary>
  24             Property for the count value of the badge.
  25             </summary>
  26             <since_tizen> 3 </since_tizen>
  27         </member>
  28         <member name="P:Tizen.Applications.Badge.AppId">
  29             <summary>
  30             Property for the application ID of the badge.
  31             </summary>
  32             <since_tizen> 3 </since_tizen>
  33         </member>
  34         <member name="P:Tizen.Applications.Badge.Visible">
  35             <summary>
  36             Property for display visibility. True if the badge display visible, otherwise false..
  37             </summary>
  38             <since_tizen> 3 </since_tizen>
  39         </member>
  40         <member name="T:Tizen.Applications.BadgeControl">
  41             <summary>
  42             The class for badge operation.
  43             </summary>
  44         </member>
  45         <member name="E:Tizen.Applications.BadgeControl.Changed">
  46             <summary>
  47             Event handler for receiving badge events.
  48             </summary>
  49             <since_tizen> 3 </since_tizen>
  50             <feature>http://tizen.org/feature/badge</feature>
  51             <privilege>http://tizen.org/privilege/notification</privilege>
  52             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  53             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
  54             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
  55         </member>
  56         <member name="M:Tizen.Applications.BadgeControl.Find(System.String)">
  57             <summary>
  58             Gets the badge information from the application ID.
  59             </summary>
  60             <since_tizen> 3 </since_tizen>
  61             <param name="appId">Application ID.</param>
  62             <returns>The Badge object with inputted application ID</returns>
  63             <feature>http://tizen.org/feature/badge</feature>
  64             <privilege>http://tizen.org/privilege/notification</privilege>
  65             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
  66             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
  67             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  68             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
  69         </member>
  70         <member name="M:Tizen.Applications.BadgeControl.Remove(System.String)">
  71             <summary>
  72             Removes the badge information.
  73             </summary>
  74             <since_tizen> 3 </since_tizen>
  75             <param name="appId">Application ID.</param>
  76             <feature>http://tizen.org/feature/badge</feature>
  77             <privilege>http://tizen.org/privilege/notification</privilege>
  78             <exception cref="T:System.ArgumentException">Thrown when failed because of a an invalid argument.</exception>
  79             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
  80             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  81             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
  82         </member>
  83         <member name="M:Tizen.Applications.BadgeControl.Remove(Tizen.Applications.Badge)">
  84             <summary>
  85             Removes the badge information.
  86             </summary>
  87             <since_tizen> 3 </since_tizen>
  88             <param name="badge">The Badge object.</param>
  89             <feature>http://tizen.org/feature/badge</feature>
  90             <privilege>http://tizen.org/privilege/notification</privilege>
  91             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
  92             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
  93             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  94             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
  95         </member>
  96         <member name="M:Tizen.Applications.BadgeControl.Add(Tizen.Applications.Badge)">
  97             <summary>
  98             Adds the badge information.
  99             </summary>
 100             <since_tizen> 3 </since_tizen>
 101             <param name="badge">The Badge object.</param>
 102             <feature>http://tizen.org/feature/badge</feature>
 103             <privilege>http://tizen.org/privilege/notification</privilege>
 104             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
 105             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
 106             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 107             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
 108         </member>
 109         <member name="M:Tizen.Applications.BadgeControl.Update(Tizen.Applications.Badge)">
 110             <summary>
 111             Updates the badge information.
 112             </summary>
 113             <since_tizen> 3 </since_tizen>
 114             <param name="badge">The Badge object.</param>
 115             <feature>http://tizen.org/feature/badge</feature>
 116             <privilege>http://tizen.org/privilege/notification</privilege>
 117             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
 118             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
 119             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 120             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
 121         </member>
 122         <member name="M:Tizen.Applications.BadgeControl.GetBadges">
 123             <summary>
 124             Gets all the badge information.
 125             </summary>
 126             <since_tizen> 3 </since_tizen>
 127             <returns>List of all Badge instances.</returns>
 128             <feature>http://tizen.org/feature/badge</feature>
 129             <privilege>http://tizen.org/privilege/notification</privilege>
 130             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access.</exception>
 131             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 132             <exception cref="T:System.NotSupportedException">Thrown when Badge is not supported.</exception>
 133         </member>
 134         <member name="T:Tizen.Applications.BadgeErrorFactory">
 135             <summary>
 136             Immutable class for getting the badge information.
 137             </summary>
 138         </member>
 139         <member name="T:Tizen.Applications.BadgeEventArgs">
 140             <summary>
 141             The class for event arguments of the badge event.
 142             </summary>
 143         </member>
 144         <member name="T:Tizen.Applications.BadgeEventArgs.Action">
 145             <summary>
 146             Enumeration for the badge action.
 147             </summary>
 148             <since_tizen> 3 </since_tizen>
 149         </member>
 150         <member name="F:Tizen.Applications.BadgeEventArgs.Action.Add">
 151             <summary>
 152             The badge was added.
 153             </summary>
 154         </member>
 155         <member name="F:Tizen.Applications.BadgeEventArgs.Action.Remove">
 156             <summary>
 157             The badge was removed.
 158             </summary>
 159         </member>
 160         <member name="F:Tizen.Applications.BadgeEventArgs.Action.Update">
 161             <summary>
 162             The badge was updated.
 163             </summary>
 164         </member>
 165         <member name="P:Tizen.Applications.BadgeEventArgs.Badge">
 166             <summary>
 167             The property for the badge object.
 168             </summary>
 169             <since_tizen> 3 </since_tizen>
 170         </member>
 171         <member name="P:Tizen.Applications.BadgeEventArgs.Reason">
 172             <summary>
 173             The property for the action value.
 174             </summary>
 175             <since_tizen> 3 </since_tizen>
 176         </member>
 177     </members>
 178 </doc>