Class IdentitiesManager

Hierarchy

CreateDestroyStartStop
- IdentitiesManager

Constructors

constructor

new IdentitiesManager(__namedParameters): IdentitiesManager
Parameters
- __namedParameters: {
      db: DB;
      gestaltGraph: GestaltGraph;
      keyRing: KeyRing;
      logger: Logger;
      sigchain: Sigchain;
  }
  - db: DB
  - gestaltGraph: GestaltGraph
  - keyRing: KeyRing
  - logger: Logger
  - sigchain: Sigchain
Returns IdentitiesManager
Inherited from CreateDestroyStartStop.constructor
- Defined in src/identities/IdentitiesManager.ts:83

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` db

db: DB

`Protected` gestaltGraph

gestaltGraph: GestaltGraph

`Protected` identitiesDbPath

identitiesDbPath: readonly (string | Buffer)[] = ...

`Protected` identitiesTokensDbPath

identitiesTokensDbPath: readonly (string | Buffer)[] = ...

Tokens stores ProviderId -> ProviderTokens

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` providers

providers: Map<ProviderId, Provider> = ...

`Protected` sigchain

sigchain: Sigchain

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

delToken

delToken(providerId, identityId, tran?): Promise<void>
Parameters
- providerId: ProviderId
- identityId: IdentityId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/identities/IdentitiesManager.ts:217

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/identities/IdentitiesManager.ts:117

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

getProvider

getProvider(pId): undefined | Provider
Parameters
- pId: ProviderId
Returns undefined | Provider
- Defined in src/identities/IdentitiesManager.ts:129

getProviders

getProviders(): Record<ProviderId, Provider>
Returns Record<ProviderId, Provider>
- Defined in src/identities/IdentitiesManager.ts:124

getToken

getToken(providerId, identityId, tran?): Promise<undefined | ProviderToken>
Parameters
- providerId: ProviderId
- identityId: IdentityId
- Optional tran: DBTransaction
Returns Promise<undefined | ProviderToken>
- Defined in src/identities/IdentitiesManager.ts:174

getTokens

getTokens(providerId, tran?): Promise<ProviderTokens>
Parameters
- providerId: ProviderId
- Optional tran: DBTransaction
Returns Promise<ProviderTokens>
- Defined in src/identities/IdentitiesManager.ts:153

handleClaimIdentity

handleClaimIdentity(providerId, identityId): Promise<IdentitySignedClaim>
Parameters
- providerId: ProviderId
- identityId: IdentityId
Returns Promise<IdentitySignedClaim>
- Defined in src/identities/IdentitiesManager.ts:244

putToken

putToken(providerId, identityId, providerToken, tran?): Promise<void>
Parameters
- providerId: ProviderId
- identityId: IdentityId
- providerToken: ProviderToken
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/identities/IdentitiesManager.ts:196

registerProvider

registerProvider(p): void
Parameters
- p: Provider
Returns void
- Defined in src/identities/IdentitiesManager.ts:134

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/identities/IdentitiesManager.ts:103

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/identities/IdentitiesManager.ts:112

unregisterProvider

unregisterProvider(pId): void
Parameters
- pId: ProviderId
Returns void
- Defined in src/identities/IdentitiesManager.ts:148

`Static` createIdentitiesManager

createIdentitiesManager(__namedParameters): Promise<IdentitiesManager>
Parameters
- __namedParameters: {
      db: DB;
      fresh?: boolean;
      gestaltGraph: GestaltGraph;
      keyRing: KeyRing;
      logger: Logger;
      sigchain: Sigchain;
  }
  - db: DB
  - Optional fresh?: boolean
  - gestaltGraph: GestaltGraph
  - keyRing: KeyRing
  - logger: Logger
  - sigchain: Sigchain
Returns Promise<IdentitiesManager>
- Defined in src/identities/IdentitiesManager.ts:40

Class IdentitiesManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { db: DB; gestaltGraph: GestaltGraph; keyRing: KeyRing; logger: Logger; sigchain: Sigchain; }

db: DB

gestaltGraph: GestaltGraph

keyRing: KeyRing

logger: Logger

sigchain: Sigchain

Returns IdentitiesManager

Properties

Readonly [initLock]

Protected db

Protected gestaltGraph

Protected identitiesDbPath

Protected identitiesTokensDbPath

Protected keyRing

Protected logger

Protected providers

Protected sigchain

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

delToken

Parameters

providerId: ProviderId

identityId: IdentityId

Optional tran: DBTransaction

Returns Promise<void>

destroy

Returns Promise<void>

dispatchEvent

Parameters

event: Event

Returns boolean

getProvider

Parameters

pId: ProviderId

Returns undefined | Provider

getProviders

Returns Record<ProviderId, Provider>

getToken

Parameters

providerId: ProviderId

identityId: IdentityId

Optional tran: DBTransaction

Returns Promise<undefined | ProviderToken>

getTokens

Parameters

__namedParameters: {
db: DB;
gestaltGraph: GestaltGraph;
keyRing: KeyRing;
logger: Logger;
sigchain: Sigchain;
}

`Readonly` [initLock]

`Protected` db

`Protected` gestaltGraph

`Protected` identitiesDbPath

`Protected` identitiesTokensDbPath

`Protected` keyRing

`Protected` logger

`Protected` providers

`Protected` sigchain

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` options: boolean | EventListenerOptions

__namedParameters: {
fresh?: boolean;
} = {}

`Optional` fresh?: boolean

`Static` createIdentitiesManager

__namedParameters: {
db: DB;
fresh?: boolean;
gestaltGraph: GestaltGraph;
keyRing: KeyRing;
logger: Logger;
sigchain: Sigchain;
}

`Optional` fresh?: boolean