{ "api": { "name": "CIDPrintPlugin", "slug": "cidprintplugin", "docs": "", "tags": [], "methods": [ { "name": "activateLicense", "signature": "(options: { licenseKey: string; customerID: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ licenseKey: string; customerID: string; }" } ], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "PrinterLibraryEvent" ], "slug": "activatelicense" }, { "name": "closeCIDPrinterLib", "signature": "() => void", "parameters": [], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "closecidprinterlib" }, { "name": "connectToPreferredPrinter", "signature": "(options: { mac: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ mac: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "connecttopreferredprinter" }, { "name": "connectToPreferredPrinter", "signature": "(options: { mac: string; autoreconnect: boolean; timeout: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ mac: string; autoreconnect: boolean; timeout: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "connecttopreferredprinter" }, { "name": "connectToPrinter", "signature": "(options: { address: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ address: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "connecttoprinter" }, { "name": "connectToPrinter", "signature": "(options: { address: string; autoreconnect: boolean; timeout: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ address: string; autoreconnect: boolean; timeout: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "connecttoprinter" }, { "name": "connectToPrinter", "signature": "(options: { address: string; port: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ address: string; port: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "connecttoprinter" }, { "name": "convert", "signature": "(options: { label: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ label: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "convert" }, { "name": "disconnectFromPrinter", "signature": "(options: { mac: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ mac: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "disconnectfromprinter" }, { "name": "discoverDevices", "signature": "(options: { timeout: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ timeout: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "discoverdevices" }, { "name": "enableBluetoothAdapter", "signature": "(options: { enable: boolean; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "PrinterLibraryEvent" ], "slug": "enablebluetoothadapter" }, { "name": "enableBluetoothPrinting", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enablebluetoothprinting" }, { "name": "enableCalibration", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enablecalibration" }, { "name": "enableClipping", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enableclipping" }, { "name": "enableDebugToFile", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enabledebugtofile" }, { "name": "enableDispendingMode", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enabledispendingmode" }, { "name": "enableNetworkPrinting", "signature": "(options: { enable: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ enable: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "enablenetworkprinting" }, { "name": "getLatestConnectState", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "PrinterLibraryEvent" ], "slug": "getlatestconnectstate" }, { "name": "getMediaSize", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "MediaSize" ], "slug": "getmediasize" }, { "name": "getPairedDevices", "signature": "() => void", "parameters": [], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "getpaireddevices" }, { "name": "getPrinterInformation", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "CIDPrinterInformation" ], "slug": "getprinterinformation" }, { "name": "getPrinterLibraryVersion", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [], "slug": "getprinterlibraryversion" }, { "name": "getPrinterStatus", "signature": "() => void", "parameters": [], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "getprinterstatus" }, { "name": "initCIDPrinterLib", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "PrinterLibraryEvent" ], "slug": "initcidprinterlib" }, { "name": "isBluetoothAdapterEnabled", "signature": "() => Promise<{ result: boolean; }>", "parameters": [], "returns": "Promise<{ result: boolean; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "isbluetoothadapterenabled" }, { "name": "isLibraryInitialized", "signature": "() => Promise<{ result: boolean; }>", "parameters": [], "returns": "Promise<{ result: boolean; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "islibraryinitialized" }, { "name": "printData", "signature": "(options: { data: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ data: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "printdata" }, { "name": "printLabel", "signature": "(options: { label: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ label: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "printlabel" }, { "name": "printLabelWithData", "signature": "(options: { label: string; data: string[]; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ label: string; data: string[]; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "printlabelwithdata" }, { "name": "printLabelWithObject", "signature": "(options: { label: string; data: TicketData; quantity: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ label: string; data: TicketData; quantity: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [ "TicketData" ], "slug": "printlabelwithobject" }, { "name": "printNativeData", "signature": "(options: { data: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ data: string; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "printnativedata" }, { "name": "printReferenceLabel", "signature": "(options: { labeltype: ReferenceTicketType; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ labeltype: ReferenceTicketType; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [ "ReferenceTicketType" ], "slug": "printreferencelabel" }, { "name": "requestPermission", "signature": "(options: { permission: string; }) => Promise<{ result: boolean; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ permission: string; }" } ], "returns": "Promise<{ result: boolean; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "requestpermission" }, { "name": "requestAllPermissions", "signature": "(options: { permissions: string[]; }) => Promise<{ result: boolean; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ permissions: string[]; }" } ], "returns": "Promise<{ result: boolean; }>", "tags": [], "docs": "", "complexTypes": [], "slug": "requestallpermissions" }, { "name": "sendFormFeed", "signature": "() => void", "parameters": [], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "sendformfeed" }, { "name": "setAutoReconnect", "signature": "(options: { autoreconnect: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ autoreconnect: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "setautoreconnect" }, { "name": "setConfiguration", "signature": "(options: { config: PrinterConfiguration; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ config: PrinterConfiguration; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [ "PrinterConfiguration" ], "slug": "setconfiguration" }, { "name": "setLTSSensitivity", "signature": "(options: { sensitivity: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ sensitivity: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "setltssensitivity" }, { "name": "setTimeouts", "signature": "(options: CIDPrintTimeoutOptions) => void", "parameters": [ { "name": "options", "docs": "timeout configuration values.", "type": "CIDPrintTimeoutOptions" } ], "returns": "void", "tags": [ { "name": "param", "text": "options timeout configuration values." } ], "docs": "", "complexTypes": [ "CIDPrintTimeoutOptions" ], "slug": "settimeouts" }, { "name": "setupMediaSize", "signature": "(options: { width: number; height: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ width: number; height: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "setupmediasize" }, { "name": "showNavigationBar", "signature": "(options: { show: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ show: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "shownavigationbar" }, { "name": "showSettings", "signature": "(options: { show: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ show: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "showsettings" }, { "name": "showUI", "signature": "(options: { show: boolean; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ show: boolean; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "showui" }, { "name": "uploadFile", "signature": "(options: { file: string; filetype: number; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ file: string; filetype: number; }" } ], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "uploadfile" }, { "name": "addListener", "signature": "(eventName: string, listenerFunc: (data: PrinterLibraryEvent) => void) => Promise & PluginListenerHandle", "parameters": [ { "name": "eventName", "docs": "", "type": "string" }, { "name": "listenerFunc", "docs": "", "type": "(data: PrinterLibraryEvent) => void" } ], "returns": "Promise & PluginListenerHandle", "tags": [], "docs": "", "complexTypes": [ "PluginListenerHandle", "PrinterLibraryEvent" ], "slug": "addlistenerstring" }, { "name": "removeAllListeners", "signature": "() => void", "parameters": [], "returns": "void", "tags": [], "docs": "", "complexTypes": [], "slug": "removealllisteners" } ], "properties": [] }, "interfaces": [ { "name": "PrinterLibraryEvent", "slug": "printerlibraryevent", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "sender", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "type", "tags": [], "docs": "", "complexTypes": [ "EventType" ], "type": "EventType" }, { "name": "message", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "error", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "data", "tags": [], "docs": "", "complexTypes": [ "ResultClass" ], "type": "ResultClass" }, { "name": "action", "tags": [], "docs": "", "complexTypes": [ "PrinterLibraryActionType" ], "type": "PrinterLibraryActionType" } ] }, { "name": "ResultClass", "slug": "resultclass", "docs": "", "tags": [], "methods": [], "properties": [] }, { "name": "MediaSize", "slug": "mediasize", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "width", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "height", "tags": [], "docs": "", "complexTypes": [], "type": "number" } ] }, { "name": "CIDPrinterInformation", "slug": "cidprinterinformation", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "firmware", "tags": [], "docs": "", "complexTypes": [ "Firmware" ], "type": "Firmware" }, { "name": "main_firmware", "tags": [], "docs": "", "complexTypes": [ "Firmware" ], "type": "Firmware" }, { "name": "module_firmware", "tags": [], "docs": "", "complexTypes": [ "Firmware" ], "type": "Firmware" }, { "name": "sensor_boot_firmware", "tags": [], "docs": "", "complexTypes": [ "Firmware" ], "type": "Firmware" }, { "name": "sensor_firmware", "tags": [], "docs": "", "complexTypes": [ "Firmware" ], "type": "Firmware" }, { "name": "media", "tags": [], "docs": "", "complexTypes": [ "Media" ], "type": "Media" }, { "name": "battery", "tags": [], "docs": "", "complexTypes": [ "Battery" ], "type": "Battery" }, { "name": "modeltype", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "modelname", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "dpi", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "dots_mm", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "dots", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "lanaddress", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "wlanaddress", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "btaddress", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "headcount", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "lifecount", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "cutcount", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "dispensecount", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "thermotransfer", "tags": [], "docs": "", "complexTypes": [], "type": "boolean" } ] }, { "name": "Firmware", "slug": "firmware", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "version", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "date", "tags": [], "docs": "", "complexTypes": [], "type": "string" }, { "name": "checksum", "tags": [], "docs": "", "complexTypes": [], "type": "string" } ] }, { "name": "Media", "slug": "media", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "labelwidth", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "labelheight", "tags": [], "docs": "", "complexTypes": [], "type": "number" } ] }, { "name": "Battery", "slug": "battery", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "cyclecount", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "chargestat", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "health", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "remain", "tags": [], "docs": "", "complexTypes": [], "type": "number" } ] }, { "name": "TicketData", "slug": "ticketdata", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "variables", "tags": [], "docs": "", "complexTypes": [ "TicketVariable" ], "type": "TicketVariable" } ] }, { "name": "TicketVariable", "slug": "ticketvariable", "docs": "", "tags": [], "methods": [], "properties": [] }, { "name": "PrinterConfiguration", "slug": "printerconfiguration", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "disconnectonpause", "tags": [], "docs": "", "complexTypes": [], "type": "boolean" }, { "name": "connectonresume", "tags": [], "docs": "", "complexTypes": [], "type": "boolean" }, { "name": "lowbatterythreshold", "tags": [], "docs": "", "complexTypes": [], "type": "number" }, { "name": "media", "tags": [], "docs": "", "complexTypes": [ "CIDMedia" ], "type": "CIDMedia" } ] }, { "name": "CIDMedia", "slug": "cidmedia", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "size", "tags": [], "docs": "", "complexTypes": [ "MediaSize" ], "type": "MediaSize" }, { "name": "type", "tags": [], "docs": "", "complexTypes": [ "MediaType" ], "type": "MediaType" } ] }, { "name": "CIDPrintTimeoutOptions", "slug": "cidprinttimeoutoptions", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "gap", "tags": [], "docs": "the time the communication protocol waits between send and receive calls (default 0ms)", "complexTypes": [], "type": "number" }, { "name": "timeout", "tags": [], "docs": "the time the communication protocol waits for a connection request (default 18000ms)", "complexTypes": [], "type": "number" }, { "name": "status", "tags": [], "docs": "the time the communication protocol waits for the answer to a status request (default 500ms)", "complexTypes": [], "type": "number" }, { "name": "information", "tags": [], "docs": "the time the communication protocol waits for the answer to the request for the printerinformation (default 1000ms)", "complexTypes": [], "type": "number" }, { "name": "formfeed", "tags": [], "docs": "the time the communication protocol waits for the answer to the request for a formfeed (default 200ms)", "complexTypes": [], "type": "number" }, { "name": "detect", "tags": [], "docs": "the time the communication protocol waits for the answer to the request for the printerinformation (default 400ms) only used with old SATO printers(MB200i).", "complexTypes": [], "type": "number" } ] }, { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise" } ] } ], "enums": [ { "name": "EventType", "slug": "eventtype", "members": [ { "name": "SUCCESS", "value": "0", "tags": [], "docs": "" }, { "name": "NOTIFY", "value": "1", "tags": [], "docs": "" }, { "name": "FAILED", "value": "2", "tags": [], "docs": "" } ] }, { "name": "PrinterLibraryActionType", "slug": "printerlibraryactiontype", "members": [ { "name": "NONE", "value": "0", "tags": [], "docs": "" }, { "name": "INITIALIZE", "value": "1", "tags": [], "docs": "" }, { "name": "BLUETOOTH_INITIALIZE", "value": "2", "tags": [], "docs": "" }, { "name": "BLUETOOTH_ENABLE", "value": "3", "tags": [], "docs": "" }, { "name": "BLUETOOTH_DISABLE", "value": "4", "tags": [], "docs": "" }, { "name": "DISCOVER_START", "value": "5", "tags": [], "docs": "" }, { "name": "DISCOVER_DETECT", "value": "6", "tags": [], "docs": "" }, { "name": "DISCOVER_FINISH", "value": "7", "tags": [], "docs": "" }, { "name": "CONNECT", "value": "8", "tags": [], "docs": "" }, { "name": "DISCONNECT", "value": "9", "tags": [], "docs": "" }, { "name": "PRINT", "value": "10", "tags": [], "docs": "" }, { "name": "STATUS", "value": "11", "tags": [], "docs": "" }, { "name": "CONFIGURE", "value": "12", "tags": [], "docs": "" }, { "name": "BLUETOOTH_TURNED_OFF", "value": "13", "tags": [], "docs": "" }, { "name": "BLUETOOTH_TURNED_ON", "value": "14", "tags": [], "docs": "" }, { "name": "LICENSE_ACTIVATION", "value": "15", "tags": [], "docs": "" }, { "name": "FILEUPLOAD", "value": "16", "tags": [], "docs": "" }, { "name": "EXCEPTION", "value": "17", "tags": [], "docs": "" } ] }, { "name": "ReferenceTicketType", "slug": "referencetickettype", "members": [ { "name": "DOT_MATRIX", "value": "0", "tags": [], "docs": "" } ] }, { "name": "MediaType", "slug": "mediatype", "members": [ { "name": "GAP", "value": "0", "tags": [], "docs": "" }, { "name": "IMARK", "value": "1", "tags": [], "docs": "" } ] } ], "typeAliases": [], "pluginConfigs": [] }