ms_plan_bucket: Microsoft Planner Plan Bucket

In Microsoft365R: Interface to the 'Microsoft 365' Suite of Cloud Services

Microsoft Planner Plan Bucket

Description

Class representing a bucket within a plan of a Microsoft Planner.

Format

An R6 object of class ms_plan_bucket, inheriting from ms_object.

Fields

• token: The token used to authenticate with the Graph host.

• tenant: The Azure Active Directory tenant for this bucket

• type: always "plan_bucket" for plan bucket object.

• properties: The plan bucket properties.

Methods

• new(...): Initialize a new plan bucket object. Do not call this directly; see 'Initialization' below.

• update(...): Update the plan bucket metadata in Microsoft Graph.

• do_operation(...): Carry out an arbitrary operation on the plan bucket

• sync_fields(): Synchronise the R object with the plan bucket metadata in Microsoft Graph.

• list_tasks(filter=NULL, n=Inf): List the tasks for this bucket.

Initialization

Creating new objects of this class should be done via the list_buckets method of the ms_plan 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 bucket.

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.

See Also

ms_plan, ms_plan_task

Microsoft Graph overview, Plans overview

Microsoft365R documentation built on May 31, 2023, 6:10 p.m.