Class BaseKeyProvider`Experimental`

Hierarchy (View Summary)

TypedEventEmitter<KeyProviderCallbacks, this>
- BaseKeyProvider
  - ExternalE2EEKeyProvider

Index

Constructors

Methods

getKeys getLatestManuallySetKeyIndex getOptions ratchetKey

Constructors

constructor

new BaseKeyProvider(options?: Partial<KeyProviderOptions>): BaseKeyProvider
Experimental
Parameters
- options: Partial<KeyProviderOptions> = {}
Returns BaseKeyProvider
Overrides (EventEmitter as new () => TypedEventEmitter<KeyProviderCallbacks>).constructor
- Defined in e2ee/KeyProvider.ts:19

Methods

getKeys

getKeys(): KeyInfo[]
Experimental
Returns KeyInfo[]
- Defined in e2ee/KeyProvider.ts:63

getLatestManuallySetKeyIndex

getLatestManuallySetKeyIndex(): number
Experimental
Returns number
- Defined in e2ee/KeyProvider.ts:67

getOptions

getOptions(): KeyProviderOptions
Experimental
Returns KeyProviderOptions
- Defined in e2ee/KeyProvider.ts:71

ratchetKey

ratchetKey(participantIdentity?: string, keyIndex?: number): void
Experimental
Parameters
- OptionalparticipantIdentity: string
- OptionalkeyIndex: number
Returns void
- Defined in e2ee/KeyProvider.ts:75