Show / Hide Table of Contents

Class Notification

Notification for use in server side and for storage. Client side uses manually created NotificationView representation

Inheritance
System.Object
Notification
BroadcastNotification
DirectNotification
Implements
ISerializable
IBsonSerializable
IHasCreationTime
Namespace: Eco.Gameplay.Systems.Messaging.Notifications
Assembly: Eco.Gameplay.dll
Syntax
public abstract class Notification : Object, ISerializable, IBsonSerializable, IHasCreationTime

Constructors

Notification()

Declaration
protected Notification()

Notification(NotificationCategory, LocString, NotificationStyle)

Declaration
protected Notification(NotificationCategory category, LocString localizedText, NotificationStyle style)
Parameters
Type Name Description
NotificationCategory category
LocString localizedText
NotificationStyle style

Properties

Category

Declaration
public NotificationCategory Category { get; set; }
Property Value
Type Description
NotificationCategory

LocalizedText

Declaration
public LocString LocalizedText { get; set; }
Property Value
Type Description
LocString

Style

Declaration
public NotificationStyle Style { get; set; }
Property Value
Type Description
NotificationStyle

Text

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

TimeSeconds

Declaration
public double TimeSeconds { get; set; }
Property Value
Type Description
System.Double

Methods

GetOnlineReceivers()

Returns only online receivers as enumerable for the Notification.

Declaration
public abstract IEnumerable<User> GetOnlineReceivers()
Returns
Type Description
System.Collections.Generic.IEnumerable<User>

GetReceivers()

Returns all receivers as enumerable for the Notification.

Declaration
public abstract IEnumerable<User> GetReceivers()
Returns
Type Description
System.Collections.Generic.IEnumerable<User>

HasReceiver(User)

Checks if the notification has receiver.

Declaration
public abstract bool HasReceiver(User receiver)
Parameters
Type Name Description
User receiver
Returns
Type Description
System.Boolean

ToBson()

Declaration
public BSONArray ToBson()
Returns
Type Description
BSONArray

Implements

ISerializable
IBsonSerializable
IHasCreationTime

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