PollRequest

CloudPRNTデバイスからhttp POSTを介してサーバーに送信されるStar CloudPRNTポーリングリクエストを表します。
このオブジェクトは、CloudPRNTクライアントデバイスからのJsonリクエストを デシリアライズすることで作成する必要があります。

NameSpace: StarMicronics.CloudPrnt.CpMessage

Syntax

public class PollRequest

Properties

barcodeReader

CloudPRNTクライアントデバイスに接続されているバーコードリーダーのステータス情報の取得または設定をします。

Declaration

public BarcodeReaderInfo[] barcodeReader { get; set; }

Property Value

Type

Description

BarcodeReaderInfo []

clientAction

An array of the CloudPRNT devices replies to any ClientAction requests made in a previous POST response from the server to the device (using a PollResponse object).

Declaration

public ClientActionResult[] clientAction { get; set; }

Property Value

Type

Description

ClientActionResult []

DecodedStatus

生Star ASB 'status'からデコードされた PrinterStatus オブジェクトを取得します。

Declaration

public PrinterStatus DecodedStatus { get; }

Property Value

Type

Description

PrinterStatus

display

CloudPRNTクライアントデバイスに接続されているディスプレイのステータス情報の取得または設定をします。

Declaration

public DisplayInfo[] display { get; set; }

Property Value

Type

Description

DisplayInfo []

keyboard

CloudPRNTクライアントデバイスに接続されているキーボードのステータス情報の取得または設定をします。

Declaration

public KeyboardInfo[] keyboard { get; set; }

Property Value

Type

Description

KeyboardInfo []

printerMAC

POSTリクエストを送信したデバイスのMACアドレスを取得または設定します。

Declaration

public string printerMAC { get; set; }

Property Value

Type

Description

System.String

printingInProgress

CloudPRNTクライアントデバイスが印刷処理中かどうかの状態を取得または設定します。
デバイスが現在印刷ジョブを処理しており、デバイスがバージョン2以降のCloudPRNT仕様をサポートしている場合、進行中の印刷はtrueを報告します。
古いバージョンのデバイスはこの情報は報告しません。

Declaration

public bool printingInProgress { get; set; }

Property Value

Type

Description

System.Boolean

status

Star ASB 形式の生デバイスステータスを取得または設定します。

Declaration

public string status { get; set; }

Property Value

Type

Description

System.String

statusCode

CloudPRNTクライアントデバイスのステータス概要を取得または設定します。
詳細ステータスは'status'または'DecodedStatus'プロパティを参照ください。

Declaration

public string statusCode { get; set; }

Property Value

Type

Description

System.String

uniqueID

CloudPRNTクライアントデバイスの割り当てIDを取得または設定します。
CloudPRNTサーバーはPOSTレスポンスのclientActionリクエストを利用してこのIDを割り当てます。
割り当てられない場合、nullを設定します。

Declaration

public string uniqueID { get; set; }

Property Value

Type

Description

System.String

Methods

FromJson(String)

有効なJSON文字列データをPollRequestオブジェクトに変換します。
失敗した場合は例外がスローされ、基になるシリアル化エンジン (現在は Newtonsoft.Json) のエラーを含む内部例外が発生します。

Declaration

public static PollRequest FromJson(string pollRequest)

Parameters

Type

Name

Description

System.String

pollRequest

JSON入力

Returns

Type

Description

PollRequest

デシリアライズされたPollRequestオブジェクト