Singularity: R6 Class representing the Singularity SDK

In kmchugh/com.icatalyst.singularity.r: OAuth 2.0 Authentication against the Singularity API

Description

R6 Class representing the Singularity SDK

R6 Class representing the Singularity SDK

Details

Allows configuration of the interactions between this client and the Singularity Oauth 2.0 server

the custom message handler created to allow redirection from shiny

Public fields

the

client id generated by the singularity server that represents this client

client_secret

the client secret generated by the singularity server to allow this client to access the API

client_key

the client key generated by the singularity server to allow this client to access the API

message_handler

the name of the message handler to create for shiny js code

Active bindings

the

client id generated by the singularity server that represents this client

client_secret

the client secret generated by the singularity server to allow this client to access the API

client_key

the client key generated by the singularity server to allow this client to access the API

message_handler

the name of the message handler to create for shiny js code

Methods

Public methods

• Singularity$new()

• Singularity$print()

• Singularity$shiny_tags()

• Singularity$shiny_redirect()

• Singularity$clone()

---

Method new()

Creates a new instance of the SDK

Usage

Singularity$new(
  client_id,
  client_secret,
  client_key,
  config_file = ".local.config.json",
  config = NULL
)

Arguments

client_id

the client identifier as generated by Singularity

client_secret

the client secret as generated by Singularity

client_key

the client key as generated by Singularity

config_file

optional configuration file to override the default configuration from

config

optional config list to override the default configuration with

---

Method print()

Prints a representation of this object

Usage

Singularity$print(...)

Arguments

...

print parameters

---

Method shiny_tags()

Adds a script tag with the redirection handler This is specifically for shiny

Usage

Singularity$shiny_tags(tags)

Arguments

tags

the shiny tags object

---

Method shiny_redirect()

Calls the shiny redirect handler This is specifically for shiny

Usage

Singularity$shiny_redirect(session, redirect_uri)

Arguments

session

the session object from shiny

redirect_uri

the uri to redirect the user to in order to force the trusted login flow

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Singularity$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

kmchugh/com.icatalyst.singularity.r documentation built on Sept. 13, 2020, 12:22 a.m.