Class EnumerateDataFeedParameters<TDataFeed>

Namespace

MonkeyLoader.Resonite.DataFeeds

Assembly

MonkeyLoader.Resonite.Integration.dll

Represents the event data for the Enumerate Data Feed Event.

public sealed class EnumerateDataFeedParameters<TDataFeed> : AsyncEvent where TDataFeed : IDataFeed

Type Parameters

TDataFeed

The type of the data feed.

Inheritance

object

Event

AsyncEvent

EnumerateDataFeedParameters<TDataFeed>

Inherited Members

Event.GetDispatchableEventTypes(Type)

Event.IsAsyncEvent(Type)

Event.IsCancelable(Type)

Event.IsCancelableAsyncEvent(Type)

Event.IsCancelableSyncEvent(Type)

Event.IsEvent(Type)

Event.IsSyncEvent(Type)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

This event is used by concrete MonkeyLoader.Resonite.DataFeeds.DataFeedInjector<TDataFeed> implementations to signal that the FrooxEngine.IDataFeed they're patching is being enumerated.

Properties

DataFeed

Gets the FrooxEngine.IDataFeed instance that the enumeration request was made on.

public TDataFeed DataFeed { get; }

Property Value

TDataFeed

GroupKeys

Gets the group keys for this enumeration request. Can be empty.

public IReadOnlyList<string> GroupKeys { get; }

Property Value

IReadOnlyList<string>

HasGroupKeys

Gets whether this enumeration request has any GroupKeys.

public bool HasGroupKeys { get; }

Property Value

bool

true when there's at least one group key; otherwise, false.

HasSearchPhrase

Gets whether this enumeration request has a search phrase.

public bool HasSearchPhrase { get; }

Property Value

bool

true if SearchPhrase is not null or empty; otherwise, false.

HasViewData

Gets whether this enumeration request has custom view data.

public bool HasViewData { get; }

Property Value

bool

true if ViewData is not null; otherwise, false.

IncludeOriginalResult

Gets or sets whether the original result should be inserted into the generated sequence.

public bool IncludeOriginalResult { get; set; }

Property Value

bool

IsRootPath

Gets whether this enumeration request is for the root path.

public bool IsRootPath { get; }

Property Value

bool

true if there's no Path elements; otherwise false.

Path

Gets the path for this enumeration request.

public IReadOnlyList<string> Path { get; }

Property Value

IReadOnlyList<string>

SearchPhrase

Gets the search phrase for this enumeration request.

public string? SearchPhrase { get; }

Property Value

string

ViewData

Gets the custom view data for this enumeration request.

public object? ViewData { get; }

Property Value

object