R: Microsoft Planner Plan

ms_plan {Microsoft365R}

R Documentation

Microsoft Planner Plan

Description

Class representing one plan withing a Microsoft Planner.

Format

An R6 object of class ms_plan, inheriting from ms_object.

Details

The plans belong to a group.

Fields

token: The token used to authenticate with the Graph host.
tenant: The Azure Active Directory tenant for this drive.
type: always "plan" for plan object.
properties: The plan properties.

Methods

new(...): Initialize a new plan object. Do not call this directly; see 'Initialization' below.
update(...): Update the plan metadata in Microsoft Graph.
do_operation(...): Carry out an arbitrary operation on the plan
sync_fields(): Synchronise the R object with the plan metadata in Microsoft Graph.
list_tasks(filter=NULL, n=Inf): List the tasks under the specified plan.
get_task(task_title, task_id): Get a task, either by title or ID.
list_buckets(filter=NULL, n=Inf): List the buckets under the specified plan.
get_bucket(bucket_name, bucket_id): Get a bucket, either by name or ID.
get_details(): Get the plan details.

Initialization

Creating new objects of this class should be done via the list_plans methods of the az_group class. Calling the new() method for this class only constructs the R object; it does not call the Microsoft Graph API to retrieve or create the actual plan.

Planner operations

This class exposes methods for carrying out common operations on a plan. Currently only read operations are supported.

Call list_tasks() to list the tasks under the plan, and get_task() to retrieve a specific task. Similarly, call list_buckets() to list the buckets, and get_bucket() to retrieve a specific bucket.

Call get_details() to get a list containing the details for the plan.

List methods

All ⁠list_*⁠ methods have filter and n arguments to limit the number of results. The former should be an OData expression as a string to filter the result set on. The latter should be a number setting the maximum number of (filtered) results to return. The default values are filter=NULL and n=Inf. If n=NULL, the ms_graph_pager iterator object is returned instead to allow manual iteration over the results.

Support in the underlying Graph API for OData queries is patchy. Not all endpoints that return lists of objects support filtering, and if they do, they may not allow all of the defined operators. If your filtering expression results in an error, you can carry out the operation without filtering and then filter the results on the client side.