class Endpoint
Represents an endpoint in a call, such as a user's device, meeting, application, or bot. This is a base class that is inherited by participantEndpoint and serviceEndpoint types.
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/callrecords/endpoint.py
4 - 6
simple
Purpose
The Endpoint class serves as a base representation for various types of endpoints that can participate in a call within the Office365 ecosystem. It inherits from ClientValue, which provides serialization and deserialization capabilities for communication with Office365 services. This class is designed to be extended by more specific endpoint types (participantEndpoint and serviceEndpoint) that represent different kinds of call participants. It provides a common interface and structure for all endpoint types in the call management system.
Source Code
class Endpoint(ClientValue):
"""Represents an endpoint in a call. The endpoint could be a user's device, a meeting, an application/bot, etc.
The participantEndpoint and serviceEndpoint types inherit from this type."""Parameters
| Name | Type | Default | Kind |
|---|---|---|---|
bases |
ClientValue | - |
Parameter Details
bases: The class inherits from ClientValue, which is a base class from the office365.runtime module that provides functionality for client-side value objects that can be serialized and sent to Office365 services
Return Value
Instantiating this class returns an Endpoint object that represents a call endpoint. The object inherits all methods and properties from ClientValue, which typically include serialization methods (to_json, from_json) and property management capabilities. Specific return values depend on the inherited methods from ClientValue.
Class Interface
Dependencies
office365
Required Imports
from office365.runtime.client_value import ClientValue
from office365.communications.calls.endpoint import Endpoint
Usage Example
from office365.runtime.client_value import ClientValue
from office365.communications.calls.endpoint import Endpoint
# Note: Endpoint is typically used as a base class, not instantiated directly
# It would be extended by specific endpoint types:
class ParticipantEndpoint(Endpoint):
def __init__(self):
super().__init__()
# Add participant-specific properties
class ServiceEndpoint(Endpoint):
def __init__(self):
super().__init__()
# Add service-specific properties
# Usage in a call context:
participant_endpoint = ParticipantEndpoint()
service_endpoint = ServiceEndpoint()
# These endpoints would then be used in call operations
# such as adding participants or configuring call servicesBest Practices
- This class is designed as a base class and should typically be extended rather than instantiated directly
- Use participantEndpoint or serviceEndpoint subclasses for specific endpoint types
- Ensure proper Office365 authentication is configured before using endpoint objects in call operations
- The class inherits from ClientValue, so it supports serialization to/from JSON for API communication
- When extending this class, maintain compatibility with the Office365 communications API schema
- Endpoint objects are typically used in the context of call management operations and should be created with appropriate properties for the specific endpoint type
Tags
Similar Components
AI-powered semantic similarity - components with related functionality:
-
class MeetingParticipants 61.2% similar
-
class SearchEndpoints 59.0% similar
-
class MeetingParticipantInfo 57.5% similar
-
class Attendee 57.2% similar
-
class TenantAdminEndpoints 57.0% similar