blob: 2c4c60e89eb3bdb8873c2ede476776e3be859b24 [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/KorAPConnection.R
3\docType{class}
4\name{KorAPConnection-class}
5\alias{KorAPConnection-class}
6\alias{KorAPConnection}
7\alias{initialize,KorAPConnection-method}
8\alias{show,KorAPConnection-method}
9\title{Class KorAPConnection}
10\usage{
11\S4method{initialize}{KorAPConnection}(.Object,
Marc Kupietzf94a6c82019-09-19 11:32:07 +020012 KorAPUrl = "https://korap.ids-mannheim.de/", apiVersion = "v1.0",
13 apiUrl)
Marc Kupietze95108e2019-09-18 13:23:58 +020014
15\S4method{show}{KorAPConnection}(object)
16}
17\arguments{
18\item{.Object}{KorAPConnection object}
19
20\item{KorAPUrl}{the URL of the KorAP server instance you want to access.}
21
22\item{apiVersion}{which version of KorAP's API you want to connect to.}
23
24\item{apiUrl}{URL of the KorAP web service.}
25
26\item{object}{KorAPConnection object}
27}
28\value{
29\code{\link{KorAPConnection}} object that can be used e.g. with \code{\link{corpusQuery}}
30}
31\description{
32\code{KorAPConnection} objetcs represent the connection to a KorAP server.
33New \code{KorAPConnection} objects can be created by \code{KorAPConnection()}
34}
35\note{
36Currently it is not possible to authenticate the client
37}
38\examples{
39kcon <- new("KorAPConnection")
40kq <- corpusQuery(kcon, "Ameisenplage")
41kq <- fetchAll(kq, verbose=TRUE)
42
43}