Deep Trekker BRIDGE API - v1.0.3
    Preparing search index...

    Type Alias FileTransfer

    FileTransfer

    Describe the meta data related to a generic file transfer.

    type FileTransfer = {
        name?: string;
        readyToTransfer?: boolean;
        sha256?: string;
        size?: number;
    }
    Index

    Properties

    name? readyToTransfer? sha256? size?

    Properties

    name?: string

    File name

    The plain file name with file extension. May not contain directory structures.

    readyToTransfer?: boolean

    readyToTransfer

    Indicate the receiver is ready for the file transfer. Sender should await this response before sending a byte stream via WebRTC. May not send multiple files to a single endpoint at a time. If multiple files are attempted to be sent simultaneously the receiver should send an error message.

    sha256?: string

    Checksum

    The sha256 checksum used to verify the file content after transfer.

    size?: number

    File size

    Total number of bytes of the file.

    Settings

    Member Visibility

    On This Page

    Properties