| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/KorAPConnection.R |
| 3 | \name{KorAPConnection} |
| 4 | \alias{KorAPConnection} |
| Marc Kupietz | 7915dc4 | 2019-09-12 17:44:58 +0200 | [diff] [blame] | 5 | \title{Connect to a KorAP server.} |
| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 6 | \usage{ |
| 7 | KorAPConnection(KorAPUrl = defaultKorAPUrl, apiVersion = "v1.0", |
| Marc Kupietz | f568f3f | 2019-09-16 17:03:46 +0200 | [diff] [blame] | 8 | apiUrl) |
| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 9 | } |
| 10 | \arguments{ |
| 11 | \item{KorAPUrl}{instead of providing the query and vc string parameters, you can also simply copy a KorAP query URL from your browser and use it here (and in \code{KorAPConnection}) to provide all necessary information for the query.} |
| Marc Kupietz | 25aebc3 | 2019-09-16 18:40:50 +0200 | [diff] [blame^] | 12 | |
| 13 | \item{apiVersion}{which version of KorAP's API you want to connect to} |
| 14 | |
| 15 | \item{apiUrl}{url of the KorAP web service} |
| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 16 | } |
| 17 | \value{ |
| Marc Kupietz | 7915dc4 | 2019-09-12 17:44:58 +0200 | [diff] [blame] | 18 | object that contains all connection information and can be used with \code{\link{KorAPQuery}} |
| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 19 | } |
| 20 | \description{ |
| Marc Kupietz | 7915dc4 | 2019-09-12 17:44:58 +0200 | [diff] [blame] | 21 | Connect to a KorAP server. |
| 22 | } |
| 23 | \note{ |
| 24 | Currently it is not possible to authenticate the client |
| Marc Kupietz | cf1caf4 | 2019-09-07 19:19:31 +0200 | [diff] [blame] | 25 | } |