From a49fff63dfefc1791cc0294ff5d81503436fe54e Mon Sep 17 00:00:00 2001 From: davidliu Date: Wed, 18 Dec 2024 14:16:46 +0900 Subject: [PATCH] docs: add api docs for E2EE --- docs/classes/RNE2EEManager.html | 6 ++++++ docs/classes/RNKeyProvider.html | 11 +++++++++++ docs/functions/useRNE2EEManager.html | 1 + docs/interfaces/RNE2EEManagerState.html | 3 +++ docs/types/RNKeyProviderOptions.html | 2 ++ docs/types/UseRNE2EEManagerOptions.html | 1 + 6 files changed, 24 insertions(+) create mode 100644 docs/classes/RNE2EEManager.html create mode 100644 docs/classes/RNKeyProvider.html create mode 100644 docs/functions/useRNE2EEManager.html create mode 100644 docs/interfaces/RNE2EEManagerState.html create mode 100644 docs/types/RNKeyProviderOptions.html create mode 100644 docs/types/UseRNE2EEManagerOptions.html diff --git a/docs/classes/RNE2EEManager.html b/docs/classes/RNE2EEManager.html new file mode 100644 index 0000000..6fd226a --- /dev/null +++ b/docs/classes/RNE2EEManager.html @@ -0,0 +1,6 @@ +RNE2EEManager | LiveKit React Native Client SDK - v2.5.0

Class RNE2EEManagerExperimental

Hierarchy

  • TypedEventEmitter<E2EEManagerCallbacks, this>
    • RNE2EEManager

Implements

  • BaseE2EEManager

Constructors

constructor +

Methods

setParticipantCryptorEnabled +setSifTrailer +setup +setupEngine +

Constructors

constructor

Methods

setParticipantCryptorEnabled

  • setParticipantCryptorEnabled(enabled, participantIdentity): void

  • Parameters

    • enabled: boolean
    • participantIdentity: string

    Returns void

setSifTrailer

  • setSifTrailer(trailer): void

  • Parameters

    • trailer: Uint8Array

    Returns void

setup

  • setup(room): void

  • Parameters

    • room: Room

    Returns void

setupEngine

  • setupEngine(_engine): void

  • Parameters

    • _engine: default

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorsetParticipantCryptorEnabledsetSifTrailersetupsetupEngine
\ No newline at end of file diff --git a/docs/classes/RNKeyProvider.html b/docs/classes/RNKeyProvider.html new file mode 100644 index 0000000..2180b6a --- /dev/null +++ b/docs/classes/RNKeyProvider.html @@ -0,0 +1,11 @@ +RNKeyProvider | LiveKit React Native Client SDK - v2.5.0

Class RNKeyProviderExperimental

Hierarchy

  • BaseKeyProvider
    • RNKeyProvider

Constructors

constructor +

Methods

dispose +getLatestKeyIndex +ratchetKey +ratchetSharedKey +setKey +setSharedKey +setSifTrailer +

Constructors

constructor

Methods

dispose

getLatestKeyIndex

  • getLatestKeyIndex(participantId): number

  • Parameters

    • participantId: string

    Returns number

ratchetKey

  • ratchetKey(participantIdentity?, keyIndex?): Promise<void>

  • Parameters

    • Optional participantIdentity: string
    • Optional keyIndex: number

    Returns Promise<void>

ratchetSharedKey

  • ratchetSharedKey(keyIndex?): Promise<void>

  • Parameters

    • Optional keyIndex: number

    Returns Promise<void>

setKey

  • setKey(participantId, key, keyIndex?): Promise<any>

  • Accepts a passphrase that's used to create the crypto keys for a participant's stream.

    +

    Parameters

    • participantId: string
    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSharedKey

  • setSharedKey(key, keyIndex?): Promise<any>

  • Accepts a passphrase that's used to create the crypto keys.

    +

    Parameters

    • key: string | Uint8Array
    • Optional keyIndex: number

    Returns Promise<any>

setSifTrailer

  • setSifTrailer(trailer): Promise<any>

  • Parameters

    • trailer: Uint8Array

    Returns Promise<any>

Settings

Member Visibility

Theme

On This Page

constructordisposegetLatestKeyIndexratchetKeyratchetSharedKeysetKeysetSharedKeysetSifTrailer
\ No newline at end of file diff --git a/docs/functions/useRNE2EEManager.html b/docs/functions/useRNE2EEManager.html new file mode 100644 index 0000000..92b6a9a --- /dev/null +++ b/docs/functions/useRNE2EEManager.html @@ -0,0 +1 @@ +useRNE2EEManager | LiveKit React Native Client SDK - v2.5.0

Function useRNE2EEManager

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/interfaces/RNE2EEManagerState.html b/docs/interfaces/RNE2EEManagerState.html new file mode 100644 index 0000000..188fc72 --- /dev/null +++ b/docs/interfaces/RNE2EEManagerState.html @@ -0,0 +1,3 @@ +RNE2EEManagerState | LiveKit React Native Client SDK - v2.5.0

Interface RNE2EEManagerState

interface RNE2EEManagerState {
    e2eeManager: RNE2EEManager;
    keyProvider: RNKeyProvider;
}

Properties

e2eeManager +keyProvider +

Properties

e2eeManager

e2eeManager: RNE2EEManager

keyProvider

keyProvider: RNKeyProvider

Settings

Member Visibility

Theme

On This Page

e2eeManagerkeyProvider
\ No newline at end of file diff --git a/docs/types/RNKeyProviderOptions.html b/docs/types/RNKeyProviderOptions.html new file mode 100644 index 0000000..75147ff --- /dev/null +++ b/docs/types/RNKeyProviderOptions.html @@ -0,0 +1,2 @@ +RNKeyProviderOptions | LiveKit React Native Client SDK - v2.5.0

Type alias RNKeyProviderOptions

RNKeyProviderOptions: KeyProviderOptions & {
    uncryptedMagicBytes?: string | Uint8Array;
}

Options for construction an RNKeyProvider

+

Type declaration

  • Optional uncryptedMagicBytes?: string | Uint8Array

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/types/UseRNE2EEManagerOptions.html b/docs/types/UseRNE2EEManagerOptions.html new file mode 100644 index 0000000..9c74156 --- /dev/null +++ b/docs/types/UseRNE2EEManagerOptions.html @@ -0,0 +1 @@ +UseRNE2EEManagerOptions | LiveKit React Native Client SDK - v2.5.0

Type alias UseRNE2EEManagerOptions

UseRNE2EEManagerOptions: {
    keyProviderOptions?: RNKeyProviderOptions;
    sharedKey: string | Uint8Array;
}

Type declaration

Settings

Member Visibility

Theme

\ No newline at end of file