🔍 Code Extractor

A data class that encapsulates parameters for folder deletion operations in SharePoint/Office365, inheriting from ClientValue to enable serialization for API requests.

Purpose

This class serves as a parameter container for folder deletion operations in the Office365 SDK. It allows clients to specify deletion behavior through three boolean flags: whether to bypass shared locks, whether to delete only if the folder is empty, and whether to match ETags for optimistic concurrency control. The class inherits from ClientValue, which provides serialization capabilities for transmitting these parameters to SharePoint REST APIs.

Source Code

class FolderDeleteParameters(ClientValue):
    def __init__(self, bypass_shared_lock=None, delete_if_empty=None, etag_match=None):
        """
        :param bool bypass_shared_lock:
        :param bool delete_if_empty:
        :param bool etag_match:
        """
        self.BypassSharedLock = bypass_shared_lock
        self.DeleteIfEmpty = delete_if_empty
        self.ETagMatch = etag_match

Parameters

Parameter Details

bypass_shared_lock: Boolean flag indicating whether to bypass shared locks when deleting the folder. When True, the deletion will proceed even if the folder has shared locks. When False or None, shared locks will prevent deletion. Default is None.

delete_if_empty: Boolean flag indicating whether to delete the folder only if it is empty. When True, deletion will only succeed if the folder contains no items. When False or None, the folder will be deleted regardless of its contents. Default is None.

etag_match: Boolean flag for ETag matching to ensure optimistic concurrency control. When True, the deletion will only proceed if the ETag matches the current state of the folder, preventing conflicts from concurrent modifications. When False or None, ETag matching is not enforced. Default is None.

Return Value

Instantiation returns a FolderDeleteParameters object with three public attributes (BypassSharedLock, DeleteIfEmpty, ETagMatch) set to the provided parameter values. This object can be serialized and passed to folder deletion API methods in the Office365 SDK.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.folders.folder_delete_parameters import FolderDeleteParameters

# Create parameters to delete a folder only if empty, bypassing locks
delete_params = FolderDeleteParameters(
    bypass_shared_lock=True,
    delete_if_empty=True,
    etag_match=False
)

# Access the attributes
print(delete_params.BypassSharedLock)  # True
print(delete_params.DeleteIfEmpty)  # True
print(delete_params.ETagMatch)  # False

# Typically used with a folder object's delete method
# folder.delete_object(delete_params).execute_query()

Best Practices

• Always consider the implications of bypass_shared_lock=True as it may override collaborative locking mechanisms
• Use delete_if_empty=True when you want to ensure no data loss from accidental deletion of non-empty folders
• Enable etag_match=True when concurrent modifications are a concern to prevent race conditions
• All parameters are optional and default to None, allowing selective specification of deletion behavior
• This class is immutable after instantiation - create a new instance if different parameters are needed
• The class follows PascalCase naming convention for attributes (BypassSharedLock, DeleteIfEmpty, ETagMatch) to match SharePoint API conventions
• This object is typically passed to folder deletion methods in the Office365 SDK and should not be used standalone

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class ListItemDeleteParameters 78.1% similar

  A parameter class that encapsulates configuration options for deleting list items in SharePoint/Office365, specifically controlling whether to bypass shared locks during deletion.

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

• class GroupCreationParams 64.7% similar

  A data class representing parameters for creating a SharePoint group, inheriting from ClientValue to enable serialization for SharePoint API calls.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/groups/creation_params.py

• class ListItemUpdateParameters 63.2% similar

  A parameter class for updating SharePoint list items, inheriting from ClientValue to represent client-side values in Office 365 operations.

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

• class FolderColoringInformation 62.9% similar

  A data class that represents folder coloring information in Microsoft 365/SharePoint, storing color hex values, color tags, and emoji associations for folder customization.

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

• class GetListItemVersionsParameters 61.4% similar

  A parameter class for configuring list item version retrieval operations in SharePoint, allowing control over result limits and sort order.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listitems/versions/get_parameters.py