🔍 Code Extractor

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

Purpose

GroupCreationParams encapsulates the configuration needed to create a new SharePoint group through the Microsoft.SharePoint.Portal API. It provides a structured way to specify group classification, description, and creation options (such as site language). This class is designed to be serialized and sent as part of SharePoint REST API requests for group creation operations.

Source Code

class GroupCreationParams(ClientValue):
    def __init__(self, classification="", description=""):
        super(GroupCreationParams, self).__init__()
        self.Classification = classification
        self.Description = description
        self.CreationOptions = ClientValueCollection(str)
        self.CreationOptions.add("SPSiteLanguage:1033")

    @property
    def entity_type_name(self):
        return "Microsoft.SharePoint.Portal.GroupCreationParams"

Parameters

Parameter Details

classification: Optional string parameter that specifies the classification or category of the group being created. Defaults to an empty string if not provided. Used for organizational taxonomy and governance purposes.

description: Optional string parameter that provides a textual description of the group's purpose or content. Defaults to an empty string if not provided. This description is typically displayed in SharePoint UI.

Return Value

Instantiation returns a GroupCreationParams object configured with the specified classification and description. The object has Classification, Description, and CreationOptions attributes set. The entity_type_name property returns the string 'Microsoft.SharePoint.Portal.GroupCreationParams' which identifies the SharePoint entity type for API serialization.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import ClientValueCollection

Usage Example

from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import ClientValueCollection

# Create group creation parameters with classification and description
params = GroupCreationParams(
    classification="Public",
    description="A team group for project collaboration"
)

# Access the attributes
print(params.Classification)  # Output: Public
print(params.Description)  # Output: A team group for project collaboration
print(params.entity_type_name)  # Output: Microsoft.SharePoint.Portal.GroupCreationParams

# The CreationOptions collection is pre-populated with default language
print(params.CreationOptions)  # Contains: SPSiteLanguage:1033

# Add additional creation options if needed
params.CreationOptions.add("AdditionalOption:Value")

# This object would typically be passed to a SharePoint API method
# Example: context.web.create_group(params)

Best Practices

• Always instantiate with meaningful classification and description values for better group organization and discoverability
• The CreationOptions collection is automatically initialized with default language setting (SPSiteLanguage:1033 for English). Modify only if different language or additional options are required
• This class is designed to be used as a parameter object for SharePoint group creation API calls, not for standalone use
• The entity_type_name property should not be modified as it's used internally by the office365 library for proper API serialization
• Ensure the parent ClientValue class is properly initialized by calling super().__init__() to maintain serialization capabilities
• Language code 1033 represents English (US). Change this value in CreationOptions if creating groups for different locales

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class GroupCreationInformation_v1 73.8% similar

  A data class that encapsulates information required to create a SharePoint group, including display name, alias, visibility settings, and optional parameters.

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

• class GroupCreationContext 65.5% similar

  A client value class representing the context for creating a SharePoint group, inheriting from ClientValue base class.

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

• class SiteCreationProperties 65.1% similar

  A data class that encapsulates the properties required to create a new SharePoint site, including URL, owner, title, and template information.

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

• class FolderDeleteParameters 64.7% similar

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

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

• class SiteCreationData 63.5% similar

  A data class representing site creation information for SharePoint Online tenant administration, including creation count and source GUID.

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