class MembersInfo
MembersInfo is a SharePoint entity class that represents directory members information in the SharePoint API.
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/directory/members_info.py
4 - 7
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
-
class SharedDocumentInfo 68.2% similar
-
class MembershipResult 64.7% similar
-
class ChannelInfo 64.3% similar
-
class Group_v1 64.2% similar