External module "contacts"

Index

Functions

Functions

add

add(contact: IContact): Promise<void>

- Defined in contacts.ts:22
Add a new Contact after fetching the Contact information.

Parameters
- contact: IContact
Returns Promise<void>

cancelSearch

cancelSearch(): Promise<void>

- Defined in contacts.ts:84
Cancel an ongoing contact search.
```
Textile.contacts.cancelSearch();
```
Returns Promise<void>

get

get(address: string): Promise<IContact>

- Defined in contacts.ts:30
Get Contact information by address.

Parameters
- address: string
Returns Promise<IContact>

list

list(): Promise<IContactList>

- Defined in contacts.ts:39
List all known Contacts.

Returns Promise<IContactList>

remove

remove(address: string): Promise<void>

- Defined in contacts.ts:47
Remove a Contact by their address.

Parameters
- address: string
Returns Promise<void>

search

search(query: IContactQuery, options: IQueryOptions): Promise<string>

- Defined in contacts.ts:68
Search for Contacts over network.
```
Textile.contacts.search(query, options);
```
Parameters
- query: IContactQuery
- options: IQueryOptions
Returns Promise<string>

threads

threads(address: string): Promise<IThreadList>

- Defined in contacts.ts:57
List all Threads in common with a Contact.
```
Textile.contacts.threads(address);
```
Parameters
- address: string
Returns Promise<IThreadList>