🔍 Code Extractor

class NavigationProviderType

Maturity: 32

A constants class that defines string identifiers for various SharePoint navigation provider types used in site navigation configuration.

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/navigation/provider_type.py
Lines:
1 - 47
Complexity:
simple

Purpose

This class serves as a centralized enumeration of SharePoint navigation provider type identifiers. It provides string constants representing different navigation providers used in SharePoint sites, including global navigation, current navigation, taxonomy providers, MySite providers, and various site map providers. These constants are typically used when configuring or querying SharePoint navigation settings programmatically.

Source Code

class NavigationProviderType:
    def __init__(self):
        pass

    SPNavigationProvider = "SPNavigationProvider"

    AdministrationQuickLaunchProvider = "AdministrationQuickLaunchProvider"

    SharedServicesQuickLaunchProvider = "SharedServicesQuickLaunchProvider"

    GlobalNavSiteMapProvider = "GlobalNavSiteMapProvider"

    CombinedNavSiteMapProvider = "CombinedNavSiteMapProvider"

    CurrentNavSiteMapProvider = "CurrentNavSiteMapProvider"

    CurrentNavSiteMapProviderNoEncode = "CurrentNavSiteMapProviderNoEncode"

    GlobalNavigation = "GlobalNavigation"

    CurrentNavigation = "CurrentNavigation"

    MySitePersonalQuickLaunchProvider = "MySitePersonalQuickLaunchProvider"

    MySiteHostTopNavigationProvider = "MySiteHostTopNavigationProvider"

    GlobalNavigationSwitchableProvider = "GlobalNavigationSwitchableProvider"

    CurrentNavigationSwitchableProvider = "CurrentNavigationSwitchableProvider"

    GlobalNavigationTaxonomyProvider = "GlobalNavigationTaxonomyProvider"

    CurrentNavigationTaxonomyProvider = "CurrentNavigationTaxonomyProvider"

    MySiteMapProvider = "MySiteMapProvider"

    MySiteLeftNavProvider = "MySiteLeftNavProvider"

    MySiteDocumentStaticProvider = "MySiteDocumentStaticProvider"

    MySiteSitesPageStaticProvider = "MySiteSitesPageStaticProvider"

    MySiteSubNavProvider = "MySiteSubNavProvider"

    EduTopNavProvider = "EduTopNavProvider"

    MySiteHostQuickLaunchProvider = "MySiteHostQuickLaunchProvider"

Parameters

Name Type Default Kind
bases - -

Parameter Details

self: Standard instance reference for the class constructor. No actual parameters are needed as this class only defines constants.

Return Value

Instantiation returns a NavigationProviderType object, though the class is designed to be used primarily for accessing its class-level string constants rather than creating instances. Each class attribute returns a string identifier for a specific SharePoint navigation provider type.

Class Interface

Methods

__init__(self)

Purpose: Constructor that initializes the class instance (no-op implementation)

Parameters:

  • self: Instance reference

Returns: None - initializes a NavigationProviderType instance

Attributes

Name Type Description Scope
SPNavigationProvider str Standard SharePoint navigation provider identifier class
AdministrationQuickLaunchProvider str Provider for administration quick launch navigation class
SharedServicesQuickLaunchProvider str Provider for shared services quick launch navigation class
GlobalNavSiteMapProvider str Site map provider for global navigation class
CombinedNavSiteMapProvider str Site map provider that combines multiple navigation sources class
CurrentNavSiteMapProvider str Site map provider for current navigation with encoding class
CurrentNavSiteMapProviderNoEncode str Site map provider for current navigation without URL encoding class
GlobalNavigation str Global navigation provider identifier class
CurrentNavigation str Current navigation provider identifier class
MySitePersonalQuickLaunchProvider str Provider for MySite personal quick launch navigation class
MySiteHostTopNavigationProvider str Provider for MySite host top navigation class
GlobalNavigationSwitchableProvider str Switchable provider for global navigation class
CurrentNavigationSwitchableProvider str Switchable provider for current navigation class
GlobalNavigationTaxonomyProvider str Taxonomy-based provider for global navigation class
CurrentNavigationTaxonomyProvider str Taxonomy-based provider for current navigation class
MySiteMapProvider str Site map provider for MySite class
MySiteLeftNavProvider str Provider for MySite left navigation class
MySiteDocumentStaticProvider str Static provider for MySite document navigation class
MySiteSitesPageStaticProvider str Static provider for MySite sites page navigation class
MySiteSubNavProvider str Provider for MySite sub-navigation class
EduTopNavProvider str Provider for education site top navigation class
MySiteHostQuickLaunchProvider str Provider for MySite host quick launch navigation class

Usage Example

# Access navigation provider type constants
provider_type = NavigationProviderType.GlobalNavigation
print(provider_type)  # Output: 'GlobalNavigation'

# Use in SharePoint navigation configuration
current_nav = NavigationProviderType.CurrentNavigation
global_nav = NavigationProviderType.GlobalNavigationTaxonomyProvider

# Can also instantiate (though not necessary)
nav_types = NavigationProviderType()
my_site_provider = nav_types.MySitePersonalQuickLaunchProvider

# Common usage in conditional logic
if selected_provider == NavigationProviderType.CurrentNavigationTaxonomyProvider:
    # Configure taxonomy-based navigation
    pass

Best Practices

  • This class is designed as a constants container and does not require instantiation - access attributes directly via the class name (e.g., NavigationProviderType.GlobalNavigation)
  • Use these constants instead of hardcoded strings when working with SharePoint navigation providers to avoid typos and improve code maintainability
  • The class has no state or side effects - it simply provides string constants
  • No initialization parameters are needed; the __init__ method is a no-op
  • All attributes are class-level string constants that represent SharePoint navigation provider identifiers
  • This pattern is similar to an enum but implemented as a class with string attributes for compatibility with SharePoint APIs

Tags

sharepoint navigation constants enumeration configuration providers site-navigation taxonomy mysite

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class PublishingNavigationProviderType 85.7% similar

    An enumeration-style class that defines constants representing different types of navigation providers in a publishing/content management system.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/navigation/publishing_navigation_provider_type.py

  • class SiteType 69.4% similar

    A simple enumeration-like class that defines constants for SharePoint site types.

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

  • class PageType 64.9% similar

    An enumeration class that defines constants representing different SharePoint page types as specified in the MS-WSSFO3 protocol specification.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/pages/page_type.py

  • class KnownFeaturesList 61.8% similar

    A class that defines constant identifiers (UUIDs) for known SharePoint features.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/features/known_list.py

  • class NavigationService 60.9% similar

    NavigationService is a REST-based service class for managing SharePoint navigation operations, including global navigation, menu states, and publishing navigation providers.

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