Client Action
サーバーレスポンスパケットの一つの"clientAction"オプションは、サーバーがクライアントに印刷以外の動作実行の要求や通常のクライアント POST リクエストパケットに含まれない情報の返答を要求することに使用されます。
もしサーバーが"clientAction"要求をサーバーレスポンスにて発行した場合、クライアントは指定された”clientAction”を実施します。またその実施結果を含むクライアントからの POST リクエストの発行タイミングは、通常のポーリングインターバルではなく、実施直後になります。
パフォーマンスとして、複数のクライアントアクションは列として渡すことができ、複数の要求を同時に処理できます。クライアントは配列として応答することもでき、場合によっては複数の応答を生成します。通常の印刷操作においては、Client Action を要求する必要はありません。
サポートされている Client Action は下記になります。
| Version (HI01X/02X) | Version (mC-Print2/3) | Client Action Request | Parameter | Client Request result |
|---|---|---|---|---|
| 1.0 | 1.2 | ClientType | クライアントタイプを示す文字列の応答を取得します。 例: “Star mC-Print2” - (mC-Print2) “Star mC-Print3” - (mC-Print3) |
|
| 1.0 | 1.2 | ClientVersion | クライアントに実装されている CloudPRNT のバージョンの応答を取得します。 例:”1.2” | |
| 1.0 | 1.2 | Encodings | クライアントにてサポートされている印刷ジョブのエンコーディングリストについてセミコロンを仕切りにした応答を取得します。エンコード名は標準 MIME/Content type の文字列フォーマットに準じます。 | |
| 1.0 | 1.2 | SetID | 新規 ID 文字列 | クライアントにて、POST/GET リクエストの"uniqueID"フィールドで使われる任意の ID を設定します。 |
| 1.0 | 1.2 | GetPollInterval | クライアントのポーリングインターバル秒の応答を取得します。この値はサーバーによってクライアント接続のタイムアウトを決定することに利用することが出来ます。 | |
| 1.4 | 1.2 | PageInfo | クライアントのプリンタページ情報の応答を取得します。応答には文字列フィールドが含まれるJSONフォーマットされたオブジェクトが返ります: { "paperWidth": " "printWidth": " "horizontalResolution": " "verticalResolution": " } これらは丸め誤差を避けるため文字列で返答されます。 |
clientAction 要求は全てのクライアントで全ての項目をサポートされる保証はないため、オプションとなります。しかし、現状上記の Client Action は、mC-Print2 及び mC-Print3 にてサポートされます。