Interface Channel

Hierarchy

  • Channel

Properties

awaitInit awaitMsg awaitRes close keypair open send sendFin sendInit sendMsg sendRes subscribe ws?

Properties

awaitInit

awaitInit: (() => Promise<AwakeInit>)

Type declaration

awaitMsg

awaitMsg: ((did: Principal<string>) => Promise<AwakeMsgDecrypted>)

Type declaration

    • (did: Principal<string>): Promise<AwakeMsgDecrypted>

    • Awaits for a awake/msg and decrypts payload from sender DID

      Parameters

      • did: Principal<string>

      Returns Promise<AwakeMsgDecrypted>

awaitRes

awaitRes: (() => Promise<AwakeRes>)

Type declaration

    • (): Promise<AwakeRes>

    • Awaits for awake/res msg and decrypts ucan payload from send DID

      Returns Promise<AwakeRes>

close

close: ((code?: number, reason?: string) => Promise<Channel>)

Type declaration

    • (code?: number, reason?: string): Promise<Channel>

    • Parameters

      • Optional code: number
      • Optional reason: string

      Returns Promise<Channel>

keypair

keypair: KeyExchangeKeypair

open

open: (() => Promise<Channel>)

Type declaration

send

send: ((data: unknown) => void)

Type declaration

    • (data: unknown): void

    • Sends a data as a message Data should run through JSON.stringify

      Parameters

      • data: unknown

      Returns void

sendFin

sendFin: ((did: Principal<string>) => Promise<void>)

Type declaration

    • (did: Principal<string>): Promise<void>

    • Parameters

      • did: Principal<string>

      Returns Promise<void>

sendInit

sendInit: ((caps: Capabilities) => Promise<void>)

Type declaration

    • (caps: Capabilities): Promise<void>

    • Send awake init message to responder did - The Requestor's initial (temp) ECDH P-256

      Parameters

      • caps: Capabilities

        Capabilities that the Responder MUST provide

      Returns Promise<void>

sendMsg

sendMsg: ((did: Principal<string>, msg: unknown) => Promise<void>)

Type declaration

    • (did: Principal<string>, msg: unknown): Promise<void>

    • Send generic awake/msg with encrypted payload and message id

      Parameters

      • did: Principal<string>

        DID to encrypt for

      • msg: unknown

        Message to be encrypted and sent

      Returns Promise<void>

sendRes

sendRes: ((aud: Principal<string>, msg: View<Capabilities>) => Promise<void>)

Type declaration

    • (aud: Principal<string>, msg: View<Capabilities>): Promise<void>

    • Send awake res message to requestor

      Parameters

      • aud: Principal<string>

        The ECDH P-256 DID signalled by the Requestor in previous awake/init

      • msg: View<Capabilities>

      Returns Promise<void>

subscribe

subscribe: ((type: "awake/init" | "awake/res" | "awake/msg", fn: Handler<unknown>, once?: boolean) => (() => void))

Type declaration

    • (type: "awake/init" | "awake/res" | "awake/msg", fn: Handler<unknown>, once?: boolean): (() => void)

    • Parameters

      • type: "awake/init" | "awake/res" | "awake/msg"
      • fn: Handler<unknown>
      • Optional once: boolean

      Returns (() => void)

        • (): void

        • Returns void

Optional ws

ws?: WebSocket | WebSocket

Settings

Member Visibility

Theme

Generated using TypeDoc