🔍 Code Extractor

PlannerGroup is a class that provides access to Microsoft Planner resources associated with a group, specifically enabling retrieval of planner plans owned by the group.

Purpose

This class serves as a wrapper entity for accessing Microsoft Planner functionality within the context of a Microsoft 365 group. It inherits from Entity and provides a property-based interface to retrieve PlannerPlanCollection objects. The class acts as an entry point for group-related planner operations, though it doesn't maintain any usable properties of its own beyond the inherited Entity properties.

Source Code

class PlannerGroup(Entity):
    """
    The plannerGroup resource provides access to Planner resources for a group.
    It doesn't contain any usable properties.
    """

    @property
    def plans(self):
        """
        Returns the plannerPlans owned by the group.
        """
        from office365.planner.plans.collection import PlannerPlanCollection

        return self.properties.get(
            "plans",
            PlannerPlanCollection(
                self.context, ResourcePath("plans", self.resource_path)
            ),
        )

Parameters

Parameter Details

context: The client context object required for making API calls to Microsoft 365 services. This is inherited from the Entity base class and is used to authenticate and communicate with the Planner API.

resource_path: The resource path identifying the specific group in the Microsoft 365 environment. This is inherited from Entity and used to construct child resource paths for accessing plans.

Return Value

Instantiation returns a PlannerGroup object that provides access to group planner resources. The main method 'plans' returns a PlannerPlanCollection object containing all planner plans owned by the group. This collection can be used to query, create, or manage plans associated with the group.

Class Interface

Methods

Attributes

Dependencies

• office365.entity
• office365.runtime.paths.resource_path
• office365.planner.plans.collection

Required Imports

from office365.entity import Entity
from office365.runtime.paths.resource_path import ResourcePath

Conditional/Optional Imports

These imports are only needed under specific conditions:

from office365.planner.plans.collection import PlannerPlanCollection

Usage Example

from office365.planner.groups.group import PlannerGroup
from office365.runtime.client_context import ClientContext
from office365.runtime.paths.resource_path import ResourcePath

# Assuming you have a configured client context
ctx = ClientContext.connect_with_credentials(tenant_url, credentials)

# Create a PlannerGroup instance for a specific group
group_id = 'group-guid-here'
resource_path = ResourcePath(group_id)
planner_group = PlannerGroup(ctx, resource_path)

# Access the plans collection for this group
plans_collection = planner_group.plans

# Load and iterate through plans
plans_collection.get().execute_query()
for plan in plans_collection:
    print(f'Plan: {plan.title}')

Best Practices

• Always ensure the client context is properly authenticated before instantiating PlannerGroup
• The 'plans' property uses lazy loading - the PlannerPlanCollection is only created when first accessed
• The class caches the plans collection in the properties dictionary to avoid recreating it on subsequent accesses
• This class should be instantiated through the parent Entity framework rather than directly, typically accessed via a Group object's planner property
• The class inherits from Entity, so all Entity methods and properties are available (e.g., get(), update(), delete())
• Remember to call execute_query() on the context after operations to actually execute the API calls
• The resource path should point to a valid Microsoft 365 group that has Planner enabled

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class PlannerUser 81.1% similar

  PlannerUser is a resource class that provides access to Microsoft Planner resources (plans and tasks) associated with a specific user.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/user.py

• class Planner 80.9% similar

  The Planner class is a singleton entry point for accessing Microsoft Planner resources, providing access to buckets, tasks, and plans assigned to a user.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/planner.py

• class PlannerPlanCollection 77.6% similar

  A collection class for managing Microsoft Planner Plan entities, providing methods to create and manage multiple PlannerPlan objects within a Microsoft Graph API context.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/plans/collection.py

• class PlannerPlan 74.0% similar

  The plannerPlan resource represents a plan in Microsoft 365. A plan can be owned by a group and contains a collection of plannerTasks. It can also have a collection of plannerBuckets. Each plan object has a details object that can contain more information about the plan. For more information about the relationships between groups, plans, and tasks, see Planner.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/plans/plan.py

• class PlannerTask 72.3% similar

  Represents a Microsoft 365 Planner task entity with properties for title and detailed task information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/tasks/task.py