Nothing
#' Delete Object or Field Metadata in Salesforce
#'
#' @description
#' `r lifecycle::badge("experimental")`
#'
#' This function takes a request of named elements in Salesforce and deletes them.
#'
#' @importFrom lifecycle deprecate_warn is_present deprecated
#' @importFrom XML newXMLNode xmlInternalTreeParse xmlChildren
#' @template metadata_type
#' @param object_names a character vector of names that we wish to read metadata for
#' @template control
#' @param ... arguments passed to \code{\link{sf_control}}
#' @template all_or_none
#' @template verbose
#' @return A \code{data.frame} containing the creation result for each submitted metadata component
#' @seealso \code{\link{sf_list_metadata}}, \href{https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta}{Salesforce Documentation}
#' @examples
#' \dontrun{
#' metadata_info <- sf_delete_metadata(metadata_type = 'CustomObject',
#' object_names = c('Custom_Account25__c'))
#' }
#' @export
sf_delete_metadata <- function(metadata_type,
object_names,
control = list(...), ...,
all_or_none = deprecated(),
verbose = FALSE){
stopifnot(all(is.character(object_names)))
stopifnot(metadata_type %in% names(valid_metadata_list()))
# format names into list
object_list <- as.list(object_names)
names(object_list) <- rep('fullNames', length(object_list))
which_operation <- "deleteMetadata"
# determine how to pass along the control args
control_args <- return_matching_controls(control)
control_args$api_type <- "Metadata"
control_args$operation <- "delete"
if(is_present(all_or_none)) {
deprecate_warn("0.1.3", "salesforcer::sf_delete_metadata(all_or_none = )",
"sf_delete_metadata(AllOrNoneHeader = )",
details = paste0("You can pass the all or none header directly ",
"as shown above or via the `control` argument."))
control_args$AllOrNoneHeader <- list(allOrNone = tolower(all_or_none))
}
control <- do.call("sf_control", control_args)
# define the operation
operation_node <- newXMLNode(which_operation,
namespaceDefinitions = c('http://soap.sforce.com/2006/04/metadata'),
suppressNamespaceWarning = TRUE)
type_node <- newXMLNode("type", metadata_type, parent = operation_node)
# and add the metadata to it
xml_dat <- build_metadata_xml_from_list(input_data = object_list, metatype = NULL, root = operation_node)
base_metadata_url <- make_base_metadata_url()
root <- make_soap_xml_skeleton(soap_headers = control, metadata_ns = TRUE)
body_node <- newXMLNode("soapenv:Body", parent=root)
body_node <- addChildren(body_node, xml_dat)
request_body <- as(root, "character")
httr_response <- rPOST(url = base_metadata_url,
headers = c("SOAPAction"=which_operation,
"Content-Type"="text/xml"),
body = request_body)
if(verbose){
make_verbose_httr_message(httr_response$request$method,
httr_response$request$url,
httr_response$request$headers,
request_body)
}
catch_errors(httr_response)
response_parsed <- content(httr_response, encoding="UTF-8")
resultset <- response_parsed %>%
xml_ns_strip() %>%
xml_find_all('.//result') %>%
map_df(xml_nodeset_to_df) %>%
type_convert(col_types = cols())
return(resultset)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.