🔍 Code Extractor

A class representing the response format for canceling a media processing operation in Microsoft 365 Communications services.

Purpose

This class serves as a data model for the response received when canceling a media processing operation in Microsoft 365 Communications. It inherits from CommsOperation and provides a structured format for handling the cancellation response. This is typically used in scenarios involving real-time communications where media processing operations need to be terminated before completion.

Source Code

class CancelMediaProcessingOperation(CommsOperation):
    """Describes the response format of the cancel media processing operation."""

Parameters

Parameter Details

bases: Inherits from CommsOperation, which provides the base functionality for communication operations in Microsoft 365

Return Value

Instantiation returns a CancelMediaProcessingOperation object that represents the response format for a media processing cancellation operation. The object inherits all methods and attributes from CommsOperation.

Class Interface

Dependencies

• office365

Required Imports

from office365.communications.operations.comms import CommsOperation
from office365.communications.operations.cancel_media_processing import CancelMediaProcessingOperation

Usage Example

from office365.communications.operations.cancel_media_processing import CancelMediaProcessingOperation
from office365.runtime.client_request import ClientRequest

# Typically used as part of a larger communication workflow
# The class is instantiated internally by the SDK when processing responses
operation = CancelMediaProcessingOperation()

# The object would be populated with response data from the API
# and used to track the status of the cancellation operation
# Access inherited properties from CommsOperation
operation_id = operation.id
operation_status = operation.status

Best Practices

• This class is primarily used internally by the Office365 SDK to deserialize API responses
• Do not manually instantiate this class unless you are mocking API responses for testing
• The class inherits all functionality from CommsOperation, so refer to the parent class documentation for available methods and attributes
• This is a response model class, meaning it represents data returned from the API rather than being used to make requests
• Ensure proper authentication is configured before making API calls that would return this type
• Check the inherited status property to determine if the cancellation operation completed successfully

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class UnmuteParticipantOperation 71.3% similar

  A class representing the response format for an unmute participant operation in a communications context, inheriting from CommsOperation.

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

• class UpdateRecordingStatusOperation 65.9% similar

  A class representing the response format for an update recording status action in Microsoft 365 communications operations.

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

• class CommsOperation 61.6% similar

  Represents the status of long-running communications operations in Microsoft Graph API, tracking operation progress and results through notifications.

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

• class StopHoldMusicOperation 61.4% similar

  A class representing the status of a stopHoldMusic operation in Microsoft 365 communications, used to track the result of stopping hold music during a call.

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

• class StartHoldMusicOperation 58.6% similar

  A class representing the status of a startHoldMusic operation in Microsoft 365 communications, inheriting from CommsOperation.

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