FavoritesListOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| can |
該当する各お気に入りの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、お気に入りの概要コンテンツのみを返します。 |
| favorite |
お気に入りの種類。 値には、共有またはユーザーのいずれかを指定できます。 |
| source |
返されるお気に入りのソースの種類。 省略すると、ソースの種類は既定で "other" になります (この列挙型には存在しません)。 |
| tags | 返される各お気に入りに存在する必要があるタグ。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
canFetchContent
該当する各お気に入りの完全なコンテンツを返すかどうかを示すフラグ。 false の場合は、お気に入りの概要コンテンツのみを返します。
canFetchContent?: boolean
プロパティ値
boolean
favoriteType
sourceType
返されるお気に入りのソースの種類。 省略すると、ソースの種類は既定で "other" になります (この列挙型には存在しません)。
sourceType?: string
プロパティ値
string
tags
返される各お気に入りに存在する必要があるタグ。
tags?: string[]
プロパティ値
string[]
継承されたプロパティの詳細
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 から継承