Class BadgeControl

Definition

Namespace:
Tizen.Applications
Assembly:
Tizen.Applications.Badge.dll
API Level:
3

The class for badge operation.

C#
Copy
public static class BadgeControl
Inheritance
BadgeControl

Methods

View Source

Add(Badge)

Adds the badge information.

Declaration
C#
Copy
public static void Add(Badge badge)
Parameters
Type Name Description
Badge badge

The Badge object.

Exceptions
Type Condition
ArgumentException

Thrown when failed because of an invalid argument.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge
View Source

Find(String)

Gets the badge information from the application ID.

Declaration
C#
Copy
public static Badge Find(string appId)
Parameters
Type Name Description
String appId

Application ID.

Returns
Type Description
Badge

The Badge object with inputted application ID

Exceptions
Type Condition
ArgumentException

Thrown when failed because of an invalid argument.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge
View Source

GetBadges()

Gets all the badge information.

Declaration
C#
Copy
public static IEnumerable<Badge> GetBadges()
Returns
Type Description
IEnumerable<Badge>

List of all Badge instances.

Exceptions
Type Condition
UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge
View Source

Remove(String)

Removes the badge information.

Declaration
C#
Copy
public static void Remove(string appId)
Parameters
Type Name Description
String appId

Application ID.

Exceptions
Type Condition
ArgumentException

Thrown when failed because of a an invalid argument.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge
View Source

Remove(Badge)

Removes the badge information.

Declaration
C#
Copy
public static void Remove(Badge badge)
Parameters
Type Name Description
Badge badge

The Badge object.

Exceptions
Type Condition
ArgumentException

Thrown when failed because of an invalid argument.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge
View Source

Update(Badge)

Updates the badge information.

Declaration
C#
Copy
public static void Update(Badge badge)
Parameters
Type Name Description
Badge badge

The Badge object.

Exceptions
Type Condition
ArgumentException

Thrown when failed because of an invalid argument.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

InvalidOperationException

Thrown in case of failed conditions.

NotSupportedException

Thrown when Badge is not supported.

API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge

Events

View Source

Changed

Event handler for receiving badge events.

Declaration
C#
Copy
public static event EventHandler<BadgeEventArgs> Changed
Event Type
Type Description
EventHandler<BadgeEventArgs>
Exceptions
Type Condition
InvalidOperationException

Thrown in case of failed conditions.

UnauthorizedAccessException

Thrown when an application does not have the privilege to access.

NotSupportedException

Thrown when Badge is not supported.

API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/notification
Feature: http://tizen.org/feature/badge