Class AggregatedNotifications

Inheritance
System.Object
AggregatedNotifications
Namespace: Eco.Gameplay.Systems.Messaging.Notifications
Assembly: Eco.Gameplay.dll
Syntax
public class AggregatedNotifications : Object

Constructors

AggregatedNotifications()

Declaration
public AggregatedNotifications()

Methods

AddAggregatedMessage(User, String, Object, Double, Boolean, Func<IEnumerable<User>, IEnumerable<Object>, LocString>, Boolean, Settlement)

Begin an aggregated message that appends the passed data to the list, updates the time of send, and assigns the instructions to how to build the final data. The notification will be identified as a key of user+handle string.

Declaration
public void AddAggregatedMessage(User user, string handle, object data, double delay, bool showOneThenStartDelaying, Func<IEnumerable<User>, IEnumerable<object>, LocString> makeMsg, bool accumulateSeparateMessagesPerUser = true, Settlement settlement = null)
Parameters
Type Name Description
User user
System.String handle
System.Object data
System.Double delay
System.Boolean showOneThenStartDelaying
System.Func<System.Collections.Generic.IEnumerable<User>, System.Collections.Generic.IEnumerable<System.Object>, LocString> makeMsg
System.Boolean accumulateSeparateMessagesPerUser

If true, each user will have their own separate notification. Otherwise, users will be accumulated into a single notification.
Settlement settlement

CurrentDatas(String)

Declaration
public IEnumerable<object> CurrentDatas(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Object>

GetAndClearReadyAggregatedMessages()

Get any aggregated messages from the queue, and clear them from the list.

Declaration
public IEnumerable<LocString> GetAndClearReadyAggregatedMessages()
Returns
Type Description
System.Collections.Generic.IEnumerable<LocString>

SetDelayOverride(Nullable<Int32>)

Override all aggregated notification delay, used for testing.

Declaration
public static void SetDelayOverride(Nullable<int> value)
Parameters
Type Name Description
System.Nullable<System.Int32> value

Extension Methods