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
Inheritance
object
Disposable
Notification

Constructors

View Source

Notification(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.

Fields

View Source

ToastBottom

Toast will appear at the bottom of the screen.

Declaration
public static readonly Position ToastBottom
Field Value
Type Description
Position
View Source

ToastCenter

Toast will appear at the center of the screen.

Declaration
public static readonly Position ToastCenter
Field Value
Type Description
Position
View Source

ToastLong

Show the notification for a long period of time.

Declaration
public static readonly uint ToastLong
Field Value
Type Description
uint
View Source

ToastShort

Show the notification for a short period of time.

Declaration
public static readonly uint ToastShort
Field Value
Type Description
uint
View Source

ToastTop

Toast will appear at the top of the screen.

Declaration
public static readonly Position ToastTop
Field Value
Type Description
Position

Properties

View Source

ContentView

The content view received in a constructor.

Declaration
public View ContentView { get; }
Property Value
Type Description
View

Methods

View Source

Dismiss()

Dismiss the notification window.

Declaration
public void Dismiss()
View Source

Dispose(DisposeTypes)

Dispose.

Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type
Overrides
View Source

ForceQuit()

Dismiss the notification window directly without waiting the onDismissAnimation finished.

Declaration
public void ForceQuit()
View Source

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);
View Source

Post(uint)

Post a notification window with the content view.

Declaration
public void Post(uint duration = null)
Parameters
Type Name Description
uint duration

Dismiss the notification window after given time in millisecond. The value 0 won't dismiss the notification.
View Source

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
View Source

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
View Source

SetDismissOnTouch(bool)

Sets whether listen to touch event to dismiss notification window.

Declaration
public Notification SetDismissOnTouch(bool dismissOnTouch)
Parameters
Type Name Description
bool dismissOnTouch

Dismiss notification window on touch if the value is true.
Returns
Type Description
Notification

The current Notification instance.
View Source

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.
View Source

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.

Extension Methods