🔍 Code Extractor

class UnifiedGroup

Maturity: 24

A class representing a Microsoft 365 Unified Group (also known as Microsoft 365 Group) in a SharePoint Multi-Geo environment, inheriting from the Entity base class.

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

Purpose

This class serves as a data model for Microsoft 365 Unified Groups within the SharePoint Multi-Geo service context. It provides the entity type identifier used by the SharePoint REST API to interact with unified groups across geographic locations. Unified Groups are the foundation for Microsoft Teams, Planner, and other Microsoft 365 collaborative services. This class is primarily used for API communication and object serialization/deserialization when working with SharePoint Multi-Geo services.

Source Code

class UnifiedGroup(Entity):
    @property
    def entity_type_name(self):
        return "Microsoft.Online.SharePoint.MultiGeo.Service.UnifiedGroup"

Parameters

Name Type Default Kind
bases Entity -

Parameter Details

__init__: Inherits constructor from Entity base class. The exact parameters depend on the Entity class implementation, but typically include context and properties for initializing the entity with SharePoint connection details and initial property values.

Return Value

Instantiation returns a UnifiedGroup object that represents a Microsoft 365 Unified Group entity. The entity_type_name property returns a string value 'Microsoft.Online.SharePoint.MultiGeo.Service.UnifiedGroup' which is used internally by the SharePoint REST API for type identification.

Class Interface

Methods

@property def entity_type_name(self) -> str property

Purpose: Returns the fully qualified entity type name used by the SharePoint REST API to identify this entity type in Multi-Geo service operations

Returns: A string containing the entity type identifier 'Microsoft.Online.SharePoint.MultiGeo.Service.UnifiedGroup'

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the entity type identifier for SharePoint Multi-Geo Unified Groups instance

Dependencies

  • office365-runtime

Required Imports

from office365.sharepoint.entity import Entity
from office365.sharepoint.multigeography.unified_group import UnifiedGroup

Usage Example

from office365.runtime.auth.authentication_context import AuthenticationContext
from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.multigeography.unified_group import UnifiedGroup

# Setup authentication
site_url = 'https://tenant.sharepoint.com'
ctx_auth = AuthenticationContext(site_url)
ctx_auth.acquire_token_for_user('username', 'password')

# Create client context
ctx = ClientContext(site_url, ctx_auth)

# Instantiate or retrieve a UnifiedGroup
unified_group = UnifiedGroup(ctx)

# Access the entity type name
entity_type = unified_group.entity_type_name
print(entity_type)  # Output: Microsoft.Online.SharePoint.MultiGeo.Service.UnifiedGroup

# Typically used with query operations
# groups = ctx.web.unified_groups.get().execute_query()
# for group in groups:
#     print(group.entity_type_name)

Best Practices

  • This class is typically instantiated through SharePoint API query operations rather than direct instantiation
  • The entity_type_name property is primarily used internally by the office365-runtime library for API serialization and should not be modified
  • Ensure proper authentication and permissions are configured before attempting to access Unified Group data
  • This class inherits all functionality from the Entity base class, so refer to Entity documentation for additional methods and properties
  • When working with Multi-Geo environments, ensure the appropriate geo-location context is set for the operations
  • Use this class in conjunction with ClientContext and appropriate collection classes for querying and manipulating Unified Groups

Tags

sharepoint microsoft365 unified-group multi-geo entity office365 collaboration teams rest-api data-model

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class CalendarGroup 66.1% similar

    A class representing a group of user calendars in Microsoft Office 365, providing access to calendar group properties and associated calendars.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/group.py

  • class PlannerGroup 64.4% similar

    PlannerGroup is a class that provides access to Microsoft Planner resources associated with a group, specifically enabling retrieval of planner plans owned by the group.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/planner/group.py

  • class GroupService 63.4% similar

    GroupService is a SharePoint service class that provides operations for managing SharePoint groups, including retrieving group images and synchronizing group properties.

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

  • class DocumentsSharedWithGroup 62.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 GroupByElement 62.2% similar

    A class representing a Group By section for grouping data returned through a query in a SharePoint list view.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/listitems/caml/query.py
← Back to Browse