From c811caee7e770aa31d1ff8f0fac9007cc68d6f8c Mon Sep 17 00:00:00 2001 From: toph-allen Date: Fri, 8 Nov 2024 19:16:16 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rstudio/?= =?UTF-8?q?connectapi@c5bfd8dcd5948a49ba68d60b2b4a07a67cd953ad=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dev/PULL_REQUEST_TEMPLATE.html | 2 +- dev/articles/connectapi_tags.html | 36 +++++++++---------- dev/articles/content_permissions.html | 52 +++++++++++++-------------- dev/pkgdown.yml | 2 +- dev/reference/bundle_static.html | 6 ++-- dev/reference/connect.html | 2 +- dev/reference/get_audit_logs.html | 2 +- dev/reference/get_group_members.html | 4 +-- dev/reference/get_groups.html | 8 ++--- dev/reference/get_usage_shiny.html | 4 +-- dev/reference/get_usage_static.html | 4 +-- dev/search.json | 2 +- 12 files changed, 60 insertions(+), 64 deletions(-) diff --git a/dev/PULL_REQUEST_TEMPLATE.html b/dev/PULL_REQUEST_TEMPLATE.html index f2b9a398..070f43e9 100644 --- a/dev/PULL_REQUEST_TEMPLATE.html +++ b/dev/PULL_REQUEST_TEMPLATE.html @@ -58,7 +58,7 @@

Approach

Checklist

diff --git a/dev/articles/connectapi_tags.html b/dev/articles/connectapi_tags.html index d3e2cd63..a5ee7757 100644 --- a/dev/articles/connectapi_tags.html +++ b/dev/articles/connectapi_tags.html @@ -125,7 +125,7 @@

Create the Tag Tree(s)tree_project_1 
## Posit Connect API Client: 
 ##   Posit Connect Server: http://localhost:32768
-##   Posit Connect API Key: ***********gtm8
+## Posit Connect API Key: ***********6eAV 
 tmp_tags <- get_tags(client)
 
@@ -137,7 +137,7 @@ 
Create the Tag Tree(s)tree_project_2
## Posit Connect API Client: 
 ##   Posit Connect Server: http://localhost:32768
-##   Posit Connect API Key: ***********gtm8
+## Posit Connect API Key: ***********6eAV 
 tree_audience_1 <- create_tag_tree(client, "DemoAudience", "Sales")
## Posit Connect Tag Tree (filtered)
@@ -165,11 +165,11 @@ 
Content tags
 bnd <- bundle_static(system.file("logo.png", package = "connectapi"))

-
## Bundling directory (/tmp/RtmpOykJ6e/bundledir27507afcb7c3)

+
## Bundling directory (/tmp/RtmpddGLxx/bundledir26f1546c8d33)

 
 content_1 <- deploy(client, bnd)

 
## Getting content endpoint

-
## Found EXISTING content a12fa281-b1a4-4802-875c-7747c4db27ef with name mwlefoodfieexombwkkeulbfd on http://localhost:32768

+
## Found EXISTING content 66b778b6-b6c0-4702-98b2-5dee2a5d568c with name mwlefoodfieexombwkkeulbfd on http://localhost:32768

 
## Uploading bundle

 
## Deploying bundle

 
 set_content_tags(content_1, all_tags$DemoAudience$Sales)
## Posit Connect Tag Tree (content)
@@ -202,9 +202,9 @@ 
Set Tags## └── DemoAudience
 ##    └── Sales
## Posit Connect Content Task: 
-##   Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef
-##   URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/
-##   Task ID: j4nOlsdPkSU5lbSt
+## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c +## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ +## Task ID: iqNUaKRBDzu9Ng6M

Content 2 is for project_2 and both Audiences (Sales and Finance).

See the tags associated with content @@ -261,8 +261,8 @@

List all content associated with 
## # A tibble: 2 × 44
 ##   guid       name  title description access_type connection_timeout read_timeout
 ##   <chr>      <chr> <chr> <chr>       <chr>                    <int>        <int>
-## 1 7754d693-… pbcy… pbcy… ""          acl                         NA           NA
-## 2 a12fa281-… mwle… mwle… ""          acl                         NA           NA
+## 1 1b3a4597-… pbcy… pbcy… ""          acl                         NA           NA
+## 2 66b778b6-… mwle… mwle… ""          acl                         NA           NA
 ## # ℹ 37 more variables: init_timeout <int>, idle_timeout <int>,
 ## #   max_processes <int>, min_processes <int>, max_conns_per_process <int>,
 ## #   load_factor <dbl>, memory_request <lgl>, memory_limit <lgl>,
@@ -275,7 +275,7 @@ 
List all content associated with
 
## # A tibble: 1 × 44
 ##   guid       name  title description access_type connection_timeout read_timeout
 ##   <chr>      <chr> <chr> <chr>       <chr>                    <int>        <int>
-## 1 a12fa281-… mwle… mwle… ""          acl                         NA           NA
+## 1 66b778b6-… mwle… mwle… ""          acl                         NA           NA
 ## # ℹ 37 more variables: init_timeout <int>, idle_timeout <int>,
 ## #   max_processes <int>, min_processes <int>, max_conns_per_process <int>,
 ## #   load_factor <dbl>, memory_request <lgl>, memory_limit <lgl>,
@@ -308,12 +308,12 @@ 
Cleanupdelete_tag(client, latest_tags$DemoProject)

## Posit Connect API Client: 
 ##   Posit Connect Server: http://localhost:32768
-##   Posit Connect API Key: ***********gtm8
+## Posit Connect API Key: ***********6eAV 
 delete_tag(client, latest_tags$DemoAudience)
## Posit Connect API Client: 
 ##   Posit Connect Server: http://localhost:32768
-##   Posit Connect API Key: ***********gtm8
+## Posit Connect API Key: ***********6eAV 
 # TODO: delete content
diff --git a/dev/articles/content_permissions.html b/dev/articles/content_permissions.html index 6e51d915..75bf8d19 100644 --- a/dev/articles/content_permissions.html +++ b/dev/articles/content_permissions.html @@ -95,17 +95,17 @@

Getting Started 
 bnd <- bundle_static(system.file("logo.png", package = "connectapi"))
-
## Bundling directory (/tmp/Rtmp8Okmkf/bundledir27891626a2e3)
+
## Bundling directory (/tmp/RtmpWt5hWA/bundledir272a766037be)
 content_1 <- deploy(client, bnd, title = "App 1")
## Getting content endpoint
-
## Found EXISTING content a12fa281-b1a4-4802-875c-7747c4db27ef with name mwlefoodfieexombwkkeulbfd on http://localhost:32768
+
## Found EXISTING content 66b778b6-b6c0-4702-98b2-5dee2a5d568c with name mwlefoodfieexombwkkeulbfd on http://localhost:32768
## Uploading bundle
## Deploying bundle
 content_2 <- deploy(client, bnd, title = "App 2")
## Getting content endpoint
-
## Found EXISTING content 7754d693-556c-48b0-9be1-b422e038e2ec with name pbcyvkgufivjubqtxvafbsnay on http://localhost:32768
+
## Found EXISTING content 1b3a4597-98b5-467a-b638-df39e2ef5efc with name pbcyvkgufivjubqtxvafbsnay on http://localhost:32768
## Uploading bundle
## Deploying bundle
@@ -125,39 +125,39 @@ 
Getting Started## └── Example
 ##    └── Permissions
## Posit Connect Content Task: 
-##   Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef
-##   URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/
-##   Task ID: eSj0HZRLkSymuCYb
+## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c +## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ +## Task ID: I6EfNRyMfv6MvEXz 
 set_content_tags(content_2, tag_1)
## Posit Connect Tag Tree (content)
 ## └── Example
 ##    └── Permissions
## Posit Connect Content Task: 
-##   Content GUID: 7754d693-556c-48b0-9be1-b422e038e2ec
-##   URL: http://localhost:32768/connect/#/apps/7754d693-556c-48b0-9be1-b422e038e2ec/
-##   Task ID: jmO4sFW9ERwhhoQ0
+## Content GUID: 1b3a4597-98b5-467a-b638-df39e2ef5efc +## URL: http://localhost:32768/connect/#/apps/1b3a4597-98b5-467a-b638-df39e2ef5efc/ +## Task ID: Gr8JYfZhqgFpPa4e 
 content_add_user(content_1, user_restricted$guid, role = "viewer")
-
## Adding permission for user '3a576386-eedc-4245-8551-d30d12502643' with role 'viewer'
+
## Adding permission for user '3e623a69-ab85-40e5-a837-47ce755f20c1' with role 'viewer'
## Posit Connect Content Task: 
-##   Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef
-##   URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/
-##   Task ID: eSj0HZRLkSymuCYb
+## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c +## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ +## Task ID: I6EfNRyMfv6MvEXz 
 content_add_user(content_1, user_all$guid, "viewer")
-
## Adding permission for user '13169aca-6f6a-4e4b-bacb-e1e4c425f14a' with role 'viewer'
+
## Adding permission for user '5c653fc8-3fcb-4bd6-a2c6-3382554e7769' with role 'viewer'
## Posit Connect Content Task: 
-##   Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef
-##   URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/
-##   Task ID: eSj0HZRLkSymuCYb
+## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c +## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ +## Task ID: I6EfNRyMfv6MvEXz 
 content_add_user(content_2, user_all$guid, "viewer")
-
## Adding permission for user '13169aca-6f6a-4e4b-bacb-e1e4c425f14a' with role 'viewer'
+
## Adding permission for user '5c653fc8-3fcb-4bd6-a2c6-3382554e7769' with role 'viewer'
## Posit Connect Content Task: 
-##   Content GUID: 7754d693-556c-48b0-9be1-b422e038e2ec
-##   URL: http://localhost:32768/connect/#/apps/7754d693-556c-48b0-9be1-b422e038e2ec/
-##   Task ID: jmO4sFW9ERwhhoQ0
+## Content GUID: 1b3a4597-98b5-467a-b638-df39e2ef5efc +## URL: http://localhost:32768/connect/#/apps/1b3a4597-98b5-467a-b638-df39e2ef5efc/ +## Task ID: Gr8JYfZhqgFpPa4e

Retrieve the Content List @@ -192,16 +192,16 @@

Retrieve the Content List## # A tibble: 2 × 5 ## id content_guid principal_guid principal_type role ## <chr> <chr> <chr> <chr> <chr> -## 1 3 7754d693-556c-48b0-9be1-b422e038e2ec 13169aca-6f6a… user view… -## 2 NA 7754d693-556c-48b0-9be1-b422e038e2ec 5fcc3cd9-22f9… user owner +## 1 3 1b3a4597-98b5-467a-b638-df39e2ef5efc 5c653fc8-3fcb… user view… +## 2 NA 1b3a4597-98b5-467a-b638-df39e2ef5efc 0a3e5921-6742… user owner ## ## [[2]] ## # A tibble: 3 × 5 ## id content_guid principal_guid principal_type role ## <chr> <chr> <chr> <chr> <chr> -## 1 1 a12fa281-b1a4-4802-875c-7747c4db27ef 3a576386-eedc… user view… -## 2 2 a12fa281-b1a4-4802-875c-7747c4db27ef 13169aca-6f6a… user view… -## 3 NA a12fa281-b1a4-4802-875c-7747c4db27ef 5fcc3cd9-22f9… user owner +## 1 1 66b778b6-b6c0-4702-98b2-5dee2a5d568c 3e623a69-ab85… user view… +## 2 2 66b778b6-b6c0-4702-98b2-5dee2a5d568c 5c653fc8-3fcb… user view… +## 3 NA 66b778b6-b6c0-4702-98b2-5dee2a5d568c 0a3e5921-6742… user owner

Filter the Content List diff --git a/dev/pkgdown.yml b/dev/pkgdown.yml index 27141831..d6045495 100644 --- a/dev/pkgdown.yml +++ b/dev/pkgdown.yml @@ -7,7 +7,7 @@ articles: customize-http: customize-http.html getting-started: getting-started.html articles/lifecycle-statuses: lifecycle-statuses.html -last_built: 2024-11-08T18:53Z +last_built: 2024-11-08T19:15Z urls: reference: https://pkgs.rstudio.com/connectapi/reference article: https://pkgs.rstudio.com/connectapi/articles diff --git a/dev/reference/bundle_static.html b/dev/reference/bundle_static.html index d2ed0c84..03dd97b6 100644 --- a/dev/reference/bundle_static.html +++ b/dev/reference/bundle_static.html @@ -92,12 +92,12 @@

See alsoExamples


 bundle_static(system.file("logo.png", package = "connectapi"))
-#> Bundling directory (/tmp/RtmpaNfKfe/bundledir21c84620a3ff)
+#> Bundling directory (/tmp/RtmpYD7Rbc/bundledir21733f40762e)
 #> Posit Connect Bundle: 
-#>   Path: /tmp/RtmpaNfKfe/bundle21c8537992f8.tar.gz
+#>   Path: /tmp/RtmpYD7Rbc/bundle2173334b1d25.tar.gz
 #>   Size: 23.9K
 #> 
-#> bundle_path("/tmp/RtmpaNfKfe/bundle21c8537992f8.tar.gz")
+#> bundle_path("/tmp/RtmpYD7Rbc/bundle2173334b1d25.tar.gz")
 #>
diff --git a/dev/reference/connect.html b/dev/reference/connect.html index 71fd2704..5a150fd2 100644 --- a/dev/reference/connect.html +++ b/dev/reference/connect.html @@ -107,7 +107,7 @@

Examples#> Defining Connect with server: http://localhost:32768 #> Posit Connect API Client: #> Posit Connect Server: http://localhost:32768 -#> Posit Connect API Key: ***********gtm8 +#> Posit Connect API Key: ***********6eAV #> diff --git a/dev/reference/get_audit_logs.html b/dev/reference/get_audit_logs.html index 4b552607..6c815d6b 100644 --- a/dev/reference/get_audit_logs.html +++ b/dev/reference/get_audit_logs.html @@ -92,7 +92,7 @@

Value

Details

-

Please see https://docs.posit.co/connect/api/#getAuditLogs for more +

Please see https://docs.posit.co/connect/api/#get-/v1/audit_logs for more information.

diff --git a/dev/reference/get_group_members.html b/dev/reference/get_group_members.html index ca8e7c8e..05833d5c 100644 --- a/dev/reference/get_group_members.html +++ b/dev/reference/get_group_members.html @@ -83,8 +83,8 @@

Value

Details

-

Please see https://docs.posit.co/connect/api/#getGroupMembers for more -information.

+

Please see https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members +for more information.

diff --git a/dev/reference/get_groups.html b/dev/reference/get_groups.html index 02993a15..0746d0ad 100644 --- a/dev/reference/get_groups.html +++ b/dev/reference/get_groups.html @@ -82,12 +82,8 @@

Value

Details

- -
+

Please see https://docs.posit.co/connect/api/#get-/v1/groups for more information.

+

Examples

diff --git a/dev/reference/get_usage_shiny.html b/dev/reference/get_usage_shiny.html index 32d70109..057ea9bf 100644 --- a/dev/reference/get_usage_shiny.html +++ b/dev/reference/get_usage_shiny.html @@ -131,8 +131,8 @@

Value

Details

-

Please see https://docs.posit.co/connect/api/#getShinyAppUsage for more -information.

+

Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/shiny/usage +for more information.

diff --git a/dev/reference/get_usage_static.html b/dev/reference/get_usage_static.html index a4c8612e..ae8eb830 100644 --- a/dev/reference/get_usage_static.html +++ b/dev/reference/get_usage_static.html @@ -138,8 +138,8 @@

Value

Details

-

Please see https://docs.posit.co/connect/api/#getContentVisits for more -information.

+

Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/content/visits +for more information.

