🔍 Code Extractor

A data class that encapsulates the result of a follow operation on a SharePoint item, containing the followed item and the result status.

Purpose

The FollowResult class serves as a container for information returned when a user attempts to follow a SharePoint item. It inherits from ClientValue and provides structured access to both the item being followed and the outcome of the follow request. This class is typically used in SharePoint user profile operations to track social following activities and their success/failure states.

Source Code

class FollowResult(ClientValue):
    """The FollowResult class returns information about a request to follow an item."""

    def __init__(self, item=FollowedItem(), result_type=None):
        """
        :param FollowedItem item: The Item property contains the item being followed.
        :param int result_type: The ResultType property provides information about the attempt to follow an item.
            For details on the FollowResultType type, see section 3.1.5.54.
        """
        self.Item = item
        self.ResultType = result_type

Parameters

Parameter Details

item: A FollowedItem object representing the SharePoint item that was targeted for following. Defaults to an empty FollowedItem() instance if not provided. This contains metadata about the item such as its URL, title, and type.

result_type: An integer value indicating the outcome of the follow operation. This corresponds to the FollowResultType enumeration (see section 3.1.5.54 of SharePoint documentation). Common values indicate success, failure, or specific error conditions. Defaults to None if not specified.

Return Value

Instantiation returns a FollowResult object with two accessible attributes: Item (the FollowedItem being followed) and ResultType (the integer status code of the operation). This object can be serialized as a ClientValue for transmission to/from SharePoint services.

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.runtime.client_value import ClientValue
from office365.sharepoint.userprofiles.followed_item import FollowedItem

Usage Example

from office365.runtime.client_value import ClientValue
from office365.sharepoint.userprofiles.followed_item import FollowedItem
from office365.sharepoint.userprofiles.follow_result import FollowResult

# Create a followed item
followed_item = FollowedItem()
followed_item.Uri = "https://contoso.sharepoint.com/sites/team"
followed_item.Title = "Team Site"

# Create a follow result indicating success (result_type=0 typically means success)
follow_result = FollowResult(item=followed_item, result_type=0)

# Access the result properties
print(f"Followed item: {follow_result.Item.Title}")
print(f"Result type: {follow_result.ResultType}")

# Create with defaults
default_result = FollowResult()
print(f"Default result type: {default_result.ResultType}")  # None

Best Practices

• Always check the ResultType property after a follow operation to determine if the operation succeeded
• The class is immutable after instantiation by design - create new instances rather than modifying existing ones
• Use this class as a read-only container for follow operation results rather than for initiating follow operations
• When creating instances manually for testing, ensure the result_type value matches the expected FollowResultType enumeration values
• The Item attribute should always contain a valid FollowedItem object, even if the follow operation failed
• This class inherits from ClientValue, making it suitable for serialization in SharePoint API communications

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class FollowedItem 75.2% similar

  A data class representing an item that is followed by a user in a SharePoint/Office365 context, specifically designed for server-to-server operations.

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

• class FollowedContent 69.8% similar

  The FollowedContent class provides access to followed content items in SharePoint user profiles, allowing server-side management of followed items and retrieval of followed content URLs.

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

• class SocialRestFollowingManager 61.5% similar

  A SharePoint Social REST API manager class that provides methods for managing a user's list of followed actors, including users, documents, sites, and tags, as well as retrieving followers.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/social/following/rest_manager.py

• class DlpClassificationResult 61.2% similar

  A class representing the result of a DLP (Data Loss Prevention) classification operation in SharePoint's compliance policy system.

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

• class SharedWithMeViewItemRemovalResult 61.0% similar

  A result object that encapsulates the outcome of removing an item from a user's 'Shared With Me' view in SharePoint.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/userprofiles/sharedwithme/view_item_removal_result.py