Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

AutoConnectDeviceRegister

AutoConnectDeviceRegister<T>: { DeviceConnection: HardwareDeviceRegister; DeviceType: AutoConnectDeviceType; Options?: T; type?: "auto" }

自动连接 设备类型的协议注册器

不需要提供 Discover

Type parameters

  • T

Type declaration

  • DeviceConnection: HardwareDeviceRegister

    硬件设备类

  • DeviceType: AutoConnectDeviceType

    需要提供一个自动连接的设备类型

  • Optional Options?: T

    注册参数,实例化 DeviceConnection 的时候作为第三个参数提供

  • Optional type?: "auto"

    type 默认可以不提供,默认就是 'auto'

AutoConnectDeviceType

AutoConnectDeviceType: CommonDeviceType & { connectType?: "auto" }

自动连接 设备类型

CommonDeviceType

CommonDeviceType: { icon?: string; id: string; name: string; tip?: DeviceConnectionTip }

通用的 设备类型 定义

Type declaration

  • Optional icon?: string

    图标 支持 base64 或者 url, 大小在 128x128 或者 256x256 512x512 更佳

  • id: string

    唯一 ID

  • name: string

    名字

  • Optional tip?: DeviceConnectionTip

    连接提示

DefaultTargetData

DefaultTargetData: { json: CommonSerializeTargetJson & { ucode?: { assets?: SerializedTargetAssetList } } } | undefined

DeserializeData

DeserializeData: { json: DeviceTargetSerializedData } | undefined

DeviceConnectionTip

DeviceConnectionTip: { data: string; type: "text" } | { data: { src: string; text: string }[]; type: "image" } | { src: string; type: "video" } | { src: string; type: "gif" } | { data: string; type: "markdown" }

DeviceRegisterType

DeviceTargetCustomData

DeviceTargetCustomData: { extId: string; extType: string; extensionInfo?: { USV?: string; origin: ExternalHardwareExtensionOrigin; version: string } }

Type declaration

DeviceTargetSerializedData

DeviceTargetSerializedData: SerializedTargetJson<"device", DeviceTargetCustomData>

DeviceType

DiscoverConstructorArgumentType

DiscoverConstructorArgumentType<T>: { deviceType: DeviceType; eventbus: DiscoverEventBus; options?: T; getWorkingMode: any }

Type parameters

  • T = any

Type declaration

DiscoverDeviceRegister

DiscoverDeviceRegister<T>: { DeviceConnection: HardwareDeviceRegister; DeviceType: DiscoverDeviceType; Discover: DiscoverRegister; Options?: T; type: "discover" }

扫描 设备类型的协议注册器

需要提供 Discover

Type parameters

  • T

Type declaration

  • DeviceConnection: HardwareDeviceRegister

    硬件设备类

  • DeviceType: DiscoverDeviceType

    必须 提供一个 扫描 设备类型

  • Discover: DiscoverRegister

    硬件扫描类

  • Optional Options?: T

    注册参数,实例化 Discover 或者 DeviceConnection 的时候作为第三个参数提供

  • type: "discover"

    类型必须是: discover

DiscoverDeviceType

DiscoverDeviceType: CommonDeviceType & { connectType: "discover"; scanTime?: number; skipDuplicate?: boolean }

扫描 设备类型

ExternalHardwareExtensionOrigin

ExternalHardwareExtensionOrigin: "development" | "external" | "internal"

HardwareDeviceConstructorArgumentType

HardwareDeviceConstructorArgumentType<T>: { deviceType: DeviceType; eventbus: DeviceEventbusInterface; options?: T; getWorkingMode: any }

Type parameters

  • T = any

Type declaration

IDesktopApis

IDesktopApis: { ipcApis: { listen: any; send: any }; getWebBluetoothIntercept: any }

Type declaration

  • ipcApis: { listen: any; send: any }
    • listen:function
      • listen(channel: string, callback: (event: any, ...args: any[]) => void): void
      • Parameters

        • channel: string
        • callback: (event: any, ...args: any[]) => void
            • (event: any, ...args: any[]): void
            • Parameters

              • event: any
              • Rest ...args: any[]

              Returns void

        Returns void

    • send:function
      • send(channel: string, ...args: any): void
      • Parameters

        • channel: string
        • Rest ...args: any

        Returns void

  • getWebBluetoothIntercept:function

InputDeviceIdConfigType

InputDeviceIdConfigType: { inputPlaceholder?: string; invalidInputTip?: string; verifyRegex?: string | RegExp }

Type declaration

  • Optional inputPlaceholder?: string
  • Optional invalidInputTip?: string
  • Optional verifyRegex?: string | RegExp

InputDeviceIdRegister

InputDeviceIdRegister<T>: { DeviceConnection: HardwareDeviceRegister; DeviceType: InputIdDeviceType; Options?: T; type?: "inputDeviceId" }

输入设备ID 设备类型的协议注册器

不需要提供 Discover

Type parameters

  • T

Type declaration

  • DeviceConnection: HardwareDeviceRegister

    硬件设备类

  • DeviceType: InputIdDeviceType

    需要提供一个自动连接的设备类型

  • Optional Options?: T

    注册参数,实例化 DeviceConnection 的时候作为第三个参数提供

  • Optional type?: "inputDeviceId"

    type 默认可以不提供,默认就是 'auto'

InputIdDeviceType

InputIdDeviceType: CommonDeviceType & { configInfo?: InputDeviceIdConfigType; connectType: "inputDeviceId" }

输入设备id

SetBlockWarningTextArguments

SetBlockWarningTextArguments: { blockId: string; targetId: string; text: Error | string | IntlMessage | unknown }

Type declaration

  • blockId: string
  • targetId: string
  • text: Error | string | IntlMessage | unknown

blockOnValidate

blockOnValidate: (event?: any) => void

Type declaration

    • (event?: any): void
    • Parameters

      • Optional event: any

      Returns void

Generated using TypeDoc