🔍 Code Extractor

class MembersInfo

Maturity: 22

MembersInfo is a SharePoint entity class that represents directory members information in the SharePoint API.

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

Purpose

This class serves as a data model for SharePoint directory members information. It inherits from the Entity base class and provides the entity type name for SharePoint API operations. It is used to interact with SharePoint's directory service to retrieve or manage information about members in a directory context.

Source Code

class MembersInfo(Entity):
    @property
    def entity_type_name(self):
        return "SP.Directory.MembersInfo"

Parameters

Name Type Default Kind
bases Entity -

Parameter Details

__init__: Inherits constructor from Entity base class. The specific parameters depend on the Entity parent class implementation, but typically would include context and resource path for SharePoint API operations.

Return Value

Instantiation returns a MembersInfo object that represents a SharePoint directory members entity. The entity_type_name property returns the string 'SP.Directory.MembersInfo' which identifies this entity type in SharePoint API calls.

Class Interface

Methods

@property def entity_type_name(self) -> str property

Purpose: Returns the SharePoint entity type name identifier for this class

Returns: String 'SP.Directory.MembersInfo' which identifies this entity type in SharePoint API operations

Attributes

Name Type Description Scope
entity_type_name str Read-only property that returns the SharePoint entity type identifier 'SP.Directory.MembersInfo' instance

Dependencies

  • office365

Required Imports

from office365.sharepoint.directory.members_info import MembersInfo
from office365.sharepoint.entity import Entity

Usage Example

from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.directory.members_info import MembersInfo

# Authenticate with SharePoint
ctx = ClientContext(site_url).with_credentials(credentials)

# Create or retrieve MembersInfo instance
members_info = MembersInfo(ctx)

# Access entity type name
entity_type = members_info.entity_type_name
print(entity_type)  # Output: SP.Directory.MembersInfo

# Typically used in SharePoint API operations
# The actual usage depends on the Entity base class methods

Best Practices

  • This class should be instantiated within a valid SharePoint context (ClientContext) to function properly
  • The entity_type_name property is primarily used internally by the office365 library for API serialization and should not typically be modified
  • Inherit from this class if you need to extend SharePoint directory members functionality
  • Use this class as part of the office365 SharePoint SDK workflow, not as a standalone component
  • Ensure proper authentication is established before creating instances of this class

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class UserDirectoryInfo 69.2% similar

    A data class representing user information retrieved from a directory service, such as Active Directory or Azure AD, used in SharePoint sharing operations.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/user_directory_info.py
  • class SharedDocumentInfo 68.2% similar

    A SharePoint entity class representing metadata and information about a shared document, including its activity and author details.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/shared_document_info.py
  • class MembershipResult 64.7% similar

    MembershipResult is a SharePoint entity class that represents the result of a membership query or operation in SharePoint Directory services.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/directory/membership_result.py
  • class ChannelInfo 64.3% similar

    ChannelInfo is a data class representing Microsoft SharePoint Portal channel information, inheriting from ClientValue to provide serialization capabilities for SharePoint API interactions.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/channels/info.py
  • class Group_v1 64.2% similar

    Represents a SharePoint Directory Group entity that provides methods to retrieve group members, owners, and member information with lazy loading support.

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