Options
All
  • Public
  • Public/Protected
  • All
Menu

Class JSPrintManager

It handles WebSocket communication with the JSPrintManager Client App.

Hierarchy

  • JSPrintManager

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static WS

WS: NDWS

The JSPrintManager websocket.

Static auto_reconnect

auto_reconnect: boolean = false

If the websocket have closed, then retry to reconnect automatically

Accessors

Static license_url

  • get license_url(): string
  • set license_url(value: string): void

  • Gets or sets the URL to request the license info from.

    Returns string

  • Gets or sets the URL to request the license info from.

    Parameters

    • value: string

    Returns void

Static websocket_status

Methods

Static getClientAppInfo

  • getClientAppInfo(secure?: boolean, host?: string, port?: number): Promise<unknown>

  • Returns the JSPrintManager Client App Info including version, OS and CPU.

    Parameters

    • secure: boolean = true

      True to use WebSocket Secure (wss://); otherwise false.

    • host: string = 'localhost'

      The host name, 'localhost' by default.

    • port: number = WSPORT

      The local network port number.

    Returns Promise<unknown>

Static getDefaultPaperName

  • getDefaultPaperName(printer_name: string): Promise<any>

  • Returns the default paper name for the specified printer.

    Parameters

    • printer_name: string

      The printer name.

    Returns Promise<any>

Static getDefaultTrayName

  • getDefaultTrayName(printer_name: string): Promise<any>

  • Returns the default tray name for the specified printer.

    Parameters

    • printer_name: string

      The printer name.

    Returns Promise<any>

Static getInstances

  • getInstances(secure?: boolean, host?: string, port?: number): Promise<unknown>

  • Returns the JSPrintManager Client App instances.

    Parameters

    • secure: boolean = true

      True to use WebSocket Secure (wss://); otherwise false.

    • host: string = 'localhost'

      The host name, 'localhost' by default.

    • port: number = WSPORT

      The local network port number.

    Returns Promise<unknown>

Static getMAC

  • getMAC(): Promise<any>

  • Returns the Media Access Control (MAC) address of the client system.

    Returns Promise<any>

Static getPaperInfo

  • getPaperInfo(printer_name: string, paper_name: string): Promise<any>

  • Returns paper related info (width, height, printable area) for the specified printer and paper name.

    Parameters

    • printer_name: string

      The printer name.

    • paper_name: string

      The paper name.

    Returns Promise<any>

Static getPapers

  • getPapers(printer_name: string): Promise<any>

  • Returns the list of supported papers for the specified printer.

    Parameters

    • printer_name: string

      The printer name.

    Returns Promise<any>

Static getPrinters

  • getPrinters(): Promise<unknown>

  • Gets the list of installed printers in the client system.

    Returns Promise<unknown>

Static getPrintersInfo

  • getPrintersInfo(detail_level?: PrintersInfoLevel, printer_name?: string, printer_icon: None): Promise<unknown>

  • Gets detailed info of each installed printer in the client system.

    Parameters

    Returns Promise<unknown>

Static getScanners

  • getScanners(): Promise<any>

  • Returns the list of scanner devices available in the client system.

    Returns Promise<any>

Static getSerialPorts

  • getSerialPorts(): Promise<any>

  • Returns the list of Serial ports available in the client system.

    Returns Promise<any>

Static getSessionCertificate

  • getSessionCertificate(): Promise<unknown>

  • Gets an unique certificate / public-key to use for encryption scenarios. The returned JSON object is {"certificate":"CERT_PEM_FORMAT", "public_key":"PUB_KEY_PEM_FORMAT"}

    Returns Promise<unknown>

Static getSystemFonts

  • getSystemFonts(): Promise<any>

  • Returns the list of fonts name available in the client system.

    Returns Promise<any>

Static getTrays

  • getTrays(printer_name: string): Promise<any>

  • Returns the list of supported trays for the specified printer.

    Parameters

    • printer_name: string

      The printer name.

    Returns Promise<any>

Static getUser

  • getUser(): Promise<any>

  • Returns the User name of the current client system session.

    Returns Promise<any>

Static onPrinterCreated

  • onPrinterCreated(callback: any, error: any, detail_level?: PrintersInfoLevel): string

  • Occurs when a new printer is created in the client system.

    Parameters

    • callback: any

      The callback function

    • error: any

      The error function

    • detail_level: PrintersInfoLevel = PrintersInfoLevel.Extended

      The printers info details level

    Returns string

Static onPrinterDeleted

  • onPrinterDeleted(callback: any, error: any, detail_level?: PrintersInfoLevel): string

  • Occurs when any printer is deleted from the client system.

    Parameters

    • callback: any

      The callback function

    • error: any

      The error function

    • detail_level: PrintersInfoLevel = PrintersInfoLevel.Extended

      The printers info details level

    Returns string

Static onPrinterUpdated

  • onPrinterUpdated(callback: any, error: any, detail_level?: PrintersInfoLevel): string

  • Occurs when any printer is updated in the client system.

    Parameters

    • callback: any

      The callback function

    • error: any

      The error function

    • detail_level: PrintersInfoLevel = PrintersInfoLevel.Extended

      The printers info details level

    Returns string

Static showAbout

  • showAbout(): Promise<any>

  • Displays the About dialog of the JSPrintManager Client App.

    Returns Promise<any>

Static start

  • start(secure?: boolean, host?: string, port?: number): Promise<void>

  • Starts a WebSocket communication with the JSPrintManager Client App.

    Parameters

    • secure: boolean = true

      True to use WebSocket Secure (wss://); otherwise false.

    • host: string = 'localhost'

      The host name, 'localhost' by default.

    • port: number = WSPORT

      The local network port number.

    Returns Promise<void>

Static stop

  • stop(): void

  • Closes the WebSocket connection.

    Returns void

Static unsubscribePrinterEvent

  • unsubscribePrinterEvent(id: any): Promise<unknown>

  • Unsubscribes a given event ID

    Parameters

    • id: any

      The event ID

    Returns Promise<unknown>

Static updateClient

  • updateClient(): Promise<any>

  • Performs the update process of the JSPrintManager Client App.

    Returns Promise<any>