Class Notification
Definition
- Namespace:
- Tizen.NUI.Components
- Assembly:
- Tizen.NUI.Components.dll
Notification helps to raise a notification window with a content View.
public class Notification : Disposable, IDisposable
- Inheritance
- Implements
-
System.IDisposable
Constructors
View SourceNotification(View)
Create a notification with a content View.
Declaration
public Notification(View contentView)
Parameters
Type | Name | Description |
---|---|---|
View | contentView | The content view instance to display in the notification window. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the device does not support a notification feature. |
System.ArgumentNullException | Thrown when a given contentView is null. |
Properties
View SourceContentView
The content view received in a constructor.
Declaration
public View ContentView { get; }
Property Value
Type | Description |
---|---|
View |
Methods
View SourceDismiss()
Dismiss the notification window.
Declaration
public void Dismiss()
Dispose(DisposeTypes)
Dispose.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type |
Overrides
View SourceForceQuit()
Dismiss the notification window directly without waiting the onDismissAnimation finished.
Declaration
public void ForceQuit()
MakeToast(string, Position)
Create a simple text notification called toast.
Declaration
public static Notification MakeToast(string text, Position gravity)
Parameters
Type | Name | Description |
---|---|---|
string | text | The string content. |
Position | gravity | The location at which the toast should appear. It's one of the notification constants: ToastTop, ToastCenter and ToastBottom. |
Returns
Type | Description |
---|---|
Notification | The created Notification instance. |
Examples
The following example demonstrates how to make a toast at the bottom and show it for a short period time.
Notification.MakeToast("Hello World!", Notification.ToastBottom).Post(Notification.ToastShort);
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | Thrown when the device does not support a notification feature. |
System.ArgumentNullException | Thrown when the given text or gravity is null. |
Post(uint)
Post a notification window with the content view.
Declaration
public void Post(uint duration = 0)
Parameters
Type | Name | Description |
---|---|---|
uint | duration | Dismiss the notification window after given time in millisecond. The value 0 won't dismiss the notification. |
Exceptions
Type | Condition |
---|---|
System.UnauthorizedAccessException | Thrown when the application does not have proper privilege. |
SetAnimationOnDismiss(Animation)
Sets a user-defined animation to play when dismiss the notification. On dismiss, the given animation is played, and after the playback is completed the notification window is undisplayed.
Declaration
public Notification SetAnimationOnDismiss(Animation animation)
Parameters
Type | Name | Description |
---|---|---|
Animation | animation | The animation to play. |
Returns
Type | Description |
---|---|
Notification |
SetAnimationOnPost(Animation)
Sets a user-defined animation to play when posting the notification. The Notification will play the given animation right after the notification window pops up.
Declaration
public Notification SetAnimationOnPost(Animation animation)
Parameters
Type | Name | Description |
---|---|---|
Animation | animation | The animation to play. |
Returns
Type | Description |
---|---|
Notification |
SetLevel(NotificationLevel)
Sets a priority level for the specified notification window. The default level is NotificationLevel.Base.
Declaration
public Notification SetLevel(NotificationLevel level)
Parameters
Type | Name | Description |
---|---|---|
NotificationLevel | level | The notification window level. |
Returns
Type | Description |
---|---|
Notification | The current Notification instance. |
Exceptions
Type | Condition |
---|---|
System.UnauthorizedAccessException | Thrown when the application does not have proper privilege. |
SetPositionSize(Rectangle)
Sets position and size of the notification window.
Declaration
public Notification SetPositionSize(Rectangle positionSize)
Parameters
Type | Name | Description |
---|---|---|
Rectangle | positionSize | The position and size information in rectangle. |
Returns
Type | Description |
---|---|
Notification | The current Notification instance. |
Exceptions
Type | Condition |
---|---|
System.ArgumentException | Thrown when a given positionSize is invalid. |