meshcore.js
ReferenceClasses

ContactManager

Defined in: packages/client/src/managers/contact-manager.ts:17

client.contacts: caches the radio's contact table, looks contacts up by key or prefix, removes them.

Constructors

Constructor

new ContactManager(client): ContactManager;

Defined in: packages/client/src/managers/contact-manager.ts:22

Parameters

client

Client

Owning client

Returns

ContactManager

Properties

cache

readonly cache: Collection<string, Contact>;

Defined in: packages/client/src/managers/contact-manager.ts:19


client

readonly client: Client;

Defined in: packages/client/src/managers/contact-manager.ts:18

Methods

fetch()

fetch(options?): Promise<Collection<string, Contact>>;

Defined in: packages/client/src/managers/contact-manager.ts:36

Parameters

options?

emitEvents emits contact events for the differences

emitEvents?

boolean

Returns

Promise<Collection<string, Contact>>


get()

get(keyOrPrefix): Contact | undefined;

Defined in: packages/client/src/managers/contact-manager.ts:27

Parameters

keyOrPrefix

string

Full key or a prefix of 12 hex characters or more

Returns

Contact | undefined


remove()

remove(contact): Promise<void>;

Defined in: packages/client/src/managers/contact-manager.ts:53

Parameters

contact

string | Contact

Contact or public key

Returns

Promise<void>


resetPath()

resetPath(contact): Promise<void>;

Defined in: packages/client/src/managers/contact-manager.ts:61

Parameters

contact

Contact

Contact to flood again

Returns

Promise<void>

On this page