Struct libqaul::api::Contacts

pub struct Contacts<'chain> { /* fields omitted */ }

API scope type to access contact book functions

The contact book is a user local store of metadata, that can be assigned for each Identity, that a user is aware of on the network. A contact entry is backed by an entry in the user store, available via the users() endpoint scope.

A ContactEntry should be considered additional information a user can keep on someone they interact with on the network, independent of the UserProfile, which is fetched from the remote user themselves.

When assembling a complete view of a user, it’s important to consider both their primary profile, as well as the contact metadata stored via this API. Because of this, queries only return the ContactEntry structures, not the profile itself.

Furthermore, it is possible to query users via metadata set in a user’s local contact book, such as their nick, trust, location and more.

Implementations

impl<'qaul> Contacts<'qaul>

pub fn drop(&'qaul self) -> &'qaul Qaul

Drop this scope and return back to global Qaul scope

pub fn modify<F>(
    &self,
    user: UserAuth,
    contact: &Identity,
    modify: F
) -> Result<()> where
    F: FnOnce(&mut ContactEntry), 

Modify a user’s contact entry in a user-local contact book

The modify lambda allows a user to add personal metadata for a contact, such as a nickname, or trust levels. Each contact list is user local and it’s not possible to access other user’s contact metadata.

If no contact entry existed before, a fresh one will be created before calling the passed-in lambda.

pub fn get(&self, user: UserAuth, contact: &Identity) -> Result<ContactEntry>

Get a single ContactEntry from a user’s contact book

Considering that a ContactEntry might contain large amounts of data, this is the only way to return a reference to the full object. When trying to query all data from all contact entries, it’s advised to get a list of Identities via Contacts::get_all first, and then map this collection over Contacts::get afterwards.

pub fn query(
    &self,
    user: UserAuth,
    query: ContactQuery
) -> Result<Vec<Identity>>

Query for a subset of users that have a ContactEntry

To get a list of all ContactEntry objects, map the result of this function over Contacts::get.

# use libqaul::{Qaul, error::Result, contacts::ContactQuery};
# let qaul = Qaul::dummy();
# let user = qaul.users().create("abc").await.unwrap();
let contacts = qaul.contacts();
# (|| -> Result<()> {
contacts
    .query(user.clone(), ContactQuery::Nick("buddy".to_string()))?
    .into_iter()
    .map(|i| contacts.get(user.clone(), &i));
# Ok(())
# })().unwrap();

pub fn all(&self, user: UserAuth) -> Result<Vec<Identity>>

Get all users that have a ContactEntry for this user