CommunicationsListOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
filter | 操作に適用するフィルター。 communicationType プロパティと createdDate プロパティでフィルター処理できます。 CommunicationType は Equals ('eq') 演算子をサポートし、createdDate は Greater Than ('gt') 演算子と Greater Than or Equals ('ge') 演算子をサポートします。 CommunicationType フィルターと CreatedDate フィルターを論理 And ('and') 演算子で組み合わせることができます。 |
top | コレクションで返される値の数。 既定値は 10、最大は 10 です。 |
継承されたプロパティ
abort |
要求を中止するために使用できるシグナル。 |
on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
filter
操作に適用するフィルター。 communicationType プロパティと createdDate プロパティでフィルター処理できます。 CommunicationType は Equals ('eq') 演算子をサポートし、createdDate は Greater Than ('gt') 演算子と Greater Than or Equals ('ge') 演算子をサポートします。 CommunicationType フィルターと CreatedDate フィルターを論理 And ('and') 演算子で組み合わせることができます。
filter?: string
プロパティ値
string
top
コレクションで返される値の数。 既定値は 10、最大は 10 です。
top?: number
プロパティ値
number
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
継承元 coreClient.OperationOptions.abortSignal
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
継承元 coreClient.OperationOptions.onResponse
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
継承元 coreClient.OperationOptions.requestOptions
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptions
プロパティ値
継承元 coreClient.OperationOptions.serializerOptions
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
継承元 coreClient.OperationOptions.tracingOptions