@Target([AnnotationTarget.VALUE_PARAMETER]) annotation class HttpRpcQueryParameter
Marks a function parameter of a function annotated with @HttpRpcGET or @HttpRpcPOST as a query parameter.
<init> |
Marks a function parameter of a function annotated with @HttpRpcGET or @HttpRpcPOST as a query parameter. HttpRpcQueryParameter(name: String = "", description: String = "", required: Boolean = true, default: String = "") |
default |
The default value of this parameter. Defaults to null. val default: String |
description |
The description of the path parameter, used for documentation. Defaults to empty string. val description: String |
name |
The name of the query parameter in the call. Defaults to the parameter's name in the function signature. val name: String |
required |
Whether this parameter is required when making an http call. Defaults to true. val required: Boolean |