🔍 Code Extractor

A collection class for managing SharePoint site templates (WebTemplate objects), providing methods to retrieve and work with multiple web templates.

Purpose

WebTemplateCollection serves as a container and manager for SharePoint web templates. It extends EntityCollection to provide specialized functionality for working with site templates, including retrieving templates by name. This class is used when interacting with SharePoint's template system to list available site templates or access specific templates for site creation or configuration.

Source Code

class WebTemplateCollection(EntityCollection[WebTemplate]):
    """Specifies a collection of site templates."""

    def __init__(self, context, resource_path=None, parent=None):
        super(WebTemplateCollection, self).__init__(
            context, WebTemplate, resource_path, parent
        )

    def get_by_name(self, name):
        """Returns the SP.WebTemplate (section 3.2.5.151) specified by its name.
        :param str name: The name of the WebTemplate that is returned.
        """
        return WebTemplate(
            self.context,
            ServiceOperationPath(
                "getByName", ["{name}".format(name=name)], self.resource_path
            ),
        )

Parameters

Parameter Details

context: The client context object that provides the connection and authentication information for SharePoint operations. This is required for all API calls and is passed to parent EntityCollection.

resource_path: Optional. The URL path to the resource representing this collection in the SharePoint REST API. If not provided, it will be derived from the parent or context. Defaults to None.

parent: Optional. The parent entity that owns this collection. Used to establish the object hierarchy in the SharePoint object model. Defaults to None.

Return Value

Instantiation returns a WebTemplateCollection object that can be used to query and retrieve WebTemplate objects. The get_by_name method returns a single WebTemplate object corresponding to the specified template name.

Class Interface

Methods

Attributes

Dependencies

• office365.runtime.paths.service_operation
• office365.sharepoint.entity_collection
• office365.sharepoint.webs.template

Required Imports

from office365.runtime.paths.service_operation import ServiceOperationPath
from office365.sharepoint.entity_collection import EntityCollection
from office365.sharepoint.webs.template import WebTemplate

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.webs.template_collection import WebTemplateCollection

# Assuming you have a configured context
ctx = ClientContext(site_url).with_credentials(credentials)

# Create a collection instance (typically obtained from a Web object)
templates = WebTemplateCollection(ctx, resource_path="_api/web/GetAvailableWebTemplates(lcid=1033)")

# Load the collection
ctx.load(templates)
ctx.execute_query()

# Iterate through templates
for template in templates:
    print(template.name)

# Get a specific template by name
team_template = templates.get_by_name("STS#0")
ctx.load(team_template)
ctx.execute_query()
print(team_template.title)

Best Practices

• Always ensure the context object is properly authenticated before creating a WebTemplateCollection instance
• Use get_by_name() when you know the specific template name rather than loading the entire collection
• Call ctx.load() and ctx.execute_query() to actually fetch data from SharePoint after creating or retrieving templates
• Template names typically follow the format 'TemplateType#Configuration' (e.g., 'STS#0' for Team Site)
• The collection inherits from EntityCollection, so standard collection operations like iteration and indexing are supported
• Resource paths for template collections often include locale identifiers (lcid) to get templates for specific languages
• Handle potential exceptions when retrieving templates by name, as invalid names will cause API errors

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class ListTemplateCollection 85.5% similar

  A collection class that manages and provides access to SharePoint list templates, extending EntityCollection to handle multiple ListTemplate instances.

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

• class SPOTenantWebTemplateCollection 84.7% similar

  A collection class that represents a set of SharePoint Online tenant web templates, inheriting from Entity and providing access to template items.

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

• class WebTemplate 78.4% similar

  Represents a SharePoint site definition or site template that is used to instantiate a site, providing access to template metadata and configuration properties.

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

• class WebCollection 74.9% 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 WorkflowTemplate 70.8% similar

  A class representing a workflow template that is currently deployed on a SharePoint site, inheriting from the Entity base class.

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