/
purgeApp.R
39 lines (37 loc) · 1.19 KB
/
purgeApp.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#' Purge an Application
#'
#' Purge a currently archived ShinyApps application.
#'
#' @param appName Name of application to purge
#' @param account Account name. If a single account is registered on the system
#' then this parameter can be omitted.
#' @param server Server name. Required only if you use the same account name on
#' multiple servers (see [servers()])
#' @param quiet Request that no status information be printed to the console
#' during the termination.
#'
#' @note This function only works for ShinyApps servers.
#'
#' @examples
#' \dontrun{
#'
#' # purge an application
#' purgeApp("myapp")
#' }
#' @seealso [applications()], [deployApp()], and
#' [restartApp()]
#' @export
purgeApp <- function(appName, account = NULL, server = NULL,
quiet = FALSE) {
accountDetails <- accountInfo(account, server)
checkShinyappsServer(accountDetails$server)
# define purge task
taskDef <- list()
taskDef$beginStatus <- "Purging application"
taskDef$endStatus <- "Application successfully purged"
taskDef$action <- function(client, application) {
client$purgeApplication(application$id)
}
# perform it
applicationTask(taskDef, appName, accountDetails, quiet)
}