ContactList class

A contact list.

It can either be created as an empty contact list or populated using JSON data from a NIP-02 contact_list event:

// Create an empty contact list
var contacts = ContactList();

// Create a contact list populated by `contact_list` event tags
contacts = ContactList.fromJson([
  ["p", "91cf9..4e5ca", "wss://alicerelay.com/", "alice"],
  ["p", "14aeb..8dad4", "wss://bobrelay.com/nostr", "bob"],
  ["p", "612ae..e610f", "ws://carolrelay.com/ws", "carol"]
]);

ContactList is iterable so in addition to ContactList.get contacts in the contact list can be accessed like this:

for (Contact c in contacts){
  print(c.petname);
}
Mixed-in types

Constructors

ContactList()
Creates an empty ContactList.
ContactList.fromJson(List tags)
Creates a ContactList populated from tags which is a JSON array of event tags from a contact_list event as defined by NIP-02.
factory

Properties

first → Contact
The first element.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isEmpty → bool
Whether this collection has no elements.
no setterinherited
isNotEmpty → bool
Whether this collection has at least one element.
no setterinherited
iterator → Iterator<Contact>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last → Contact
The last element.
no setterinherited
length → int
The number of elements in this Iterable.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
single → Contact
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

add(Contact contact) → void
Adds contact to the ContactList.
any(bool test(Contact element)) → bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() → Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
contains(Object? element) → bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) → Contact
Returns the indexth element.
inherited
every(bool test(Contact element)) → bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(Contact element)) → Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(Contact element), {Contact orElse()?}) → Contact
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, Contact element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<Contact> other) → Iterable<Contact>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(Contact element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
get(String publicKey) → Contact
Gets a Contact specified by publicKey.
join([String separator = ""]) → String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(Contact element), {Contact orElse()?}) → Contact
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(Contact e)) → Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(Contact combine(Contact value, Contact element)) → Contact
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
remove(String publicKey) → Contact
Removes a Contact specified by publicKey from the ContactList and returns the removed Contact.
singleWhere(bool test(Contact element), {Contact orElse()?}) → Contact
The single element that satisfies test.
inherited
skip(int count) → Iterable<Contact>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(Contact value)) → Iterable<Contact>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) → Iterable<Contact>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(Contact value)) → Iterable<Contact>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toJson() → List
Returns the contact list as a JSON array of event tags.
toList({bool growable = true}) → List<Contact>
Creates a List containing the elements of this Iterable.
inherited
toSet() → Set<Contact>
Creates a Set containing the same elements as this iterable.
inherited
toString() → String
Returns a string representation of (some of) the elements of this.
inherited
where(bool test(Contact element)) → Iterable<Contact>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() → Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited