Reference

BackstageClient.printerMedia

BackstageClient.printerMedia in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / printerMedia

printerMedia: {
  get: (deviceId: string, requestOptions?: RequestOptions) => Promise<{
     deviceId: string;
     loadedAt: string | null;
     mediaType: string | null;
     source: "staff" | "relay" | null;
  }>;
  set: (deviceId: string, request: {
     mediaType: string | null;
   }, requestOptions?: RequestOptions) => Promise<{
     deviceId: string;
     loadedAt: string | null;
     mediaType: string | null;
     source: "staff" | "relay" | null;
  }>;
};

Defined in: client.ts:7100

Printer media methods

get()#

get: (deviceId: string, requestOptions?: RequestOptions) => Promise<{
  deviceId: string;
  loadedAt: string | null;
  mediaType: string | null;
  source: "staff" | "relay" | null;
}>;

What a printer has loaded The media type a printer has loaded: what staff set, else what the relay reports in the printer's capabilities (print.loadedMedia). Needs devices.read on its account.

Parameters#

Parameter	Type
`deviceId`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ deviceId: string; loadedAt: string | null; mediaType: string | null; source: "staff" | "relay" | null; }>

Operation Id#

getPrinterMedia

set()#

set: (deviceId: string, request: {
  mediaType: string | null;
}, requestOptions?: RequestOptions) => Promise<{
  deviceId: string;
  loadedAt: string | null;
  mediaType: string | null;
  source: "staff" | "relay" | null;
}>;

Set what a printer has loaded Record the media type loaded in a printer. A print job for a template that targets a media type goes only to a printer with it loaded. Needs devices.update on its account.

Parameters#

Parameter	Type	Description
`deviceId`	`string`	-
`request`	{ `mediaType`: `string` \| `null`; }	-
`request.mediaType`	`string` \| `null`	Description What is loaded now; null clears it (the relay's report, if any, then applies)
`requestOptions?`	`RequestOptions`	-

Returns#

Promise<{ deviceId: string; loadedAt: string | null; mediaType: string | null; source: "staff" | "relay" | null; }>

Operation Id#

setPrinterMedia