Filter class

Represents a filter for querying Nostr events.

This class encapsulates various criteria that can be used to filter Nostr events when querying relays or local caches. https://github.com/nostr-protocol/nips/blob/master/01.md#communication-between-clients-and-relays

Constructors

Filter({List<String>? ids, List<String>? authors, List<int>? kinds, String? search, Map<String, List<String>>? tags, List<String>? eTags, List<String>? pTags, List<String>? tTags, List<String>? aTags, List<String>? dTags, List<String>? mTags, int? since, int? until, int? limit})

Filter.fromJson(Map<String, dynamic> json)

factory

Filter.fromMap(Map<String, dynamic> map)

Properties

aTags → List<String>?

List of replaceable event tags to filter by.

no setter

authors ↔ List<String>?

List of author public keys to filter by.

getter/setter pair

dTags → List<String>?

...

no setter

eTags → List<String>?

List of event tags to filter by.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

ids ↔ List<String>?

List of event IDs to filter by.

getter/setter pair

kinds ↔ List<int>?

List of event kinds to filter by.

getter/setter pair

limit ↔ int?

Maximum number of events to return.

getter/setter pair

mTags → List<String>?

other tags

no setter

pTags → List<String>?

List of pubkey tags to filter by.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

search ↔ String?

Text to search for in event content.

getter/setter pair

since ↔ int?

Unix timestamp to filter events created after this time.

getter/setter pair

tags ↔ Map<String, List<String>>?

Map to store tags
Key is the tag name (# prefixed), value is a list of tag values

getter/setter pair

tTags → List<String>?

List of hashtag tags to filter by.

no setter

until ↔ int?

Unix timestamp to filter events created before this time.

getter/setter pair

Methods

clone() → Filter

cloneWithAuthors(List<String> authors) → Filter

Creates a new Filter with updated authors.

cloneWithPTags(List<String> pTags) → Filter

Creates a new Filter with updated pubkey tags.

getTag(String tagName) → List<String>?

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setTag(String tagName, List<String> values) → void

toJson() → Map<String, dynamic>

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

mergeAuthors(Filter filter1, Filter filter2) → Filter

Creates a new Filter by merging authors from two filters.