Struct Notification

Represents a notification to be sent or a received one.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Notifications

Assembly: Unity.Notifications.Unified.dll

Syntax

public struct Notification

Remarks

Can be converted to platform specific notification via explicit cast.

Examples

var n1 = (AndroidNotification)notification; // convert to Android
var n1 = (iOSNotification)notification; // convert to iOS

Properties

Badge

Number, associated with the notification. Zero is ignored. When supported, shows up as badge on application launcher.

Declaration

public int Badge { get; set; }

Property Value

Type	Description
int

Data

Arbitrary data that is sent with notification. Can be used to store some useful information in the notification to be later retrieved when notification arrives or is tapped by user.

Declaration

public string Data { get; set; }

Property Value

Type	Description
string

Group

Identifier for the group this notification belong to. If device supports it, notifications with same group identifier are stacked together. On Android this is also called group, while on iOS it is called thread identidier.

Declaration

public string Group { get; set; }

Property Value

Type	Description
string

Identifier

A unique identifier for this notification. If null, a unique ID will be generated when scheduling.

Declaration

public int? Identifier { readonly get; set; }

Property Value

Type	Description
int?

IsGroupSummary

Marks this notification as group summary. Only has effect if Group is also set. Android only. On iOS will be just another notification in the group.

Declaration

public bool IsGroupSummary { get; set; }

Property Value

Type	Description
bool

ShowInForeground

Indicated, whether notification should be shown if it arrives while application is in foreground. When notification arrives with app in foreground OnNotificationReceived even fires regardless of this. Default is false, meaning notifications are silent when app is in foreground.

Declaration

public bool ShowInForeground { readonly get; set; }

Property Value

Type	Description
bool

Text

String that is shown on notification as it's main body.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

Title

String that is shown on notification as title.

Declaration

public string Title { get; set; }

Property Value

Type	Description
string

Operators

explicit operator iOSNotification(Notification)

Notification can be converted to its platform-specific counterpart using explicit cast.

Declaration

public static explicit operator iOSNotification(Notification n)

Parameters

Type	Name	Description
Notification	n	Notification to convert

Returns

Type	Description
iOSNotification	Resulting platform-specific notification