ocsRequest
ocsRequest
Object of R6Class for modelling a generic 'ocs' web-service request
R6Class object.
new(type, url, request, user, pwd, token, cookies,
format, namedParams, content, contentType, filename, logger, ...)This method is used to instantiate a object for doing an 'ocs' web-service request
getRequest()Get the request payload
getRequestHeaders()Get the request headers
getStatus()Get the request status code
getResponse()Get the request response
getException()Get the exception (in case of request failure)
getResult()Get the result TRUE if the request is successful, FALSE otherwise
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
ocs4R::ocs4RLogger -> ocsRequest
new()This method is used to instantiate a object for doing an 'ocs' web-service request
ocsRequest$new(
type,
url,
request,
user = NULL,
pwd = NULL,
token = NULL,
cookies = NULL,
format = "json",
namedParams = list(),
content = NULL,
contentType = "text/plain",
filename = NULL,
logger = NULL,
...
)typetype of request
urlurl
requestrequest
useruser
pwdpwd
tokentoken
cookiescookies
formatformat. Default is "json"
namedParamsa list of named parameters
contentcontent
contentTypecontent type. Default is "text/plain"
filenamefile name
loggerlogger
...additional parameters
execute()Executes the request
ocsRequest$execute()
getRequest()Get request
ocsRequest$getRequest()
getRequestHeaders()Get request headers
ocsRequest$getRequestHeaders()
getStatus()Get status
ocsRequest$getStatus()
getResponse()Get response
ocsRequest$getResponse()
getException()Get exception
ocsRequest$getException()
getResult()Get result
ocsRequest$getResult()
setResult()Set result
ocsRequest$setResult(result)resultresult
clone()The objects of this class are cloneable with this method.
ocsRequest$clone(deep = FALSE)deepWhether to make a deep clone.