diff --git a/dev/search.json b/dev/search.json index ba5e6577..86d676ca 100644 --- a/dev/search.json +++ b/dev/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to connectapi","title":"Contributing to connectapi","text":"outlines propose change connectapi. detailed info contributing , tidyverse packages, please see development contributing guide.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"testing","dir":"","previous_headings":"","what":"Testing","title":"Contributing to connectapi","text":"two test suites package. One contains unit tests tests use API mocks, can run without access running Connect server. Run R test suite devtools::test(). second suite runs integration tests live Connect server running locally Docker. additional requirements. need valid Connect license key file. Put contents license key, path license file, RSC_LICENSE environment variable. need Docker. ’re running ARM (non-Intel) Mac, export DOCKER_DEFAULT_PLATFORM=linux/amd64 Run connectapi:::build_test_env() set Connect processes docker default, run contemporary version Connect. test older version, set environment variable CONNECT_VERSION something else run build_test_env(). Set CONNECTAPI_INTEGRATED=true environment enable running integration tests (’re skipped default). Run source(\"tests/test-integrated.R\")","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to connectapi","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to connectapi","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to connectapi","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"rstudio/connectapi\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to connectapi","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to connectapi","text":"Please note connectapi project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Posit Software, PBC Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"intent","dir":"","previous_headings":"","what":"Intent","title":"NA","text":"Describe problem pull request resolves, new feature introduces. Link related GitHub issues, applicable Fixes #","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"approach","dir":"","previous_headings":"","what":"Approach","title":"NA","text":"Explain solved problem tradeoffs. applicable: - Include guidance reviewers (rewrites …, start …, commit--commit, etc.). - Link notes discussions work. - relevant information tests, automated manual.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"checklist","dir":"","previous_headings":"","what":"Checklist","title":"NA","text":"change update NEWS.md (referencing connected issue necessary)? change need documentation? run `document()?","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":null,"dir":"","previous_headings":"","what":"Development and Release Notes","title":"Development and Release Notes","text":"release process goes CRAN. Details release prepared need formalized documented. interested contributing, please read CONTRIBUTING.md","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":"build-pipeline","dir":"","previous_headings":"","what":"Build Pipeline","title":"Development and Release Notes","text":"use GitHub Actions build process. Files can seen ./workflows directory. modify examples r-lib/actions repository purposes follows: Generally copy examples -, leave names workflows folder consistent history R-CMD-check analogue check-full, without devel R. approximates CRAN submission test-coverage.yaml pkgdown.yaml lines added set appropriate environment variables “integration tests” run Connect order evaluate package (product) thoroughly Similarly integration-tests.yaml, analogous R-CMD-check integration tests ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":"integration-tests","dir":"","previous_headings":"Build Pipeline","what":"Integration Tests","title":"Development and Release Notes","text":"Integration tests designed run connectapi package actual latest version Connect “test environment” stands two Connect instances docker images using un-exported build_test_env() function uses docker compose build environment also use “hacky” utilities build initial user API key executing file able executed independently (know, terrible… made choices reasons) fudge clean line unit tests order ensure complex functionalities work expected without much time work bootstrapping “integration test” execution happens test-integrated.R script, keys mostly CONNECTAPI_INTEGRATED=true environment variable run integration tests interactively / locally run following:","code":"connectapi:::build_test_env() readRenviron(\".Renviron\") # or set this in .Renviron yourself Sys.setenv(\"CONNECTAPI_INTEGRATED\"=\"true\") # or run R CMD CHECK with that env var set, etc. source(\"tests/test-integrated.R\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with connectapi","title":"Getting help with connectapi","text":"Thanks using connectapi! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with connectapi","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with connectapi","text":"Armed reprex, next step figure ask. ’s question: start forum.posit.co, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with connectapi","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"connectapi Tags","text":"understand tags work connectapi, must first understand tags RStudio Connect. Tags RStudio Connect consist multiple “tag trees,” “Category” parent. tag hierarchy / structure created administrators Publishers administrators can associate non-Category tag content tag member “child” tag doe automatically make member “parent” tag always, get started defining CONNECT_SERVER CONNECT_API_KEY variables, initialize API client. NOTE: example report create tag hierarchies use . result, use example verbatim requires admin privileges create tags server.","code":"library(connectapi) client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"create-the-tag-trees","dir":"Articles","previous_headings":"","what":"Create the Tag Tree(s)","title":"connectapi Tags","text":"get started, create tag tree show things work. create_tag() helper allows create singular tag (specifying parent, etc.). purposes, create_tag_tree() easier, since creates entire tree specified .","code":"start_tags <- get_tags(client) start_tags ## Posit Connect Tag Tree ## < No tags > tree_project_1 <- create_tag_tree(client, \"DemoProject\", \"project_1\") ## Posit Connect Tag Tree (filtered) ## └── DemoProject ## └── project_1 tree_project_1 ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********gtm8 tmp_tags <- get_tags(client) tree_project_2 <- create_tag(client, name = \"project_2\", parent = tmp_tags$DemoProject) ## Posit Connect Tag Tree (filtered) ## └── DemoProject ## └── project_2 tree_project_2 ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********gtm8 tree_audience_1 <- create_tag_tree(client, \"DemoAudience\", \"Sales\") ## Posit Connect Tag Tree (filtered) ## └── DemoAudience ## └── Sales tree_audience_2 <- create_tag_tree(client, \"DemoAudience\", \"Finance\") ## Posit Connect Tag Tree (filtered) ## └── DemoAudience ## └── Finance get_tags(client) ## Posit Connect Tag Tree ## ├── DemoProject ## │ ├── project_1 ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"content-tags","dir":"Articles","previous_headings":"","what":"Content tags","title":"connectapi Tags","text":"order show tags work, need content work .","code":"bnd <- bundle_static(system.file(\"logo.png\", package = \"connectapi\")) ## Bundling directory (/tmp/RtmpOykJ6e/bundledir27507afcb7c3) content_1 <- deploy(client, bnd) ## Getting content endpoint ## Found EXISTING content a12fa281-b1a4-4802-875c-7747c4db27ef with name mwlefoodfieexombwkkeulbfd on http://localhost:32768 ## Uploading bundle ## Deploying bundle content_2 <- deploy(client, bnd) ## Getting content endpoint ## ## Uploading bundle ## Deploying bundle"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"set-tags","dir":"Articles","previous_headings":"Content tags","what":"Set Tags","title":"connectapi Tags","text":"Content 1 project_1 Sales, let’s set tags! ways . Content 2 project_2 Audiences (Sales Finance).","code":"all_tags <- get_tags(client) set_content_tag_tree(content_1, \"DemoProject\", \"project_1\") ## Posit Connect Tag Tree (content) ## └── DemoProject ## └── project_1 ## Posit Connect Content Task: ## Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef ## URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/ ## Task ID: j4nOlsdPkSU5lbSt set_content_tags(content_1, all_tags$DemoAudience$Sales) ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_1 ## └── DemoAudience ## └── Sales ## Posit Connect Content Task: ## Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef ## URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/ ## Task ID: j4nOlsdPkSU5lbSt set_content_tags( content_2, all_tags$DemoProject$project_2, all_tags$DemoAudience$Sales, all_tags$DemoAudience$Finance ) ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance ## Posit Connect Content Task: ## Content GUID: 7754d693-556c-48b0-9be1-b422e038e2ec ## URL: http://localhost:32768/connect/#/apps/7754d693-556c-48b0-9be1-b422e038e2ec/ ## Task ID: FuVdrjz22EcjMXgL"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"see-the-tags-associated-with-content","dir":"Articles","previous_headings":"Content tags","what":"See the tags associated with content","title":"connectapi Tags","text":"order see tags associated content, use get_content_tags(). data structure get_tags(), “whole list” filtered tags associated piece content.","code":"c1_tags <- get_content_tags(content_1) c1_tags ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_1 ## └── DemoAudience ## └── Sales c2_tags <- get_content_tags(content_2) c2_tags ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"list-all-content-associated-with-a-tag","dir":"Articles","previous_headings":"","what":"List all content associated with a tag","title":"connectapi Tags","text":"tags defined, can also search content associated tag.","code":"content_list_by_tag(client, all_tags$DemoAudience$Sales) ## # A tibble: 2 × 44 ## guid name title description access_type connection_timeout read_timeout ## ## 1 7754d693-… pbcy… pbcy… \"\" acl NA NA ## 2 a12fa281-… mwle… mwle… \"\" acl NA NA ## # ℹ 37 more variables: init_timeout , idle_timeout , ## # max_processes , min_processes , max_conns_per_process , ## # load_factor , memory_request , memory_limit , ## # cpu_request , cpu_limit , amd_gpu_limit , ## # nvidia_gpu_limit , service_account_name , ## # default_image_name , created_time , last_deployed_time , ## # bundle_id , app_mode , content_category , … content_list_by_tag(client, all_tags$DemoProject$project_1) ## # A tibble: 1 × 44 ## guid name title description access_type connection_timeout read_timeout ## ## 1 a12fa281-… mwle… mwle… \"\" acl NA NA ## # ℹ 37 more variables: init_timeout , idle_timeout , ## # max_processes , min_processes , max_conns_per_process , ## # load_factor , memory_request , memory_limit , ## # cpu_request , cpu_limit , amd_gpu_limit , ## # nvidia_gpu_limit , service_account_name , ## # default_image_name , created_time , last_deployed_time , ## # bundle_id , app_mode , content_category , … content_list_by_tag(client, all_tags$DemoProject) ## # A tibble: 0 × 32 ## # ℹ 32 variables: guid , name , title , description , ## # access_type , connection_timeout , read_timeout , ## # init_timeout , idle_timeout , max_processes , ## # min_processes , max_conns_per_process , load_factor , ## # created_time , last_deployed_time , bundle_id , ## # app_mode , content_category , parameterized , ## # cluster_name , image_name , r_version , py_version , …"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"cleanup","dir":"Articles","previous_headings":"","what":"Cleanup","title":"connectapi Tags","text":"Now clean demo tags created.","code":"# Protect against tags already existing if (\"DemoProject\" %in% names(start_tags) || \"DemoAudience\" %in% names(start_tags)) { stop(\"ERROR: One of the demo tags already exist for you! Beware lest they be deleted by this demo\") } latest_tags <- get_tags(client) delete_tag(client, latest_tags$DemoProject) ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********gtm8 delete_tag(client, latest_tags$DemoAudience) ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********gtm8 # TODO: delete content"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"Content Permissions","text":"filter content permissions, first need “baseline set content.” content server, content particular tag, etc. NOTE: performance depend heavily size baseline set content, permissions API today requires enumeration. improve performance large sets content, can use pins caching disk reduce often requests must re-executed. start deploying pieces test content, two test users, set access controls, tags:","code":"bnd <- bundle_static(system.file(\"logo.png\", package = \"connectapi\")) ## Bundling directory (/tmp/Rtmp8Okmkf/bundledir27891626a2e3) content_1 <- deploy(client, bnd, title = \"App 1\") ## Getting content endpoint ## Found EXISTING content a12fa281-b1a4-4802-875c-7747c4db27ef with name mwlefoodfieexombwkkeulbfd on http://localhost:32768 ## Uploading bundle ## Deploying bundle content_2 <- deploy(client, bnd, title = \"App 2\") ## Getting content endpoint ## Found EXISTING content 7754d693-556c-48b0-9be1-b422e038e2ec with name pbcyvkgufivjubqtxvafbsnay on http://localhost:32768 ## Uploading bundle ## Deploying bundle user_restricted <- client$users_create(\"example_restricted\", \"restricted@example.com\", password = create_random_name()) user_all <- client$users_create(\"example_all\", \"all@example.com\", password = create_random_name()) invisible(create_tag_tree(client, \"Example\", \"Permissions\")) ## Posit Connect Tag Tree (filtered) ## └── Example ## └── Permissions tags <- get_tags(client) tag_1 <- tags$Example$Permissions set_content_tags(content_1, tag_1) ## Posit Connect Tag Tree (content) ## └── Example ## └── Permissions ## Posit Connect Content Task: ## Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef ## URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/ ## Task ID: eSj0HZRLkSymuCYb set_content_tags(content_2, tag_1) ## Posit Connect Tag Tree (content) ## └── Example ## └── Permissions ## Posit Connect Content Task: ## Content GUID: 7754d693-556c-48b0-9be1-b422e038e2ec ## URL: http://localhost:32768/connect/#/apps/7754d693-556c-48b0-9be1-b422e038e2ec/ ## Task ID: jmO4sFW9ERwhhoQ0 content_add_user(content_1, user_restricted$guid, role = \"viewer\") ## Adding permission for user '3a576386-eedc-4245-8551-d30d12502643' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef ## URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/ ## Task ID: eSj0HZRLkSymuCYb content_add_user(content_1, user_all$guid, \"viewer\") ## Adding permission for user '13169aca-6f6a-4e4b-bacb-e1e4c425f14a' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: a12fa281-b1a4-4802-875c-7747c4db27ef ## URL: http://localhost:32768/connect/#/apps/a12fa281-b1a4-4802-875c-7747c4db27ef/ ## Task ID: eSj0HZRLkSymuCYb content_add_user(content_2, user_all$guid, \"viewer\") ## Adding permission for user '13169aca-6f6a-4e4b-bacb-e1e4c425f14a' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: 7754d693-556c-48b0-9be1-b422e038e2ec ## URL: http://localhost:32768/connect/#/apps/7754d693-556c-48b0-9be1-b422e038e2ec/ ## Task ID: jmO4sFW9ERwhhoQ0"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"retrieve-the-content-list","dir":"Articles","previous_headings":"","what":"Retrieve the Content List","title":"Content Permissions","text":"content_list_with_permissions() function core want. However, defaults return content server. servers, expensive (can take 30 minutes ). Instead, recommend using .p argument define “predicate” function (style purrr::keep()) determines records keep. Since predicate access “content list” , retrieve list Content GUIDs first.","code":"my_tag_content <- content_list_by_tag(client, tag_1) content_guids <- my_tag_content$guid c_with_p <- content_list_with_permissions(client, .p = ~ .x$guid %in% content_guids) ## Getting content list ## Getting permission list # another approach, with a function c_with_p <- content_list_with_permissions(client, .p = function(.x) { .x$guid %in% content_guids }) ## Getting content list ## Getting permission list # notice the \"permission\" column: c_with_p$permission ## [[1]] ## # A tibble: 2 × 5 ## id content_guid principal_guid principal_type role ## ## 1 3 7754d693-556c-48b0-9be1-b422e038e2ec 13169aca-6f6a… user view… ## 2 NA 7754d693-556c-48b0-9be1-b422e038e2ec 5fcc3cd9-22f9… user owner ## ## [[2]] ## # A tibble: 3 × 5 ## id content_guid principal_guid principal_type role ## ## 1 1 a12fa281-b1a4-4802-875c-7747c4db27ef 3a576386-eedc… user view… ## 2 2 a12fa281-b1a4-4802-875c-7747c4db27ef 13169aca-6f6a… user view… ## 3 NA a12fa281-b1a4-4802-875c-7747c4db27ef 5fcc3cd9-22f9… user owner"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"filter-the-content-list","dir":"Articles","previous_headings":"","what":"Filter the Content List","title":"Content Permissions","text":"added helper function package filter content list : content_list_guid_has_access() Shiny application personalized context (.e. using session$user), filter content list user see (using permissions column returned )","code":"# restricted has access content_list_guid_has_access(c_with_p, user_restricted$guid) %>% .$title ## [1] \"mwlefoodfieexombwkkeulbfd\" # \"all\" has access content_list_guid_has_access(c_with_p, user_all$guid) %>% .$title ## [1] \"pbcyvkgufivjubqtxvafbsnay\" \"mwlefoodfieexombwkkeulbfd\""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"display-the-content-list","dir":"Articles","previous_headings":"","what":"Display the Content List","title":"Content Permissions","text":"plan build full example Shiny (show example code ). However, suffice say RStudio Connect version 1.9.0 newer, connectwidgets great way plan display data, provides several helpers !","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"Customize HTTP Requests","text":"initialize connectapi API client, implicitly create httr HTTP client. httr package allows configure HTTP requests globally using httr::set_config() scoped variant httr::with_config. walk examples .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"custom-ca-bundle","dir":"Articles","previous_headings":"Getting Started","what":"Custom CA Bundle","title":"Customize HTTP Requests","text":"","code":"library(httr) library(connectapi) client <- connect() # notice that TLS verification fails get_users(client) # use a custom Certificate Authority to verify SSL/TLS requests httr::set_config(httr::config(cainfo = \"/path/to/my.pem\")) # now it should succeed! get_users(client)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"turn-off-certificate-trust-verification---only-for-testing","dir":"Articles","previous_headings":"Getting Started","what":"Turn Off Certificate Trust Verification - ONLY FOR TESTING","title":"Customize HTTP Requests","text":"Sometimes first setting server, common use self-signed certificates. generally bad reliable communication security (reason computer trust server “self-declared” trustworthy actor). However, can useful organization’s Certificate Authority (CA) process issuing valid certificate, certificate procured public CA. can also scoped fashion:","code":"# disabling certificate trust (can allow man-in-the-middle attacks, etc.) httr::set_config(httr::config(ssl_verifypeer = 0, ssl_verifyhost = 0)) # should work client <- connect() get_users(client) httr::with_config( httr::config(ssl_verifypeer = 0, ssl_verifyhost = 0), { client <- connect() get_users(client) } )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"custom-headers-cookies-proxy-etc-","dir":"Articles","previous_headings":"Getting Started","what":"Custom Headers, Cookies, Proxy, etc.","title":"Customize HTTP Requests","text":"httr helpers common tasks like httr::add_headers(), httr::set_cookies(), httr::use_proxy(), etc. Using bit tricky, can done way client$httr_config() function. Pass usual httr arguments client$httr_config(), arguments saved passed subsequent GET, PUT, POST, PATCH, HEAD, DELETE requests send client. NOTE: values completely overwritten time call client$httr_config(), ensure pass desired values time","code":"# for instance, to set custom headers (i.e. to get through a proxy) client$httr_config(httr::add_headers(MY_MAGIC_HEADER = \"value\")) # or to clear sticky cookies if you want to switch nodes in an HA cluster client <- connect() client$server_settings()$hostname client$httr_config(handle = httr::handle(\"\")) # now you have a chance to get a new host client$server_settings()$hostname # use an outbound proxy client$httr_config(httr::use_proxy(\"http://myproxy.example.com\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"using-kerberos","dir":"Articles","previous_headings":"Getting Started","what":"Using Kerberos","title":"Customize HTTP Requests","text":"Suffice say effectively using Kerberos HTTP bit advanced topic. However, possible httr. worth noting today, interferes API key authentication, hoping improve future release Posit Connect.","code":"# disables authentication header that is included by default client$using_auth <- FALSE # use Kerberos authentication mechanism (requires local credential cache) client$httr_config(httr::authenticate(\":\", \"\", type = \"gssnegotiate\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/getting-started.html","id":"connecting","dir":"Articles","previous_headings":"","what":"Connecting","title":"Getting Started with connectapi","text":"first thing need accomplish using connectapi getting connected Posit Connect server. requires URL server API key. Directions get API key . API key, can create Connect object code, like : alternative define .Renviron file, specifies environment variables: , can used code:","code":"library(connectapi) client <- connect( server = \"http://example.com:3939\", api_key = \"aihgaahegiahgg\" ) CONNECT_SERVER=http://example.com:3939 CONNECT_API_KEY=aihgaahegiahgg library(connectapi) # this happens by default if you restart your R session readRenviron(\".Renviron\") client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/getting-started.html","id":"content-management","dir":"Articles","previous_headings":"","what":"Content Management","title":"Getting Started with connectapi","text":"connectapi package tools help programmatically deploy manage content. get started, need use rsconnect package, specifically rsconnect::writeManifest() function, build manifest.json file directory content want deploy. manifest.json file present, can reference directory deploy directly: content object (content_1) includes information deployment just requested. can explored : Alternatively, can immediately begin altering settings content object wait deployment complete: content already exists want update , can using content GUID (can find within Posit Connect Info pane). can also use Posit Connect content GUID retrieve information existing content (want examine change settings)","code":"bnd <- bundle_dir(\"./my/directory\") # name must be unique on the server # if you do not specify it, a random value will be provided content_1 <- client %>% deploy(bnd, name = \"my-content\", title = \"Amazing Report!!\") content_1 %>% poll_task() content_1 %>% set_thumbnail(\"https://gph.is/29vyb0s\") %>% set_vanity_url(\"/my_clever_content\") # ensure the vanity URL is set as expected content_1 %>% get_vanity_url() content_2 <- client %>% deploy(bnd, guid = \"d78ba9f8-bb57-422e-b164-9ecd8e4c4fd6\") %>% poll_task() content_3 <- client %>% content_item(guid = \"96532fbc-725e-441b-9cc6-a5622535241b\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Toph Allen. Author, maintainer. Neal Richardson. Author. Sean Lopp. Author. Cole Arendt. Author. Posit, PBC. Copyright holder, funder.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Allen T, Richardson N, Lopp S, Arendt C (2024). connectapi: Utilities Interacting 'Posit Connect' Server API. R package version 0.3.0.9000, https://github.com/rstudio/connectapi, https://pkgs.rstudio.com/connectapi/.","code":"@Manual{, title = {connectapi: Utilities for Interacting with the 'Posit Connect' Server API}, author = {Toph Allen and Neal Richardson and Sean Lopp and Cole Arendt}, year = {2024}, note = {R package version 0.3.0.9000, https://github.com/rstudio/connectapi}, url = {https://pkgs.rstudio.com/connectapi/}, }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"connectapi-","dir":"","previous_headings":"","what":"Utilities for Interacting with the Posit Connect Server API","title":"Utilities for Interacting with the Posit Connect Server API","text":"package provides R client Posit Connect Server API, well helpful functions utilize client. designed work supported versions Connect, though features may available newer versions.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Utilities for Interacting with the Posit Connect Server API","text":"install CRAN: install development version:","code":"install.packages(\"connectapi\") remotes::install_github('rstudio/connectapi')"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"client","dir":"","previous_headings":"","what":"Client","title":"Utilities for Interacting with the Posit Connect Server API","text":"create client: can also define following environment variables (.Renviron file, instance): environment variable values used automatically defined R session.","code":"library(connectapi) client <- connect( server = \"https://connect.example.com\", api_key = \"\" ) CONNECT_SERVER = https://connect.example.com CONNECT_API_KEY = my-secret-api-key library(connectapi) client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting Started","title":"Utilities for Interacting with the Posit Connect Server API","text":"client defined, can use interact Posit Connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"exploring-data","dir":"","previous_headings":"Getting Started","what":"Exploring Data","title":"Utilities for Interacting with the Posit Connect Server API","text":"can use get_ methods retrieve data Posit Connect server.","code":"library(connectapi) client <- connect() # get data users <- get_users(client) groups <- get_groups(client) usage_shiny <- get_usage_shiny(client) usage_static <- get_usage_static(client) some_content <- get_content(client) # get all content all_content <- get_content(client, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"deployment","dir":"","previous_headings":"Getting Started","what":"Deployment","title":"Utilities for Interacting with the Posit Connect Server API","text":"rsconnect package usually used deploying content Connect. However, want use programmatic deployment Posit Connect Server API, connectapi helpers useful!","code":"library(connectapi) client <- connect() # deploying content # NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()` bundle <- bundle_dir(\"./path/to/directory\") content <- client %>% deploy(bundle, name = \"my-app-name\") %>% poll_task() # set an image for content content %>% set_thumbnail(\"./my/local/image.png\") content %>% set_thumbnail(\"http://url.example.com/image.png\") # set image and a vanity URL content %>% set_thumbnail(\"./my/local/image.png\") %>% set_vanity_url(\"/my-awesome-app\") # change access_type to \"anyone\" content$update(access_type = \"all\") # edit another piece of content client %>% content_item(\"the-content-guid\") %>% set_vanity_url(\"/another-awesome-app\") # migrate content to another server client_prod <- connect( server = \"prod.example.com\", api_key = \"my-secret-key\" ) prod_bnd <- client %>% content_item(\"the-guid-to-promote\") %>% download_bundle() client_prod %>% deploy(prod_bnd, title = \"Now in Production\") %>% set_vanity_url(\"/my-app\") # open a browser to the content item client_prod %>% browse_dashboard() client_prod %>% browse_solo() # open a browser to the docs client_prod %>% browse_api_docs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"troubleshooting-and-faq","dir":"","previous_headings":"","what":"Troubleshooting and FAQ","title":"Utilities for Interacting with the Posit Connect Server API","text":"Access Denied Errors? likely due either (1) Connect$server Connect$api_key defined improperly (2) access Posit Connect cluster operation question Warning version numbers test package range versions Connect, old 1.8.8.2 (May 2021). Connect server older , package may still work, connectapi warn . strive : track latest version Posit Connect API add new features come available demand maintain backwards compatibility priorities sometimes odds, sometimes create inconsistencies versions result. mitigate , recommend: Track version connectapi use applications using renv Test high value content uses connectapi updating connectapi Posit Connect Update Posit Connect latest version first update connectapi needed Error - Need update Posit Connect helpful clarification users, added error messages API requests version implemented package specifically introduces backwards incompatible dependency older versions Posit Connect. get error message, recommendation : Look NEWS.md find moment change introduced Downgrade connectapi previous version package (Advanced) Use “blame” feature GitHub track commits find error introduced Please feel free open Issue think bug, ask free-form question Posit Community ideas FAQs Common Issues? Please open issue PR! love contribution!","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Utilities for Interacting with the Posit Connect Server API","text":"Please note connectapi project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":null,"dir":"Reference","previous_headings":"","what":"Bundle — Bundle","title":"Bundle — Bundle","text":"Bundle Bundle","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Bundle — Bundle","text":"R6 class represents bundle","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Bundle — Bundle","text":"path bundle path disk. size size bundle.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Bundle — Bundle","text":"Bundle$new() Bundle$print() Bundle$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Bundle — Bundle","text":"Initialize content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$new(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"path bundle path disk.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Bundle — Bundle","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Bundle — Bundle","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":null,"dir":"Reference","previous_headings":"","what":"Content — Content","title":"Content — Content","text":"Content Content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content — Content","text":"R6 class represents content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Content — Content","text":"connect R6 Connect object content content details Posit Connect","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Content — Content","text":"default_variant default variant object. is_rendered TRUE rendered content type, otherwise FALSE. is_interactive TRUE rendered content type, otherwise FALSE.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Content — Content","text":"Content$new() Content$get_connect() Content$get_content() Content$get_content_remote() Content$get_bundles() Content$bundle_download() Content$bundle_delete() Content$internal_content() Content$update() Content$danger_delete() Content$get_url() Content$get_dashboard_url() Content$jobs() Content$job() Content$variants() Content$tag_set() Content$tag_delete() Content$tags() Content$permissions_add() Content$permissions_update() Content$permissions_delete() Content$permissions() Content$environment() Content$environment_set() Content$environment_all() Content$deploy() Content$repo_enable() Content$repo_set() Content$print() Content$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Content — Content","text":"Initialize content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$new(connect, content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"connect Connect instance. content content data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Content — Content","text":"Returns Connect instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"Content — Content","text":"Returns underlying content data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_content()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-content-remote-","dir":"Reference","previous_headings":"","what":"Method get_content_remote()","title":"Content — Content","text":"Obtain content data Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_content_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-bundles-","dir":"Reference","previous_headings":"","what":"Method get_bundles()","title":"Content — Content","text":"Return set content bundles.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_bundles()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-bundle-download-","dir":"Reference","previous_headings":"","what":"Method bundle_download()","title":"Content — Content","text":"Download source archive content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$bundle_download( bundle_id, filename = tempfile(pattern = \"bundle\", fileext = \".tar.gz\"), overwrite = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id bundle identifer. filename write result. overwrite Overwrite existing filename.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-bundle-delete-","dir":"Reference","previous_headings":"","what":"Method bundle_delete()","title":"Content — Content","text":"Delete content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$bundle_delete(bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id bundle identifer.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-internal-content-","dir":"Reference","previous_headings":"","what":"Method internal_content()","title":"Content — Content","text":"Get (remote) content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$internal_content()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-update-","dir":"Reference","previous_headings":"","what":"Method update()","title":"Content — Content","text":"Update content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$update(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Content fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-danger-delete-","dir":"Reference","previous_headings":"","what":"Method danger_delete()","title":"Content — Content","text":"Delete content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$danger_delete()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-url-","dir":"Reference","previous_headings":"","what":"Method get_url()","title":"Content — Content","text":"Return URL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Content — Content","text":"Return URL content Posit Connect dashboard.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_dashboard_url(pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"pane pane dashboard link .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-jobs-","dir":"Reference","previous_headings":"","what":"Method jobs()","title":"Content — Content","text":"Return jobs content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$jobs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-job-","dir":"Reference","previous_headings":"","what":"Method job()","title":"Content — Content","text":"Return single job content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$job(key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"key job key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-variants-","dir":"Reference","previous_headings":"","what":"Method variants()","title":"Content — Content","text":"Return variants content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$variants()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tag-set-","dir":"Reference","previous_headings":"","what":"Method tag_set()","title":"Content — Content","text":"Set tag content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tag_set(tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tag-delete-","dir":"Reference","previous_headings":"","what":"Method tag_delete()","title":"Content — Content","text":"Remove tag content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tag_delete(tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tags-","dir":"Reference","previous_headings":"","what":"Method tags()","title":"Content — Content","text":"tags content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tags()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-add-","dir":"Reference","previous_headings":"","what":"Method permissions_add()","title":"Content — Content","text":"Add principal ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_add(principal_guid, principal_type, role)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"principal_guid GUID target user group. principal_type Acting user group. role kind content access.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-update-","dir":"Reference","previous_headings":"","what":"Method permissions_update()","title":"Content — Content","text":"Alter principal ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_update(id, principal_guid, principal_type, role)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier. principal_guid GUID target user group. principal_type Acting user group. role kind content access.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-delete-","dir":"Reference","previous_headings":"","what":"Method permissions_delete()","title":"Content — Content","text":"Remove entry ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_delete(id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-","dir":"Reference","previous_headings":"","what":"Method permissions()","title":"Content — Content","text":"Obtain ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions(id = NULL, add_owner = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier. add_owner Include content owner result set.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-","dir":"Reference","previous_headings":"","what":"Method environment()","title":"Content — Content","text":"Return environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-set-","dir":"Reference","previous_headings":"","what":"Method environment_set()","title":"Content — Content","text":"Adjust environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment_set(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Environment variable names values. Use NA value unset variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-all-","dir":"Reference","previous_headings":"","what":"Method environment_all()","title":"Content — Content","text":"Overwrite environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment_all(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-deploy-","dir":"Reference","previous_headings":"","what":"Method deploy()","title":"Content — Content","text":"Deploy content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$deploy(bundle_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id Target bundle identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-repo-enable-","dir":"Reference","previous_headings":"","what":"Method repo_enable()","title":"Content — Content","text":"Adjust Git polling.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$repo_enable(enabled = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"enabled Polling enabled.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-repo-set-","dir":"Reference","previous_headings":"","what":"Method repo_set()","title":"Content — Content","text":"Adjust Git repository.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$repo_set(repository, branch, subdirectory)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"repository Git repository URL branch Git repository branch subdirectory Git repository directory","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Content — Content","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-28","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Content — Content","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-29","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":null,"dir":"Reference","previous_headings":"","what":"ContentTask — ContentTask","title":"ContentTask — ContentTask","text":"ContentTask ContentTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"ContentTask — ContentTask","text":"R6 class represents Task piece Content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"ContentTask — ContentTask","text":"connectapi::Content -> ContentTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"ContentTask — ContentTask","text":"task task. data task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"ContentTask — ContentTask","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ContentTask — ContentTask","text":"ContentTask$new() ContentTask$get_task() ContentTask$add_data() ContentTask$get_data() ContentTask$print() ContentTask$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ContentTask — ContentTask","text":"Initialize task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$new(connect, content, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"connect Connect instance. content Content instance. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"ContentTask — ContentTask","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"ContentTask — ContentTask","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"ContentTask — ContentTask","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"ContentTask — ContentTask","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ContentTask — ContentTask","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":null,"dir":"Reference","previous_headings":"","what":"Environment — Environment","title":"Environment — Environment","text":"Environment Environment","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Environment — Environment","text":"R6 class represents Content's Environment Variables","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Environment — Environment","text":"connectapi::Content -> Environment","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Environment — Environment","text":"env_raw (raw) set environment variables. env_vars set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Environment — Environment","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Environment — Environment","text":"Environment$new() Environment$environment() Environment$environment_set() Environment$environment_all() Environment$env_refresh() Environment$print() Environment$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Environment — Environment","text":"Initialize set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$new(connect, content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"connect Connect instance. content Content instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-","dir":"Reference","previous_headings":"","what":"Method environment()","title":"Environment — Environment","text":"Fetch set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-set-","dir":"Reference","previous_headings":"","what":"Method environment_set()","title":"Environment — Environment","text":"Update set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment_set(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-all-","dir":"Reference","previous_headings":"","what":"Method environment_all()","title":"Environment — Environment","text":"Overwrite set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment_all(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-env-refresh-","dir":"Reference","previous_headings":"","what":"Method env_refresh()","title":"Environment — Environment","text":"Fetch set o environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$env_refresh()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Environment — Environment","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Environment — Environment","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":null,"dir":"Reference","previous_headings":"","what":"Class representing a Connect API client — PositConnect","title":"Class representing a Connect API client — PositConnect","text":"Class representing Connect API client Class representing Connect API client","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"client <- Connect$new(server = 'connect.example.com', apiKey = 'mysecretkey') client$get_apps() client$get_tags()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Class representing a Connect API client — PositConnect","text":"class allows user interact Connect server via Connect API. Authentication done providing API key.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class representing a Connect API client — PositConnect","text":"server base URL Posit Connect server. api_key Posit Connect API key. tags initial set tags. tag_map initial tag map. httr_additions initial set httr configuration added HTTP call. using_auth Indicates API key added HTTP call.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class representing a Connect API client — PositConnect","text":"version server version.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class representing a Connect API client — PositConnect","text":"Connect$get_connect() Connect$new() Connect$httr_config() Connect$print() Connect$raise_error() Connect$add_auth() Connect$api_url() Connect$server_url() Connect$request() Connect$GET() Connect$PUT() Connect$HEAD() Connect$DELETE() Connect$PATCH() Connect$POST() Connect$() Connect$get_dashboard_url() Connect$get_tags() Connect$get_tag_id() Connect$get_tag_tree() Connect$tag_create_safe() Connect$tag_create() Connect$tag() Connect$tag_delete() Connect$get_apps() Connect$get_schedule() Connect$content_create() Connect$content_upload() Connect$content_deploy() Connect$content() Connect$task() Connect$set_content_tag() Connect$remove_content_tag() Connect$user() Connect$users() Connect$users_remote() Connect$users_create() Connect$users_create_remote() Connect$users_lock() Connect$users_unlock() Connect$users_update() Connect$groups() Connect$group_members() Connect$group_member_add() Connect$group_member_remove() Connect$groups_create() Connect$groups_create_remote() Connect$groups_remote() Connect$inst_content_visits() Connect$inst_shiny_usage() Connect$procs() Connect$repo_account() Connect$repo_branches() Connect$repo_manifest_dirs() Connect$schedules() Connect$docs() Connect$audit_logs() Connect$server_settings_r() Connect$server_settings() Connect$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Class representing a Connect API client — PositConnect","text":"Return connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class representing a Connect API client — PositConnect","text":"Initialize new connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$new(server, api_key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"server base URL Posit Connect server. api_key Posit Connect API key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-httr-config-","dir":"Reference","previous_headings":"","what":"Method httr_config()","title":"Class representing a Connect API client — PositConnect","text":"Set additional httr configuration added HTTP call.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$httr_config(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... Set httr configurations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Class representing a Connect API client — PositConnect","text":"Print details instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... Ignored.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-raise-error-","dir":"Reference","previous_headings":"","what":"Method raise_error()","title":"Class representing a Connect API client — PositConnect","text":"Raise error HTTP result HTTP error.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$raise_error(res)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"res HTTP result.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-add-auth-","dir":"Reference","previous_headings":"","what":"Method add_auth()","title":"Class representing a Connect API client — PositConnect","text":"Returns HTTP authorization headers, NULL none used.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$add_auth()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-api-url-","dir":"Reference","previous_headings":"","what":"Method api_url()","title":"Class representing a Connect API client — PositConnect","text":"Build URL relative API root","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$api_url(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... path segments","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-url-","dir":"Reference","previous_headings":"","what":"Method server_url()","title":"Class representing a Connect API client — PositConnect","text":"Build URL relative server root","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_url(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... path segments","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-request-","dir":"Reference","previous_headings":"","what":"Method request()","title":"Class representing a Connect API client — PositConnect","text":"General wrapper around httr verbs","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$request(method, url, ..., parser = \"parsed\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"method HTTP request method url URL request ... Additional arguments passed request function parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-","dir":"Reference","previous_headings":"","what":"Method GET()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP GET request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$GET(path, ..., url = self$api_url(path), parser = \"parsed\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::GET() url Target URL. Default uses path, provide url request server resource /__api__ parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-put-","dir":"Reference","previous_headings":"","what":"Method PUT()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP PUT request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$PUT( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::PUT() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-head-","dir":"Reference","previous_headings":"","what":"Method HEAD()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP HEAD request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$HEAD(path, ..., url = self$api_url(path))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::HEAD() url Target URL. Default uses path, provide url request server resource /__api__ httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-delete-","dir":"Reference","previous_headings":"","what":"Method DELETE()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP DELETE request named API path. Returns HTTP response object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$DELETE(path, ..., url = self$api_url(path), parser = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::DELETE() url Target URL. Default uses path, provide url request server resource /__api__ parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-patch-","dir":"Reference","previous_headings":"","what":"Method PATCH()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP PATCH request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$PATCH( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::PATCH() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-post-","dir":"Reference","previous_headings":"","what":"Method POST()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP POST request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$POST( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::POST() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-me-","dir":"Reference","previous_headings":"","what":"Method me()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP GET request \"\" server endpoint.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$me()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Class representing a Connect API client — PositConnect","text":"Return base URL Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_dashboard_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tags-","dir":"Reference","previous_headings":"","what":"Method get_tags()","title":"Class representing a Connect API client — PositConnect","text":"Return tags.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tags(use_cache = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"use_cache Indicates cached set tags used.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tag-id-","dir":"Reference","previous_headings":"","what":"Method get_tag_id()","title":"Class representing a Connect API client — PositConnect","text":"Get identifier named tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tag_id(tagname)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"tagname name tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tag-tree-","dir":"Reference","previous_headings":"","what":"Method get_tag_tree()","title":"Class representing a Connect API client — PositConnect","text":"Get tag tree.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tag_tree()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-create-safe-","dir":"Reference","previous_headings":"","what":"Method tag_create_safe()","title":"Class representing a Connect API client — PositConnect","text":"Create tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_create_safe(name, parent_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name tag name. parent_id parent identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-create-","dir":"Reference","previous_headings":"","what":"Method tag_create()","title":"Class representing a Connect API client — PositConnect","text":"Create tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_create(name, parent_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name tag name. parent_id parent identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-","dir":"Reference","previous_headings":"","what":"Method tag()","title":"Class representing a Connect API client — PositConnect","text":"Get tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag(id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-delete-","dir":"Reference","previous_headings":"","what":"Method tag_delete()","title":"Class representing a Connect API client — PositConnect","text":"Delete tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_delete(id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-apps-","dir":"Reference","previous_headings":"","what":"Method get_apps()","title":"Class representing a Connect API client — PositConnect","text":"Get content items.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_apps(filter = NULL, .collapse = \"&\", .limit = Inf, page_size = 25)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-19","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"filter Named list containing filter conditions. .collapse multiple filters combined. .limit limit. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"Class representing a Connect API client — PositConnect","text":"Get schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_schedule(schedule_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-20","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"schedule_id schedule identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-create-","dir":"Reference","previous_headings":"","what":"Method content_create()","title":"Class representing a Connect API client — PositConnect","text":"Create content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_create(name, title = name, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-21","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name content name. title content title. ... content fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-upload-","dir":"Reference","previous_headings":"","what":"Method content_upload()","title":"Class representing a Connect API client — PositConnect","text":"Upload content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-28","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_upload(bundle_path, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-22","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"bundle_path path bundle archive. guid content GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-deploy-","dir":"Reference","previous_headings":"","what":"Method content_deploy()","title":"Class representing a Connect API client — PositConnect","text":"Deploy content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-29","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_deploy(guid, bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-23","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid content GUID. bundle_id bundle identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-","dir":"Reference","previous_headings":"","what":"Method content()","title":"Class representing a Connect API client — PositConnect","text":"Get content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-30","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content( guid = NULL, owner_guid = NULL, name = NULL, include = \"tags,owner\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-24","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid content GUID. owner_guid target content owner. name target name. include Additional response fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-task-","dir":"Reference","previous_headings":"","what":"Method task()","title":"Class representing a Connect API client — PositConnect","text":"Get task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-31","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$task(task_id, first = 0, wait = 5)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-25","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"task_id task identifier. first initial status position. wait Maximum time wait update.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-set-content-tag-","dir":"Reference","previous_headings":"","what":"Method set_content_tag()","title":"Class representing a Connect API client — PositConnect","text":"Set tag content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-32","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$set_content_tag(content_id, tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-26","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_id content identifier. tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-remove-content-tag-","dir":"Reference","previous_headings":"","what":"Method remove_content_tag()","title":"Class representing a Connect API client — PositConnect","text":"Remove tag content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-33","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$remove_content_tag(content_id, tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-27","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_id content identifier. tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-user-","dir":"Reference","previous_headings":"","what":"Method user()","title":"Class representing a Connect API client — PositConnect","text":"Get user details.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-34","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$user(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-28","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-","dir":"Reference","previous_headings":"","what":"Method users()","title":"Class representing a Connect API client — PositConnect","text":"Get users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-35","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users(page_number = 1, prefix = NULL, page_size = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-29","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"page_number page number. prefix search term. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-remote-","dir":"Reference","previous_headings":"","what":"Method users_remote()","title":"Class representing a Connect API client — PositConnect","text":"Get remote users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-36","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_remote(prefix)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-30","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"prefix search term.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-create-","dir":"Reference","previous_headings":"","what":"Method users_create()","title":"Class representing a Connect API client — PositConnect","text":"Create user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-37","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_create( username, email, first_name = NULL, last_name = NULL, password = NULL, user_must_set_password = NULL, user_role = NULL, unique_id = NULL )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-31","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"username username. email Email address. first_name First name. last_name Last name. password password. user_must_set_password Indicates user sets password first login. user_role Role user. unique_id Identifier user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-create-remote-","dir":"Reference","previous_headings":"","what":"Method users_create_remote()","title":"Class representing a Connect API client — PositConnect","text":"Create remote user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-38","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_create_remote(temp_ticket)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-32","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"temp_ticket Ticket identifying target remote user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-lock-","dir":"Reference","previous_headings":"","what":"Method users_lock()","title":"Class representing a Connect API client — PositConnect","text":"Lock user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-39","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_lock(user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-33","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-unlock-","dir":"Reference","previous_headings":"","what":"Method users_unlock()","title":"Class representing a Connect API client — PositConnect","text":"Unlock user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-40","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_unlock(user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-34","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-update-","dir":"Reference","previous_headings":"","what":"Method users_update()","title":"Class representing a Connect API client — PositConnect","text":"Update user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-41","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_update(user_guid, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-35","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID. ... User fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-","dir":"Reference","previous_headings":"","what":"Method groups()","title":"Class representing a Connect API client — PositConnect","text":"Get groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-42","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups(page_number = 1, prefix = NULL, page_size = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-36","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"page_number page number. prefix search term. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-members-","dir":"Reference","previous_headings":"","what":"Method group_members()","title":"Class representing a Connect API client — PositConnect","text":"Get group members.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-43","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_members(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-37","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid group GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-member-add-","dir":"Reference","previous_headings":"","what":"Method group_member_add()","title":"Class representing a Connect API client — PositConnect","text":"Add group member.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-44","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_member_add(group_guid, user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-38","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"group_guid group GUID. user_guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-member-remove-","dir":"Reference","previous_headings":"","what":"Method group_member_remove()","title":"Class representing a Connect API client — PositConnect","text":"Remove group member.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-45","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_member_remove(group_guid, user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-39","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"group_guid group GUID. user_guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-create-","dir":"Reference","previous_headings":"","what":"Method groups_create()","title":"Class representing a Connect API client — PositConnect","text":"Create group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-46","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_create(name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-40","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name group name.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-create-remote-","dir":"Reference","previous_headings":"","what":"Method groups_create_remote()","title":"Class representing a Connect API client — PositConnect","text":"Create remote group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-47","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_create_remote(temp_ticket)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-41","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"temp_ticket Ticket identifying target remote group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-remote-","dir":"Reference","previous_headings":"","what":"Method groups_remote()","title":"Class representing a Connect API client — PositConnect","text":"Get remote groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-48","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_remote(prefix = NULL, limit = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-42","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"prefix search term. limit maximal result set size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-inst-content-visits-","dir":"Reference","previous_headings":"","what":"Method inst_content_visits()","title":"Class representing a Connect API client — PositConnect","text":"Get (non-interactive) content visits.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-49","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$inst_content_visits( content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-43","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_guid Content GUID. min_data_version Data version request. Start range. End range. limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-inst-shiny-usage-","dir":"Reference","previous_headings":"","what":"Method inst_shiny_usage()","title":"Class representing a Connect API client — PositConnect","text":"Get interactive content visits. Get (non-interactive) content visits.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-50","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$inst_shiny_usage( content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-44","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_guid Content GUID. min_data_version Data version request. Start range. End range. limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-procs-","dir":"Reference","previous_headings":"","what":"Method procs()","title":"Class representing a Connect API client — PositConnect","text":"Get running processes.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-51","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$procs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-account-","dir":"Reference","previous_headings":"","what":"Method repo_account()","title":"Class representing a Connect API client — PositConnect","text":"Determine Git repository associated authorization.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-52","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_account(host)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-45","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"host Repository URL.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-branches-","dir":"Reference","previous_headings":"","what":"Method repo_branches()","title":"Class representing a Connect API client — PositConnect","text":"Get Git repository branches.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-53","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_branches(repo)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-46","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"repo Repository URL.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-manifest-dirs-","dir":"Reference","previous_headings":"","what":"Method repo_manifest_dirs()","title":"Class representing a Connect API client — PositConnect","text":"Get Git repository directories.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-54","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_manifest_dirs(repo, branch)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-47","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"repo Repository URL. branch Repository branch.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-schedules-","dir":"Reference","previous_headings":"","what":"Method schedules()","title":"Class representing a Connect API client — PositConnect","text":"Get schedules.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-55","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$schedules( start = Sys.time(), end = Sys.time() + 60 * 60 * 24 * 7, detailed = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-48","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"start Starting time. end Ending time. detailed Indicates detailed schedule information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-docs-","dir":"Reference","previous_headings":"","what":"Method docs()","title":"Class representing a Connect API client — PositConnect","text":"Get documentation.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-56","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$docs(docs = \"api\", browse = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-49","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"docs Named document. browse Open browser.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-audit-logs-","dir":"Reference","previous_headings":"","what":"Method audit_logs()","title":"Class representing a Connect API client — PositConnect","text":"Get auditing.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-57","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$audit_logs(limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-50","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-settings-r-","dir":"Reference","previous_headings":"","what":"Method server_settings_r()","title":"Class representing a Connect API client — PositConnect","text":"Get R installations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-58","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_settings_r()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-settings-","dir":"Reference","previous_headings":"","what":"Method server_settings()","title":"Class representing a Connect API client — PositConnect","text":"Get server settings.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-59","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_settings()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class representing a Connect API client — PositConnect","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-60","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-51","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":null,"dir":"Reference","previous_headings":"","what":"Task — Task","title":"Task — Task","text":"Task Task","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Task — Task","text":"R6 class represents Task","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Task — Task","text":"connect Connect instance. task task. data task data.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Task — Task","text":"Task$new() Task$get_connect() Task$get_task() Task$add_data() Task$get_data() Task$print() Task$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Task — Task","text":"Initialize task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$new(connect, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"connect Connect instance. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Task — Task","text":"Return associated Connect instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"Task — Task","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"Task — Task","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"Task — Task","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Task — Task","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Task — Task","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":null,"dir":"Reference","previous_headings":"","what":"Vanity — Vanity","title":"Vanity — Vanity","text":"Vanity Vanity","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Vanity — Vanity","text":"R6 class represents Vanity URL","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Vanity — Vanity","text":"connectapi::Content -> Vanity","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Vanity — Vanity","text":"vanity vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Vanity — Vanity","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Vanity — Vanity","text":"Vanity$new() Vanity$get_vanity() Vanity$print() Vanity$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Vanity — Vanity","text":"Initialize vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$new(connect, content, vanity)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"connect Connect instance. content Content instance. vanity vanity data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-get-vanity-","dir":"Reference","previous_headings":"","what":"Method get_vanity()","title":"Vanity — Vanity","text":"Return underlying vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$get_vanity()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Vanity — Vanity","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Vanity — Vanity","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":null,"dir":"Reference","previous_headings":"","what":"Variant — Variant","title":"Variant — Variant","text":"Variant Variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Variant — Variant","text":"R6 class represents Variant","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Variant — Variant","text":"connectapi::Content -> Variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Variant — Variant","text":"key variant key. variant variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Variant — Variant","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Variant — Variant","text":"Variant$get_variant() Variant$get_variant_remote() Variant$new() Variant$send_mail() Variant$get_schedule() Variant$get_schedule_remote() Variant$get_subscribers() Variant$remove_subscriber() Variant$add_subscribers() Variant$render() Variant$renderings() Variant$update_variant() Variant$jobs() Variant$job() Variant$get_url() Variant$get_url_rev() Variant$get_dashboard_url() Variant$print() Variant$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-variant-","dir":"Reference","previous_headings":"","what":"Method get_variant()","title":"Variant — Variant","text":"Get underlying variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_variant()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-variant-remote-","dir":"Reference","previous_headings":"","what":"Method get_variant_remote()","title":"Variant — Variant","text":"Get store (remote) variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_variant_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Variant — Variant","text":"Initialize variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$new(connect, content, key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"connect Connect instance. content Content instance. key variant key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-send-mail-","dir":"Reference","previous_headings":"","what":"Method send_mail()","title":"Variant — Variant","text":"Mail previously rendered content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$send_mail(to = c(\"me\", \"collaborators\", \"collaborators_viewers\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"Targeting.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"Variant — Variant","text":"Get (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-schedule-remote-","dir":"Reference","previous_headings":"","what":"Method get_schedule_remote()","title":"Variant — Variant","text":"Get (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_schedule_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-subscribers-","dir":"Reference","previous_headings":"","what":"Method get_subscribers()","title":"Variant — Variant","text":"Get subscribers.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_subscribers()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-remove-subscriber-","dir":"Reference","previous_headings":"","what":"Method remove_subscriber()","title":"Variant — Variant","text":"Remove named subscriber.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$remove_subscriber(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-add-subscribers-","dir":"Reference","previous_headings":"","what":"Method add_subscribers()","title":"Variant — Variant","text":"Add named subscribers.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$add_subscribers(guids)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"guids User GUIDs.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-render-","dir":"Reference","previous_headings":"","what":"Method render()","title":"Variant — Variant","text":"Render variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$render()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-renderings-","dir":"Reference","previous_headings":"","what":"Method renderings()","title":"Variant — Variant","text":"List renderings variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$renderings()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-update-variant-","dir":"Reference","previous_headings":"","what":"Method update_variant()","title":"Variant — Variant","text":"Update variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$update_variant(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"... Target fields values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-jobs-","dir":"Reference","previous_headings":"","what":"Method jobs()","title":"Variant — Variant","text":"Jobs variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$jobs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-job-","dir":"Reference","previous_headings":"","what":"Method job()","title":"Variant — Variant","text":"Return single job variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$job(key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"key job key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-url-","dir":"Reference","previous_headings":"","what":"Method get_url()","title":"Variant — Variant","text":"Return URL variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-url-rev-","dir":"Reference","previous_headings":"","what":"Method get_url_rev()","title":"Variant — Variant","text":"Return URL associated one rendering variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_url_rev(rev)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"rev Rendering identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Variant — Variant","text":"Return URL variant Posit Connect dashboard.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_dashboard_url(pane = \"access\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"pane pane dashboard link .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Variant — Variant","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Variant — Variant","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":null,"dir":"Reference","previous_headings":"","what":"VariantSchedule — VariantSchedule","title":"VariantSchedule — VariantSchedule","text":"VariantSchedule VariantSchedule","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"VariantSchedule — VariantSchedule","text":"R6 class represents Schedule","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"VariantSchedule — VariantSchedule","text":"connectapi::Content -> connectapi::Variant -> VariantSchedule","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"VariantSchedule — VariantSchedule","text":"schedule_data schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"VariantSchedule — VariantSchedule","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants() connectapi::Variant$add_subscribers() connectapi::Variant$get_dashboard_url() connectapi::Variant$get_subscribers() connectapi::Variant$get_url() connectapi::Variant$get_url_rev() connectapi::Variant$get_variant() connectapi::Variant$get_variant_remote() connectapi::Variant$job() connectapi::Variant$jobs() connectapi::Variant$remove_subscriber() connectapi::Variant$render() connectapi::Variant$renderings() connectapi::Variant$send_mail() connectapi::Variant$update_variant()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"VariantSchedule — VariantSchedule","text":"VariantSchedule$new() VariantSchedule$GET() VariantSchedule$POST() VariantSchedule$DELETE() VariantSchedule$set_schedule() VariantSchedule$is_empty() VariantSchedule$print() VariantSchedule$get_schedule() VariantSchedule$get_schedule_remote() VariantSchedule$describe_schedule() VariantSchedule$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"VariantSchedule — VariantSchedule","text":"Initialize schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$new(connect, content, key, schedule)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"connect Connect instance. content Content instance. key variant key. schedule schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-","dir":"Reference","previous_headings":"","what":"Method GET()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP GET request named API path. Returns object parsed HTTP response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$GET(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-post-","dir":"Reference","previous_headings":"","what":"Method POST()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP POST request named API path. Returns object parsed HTTP response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$POST(path, body)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path. body HTTP payload.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-delete-","dir":"Reference","previous_headings":"","what":"Method DELETE()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP DELETE request named API path. Returns HTTP response object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$DELETE(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-set-schedule-","dir":"Reference","previous_headings":"","what":"Method set_schedule()","title":"VariantSchedule — VariantSchedule","text":"Set schedule variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$set_schedule(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"... Schedule fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-is-empty-","dir":"Reference","previous_headings":"","what":"Method is_empty()","title":"VariantSchedule — VariantSchedule","text":"Return variant schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$is_empty()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"VariantSchedule — VariantSchedule","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"VariantSchedule — VariantSchedule","text":"Get schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$get_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-schedule-remote-","dir":"Reference","previous_headings":"","what":"Method get_schedule_remote()","title":"VariantSchedule — VariantSchedule","text":"Get store (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$get_schedule_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-describe-schedule-","dir":"Reference","previous_headings":"","what":"Method describe_schedule()","title":"VariantSchedule — VariantSchedule","text":"Description associated schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$describe_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"VariantSchedule — VariantSchedule","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":null,"dir":"Reference","previous_headings":"","what":"VariantTask — VariantTask","title":"VariantTask — VariantTask","text":"VariantTask VariantTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"VariantTask — VariantTask","text":"R6 class represents Variant Task","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"VariantTask — VariantTask","text":"connectapi::Content -> connectapi::Variant -> VariantTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"VariantTask — VariantTask","text":"task task. data variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"VariantTask — VariantTask","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants() connectapi::Variant$add_subscribers() connectapi::Variant$get_dashboard_url() connectapi::Variant$get_schedule() connectapi::Variant$get_schedule_remote() connectapi::Variant$get_subscribers() connectapi::Variant$get_url() connectapi::Variant$get_url_rev() connectapi::Variant$get_variant() connectapi::Variant$get_variant_remote() connectapi::Variant$job() connectapi::Variant$jobs() connectapi::Variant$remove_subscriber() connectapi::Variant$render() connectapi::Variant$renderings() connectapi::Variant$send_mail() connectapi::Variant$update_variant()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"VariantTask — VariantTask","text":"VariantTask$new() VariantTask$get_task() VariantTask$add_data() VariantTask$get_data() VariantTask$print() VariantTask$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"VariantTask — VariantTask","text":"Initialize variant task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$new(connect, content, key, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"connect Connect instance. content Content instance. key variant key. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"VariantTask — VariantTask","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"VariantTask — VariantTask","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"VariantTask — VariantTask","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"VariantTask — VariantTask","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"VariantTask — VariantTask","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"deep Whether make deep clone.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_access_open.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit Access Controls — audit_access_open","text":"","code":"audit_access_open(content, type = \"all\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_access_open.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit Access Controls — audit_access_open","text":"content data.frame content information, get_content() type One \"\" \"logged_in\". \"\", return list apps whose access control set \"Everyone\". \"logged_in\", return list apps whose access control set \"logged users\"","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit R Versions — audit_r_versions","text":"","code":"audit_r_versions(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit R Versions — audit_r_versions","text":"content data.frame content information, get_content()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Audit R Versions — audit_r_versions","text":"plot shows R version used content time aggregate.","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit Run As Settings — audit_runas","text":"","code":"audit_runas(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit Run As Settings — audit_runas","text":"content data.frame content information, get_content()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Audit Run As Settings — audit_runas","text":"data frame app name Run user Run user default","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":null,"dir":"Reference","previous_headings":"","what":"Browse — browse_solo","title":"Browse — browse_solo","text":"Browse different locations Connect via utils::browseURL","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Browse — browse_solo","text":"","code":"browse_solo(content) browse_dashboard(content) browse_api_docs(connect) browse_connect(connect)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Browse — browse_solo","text":"content R6 Content object connect R6 Connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Browse — browse_solo","text":"url opened browser","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a Directory — bundle_dir","title":"Define a bundle from a Directory — bundle_dir","text":"Creates bundle target directory.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a Directory — bundle_dir","text":"","code":"bundle_dir( path = \".\", filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\") )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a Directory — bundle_dir","text":"path path directory bundled filename output bundle path","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a Directory — bundle_dir","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a Directory — bundle_dir","text":"","code":"bundle_dir(system.file(\"tests/testthat/examples/shiny/\", package = \"connectapi\")) #> Error in bundle_dir(system.file(\"tests/testthat/examples/shiny/\", package = \"connectapi\")): fs::dir_exists(path) is not TRUE"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"Define bundle path (path directly tar.gz file)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"","code":"bundle_path(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"path path .tar.gz file","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"","code":"bundle_path(system.file(\"tests/testthat/examples/static.tar.gz\", package = \"connectapi\")) #> Bundling path #> Posit Connect Bundle: #> Path: /home/runner/work/connectapi/connectapi/docs/dev/reference #> Size: 4K #> #> bundle_path(\"/home/runner/work/connectapi/connectapi/docs/dev/reference\") #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a static file (or files) — bundle_static","title":"Define a bundle from a static file (or files) — bundle_static","text":"Defines bundle static files. copies files temporary directory, generates basic manifest file (using first file \"primary\"), bundles directory.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a static file (or files) — bundle_static","text":"","code":"bundle_static( path, filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\") )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a static file (or files) — bundle_static","text":"path path file (files) used static bundle filename output bundle path","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a static file (or files) — bundle_static","text":"Bundle bundle object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Define a bundle from a static file (or files) — bundle_static","text":"NOTE: rsconnect package required function work properly.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a static file (or files) — bundle_static","text":"","code":"bundle_static(system.file(\"logo.png\", package = \"connectapi\")) #> Bundling directory (/tmp/RtmpaNfKfe/bundledir21c84620a3ff) #> Posit Connect Bundle: #> Path: /tmp/RtmpaNfKfe/bundle21c8537992f8.tar.gz #> Size: 23.9K #> #> bundle_path(\"/tmp/RtmpaNfKfe/bundle21c8537992f8.tar.gz\") #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a connection to Posit Connect — connect","title":"Create a connection to Posit Connect — connect","text":"Creates connection Posit Connect using server URL api key. Validates connection checks version server compatible current version package.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a connection to Posit Connect — connect","text":"","code":"connect( server = Sys.getenv(paste0(prefix, \"_SERVER\"), NA_character_), api_key = Sys.getenv(paste0(prefix, \"_API_KEY\"), NA_character_), prefix = \"CONNECT\", ..., .check_is_fatal = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a connection to Posit Connect — connect","text":"server URL accessing Posit Connect. Defaults environment variable CONNECT_SERVER api_key API Key authenticate Posit Connect . Defaults environment variable CONNECT_API_KEY prefix prefix used determine environment variables ... Additional arguments. used present .check_is_fatal Whether fail \"check\" requests fail. Useful rare cases http request customization needed requests succeed.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a connection to Posit Connect — connect","text":"Posit Connect R6 object can passed along methods","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a connection to Posit Connect — connect","text":"","code":"if (FALSE) { # \\dontrun{ connect() } # } # default is to read CONNECT_SERVER and CONNECT_API_KEY environment variables # this example will read TEST_1_SERVER and TEST_1_API_KEY connect(prefix = \"TEST_1\") #> Defining Connect with server: http://localhost:32768 #> Posit Connect API Client: #> Posit Connect Server: http://localhost:32768 #> Posit Connect API Key: ***********gtm8 #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connectapi-package.html","id":null,"dir":"Reference","previous_headings":"","what":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","title":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","text":"Provides helpful 'R6' class methods interacting 'Posit Connect' Server API along meaningful utility functions regular tasks. API documentation varies 'Posit Connect' installation version, latest documentation also hosted publicly https://docs.posit.co/connect/api/. Provides helpful 'R6' class methods interacting 'Posit Connect' Server API along meaningful utility functions regular tasks. API documentation varies 'Posit Connect' installation version, latest documentation also hosted publicly https://docs.posit.co/connect/api/.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connectapi-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","text":"Maintainer: Toph Allen toph@posit.co Authors: Neal Richardson Sean Lopp Cole Arendt cole@posit.co contributors: Posit, PBC [copyright holder, funder]","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete Content — content_delete","title":"Delete Content — content_delete","text":"Delete content item. WARNING: action deletes history, configuration, logs, resources content item. undone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete Content — content_delete","text":"","code":"content_delete(content, force = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete Content — content_delete","text":"content R6 content item force Optional. boolean determines whether prompt interactive sessions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete Content — content_delete","text":"R6 Content item. item deleted, information cached locally","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content Item — content_item","title":"Get Content Item — content_item","text":"Returns single content item based guid","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content Item — content_item","text":"","code":"content_item(connect, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content Item — content_item","text":"connect Connect object guid GUID content item retrieved","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Content Item — content_item","text":"Content object use content endpoints","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Content Item — content_item","text":"","code":"if (FALSE) { # \\dontrun{ connect() %>% content_item(\"some-guid\") %>% content_update_access_type(\"all\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Content List — content_list_by_tag","title":"Content List — content_list_by_tag","text":"Get content list","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content List — content_list_by_tag","text":"","code":"content_list_by_tag(src, tag)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content List — content_list_by_tag","text":"src R6 Connect object tag connect_tag_tree object tag ID","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content List — content_list_by_tag","text":"content_list_by_tag() retrieves content list tag","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content List with Permissions — content_list_with_permissions","title":"Get Content List with Permissions — content_list_with_permissions","text":"functions experimental placeholders API supports behavior.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content List with Permissions — content_list_with_permissions","text":"","code":"content_list_with_permissions(src, ..., .p = NULL) content_list_guid_has_access(content_list, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content List with Permissions — content_list_with_permissions","text":"src Connect R6 object ... Extra arguments. Currently used .p Optional. predicate function, passed -purrr::keep(). See get_content() details. Can greatly help performance reducing many items get permissions content_list \"content list permissions\" returned content_list_with_permissions() guid user group GUID filter content list whether access","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Content List with Permissions — content_list_with_permissions","text":"content_list_with_permissions loops content retrieves permissions item (progress bar). can take long time lots content! Make sure use optional .p argument predicate function filters content list transformed. content_list_guid_has_access works content_list_with_permissions dataset checking whether given GUID (either user group) access content : checking content access_type == \"\" checking content access_type == \"logged_in\" checking provided guid content owner checking provided guid list content permissions (\"permissions\" column)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render a content item. — content_render","title":"Render a content item. — content_render","text":"Submit request render content item. submitted, server runs asynchronous process render content. might useful content needs updated source data changed, especially happen regular schedule. valid rendered content (e.g., Quarto documents, Jupyter notebooks, R Markdown reports).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render a content item. — content_render","text":"","code":"content_render(content, variant_key = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render a content item. — content_render","text":"content content item wish render. variant_key variant key provided, render variant. Otherwise, render default variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render a content item. — content_render","text":"VariantTask object can used track completion render.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render a content item. — content_render","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"951bf3ad-82d0-4bca-bba8-9b27e35c49fa\") task <- content_render(item) poll_task(task) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":null,"dir":"Reference","previous_headings":"","what":"Restart a content item. — content_restart","title":"Restart a content item. — content_restart","text":"Submit request restart content item. submitted, server performs asynchronous request kill processes associated content item, starting new processes needed. might useful application relies data loaded startup, memory usage grown time. Note users interacting certain types applications may workflows interrupted. valid interactive content (e.g., applications, APIs).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Restart a content item. — content_restart","text":"","code":"content_restart(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Restart a content item. — content_restart","text":"content content item wish restart.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Restart a content item. — content_restart","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") content_restart(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content Title — content_title","title":"Get Content Title — content_title","text":"Return content title piece content. content missing (deleted) visible, returns default","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content Title — content_title","text":"","code":"content_title(connect, guid, default = \"Unknown Content\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content Title — content_title","text":"connect Connect object guid GUID content item retrieved default default value returned missing visible content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Content Title — content_title","text":"character. title requested content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":null,"dir":"Reference","previous_headings":"","what":"Update Content — content_update","title":"Update Content — content_update","text":"Update settings content item. list settings, see latest documentation documentation server via connectapi::browse_api_docs().","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update Content — content_update","text":"","code":"content_update(content, ...) content_update_access_type(content, access_type = c(\"all\", \"logged_in\", \"acl\")) content_update_owner(content, owner_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update Content — content_update","text":"content R6 content item ... Settings update passed along Posit Connect access_type One \"\", \"logged_in\", \"acl\" owner_guid GUID user publisher, can become new owner content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update Content — content_update","text":"R6 content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update Content — content_update","text":"Popular selections content_update(access_type=\"\"), content_update(access_type=\"logged_in\") content_update(access_type=\"acl\"), process settings, title, description, etc. content_update_access_type() helper make easier change access_type content_update_owner() helper make easier change owner","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Random Name — create_random_name","title":"Create Random Name — create_random_name","text":"Creates random name LETTERS dataset","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Random Name — create_random_name","text":"","code":"create_random_name(length = 25)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Random Name — create_random_name","text":"length Optional. length random name. Defaults 25","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Random Name — create_random_name","text":"randomly generated name","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a Dashboard URL from a Content Item — dashboard_url","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"Returns URL content dashboard (opened selected pane).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"","code":"dashboard_url(content, pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"content Content Content object pane character pane dashboard link ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"character dashboard URL content provided","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"Returns URL content dashboard (opened selected pane). NOTE: takes character object performance optimization.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"","code":"dashboard_url_chr(connect_url, content_guid, pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"connect_url character base URL Connect server content_guid character guid content item question pane character pane dashboard link ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"character dashboard URL content provided","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a runtime cache — delete_runtime_cache","title":"Delete a runtime cache — delete_runtime_cache","text":"Delete runtime cache Connect server. Requires Administrator privileges.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a runtime cache — delete_runtime_cache","text":"","code":"delete_runtime_cache( client, language, version, image_name = \"Local\", dry_run = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a runtime cache — delete_runtime_cache","text":"client Connect object. language language cache, either \"R\" \"Python\". version version cache, e.g. \"4.3.3\". image_name Optional. name -host execution image cache, \"Local\" (default) native execution caches. dry_run Optional, default FALSE. true, perform dry run deletion.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a runtime cache — delete_runtime_cache","text":"Task object representing deletion task. dry_run TRUE, returns NULL throws error deletion fail.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a runtime cache — delete_runtime_cache","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() task <- delete_runtime_cache(client, \"R\", \"4.3.3\") poll_task(task) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete content item thumbnail — delete_thumbnail","title":"Delete content item thumbnail — delete_thumbnail","text":"Delete thumbnail content item Connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete content item thumbnail — delete_thumbnail","text":"","code":"delete_thumbnail(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete content item thumbnail — delete_thumbnail","text":"content content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete content item thumbnail — delete_thumbnail","text":"content item (invisibly).","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete content item thumbnail — delete_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") thumbnail <- get_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete the Vanity URL — delete_vanity_url","title":"Delete the Vanity URL — delete_vanity_url","text":"Deletes Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete the Vanity URL — delete_vanity_url","text":"","code":"delete_vanity_url(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete the Vanity URL — delete_vanity_url","text":"content Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a bundle — deploy","title":"Deploy a bundle — deploy","text":"Deploys bundle (tarball) Posit Connect server. provided, name (unique identifier) auto-generated alphabetic string. deploying existing endpoint, can set name guid desired content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a bundle — deploy","text":"","code":"deploy( connect, bundle, name = create_random_name(), title = name, guid = NULL, ..., .pre_deploy = { } ) deploy_current(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a bundle — deploy","text":"connect Connect object bundle Bundle object name unique name content server title optional title used content server guid optional GUID content already exists server ... Additional arguments passed along content creation .pre_deploy expression execute deploying new bundle. variables content bundle_id supplied content Content object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy a bundle — deploy","text":"Task task object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Deploy a bundle — deploy","text":"function accepts arguments connectapi::content_update(). deploy_current() helper easily redeploy currently active bundle existing content item.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Deploy a bundle — deploy","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() # beware bundling big directories, like `renv/`, `data/`, etc. bnd <- bundle_dir(\".\") deploy(client, bnd) } # } client <- connect(prefix = \"TEST_1\") #> Defining Connect with server: http://localhost:32768 bnd <- bundle_path(system.file(\"tests/testthat/examples/static.tar.gz\", package = \"connectapi\")) #> Bundling path deploy(client, bnd) #> Getting content endpoint #> #> Uploading bundle #> Warning: 'raw = FALSE' but '/home/runner/work/connectapi/connectapi/docs/dev/reference' is not a regular file #> Warning: cannot open file '/home/runner/work/connectapi/connectapi/docs/dev/reference': it is a directory #> Error in file(body$path, \"rb\"): cannot open the connection"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a Git Repository — deploy_repo","title":"Deploy a Git Repository — deploy_repo","text":"Deploy git repository directly Posit Connect, using Posit Connect's \"pull-based\" \"git-polling\" method deployment.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a Git Repository — deploy_repo","text":"","code":"deploy_repo( client, repository, branch, subdirectory, name = create_random_name(), title = name, ... ) deploy_repo_enable(content, enabled = TRUE) deploy_repo_update(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a Git Repository — deploy_repo","text":"client Connect R6 object repository git repository deploy branch git branch deploy subdirectory subdirectory deploy (must contain manifest.json) name \"name\" / unique identifier content. Defaults random character string title \"title\" content ... Additional options defining / specifying content attributes content R6 Content object (.e. result content_item()) enabled Whether Connect enable automatic polling repository updates","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy a Git Repository — deploy_repo","text":"ContentTask object, use poll_task() (want follow logs)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Deploy a Git Repository — deploy_repo","text":"deploy_repo_enable() enables (disables) Posit Connect's git polling piece content deploy_repo_update() triggers update content git repository, present","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a Bundle from Deployed Connect Content — download_bundle","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"Downloads Content item's active bundle, (optionally) one bundles.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"","code":"download_bundle( content, filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\"), bundle_id = NULL, overwrite = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"content Content object filename Optional. output bundle path bundle_id Optional. string representing bundle_id download. NULL, use currently active bundle. overwrite Optional. Default FALSE. Whether overwrite target location already exists","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":null,"dir":"Reference","previous_headings":"","what":"Manage Environment Variables — get_environment","title":"Manage Environment Variables — get_environment","text":"Manage Environment Variables piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Manage Environment Variables — get_environment","text":"","code":"get_environment(content) set_environment_new(env, ...) set_environment_remove(env, ...) set_environment_all(env, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Manage Environment Variables — get_environment","text":"content R6 Content object returned content_item() env R6 Environment object returned get_environment() ... name = value pairs environment variable names values","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Manage Environment Variables — get_environment","text":"get_environment() returns Environment object use \"setter\" methods set_environment_new() updates environment values (either creating new values updating existing). Set NA value remove variable. set_environment_remove() wrapper set_environment_new() allows removing named / listed variables quickly set_environment_all() sets environment variable values (remove variables specified)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Audit Logs from Posit Connect Server — get_audit_logs","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"Get Audit Logs Posit Connect Server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"","code":"get_audit_logs(src, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"src source object limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"tibble following columns: id: ID audit action time: Timestamp RFC3339 format action taken user_id: User ID actor made audit action user_description: Description actor action: Audit action taken event_description: Description action","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"Please see https://docs.posit.co/connect/api/#getAuditLogs information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get the last 20 audit logs get_audit_logs(client, limit = 20, asc_order = FALSE) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Bundles — get_bundles","title":"Get Bundles — get_bundles","text":"Lists bundles content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Bundles — get_bundles","text":"","code":"get_bundles(content) delete_bundle(content, bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Bundles — get_bundles","text":"content R6 Content item, returned content_item() bundle_id specific bundle ID content item","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information about content on the Posit Connect server — get_content","title":"Get information about content on the Posit Connect server — get_content","text":"Get information content Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information about content on the Posit Connect server — get_content","text":"","code":"get_content(src, guid = NULL, owner_guid = NULL, name = NULL, ..., .p = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get information about content on the Posit Connect server — get_content","text":"src Connect object guid guid particular content item owner_guid unique identifier user owns content name content name specified content created ... Extra arguments. Currently used. .p Optional. predicate function, passed -purrr::keep() turning response tibble. Can useful performance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information about content on the Posit Connect server — get_content","text":"tibble following columns: guid: unique identifier content item. name: simple, URL-friendly identifier. Allows alpha-numeric characters, hyphens (\"-\"), underscores (\"_\"). title: title content. description: rich description content access_type: Access type describes content manages viewers. may value , logged_in acl. value permissive; visitor Posit Connect able view content. value logged_in indicates Posit Connect accounts may view content. acl value lets specifically enumerated users groups view content. Users configured collaborators may always view content. connection_timeout: Maximum number seconds allowed without data sent received across client connection. value 0 means connections never time-(recommended). null, default Scheduler.ConnectionTimeout used. Applies content types executed demand. read_timeout: Maximum number seconds allowed without data received client connection. value 0 means lack client (browser) interaction never causes connection close. null, default Scheduler.ReadTimeout used. Applies content types executed demand. init_timeout: maximum number seconds allowed interactive application start. Posit Connect must able connect newly launched Shiny application, example, threshold elapsed. null, default Scheduler.InitTimeout used. Applies content types executed demand. idle_timeout: maximum number seconds worker process interactive application remain alive goes idle (active connections). null, default Scheduler.IdleTimeout used. Applies content types executed demand. max_processes: Specifies total number concurrent processes allowed single interactive application. null, default Scheduler.MaxProcesses setting used. Applies content types executed demand. min_processes: Specifies minimum number concurrent processes allowed single interactive application. null, default Scheduler.MinProcesses used. Applies content types executed demand. max_conns_per_process: Specifies maximum number client connections allowed individual process. Incoming connections exceed limit routed new process rejected. null, default Scheduler.MaxConnsPerProcess used. Applies content types executed demand. load_factor: Controls aggressively new processes spawned. null, default Scheduler.LoadFactor used. Applies content types executed demand. created_time: timestamp (RFC3339) indicating content created. last_deployed_time: timestamp (RFC3339) indicating content last successful bundle deployment performed. bundle_id: identifier active deployment bundle. Automatically assigned upon successful deployment bundle. app_mode: runtime model content. value unknown data deployed item. Automatically assigned upon first successful bundle deployment. Allowed: api, jupyter-static, python-api, python-bokeh, python-dash, python-streamlit, rmd-shiny, rmd-static, shiny, static, tensorflow-saved-model, unknown. content_category: Describes specialization content runtime model. Automatically assigned upon first successful bundle deployment. parameterized: True R Markdown rendered content allows parameter configuration. Automatically assigned upon first successful bundle deployment. Applies content app_mode rmd-static. r_version: version R interpreter associated content. value null represents R interpreter used content R package environment successfully restored. Automatically assigned upon successful deployment bundle. py_version: version Python interpreter associated content. value null represents Python interpreter used content Python package environment successfully restored. Automatically assigned upon successful deployment bundle. run_as: UNIX user executes content. null, default Applications.RunAs used. Applies executable content types - static. run_as_current_user: Indicates content allowed execute logged-user using PAM authentication. Applies executable content types - static. owner_guid: unique identifier owner content_url: URL associated content. Computed associated vanity URL GUID content. dashboard_url: URL within Connect dashboard content can configured. Computed GUID content. role: relationship accessing user content. value owner returned content owner. editor indicates collaborator. viewer value given users permitted view content. none role returned administrators view content permitted view configuration. Computed time request. id: internal numeric identifier content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get information about content on the Posit Connect server — get_content","text":"Please see https://docs.posit.co/connect/api/#get-/v1/content information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get information about content on the Posit Connect server — get_content","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() get_content(client) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":null,"dir":"Reference","previous_headings":"","what":"Get users within a specific group — get_group_members","title":"Get users within a specific group — get_group_members","text":"Get users within specific group","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get users within a specific group — get_group_members","text":"","code":"get_group_members(src, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get users within a specific group — get_group_members","text":"src source object guid group GUID identifier","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get users within a specific group — get_group_members","text":"tibble following columns: email: user's email username: user's username first_name: user's first name last_name: user's last name user_role: user's role. may value administrator, publisher viewer. created_time: timestamp (RFC3339 format) user created Posit Connect server updated_time: timestamp (RFC3339 format) user last updated Posit Connect server active_time: timestamp (RFC3339 format) user last active Posit Connect server confirmed: false, created user must confirm account email. feature unique password authentication. locked: Whether user locked guid: user's GUID, unique identifier, UUID RFC4122 format","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get users within a specific group — get_group_members","text":"Please see https://docs.posit.co/connect/api/#getGroupMembers information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get users within a specific group — get_group_members","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get the first 20 groups groups <- get_groups(client) group_guid <- groups$guid[1] get_group_members(client, guid = group_guid) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group information from the Posit Connect server — get_groups","title":"Get group information from the Posit Connect server — get_groups","text":"Get group information Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group information from the Posit Connect server — get_groups","text":"","code":"get_groups(src, page_size = 500, prefix = NULL, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group information from the Posit Connect server — get_groups","text":"src source object. page_size number records return per page (max 500). prefix Filters groups prefix (group name). filter case insensitive. limit number groups retrieve paging stops. limit ignored prefix NULL. limit results prefix NULL, change page_size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group information from the Posit Connect server — get_groups","text":"tibble following columns: guid: unique identifier group name: group name owner_guid: group owner's unique identifier. using LDAP Proxied authentication group provisioning enabled property always null.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get group information from the Posit Connect server — get_groups","text":"api request paginated limit paging stops limit relevant using prefix pagination happen thus page-size basically limit using prefix Please see https://docs.posit.co/connect/api/#get-/v1/groups information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get group information from the Posit Connect server — get_groups","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get all groups get_groups(client, limit = Inf) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Content Image — get_image","title":"Get the Content Image — get_image","text":"Please use get_thumbnail, delete_thumbnail, has_thumbnail instead. get_image saves content image given path (default: temp file). delete_image removes image (optionally saving given path) has_image returns whether content image","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Content Image — get_image","text":"","code":"get_image(content, path = NULL) delete_image(content, path = NULL) has_image(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Content Image — get_image","text":"content content object path optional. path image disk","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"Perform OAuth credential exchange obtain viewer's OAuth access token.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"","code":"get_oauth_credentials(connect, user_session_token)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"connect Connect R6 object. user_session_token content viewer's session token. token can obtained content running Connect server. token identifies user viewing content interactively Connect server. Read value HTTP header: Posit-Connect-User-Session-Token","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"OAuth credential exchange response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining--viewer-oauth-access-token information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) library(plumber) client <- connect() #* @get /do function(req) { user_session_token <- req$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN credentials <- get_oauth_credentials(client, user_session_token) # ... do something with `credentials$access_token` ... \"done\" } } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Real-Time Process Data — get_procs","title":"Get Real-Time Process Data — get_procs","text":"returns real-time process data Posit Connect API. requires administrator privileges use. NOTE returns data server responds request (.e. Highly Available cluster)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Real-Time Process Data — get_procs","text":"","code":"get_procs(src)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Real-Time Process Data — get_procs","text":"src source object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Real-Time Process Data — get_procs","text":"tibble following columns: pid: PID current process appId: application ID appGuid: application GUID appName: application name appUrl: application URL appRunAs: application RunAs user type: type process cpuCurrent: current CPU usage cpuTotal: total CPU usage ram: current RAM usage","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":null,"dir":"Reference","previous_headings":"","what":"Get runtime caches — get_runtime_caches","title":"Get runtime caches — get_runtime_caches","text":"View runtime caches Connect server. Requires Administrator privileges.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get runtime caches — get_runtime_caches","text":"","code":"get_runtime_caches(client)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get runtime caches — get_runtime_caches","text":"client Connect object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get runtime caches — get_runtime_caches","text":"tibble runtime caches server, showing language, version image_name. Connect servers using -host execution, image_name \"Local\".","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get runtime caches — get_runtime_caches","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() get_runtime_caches(client) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":null,"dir":"Reference","previous_headings":"","what":"Get available runtimes on server — get_runtimes","title":"Get available runtimes on server — get_runtimes","text":"Get table showing available versions R, Python, Quarto, Tensorflow Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get available runtimes on server — get_runtimes","text":"","code":"get_runtimes(client, runtimes = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get available runtimes on server — get_runtimes","text":"client Connect object. runtimes Optional. character vector runtimes include. Must combination \"r\", \"python\", \"quarto\", \"tensorflow\". Quarto supported Connect >= 2021.08.0, Tensorflow supported Connect >= 2024.03.0.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get available runtimes on server — get_runtimes","text":"tibble columns runtime, version, cluster_name image_name. Cluster name image name meaningful Connect instances running -host execution.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get available runtimes on server — get_runtimes","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() get_runtimes(client, runtimes = c(\"r\", \"python\", \"tensorflow\")) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Get content item thumbnail — get_thumbnail","title":"Get content item thumbnail — get_thumbnail","text":"Download thumbnail content item Connect file computer.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get content item thumbnail — get_thumbnail","text":"","code":"get_thumbnail(content, path = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get content item thumbnail — get_thumbnail","text":"content content item. path Optional. path file used write thumbnail image. path provided, temporary file correct file extension created.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get content item thumbnail — get_thumbnail","text":"path downloaded image file, content thumbnail; otherwise NA.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get content item thumbnail — get_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") thumbnail <- get_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":null,"dir":"Reference","previous_headings":"","what":"Get TimeZones — get_timezones","title":"Get TimeZones — get_timezones","text":"Get available timezones server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get TimeZones — get_timezones","text":"","code":"get_timezones(connect)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get TimeZones — get_timezones","text":"connect R6 Connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get TimeZones — get_timezones","text":"TimeZone vector used setting time zones","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":null,"dir":"Reference","previous_headings":"","what":"Get usage information for deployed shiny applications — get_usage_shiny","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"Get usage information deployed shiny applications","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"","code":"get_usage_shiny( src, content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"src source object content_guid Filter results content GUID min_data_version Filter data version. Records data version lower given value excluded set results. timestamp starts time window interest. usage information ends prior timestamp returned. Individual records may contain starting time end finished. Must class Date POSIX timestamp ends time window interest. usage information starts timestamp returned. Individual records may contain ending time (ending time) start . Must class Date POSIX limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"tibble following columns: content_guid: GUID, RFC4122 format, Shiny application information pertains . user_guid: GUID, RFC4122 format, user visited application. started: timestamp, RFC3339 format, user opened application. ended: timestamp, RFC3339 format, user left application. data_version: data version record recorded . Shiny Application Events section Posit Connect Admin Guide explains interpret data_version values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"Please see https://docs.posit.co/connect/api/#getShinyAppUsage information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() from <- Sys.Date() - lubridate::days(5) get_usage_shiny(client, limit = 20, from = from) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":null,"dir":"Reference","previous_headings":"","what":"Get usage information from deployed static content — get_usage_static","title":"Get usage information from deployed static content — get_usage_static","text":"function retrieves usage information static content Posit Connect server (e.g. Rmarkdown, Jupyter Notebooks)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get usage information from deployed static content — get_usage_static","text":"","code":"get_usage_static( src, content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get usage information from deployed static content — get_usage_static","text":"src source object content_guid Filter results content GUID min_data_version Filter data version. Records data version lower given value excluded set results. timestamp starts time window interest. usage information ends prior timestamp returned. Individual records may contain starting time end finished. Must class Date POSIX timestamp ends time window interest. usage information starts timestamp returned. Individual records may contain ending time (ending time) start . Must class Date POSIX limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get usage information from deployed static content — get_usage_static","text":"tibble following columns: content_guid: GUID, RFC4122 format, Shiny application information pertains . user_guid: GUID, RFC4122 format, user visited application. variant_key: key variant user visited. null static content. time: timestamp, RFC3339 format, user visited content. rendering_id: ID rendering user visited. null static content. bundle_id: ID particular bundle used. data_version: data version record recorded . Rendered Static Content Visit Events section Posit Connect Admin Guide explains interpret data_version values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get usage information from deployed static content — get_usage_static","text":"Please see https://docs.posit.co/connect/api/#getContentVisits information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get usage information from deployed static content — get_usage_static","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() from <- Sys.Date() - lubridate::days(5) get_usage_static(client, limit = 20, from = from) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user information from the Posit Connect server — get_users","title":"Get user information from the Posit Connect server — get_users","text":"Get user information Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user information from the Posit Connect server — get_users","text":"","code":"get_users(src, page_size = 500, prefix = NULL, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user information from the Posit Connect server — get_users","text":"src source object page_size number records return per page (max 500) prefix Filters users prefix (username, first name, last name). filter case insensitive. limit max number records return","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user information from the Posit Connect server — get_users","text":"tibble following columns: email: user's email username: user's username first_name: user's first name last_name: user's last name user_role: user's role. may value administrator, publisher viewer. created_time: timestamp (RFC3339 format) user created Posit Connect server updated_time: timestamp (RFC3339 format) user last updated Posit Connect server active_time: timestamp (RFC3339 format) user last active Posit Connect server confirmed: false, created user must confirm account email. feature unique password authentication. locked: Whether user locked guid: user's GUID, unique identifier, UUID RFC4122 format","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get user information from the Posit Connect server — get_users","text":"Please see https://docs.posit.co/connect/api/#get-/v1/users information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get user information from the Posit Connect server — get_users","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get all users get_users(client, limit = Inf) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Vanity URL — get_vanity_url","title":"Get the Vanity URL — get_vanity_url","text":"Gets Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Vanity URL — get_vanity_url","text":"","code":"get_vanity_url(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Vanity URL — get_vanity_url","text":"content Content object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Vanity URL — get_vanity_url","text":"character string (NULL defined)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a Variant Schedule — get_variant_schedule","title":"Get a Variant Schedule — get_variant_schedule","text":"Gets schedule associated Variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a Variant Schedule — get_variant_schedule","text":"","code":"get_variant_schedule(variant)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a Variant Schedule — get_variant_schedule","text":"variant Variant object, returned get_variant() get_variant_default()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a Variant Schedule — get_variant_schedule","text":"VariantSchedule object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":null,"dir":"Reference","previous_headings":"","what":"Git Repository Helpers — git","title":"Git Repository Helpers — git","text":"functions help use Posit Connect's configured authorization query available branches subdirectories deployment using deploy_repo()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Git Repository Helpers — git","text":"","code":"repo_check_account(client, host) repo_check_branches(client, repository) repo_check_branches_ref(client, repository) repo_check_manifest_dirs(client, repository, branch)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Git Repository Helpers — git","text":"client Connect R6 object host git repository host (schema). example, \"https://github.com\" repository git repository explore consider deploying branch git branch explore subdirectories","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Git Repository Helpers — git","text":"repo_check_account() messages whether account use, returns account repo_check_branches() retrieves branches available, returning named list repo_check_manifest_dirs() retrieves directories contain manifest.json, returning named list","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Remote Group — groups_create_remote","title":"Create a Remote Group — groups_create_remote","text":"Create Remote Group","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Remote Group — groups_create_remote","text":"","code":"groups_create_remote(connect, prefix, expect = 1, check = TRUE, exact = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Remote Group — groups_create_remote","text":"connect R6 Connect object. prefix character. prefix user name search . expect number. Optional. number responses expect search. check boolean. Optional. Whether check local existence first. exact boolean. Optional. Whether create groups whose name exactly matches provided prefix.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Remote Group — groups_create_remote","text":"results creating groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Check content item thumbnail — has_thumbnail","title":"Check content item thumbnail — has_thumbnail","text":"Check whether content item thumbnail.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check content item thumbnail — has_thumbnail","text":"","code":"has_thumbnail(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check content item thumbnail — has_thumbnail","text":"content content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check content item thumbnail — has_thumbnail","text":"TRUE content item thumbnail, otherwise FALSE. Throws error permission view thumbnail.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check content item thumbnail — has_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") has_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Jobs — get_jobs","title":"Get Jobs — get_jobs","text":"Retrieve details jobs associated content_item. \"Jobs\" Posit Connect content executions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Jobs — get_jobs","text":"","code":"get_jobs(content) get_job(content, key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Jobs — get_jobs","text":"content Content object, returned content_item() key key job","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":null,"dir":"Reference","previous_headings":"","what":"Paging — page_cursor","title":"Paging — page_cursor","text":"Helper functions make paging easier Posit Connect Server API. Helper functions make paging easier Posit Connect Server API.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paging — page_cursor","text":"","code":"page_cursor(client, req, limit = Inf) page_offset(client, req, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paging — page_cursor","text":"client Connect client object req request needs paged limit row limit","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Paging — page_cursor","text":"aggregated results requests aggregated results requests","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Content permissions — permissions","title":"Content permissions — permissions","text":"Get set content permissions content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content permissions — permissions","text":"","code":"content_add_user(content, guid, role = c(\"viewer\", \"owner\")) content_add_group(content, guid, role = c(\"viewer\", \"owner\")) content_delete_user(content, guid) content_delete_group(content, guid) get_user_permission(content, guid, add_owner = TRUE) get_my_permission(content, add_owner = TRUE) get_group_permission(content, guid) get_content_permissions(content, add_owner = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content permissions — permissions","text":"content R6 content object guid guid associated either user (content_add_user) group (content_add_group) role role assign user. Either \"viewer\" \"owner.\" Defaults \"viewer\" add_owner Optional. Whether include owner returned permission sets. Default TRUE. owner NA_character_ permission \"id\"","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content permissions — permissions","text":"Permission modification: content_add_* adds permission content content_delete_* removes permission content Permission retrieval: get_content_permissions() lists permissions get_my_permission() gets permission associated caller. get_user_permission() gets permissions associated given user. evaluate group memberships get_group_permission() gets permissions associated given group. NOTE: default, owner injected \"NA_character_\" permission id. makes easier find / isolate record.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::[\\%>\\%][magrittr::\\%>\\%] details.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":null,"dir":"Reference","previous_headings":"","what":"Poll Task — poll_task","title":"Poll Task — poll_task","text":"Polls task, waiting information deployment. task results, output modified \"Task\" object task$get_data() available retrieve results.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Poll Task — poll_task","text":"","code":"poll_task(task, wait = 1, callback = message)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Poll Task — poll_task","text":"task Task object wait interval wait polling callback function called message received. Set NULL callback","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Poll Task — poll_task","text":"Task Task object input","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Poll Task — poll_task","text":"simple way silence messages, set callback = NULL","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":null,"dir":"Reference","previous_headings":"","what":"Promote content from one Connect server to another — promote","title":"Promote content from one Connect server to another — promote","text":"Promote content one Connect server another","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Promote content from one Connect server to another — promote","text":"","code":"promote(from, to, to_key, from_key, name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Promote content from one Connect server to another — promote","text":"url server containing content (originating server) url server content deployed (destination server) to_key API key destination \"\" server. destination content going updated, API key must belong user collaborator access content updated. destination content created new, API key must belong user publisher privileges. from_key API key originating \"\" server. API key must belong user collaborator access content promoted. name name content originating \"\" server. content name found destination server, content updated. content destination server matching name, new endpoint created.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Promote content from one Connect server to another — promote","text":"URL content destination \"\" server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Content Image — set_image_path","title":"Set the Content Image — set_image_path","text":"Please use set_thumbnail instead. Set Content Image using variety methods.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Content Image — set_image_path","text":"","code":"set_image_path(content, path) set_image_url(content, url) set_image_webshot(content, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Content Image — set_image_path","text":"content content object path path image disk url url image ... Additional arguments passed webshot2::webshot()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the Content Image — set_image_path","text":"NOTE: set_image_webshot() requires webshot2::webshot(), currently skips warns content requires authentication webshot2 package supports authentication.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":null,"dir":"Reference","previous_headings":"","what":"Set RunAs User — set_run_as","title":"Set RunAs User — set_run_as","text":"Set RunAs user piece content. run_as_current_user flag anything :","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set RunAs User — set_run_as","text":"","code":"set_run_as(content, run_as, run_as_current_user = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set RunAs User — set_run_as","text":"content R6 Content item run_as RunAs user use content run_as_current_user Whether run content viewer application","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set RunAs User — set_run_as","text":"Content object, updated new details","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set RunAs User — set_run_as","text":"PAM authentication method Applications.RunAsCurrentUser enabled server Also worth noting run_as user must exist Posit Connect server (linux user) appropriate group memberships, get 400: Bad Request. Set NULL use default RunAs user / unset current configuration. \"read\" current RunAs user, use Content object get_content() function.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":null,"dir":"Reference","previous_headings":"","what":"Set a Schedule — set_schedule","title":"Set a Schedule — set_schedule","text":"Sets schedule given Variant. Requires Schedule object (returned get_variant_schedule())","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set a Schedule — set_schedule","text":"","code":"set_schedule(.schedule, ...) set_schedule_minute( .schedule, n = 30, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_hour( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_day( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_weekday( .schedule, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_week( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayofweek( .schedule, days, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_semimonth( .schedule, first = TRUE, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayofmonth( .schedule, n = 1, day = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayweekofmonth( .schedule, n = 1, day = 1, week = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_year( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_remove(.schedule) schedule_describe(.schedule)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set a Schedule — set_schedule","text":".schedule schedule object. returned get_variant_schedule() ... Scheduling parameters n \"number \" iterations start_time start time schedule activate Whether publish output schedule email Whether send emails schedule timezone timezone use setting schedule. Defaults Sys.timezone() days days week (0-6) first logical Whether execute 1st 15th (TRUE) 14th last (FALSE) day day week (0-6) day month (0-31) week week month (0-5) schedule JSON blob (string) describing schedule. See \"Details\"","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set a Schedule — set_schedule","text":"updated Schedule object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set a Schedule — set_schedule","text":"set_schedule() raw interface Posit Connect's schedule API set_schedule_*() functions provide handy wrappers around set_schedule() set_schedule_remove() removes schedule / un-schedules variant Beware, using set_schedule() currently uses Posit Connect schedule API directly, can little clunky. Using set_schedule_*() generally recommended.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Set content item thumbnail — set_thumbnail","title":"Set content item thumbnail — set_thumbnail","text":"Set thumbnail content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set content item thumbnail — set_thumbnail","text":"","code":"set_thumbnail(content, path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set content item thumbnail — set_thumbnail","text":"content content item. path Either path local file URL image available HTTP/HTTPS. path HTTP HTTPS URL, image first downloaded.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set content item thumbnail — set_thumbnail","text":"content item (invisibly).","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set content item thumbnail — set_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") set_thumbnail(item, \"resources/image.png\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Vanity URL — set_vanity_url","title":"Set the Vanity URL — set_vanity_url","text":"Sets Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Vanity URL — set_vanity_url","text":"","code":"set_vanity_url(content, url, force = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Vanity URL — set_vanity_url","text":"content Content object url path component URL force optional. Default FALSE. Whether force-reassign vanity URL already exists","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the Vanity URL — set_vanity_url","text":"updated Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the Vanity URL — set_vanity_url","text":"","code":"if (FALSE) { # \\dontrun{ bnd <- bundle_dir(\"~/my/directory\") connect() %>% deploy(bnd) %>% set_vanity_url(\"a/vanity/url\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Swap the Vanity URL — swap_vanity_url","title":"Swap the Vanity URL — swap_vanity_url","text":"Swaps Vanity URLs two pieces content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Swap the Vanity URL — swap_vanity_url","text":"","code":"swap_vanity_url(from_content, to_content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Swap the Vanity URL — swap_vanity_url","text":"from_content Content object to_content Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all Tags on the server — get_tags","title":"Get all Tags on the server — get_tags","text":"Tag manipulation assignment functions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all Tags on the server — get_tags","text":"","code":"get_tags(src) get_tag_data(src) create_tag(src, name, parent = NULL) create_tag_tree(src, ...) delete_tag(src, tag) get_content_tags(content) set_content_tag_tree(content, ...) set_content_tags(content, ...) filter_tag_tree_id(tags, ids) filter_tag_tree_chr(tags, pattern)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get all Tags on the server — get_tags","text":"src source object name name tag create parent optional. connect_tag_tree object (returned get_tags()) pointed parent tag ... Additional arguments Manage tags (requires Administrator role): get_tags() - returns \"tag tree\" object can traversed tag_tree$tag1$childtag get_tag_data() - returns tibble tag data create_tag() - create tag specifying Parent directly create_tag_tree() - create tag(s) specifying \"desired\" tag tree hierarchy delete_tag() - delete tag (children). WARNING: disassociate content automatically Manage content tags: get_content_tags() - return connect_tag_tree object corresponding tags piece content. set_content_tag_tree() - attach tag content specifying desired tag tree set_content_tags() - Set multiple tags providing connect_tag_tree objects Search tag tree: filter_tag_tree_chr() - filters tag tree based regex filter_tag_tree_id() - filters tag tree based id tag connect_tag_tree object (returned get_tags()) content R6 Content object, returned content_item() tags connect_tag_tree object (returned get_tags()) ids list ids filter tag tree pattern regex filter tag tree (passed grepl)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":null,"dir":"Reference","previous_headings":"","what":"Connect Tibble — tbl_connect","title":"Connect Tibble — tbl_connect","text":"lazy tibble automatically pages API requests collected.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect Tibble — tbl_connect","text":"","code":"tbl_connect( src, from = c(\"users\", \"groups\", \"content\", \"usage_shiny\", \"usage_static\", \"audit_logs\"), ... )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect Tibble — tbl_connect","text":"src source object type tibble ... Additional arguments yet implemented","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Connect Tibble — tbl_connect","text":"tbl_connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":null,"dir":"Reference","previous_headings":"","what":"User — user_guid_from_username","title":"User — user_guid_from_username","text":"Get user details","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"User — user_guid_from_username","text":"","code":"user_guid_from_username(client, username)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"User — user_guid_from_username","text":"client Connect R6 object username user's username","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"User — user_guid_from_username","text":"user_guid_from_username() helper retrieve user GUID, given user's username. useful Shiny applications using session$user","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Remote User — users_create_remote","title":"Create a Remote User — users_create_remote","text":"remote user creation workflow involves authentication providers like LDAP involve queryable identity store. helper wraps API calls necessary retrieve information create user. functions \"fuzzy match\" prefix default, want instantiate users directly, set exact = TRUE.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Remote User — users_create_remote","text":"","code":"users_create_remote(connect, prefix, expect = 1, check = TRUE, exact = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Remote User — users_create_remote","text":"connect R6 Connect object. prefix character. prefix user name search . expect number. Optional. number responses expect search. check boolean. Optional. Whether check local existence first. exact boolean. Optional. Whether create users whose username exactly matches provided prefix.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Remote User — users_create_remote","text":"results creating users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a Remote User — users_create_remote","text":"NOTE: can problems usernames unique. Please open issue run problems.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"","code":"vanity_is_available(connect, vanity)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"connect Connect R6 object vanity string vanity URL check","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"logical indicating vanity URL available.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Variant — get_variants","title":"Get Variant — get_variants","text":"Work variants","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Variant — get_variants","text":"","code":"get_variants(content) get_variant(content, key) get_variant_default(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Variant — get_variants","text":"content R6 Content object. Returned content_item() key Variant key specific variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Variant — get_variants","text":"get_variants() returns tibble variant data content_item get_variant_default() returns default variant content_item get_variant() returns specific variant content_item (specified key)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render a Variant — get_variant_renderings","title":"Render a Variant — get_variant_renderings","text":"Get details renderings (.e. render history) execute variant demand","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render a Variant — get_variant_renderings","text":"","code":"get_variant_renderings(variant) variant_render(variant)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render a Variant — get_variant_renderings","text":"variant R6 Variant object. returned get_variant() get_variant_default()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Render a Variant — get_variant_renderings","text":"get_variant_renderings() returns renderings / content particular variant. Returns tibble variant_render() executes variant demand. Returns VariantTask object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Verify Content Name — verify_content_name","title":"Verify Content Name — verify_content_name","text":"Ensures content name fits specifications / requirements Posit Connect. Throws error content name invalid. Content names (time writing) must 3 64 alphanumeric characters, dashes, underscores","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Verify Content Name — verify_content_name","text":"","code":"verify_content_name(name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Verify Content Name — verify_content_name","text":"name proposed content name","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Verify Content Name — verify_content_name","text":"name (error invalid)","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-030","dir":"Changelog","previous_headings":"","what":"connectapi 0.3.0","title":"connectapi 0.3.0","text":"CRAN release: 2024-09-05","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-changes-0-3-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"connectapi 0.3.0","text":"GET_URL(), GET_RESULT(), GET_RESULT_URL() eliminated favor GET() (#274). .empty_object argument removed PUT/PATCH/POST (#274).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"new-features-0-3-0","dir":"Changelog","previous_headings":"","what":"New features","title":"connectapi 0.3.0","text":"New content_render() content_restart() functions. content_render() allows programmatically re-render content Quarto R Markdown reports Jupyter notebooks, optionally passing variant_key render specific variant parameterized content. content_restart() lets restart interactive content, Shiny applications, APIs, dashboards (#283, #289) New get_oauth_credentials() function interacting Connect’s /v1/oauth/integrations/credentials endpoint. endpoint allows content running Posit Connect obtain content viewer’s OAuth access token (#297).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"minor-improvements-and-fixes-0-3-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"connectapi 0.3.0","text":"Timestamps non-zero offsets received Connect longer parse NA (#290). Timestamps sent Connect now correctly converted UTC, instead simply labeled GMT (#291). Functions render variants email reports now contain request query Connect expects (#277). HTTP verb functions can take URL, just one relative API root, can optionally return httr_response object (#274).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-020","dir":"Changelog","previous_headings":"","what":"connectapi 0.2.0","title":"connectapi 0.2.0","text":"CRAN release: 2024-06-06","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-changes-0-2-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"connectapi 0.2.0","text":"previously deprecated functions now removed. functions Connect$download_bundle() Connect$bundle_delete() removed. Use Content$bundle_download() Content$bundle_delete() instead. audit_vanity_urls() removed. check vanity URL use, use vanity_is_available() instead. audit_* functions modified accept result get_content() rather cache_apps() (now removed). faster result. dplyr longer required dependency. use tbl_connect(), need install dplyr dbplyr explicitly. (#246)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"enhancements-and-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"Enhancements and fixes","title":"connectapi 0.2.0","text":"package now tested many versions Connect, back 1.8.8.2 (May 2021). now fewer warnings version mismatches: see warning Connect server older . (#244) Now correctly provides methods tbl_connect, rather tbl_lazy, preventing problems also using dplyr (#177). progress now optional dependency. show pretty progress bars, install package explicitly. (#269) Content$tag_delete() removes tag target content item rather removing tag entirely. (#194) audit_r_versions() returns bar chart instead histogram (#179) Fix issue NULL length 1 job outputs (#193) Timestamp parsing now correctly preserves time components (#259)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0131","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.3.1","title":"connectapi 0.1.3.1","text":"CRAN release: 2023-02-02 Fix generated documentation HTML CRAN submission","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-013","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.3","title":"connectapi 0.1.3","text":"RStudioConnect documentation now PositConnect Fix purrr deprecated changes","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-012","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.2","title":"connectapi 0.1.2","text":"CRAN release: 2022-09-30 Update docs illustrate customizing HTTP requests (#168) Fix issue HTML documentation retain CRAN (#164) Fix typo min_data_version parameter usage data functions (#166) Bump Connect tested version 2022.09.0 (#170)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0111","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.1.1","title":"connectapi 0.1.1.1","text":"CRAN release: 2022-07-21","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-0-1-1-1","dir":"Changelog","previous_headings":"","what":"BREAKING","title":"connectapi 0.1.1.1","text":"set_vanity_url(), get_vanity_url(), swap_vanity_url() get_tags(), get_tag_data(), get_content_tags(), create_tag(), create_tag_tree(), delete_tag(), get_content_tags(), set_content_tags(), set_content_tag_tree(), filter_tag_tree_id(), filter_tag_tree_chr(), set_environment_new(), get_environment(), set_environment_remove(), download_bundle() tag ids now character strings (integers) instead integers true connect() function, although warn argument deprecation case. (#125) BREAKING: set_environment_new() set_environment_remove() longer take .version argument, output data structure bit different (list names). now use public API, changes interface bit. Also, intricacies set / remove environment variables changed (.e. setting VAR=NA remove VAR). (#141) get_vanity_url() now returns character string representing vanity url use (NULL defined) set_vanity_url() still returns Vanity R6 object, vanity$get_vanity()$path_prefix now vanity$get_vanity()$path BREAKING: tag_page() tag_page_iframe() removed. Similar functions belong connectwidgets package future. .e. bundle_id become id response data. others, url become content_url. R6 method content$get_bundles() longer takes page_number argument, get_bundles(limit) argument now deprecated (#129) Connect$download_bundle now deprecated favor Content$bundle_download(), delete_bundle() now takes Content item instead Connect. (#153) BREAKING: acl_*() functions deprecated favor get_content_permissions(), content_add_user(), friends. BREAKING: Connect$PUT(), Connect$POST() Connect$PATCH() endpoints now presume empty list really “map”/“object” (like {} instead []). can break endpoints expect list. Set .empty_object=FALSE avoid behavior.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"other-changes-0-1-1-1","dir":"Changelog","previous_headings":"","what":"Other Changes","title":"connectapi 0.1.1.1","text":"users_create_remote() gains exact argument simplify complex cases (#135). Long term, solicit feedback whether function attempts much. Add helpers common content modification actions: content_update(), content_update_access_type() content_update_owner() Fix issue relative paths bundle_dir() (@slodge) (#118, #121) Add overwrite= parameter download_bundle() Add HTTP request customization options, related documentation (#101) Add git deployment (#112) R6 support multiple inheritance, keep Task interface --date ContentTask VariantTask manually Improve several print methods (#18, #19) Protect bad bundles (#13) Error empty API key defined (#16) content_list_with_permissions returns content_list “permission” column includes access content_list_by_tag allows fetching just content_list particular tag content_list_guid_has_access filters “content list permission” whether user group GUID access Add user_guid_from_username() function convert session$user usernames user GUID (#130)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0109018","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0.9018","title":"connectapi 0.1.0.9018","text":"Add client$PATCH verb Switch Content$update() use PATCH (depends RStudio Connect 1.8.6+) Add error messaging new API endpoints using older versions Connect Fail gracefully /protocol http/https defined","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0109017","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0.9017","title":"connectapi 0.1.0.9017","text":"BREAKING: * Switch RSTUDIO_CONNECT_* variables CONNECT_* variables * Rename handful functions: - connect$activate_bundle connect$content_deploy - connect$create_app connect$content_create - connect$upload_bundle connect$content_upload - connect$get_users connect$users * Change return types consistent API - connect$content_upload returns response instead bundle_id - connect$content_deploy returns response instead task_id * Switch endpoints using app_id guid * get_task$start renamed get_task$first * promote$app_name renamed promote$name * rename package connectapi * change functions take Connect object instead server / api key - cache_apps - tag_page : * Add endpoints: - content - audit_logs - server_settings - server_settings_r - inst_shiny_usage - inst_content_visits * Add helper functions: - swap_vanity_url, deployment functions - browse_ family functions - users_create_remote groups_create_remote remote users/groups * Update Connect R6 object compatible Connect 1.7.0+ APIs * Added NEWS.md file track changes package. * Add integration testing protect regressions * Add tbl_connect() lazy_tbl querying Connect API endpoints * Add get_* functions alternatives lazy_tbl","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-010","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0","title":"connectapi 0.1.0","text":"Initial package version Create Connect R6 object","code":""}] +[{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.0, available https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. Community Impact Guidelines inspired Mozilla’s code conduct enforcement ladder. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to connectapi","title":"Contributing to connectapi","text":"outlines propose change connectapi. detailed info contributing , tidyverse packages, please see development contributing guide.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"testing","dir":"","previous_headings":"","what":"Testing","title":"Contributing to connectapi","text":"two test suites package. One contains unit tests tests use API mocks, can run without access running Connect server. Run R test suite devtools::test(). second suite runs integration tests live Connect server running locally Docker. additional requirements. need valid Connect license key file. Put contents license key, path license file, RSC_LICENSE environment variable. need Docker. ’re running ARM (non-Intel) Mac, export DOCKER_DEFAULT_PLATFORM=linux/amd64 Run connectapi:::build_test_env() set Connect processes docker default, run contemporary version Connect. test older version, set environment variable CONNECT_VERSION something else run build_test_env(). Set CONNECTAPI_INTEGRATED=true environment enable running integration tests (’re skipped default). Run source(\"tests/test-integrated.R\")","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to connectapi","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to connectapi","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to connectapi","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"rstudio/connectapi\", fork = TRUE). Install development dependencies devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to connectapi","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to connectapi","text":"Please note connectapi project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 Posit Software, PBC Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"intent","dir":"","previous_headings":"","what":"Intent","title":"NA","text":"Describe problem pull request resolves, new feature introduces. Link related GitHub issues, applicable Fixes #","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"approach","dir":"","previous_headings":"","what":"Approach","title":"NA","text":"Explain solved problem tradeoffs. applicable: - Include guidance reviewers (rewrites …, start …, commit--commit, etc.). - Link notes discussions work. - relevant information tests, automated manual.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/PULL_REQUEST_TEMPLATE.html","id":"checklist","dir":"","previous_headings":"","what":"Checklist","title":"NA","text":"change update NEWS.md (referencing connected issue necessary)? change need documentation? run devtools::document()?","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":null,"dir":"","previous_headings":"","what":"Development and Release Notes","title":"Development and Release Notes","text":"release process goes CRAN. Details release prepared need formalized documented. interested contributing, please read CONTRIBUTING.md","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":"build-pipeline","dir":"","previous_headings":"","what":"Build Pipeline","title":"Development and Release Notes","text":"use GitHub Actions build process. Files can seen ./workflows directory. modify examples r-lib/actions repository purposes follows: Generally copy examples -, leave names workflows folder consistent history R-CMD-check analogue check-full, without devel R. approximates CRAN submission test-coverage.yaml pkgdown.yaml lines added set appropriate environment variables “integration tests” run Connect order evaluate package (product) thoroughly Similarly integration-tests.yaml, analogous R-CMD-check integration tests ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/RELEASE.html","id":"integration-tests","dir":"","previous_headings":"Build Pipeline","what":"Integration Tests","title":"Development and Release Notes","text":"Integration tests designed run connectapi package actual latest version Connect “test environment” stands two Connect instances docker images using un-exported build_test_env() function uses docker compose build environment also use “hacky” utilities build initial user API key executing file able executed independently (know, terrible… made choices reasons) fudge clean line unit tests order ensure complex functionalities work expected without much time work bootstrapping “integration test” execution happens test-integrated.R script, keys mostly CONNECTAPI_INTEGRATED=true environment variable run integration tests interactively / locally run following:","code":"connectapi:::build_test_env() readRenviron(\".Renviron\") # or set this in .Renviron yourself Sys.setenv(\"CONNECTAPI_INTEGRATED\"=\"true\") # or run R CMD CHECK with that env var set, etc. source(\"tests/test-integrated.R\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with connectapi","title":"Getting help with connectapi","text":"Thanks using connectapi! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with connectapi","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with connectapi","text":"Armed reprex, next step figure ask. ’s question: start forum.posit.co, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with connectapi","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"connectapi Tags","text":"understand tags work connectapi, must first understand tags RStudio Connect. Tags RStudio Connect consist multiple “tag trees,” “Category” parent. tag hierarchy / structure created administrators Publishers administrators can associate non-Category tag content tag member “child” tag doe automatically make member “parent” tag always, get started defining CONNECT_SERVER CONNECT_API_KEY variables, initialize API client. NOTE: example report create tag hierarchies use . result, use example verbatim requires admin privileges create tags server.","code":"library(connectapi) client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"create-the-tag-trees","dir":"Articles","previous_headings":"","what":"Create the Tag Tree(s)","title":"connectapi Tags","text":"get started, create tag tree show things work. create_tag() helper allows create singular tag (specifying parent, etc.). purposes, create_tag_tree() easier, since creates entire tree specified .","code":"start_tags <- get_tags(client) start_tags ## Posit Connect Tag Tree ## < No tags > tree_project_1 <- create_tag_tree(client, \"DemoProject\", \"project_1\") ## Posit Connect Tag Tree (filtered) ## └── DemoProject ## └── project_1 tree_project_1 ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********6eAV tmp_tags <- get_tags(client) tree_project_2 <- create_tag(client, name = \"project_2\", parent = tmp_tags$DemoProject) ## Posit Connect Tag Tree (filtered) ## └── DemoProject ## └── project_2 tree_project_2 ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********6eAV tree_audience_1 <- create_tag_tree(client, \"DemoAudience\", \"Sales\") ## Posit Connect Tag Tree (filtered) ## └── DemoAudience ## └── Sales tree_audience_2 <- create_tag_tree(client, \"DemoAudience\", \"Finance\") ## Posit Connect Tag Tree (filtered) ## └── DemoAudience ## └── Finance get_tags(client) ## Posit Connect Tag Tree ## ├── DemoProject ## │ ├── project_1 ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"content-tags","dir":"Articles","previous_headings":"","what":"Content tags","title":"connectapi Tags","text":"order show tags work, need content work .","code":"bnd <- bundle_static(system.file(\"logo.png\", package = \"connectapi\")) ## Bundling directory (/tmp/RtmpddGLxx/bundledir26f1546c8d33) content_1 <- deploy(client, bnd) ## Getting content endpoint ## Found EXISTING content 66b778b6-b6c0-4702-98b2-5dee2a5d568c with name mwlefoodfieexombwkkeulbfd on http://localhost:32768 ## Uploading bundle ## Deploying bundle content_2 <- deploy(client, bnd) ## Getting content endpoint ## ## Uploading bundle ## Deploying bundle"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"set-tags","dir":"Articles","previous_headings":"Content tags","what":"Set Tags","title":"connectapi Tags","text":"Content 1 project_1 Sales, let’s set tags! ways . Content 2 project_2 Audiences (Sales Finance).","code":"all_tags <- get_tags(client) set_content_tag_tree(content_1, \"DemoProject\", \"project_1\") ## Posit Connect Tag Tree (content) ## └── DemoProject ## └── project_1 ## Posit Connect Content Task: ## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c ## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ ## Task ID: iqNUaKRBDzu9Ng6M set_content_tags(content_1, all_tags$DemoAudience$Sales) ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_1 ## └── DemoAudience ## └── Sales ## Posit Connect Content Task: ## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c ## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ ## Task ID: iqNUaKRBDzu9Ng6M set_content_tags( content_2, all_tags$DemoProject$project_2, all_tags$DemoAudience$Sales, all_tags$DemoAudience$Finance ) ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance ## Posit Connect Content Task: ## Content GUID: 1b3a4597-98b5-467a-b638-df39e2ef5efc ## URL: http://localhost:32768/connect/#/apps/1b3a4597-98b5-467a-b638-df39e2ef5efc/ ## Task ID: OyyrKns5nDAYPsRQ"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"see-the-tags-associated-with-content","dir":"Articles","previous_headings":"Content tags","what":"See the tags associated with content","title":"connectapi Tags","text":"order see tags associated content, use get_content_tags(). data structure get_tags(), “whole list” filtered tags associated piece content.","code":"c1_tags <- get_content_tags(content_1) c1_tags ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_1 ## └── DemoAudience ## └── Sales c2_tags <- get_content_tags(content_2) c2_tags ## Posit Connect Tag Tree (content) ## ├── DemoProject ## │ └── project_2 ## └── DemoAudience ## ├── Sales ## └── Finance"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"list-all-content-associated-with-a-tag","dir":"Articles","previous_headings":"","what":"List all content associated with a tag","title":"connectapi Tags","text":"tags defined, can also search content associated tag.","code":"content_list_by_tag(client, all_tags$DemoAudience$Sales) ## # A tibble: 2 × 44 ## guid name title description access_type connection_timeout read_timeout ## ## 1 1b3a4597-… pbcy… pbcy… \"\" acl NA NA ## 2 66b778b6-… mwle… mwle… \"\" acl NA NA ## # ℹ 37 more variables: init_timeout , idle_timeout , ## # max_processes , min_processes , max_conns_per_process , ## # load_factor , memory_request , memory_limit , ## # cpu_request , cpu_limit , amd_gpu_limit , ## # nvidia_gpu_limit , service_account_name , ## # default_image_name , created_time , last_deployed_time , ## # bundle_id , app_mode , content_category , … content_list_by_tag(client, all_tags$DemoProject$project_1) ## # A tibble: 1 × 44 ## guid name title description access_type connection_timeout read_timeout ## ## 1 66b778b6-… mwle… mwle… \"\" acl NA NA ## # ℹ 37 more variables: init_timeout , idle_timeout , ## # max_processes , min_processes , max_conns_per_process , ## # load_factor , memory_request , memory_limit , ## # cpu_request , cpu_limit , amd_gpu_limit , ## # nvidia_gpu_limit , service_account_name , ## # default_image_name , created_time , last_deployed_time , ## # bundle_id , app_mode , content_category , … content_list_by_tag(client, all_tags$DemoProject) ## # A tibble: 0 × 32 ## # ℹ 32 variables: guid , name , title , description , ## # access_type , connection_timeout , read_timeout , ## # init_timeout , idle_timeout , max_processes , ## # min_processes , max_conns_per_process , load_factor , ## # created_time , last_deployed_time , bundle_id , ## # app_mode , content_category , parameterized , ## # cluster_name , image_name , r_version , py_version , …"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/connectapi_tags.html","id":"cleanup","dir":"Articles","previous_headings":"","what":"Cleanup","title":"connectapi Tags","text":"Now clean demo tags created.","code":"# Protect against tags already existing if (\"DemoProject\" %in% names(start_tags) || \"DemoAudience\" %in% names(start_tags)) { stop(\"ERROR: One of the demo tags already exist for you! Beware lest they be deleted by this demo\") } latest_tags <- get_tags(client) delete_tag(client, latest_tags$DemoProject) ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********6eAV delete_tag(client, latest_tags$DemoAudience) ## Posit Connect API Client: ## Posit Connect Server: http://localhost:32768 ## Posit Connect API Key: ***********6eAV # TODO: delete content"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"Content Permissions","text":"filter content permissions, first need “baseline set content.” content server, content particular tag, etc. NOTE: performance depend heavily size baseline set content, permissions API today requires enumeration. improve performance large sets content, can use pins caching disk reduce often requests must re-executed. start deploying pieces test content, two test users, set access controls, tags:","code":"bnd <- bundle_static(system.file(\"logo.png\", package = \"connectapi\")) ## Bundling directory (/tmp/RtmpWt5hWA/bundledir272a766037be) content_1 <- deploy(client, bnd, title = \"App 1\") ## Getting content endpoint ## Found EXISTING content 66b778b6-b6c0-4702-98b2-5dee2a5d568c with name mwlefoodfieexombwkkeulbfd on http://localhost:32768 ## Uploading bundle ## Deploying bundle content_2 <- deploy(client, bnd, title = \"App 2\") ## Getting content endpoint ## Found EXISTING content 1b3a4597-98b5-467a-b638-df39e2ef5efc with name pbcyvkgufivjubqtxvafbsnay on http://localhost:32768 ## Uploading bundle ## Deploying bundle user_restricted <- client$users_create(\"example_restricted\", \"restricted@example.com\", password = create_random_name()) user_all <- client$users_create(\"example_all\", \"all@example.com\", password = create_random_name()) invisible(create_tag_tree(client, \"Example\", \"Permissions\")) ## Posit Connect Tag Tree (filtered) ## └── Example ## └── Permissions tags <- get_tags(client) tag_1 <- tags$Example$Permissions set_content_tags(content_1, tag_1) ## Posit Connect Tag Tree (content) ## └── Example ## └── Permissions ## Posit Connect Content Task: ## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c ## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ ## Task ID: I6EfNRyMfv6MvEXz set_content_tags(content_2, tag_1) ## Posit Connect Tag Tree (content) ## └── Example ## └── Permissions ## Posit Connect Content Task: ## Content GUID: 1b3a4597-98b5-467a-b638-df39e2ef5efc ## URL: http://localhost:32768/connect/#/apps/1b3a4597-98b5-467a-b638-df39e2ef5efc/ ## Task ID: Gr8JYfZhqgFpPa4e content_add_user(content_1, user_restricted$guid, role = \"viewer\") ## Adding permission for user '3e623a69-ab85-40e5-a837-47ce755f20c1' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c ## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ ## Task ID: I6EfNRyMfv6MvEXz content_add_user(content_1, user_all$guid, \"viewer\") ## Adding permission for user '5c653fc8-3fcb-4bd6-a2c6-3382554e7769' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: 66b778b6-b6c0-4702-98b2-5dee2a5d568c ## URL: http://localhost:32768/connect/#/apps/66b778b6-b6c0-4702-98b2-5dee2a5d568c/ ## Task ID: I6EfNRyMfv6MvEXz content_add_user(content_2, user_all$guid, \"viewer\") ## Adding permission for user '5c653fc8-3fcb-4bd6-a2c6-3382554e7769' with role 'viewer' ## Posit Connect Content Task: ## Content GUID: 1b3a4597-98b5-467a-b638-df39e2ef5efc ## URL: http://localhost:32768/connect/#/apps/1b3a4597-98b5-467a-b638-df39e2ef5efc/ ## Task ID: Gr8JYfZhqgFpPa4e"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"retrieve-the-content-list","dir":"Articles","previous_headings":"","what":"Retrieve the Content List","title":"Content Permissions","text":"content_list_with_permissions() function core want. However, defaults return content server. servers, expensive (can take 30 minutes ). Instead, recommend using .p argument define “predicate” function (style purrr::keep()) determines records keep. Since predicate access “content list” , retrieve list Content GUIDs first.","code":"my_tag_content <- content_list_by_tag(client, tag_1) content_guids <- my_tag_content$guid c_with_p <- content_list_with_permissions(client, .p = ~ .x$guid %in% content_guids) ## Getting content list ## Getting permission list # another approach, with a function c_with_p <- content_list_with_permissions(client, .p = function(.x) { .x$guid %in% content_guids }) ## Getting content list ## Getting permission list # notice the \"permission\" column: c_with_p$permission ## [[1]] ## # A tibble: 2 × 5 ## id content_guid principal_guid principal_type role ## ## 1 3 1b3a4597-98b5-467a-b638-df39e2ef5efc 5c653fc8-3fcb… user view… ## 2 NA 1b3a4597-98b5-467a-b638-df39e2ef5efc 0a3e5921-6742… user owner ## ## [[2]] ## # A tibble: 3 × 5 ## id content_guid principal_guid principal_type role ## ## 1 1 66b778b6-b6c0-4702-98b2-5dee2a5d568c 3e623a69-ab85… user view… ## 2 2 66b778b6-b6c0-4702-98b2-5dee2a5d568c 5c653fc8-3fcb… user view… ## 3 NA 66b778b6-b6c0-4702-98b2-5dee2a5d568c 0a3e5921-6742… user owner"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"filter-the-content-list","dir":"Articles","previous_headings":"","what":"Filter the Content List","title":"Content Permissions","text":"added helper function package filter content list : content_list_guid_has_access() Shiny application personalized context (.e. using session$user), filter content list user see (using permissions column returned )","code":"# restricted has access content_list_guid_has_access(c_with_p, user_restricted$guid) %>% .$title ## [1] \"mwlefoodfieexombwkkeulbfd\" # \"all\" has access content_list_guid_has_access(c_with_p, user_all$guid) %>% .$title ## [1] \"pbcyvkgufivjubqtxvafbsnay\" \"mwlefoodfieexombwkkeulbfd\""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/content_permissions.html","id":"display-the-content-list","dir":"Articles","previous_headings":"","what":"Display the Content List","title":"Content Permissions","text":"plan build full example Shiny (show example code ). However, suffice say RStudio Connect version 1.9.0 newer, connectwidgets great way plan display data, provides several helpers !","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"getting-started","dir":"Articles","previous_headings":"","what":"Getting Started","title":"Customize HTTP Requests","text":"initialize connectapi API client, implicitly create httr HTTP client. httr package allows configure HTTP requests globally using httr::set_config() scoped variant httr::with_config. walk examples .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"custom-ca-bundle","dir":"Articles","previous_headings":"Getting Started","what":"Custom CA Bundle","title":"Customize HTTP Requests","text":"","code":"library(httr) library(connectapi) client <- connect() # notice that TLS verification fails get_users(client) # use a custom Certificate Authority to verify SSL/TLS requests httr::set_config(httr::config(cainfo = \"/path/to/my.pem\")) # now it should succeed! get_users(client)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"turn-off-certificate-trust-verification---only-for-testing","dir":"Articles","previous_headings":"Getting Started","what":"Turn Off Certificate Trust Verification - ONLY FOR TESTING","title":"Customize HTTP Requests","text":"Sometimes first setting server, common use self-signed certificates. generally bad reliable communication security (reason computer trust server “self-declared” trustworthy actor). However, can useful organization’s Certificate Authority (CA) process issuing valid certificate, certificate procured public CA. can also scoped fashion:","code":"# disabling certificate trust (can allow man-in-the-middle attacks, etc.) httr::set_config(httr::config(ssl_verifypeer = 0, ssl_verifyhost = 0)) # should work client <- connect() get_users(client) httr::with_config( httr::config(ssl_verifypeer = 0, ssl_verifyhost = 0), { client <- connect() get_users(client) } )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"custom-headers-cookies-proxy-etc-","dir":"Articles","previous_headings":"Getting Started","what":"Custom Headers, Cookies, Proxy, etc.","title":"Customize HTTP Requests","text":"httr helpers common tasks like httr::add_headers(), httr::set_cookies(), httr::use_proxy(), etc. Using bit tricky, can done way client$httr_config() function. Pass usual httr arguments client$httr_config(), arguments saved passed subsequent GET, PUT, POST, PATCH, HEAD, DELETE requests send client. NOTE: values completely overwritten time call client$httr_config(), ensure pass desired values time","code":"# for instance, to set custom headers (i.e. to get through a proxy) client$httr_config(httr::add_headers(MY_MAGIC_HEADER = \"value\")) # or to clear sticky cookies if you want to switch nodes in an HA cluster client <- connect() client$server_settings()$hostname client$httr_config(handle = httr::handle(\"\")) # now you have a chance to get a new host client$server_settings()$hostname # use an outbound proxy client$httr_config(httr::use_proxy(\"http://myproxy.example.com\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/customize-http.html","id":"using-kerberos","dir":"Articles","previous_headings":"Getting Started","what":"Using Kerberos","title":"Customize HTTP Requests","text":"Suffice say effectively using Kerberos HTTP bit advanced topic. However, possible httr. worth noting today, interferes API key authentication, hoping improve future release Posit Connect.","code":"# disables authentication header that is included by default client$using_auth <- FALSE # use Kerberos authentication mechanism (requires local credential cache) client$httr_config(httr::authenticate(\":\", \"\", type = \"gssnegotiate\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/getting-started.html","id":"connecting","dir":"Articles","previous_headings":"","what":"Connecting","title":"Getting Started with connectapi","text":"first thing need accomplish using connectapi getting connected Posit Connect server. requires URL server API key. Directions get API key . API key, can create Connect object code, like : alternative define .Renviron file, specifies environment variables: , can used code:","code":"library(connectapi) client <- connect( server = \"http://example.com:3939\", api_key = \"aihgaahegiahgg\" ) CONNECT_SERVER=http://example.com:3939 CONNECT_API_KEY=aihgaahegiahgg library(connectapi) # this happens by default if you restart your R session readRenviron(\".Renviron\") client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/articles/getting-started.html","id":"content-management","dir":"Articles","previous_headings":"","what":"Content Management","title":"Getting Started with connectapi","text":"connectapi package tools help programmatically deploy manage content. get started, need use rsconnect package, specifically rsconnect::writeManifest() function, build manifest.json file directory content want deploy. manifest.json file present, can reference directory deploy directly: content object (content_1) includes information deployment just requested. can explored : Alternatively, can immediately begin altering settings content object wait deployment complete: content already exists want update , can using content GUID (can find within Posit Connect Info pane). can also use Posit Connect content GUID retrieve information existing content (want examine change settings)","code":"bnd <- bundle_dir(\"./my/directory\") # name must be unique on the server # if you do not specify it, a random value will be provided content_1 <- client %>% deploy(bnd, name = \"my-content\", title = \"Amazing Report!!\") content_1 %>% poll_task() content_1 %>% set_thumbnail(\"https://gph.is/29vyb0s\") %>% set_vanity_url(\"/my_clever_content\") # ensure the vanity URL is set as expected content_1 %>% get_vanity_url() content_2 <- client %>% deploy(bnd, guid = \"d78ba9f8-bb57-422e-b164-9ecd8e4c4fd6\") %>% poll_task() content_3 <- client %>% content_item(guid = \"96532fbc-725e-441b-9cc6-a5622535241b\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Toph Allen. Author, maintainer. Neal Richardson. Author. Sean Lopp. Author. Cole Arendt. Author. Posit, PBC. Copyright holder, funder.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Allen T, Richardson N, Lopp S, Arendt C (2024). connectapi: Utilities Interacting 'Posit Connect' Server API. R package version 0.3.0.9000, https://github.com/rstudio/connectapi, https://pkgs.rstudio.com/connectapi/.","code":"@Manual{, title = {connectapi: Utilities for Interacting with the 'Posit Connect' Server API}, author = {Toph Allen and Neal Richardson and Sean Lopp and Cole Arendt}, year = {2024}, note = {R package version 0.3.0.9000, https://github.com/rstudio/connectapi}, url = {https://pkgs.rstudio.com/connectapi/}, }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"connectapi-","dir":"","previous_headings":"","what":"Utilities for Interacting with the Posit Connect Server API","title":"Utilities for Interacting with the Posit Connect Server API","text":"package provides R client Posit Connect Server API, well helpful functions utilize client. designed work supported versions Connect, though features may available newer versions.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Utilities for Interacting with the Posit Connect Server API","text":"install CRAN: install development version:","code":"install.packages(\"connectapi\") remotes::install_github('rstudio/connectapi')"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"client","dir":"","previous_headings":"","what":"Client","title":"Utilities for Interacting with the Posit Connect Server API","text":"create client: can also define following environment variables (.Renviron file, instance): environment variable values used automatically defined R session.","code":"library(connectapi) client <- connect( server = \"https://connect.example.com\", api_key = \"\" ) CONNECT_SERVER = https://connect.example.com CONNECT_API_KEY = my-secret-api-key library(connectapi) client <- connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting Started","title":"Utilities for Interacting with the Posit Connect Server API","text":"client defined, can use interact Posit Connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"exploring-data","dir":"","previous_headings":"Getting Started","what":"Exploring Data","title":"Utilities for Interacting with the Posit Connect Server API","text":"can use get_ methods retrieve data Posit Connect server.","code":"library(connectapi) client <- connect() # get data users <- get_users(client) groups <- get_groups(client) usage_shiny <- get_usage_shiny(client) usage_static <- get_usage_static(client) some_content <- get_content(client) # get all content all_content <- get_content(client, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"deployment","dir":"","previous_headings":"Getting Started","what":"Deployment","title":"Utilities for Interacting with the Posit Connect Server API","text":"rsconnect package usually used deploying content Connect. However, want use programmatic deployment Posit Connect Server API, connectapi helpers useful!","code":"library(connectapi) client <- connect() # deploying content # NOTE: a `manifest.json` should already exist from `rsconnect::writeManifest()` bundle <- bundle_dir(\"./path/to/directory\") content <- client %>% deploy(bundle, name = \"my-app-name\") %>% poll_task() # set an image for content content %>% set_thumbnail(\"./my/local/image.png\") content %>% set_thumbnail(\"http://url.example.com/image.png\") # set image and a vanity URL content %>% set_thumbnail(\"./my/local/image.png\") %>% set_vanity_url(\"/my-awesome-app\") # change access_type to \"anyone\" content$update(access_type = \"all\") # edit another piece of content client %>% content_item(\"the-content-guid\") %>% set_vanity_url(\"/another-awesome-app\") # migrate content to another server client_prod <- connect( server = \"prod.example.com\", api_key = \"my-secret-key\" ) prod_bnd <- client %>% content_item(\"the-guid-to-promote\") %>% download_bundle() client_prod %>% deploy(prod_bnd, title = \"Now in Production\") %>% set_vanity_url(\"/my-app\") # open a browser to the content item client_prod %>% browse_dashboard() client_prod %>% browse_solo() # open a browser to the docs client_prod %>% browse_api_docs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"troubleshooting-and-faq","dir":"","previous_headings":"","what":"Troubleshooting and FAQ","title":"Utilities for Interacting with the Posit Connect Server API","text":"Access Denied Errors? likely due either (1) Connect$server Connect$api_key defined improperly (2) access Posit Connect cluster operation question Warning version numbers test package range versions Connect, old 1.8.8.2 (May 2021). Connect server older , package may still work, connectapi warn . strive : track latest version Posit Connect API add new features come available demand maintain backwards compatibility priorities sometimes odds, sometimes create inconsistencies versions result. mitigate , recommend: Track version connectapi use applications using renv Test high value content uses connectapi updating connectapi Posit Connect Update Posit Connect latest version first update connectapi needed Error - Need update Posit Connect helpful clarification users, added error messages API requests version implemented package specifically introduces backwards incompatible dependency older versions Posit Connect. get error message, recommendation : Look NEWS.md find moment change introduced Downgrade connectapi previous version package (Advanced) Use “blame” feature GitHub track commits find error introduced Please feel free open Issue think bug, ask free-form question Posit Community ideas FAQs Common Issues? Please open issue PR! love contribution!","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Utilities for Interacting with the Posit Connect Server API","text":"Please note connectapi project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":null,"dir":"Reference","previous_headings":"","what":"Bundle — Bundle","title":"Bundle — Bundle","text":"Bundle Bundle","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Bundle — Bundle","text":"R6 class represents bundle","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Bundle — Bundle","text":"path bundle path disk. size size bundle.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Bundle — Bundle","text":"Bundle$new() Bundle$print() Bundle$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Bundle — Bundle","text":"Initialize content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$new(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"path bundle path disk.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Bundle — Bundle","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Bundle — Bundle","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Bundle — Bundle","text":"","code":"Bundle$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Bundle.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Bundle — Bundle","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":null,"dir":"Reference","previous_headings":"","what":"Content — Content","title":"Content — Content","text":"Content Content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content — Content","text":"R6 class represents content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Content — Content","text":"connect R6 Connect object content content details Posit Connect","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Content — Content","text":"default_variant default variant object. is_rendered TRUE rendered content type, otherwise FALSE. is_interactive TRUE rendered content type, otherwise FALSE.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Content — Content","text":"Content$new() Content$get_connect() Content$get_content() Content$get_content_remote() Content$get_bundles() Content$bundle_download() Content$bundle_delete() Content$internal_content() Content$update() Content$danger_delete() Content$get_url() Content$get_dashboard_url() Content$jobs() Content$job() Content$variants() Content$tag_set() Content$tag_delete() Content$tags() Content$permissions_add() Content$permissions_update() Content$permissions_delete() Content$permissions() Content$environment() Content$environment_set() Content$environment_all() Content$deploy() Content$repo_enable() Content$repo_set() Content$print() Content$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Content — Content","text":"Initialize content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$new(connect, content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"connect Connect instance. content content data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Content — Content","text":"Returns Connect instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-content-","dir":"Reference","previous_headings":"","what":"Method get_content()","title":"Content — Content","text":"Returns underlying content data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_content()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-content-remote-","dir":"Reference","previous_headings":"","what":"Method get_content_remote()","title":"Content — Content","text":"Obtain content data Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_content_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-bundles-","dir":"Reference","previous_headings":"","what":"Method get_bundles()","title":"Content — Content","text":"Return set content bundles.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_bundles()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-bundle-download-","dir":"Reference","previous_headings":"","what":"Method bundle_download()","title":"Content — Content","text":"Download source archive content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$bundle_download( bundle_id, filename = tempfile(pattern = \"bundle\", fileext = \".tar.gz\"), overwrite = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id bundle identifer. filename write result. overwrite Overwrite existing filename.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-bundle-delete-","dir":"Reference","previous_headings":"","what":"Method bundle_delete()","title":"Content — Content","text":"Delete content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$bundle_delete(bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id bundle identifer.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-internal-content-","dir":"Reference","previous_headings":"","what":"Method internal_content()","title":"Content — Content","text":"Get (remote) content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$internal_content()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-update-","dir":"Reference","previous_headings":"","what":"Method update()","title":"Content — Content","text":"Update content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$update(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Content fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-danger-delete-","dir":"Reference","previous_headings":"","what":"Method danger_delete()","title":"Content — Content","text":"Delete content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$danger_delete()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-url-","dir":"Reference","previous_headings":"","what":"Method get_url()","title":"Content — Content","text":"Return URL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Content — Content","text":"Return URL content Posit Connect dashboard.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$get_dashboard_url(pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"pane pane dashboard link .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-jobs-","dir":"Reference","previous_headings":"","what":"Method jobs()","title":"Content — Content","text":"Return jobs content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$jobs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-job-","dir":"Reference","previous_headings":"","what":"Method job()","title":"Content — Content","text":"Return single job content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$job(key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"key job key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-variants-","dir":"Reference","previous_headings":"","what":"Method variants()","title":"Content — Content","text":"Return variants content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$variants()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tag-set-","dir":"Reference","previous_headings":"","what":"Method tag_set()","title":"Content — Content","text":"Set tag content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tag_set(tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tag-delete-","dir":"Reference","previous_headings":"","what":"Method tag_delete()","title":"Content — Content","text":"Remove tag content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tag_delete(tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-tags-","dir":"Reference","previous_headings":"","what":"Method tags()","title":"Content — Content","text":"tags content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$tags()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-add-","dir":"Reference","previous_headings":"","what":"Method permissions_add()","title":"Content — Content","text":"Add principal ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_add(principal_guid, principal_type, role)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"principal_guid GUID target user group. principal_type Acting user group. role kind content access.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-update-","dir":"Reference","previous_headings":"","what":"Method permissions_update()","title":"Content — Content","text":"Alter principal ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_update(id, principal_guid, principal_type, role)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier. principal_guid GUID target user group. principal_type Acting user group. role kind content access.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-delete-","dir":"Reference","previous_headings":"","what":"Method permissions_delete()","title":"Content — Content","text":"Remove entry ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions_delete(id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-permissions-","dir":"Reference","previous_headings":"","what":"Method permissions()","title":"Content — Content","text":"Obtain ACL content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$permissions(id = NULL, add_owner = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"id target identifier. add_owner Include content owner result set.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-","dir":"Reference","previous_headings":"","what":"Method environment()","title":"Content — Content","text":"Return environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-set-","dir":"Reference","previous_headings":"","what":"Method environment_set()","title":"Content — Content","text":"Adjust environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment_set(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Environment variable names values. Use NA value unset variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-environment-all-","dir":"Reference","previous_headings":"","what":"Method environment_all()","title":"Content — Content","text":"Overwrite environment variables set content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$environment_all(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-deploy-","dir":"Reference","previous_headings":"","what":"Method deploy()","title":"Content — Content","text":"Deploy content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$deploy(bundle_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"bundle_id Target bundle identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-repo-enable-","dir":"Reference","previous_headings":"","what":"Method repo_enable()","title":"Content — Content","text":"Adjust Git polling.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$repo_enable(enabled = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"enabled Polling enabled.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-repo-set-","dir":"Reference","previous_headings":"","what":"Method repo_set()","title":"Content — Content","text":"Adjust Git repository.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$repo_set(repository, branch, subdirectory)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"repository Git repository URL branch Git repository branch subdirectory Git repository directory","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Content — Content","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-28","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Content — Content","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"usage-29","dir":"Reference","previous_headings":"","what":"Usage","title":"Content — Content","text":"","code":"Content$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Content.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content — Content","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":null,"dir":"Reference","previous_headings":"","what":"ContentTask — ContentTask","title":"ContentTask — ContentTask","text":"ContentTask ContentTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"ContentTask — ContentTask","text":"R6 class represents Task piece Content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"ContentTask — ContentTask","text":"connectapi::Content -> ContentTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"ContentTask — ContentTask","text":"task task. data task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"ContentTask — ContentTask","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"ContentTask — ContentTask","text":"ContentTask$new() ContentTask$get_task() ContentTask$add_data() ContentTask$get_data() ContentTask$print() ContentTask$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"ContentTask — ContentTask","text":"Initialize task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$new(connect, content, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"connect Connect instance. content Content instance. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"ContentTask — ContentTask","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"ContentTask — ContentTask","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"ContentTask — ContentTask","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"ContentTask — ContentTask","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"ContentTask — ContentTask","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"ContentTask — ContentTask","text":"","code":"ContentTask$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/ContentTask.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"ContentTask — ContentTask","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":null,"dir":"Reference","previous_headings":"","what":"Environment — Environment","title":"Environment — Environment","text":"Environment Environment","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Environment — Environment","text":"R6 class represents Content's Environment Variables","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Environment — Environment","text":"connectapi::Content -> Environment","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Environment — Environment","text":"env_raw (raw) set environment variables. env_vars set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Environment — Environment","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Environment — Environment","text":"Environment$new() Environment$environment() Environment$environment_set() Environment$environment_all() Environment$env_refresh() Environment$print() Environment$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Environment — Environment","text":"Initialize set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$new(connect, content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"connect Connect instance. content Content instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-","dir":"Reference","previous_headings":"","what":"Method environment()","title":"Environment — Environment","text":"Fetch set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-set-","dir":"Reference","previous_headings":"","what":"Method environment_set()","title":"Environment — Environment","text":"Update set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment_set(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-environment-all-","dir":"Reference","previous_headings":"","what":"Method environment_all()","title":"Environment — Environment","text":"Overwrite set environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$environment_all(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Environment variable names values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-env-refresh-","dir":"Reference","previous_headings":"","what":"Method env_refresh()","title":"Environment — Environment","text":"Fetch set o environment variables.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$env_refresh()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Environment — Environment","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Environment — Environment","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Environment — Environment","text":"","code":"Environment$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/EnvironmentR6.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Environment — Environment","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":null,"dir":"Reference","previous_headings":"","what":"Class representing a Connect API client — PositConnect","title":"Class representing a Connect API client — PositConnect","text":"Class representing Connect API client Class representing Connect API client","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"client <- Connect$new(server = 'connect.example.com', apiKey = 'mysecretkey') client$get_apps() client$get_tags()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Class representing a Connect API client — PositConnect","text":"class allows user interact Connect server via Connect API. Authentication done providing API key.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Class representing a Connect API client — PositConnect","text":"server base URL Posit Connect server. api_key Posit Connect API key. tags initial set tags. tag_map initial tag map. httr_additions initial set httr configuration added HTTP call. using_auth Indicates API key added HTTP call.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"active-bindings","dir":"Reference","previous_headings":"","what":"Active bindings","title":"Class representing a Connect API client — PositConnect","text":"version server version.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Class representing a Connect API client — PositConnect","text":"Connect$get_connect() Connect$new() Connect$httr_config() Connect$print() Connect$raise_error() Connect$add_auth() Connect$api_url() Connect$server_url() Connect$request() Connect$GET() Connect$PUT() Connect$HEAD() Connect$DELETE() Connect$PATCH() Connect$POST() Connect$() Connect$get_dashboard_url() Connect$get_tags() Connect$get_tag_id() Connect$get_tag_tree() Connect$tag_create_safe() Connect$tag_create() Connect$tag() Connect$tag_delete() Connect$get_apps() Connect$get_schedule() Connect$content_create() Connect$content_upload() Connect$content_deploy() Connect$content() Connect$task() Connect$set_content_tag() Connect$remove_content_tag() Connect$user() Connect$users() Connect$users_remote() Connect$users_create() Connect$users_create_remote() Connect$users_lock() Connect$users_unlock() Connect$users_update() Connect$groups() Connect$group_members() Connect$group_member_add() Connect$group_member_remove() Connect$groups_create() Connect$groups_create_remote() Connect$groups_remote() Connect$inst_content_visits() Connect$inst_shiny_usage() Connect$procs() Connect$repo_account() Connect$repo_branches() Connect$repo_manifest_dirs() Connect$schedules() Connect$docs() Connect$audit_logs() Connect$server_settings_r() Connect$server_settings() Connect$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Class representing a Connect API client — PositConnect","text":"Return connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Class representing a Connect API client — PositConnect","text":"Initialize new connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$new(server, api_key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"server base URL Posit Connect server. api_key Posit Connect API key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-httr-config-","dir":"Reference","previous_headings":"","what":"Method httr_config()","title":"Class representing a Connect API client — PositConnect","text":"Set additional httr configuration added HTTP call.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$httr_config(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... Set httr configurations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Class representing a Connect API client — PositConnect","text":"Print details instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... Ignored.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-raise-error-","dir":"Reference","previous_headings":"","what":"Method raise_error()","title":"Class representing a Connect API client — PositConnect","text":"Raise error HTTP result HTTP error.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$raise_error(res)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"res HTTP result.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-add-auth-","dir":"Reference","previous_headings":"","what":"Method add_auth()","title":"Class representing a Connect API client — PositConnect","text":"Returns HTTP authorization headers, NULL none used.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$add_auth()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-api-url-","dir":"Reference","previous_headings":"","what":"Method api_url()","title":"Class representing a Connect API client — PositConnect","text":"Build URL relative API root","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$api_url(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... path segments","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-url-","dir":"Reference","previous_headings":"","what":"Method server_url()","title":"Class representing a Connect API client — PositConnect","text":"Build URL relative server root","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_url(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"... path segments","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-request-","dir":"Reference","previous_headings":"","what":"Method request()","title":"Class representing a Connect API client — PositConnect","text":"General wrapper around httr verbs","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$request(method, url, ..., parser = \"parsed\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"method HTTP request method url URL request ... Additional arguments passed request function parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-","dir":"Reference","previous_headings":"","what":"Method GET()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP GET request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$GET(path, ..., url = self$api_url(path), parser = \"parsed\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::GET() url Target URL. Default uses path, provide url request server resource /__api__ parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-put-","dir":"Reference","previous_headings":"","what":"Method PUT()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP PUT request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$PUT( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::PUT() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-head-","dir":"Reference","previous_headings":"","what":"Method HEAD()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP HEAD request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$HEAD(path, ..., url = self$api_url(path))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::HEAD() url Target URL. Default uses path, provide url request server resource /__api__ httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-delete-","dir":"Reference","previous_headings":"","what":"Method DELETE()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP DELETE request named API path. Returns HTTP response object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$DELETE(path, ..., url = self$api_url(path), parser = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-10","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. ... Arguments httr::DELETE() url Target URL. Default uses path, provide url request server resource /__api__ parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-patch-","dir":"Reference","previous_headings":"","what":"Method PATCH()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP PATCH request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$PATCH( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-11","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::PATCH() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-post-","dir":"Reference","previous_headings":"","what":"Method POST()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP POST request named API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$POST( path, body = \"{}\", ..., url = self$api_url(path), encode = \"json\", parser = \"parsed\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-12","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"path API path relative server's /__api__ root. body HTTP payload. ... Arguments httr::POST() url Target URL. Default uses path, provide url request server resource /__api__ encode payload encoded. parser response parsed. NULL, httr_response returned. Otherwise, argument forwarded httr::content(res, = parser).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-me-","dir":"Reference","previous_headings":"","what":"Method me()","title":"Class representing a Connect API client — PositConnect","text":"Perform HTTP GET request \"\" server endpoint.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$me()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Class representing a Connect API client — PositConnect","text":"Return base URL Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_dashboard_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tags-","dir":"Reference","previous_headings":"","what":"Method get_tags()","title":"Class representing a Connect API client — PositConnect","text":"Return tags.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tags(use_cache = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-13","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"use_cache Indicates cached set tags used.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tag-id-","dir":"Reference","previous_headings":"","what":"Method get_tag_id()","title":"Class representing a Connect API client — PositConnect","text":"Get identifier named tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-19","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tag_id(tagname)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-14","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"tagname name tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-tag-tree-","dir":"Reference","previous_headings":"","what":"Method get_tag_tree()","title":"Class representing a Connect API client — PositConnect","text":"Get tag tree.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-20","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_tag_tree()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-create-safe-","dir":"Reference","previous_headings":"","what":"Method tag_create_safe()","title":"Class representing a Connect API client — PositConnect","text":"Create tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-21","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_create_safe(name, parent_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-15","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name tag name. parent_id parent identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-create-","dir":"Reference","previous_headings":"","what":"Method tag_create()","title":"Class representing a Connect API client — PositConnect","text":"Create tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-22","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_create(name, parent_id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-16","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name tag name. parent_id parent identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-","dir":"Reference","previous_headings":"","what":"Method tag()","title":"Class representing a Connect API client — PositConnect","text":"Get tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-23","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag(id = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-17","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-tag-delete-","dir":"Reference","previous_headings":"","what":"Method tag_delete()","title":"Class representing a Connect API client — PositConnect","text":"Delete tag.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-24","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$tag_delete(id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-18","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-apps-","dir":"Reference","previous_headings":"","what":"Method get_apps()","title":"Class representing a Connect API client — PositConnect","text":"Get content items.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-25","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_apps(filter = NULL, .collapse = \"&\", .limit = Inf, page_size = 25)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-19","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"filter Named list containing filter conditions. .collapse multiple filters combined. .limit limit. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"Class representing a Connect API client — PositConnect","text":"Get schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-26","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$get_schedule(schedule_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-20","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"schedule_id schedule identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-create-","dir":"Reference","previous_headings":"","what":"Method content_create()","title":"Class representing a Connect API client — PositConnect","text":"Create content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-27","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_create(name, title = name, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-21","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name content name. title content title. ... content fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-upload-","dir":"Reference","previous_headings":"","what":"Method content_upload()","title":"Class representing a Connect API client — PositConnect","text":"Upload content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-28","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_upload(bundle_path, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-22","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"bundle_path path bundle archive. guid content GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-deploy-","dir":"Reference","previous_headings":"","what":"Method content_deploy()","title":"Class representing a Connect API client — PositConnect","text":"Deploy content bundle.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-29","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content_deploy(guid, bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-23","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid content GUID. bundle_id bundle identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-content-","dir":"Reference","previous_headings":"","what":"Method content()","title":"Class representing a Connect API client — PositConnect","text":"Get content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-30","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$content( guid = NULL, owner_guid = NULL, name = NULL, include = \"tags,owner\" )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-24","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid content GUID. owner_guid target content owner. name target name. include Additional response fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-task-","dir":"Reference","previous_headings":"","what":"Method task()","title":"Class representing a Connect API client — PositConnect","text":"Get task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-31","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$task(task_id, first = 0, wait = 5)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-25","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"task_id task identifier. first initial status position. wait Maximum time wait update.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-set-content-tag-","dir":"Reference","previous_headings":"","what":"Method set_content_tag()","title":"Class representing a Connect API client — PositConnect","text":"Set tag content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-32","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$set_content_tag(content_id, tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-26","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_id content identifier. tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-remove-content-tag-","dir":"Reference","previous_headings":"","what":"Method remove_content_tag()","title":"Class representing a Connect API client — PositConnect","text":"Remove tag content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-33","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$remove_content_tag(content_id, tag_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-27","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_id content identifier. tag_id tag identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-user-","dir":"Reference","previous_headings":"","what":"Method user()","title":"Class representing a Connect API client — PositConnect","text":"Get user details.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-34","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$user(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-28","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-","dir":"Reference","previous_headings":"","what":"Method users()","title":"Class representing a Connect API client — PositConnect","text":"Get users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-35","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users(page_number = 1, prefix = NULL, page_size = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-29","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"page_number page number. prefix search term. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-remote-","dir":"Reference","previous_headings":"","what":"Method users_remote()","title":"Class representing a Connect API client — PositConnect","text":"Get remote users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-36","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_remote(prefix)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-30","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"prefix search term.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-create-","dir":"Reference","previous_headings":"","what":"Method users_create()","title":"Class representing a Connect API client — PositConnect","text":"Create user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-37","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_create( username, email, first_name = NULL, last_name = NULL, password = NULL, user_must_set_password = NULL, user_role = NULL, unique_id = NULL )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-31","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"username username. email Email address. first_name First name. last_name Last name. password password. user_must_set_password Indicates user sets password first login. user_role Role user. unique_id Identifier user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-create-remote-","dir":"Reference","previous_headings":"","what":"Method users_create_remote()","title":"Class representing a Connect API client — PositConnect","text":"Create remote user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-38","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_create_remote(temp_ticket)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-32","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"temp_ticket Ticket identifying target remote user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-lock-","dir":"Reference","previous_headings":"","what":"Method users_lock()","title":"Class representing a Connect API client — PositConnect","text":"Lock user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-39","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_lock(user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-33","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-unlock-","dir":"Reference","previous_headings":"","what":"Method users_unlock()","title":"Class representing a Connect API client — PositConnect","text":"Unlock user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-40","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_unlock(user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-34","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-users-update-","dir":"Reference","previous_headings":"","what":"Method users_update()","title":"Class representing a Connect API client — PositConnect","text":"Update user.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-41","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$users_update(user_guid, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-35","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"user_guid User GUID. ... User fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-","dir":"Reference","previous_headings":"","what":"Method groups()","title":"Class representing a Connect API client — PositConnect","text":"Get groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-42","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups(page_number = 1, prefix = NULL, page_size = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-36","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"page_number page number. prefix search term. page_size page size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-members-","dir":"Reference","previous_headings":"","what":"Method group_members()","title":"Class representing a Connect API client — PositConnect","text":"Get group members.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-43","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_members(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-37","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"guid group GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-member-add-","dir":"Reference","previous_headings":"","what":"Method group_member_add()","title":"Class representing a Connect API client — PositConnect","text":"Add group member.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-44","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_member_add(group_guid, user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-38","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"group_guid group GUID. user_guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-group-member-remove-","dir":"Reference","previous_headings":"","what":"Method group_member_remove()","title":"Class representing a Connect API client — PositConnect","text":"Remove group member.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-45","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$group_member_remove(group_guid, user_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-39","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"group_guid group GUID. user_guid user GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-create-","dir":"Reference","previous_headings":"","what":"Method groups_create()","title":"Class representing a Connect API client — PositConnect","text":"Create group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-46","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_create(name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-40","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"name group name.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-create-remote-","dir":"Reference","previous_headings":"","what":"Method groups_create_remote()","title":"Class representing a Connect API client — PositConnect","text":"Create remote group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-47","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_create_remote(temp_ticket)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-41","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"temp_ticket Ticket identifying target remote group.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-groups-remote-","dir":"Reference","previous_headings":"","what":"Method groups_remote()","title":"Class representing a Connect API client — PositConnect","text":"Get remote groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-48","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$groups_remote(prefix = NULL, limit = 500)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-42","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"prefix search term. limit maximal result set size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-inst-content-visits-","dir":"Reference","previous_headings":"","what":"Method inst_content_visits()","title":"Class representing a Connect API client — PositConnect","text":"Get (non-interactive) content visits.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-49","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$inst_content_visits( content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-43","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_guid Content GUID. min_data_version Data version request. Start range. End range. limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-inst-shiny-usage-","dir":"Reference","previous_headings":"","what":"Method inst_shiny_usage()","title":"Class representing a Connect API client — PositConnect","text":"Get interactive content visits. Get (non-interactive) content visits.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-50","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$inst_shiny_usage( content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-44","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"content_guid Content GUID. min_data_version Data version request. Start range. End range. limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-procs-","dir":"Reference","previous_headings":"","what":"Method procs()","title":"Class representing a Connect API client — PositConnect","text":"Get running processes.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-51","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$procs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-account-","dir":"Reference","previous_headings":"","what":"Method repo_account()","title":"Class representing a Connect API client — PositConnect","text":"Determine Git repository associated authorization.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-52","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_account(host)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-45","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"host Repository URL.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-branches-","dir":"Reference","previous_headings":"","what":"Method repo_branches()","title":"Class representing a Connect API client — PositConnect","text":"Get Git repository branches.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-53","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_branches(repo)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-46","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"repo Repository URL.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-repo-manifest-dirs-","dir":"Reference","previous_headings":"","what":"Method repo_manifest_dirs()","title":"Class representing a Connect API client — PositConnect","text":"Get Git repository directories.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-54","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$repo_manifest_dirs(repo, branch)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-47","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"repo Repository URL. branch Repository branch.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-schedules-","dir":"Reference","previous_headings":"","what":"Method schedules()","title":"Class representing a Connect API client — PositConnect","text":"Get schedules.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-55","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$schedules( start = Sys.time(), end = Sys.time() + 60 * 60 * 24 * 7, detailed = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-48","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"start Starting time. end Ending time. detailed Indicates detailed schedule information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-docs-","dir":"Reference","previous_headings":"","what":"Method docs()","title":"Class representing a Connect API client — PositConnect","text":"Get documentation.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-56","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$docs(docs = \"api\", browse = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-49","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"docs Named document. browse Open browser.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-audit-logs-","dir":"Reference","previous_headings":"","what":"Method audit_logs()","title":"Class representing a Connect API client — PositConnect","text":"Get auditing.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-57","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$audit_logs(limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-50","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"limit Result set size. previous Previous item. nxt Next item. asc_order Indicates ascending result order.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-settings-r-","dir":"Reference","previous_headings":"","what":"Method server_settings_r()","title":"Class representing a Connect API client — PositConnect","text":"Get R installations.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-58","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_settings_r()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-server-settings-","dir":"Reference","previous_headings":"","what":"Method server_settings()","title":"Class representing a Connect API client — PositConnect","text":"Get server settings.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-59","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$server_settings()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Class representing a Connect API client — PositConnect","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"usage-60","dir":"Reference","previous_headings":"","what":"Usage","title":"Class representing a Connect API client — PositConnect","text":"","code":"Connect$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/PositConnect.html","id":"arguments-51","dir":"Reference","previous_headings":"","what":"Arguments","title":"Class representing a Connect API client — PositConnect","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":null,"dir":"Reference","previous_headings":"","what":"Task — Task","title":"Task — Task","text":"Task Task","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Task — Task","text":"R6 class represents Task","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Task — Task","text":"connect Connect instance. task task. data task data.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Task — Task","text":"Task$new() Task$get_connect() Task$get_task() Task$add_data() Task$get_data() Task$print() Task$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Task — Task","text":"Initialize task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$new(connect, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"connect Connect instance. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-connect-","dir":"Reference","previous_headings":"","what":"Method get_connect()","title":"Task — Task","text":"Return associated Connect instance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_connect()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"Task — Task","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"Task — Task","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"Task — Task","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Task — Task","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Task — Task","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Task — Task","text":"","code":"Task$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Task.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Task — Task","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":null,"dir":"Reference","previous_headings":"","what":"Vanity — Vanity","title":"Vanity — Vanity","text":"Vanity Vanity","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Vanity — Vanity","text":"R6 class represents Vanity URL","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Vanity — Vanity","text":"connectapi::Content -> Vanity","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Vanity — Vanity","text":"vanity vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Vanity — Vanity","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$get_dashboard_url() connectapi::Content$get_url() connectapi::Content$internal_content() connectapi::Content$job() connectapi::Content$jobs() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Vanity — Vanity","text":"Vanity$new() Vanity$get_vanity() Vanity$print() Vanity$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Vanity — Vanity","text":"Initialize vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$new(connect, content, vanity)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"connect Connect instance. content Content instance. vanity vanity data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-get-vanity-","dir":"Reference","previous_headings":"","what":"Method get_vanity()","title":"Vanity — Vanity","text":"Return underlying vanity.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$get_vanity()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Vanity — Vanity","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Vanity — Vanity","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Vanity — Vanity","text":"","code":"Vanity$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/Vanity.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Vanity — Vanity","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":null,"dir":"Reference","previous_headings":"","what":"Variant — Variant","title":"Variant — Variant","text":"Variant Variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Variant — Variant","text":"R6 class represents Variant","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"super-class","dir":"Reference","previous_headings":"","what":"Super class","title":"Variant — Variant","text":"connectapi::Content -> Variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"Variant — Variant","text":"key variant key. variant variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"Variant — Variant","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"Variant — Variant","text":"Variant$get_variant() Variant$get_variant_remote() Variant$new() Variant$send_mail() Variant$get_schedule() Variant$get_schedule_remote() Variant$get_subscribers() Variant$remove_subscriber() Variant$add_subscribers() Variant$render() Variant$renderings() Variant$update_variant() Variant$jobs() Variant$job() Variant$get_url() Variant$get_url_rev() Variant$get_dashboard_url() Variant$print() Variant$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-variant-","dir":"Reference","previous_headings":"","what":"Method get_variant()","title":"Variant — Variant","text":"Get underlying variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_variant()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-variant-remote-","dir":"Reference","previous_headings":"","what":"Method get_variant_remote()","title":"Variant — Variant","text":"Get store (remote) variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_variant_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"Variant — Variant","text":"Initialize variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$new(connect, content, key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"connect Connect instance. content Content instance. key variant key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-send-mail-","dir":"Reference","previous_headings":"","what":"Method send_mail()","title":"Variant — Variant","text":"Mail previously rendered content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$send_mail(to = c(\"me\", \"collaborators\", \"collaborators_viewers\"))"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"Targeting.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"Variant — Variant","text":"Get (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-schedule-remote-","dir":"Reference","previous_headings":"","what":"Method get_schedule_remote()","title":"Variant — Variant","text":"Get (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_schedule_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-subscribers-","dir":"Reference","previous_headings":"","what":"Method get_subscribers()","title":"Variant — Variant","text":"Get subscribers.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_subscribers()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-remove-subscriber-","dir":"Reference","previous_headings":"","what":"Method remove_subscriber()","title":"Variant — Variant","text":"Remove named subscriber.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$remove_subscriber(guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"guid User GUID.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-add-subscribers-","dir":"Reference","previous_headings":"","what":"Method add_subscribers()","title":"Variant — Variant","text":"Add named subscribers.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$add_subscribers(guids)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"guids User GUIDs.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-render-","dir":"Reference","previous_headings":"","what":"Method render()","title":"Variant — Variant","text":"Render variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$render()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-renderings-","dir":"Reference","previous_headings":"","what":"Method renderings()","title":"Variant — Variant","text":"List renderings variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$renderings()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-update-variant-","dir":"Reference","previous_headings":"","what":"Method update_variant()","title":"Variant — Variant","text":"Update variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-11","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$update_variant(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"... Target fields values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-jobs-","dir":"Reference","previous_headings":"","what":"Method jobs()","title":"Variant — Variant","text":"Jobs variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-12","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$jobs()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-job-","dir":"Reference","previous_headings":"","what":"Method job()","title":"Variant — Variant","text":"Return single job variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-13","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$job(key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"key job key.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-url-","dir":"Reference","previous_headings":"","what":"Method get_url()","title":"Variant — Variant","text":"Return URL variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-14","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_url()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-url-rev-","dir":"Reference","previous_headings":"","what":"Method get_url_rev()","title":"Variant — Variant","text":"Return URL associated one rendering variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-15","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_url_rev(rev)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"rev Rendering identifier.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-get-dashboard-url-","dir":"Reference","previous_headings":"","what":"Method get_dashboard_url()","title":"Variant — Variant","text":"Return URL variant Posit Connect dashboard.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-16","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$get_dashboard_url(pane = \"access\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-7","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"pane pane dashboard link .","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"Variant — Variant","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-17","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-8","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"Variant — Variant","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"usage-18","dir":"Reference","previous_headings":"","what":"Usage","title":"Variant — Variant","text":"","code":"Variant$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantR6.html","id":"arguments-9","dir":"Reference","previous_headings":"","what":"Arguments","title":"Variant — Variant","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":null,"dir":"Reference","previous_headings":"","what":"VariantSchedule — VariantSchedule","title":"VariantSchedule — VariantSchedule","text":"VariantSchedule VariantSchedule","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"VariantSchedule — VariantSchedule","text":"R6 class represents Schedule","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"VariantSchedule — VariantSchedule","text":"connectapi::Content -> connectapi::Variant -> VariantSchedule","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"VariantSchedule — VariantSchedule","text":"schedule_data schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"VariantSchedule — VariantSchedule","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants() connectapi::Variant$add_subscribers() connectapi::Variant$get_dashboard_url() connectapi::Variant$get_subscribers() connectapi::Variant$get_url() connectapi::Variant$get_url_rev() connectapi::Variant$get_variant() connectapi::Variant$get_variant_remote() connectapi::Variant$job() connectapi::Variant$jobs() connectapi::Variant$remove_subscriber() connectapi::Variant$render() connectapi::Variant$renderings() connectapi::Variant$send_mail() connectapi::Variant$update_variant()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"VariantSchedule — VariantSchedule","text":"VariantSchedule$new() VariantSchedule$GET() VariantSchedule$POST() VariantSchedule$DELETE() VariantSchedule$set_schedule() VariantSchedule$is_empty() VariantSchedule$print() VariantSchedule$get_schedule() VariantSchedule$get_schedule_remote() VariantSchedule$describe_schedule() VariantSchedule$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"VariantSchedule — VariantSchedule","text":"Initialize schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$new(connect, content, key, schedule)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"connect Connect instance. content Content instance. key variant key. schedule schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-","dir":"Reference","previous_headings":"","what":"Method GET()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP GET request named API path. Returns object parsed HTTP response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$GET(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-post-","dir":"Reference","previous_headings":"","what":"Method POST()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP POST request named API path. Returns object parsed HTTP response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$POST(path, body)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path. body HTTP payload.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-delete-","dir":"Reference","previous_headings":"","what":"Method DELETE()","title":"VariantSchedule — VariantSchedule","text":"Perform HTTP DELETE request named API path. Returns HTTP response object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$DELETE(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"path API path.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-set-schedule-","dir":"Reference","previous_headings":"","what":"Method set_schedule()","title":"VariantSchedule — VariantSchedule","text":"Set schedule variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$set_schedule(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-4","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"... Schedule fields.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-is-empty-","dir":"Reference","previous_headings":"","what":"Method is_empty()","title":"VariantSchedule — VariantSchedule","text":"Return variant schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$is_empty()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"VariantSchedule — VariantSchedule","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-6","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-5","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-schedule-","dir":"Reference","previous_headings":"","what":"Method get_schedule()","title":"VariantSchedule — VariantSchedule","text":"Get schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-7","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$get_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-get-schedule-remote-","dir":"Reference","previous_headings":"","what":"Method get_schedule_remote()","title":"VariantSchedule — VariantSchedule","text":"Get store (remote) schedule data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-8","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$get_schedule_remote()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-describe-schedule-","dir":"Reference","previous_headings":"","what":"Method describe_schedule()","title":"VariantSchedule — VariantSchedule","text":"Description associated schedule.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-9","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$describe_schedule()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"VariantSchedule — VariantSchedule","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"usage-10","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantSchedule — VariantSchedule","text":"","code":"VariantSchedule$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantSchedule.html","id":"arguments-6","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantSchedule — VariantSchedule","text":"deep Whether make deep clone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":null,"dir":"Reference","previous_headings":"","what":"VariantTask — VariantTask","title":"VariantTask — VariantTask","text":"VariantTask VariantTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"VariantTask — VariantTask","text":"R6 class represents Variant Task","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"super-classes","dir":"Reference","previous_headings":"","what":"Super classes","title":"VariantTask — VariantTask","text":"connectapi::Content -> connectapi::Variant -> VariantTask","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"public-fields","dir":"Reference","previous_headings":"","what":"Public fields","title":"VariantTask — VariantTask","text":"task task. data variant data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"methods","dir":"Reference","previous_headings":"","what":"Methods","title":"VariantTask — VariantTask","text":"connectapi::Content$bundle_delete() connectapi::Content$bundle_download() connectapi::Content$danger_delete() connectapi::Content$deploy() connectapi::Content$environment() connectapi::Content$environment_all() connectapi::Content$environment_set() connectapi::Content$get_bundles() connectapi::Content$get_connect() connectapi::Content$get_content() connectapi::Content$get_content_remote() connectapi::Content$internal_content() connectapi::Content$permissions() connectapi::Content$permissions_add() connectapi::Content$permissions_delete() connectapi::Content$permissions_update() connectapi::Content$repo_enable() connectapi::Content$repo_set() connectapi::Content$tag_delete() connectapi::Content$tag_set() connectapi::Content$tags() connectapi::Content$update() connectapi::Content$variants() connectapi::Variant$add_subscribers() connectapi::Variant$get_dashboard_url() connectapi::Variant$get_schedule() connectapi::Variant$get_schedule_remote() connectapi::Variant$get_subscribers() connectapi::Variant$get_url() connectapi::Variant$get_url_rev() connectapi::Variant$get_variant() connectapi::Variant$get_variant_remote() connectapi::Variant$job() connectapi::Variant$jobs() connectapi::Variant$remove_subscriber() connectapi::Variant$render() connectapi::Variant$renderings() connectapi::Variant$send_mail() connectapi::Variant$update_variant()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"public-methods","dir":"Reference","previous_headings":"","what":"Public methods","title":"VariantTask — VariantTask","text":"VariantTask$new() VariantTask$get_task() VariantTask$add_data() VariantTask$get_data() VariantTask$print() VariantTask$clone()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-new-","dir":"Reference","previous_headings":"","what":"Method new()","title":"VariantTask — VariantTask","text":"Initialize variant task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$new(connect, content, key, task)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"connect Connect instance. content Content instance. key variant key. task task data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-get-task-","dir":"Reference","previous_headings":"","what":"Method get_task()","title":"VariantTask — VariantTask","text":"Return underlying task.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-1","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$get_task()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-add-data-","dir":"Reference","previous_headings":"","what":"Method add_data()","title":"VariantTask — VariantTask","text":"Set data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-2","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$add_data(data)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-1","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"data data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-get-data-","dir":"Reference","previous_headings":"","what":"Method get_data()","title":"VariantTask — VariantTask","text":"Get data.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-3","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$get_data()"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-print-","dir":"Reference","previous_headings":"","what":"Method print()","title":"VariantTask — VariantTask","text":"Print object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-4","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$print(...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-2","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"... Unused.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"method-clone-","dir":"Reference","previous_headings":"","what":"Method clone()","title":"VariantTask — VariantTask","text":"objects class cloneable method.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"usage-5","dir":"Reference","previous_headings":"","what":"Usage","title":"VariantTask — VariantTask","text":"","code":"VariantTask$clone(deep = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/VariantTask.html","id":"arguments-3","dir":"Reference","previous_headings":"","what":"Arguments","title":"VariantTask — VariantTask","text":"deep Whether make deep clone.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_access_open.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit Access Controls — audit_access_open","text":"","code":"audit_access_open(content, type = \"all\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_access_open.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit Access Controls — audit_access_open","text":"content data.frame content information, get_content() type One \"\" \"logged_in\". \"\", return list apps whose access control set \"Everyone\". \"logged_in\", return list apps whose access control set \"logged users\"","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit R Versions — audit_r_versions","text":"","code":"audit_r_versions(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit R Versions — audit_r_versions","text":"content data.frame content information, get_content()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_r_versions.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Audit R Versions — audit_r_versions","text":"plot shows R version used content time aggregate.","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Audit Run As Settings — audit_runas","text":"","code":"audit_runas(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Audit Run As Settings — audit_runas","text":"content data.frame content information, get_content()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/audit_runas.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Audit Run As Settings — audit_runas","text":"data frame app name Run user Run user default","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":null,"dir":"Reference","previous_headings":"","what":"Browse — browse_solo","title":"Browse — browse_solo","text":"Browse different locations Connect via utils::browseURL","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Browse — browse_solo","text":"","code":"browse_solo(content) browse_dashboard(content) browse_api_docs(connect) browse_connect(connect)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Browse — browse_solo","text":"content R6 Content object connect R6 Connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/browse.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Browse — browse_solo","text":"url opened browser","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a Directory — bundle_dir","title":"Define a bundle from a Directory — bundle_dir","text":"Creates bundle target directory.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a Directory — bundle_dir","text":"","code":"bundle_dir( path = \".\", filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\") )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a Directory — bundle_dir","text":"path path directory bundled filename output bundle path","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a Directory — bundle_dir","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_dir.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a Directory — bundle_dir","text":"","code":"bundle_dir(system.file(\"tests/testthat/examples/shiny/\", package = \"connectapi\")) #> Error in bundle_dir(system.file(\"tests/testthat/examples/shiny/\", package = \"connectapi\")): fs::dir_exists(path) is not TRUE"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"Define bundle path (path directly tar.gz file)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"","code":"bundle_path(path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"path path .tar.gz file","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_path.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a path (a path directly to a tar.gz file) — bundle_path","text":"","code":"bundle_path(system.file(\"tests/testthat/examples/static.tar.gz\", package = \"connectapi\")) #> Bundling path #> Posit Connect Bundle: #> Path: /home/runner/work/connectapi/connectapi/docs/dev/reference #> Size: 4K #> #> bundle_path(\"/home/runner/work/connectapi/connectapi/docs/dev/reference\") #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":null,"dir":"Reference","previous_headings":"","what":"Define a bundle from a static file (or files) — bundle_static","title":"Define a bundle from a static file (or files) — bundle_static","text":"Defines bundle static files. copies files temporary directory, generates basic manifest file (using first file \"primary\"), bundles directory.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Define a bundle from a static file (or files) — bundle_static","text":"","code":"bundle_static( path, filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\") )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Define a bundle from a static file (or files) — bundle_static","text":"path path file (files) used static bundle filename output bundle path","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Define a bundle from a static file (or files) — bundle_static","text":"Bundle bundle object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Define a bundle from a static file (or files) — bundle_static","text":"NOTE: rsconnect package required function work properly.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/bundle_static.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Define a bundle from a static file (or files) — bundle_static","text":"","code":"bundle_static(system.file(\"logo.png\", package = \"connectapi\")) #> Bundling directory (/tmp/RtmpYD7Rbc/bundledir21733f40762e) #> Posit Connect Bundle: #> Path: /tmp/RtmpYD7Rbc/bundle2173334b1d25.tar.gz #> Size: 23.9K #> #> bundle_path(\"/tmp/RtmpYD7Rbc/bundle2173334b1d25.tar.gz\") #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a connection to Posit Connect — connect","title":"Create a connection to Posit Connect — connect","text":"Creates connection Posit Connect using server URL api key. Validates connection checks version server compatible current version package.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a connection to Posit Connect — connect","text":"","code":"connect( server = Sys.getenv(paste0(prefix, \"_SERVER\"), NA_character_), api_key = Sys.getenv(paste0(prefix, \"_API_KEY\"), NA_character_), prefix = \"CONNECT\", ..., .check_is_fatal = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a connection to Posit Connect — connect","text":"server URL accessing Posit Connect. Defaults environment variable CONNECT_SERVER api_key API Key authenticate Posit Connect . Defaults environment variable CONNECT_API_KEY prefix prefix used determine environment variables ... Additional arguments. used present .check_is_fatal Whether fail \"check\" requests fail. Useful rare cases http request customization needed requests succeed.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a connection to Posit Connect — connect","text":"Posit Connect R6 object can passed along methods","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connect.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create a connection to Posit Connect — connect","text":"","code":"if (FALSE) { # \\dontrun{ connect() } # } # default is to read CONNECT_SERVER and CONNECT_API_KEY environment variables # this example will read TEST_1_SERVER and TEST_1_API_KEY connect(prefix = \"TEST_1\") #> Defining Connect with server: http://localhost:32768 #> Posit Connect API Client: #> Posit Connect Server: http://localhost:32768 #> Posit Connect API Key: ***********6eAV #>"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connectapi-package.html","id":null,"dir":"Reference","previous_headings":"","what":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","title":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","text":"Provides helpful 'R6' class methods interacting 'Posit Connect' Server API along meaningful utility functions regular tasks. API documentation varies 'Posit Connect' installation version, latest documentation also hosted publicly https://docs.posit.co/connect/api/. Provides helpful 'R6' class methods interacting 'Posit Connect' Server API along meaningful utility functions regular tasks. API documentation varies 'Posit Connect' installation version, latest documentation also hosted publicly https://docs.posit.co/connect/api/.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/connectapi-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"connectapi: Utilities for Interacting with the 'Posit Connect' Server API — connectapi-package","text":"Maintainer: Toph Allen toph@posit.co Authors: Neal Richardson Sean Lopp Cole Arendt cole@posit.co contributors: Posit, PBC [copyright holder, funder]","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete Content — content_delete","title":"Delete Content — content_delete","text":"Delete content item. WARNING: action deletes history, configuration, logs, resources content item. undone.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete Content — content_delete","text":"","code":"content_delete(content, force = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete Content — content_delete","text":"content R6 content item force Optional. boolean determines whether prompt interactive sessions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_delete.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete Content — content_delete","text":"R6 Content item. item deleted, information cached locally","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content Item — content_item","title":"Get Content Item — content_item","text":"Returns single content item based guid","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content Item — content_item","text":"","code":"content_item(connect, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content Item — content_item","text":"connect Connect object guid GUID content item retrieved","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Content Item — content_item","text":"Content object use content endpoints","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_item.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Content Item — content_item","text":"","code":"if (FALSE) { # \\dontrun{ connect() %>% content_item(\"some-guid\") %>% content_update_access_type(\"all\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":null,"dir":"Reference","previous_headings":"","what":"Content List — content_list_by_tag","title":"Content List — content_list_by_tag","text":"Get content list","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content List — content_list_by_tag","text":"","code":"content_list_by_tag(src, tag)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content List — content_list_by_tag","text":"src R6 Connect object tag connect_tag_tree object tag ID","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content List — content_list_by_tag","text":"content_list_by_tag() retrieves content list tag","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content List with Permissions — content_list_with_permissions","title":"Get Content List with Permissions — content_list_with_permissions","text":"functions experimental placeholders API supports behavior.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content List with Permissions — content_list_with_permissions","text":"","code":"content_list_with_permissions(src, ..., .p = NULL) content_list_guid_has_access(content_list, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content List with Permissions — content_list_with_permissions","text":"src Connect R6 object ... Extra arguments. Currently used .p Optional. predicate function, passed -purrr::keep(). See get_content() details. Can greatly help performance reducing many items get permissions content_list \"content list permissions\" returned content_list_with_permissions() guid user group GUID filter content list whether access","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_list_with_permissions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Content List with Permissions — content_list_with_permissions","text":"content_list_with_permissions loops content retrieves permissions item (progress bar). can take long time lots content! Make sure use optional .p argument predicate function filters content list transformed. content_list_guid_has_access works content_list_with_permissions dataset checking whether given GUID (either user group) access content : checking content access_type == \"\" checking content access_type == \"logged_in\" checking provided guid content owner checking provided guid list content permissions (\"permissions\" column)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render a content item. — content_render","title":"Render a content item. — content_render","text":"Submit request render content item. submitted, server runs asynchronous process render content. might useful content needs updated source data changed, especially happen regular schedule. valid rendered content (e.g., Quarto documents, Jupyter notebooks, R Markdown reports).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render a content item. — content_render","text":"","code":"content_render(content, variant_key = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render a content item. — content_render","text":"content content item wish render. variant_key variant key provided, render variant. Otherwise, render default variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render a content item. — content_render","text":"VariantTask object can used track completion render.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_render.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render a content item. — content_render","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"951bf3ad-82d0-4bca-bba8-9b27e35c49fa\") task <- content_render(item) poll_task(task) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":null,"dir":"Reference","previous_headings":"","what":"Restart a content item. — content_restart","title":"Restart a content item. — content_restart","text":"Submit request restart content item. submitted, server performs asynchronous request kill processes associated content item, starting new processes needed. might useful application relies data loaded startup, memory usage grown time. Note users interacting certain types applications may workflows interrupted. valid interactive content (e.g., applications, APIs).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Restart a content item. — content_restart","text":"","code":"content_restart(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Restart a content item. — content_restart","text":"content content item wish restart.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_restart.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Restart a content item. — content_restart","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") content_restart(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Content Title — content_title","title":"Get Content Title — content_title","text":"Return content title piece content. content missing (deleted) visible, returns default","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Content Title — content_title","text":"","code":"content_title(connect, guid, default = \"Unknown Content\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Content Title — content_title","text":"connect Connect object guid GUID content item retrieved default default value returned missing visible content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Content Title — content_title","text":"character. title requested content","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":null,"dir":"Reference","previous_headings":"","what":"Update Content — content_update","title":"Update Content — content_update","text":"Update settings content item. list settings, see latest documentation documentation server via connectapi::browse_api_docs().","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Update Content — content_update","text":"","code":"content_update(content, ...) content_update_access_type(content, access_type = c(\"all\", \"logged_in\", \"acl\")) content_update_owner(content, owner_guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Update Content — content_update","text":"content R6 content item ... Settings update passed along Posit Connect access_type One \"\", \"logged_in\", \"acl\" owner_guid GUID user publisher, can become new owner content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Update Content — content_update","text":"R6 content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/content_update.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Update Content — content_update","text":"Popular selections content_update(access_type=\"\"), content_update(access_type=\"logged_in\") content_update(access_type=\"acl\"), process settings, title, description, etc. content_update_access_type() helper make easier change access_type content_update_owner() helper make easier change owner","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Create Random Name — create_random_name","title":"Create Random Name — create_random_name","text":"Creates random name LETTERS dataset","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create Random Name — create_random_name","text":"","code":"create_random_name(length = 25)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create Random Name — create_random_name","text":"length Optional. length random name. Defaults 25","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/create_random_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create Random Name — create_random_name","text":"randomly generated name","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a Dashboard URL from a Content Item — dashboard_url","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"Returns URL content dashboard (opened selected pane).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"","code":"dashboard_url(content, pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"content Content Content object pane character pane dashboard link ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a Dashboard URL from a Content Item — dashboard_url","text":"character dashboard URL content provided","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":null,"dir":"Reference","previous_headings":"","what":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"Returns URL content dashboard (opened selected pane). NOTE: takes character object performance optimization.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"","code":"dashboard_url_chr(connect_url, content_guid, pane = \"\")"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"connect_url character base URL Connect server content_guid character guid content item question pane character pane dashboard link ","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/dashboard_url_chr.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Build a Dashboard URL from Character Vectors — dashboard_url_chr","text":"character dashboard URL content provided","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete a runtime cache — delete_runtime_cache","title":"Delete a runtime cache — delete_runtime_cache","text":"Delete runtime cache Connect server. Requires Administrator privileges.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete a runtime cache — delete_runtime_cache","text":"","code":"delete_runtime_cache( client, language, version, image_name = \"Local\", dry_run = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete a runtime cache — delete_runtime_cache","text":"client Connect object. language language cache, either \"R\" \"Python\". version version cache, e.g. \"4.3.3\". image_name Optional. name -host execution image cache, \"Local\" (default) native execution caches. dry_run Optional, default FALSE. true, perform dry run deletion.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete a runtime cache — delete_runtime_cache","text":"Task object representing deletion task. dry_run TRUE, returns NULL throws error deletion fail.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_runtime_cache.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete a runtime cache — delete_runtime_cache","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() task <- delete_runtime_cache(client, \"R\", \"4.3.3\") poll_task(task) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete content item thumbnail — delete_thumbnail","title":"Delete content item thumbnail — delete_thumbnail","text":"Delete thumbnail content item Connect.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete content item thumbnail — delete_thumbnail","text":"","code":"delete_thumbnail(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete content item thumbnail — delete_thumbnail","text":"content content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Delete content item thumbnail — delete_thumbnail","text":"content item (invisibly).","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Delete content item thumbnail — delete_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") thumbnail <- get_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Delete the Vanity URL — delete_vanity_url","title":"Delete the Vanity URL — delete_vanity_url","text":"Deletes Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Delete the Vanity URL — delete_vanity_url","text":"","code":"delete_vanity_url(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/delete_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Delete the Vanity URL — delete_vanity_url","text":"content Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a bundle — deploy","title":"Deploy a bundle — deploy","text":"Deploys bundle (tarball) Posit Connect server. provided, name (unique identifier) auto-generated alphabetic string. deploying existing endpoint, can set name guid desired content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a bundle — deploy","text":"","code":"deploy( connect, bundle, name = create_random_name(), title = name, guid = NULL, ..., .pre_deploy = { } ) deploy_current(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a bundle — deploy","text":"connect Connect object bundle Bundle object name unique name content server title optional title used content server guid optional GUID content already exists server ... Additional arguments passed along content creation .pre_deploy expression execute deploying new bundle. variables content bundle_id supplied content Content object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy a bundle — deploy","text":"Task task object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Deploy a bundle — deploy","text":"function accepts arguments connectapi::content_update(). deploy_current() helper easily redeploy currently active bundle existing content item.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Deploy a bundle — deploy","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() # beware bundling big directories, like `renv/`, `data/`, etc. bnd <- bundle_dir(\".\") deploy(client, bnd) } # } client <- connect(prefix = \"TEST_1\") #> Defining Connect with server: http://localhost:32768 bnd <- bundle_path(system.file(\"tests/testthat/examples/static.tar.gz\", package = \"connectapi\")) #> Bundling path deploy(client, bnd) #> Getting content endpoint #> #> Uploading bundle #> Warning: 'raw = FALSE' but '/home/runner/work/connectapi/connectapi/docs/dev/reference' is not a regular file #> Warning: cannot open file '/home/runner/work/connectapi/connectapi/docs/dev/reference': it is a directory #> Error in file(body$path, \"rb\"): cannot open the connection"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":null,"dir":"Reference","previous_headings":"","what":"Deploy a Git Repository — deploy_repo","title":"Deploy a Git Repository — deploy_repo","text":"Deploy git repository directly Posit Connect, using Posit Connect's \"pull-based\" \"git-polling\" method deployment.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Deploy a Git Repository — deploy_repo","text":"","code":"deploy_repo( client, repository, branch, subdirectory, name = create_random_name(), title = name, ... ) deploy_repo_enable(content, enabled = TRUE) deploy_repo_update(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Deploy a Git Repository — deploy_repo","text":"client Connect R6 object repository git repository deploy branch git branch deploy subdirectory subdirectory deploy (must contain manifest.json) name \"name\" / unique identifier content. Defaults random character string title \"title\" content ... Additional options defining / specifying content attributes content R6 Content object (.e. result content_item()) enabled Whether Connect enable automatic polling repository updates","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Deploy a Git Repository — deploy_repo","text":"ContentTask object, use poll_task() (want follow logs)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/deploy_repo.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Deploy a Git Repository — deploy_repo","text":"deploy_repo_enable() enables (disables) Posit Connect's git polling piece content deploy_repo_update() triggers update content git repository, present","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":null,"dir":"Reference","previous_headings":"","what":"Download a Bundle from Deployed Connect Content — download_bundle","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"Downloads Content item's active bundle, (optionally) one bundles.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"","code":"download_bundle( content, filename = fs::file_temp(pattern = \"bundle\", ext = \".tar.gz\"), bundle_id = NULL, overwrite = FALSE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"content Content object filename Optional. output bundle path bundle_id Optional. string representing bundle_id download. NULL, use currently active bundle. overwrite Optional. Default FALSE. Whether overwrite target location already exists","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/download_bundle.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Download a Bundle from Deployed Connect Content — download_bundle","text":"Bundle bundle object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":null,"dir":"Reference","previous_headings":"","what":"Manage Environment Variables — get_environment","title":"Manage Environment Variables — get_environment","text":"Manage Environment Variables piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Manage Environment Variables — get_environment","text":"","code":"get_environment(content) set_environment_new(env, ...) set_environment_remove(env, ...) set_environment_all(env, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Manage Environment Variables — get_environment","text":"content R6 Content object returned content_item() env R6 Environment object returned get_environment() ... name = value pairs environment variable names values","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/environment.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Manage Environment Variables — get_environment","text":"get_environment() returns Environment object use \"setter\" methods set_environment_new() updates environment values (either creating new values updating existing). Set NA value remove variable. set_environment_remove() wrapper set_environment_new() allows removing named / listed variables quickly set_environment_all() sets environment variable values (remove variables specified)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Audit Logs from Posit Connect Server — get_audit_logs","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"Get Audit Logs Posit Connect Server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"","code":"get_audit_logs(src, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"src source object limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"tibble following columns: id: ID audit action time: Timestamp RFC3339 format action taken user_id: User ID actor made audit action user_description: Description actor action: Audit action taken event_description: Description action","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"Please see https://docs.posit.co/connect/api/#get-/v1/audit_logs information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_audit_logs.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Audit Logs from Posit Connect Server — get_audit_logs","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get the last 20 audit logs get_audit_logs(client, limit = 20, asc_order = FALSE) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Bundles — get_bundles","title":"Get Bundles — get_bundles","text":"Lists bundles content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Bundles — get_bundles","text":"","code":"get_bundles(content) delete_bundle(content, bundle_id)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_bundles.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Bundles — get_bundles","text":"content R6 Content item, returned content_item() bundle_id specific bundle ID content item","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":null,"dir":"Reference","previous_headings":"","what":"Get information about content on the Posit Connect server — get_content","title":"Get information about content on the Posit Connect server — get_content","text":"Get information content Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get information about content on the Posit Connect server — get_content","text":"","code":"get_content(src, guid = NULL, owner_guid = NULL, name = NULL, ..., .p = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get information about content on the Posit Connect server — get_content","text":"src Connect object guid guid particular content item owner_guid unique identifier user owns content name content name specified content created ... Extra arguments. Currently used. .p Optional. predicate function, passed -purrr::keep() turning response tibble. Can useful performance.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get information about content on the Posit Connect server — get_content","text":"tibble following columns: guid: unique identifier content item. name: simple, URL-friendly identifier. Allows alpha-numeric characters, hyphens (\"-\"), underscores (\"_\"). title: title content. description: rich description content access_type: Access type describes content manages viewers. may value , logged_in acl. value permissive; visitor Posit Connect able view content. value logged_in indicates Posit Connect accounts may view content. acl value lets specifically enumerated users groups view content. Users configured collaborators may always view content. connection_timeout: Maximum number seconds allowed without data sent received across client connection. value 0 means connections never time-(recommended). null, default Scheduler.ConnectionTimeout used. Applies content types executed demand. read_timeout: Maximum number seconds allowed without data received client connection. value 0 means lack client (browser) interaction never causes connection close. null, default Scheduler.ReadTimeout used. Applies content types executed demand. init_timeout: maximum number seconds allowed interactive application start. Posit Connect must able connect newly launched Shiny application, example, threshold elapsed. null, default Scheduler.InitTimeout used. Applies content types executed demand. idle_timeout: maximum number seconds worker process interactive application remain alive goes idle (active connections). null, default Scheduler.IdleTimeout used. Applies content types executed demand. max_processes: Specifies total number concurrent processes allowed single interactive application. null, default Scheduler.MaxProcesses setting used. Applies content types executed demand. min_processes: Specifies minimum number concurrent processes allowed single interactive application. null, default Scheduler.MinProcesses used. Applies content types executed demand. max_conns_per_process: Specifies maximum number client connections allowed individual process. Incoming connections exceed limit routed new process rejected. null, default Scheduler.MaxConnsPerProcess used. Applies content types executed demand. load_factor: Controls aggressively new processes spawned. null, default Scheduler.LoadFactor used. Applies content types executed demand. created_time: timestamp (RFC3339) indicating content created. last_deployed_time: timestamp (RFC3339) indicating content last successful bundle deployment performed. bundle_id: identifier active deployment bundle. Automatically assigned upon successful deployment bundle. app_mode: runtime model content. value unknown data deployed item. Automatically assigned upon first successful bundle deployment. Allowed: api, jupyter-static, python-api, python-bokeh, python-dash, python-streamlit, rmd-shiny, rmd-static, shiny, static, tensorflow-saved-model, unknown. content_category: Describes specialization content runtime model. Automatically assigned upon first successful bundle deployment. parameterized: True R Markdown rendered content allows parameter configuration. Automatically assigned upon first successful bundle deployment. Applies content app_mode rmd-static. r_version: version R interpreter associated content. value null represents R interpreter used content R package environment successfully restored. Automatically assigned upon successful deployment bundle. py_version: version Python interpreter associated content. value null represents Python interpreter used content Python package environment successfully restored. Automatically assigned upon successful deployment bundle. run_as: UNIX user executes content. null, default Applications.RunAs used. Applies executable content types - static. run_as_current_user: Indicates content allowed execute logged-user using PAM authentication. Applies executable content types - static. owner_guid: unique identifier owner content_url: URL associated content. Computed associated vanity URL GUID content. dashboard_url: URL within Connect dashboard content can configured. Computed GUID content. role: relationship accessing user content. value owner returned content owner. editor indicates collaborator. viewer value given users permitted view content. none role returned administrators view content permitted view configuration. Computed time request. id: internal numeric identifier content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get information about content on the Posit Connect server — get_content","text":"Please see https://docs.posit.co/connect/api/#get-/v1/content information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_content.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get information about content on the Posit Connect server — get_content","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() get_content(client) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":null,"dir":"Reference","previous_headings":"","what":"Get users within a specific group — get_group_members","title":"Get users within a specific group — get_group_members","text":"Get users within specific group","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get users within a specific group — get_group_members","text":"","code":"get_group_members(src, guid)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get users within a specific group — get_group_members","text":"src source object guid group GUID identifier","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get users within a specific group — get_group_members","text":"tibble following columns: email: user's email username: user's username first_name: user's first name last_name: user's last name user_role: user's role. may value administrator, publisher viewer. created_time: timestamp (RFC3339 format) user created Posit Connect server updated_time: timestamp (RFC3339 format) user last updated Posit Connect server active_time: timestamp (RFC3339 format) user last active Posit Connect server confirmed: false, created user must confirm account email. feature unique password authentication. locked: Whether user locked guid: user's GUID, unique identifier, UUID RFC4122 format","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get users within a specific group — get_group_members","text":"Please see https://docs.posit.co/connect/api/#get-/v1/groups/-group_guid-/members information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_group_members.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get users within a specific group — get_group_members","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get the first 20 groups groups <- get_groups(client) group_guid <- groups$guid[1] get_group_members(client, guid = group_guid) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":null,"dir":"Reference","previous_headings":"","what":"Get group information from the Posit Connect server — get_groups","title":"Get group information from the Posit Connect server — get_groups","text":"Get group information Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get group information from the Posit Connect server — get_groups","text":"","code":"get_groups(src, page_size = 500, prefix = NULL, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get group information from the Posit Connect server — get_groups","text":"src source object. page_size number records return per page (max 500). prefix Filters groups prefix (group name). filter case insensitive. limit number groups retrieve paging stops. limit ignored prefix NULL. limit results prefix NULL, change page_size.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get group information from the Posit Connect server — get_groups","text":"tibble following columns: guid: unique identifier group name: group name owner_guid: group owner's unique identifier. using LDAP Proxied authentication group provisioning enabled property always null.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get group information from the Posit Connect server — get_groups","text":"Please see https://docs.posit.co/connect/api/#get-/v1/groups information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_groups.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get group information from the Posit Connect server — get_groups","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get all groups get_groups(client, limit = Inf) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Content Image — get_image","title":"Get the Content Image — get_image","text":"Please use get_thumbnail, delete_thumbnail, has_thumbnail instead. get_image saves content image given path (default: temp file). delete_image removes image (optionally saving given path) has_image returns whether content image","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Content Image — get_image","text":"","code":"get_image(content, path = NULL) delete_image(content, path = NULL) has_image(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Content Image — get_image","text":"content content object path optional. path image disk","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":null,"dir":"Reference","previous_headings":"","what":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"Perform OAuth credential exchange obtain viewer's OAuth access token.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"","code":"get_oauth_credentials(connect, user_session_token)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"connect Connect R6 object. user_session_token content viewer's session token. token can obtained content running Connect server. token identifies user viewing content interactively Connect server. Read value HTTP header: Posit-Connect-User-Session-Token","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"OAuth credential exchange response.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"Please see https://docs.posit.co/connect/user/oauth-integrations/#obtaining--viewer-oauth-access-token information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_oauth_credentials.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Perform an OAuth credential exchange to obtain a viewer's OAuth access token. — get_oauth_credentials","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) library(plumber) client <- connect() #* @get /do function(req) { user_session_token <- req$HTTP_POSIT_CONNECT_USER_SESSION_TOKEN credentials <- get_oauth_credentials(client, user_session_token) # ... do something with `credentials$access_token` ... \"done\" } } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Real-Time Process Data — get_procs","title":"Get Real-Time Process Data — get_procs","text":"returns real-time process data Posit Connect API. requires administrator privileges use. NOTE returns data server responds request (.e. Highly Available cluster)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Real-Time Process Data — get_procs","text":"","code":"get_procs(src)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Real-Time Process Data — get_procs","text":"src source object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_procs.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Real-Time Process Data — get_procs","text":"tibble following columns: pid: PID current process appId: application ID appGuid: application GUID appName: application name appUrl: application URL appRunAs: application RunAs user type: type process cpuCurrent: current CPU usage cpuTotal: total CPU usage ram: current RAM usage","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":null,"dir":"Reference","previous_headings":"","what":"Get runtime caches — get_runtime_caches","title":"Get runtime caches — get_runtime_caches","text":"View runtime caches Connect server. Requires Administrator privileges.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get runtime caches — get_runtime_caches","text":"","code":"get_runtime_caches(client)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get runtime caches — get_runtime_caches","text":"client Connect object.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get runtime caches — get_runtime_caches","text":"tibble runtime caches server, showing language, version image_name. Connect servers using -host execution, image_name \"Local\".","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtime_caches.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get runtime caches — get_runtime_caches","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() get_runtime_caches(client) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":null,"dir":"Reference","previous_headings":"","what":"Get available runtimes on server — get_runtimes","title":"Get available runtimes on server — get_runtimes","text":"Get table showing available versions R, Python, Quarto, Tensorflow Connect server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get available runtimes on server — get_runtimes","text":"","code":"get_runtimes(client, runtimes = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get available runtimes on server — get_runtimes","text":"client Connect object. runtimes Optional. character vector runtimes include. Must combination \"r\", \"python\", \"quarto\", \"tensorflow\". Quarto supported Connect >= 2021.08.0, Tensorflow supported Connect >= 2024.03.0.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get available runtimes on server — get_runtimes","text":"tibble columns runtime, version, cluster_name image_name. Cluster name image name meaningful Connect instances running -host execution.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_runtimes.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get available runtimes on server — get_runtimes","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() get_runtimes(client, runtimes = c(\"r\", \"python\", \"tensorflow\")) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Get content item thumbnail — get_thumbnail","title":"Get content item thumbnail — get_thumbnail","text":"Download thumbnail content item Connect file computer.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get content item thumbnail — get_thumbnail","text":"","code":"get_thumbnail(content, path = NULL)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get content item thumbnail — get_thumbnail","text":"content content item. path Optional. path file used write thumbnail image. path provided, temporary file correct file extension created.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get content item thumbnail — get_thumbnail","text":"path downloaded image file, content thumbnail; otherwise NA.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get content item thumbnail — get_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") thumbnail <- get_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":null,"dir":"Reference","previous_headings":"","what":"Get TimeZones — get_timezones","title":"Get TimeZones — get_timezones","text":"Get available timezones server.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get TimeZones — get_timezones","text":"","code":"get_timezones(connect)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get TimeZones — get_timezones","text":"connect R6 Connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_timezones.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get TimeZones — get_timezones","text":"TimeZone vector used setting time zones","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":null,"dir":"Reference","previous_headings":"","what":"Get usage information for deployed shiny applications — get_usage_shiny","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"Get usage information deployed shiny applications","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"","code":"get_usage_shiny( src, content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"src source object content_guid Filter results content GUID min_data_version Filter data version. Records data version lower given value excluded set results. timestamp starts time window interest. usage information ends prior timestamp returned. Individual records may contain starting time end finished. Must class Date POSIX timestamp ends time window interest. usage information starts timestamp returned. Individual records may contain ending time (ending time) start . Must class Date POSIX limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"tibble following columns: content_guid: GUID, RFC4122 format, Shiny application information pertains . user_guid: GUID, RFC4122 format, user visited application. started: timestamp, RFC3339 format, user opened application. ended: timestamp, RFC3339 format, user left application. data_version: data version record recorded . Shiny Application Events section Posit Connect Admin Guide explains interpret data_version values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/shiny/usage information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_shiny.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get usage information for deployed shiny applications — get_usage_shiny","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() from <- Sys.Date() - lubridate::days(5) get_usage_shiny(client, limit = 20, from = from) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":null,"dir":"Reference","previous_headings":"","what":"Get usage information from deployed static content — get_usage_static","title":"Get usage information from deployed static content — get_usage_static","text":"function retrieves usage information static content Posit Connect server (e.g. Rmarkdown, Jupyter Notebooks)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get usage information from deployed static content — get_usage_static","text":"","code":"get_usage_static( src, content_guid = NULL, min_data_version = NULL, from = NULL, to = NULL, limit = 500, previous = NULL, nxt = NULL, asc_order = TRUE )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get usage information from deployed static content — get_usage_static","text":"src source object content_guid Filter results content GUID min_data_version Filter data version. Records data version lower given value excluded set results. timestamp starts time window interest. usage information ends prior timestamp returned. Individual records may contain starting time end finished. Must class Date POSIX timestamp ends time window interest. usage information starts timestamp returned. Individual records may contain ending time (ending time) start . Must class Date POSIX limit number records return. previous Retrieve previous page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. nxt Retrieve next page Shiny application usage logs relative provided value. value corresponds internal reference within server sourced appropriate attribute within paging object previous response. asc_order Defaults TRUE; Determines response records listed ascending descending order within response. Ordering started timestamp field.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get usage information from deployed static content — get_usage_static","text":"tibble following columns: content_guid: GUID, RFC4122 format, Shiny application information pertains . user_guid: GUID, RFC4122 format, user visited application. variant_key: key variant user visited. null static content. time: timestamp, RFC3339 format, user visited content. rendering_id: ID rendering user visited. null static content. bundle_id: ID particular bundle used. data_version: data version record recorded . Rendered Static Content Visit Events section Posit Connect Admin Guide explains interpret data_version values.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get usage information from deployed static content — get_usage_static","text":"Please see https://docs.posit.co/connect/api/#get-/v1/instrumentation/content/visits information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_usage_static.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get usage information from deployed static content — get_usage_static","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() from <- Sys.Date() - lubridate::days(5) get_usage_static(client, limit = 20, from = from) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":null,"dir":"Reference","previous_headings":"","what":"Get user information from the Posit Connect server — get_users","title":"Get user information from the Posit Connect server — get_users","text":"Get user information Posit Connect server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get user information from the Posit Connect server — get_users","text":"","code":"get_users(src, page_size = 500, prefix = NULL, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get user information from the Posit Connect server — get_users","text":"src source object page_size number records return per page (max 500) prefix Filters users prefix (username, first name, last name). filter case insensitive. limit max number records return","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get user information from the Posit Connect server — get_users","text":"tibble following columns: email: user's email username: user's username first_name: user's first name last_name: user's last name user_role: user's role. may value administrator, publisher viewer. created_time: timestamp (RFC3339 format) user created Posit Connect server updated_time: timestamp (RFC3339 format) user last updated Posit Connect server active_time: timestamp (RFC3339 format) user last active Posit Connect server confirmed: false, created user must confirm account email. feature unique password authentication. locked: Whether user locked guid: user's GUID, unique identifier, UUID RFC4122 format","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get user information from the Posit Connect server — get_users","text":"Please see https://docs.posit.co/connect/api/#get-/v1/users information.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_users.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get user information from the Posit Connect server — get_users","text":"","code":"if (FALSE) { # \\dontrun{ library(connectapi) client <- connect() # get all users get_users(client, limit = Inf) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Get the Vanity URL — get_vanity_url","title":"Get the Vanity URL — get_vanity_url","text":"Gets Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get the Vanity URL — get_vanity_url","text":"","code":"get_vanity_url(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get the Vanity URL — get_vanity_url","text":"content Content object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_vanity_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get the Vanity URL — get_vanity_url","text":"character string (NULL defined)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":null,"dir":"Reference","previous_headings":"","what":"Get a Variant Schedule — get_variant_schedule","title":"Get a Variant Schedule — get_variant_schedule","text":"Gets schedule associated Variant.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get a Variant Schedule — get_variant_schedule","text":"","code":"get_variant_schedule(variant)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get a Variant Schedule — get_variant_schedule","text":"variant Variant object, returned get_variant() get_variant_default()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/get_variant_schedule.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get a Variant Schedule — get_variant_schedule","text":"VariantSchedule object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":null,"dir":"Reference","previous_headings":"","what":"Git Repository Helpers — git","title":"Git Repository Helpers — git","text":"functions help use Posit Connect's configured authorization query available branches subdirectories deployment using deploy_repo()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Git Repository Helpers — git","text":"","code":"repo_check_account(client, host) repo_check_branches(client, repository) repo_check_branches_ref(client, repository) repo_check_manifest_dirs(client, repository, branch)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Git Repository Helpers — git","text":"client Connect R6 object host git repository host (schema). example, \"https://github.com\" repository git repository explore consider deploying branch git branch explore subdirectories","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/git.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Git Repository Helpers — git","text":"repo_check_account() messages whether account use, returns account repo_check_branches() retrieves branches available, returning named list repo_check_manifest_dirs() retrieves directories contain manifest.json, returning named list","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Remote Group — groups_create_remote","title":"Create a Remote Group — groups_create_remote","text":"Create Remote Group","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Remote Group — groups_create_remote","text":"","code":"groups_create_remote(connect, prefix, expect = 1, check = TRUE, exact = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Remote Group — groups_create_remote","text":"connect R6 Connect object. prefix character. prefix user name search . expect number. Optional. number responses expect search. check boolean. Optional. Whether check local existence first. exact boolean. Optional. Whether create groups whose name exactly matches provided prefix.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/groups_create_remote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Remote Group — groups_create_remote","text":"results creating groups.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Check content item thumbnail — has_thumbnail","title":"Check content item thumbnail — has_thumbnail","text":"Check whether content item thumbnail.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check content item thumbnail — has_thumbnail","text":"","code":"has_thumbnail(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check content item thumbnail — has_thumbnail","text":"content content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check content item thumbnail — has_thumbnail","text":"TRUE content item thumbnail, otherwise FALSE. Throws error permission view thumbnail.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/has_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check content item thumbnail — has_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") has_thumbnail(item) } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Jobs — get_jobs","title":"Get Jobs — get_jobs","text":"Retrieve details jobs associated content_item. \"Jobs\" Posit Connect content executions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Jobs — get_jobs","text":"","code":"get_jobs(content) get_job(content, key)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/jobs.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Jobs — get_jobs","text":"content Content object, returned content_item() key key job","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":null,"dir":"Reference","previous_headings":"","what":"Paging — page_cursor","title":"Paging — page_cursor","text":"Helper functions make paging easier Posit Connect Server API. Helper functions make paging easier Posit Connect Server API.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Paging — page_cursor","text":"","code":"page_cursor(client, req, limit = Inf) page_offset(client, req, limit = Inf)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Paging — page_cursor","text":"client Connect client object req request needs paged limit row limit","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/paging.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Paging — page_cursor","text":"aggregated results requests aggregated results requests","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":null,"dir":"Reference","previous_headings":"","what":"Content permissions — permissions","title":"Content permissions — permissions","text":"Get set content permissions content item","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Content permissions — permissions","text":"","code":"content_add_user(content, guid, role = c(\"viewer\", \"owner\")) content_add_group(content, guid, role = c(\"viewer\", \"owner\")) content_delete_user(content, guid) content_delete_group(content, guid) get_user_permission(content, guid, add_owner = TRUE) get_my_permission(content, add_owner = TRUE) get_group_permission(content, guid) get_content_permissions(content, add_owner = TRUE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Content permissions — permissions","text":"content R6 content object guid guid associated either user (content_add_user) group (content_add_group) role role assign user. Either \"viewer\" \"owner.\" Defaults \"viewer\" add_owner Optional. Whether include owner returned permission sets. Default TRUE. owner NA_character_ permission \"id\"","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/permissions.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Content permissions — permissions","text":"Permission modification: content_add_* adds permission content content_delete_* removes permission content Permission retrieval: get_content_permissions() lists permissions get_my_permission() gets permission associated caller. get_user_permission() gets permissions associated given user. evaluate group memberships get_group_permission() gets permissions associated given group. NOTE: default, owner injected \"NA_character_\" permission id. makes easier find / isolate record.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/pipe.html","id":null,"dir":"Reference","previous_headings":"","what":"Pipe operator — %>%","title":"Pipe operator — %>%","text":"See magrittr::[\\%>\\%][magrittr::\\%>\\%] details.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/pipe.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Pipe operator — %>%","text":"","code":"lhs %>% rhs"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":null,"dir":"Reference","previous_headings":"","what":"Poll Task — poll_task","title":"Poll Task — poll_task","text":"Polls task, waiting information deployment. task results, output modified \"Task\" object task$get_data() available retrieve results.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Poll Task — poll_task","text":"","code":"poll_task(task, wait = 1, callback = message)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Poll Task — poll_task","text":"task Task object wait interval wait polling callback function called message received. Set NULL callback","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Poll Task — poll_task","text":"Task Task object input","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/poll_task.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Poll Task — poll_task","text":"simple way silence messages, set callback = NULL","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":null,"dir":"Reference","previous_headings":"","what":"Promote content from one Connect server to another — promote","title":"Promote content from one Connect server to another — promote","text":"Promote content one Connect server another","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Promote content from one Connect server to another — promote","text":"","code":"promote(from, to, to_key, from_key, name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Promote content from one Connect server to another — promote","text":"url server containing content (originating server) url server content deployed (destination server) to_key API key destination \"\" server. destination content going updated, API key must belong user collaborator access content updated. destination content created new, API key must belong user publisher privileges. from_key API key originating \"\" server. API key must belong user collaborator access content promoted. name name content originating \"\" server. content name found destination server, content updated. content destination server matching name, new endpoint created.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/promote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Promote content from one Connect server to another — promote","text":"URL content destination \"\" server","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Content Image — set_image_path","title":"Set the Content Image — set_image_path","text":"Please use set_thumbnail instead. Set Content Image using variety methods.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Content Image — set_image_path","text":"","code":"set_image_path(content, path) set_image_url(content, url) set_image_webshot(content, ...)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Content Image — set_image_path","text":"content content object path path image disk url url image ... Additional arguments passed webshot2::webshot()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_image.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set the Content Image — set_image_path","text":"NOTE: set_image_webshot() requires webshot2::webshot(), currently skips warns content requires authentication webshot2 package supports authentication.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":null,"dir":"Reference","previous_headings":"","what":"Set RunAs User — set_run_as","title":"Set RunAs User — set_run_as","text":"Set RunAs user piece content. run_as_current_user flag anything :","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set RunAs User — set_run_as","text":"","code":"set_run_as(content, run_as, run_as_current_user = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set RunAs User — set_run_as","text":"content R6 Content item run_as RunAs user use content run_as_current_user Whether run content viewer application","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set RunAs User — set_run_as","text":"Content object, updated new details","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_run_as.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set RunAs User — set_run_as","text":"PAM authentication method Applications.RunAsCurrentUser enabled server Also worth noting run_as user must exist Posit Connect server (linux user) appropriate group memberships, get 400: Bad Request. Set NULL use default RunAs user / unset current configuration. \"read\" current RunAs user, use Content object get_content() function.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":null,"dir":"Reference","previous_headings":"","what":"Set a Schedule — set_schedule","title":"Set a Schedule — set_schedule","text":"Sets schedule given Variant. Requires Schedule object (returned get_variant_schedule())","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set a Schedule — set_schedule","text":"","code":"set_schedule(.schedule, ...) set_schedule_minute( .schedule, n = 30, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_hour( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_day( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_weekday( .schedule, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_week( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayofweek( .schedule, days, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_semimonth( .schedule, first = TRUE, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayofmonth( .schedule, n = 1, day = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_dayweekofmonth( .schedule, n = 1, day = 1, week = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_year( .schedule, n = 1, start_time = Sys.time(), activate = TRUE, email = FALSE, timezone = Sys.timezone() ) set_schedule_remove(.schedule) schedule_describe(.schedule)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set a Schedule — set_schedule","text":".schedule schedule object. returned get_variant_schedule() ... Scheduling parameters n \"number \" iterations start_time start time schedule activate Whether publish output schedule email Whether send emails schedule timezone timezone use setting schedule. Defaults Sys.timezone() days days week (0-6) first logical Whether execute 1st 15th (TRUE) 14th last (FALSE) day day week (0-6) day month (0-31) week week month (0-5) schedule JSON blob (string) describing schedule. See \"Details\"","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set a Schedule — set_schedule","text":"updated Schedule object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_schedule.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Set a Schedule — set_schedule","text":"set_schedule() raw interface Posit Connect's schedule API set_schedule_*() functions provide handy wrappers around set_schedule() set_schedule_remove() removes schedule / un-schedules variant Beware, using set_schedule() currently uses Posit Connect schedule API directly, can little clunky. Using set_schedule_*() generally recommended.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":null,"dir":"Reference","previous_headings":"","what":"Set content item thumbnail — set_thumbnail","title":"Set content item thumbnail — set_thumbnail","text":"Set thumbnail content item.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set content item thumbnail — set_thumbnail","text":"","code":"set_thumbnail(content, path)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set content item thumbnail — set_thumbnail","text":"content content item. path Either path local file URL image available HTTP/HTTPS. path HTTP HTTPS URL, image first downloaded.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set content item thumbnail — set_thumbnail","text":"content item (invisibly).","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_thumbnail.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set content item thumbnail — set_thumbnail","text":"","code":"if (FALSE) { # \\dontrun{ client <- connect() item <- content_item(client, \"8f37d6e0-3395-4a2c-aa6a-d7f2fe1babd0\") set_thumbnail(item, \"resources/image.png\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Set the Vanity URL — set_vanity_url","title":"Set the Vanity URL — set_vanity_url","text":"Sets Vanity URL piece content.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set the Vanity URL — set_vanity_url","text":"","code":"set_vanity_url(content, url, force = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set the Vanity URL — set_vanity_url","text":"content Content object url path component URL force optional. Default FALSE. Whether force-reassign vanity URL already exists","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set the Vanity URL — set_vanity_url","text":"updated Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/set_vanity_url.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set the Vanity URL — set_vanity_url","text":"","code":"if (FALSE) { # \\dontrun{ bnd <- bundle_dir(\"~/my/directory\") connect() %>% deploy(bnd) %>% set_vanity_url(\"a/vanity/url\") } # }"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":null,"dir":"Reference","previous_headings":"","what":"Swap the Vanity URL — swap_vanity_url","title":"Swap the Vanity URL — swap_vanity_url","text":"Swaps Vanity URLs two pieces content","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Swap the Vanity URL — swap_vanity_url","text":"","code":"swap_vanity_url(from_content, to_content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/swap_vanity_url.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Swap the Vanity URL — swap_vanity_url","text":"from_content Content object to_content Content object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":null,"dir":"Reference","previous_headings":"","what":"Get all Tags on the server — get_tags","title":"Get all Tags on the server — get_tags","text":"Tag manipulation assignment functions","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get all Tags on the server — get_tags","text":"","code":"get_tags(src) get_tag_data(src) create_tag(src, name, parent = NULL) create_tag_tree(src, ...) delete_tag(src, tag) get_content_tags(content) set_content_tag_tree(content, ...) set_content_tags(content, ...) filter_tag_tree_id(tags, ids) filter_tag_tree_chr(tags, pattern)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tags.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get all Tags on the server — get_tags","text":"src source object name name tag create parent optional. connect_tag_tree object (returned get_tags()) pointed parent tag ... Additional arguments Manage tags (requires Administrator role): get_tags() - returns \"tag tree\" object can traversed tag_tree$tag1$childtag get_tag_data() - returns tibble tag data create_tag() - create tag specifying Parent directly create_tag_tree() - create tag(s) specifying \"desired\" tag tree hierarchy delete_tag() - delete tag (children). WARNING: disassociate content automatically Manage content tags: get_content_tags() - return connect_tag_tree object corresponding tags piece content. set_content_tag_tree() - attach tag content specifying desired tag tree set_content_tags() - Set multiple tags providing connect_tag_tree objects Search tag tree: filter_tag_tree_chr() - filters tag tree based regex filter_tag_tree_id() - filters tag tree based id tag connect_tag_tree object (returned get_tags()) content R6 Content object, returned content_item() tags connect_tag_tree object (returned get_tags()) ids list ids filter tag tree pattern regex filter tag tree (passed grepl)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":null,"dir":"Reference","previous_headings":"","what":"Connect Tibble — tbl_connect","title":"Connect Tibble — tbl_connect","text":"lazy tibble automatically pages API requests collected.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Connect Tibble — tbl_connect","text":"","code":"tbl_connect( src, from = c(\"users\", \"groups\", \"content\", \"usage_shiny\", \"usage_static\", \"audit_logs\"), ... )"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Connect Tibble — tbl_connect","text":"src source object type tibble ... Additional arguments yet implemented","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/tbl_connect.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Connect Tibble — tbl_connect","text":"tbl_connect object","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":null,"dir":"Reference","previous_headings":"","what":"User — user_guid_from_username","title":"User — user_guid_from_username","text":"Get user details","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"User — user_guid_from_username","text":"","code":"user_guid_from_username(client, username)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"User — user_guid_from_username","text":"client Connect R6 object username user's username","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/user.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"User — user_guid_from_username","text":"user_guid_from_username() helper retrieve user GUID, given user's username. useful Shiny applications using session$user","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":null,"dir":"Reference","previous_headings":"","what":"Create a Remote User — users_create_remote","title":"Create a Remote User — users_create_remote","text":"remote user creation workflow involves authentication providers like LDAP involve queryable identity store. helper wraps API calls necessary retrieve information create user. functions \"fuzzy match\" prefix default, want instantiate users directly, set exact = TRUE.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create a Remote User — users_create_remote","text":"","code":"users_create_remote(connect, prefix, expect = 1, check = TRUE, exact = FALSE)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create a Remote User — users_create_remote","text":"connect R6 Connect object. prefix character. prefix user name search . expect number. Optional. number responses expect search. check boolean. Optional. Whether check local existence first. exact boolean. Optional. Whether create users whose username exactly matches provided prefix.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create a Remote User — users_create_remote","text":"results creating users.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/users_create_remote.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Create a Remote User — users_create_remote","text":"NOTE: can problems usernames unique. Please open issue run problems.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"","code":"vanity_is_available(connect, vanity)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"connect Connect R6 object vanity string vanity URL check","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/vanity_is_available.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check to see if a vanity URL is currently in use — vanity_is_available","text":"logical indicating vanity URL available.","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Variant — get_variants","title":"Get Variant — get_variants","text":"Work variants","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Variant — get_variants","text":"","code":"get_variants(content) get_variant(content, key) get_variant_default(content)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Variant — get_variants","text":"content R6 Content object. Returned content_item() key Variant key specific variant","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Get Variant — get_variants","text":"get_variants() returns tibble variant data content_item get_variant_default() returns default variant content_item get_variant() returns specific variant content_item (specified key)","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":null,"dir":"Reference","previous_headings":"","what":"Render a Variant — get_variant_renderings","title":"Render a Variant — get_variant_renderings","text":"Get details renderings (.e. render history) execute variant demand","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render a Variant — get_variant_renderings","text":"","code":"get_variant_renderings(variant) variant_render(variant)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render a Variant — get_variant_renderings","text":"variant R6 Variant object. returned get_variant() get_variant_default()","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/variant_render.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Render a Variant — get_variant_renderings","text":"get_variant_renderings() returns renderings / content particular variant. Returns tibble variant_render() executes variant demand. Returns VariantTask object","code":""},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Verify Content Name — verify_content_name","title":"Verify Content Name — verify_content_name","text":"Ensures content name fits specifications / requirements Posit Connect. Throws error content name invalid. Content names (time writing) must 3 64 alphanumeric characters, dashes, underscores","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Verify Content Name — verify_content_name","text":"","code":"verify_content_name(name)"},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Verify Content Name — verify_content_name","text":"name proposed content name","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/reference/verify_content_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Verify Content Name — verify_content_name","text":"name (error invalid)","code":""},{"path":[]},{"path":[]},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-030","dir":"Changelog","previous_headings":"","what":"connectapi 0.3.0","title":"connectapi 0.3.0","text":"CRAN release: 2024-09-05","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-changes-0-3-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"connectapi 0.3.0","text":"GET_URL(), GET_RESULT(), GET_RESULT_URL() eliminated favor GET() (#274). .empty_object argument removed PUT/PATCH/POST (#274).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"new-features-0-3-0","dir":"Changelog","previous_headings":"","what":"New features","title":"connectapi 0.3.0","text":"New content_render() content_restart() functions. content_render() allows programmatically re-render content Quarto R Markdown reports Jupyter notebooks, optionally passing variant_key render specific variant parameterized content. content_restart() lets restart interactive content, Shiny applications, APIs, dashboards (#283, #289) New get_oauth_credentials() function interacting Connect’s /v1/oauth/integrations/credentials endpoint. endpoint allows content running Posit Connect obtain content viewer’s OAuth access token (#297).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"minor-improvements-and-fixes-0-3-0","dir":"Changelog","previous_headings":"","what":"Minor improvements and fixes","title":"connectapi 0.3.0","text":"Timestamps non-zero offsets received Connect longer parse NA (#290). Timestamps sent Connect now correctly converted UTC, instead simply labeled GMT (#291). Functions render variants email reports now contain request query Connect expects (#277). HTTP verb functions can take URL, just one relative API root, can optionally return httr_response object (#274).","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-020","dir":"Changelog","previous_headings":"","what":"connectapi 0.2.0","title":"connectapi 0.2.0","text":"CRAN release: 2024-06-06","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-changes-0-2-0","dir":"Changelog","previous_headings":"","what":"Breaking changes","title":"connectapi 0.2.0","text":"previously deprecated functions now removed. functions Connect$download_bundle() Connect$bundle_delete() removed. Use Content$bundle_download() Content$bundle_delete() instead. audit_vanity_urls() removed. check vanity URL use, use vanity_is_available() instead. audit_* functions modified accept result get_content() rather cache_apps() (now removed). faster result. dplyr longer required dependency. use tbl_connect(), need install dplyr dbplyr explicitly. (#246)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"enhancements-and-fixes-0-2-0","dir":"Changelog","previous_headings":"","what":"Enhancements and fixes","title":"connectapi 0.2.0","text":"package now tested many versions Connect, back 1.8.8.2 (May 2021). now fewer warnings version mismatches: see warning Connect server older . (#244) Now correctly provides methods tbl_connect, rather tbl_lazy, preventing problems also using dplyr (#177). progress now optional dependency. show pretty progress bars, install package explicitly. (#269) Content$tag_delete() removes tag target content item rather removing tag entirely. (#194) audit_r_versions() returns bar chart instead histogram (#179) Fix issue NULL length 1 job outputs (#193) Timestamp parsing now correctly preserves time components (#259)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0131","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.3.1","title":"connectapi 0.1.3.1","text":"CRAN release: 2023-02-02 Fix generated documentation HTML CRAN submission","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-013","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.3","title":"connectapi 0.1.3","text":"RStudioConnect documentation now PositConnect Fix purrr deprecated changes","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-012","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.2","title":"connectapi 0.1.2","text":"CRAN release: 2022-09-30 Update docs illustrate customizing HTTP requests (#168) Fix issue HTML documentation retain CRAN (#164) Fix typo min_data_version parameter usage data functions (#166) Bump Connect tested version 2022.09.0 (#170)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0111","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.1.1","title":"connectapi 0.1.1.1","text":"CRAN release: 2022-07-21","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"breaking-0-1-1-1","dir":"Changelog","previous_headings":"","what":"BREAKING","title":"connectapi 0.1.1.1","text":"set_vanity_url(), get_vanity_url(), swap_vanity_url() get_tags(), get_tag_data(), get_content_tags(), create_tag(), create_tag_tree(), delete_tag(), get_content_tags(), set_content_tags(), set_content_tag_tree(), filter_tag_tree_id(), filter_tag_tree_chr(), set_environment_new(), get_environment(), set_environment_remove(), download_bundle() tag ids now character strings (integers) instead integers true connect() function, although warn argument deprecation case. (#125) BREAKING: set_environment_new() set_environment_remove() longer take .version argument, output data structure bit different (list names). now use public API, changes interface bit. Also, intricacies set / remove environment variables changed (.e. setting VAR=NA remove VAR). (#141) get_vanity_url() now returns character string representing vanity url use (NULL defined) set_vanity_url() still returns Vanity R6 object, vanity$get_vanity()$path_prefix now vanity$get_vanity()$path BREAKING: tag_page() tag_page_iframe() removed. Similar functions belong connectwidgets package future. .e. bundle_id become id response data. others, url become content_url. R6 method content$get_bundles() longer takes page_number argument, get_bundles(limit) argument now deprecated (#129) Connect$download_bundle now deprecated favor Content$bundle_download(), delete_bundle() now takes Content item instead Connect. (#153) BREAKING: acl_*() functions deprecated favor get_content_permissions(), content_add_user(), friends. BREAKING: Connect$PUT(), Connect$POST() Connect$PATCH() endpoints now presume empty list really “map”/“object” (like {} instead []). can break endpoints expect list. Set .empty_object=FALSE avoid behavior.","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"other-changes-0-1-1-1","dir":"Changelog","previous_headings":"","what":"Other Changes","title":"connectapi 0.1.1.1","text":"users_create_remote() gains exact argument simplify complex cases (#135). Long term, solicit feedback whether function attempts much. Add helpers common content modification actions: content_update(), content_update_access_type() content_update_owner() Fix issue relative paths bundle_dir() (@slodge) (#118, #121) Add overwrite= parameter download_bundle() Add HTTP request customization options, related documentation (#101) Add git deployment (#112) R6 support multiple inheritance, keep Task interface --date ContentTask VariantTask manually Improve several print methods (#18, #19) Protect bad bundles (#13) Error empty API key defined (#16) content_list_with_permissions returns content_list “permission” column includes access content_list_by_tag allows fetching just content_list particular tag content_list_guid_has_access filters “content list permission” whether user group GUID access Add user_guid_from_username() function convert session$user usernames user GUID (#130)","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0109018","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0.9018","title":"connectapi 0.1.0.9018","text":"Add client$PATCH verb Switch Content$update() use PATCH (depends RStudio Connect 1.8.6+) Add error messaging new API endpoints using older versions Connect Fail gracefully /protocol http/https defined","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-0109017","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0.9017","title":"connectapi 0.1.0.9017","text":"BREAKING: * Switch RSTUDIO_CONNECT_* variables CONNECT_* variables * Rename handful functions: - connect$activate_bundle connect$content_deploy - connect$create_app connect$content_create - connect$upload_bundle connect$content_upload - connect$get_users connect$users * Change return types consistent API - connect$content_upload returns response instead bundle_id - connect$content_deploy returns response instead task_id * Switch endpoints using app_id guid * get_task$start renamed get_task$first * promote$app_name renamed promote$name * rename package connectapi * change functions take Connect object instead server / api key - cache_apps - tag_page : * Add endpoints: - content - audit_logs - server_settings - server_settings_r - inst_shiny_usage - inst_content_visits * Add helper functions: - swap_vanity_url, deployment functions - browse_ family functions - users_create_remote groups_create_remote remote users/groups * Update Connect R6 object compatible Connect 1.7.0+ APIs * Added NEWS.md file track changes package. * Add integration testing protect regressions * Add tbl_connect() lazy_tbl querying Connect API endpoints * Add get_* functions alternatives lazy_tbl","code":""},{"path":"https://pkgs.rstudio.com/connectapi/dev/news/index.html","id":"connectapi-010","dir":"Changelog","previous_headings":"","what":"connectapi 0.1.0","title":"connectapi 0.1.0","text":"Initial package version Create Connect R6 object","code":""}]