Class BaseUserIDList<T>

Inheritance
System.Object
BaseUserIDList<T>
TimeUserIDList
UserIDList
Namespace: Eco.Gameplay.Players
Assembly: Eco.Gameplay.dll
Syntax
public abstract class BaseUserIDList<T> : Object
Type Parameters
Name Description
T

Constructors

BaseUserIDList()

Declaration
protected BaseUserIDList()

Fields

UserIDAddedEvent

Declaration
public ThreadSafeAction<string> UserIDAddedEvent
Field Value
Type Description
ThreadSafeAction<System.String>

UserIDRemovedEvent

Declaration
public ThreadSafeAction<string> UserIDRemovedEvent
Field Value
Type Description
ThreadSafeAction<System.String>

Properties

CachedDescribeEntries

Declaration
protected virtual List<string> CachedDescribeEntries { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Collection

Declaration
public SerializedSynchronizedCollection<T> Collection { get; set; }
Property Value
Type Description
SerializedSynchronizedCollection<T>

Methods

AddAndNotifyOrDescribe(IChatClient, String, String, Nullable<LocString>, String)

Add user to the collection and notify result or describe result

Declaration
public User AddAndNotifyOrDescribe(IChatClient invoker, string targetIdOrName, string time = "", Nullable<LocString> listDisplayName = null, string reason = "")
Parameters
Type Name Description
IChatClient invoker
System.String targetIdOrName
System.String time

For how long user should stay in the list. If empty : time is five years. Format: 1m, 1h, 1d, 1w
System.Nullable<LocString> listDisplayName
System.String reason
Returns
Type Description
User

Contains(User)

Declaration
public bool Contains(User user)
Parameters
Type Name Description
User user
Returns
Type Description
System.Boolean

Contains(StrangeUser)

Declaration
public bool Contains(StrangeUser strangeUser)
Parameters
Type Name Description
StrangeCloud.Service.Client.Contracts.StrangeUser strangeUser
Returns
Type Description
System.Boolean

ContainsByParams(String[])

Declaration
protected abstract bool ContainsByParams(params string[] ids)
Parameters
Type Name Description
System.String[] ids
Returns
Type Description
System.Boolean

DescribeCollection(IChatClient)

Declaration
public void DescribeCollection(IChatClient invoker)
Parameters
Type Name Description
IChatClient invoker

FindAndAddOrRemoveToList(IChatClient, String, String, Boolean, Nullable<LocString>, String)

Helper that shows elements of the collection or tries to add or remove provided string element (updates config if something was changed).

Declaration
protected User FindAndAddOrRemoveToList(IChatClient invoker, string targetIdOrName, string time, bool add = true, Nullable<LocString> listDisplayName = null, string reason = "")
Parameters
Type Name Description
IChatClient invoker
System.String targetIdOrName
System.String time
System.Boolean add
System.Nullable<LocString> listDisplayName
System.String reason
Returns
Type Description
User

RemoveAndNotify(IChatClient, String, Nullable<LocString>, String)

Declaration
public void RemoveAndNotify(IChatClient invoker, string targetIdOrName, Nullable<LocString> listDisplayName = null, string reason = "")
Parameters
Type Name Description
IChatClient invoker
System.String targetIdOrName
System.Nullable<LocString> listDisplayName
System.String reason

TryAddUser(String, (Boolean, DateTime))

Declaration
protected abstract bool TryAddUser(string targetIdOrName, (bool, DateTime) countedTime)
Parameters
Type Name Description
System.String targetIdOrName
System.ValueTuple<System.Boolean, System.DateTime> countedTime
Returns
Type Description
System.Boolean

TryRemoveUser(String)

Declaration
protected abstract bool TryRemoveUser(string targetIdOrName)
Parameters
Type Name Description
System.String targetIdOrName
Returns
Type Description
System.Boolean

UpdateStoredUsers()

Declaration
protected abstract void UpdateStoredUsers()

Extension Methods