Package 'zoomer'

OAuth client documentation

Description

OAuth client documentation

Value

A Zoom httr2::oauth_client().

---

OAuth request authentication documentation

Description

OAuth request authentication documentation

Arguments

token

A Zoom API OAuth token, or the access_token string from such a token. We recommend that you instead supply a client, in which case an appropriate token will be located if possible.

Value

An httr2::request() with Zoom OAuth authentication information.

---

OAuth token documentation

Description

OAuth token documentation

Value

A Zoom httr2::oauth_token(), invisibly.

---

Authenticate with a Zoom OAuth client

Description

Load or generate a Zoom OAuth token for use in the other functions in this package. The primary use of this function is to cache values early in a script (so the user can walk away). Otherwise the other functions in this package will prompt for authentication when needed. Once the values are cached, the rest of this package will use them by default for that client.

Usage

zoom_authenticate(
  client = zoom_client(),
  cache_key = getOption("zoom.cache_key", NULL),
  scopes = "recording:read",
  force = FALSE,
  refresh_token = NULL
)

Arguments

client	A Zoom OAuth client created with zoom_client().
cache_key	If you are authenticating with multiple users using the same client, use this key to differentiate between those users.
scopes	A character vector of allowed scopes, such as "recording:read".
force	A logical indicating whether to force a refresh of the token.
refresh_token	A refresh token associated with this client.

Value

A Zoom httr2::oauth_token(), invisibly.

---

Visit Zoom Created Apps

Description

Launch the Zoom "Created Apps" page (where you can configure OAuth 2.0 Clients). Navigate to "Develop > Build App" if you don't have an app, and choose "OAuth". Set the "OAuth allow list" to "http://localhost:8888". You'll also have to give the app allowed scopes. After you configure your app, copy/paste the Client ID and Client Secret into the ZOOM_CLIENT_ID and ZOOM_CLIENT_ID environment variables. We recommend placing these environment variables in your .Renviron file.

Usage

zoom_browse_app_management()

Value

The url of the "Created Apps" page, invisibly.

Examples

zoom_app_mgmt_url <- zoom_browse_app_management()
# Copy/paste values from your client.
Sys.setenv(ZOOM_CLIENT_ID = "raNdOMletTeRS")
Sys.setenv(ZOOM_CLIENT_SECRET = "RanDomleTTerSandNumb3rs")

---

Construct a Zoom OAuth client

Description

Builds the OAuth client object for Zoom apis.

Usage

zoom_client(
  client_id = Sys.getenv("ZOOM_CLIENT_ID"),
  client_secret = Sys.getenv("ZOOM_CLIENT_SECRET")
)

Arguments

client_id	A Zoom OAuth App client ID. We recommend you save it as an environment variable, ZOOM_CLIENT_ID.
client_secret	A Zoom OAuth App client secret. We recommend you save it as an environment variable, ZOOM_CLIENT_SECRET.

Value

A Zoom httr2::oauth_client().

Examples

zoom_client <- zoom_client()

---