🔍 Code Extractor

class SPOTenantWebTemplate

Maturity: 27

A client value class representing a SharePoint Online tenant web template in the Microsoft Online SharePoint Tenant Administration API.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/tenant/administration/webs/templates/template.py
Lines:
4 - 10
Complexity:
simple

Purpose

This class serves as a data model for SharePoint Online tenant web templates. It inherits from ClientValue and provides the entity type name for serialization/deserialization when communicating with SharePoint Online Tenant Administration REST API. It represents metadata about web templates available in a SharePoint Online tenant, which are used to create sites with predefined configurations.

Source Code

class SPOTenantWebTemplate(ClientValue):
    def __init__(self):
        super(SPOTenantWebTemplate, self).__init__()

    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplate"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: The constructor takes no parameters beyond the implicit 'self'. It calls the parent ClientValue constructor to initialize the base client value functionality.

Return Value

Instantiation returns a new SPOTenantWebTemplate object. The entity_type_name property returns a string 'Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplate' which identifies this entity type in the SharePoint API.

Class Interface

Methods

__init__(self) -> None

Purpose: Initializes a new instance of SPOTenantWebTemplate by calling the parent ClientValue constructor

Returns: None - constructor initializes the object

entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by SharePoint Tenant Administration API for web template objects

Returns: String value 'Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplate' identifying the entity type

Dependencies

  • office365

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.administration.spo_tenant_web_template import SPOTenantWebTemplate

# Instantiate a tenant web template object
web_template = SPOTenantWebTemplate()

# Access the entity type name (typically used internally by the API client)
entity_type = web_template.entity_type_name
print(entity_type)  # Output: Microsoft.Online.SharePoint.TenantAdministration.SPOTenantWebTemplate

# This class is typically used as part of larger SharePoint API operations
# and may be populated with data from API responses

Best Practices

  • This class is primarily used internally by the office365 library for API communication and should typically not be instantiated directly by end users
  • The class serves as a data transfer object (DTO) for SharePoint API responses and requests
  • When working with SharePoint tenant web templates, use higher-level API methods that return instances of this class rather than creating instances manually
  • The entity_type_name property is used for proper serialization when communicating with SharePoint REST API
  • This class follows the ClientValue pattern used throughout the office365 library for representing SharePoint entities

Tags

sharepoint tenant-administration web-template client-value data-model office365 spo entity-type

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SPOTenantWebTemplateCollection 79.0% 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 TenantCdnUrl 71.1% similar

    A client value class representing a SharePoint Tenant CDN URL entity, providing type identification for Microsoft SharePoint Tenant CDN URL objects.

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

  • class SiteCreationSource 67.4% similar

    A client value class representing a source for SharePoint site creation, containing a collection of site creation data objects.

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

  • class WebTemplate 66.6% 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 WorkflowTemplate 65.4% 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
← Back to Browse