blob: b35cb45bac2aa437414c7928860c5db65ef3ba7b [file] [log] [blame]
Marc Kupietze95108e2019-09-18 13:23:58 +02001% Generated by roxygen2: do not edit by hand
2% Please edit documentation in R/KorAPQuery.R
3\docType{class}
4\name{KorAPQuery-class}
5\alias{KorAPQuery-class}
6\alias{KorAPQuery}
Marc Kupietz38a9d682024-12-06 16:17:09 +01007\alias{buildWebUIRequestUrlFromString}
Marc Kupietzdbd431a2021-08-29 12:17:45 +02008\alias{buildWebUIRequestUrl}
Marc Kupietze95108e2019-09-18 13:23:58 +02009\alias{format.KorAPQuery}
10\alias{show,KorAPQuery-method}
Marc Kupietza8c40f42025-06-24 15:49:52 +020011\title{KorAPQuery class (internal)}
Marc Kupietze95108e2019-09-18 13:23:58 +020012\usage{
Marc Kupietz38a9d682024-12-06 16:17:09 +010013buildWebUIRequestUrlFromString(KorAPUrl, query, vc = "", ql = "poliqarp")
14
Marc Kupietzdbd431a2021-08-29 12:17:45 +020015buildWebUIRequestUrl(
16 kco,
Marc Kupietza824d502025-05-02 15:40:23 +020017 query = if (missing(KorAPUrl)) {
18
Marc Kupietzdbd431a2021-08-29 12:17:45 +020019 stop("At least one of the parameters query and KorAPUrl must be specified.", call. =
Marc Kupietza824d502025-05-02 15:40:23 +020020 FALSE)
21 } else {
22 httr2::url_parse(KorAPUrl)$query$q
23 },
Marc Kupietzf9129592025-01-26 19:17:54 +010024 vc = if (missing(KorAPUrl)) "" else httr2::url_parse(KorAPUrl)$query$cq,
Marc Kupietzdbd431a2021-08-29 12:17:45 +020025 KorAPUrl,
Marc Kupietzf9129592025-01-26 19:17:54 +010026 ql = if (missing(KorAPUrl)) "poliqarp" else httr2::url_parse(KorAPUrl)$query$ql
Marc Kupietzdbd431a2021-08-29 12:17:45 +020027)
28
Marc Kupietze95108e2019-09-18 13:23:58 +020029\method{format}{KorAPQuery}(x, ...)
30
31\S4method{show}{KorAPQuery}(object)
32}
33\arguments{
Marc Kupietza8c40f42025-06-24 15:49:52 +020034\item{x}{KorAPQuery object}
Marc Kupietze95108e2019-09-18 13:23:58 +020035
Marc Kupietzdbd431a2021-08-29 12:17:45 +020036\item{...}{further arguments passed to or from other methods}
Marc Kupietze95108e2019-09-18 13:23:58 +020037
Marc Kupietze95108e2019-09-18 13:23:58 +020038\item{object}{KorAPQuery object}
39}
Marc Kupietze95108e2019-09-18 13:23:58 +020040\description{
Marc Kupietza8c40f42025-06-24 15:49:52 +020041Internal class for query state management. Users work with \code{corpusQuery()}, \code{fetchAll()}, and \code{fetchNext()} instead.
Marc Kupietze95108e2019-09-18 13:23:58 +020042}
Marc Kupietza8c40f42025-06-24 15:49:52 +020043\keyword{internal}