RIDLConfig: RIDL Configuration

In dickoa/ridl: A Client for the UNHCR RIDL Platform API

RIDL Configuration

Description

RIDL Configuration

RIDL Configuration

Details

RIDL Configuration allow to connect to a RIDL server and setup project where you can interact with the RIDL platform

Public fields

data

all info in list.

Methods

Public methods

• RIDLConfig$new()

• RIDLConfig$set_token()

• RIDLConfig$get_token()

• RIDLConfig$get_site_url()

• RIDLConfig$get_log_file()

• RIDLConfig$remoteclient()

• RIDLConfig$call_action()

• RIDLConfig$read()

• RIDLConfig$setup()

• RIDLConfig$delete()

• RIDLConfig$as_list()

• RIDLConfig$print()

• RIDLConfig$clone()

---

Method new()

Create a new Configuration object.

Usage

RIDLConfig$new(
  site = "prod",
  token = NULL,
  key = NULL,
  user_agent = NULL,
  log_file = NULL,
  ...
)

Arguments

site

character, the RIDL instance, prod (production server), test (testing server)

token

character, the RIDL API token

key

character, the RIDL API key, is no longer recommended use the API token instead

user_agent

character value, User agent

log_file

character, the log file

...

curl options to pass to crul::HttpClient

Returns

A new Configuration object.

---

Method set_token()

Specify a RIDL API token

Usage

RIDLConfig$set_token(token)

Arguments

token

a character with token

---

Method get_token()

Specify a RIDL API token

Usage

RIDLConfig$get_token()

Returns

a character, the RIDL API token

---

Method get_site_url()

Get the RIDL server URL in use

Usage

RIDLConfig$get_site_url()

Returns

the server URL

---

Method get_log_file()

Get the log file used by RIDL

Usage

RIDLConfig$get_log_file()

Returns

the log file

---

Method remoteclient()

Get the remoteclient currently used

Usage

RIDLConfig$remoteclient(...)

Arguments

...

curl options to pass to crul::HttpClient

Returns

a crul::HttpClient

---

Method call_action()

Call the client to the RIDL API

Usage

RIDLConfig$call_action(action, ..., verb = "get")

Arguments

action

a character

...

parameters for each verb used

verb

a character the verb used, post, get, put or patch

Returns

list a with status code and results

---

Method read()

read and show Configuration object

Usage

RIDLConfig$read()

Returns

Configuration object

---

Method setup()

Setup Configuration object

Usage

RIDLConfig$setup(
  site = "prod",
  token = NULL,
  key = NULL,
  configuration = NULL,
  ...
)

Arguments

site

character, the RIDL instance, prod (production server), test (testing server)

token

a character value, the API token

key

a character value, the API key

configuration

a character

...

curl options to pass to crul::HttpClient

---

Method delete()

Delete a Configuration object

Usage

RIDLConfig$delete()

---

Method as_list()

Convert configuration to list

Usage

RIDLConfig$as_list()

Returns

configuration in list format

---

Method print()

Print Configuration object

Usage

RIDLConfig$print()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

RIDLConfig$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
 ridl_config()

## End(Not run)

dickoa/ridl documentation built on April 23, 2023, 7:14 p.m.