content_render: Render a content item.

In rstudio/connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Render a content item.

Description

Submit a request to render a content item. Once submitted, the server runs an asynchronous process to render the content. This might be useful if content needs to be updated after its source data has changed, especially if this doesn't happen on a regular schedule.

Only valid for rendered content (e.g., most Quarto documents, Jupyter notebooks, R Markdown reports).

Usage

content_render(content, variant_key = NULL)

Arguments

content	The content item you wish to render.
variant_key	If a variant key is provided, render that variant. Otherwise, render the default variant.

Value

A VariantTask object that can be used to track completion of the render.

Examples

## Not run: 
client <- connect()
item <- content_item(client, "951bf3ad-82d0-4bca-bba8-9b27e35c49fa")
task <- content_render(item)
poll_task(task)

## End(Not run)

rstudio/connectapi documentation built on Dec. 20, 2024, 1:48 p.m.