Class Contacts

Contacts is an API module for managing local contacts and finding contacts on the network

extends: API

Hierarchy

API
- Contacts

Index

Constructors

constructor

Methods

Constructors

constructor

new Contacts(opts?: ApiOptions): Contacts

Inherited from API.__constructor
- Defined in core/api.ts:68
Parameters
- Default value opts: ApiOptions = DEFAULT_API_OPTIONS
Returns Contacts

Methods

add

add(address: string, contact: Contact): Promise<boolean>

- Defined in modules/contacts.ts:18
Adds or updates a contact directly, usually from a search

Parameters
- address: string
- contact: Contact
  
  JSON object representing a contact
Returns Promise<boolean>

Whether the operation was sucessfull

get

get(address: string): Promise<Contact>

- Defined in modules/contacts.ts:34
Retrieve information about a known contact

Parameters
- address: string
  
  Address of the contact
Returns Promise<Contact>

The associated contact object

list

list(): Promise<ContactList>

- Defined in modules/contacts.ts:43
Retrieves a list of known contacts

Returns Promise<ContactList>

An array of all known contacts

remove

remove(contactId: string): Promise<boolean>

- Defined in modules/contacts.ts:54
Remove a known contact

Parameters
- contactId: string
Returns Promise<boolean>

Whether the operation was successfull

search

search(name?: undefined | string, address?: undefined | string, options?: QueryOptions): Promise<ReadableStream<QueryResult>>

- Defined in modules/contacts.ts:68
Searches locally and on the network for contacts by display name, peer id, or address

Parameters
- Optional name: undefined | string
  
  Search by display name string
- Optional address: undefined | string
  
  Search by account address string
- Optional options: QueryOptions
  
  Additional options to control the query
Returns Promise<ReadableStream<QueryResult>>

A ReadableStream of QueryResult objects. })