Artifacts/bin/public/Tizen.Applications.Badge.xml

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