Uses of Class
com.kingsrook.qqq.middleware.javalin.specs.invoke.UiApiRequest
Packages that use UiApiRequest
-
Uses of UiApiRequest in com.kingsrook.qqq.middleware.javalin.specs.invoke
Methods in com.kingsrook.qqq.middleware.javalin.specs.invoke that return UiApiRequestModifier and TypeMethodDescriptionUiApiRequest.withClientDetail(String clientDetail) Detail appended to the invoker's client channel (channel/detail), e.g.UiApiRequest.withCredentials(UiApiCredentials credentials) The calling user's credentials, as their request carried them (see UiApiCredentials.fromContext) - forwarded as they were, so the call authenticates exactly as the caller did, with any authentication module.UiApiRequest.withFormParam(String name, Object value) Send a form-encoded body (for operations whose request body is form data).UiApiRequest.withHeader(String name, String value) Add a custom header; a null value removes it.UiApiRequest.withInvokedBy(String invokedBy) Who is calling (X-QQQ-Invoked-By, written to the access log), e.g. assistant.UiApiRequest.withJsonBody(Object jsonBody) Send a JSON body (serialized with QQQ's JsonUtils).UiApiRequest.withMethod(HttpMethod method) Fluent setter for methodUiApiRequest.withMultipartFile(String fieldName, String fileName, String contentType, Supplier<InputStream> content) Append a streamed file part.Fluent setter for path (the operation's path template)UiApiRequest.withPathParam(String name, Object value) Add a value for a `{name}` in the path template.UiApiRequest.withQueryParam(String name, Object value) Add a query-string parameter.UiApiRequest.withSessionUUID(String sessionUUID) The signed-in user's session UUID, sent as the sessionUUID cookie.UiApiRequest.withTimeout(Duration timeout) Per-call timeout (default 60 seconds).UiApiRequest.withUserTimezone(String userTimezone) The user's time zone (X-QQQ-UserTimezone), for relative dates.Methods in com.kingsrook.qqq.middleware.javalin.specs.invoke with parameters of type UiApiRequestModifier and TypeMethodDescriptionUiApiInvoker.invoke(UiApiRequest request) Invoke an operation with the request's session.UiApiInvoker.invokeForStream(UiApiRequest request) Invoke with a streamed body.