PollResponse

受信したPollリクエストへのレスポンスにてCloudPRNTクライアントデバイスに送信される可能性のあるフィールドを表します。

このオブジェクトは、Jsonデータとしてシリアライズしたレスポンスデータを、POSTリクエストの受信に応じて、http経由でCloudPRNTクライアントデバイスへ返すことを目的としています。

NameSpace: StarMicronics.CloudPrnt.CpMessage

Syntax

public class PollResponse

Properties

claimBarcodeReader

スキャンイベントを受信するためにサーバーが要求するバーコードリーダーデバイス名のリストを取得または設定します。

クレームを維持し、バーコードスキャンイベントを受信し続けるためには、すべてのPOSTリクエストに対するレスポンスにこれを設定する必要があります。

Declaration

public List<string> claimBarcodeReader { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

claimKeyboard

キー入力イベントを受信するためにサーバーが要求するキーボードデバイス名のリストを取得または設定します。

クレームを維持し、キー入力イベントを受信し続けるためには、すべてのPOSTリクエストに対するレスポンスにこれを設定する必要があります。

Declaration

public List<string> claimKeyboard { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

clientAction

An optional list of ClientActionRequest objects, which are used to request an extended function of the client device.

Declaration

public List<ClientActionRequest> clientAction { get; set; }

Property Value

Type	Description
System.Collections.Generic.List< ClientActionRequest >

deleteMethod

印字ジョブ完了通知のリクエストについてGETを利用するかDELETEを利用するかの指示を取得または設定します。

オプションにて文字列値で'DELETE'、'GET'、またはnullに設定します。

DELETEリクエストを処理できないサーバーは、このフィールドを'GET'に設定して、GETリクエストを介してジョブの完了または失敗を通知するようCloudPRNTクライアントデバイスに要求できます。

Declaration

public string deleteMethod { get; set; }

Property Value

Type	Description
System.String

display

CloudPRNTクライアントデバイスに接続されているカスタマーディスプレイに指示を送信するために使用される DisplayUpdate オブジェクトのリストを取得または設定します。

Declaration

public List<DisplayUpdate> display { get; set; }

Property Value

Type	Description
System.Collections.Generic.List< DisplayUpdate >

jobReady

CloudPRNTクライアントデバイスへの印刷ジョブの有無の通知を取得または設定します。

trueに設定すると、ジョブを印刷できることをCloudPRNTクライアントに通知します。

このフィールドは必須であり、CloudPRNTクライアントからのPOSTポーリングごとに指定する必要があります。

ジョブの印刷準備ができたことがCloudPRNTクライアントに通知されると、優先mediaTypeとともに http GETリクエストがCloudPRNTクライアントから発行されて印刷ジョブデータを要求されます。

Declaration

public bool jobReady { get; set; }

Property Value

Type	Description
System.Boolean

mediaTypes

CloudPRNTクライアントデバイスに提供できる印刷準備のできたジョブのメディア形式を表す文字列のリストを取得または設定します。

'jobReady'をtrueに設定する場合、'mediaTypes'はCloudPRNTクライアントデバイスに提供できるメディア形式を表す文字列のリストも提供する必要があります。

'jobReady'をfalseに設定する場合、'mediaTypes'はnullを設定します。

ICpDocument クラスを使用して、サーバー側のジョブフォーマット変換を有効にすることをお勧めします。

この場合、mediaTypesリストは直接 ICpDocument オブジェクトから取得できます。

Declaration

public bool jobReady { get; set; }

Property Value

Type	Description
System.Boolean

Methods

ToJson(PollResponse, Boolean)

CloudPRNT互換JSON文字列データへPollResponseオブジェクトをシリアライズし、CloudPRNTポーリング要求POSTにレスポンスするデータの準備をします。

Declaration

public static string ToJson(PollResponse pollResponse, bool indented = false)

Parameters

Type	Name	Description
PollResponse	pollResponse	シリアライズされるPollResponse
System.Boolean	indented	JSON をフォーマットまたはインデントするには、'true'に設定します。デバッグ用に読み取りやすいデータを生成することを目的としています (デフォルトは'false')

Returns

Type	Description
System.String`	ポーリングPOSTレスポンスのためのCloudPRNT互換JSON文字列データ

ToJson(Boolean)

CloudPRNT互換JSON文字列データにシリアライズし、CloudPRNTポーリング要求POSTにレスポンスするための文字列データを生成します。

失敗した場合は例外がスローされ、基になるシリアル化エンジン (現在は Newtonsoft.Json) のエラーを含む内部例外が発生します。

Declaration

public string ToJson(bool indented = false)

Parameters

Type	Name	Description
System.Boolean	indented	'true' に設定すると、デバッグ用に読み取りやすいJSONデータを生成します (デフォルトは 'false')

Returns

Type	Description
System.String`