SwordHalClient | R Documentation |
This class models an Sword service client for HAL (Archives Houvertes)
R6Class
object.
SwordHalClient
Object of R6Class
for modelling an Sword client
atom4R::atom4RLogger
-> atom4R::AtomPubClient
-> atom4R::SwordClient
-> SwordHalClient
atom4R::atom4RLogger$ERROR()
atom4R::atom4RLogger$INFO()
atom4R::atom4RLogger$WARN()
atom4R::atom4RLogger$getClass()
atom4R::atom4RLogger$getClassName()
atom4R::atom4RLogger$logger()
atom4R::AtomPubClient$getPwd()
atom4R::AtomPubClient$getToken()
atom4R::AtomPubClient$getUser()
atom4R::AtomPubClient$listCollections()
new()
This method is to instantiate an Sword HAL (Archive Ouvertes - https://hal.archives-ouvertes.fr/) Client. By default the version is set to "2".
The keyring_backend
can be set to use a different backend for storing
the SWORD API user token with keyring (Default value is 'env').
The logger
allows to specify the level of log (default is NULL), either "INFO"
for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.
SwordHalClient$new( url, user = NULL, pwd = NULL, logger = NULL, keyring_backend = "env" )
url
url
user
user
pwd
pwd
logger
logger
keyring_backend
keyring backend. Default value is 'env'
getServiceDocument()
Get service document
SwordHalClient$getServiceDocument(force = FALSE)
force
force Force getting/refreshing of service document
object of class SwordServiceDocument
getCollectionMembers()
Get collection members
SwordHalClient$getCollectionMembers(collectionId)
collectionId
collection ID
a list of AtomFeed
clone()
The objects of this class are cloneable with this method.
SwordHalClient$clone(deep = FALSE)
deep
Whether to make a deep clone.
Experimental
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.