VariantSchedule: VariantSchedule

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

VariantSchedule

Description

VariantSchedule

VariantSchedule

Details

An R6 class that represents a Schedule

Super classes

connectapi::Content -> connectapi::Variant -> VariantSchedule

Public fields

schedule_data

The schedule data.

Methods

Public methods

• 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()

Inherited methods

• 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$register_job_kill_order()
• 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()

---

Method new()

Initialize this schedule.

Usage

VariantSchedule$new(connect, content, key, schedule)

Arguments

connect

The Connect instance.

content

The Content instance.

key

The variant key.

schedule

The schedule data.

---

Method GET()

Perform an HTTP GET request of the named API path. Returns an object parsed from the HTTP response.

Usage

VariantSchedule$GET(path)

Arguments

path

API path.

---

Method POST()

Perform an HTTP POST request of the named API path. Returns an object parsed from the HTTP response.

Usage

VariantSchedule$POST(path, body)

Arguments

path

API path.

body

The HTTP payload.

---

Method DELETE()

Perform an HTTP DELETE request of the named API path. Returns the HTTP response object.

Usage

VariantSchedule$DELETE(path)

Arguments

path

API path.

---

Method set_schedule()

Set the schedule for this variant

Usage

VariantSchedule$set_schedule(...)

Arguments

...

Schedule fields.

---

Method is_empty()

Return if this variant has a schedule.

Usage

VariantSchedule$is_empty()

---

Method print()

Print this object.

Usage

VariantSchedule$print(...)

Arguments

...

Unused.

---

Method get_schedule()

Get the schedule data.

Usage

VariantSchedule$get_schedule()

---

Method get_schedule_remote()

Get and store the (remote) schedule data.

Usage

VariantSchedule$get_schedule_remote()

---

Method describe_schedule()

Description of the associated schedule.

Usage

VariantSchedule$describe_schedule()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

VariantSchedule$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

Other R6 classes: Bundle, Content, ContentTask, Environment, PositConnect, Task, Vanity, Variant, VariantTask

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