🔍 Code Extractor

A class representing an error from a failed OneNote operation, extending ClientValue to encapsulate error details.

Purpose

This class serves as a data container for OneNote operation errors, storing error messages and error codes. It inherits from ClientValue, which is part of the Office365 REST API Python client library, allowing it to be serialized and deserialized when communicating with the OneNote API. This class is typically used to represent error responses from OneNote operations, providing structured access to error information.

Source Code

class OnenoteOperationError(ClientValue):
    """An error from a failed OneNote operation."""

    def __init__(self, message=None, code=None):
        """
        :param str message: The error message.
        :param str code: The error code.
        """
        super(OnenoteOperationError, self).__init__()
        self.message = message
        self.code = code

Parameters

Parameter Details

message: A string containing the human-readable error message describing what went wrong during the OneNote operation. Can be None if no message is provided. This typically contains detailed information about the failure.

code: A string containing the error code that identifies the specific type of error that occurred. Can be None if no code is provided. Error codes are typically standardized identifiers used by the OneNote API to categorize different error types.

Return Value

Instantiation returns an OnenoteOperationError object with message and code attributes set to the provided values (or None if not provided). The object inherits from ClientValue, making it compatible with the Office365 REST API client's serialization mechanisms.

Class Interface

Methods

Attributes

Dependencies

• office365-rest-python-client

Required Imports

from office365.runtime.client_value import ClientValue
from office365.onenote.onenote_operation_error import OnenoteOperationError

Usage Example

# Create an error object with both message and code
error = OnenoteOperationError(
    message="Failed to create notebook: Access denied",
    code="accessDenied"
)

# Access error details
print(f"Error Code: {error.code}")
print(f"Error Message: {error.message}")

# Create an error object with only a message
error2 = OnenoteOperationError(message="Unknown error occurred")

# Create an empty error object
error3 = OnenoteOperationError()
print(error3.message)  # None
print(error3.code)     # None

Best Practices

• This class is primarily a data container and should be instantiated when capturing error information from OneNote API operations.
• Always check if message and code attributes are None before using them, as they are optional parameters.
• This class inherits from ClientValue, which means it's designed to work with the Office365 REST API client's serialization framework. Don't modify the inheritance chain.
• Typically, you won't instantiate this class directly in application code; instead, it will be created by the Office365 API client library when errors occur.
• The class has no methods beyond the constructor, so its lifecycle is straightforward: instantiate, set attributes (via constructor), and read attributes as needed.
• Since this is an immutable-style data container, consider setting all relevant information during instantiation rather than modifying attributes afterward.
• This class does not raise exceptions or have side effects; it simply stores error information for later inspection.

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class OnenoteOperation 72.2% similar

  A class representing the status of long-running OneNote operations, extending the base Operation class with error handling capabilities.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/operations/onenote.py

• class Onenote 61.3% similar

  The Onenote class serves as the entry point for accessing Microsoft OneNote resources through the Microsoft Graph API, providing access to notebooks, pages, sections, and other OneNote entities.

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

• class ExternalLink 59.5% similar

  A simple data class that represents a URL link to a OneNote page or notebook, inheriting from ClientValue.

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

• class CopyNotebookModel 56.0% similar

  CopyNotebookModel is a data model class that inherits from ClientValue, representing a notebook copy operation in the Office365 API context.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/onenote/notebooks/copy_notebook_model.py

• class SynchronizationError 55.3% similar

  SynchronizationError is an exception class that represents errors occurring during synchronization operations in Office 365 client operations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/directory/synchronization/error.py