🔍 Code Extractor

class SiteUserGroupInfo

Maturity: 24

A data class representing SharePoint site user group information in the Microsoft Online SharePoint Tenant Administration context.

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

Purpose

This class serves as a data transfer object (DTO) for SharePoint site user group information within the Office365 SharePoint Tenant Administration API. It inherits from ClientValue, which is a base class for client-side value objects that can be serialized and sent to/from SharePoint REST APIs. The class provides the entity type name used for proper serialization and deserialization when communicating with SharePoint's tenant administration services.

Source Code

class SiteUserGroupInfo(ClientValue):
    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.TenantAdministration.SiteUserGroupInfo"

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

__init__: Inherits constructor from ClientValue base class. The base class constructor typically accepts keyword arguments that map to properties of the SharePoint entity. No explicit constructor is defined in this class, so it uses the parent class constructor which likely accepts arbitrary keyword arguments representing the entity's properties.

Return Value

Instantiation returns a SiteUserGroupInfo object that represents a SharePoint site user group entity. The entity_type_name property returns a string 'Microsoft.Online.SharePoint.TenantAdministration.SiteUserGroupInfo' which is used internally by the Office365 SDK for proper type identification during API communication.

Class Interface

Methods

@property entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by SharePoint's tenant administration API for proper type identification during serialization and deserialization

Returns: String value 'Microsoft.Online.SharePoint.TenantAdministration.SiteUserGroupInfo' representing the entity type in the SharePoint object model

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier for this class instance

Dependencies

  • office365-runtime

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.tenant.administration.site_user_group_info import SiteUserGroupInfo

# Instantiate with properties (inherited from ClientValue)
group_info = SiteUserGroupInfo()

# Access the entity type name (used internally by SDK)
entity_type = group_info.entity_type_name
print(entity_type)  # Output: Microsoft.Online.SharePoint.TenantAdministration.SiteUserGroupInfo

# Typically used as part of larger Office365 SDK operations
# Example: Retrieved from SharePoint API calls
# from office365.sharepoint.client_context import ClientContext
# ctx = ClientContext(site_url).with_credentials(credentials)
# site_groups = ctx.web.site_groups.get().execute_query()
# for group in site_groups:
#     # group would be of type SiteUserGroupInfo or similar

Best Practices

  • This class is primarily used internally by the Office365 SDK and should not typically be instantiated directly by end users
  • The entity_type_name property is used for proper serialization/deserialization and should not be modified
  • When working with SharePoint user groups, retrieve instances through the Office365 SDK's API methods rather than creating them manually
  • This class inherits from ClientValue, which provides serialization capabilities for REST API communication
  • The class follows the Office365 SDK pattern where entity type names match the server-side type definitions
  • No state management or side effects - this is a simple data container class

Tags

sharepoint tenant-administration user-groups dto data-transfer-object office365 client-value entity serialization

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class GroupSiteInfo 79.6% similar

    A data class representing information about a SharePoint group site, including its URL, status, and related metadata.

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

  • class SiteAdministratorsInfo 79.2% similar

    A data class representing site administrator information in SharePoint Online tenant administration, including email, login name, and display name.

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

  • class SiteInfoForSitePicker 76.0% similar

    A data transfer object representing site information for SharePoint site picker operations in Microsoft Online SharePoint Tenant Administration.

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

  • class GroupCreationInformation 75.8% similar

    A data transfer object (DTO) class that encapsulates information required to create a cross-site SharePoint group.

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

  • class GroupCreationInformation_v1 73.6% 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
← Back to Browse