class SuiteNavData
A SharePoint entity class representing Suite Navigation Data, which manages navigation information for the SharePoint suite bar.
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/portal/suite_nav_data.py
4 - 7
simple
Purpose
SuiteNavData is a specialized entity class that represents Microsoft SharePoint Portal Suite Navigation Data. It inherits from the Entity base class and provides a specific entity type identifier for SharePoint's suite navigation system. This class is used to interact with and manage the suite navigation bar data in SharePoint, which typically includes top-level navigation elements across the SharePoint portal.
Source Code
class SuiteNavData(Entity):
@property
def entity_type_name(self):
return "Microsoft.SharePoint.Portal.SuiteNavData"Parameters
| Name | Type | Default | Kind |
|---|---|---|---|
bases |
Entity | - |
Parameter Details
__init__: Inherits constructor from Entity base class. The exact parameters depend on the Entity parent class implementation, but typically includes context and resource path parameters for SharePoint entity initialization.
Return Value
Instantiation returns a SuiteNavData object that represents a SharePoint suite navigation data entity. The entity_type_name property returns the string 'Microsoft.SharePoint.Portal.SuiteNavData', which is used internally by SharePoint's OData protocol for entity type identification.
Class Interface
Methods
@property entity_type_name(self) -> str
property
Purpose: Returns the OData entity type name for SharePoint suite navigation data
Returns: String value 'Microsoft.SharePoint.Portal.SuiteNavData' representing the entity type identifier used in SharePoint OData operations
Attributes
| Name | Type | Description | Scope |
|---|---|---|---|
entity_type_name |
str | Read-only property that returns the SharePoint OData entity type identifier for suite navigation data | instance |
Dependencies
office365.sharepoint.entity
Required Imports
from office365.sharepoint.portal.suite_nav_data import SuiteNavData
from office365.sharepoint.entity import Entity
Usage Example
from office365.sharepoint.client_context import ClientContext
from office365.sharepoint.portal.suite_nav_data import SuiteNavData
# Assuming you have a ClientContext set up
ctx = ClientContext(site_url).with_credentials(credentials)
# Create or retrieve SuiteNavData instance
suite_nav = SuiteNavData(ctx)
# Access entity type name
entity_type = suite_nav.entity_type_name
print(entity_type) # Output: Microsoft.SharePoint.Portal.SuiteNavData
# The instance can be used with SharePoint operations
# inherited from Entity base classBest Practices
- This class should be instantiated within a valid SharePoint ClientContext to ensure proper entity operations
- The entity_type_name property is primarily used internally by the Office365 REST client for OData protocol communication
- Do not override the entity_type_name property as it identifies the specific SharePoint entity type
- Use this class when working with SharePoint suite navigation data through the Office365 REST Python Client library
- Ensure proper authentication and permissions are set up before attempting to access or modify suite navigation data
- This class inherits all methods and functionality from the Entity base class, so refer to Entity documentation for available operations
Similar Components
AI-powered semantic similarity - components with related functionality:
-
class Navigation 69.0% similar
-
class NavigationService 65.9% similar
-
class StructuralNavigationCacheWrapper 63.0% similar
-
class HomeSiteNavigationSettings 62.6% similar
-
class ConfiguredMetadataNavigationItem 62.1% similar