Interface DirectoryStorage

interface DirectoryStorage {
    all(): Promise<Account[]>;
    get(accountId: string): Promise<undefined | Account>;
    indexByDisplay(display: string): Promise<Account[]>;
    indexByEmail(email: string): Promise<Account[]>;
    indexByPhone(phone: string): Promise<Account[]>;
}

Index

Methods

all get indexByDisplay indexByEmail indexByPhone

Methods

all

all(): Promise<Account[]>
Returns the list of all existing accounts.

Returns Promise<Account[]>
- Defined in directory/storage.ts:7

get

get(accountId: string): Promise<undefined | Account>
Returns an account by its ID. Returns undefined if no account is found.
Parameters
- accountId: string
  The AccountId that identifies an Account.
Returns Promise<undefined | Account>
- Defined in directory/storage.ts:31

indexByDisplay

indexByDisplay(display: string): Promise<Account[]>
Returns this list of accounts, indexed by display.
Parameters
- display: string
  A nickname to display quickly identifying an account.
Returns Promise<Account[]>
- Defined in directory/storage.ts:13

indexByEmail

indexByEmail(email: string): Promise<Account[]>
Returns this list of accounts, indexed by email.
Parameters
- email: string
  The email of the Account.
Returns Promise<Account[]>
- Defined in directory/storage.ts:25

indexByPhone

indexByPhone(phone: string): Promise<Account[]>
Returns this list of accounts, indexed by phone.
Parameters
- phone: string
  The phone number of the Account.
Returns Promise<Account[]>
- Defined in directory/storage.ts:19