extensions: Document development functions

In brazil-data-cube/rlccs: R Client For Land Cover Classification System Web Service

Description

Document development functions

Extension development functions

Extension development functions

Extension development functions

Extension development functions

Query development functions

Usage

RLCCSDocument(content, q, subclass)

endpoint(q)

before_request(q)

after_response(q, res)

content_response(res, status_codes, content_types)

check_query_verb(q, verbs, msg = NULL)

check_subclass(x, subclasses)

subclass(x)

omit_query_params(q, names)

RLCCSQuery(
  base_url,
  params = list(),
  token = NULL,
  subclass,
  query_type = "key",
  encode = NULL
)

Arguments

content	a list data structure representing the JSON file received in HTTP response (see content_response() function)
q	a RLCCSQuery object.
subclass	a character corresponding to the subclass of the object to be created.
res	a httr response object.
status_codes	a character vector with successful status codes.
content_types	a character vector with all acceptable responses' content type.
verbs	a character vector with allowed HTTP request methods
msg	a character with a personalized error message
x	either a RLCCSQuery object expressing a LCCS query criteria or any RLCCSDocument.
subclasses	a character vector with all allowed S3 subclasses
names	a character vector with the names do omit.
base_url	a character informing the base url of a LCCS-WS (LCCS-WS-SPEC 0.6)
params	a named list with all URL query parameters to be appended in the URL.
token	a character informing the authentication token in the BDC-OAuth service. This token is used for the service's administrative operations through the HTTP verbs POST, PUT, DELETE.
query_type	a character representing the type of document that should be sent to the LCCS-WS. With this parameter, you can specify when rlccs should send the document in the format of a list (query_type = list) or a document with JSON keys (query_type = key). Examples of use are given below: To send 'key': 'value' to the server, use the type key. On the other hand, sending ['key': 'value'] must be done with a type list
encode	a character informing the request body Content-Type. Accepted types are 'json' ('application/json'), 'form' ('application/x-www-form-urlencoded'), and 'multipart' ('multipart/form-data'). Defaults to 'json'.

Value

The RLCCSDocument() function returns a RLCCSDocument object with subclass defined by subclass parameter.

A character endpoint value for endpoint() function. A RLCCSQuery object for before_request() and after_response() functions.

The content_response() function returns a list data structure representing the JSON file received in HTTP response

The RSTACQuery() function returns a STACQuery object with subclass defined by subclass parameter.

Functions

• RLCCSDocument: The RLCCSDocument() function is a constructor of LCCS documents. Currently, this class is used to represent the return of all LCCS-WS endpoints. The general use of this document is possible since the service return follows the same hierarchical structure.

• content_response: The content_response function checks if the request's response is in accordance with the allowed status codes and content-types. It returns the parsed content response.

• check_query_verb: The check_query_verb() function allows you to define which HTTP verbs are allowed. It is useful for establishing which verbs will be supported by an extension.

• check_subclass: The check_subclass() function specifies which type of query objects (RLCCSQuery) or document objects (RLCCSDocument) are expected in the function extension.

• subclass: The subclass() function returns a character representing the subclass name of either RLCCSQuery or RSTACDocument S3 classes.

• omit_query_params: The omit_query_params() function was created to omit the paths that are defined as query parameters to simplify the creation of a query. Therefore, use this method only in endpoints that specify a parameter in their paths.

• RLCCSQuery: The RLCCSQuery() function is a constructor of RLCCSQuery objects. Every extension must implement a subclass of RLCCSQuery to represent its queries. This is done by informing to the subclass parameter the extension's subclass name.

  The params parameter is a named list where user parameters must be stored. It is important to know if previous query parameters needs to be keeped in the new query. If so, it is recommended do use modifyList() function to merge the old and new query parameters.

brazil-data-cube/rlccs documentation built on Feb. 28, 2021, 5:50 p.m.