xmpp-httpx - v0.11.0
    Preparing search index...

    Interface BodyOffer

    A body to hand to a handshake-driven transport (sipub, jingle). The transport builds its descriptor synchronously and registers pending state; open() is called (at most once) when the peer completes the handshake and bytes actually start flowing.

    interface BodyOffer {
        blockSize?: number;
        contentLength?: number;
        contentType?: string;
        from?: string;
        name?: string;
        onError?: (err: unknown) => void;
        ttlMs?: number;
        open(): | ReadableStream<Uint8Array<ArrayBufferLike>>
        | Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>;
    }
    Index
    blockSize? contentLength? contentType? from? name? onError? ttlMs?
    open
    blockSize?: number
    contentLength?: number
    contentType?: string
    from?: string

    Explicit sender JID — required when the session is a component.

    name?: string

    File name announced in transfer metadata. Default "body".

    onError?: (err: unknown) => void

    Failures after the descriptor was already sent land here.

    ttlMs?: number

    Offers expire unclaimed after this.

    • Returns
          | ReadableStream<Uint8Array<ArrayBufferLike>>
          | Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods