🔍 Code Extractor

class PlannerPlanContainer

Maturity: 50

A container class representing a plannerPlan resource that manages authorization rules and lifecycle of Microsoft Planner plans.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/plans/container.py
Lines:
4 - 11
Complexity:
simple

Purpose

PlannerPlanContainer is a data model class that represents a container for Microsoft Planner plans. It encapsulates authorization rules and controls the lifetime of plans - when the container is deleted, all contained plans are also deleted. This class inherits from ClientValue and is used to represent the immutable container properties that are set when a plan is created and cannot be changed afterwards. It serves as a data transfer object for Microsoft Graph API interactions related to Planner plan containers.

Source Code

class PlannerPlanContainer(ClientValue):
    """
    Represents a container for a plannerPlan. The container is a resource that specifies authorization rules and the
    lifetime of the plan. This means that only the people who are authorized to work with the resource containing
    the plan will be able to work with the plan and the tasks within it. When the containing resource is deleted,
    the contained plans are also deleted. The properties of the plannerPlanContainer cannot be changed after the plan
    is created.
    """

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Inherits from ClientValue, which is a base class for client-side value objects in the Office365 SDK. This provides serialization/deserialization capabilities for API communication.

Return Value

Instantiation returns a PlannerPlanContainer object that represents a container for a planner plan. The object inherits ClientValue functionality for working with Microsoft Graph API responses and requests related to plan containers.

Class Interface

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.planner.plans.container import PlannerPlanContainer

Usage Example

from office365.planner.plans.container import PlannerPlanContainer
from office365.runtime.client_value import ClientValue

# Instantiate a PlannerPlanContainer
container = PlannerPlanContainer()

# Typically used as part of plan creation or retrieval
# The container properties are set during plan creation and cannot be modified
# Example in context of a plan object:
# plan.container = container
# The container specifies authorization and lifecycle rules for the plan

Best Practices

  • This class represents an immutable container - properties cannot be changed after plan creation
  • The container controls both authorization (who can access the plan) and lifecycle (when the plan is deleted)
  • Always ensure proper Microsoft Graph API permissions are configured before working with PlannerPlanContainer objects
  • The container is typically created and managed by the Microsoft Graph API, not directly instantiated by users
  • When the containing resource is deleted, all plans within the container are automatically deleted
  • Use this class as a data transfer object when working with Microsoft Planner API responses
  • The class inherits serialization capabilities from ClientValue for API communication

Tags

microsoft-planner office365 data-model container authorization lifecycle-management client-value immutable graph-api

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class PlannerPlan 73.3% 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 PlannerPlanCollection 70.1% 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 PlannerGroup 68.6% similar

    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.

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

  • class Planner 68.5% 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 PlannerUser 66.0% 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
← Back to Browse