ClientActionRequest

ClientActionRequestオブジェクトは、CloudPRNT印刷/周辺制御フロー以外のクライアントへのサーバーからの特別な要求を表します。

ClientActions はクライアントデバイス固有でオプションですが、すべての要求がすべてのデバイスでサポートされるわけではありません。

デバイスに ClientActions 要求を発行するには、まずデバイスが http POST 経由でサーバーに PollRequest を発行するのを待ちます。

デバイスに対する PollResponse を準備する場合 必要な ClientActionRequest オブジェクトをリストに追加できます。

クライアントは、ポーリングリクエストのPollRequest.clientActionプロパティにClientActionResultオブジェクトの一覧を含めることによって、クライアントアクション要求の応答/受信確認を提供します。

NameSpace: StarMicronics.CloudPrnt.CpMessage

Syntax

public class ClientActionRequest

Constructors

ClientActionRequest()

CloudPRNTクライアントデバイスから特別な機能を要求するためにCloudPRNTサーバーが使用するClientActionRequestオブジェクトを作成します。

作成されたClientActionRequestオブジェクトは、PollResponse オブジェクトのクライアントアクション要求のList ClientActionRequestプロパティに追加し、PollRequest を受信したレスポンスに含めてデバイスに送信する必要があります。

Declaration

public ClientActionRequest()

ClientActionRequest(ClientActions, String)

CloudPRNTクライアントデバイスから特別な機能を要求するためにCloudPRNTサーバーが使用するClientActionRequestオブジェクトを作成します。

作成されたClientActionRequestオブジェクトは、PollResponse オブジェクトのクライアントアクション要求のList ClientActionRequestプロパティに追加し、PollRequest を受信したレスポンスに含めてデバイスに送信する必要があります。

Declaration

public ClientActionRequest(ClientActions type, string options)

Type	Name	Description
ClientActions	type	クライアントアクション要求の種類をClientActions列挙型として指定します。
System.String	options	このClientActionに必要なオプションを指定します (たとえば、SetID タイプでは、オプション値に任意のIDを指定する必要があります)。

ClientActionRequest(String, String)

CloudPRNTクライアントデバイスから特別な機能を要求するためにCloudPRNTサーバーが使用するClientActionRequestオブジェクトを作成します。

作成されたClientActionRequestオブジェクトは、PollResponse オブジェクトのクライアントアクション要求のList ClientActionRequestプロパティに追加し、PollRequest を受信したレスポンスに含めてデバイスに送信する必要があります。

Declaration

public ClientActionRequest(string request, string options)

Type	Name	Description
System.String	request	クライアントアクション要求の種類を文字列として指定します。
System.String	options	このClientActionに必要なオプションを指定します (たとえば、SetID タイプでは、オプション値に任意のIDを指定する必要があります)。

Properties

Options

このClientActionに必要なオプションを指定します。

たとえば、SetIDタイプでは、オプション値に任意のIDを指定する必要があります。

Declaration

public string Options { get; set; }

Property Value

Type	Description
System.String

Request

クライアントアクション要求の種類を文字列として指定します。

サポートされている文字列値の詳細については、CloudPRNT仕様を参照してください。

文字列値はクライアントデバイスに直接渡され、'ClientActions' 列挙型では使用できない (通常はデバイス固有の) ClientAction の動作にアクセスするために使用できます。

Declaration

public string Request { get; set; }

Property Value

Type	Description
System.String

Type

クライアントアクション要求の種類を ClientActions 列挙型として指定します。

Declaration

public ClientActions Type { get; set; }

Property Value

Type	Description
ClientActions

Methods

ClientActionFromRequestString(String)

CloudPRNT ClientAction文字列をクライアントアクション列挙値にマップします。

Declaration

public static ClientActions ClientActionFromRequestString(string request)

Parameters

Type	Name	Description
System.String	request	CloudPRNT ClientAction要求値

Returns

Type	Description
ClientActions	指定された'request'文字列に対応するClientActions列挙値、ClientActions.Other。

ClientActionRequestString(ClientActions)

対応するCloudPRNT要求文字列にクライアントアクション列挙型をマップします。

Declaration

public static string ClientActionRequestString(ClientActions type)

Parameters

Type	Name	Description
ClientActions	type

Returns

Type	Description
System.String	'type'に対応する要求文字列。認識されていない場合または 'type'が値 ClientAction.Otherを保持している場合は空の文字列を返します。