minca
ApiSessionInterfaces

Interface: StaySignedInStore

Defined in: packages/core/src/session/stay-signed-in.ts:91

Methods

choice()

choice(): StaySignedIn;

Defined in: packages/core/src/session/stay-signed-in.ts:93

The chosen length

Returns

StaySignedIn


forget()

forget(): Promise<void>;

Defined in: packages/core/src/session/stay-signed-in.ts:103

Deletes the kept key: the next visit asks to unlock

Returns

Promise<void>


recall()

recall(place): Promise<
  | {
  accountId: string;
  seed: Uint8Array;
}
| null>;

Defined in: packages/core/src/session/stay-signed-in.ts:99

The seed this device kept, if still in date and for the kind of place that is open. Using it pushes the expiry forward.

Parameters

ParameterType
place"folder" | "browser"

Returns

Promise< | { accountId: string; seed: Uint8Array; } | null>


remember()

remember(
   accountId, 
   place, 
   seed
): Promise<void>;

Defined in: packages/core/src/session/stay-signed-in.ts:97

Keeps the seed on this device after an unlock, when the choice allows it

Parameters

ParameterType
accountIdstring
place"folder" | "browser"
seedUint8Array

Returns

Promise<void>


setChoice()

setChoice(choice): Promise<void>;

Defined in: packages/core/src/session/stay-signed-in.ts:95

Changes it. "Ask every time" forgets the current one straight away; a new length applies from now.

Parameters

ParameterType
choiceStaySignedIn

Returns

Promise<void>


until()

until(): Date | null;

Defined in: packages/core/src/session/stay-signed-in.ts:101

When the kept sign-in runs out, or null when there is none

Returns

Date | null

On this page