🔍 Code Extractor

PersonalWeb is a SharePoint client class that provides methods for managing a user's personal web site, specifically operations on the user's default document library.

Purpose

This class represents the Microsoft.SharePoint.Client.Sharing.PersonalWeb namespace and provides functionality to manage SharePoint personal web sites for individual users. Its primary use case is fixing permission inheritance issues on the default document library when breakRoleInheritance fails during library creation. It inherits from Entity and integrates with the SharePoint client context to execute service operations.

Source Code

class PersonalWeb(Entity):
    """Microsoft.SharePoint.Client.Sharing.PersonalWeb namespace represents methods that apply to a Web site for
    individual users. Methods act on the users default document library."""

    @staticmethod
    def fix_permission_inheritance(context):
        """
        This method fixes the permission inheritance for the default document library of the personal web when
        breakRoleInheritance didn't happen correctly during the default document library creation.

        :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
        """
        binding_type = PersonalWeb(context)
        qry = ServiceOperationQuery(
            binding_type, "FixPermissionInheritance", None, None, None, None, True
        )
        context.add_query(qry)
        return binding_type

    @property
    def entity_type_name(self):
        return "SP.Sharing.PersonalWeb"

Parameters

Parameter Details

context: An instance of office365.sharepoint.client_context.ClientContext that provides the connection and authentication context for SharePoint operations. This is required for all service operations and must be properly initialized with SharePoint site URL and credentials before use.

Return Value

The class constructor returns a PersonalWeb instance. The fix_permission_inheritance static method returns a PersonalWeb binding type object after queuing the permission fix operation in the provided context. The entity_type_name property returns the string 'SP.Sharing.PersonalWeb' which identifies the SharePoint entity type.

Class Interface

Methods

Attributes

Dependencies

• office365.runtime.queries.service_operation
• office365.sharepoint.entity
• office365.sharepoint.client_context

Required Imports

from office365.runtime.queries.service_operation import ServiceOperationQuery
from office365.sharepoint.entity import Entity
from office365.sharepoint.client_context import ClientContext

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.sharing.personal_web import PersonalWeb
from office365.runtime.auth.client_credential import ClientCredential

# Initialize SharePoint context
site_url = 'https://yourtenant.sharepoint.com/sites/yoursite'
credentials = ClientCredential('client_id', 'client_secret')
ctx = ClientContext(site_url).with_credentials(credentials)

# Fix permission inheritance on personal web
personal_web = PersonalWeb.fix_permission_inheritance(ctx)
ctx.execute_query()

# Access entity type name
entity_type = personal_web.entity_type_name
print(f'Entity type: {entity_type}')

Best Practices

• Always ensure the ClientContext is properly authenticated before calling fix_permission_inheritance
• Call ctx.execute_query() after fix_permission_inheritance to actually execute the queued operation
• Use fix_permission_inheritance only when permission inheritance is broken during default document library creation
• The class inherits from Entity, so it follows the Entity lifecycle and state management patterns
• This is primarily a utility class with static methods - instantiation is handled internally by the static method
• The fix_permission_inheritance method queues an operation but doesn't execute it immediately - execution happens when execute_query is called on the context
• Ensure proper error handling around execute_query as SharePoint operations can fail due to permissions or network issues

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class WebPart 66.0% similar

  A class representing a SharePoint Web Part, which is a reusable component that contains or generates web-based content (XML, HTML, scripting) and displays it in a cohesive unit on a webpage.

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

• class DocumentsSharedWithGroup 65.3% similar

  A class representing a SharePoint list that manages documents shared with a SharePoint Group on a user's personal site.

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

• class MySiteLinks 64.9% similar

  MySiteLinks is a SharePoint entity class that provides access to links for a user's personal site, including document libraries and followed sites.

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

• class WebCollection 64.8% similar

  WebCollection is a specialized collection class for managing SharePoint Web objects, providing methods to add new webs and handle web-specific resource paths.

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

• class WebPartDefinition 64.6% similar

  Represents a Web Part on a Web Part Page in SharePoint, providing operations for managing the Web Part including deletion and property access.

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