minca
ApiCoreInterfaces

Interface: NodeAccount

Defined in: packages/core/src/node/types.ts:797

Methods

picture()

picture(): Promise<
  | {
  bytes: Uint8Array;
  mime: string;
}
| null>;

Defined in: packages/core/src/node/types.ts:811

The account's picture, read from its registry; null without one, or without an account key

Returns

Promise< | { bytes: Uint8Array; mime: string; } | null>


profile()

profile(): Promise<AccountProfileView | null>;

Defined in: packages/core/src/node/types.ts:799

The account's profile; null without an account key, or before one is set

Returns

Promise<AccountProfileView | null>


revoke()

revoke(key, options?): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:813

Revokes one of this account's keys in the account registry. Needs an account key.

Parameters

ParameterType
keystring
options?RevokeOptions

Returns

Promise<boolean>


setAvatar()

setAvatar(image, options?): Promise<AccountProfileView>;

Defined in: packages/core/src/node/types.ts:806

Sets the account's picture everywhere, already resized; null removes it. name is kept with it when the registry has no name yet. Needs an account key.

Parameters

ParameterType
image| { bytes: Uint8Array; mime: string; } | null
options?{ name?: string; }
options.name?string

Returns

Promise<AccountProfileView>


setName()

setName(name): Promise<AccountProfileView>;

Defined in: packages/core/src/node/types.ts:801

Renames the account everywhere. Needs an account key.

Parameters

ParameterType
namestring

Returns

Promise<AccountProfileView>


space()

space(): Promise<string | null>;

Defined in: packages/core/src/node/types.ts:818

The account registry's space id, or null without an account key: where to keep what is the person's own across their devices, like an app's settings, as records in a collection of yours

Returns

Promise<string | null>

On this page