class MeetingParticipants
A data class representing participants in a meeting, including an organizer and a collection of attendees.
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/onlinemeetings/participants.py
8 - 18
simple
Purpose
This class serves as a container for meeting participant information in the Office365 communications API. It encapsulates the organizer details and a collection of attendees, providing a structured way to manage and pass meeting participant data. The class inherits from ClientValue, making it compatible with the Office365 SDK's serialization and communication mechanisms.
Source Code
class MeetingParticipants(ClientValue):
"""Participants in a meeting."""
def __init__(self, organizer=MeetingParticipantInfo(), attendees=None):
"""
:param MeetingParticipantInfo organizer:
:param list[MeetingParticipantInfo] attendees:
"""
super(MeetingParticipants, self).__init__()
self.organizer = organizer
self.attendees = ClientValueCollection(MeetingParticipantInfo, attendees)
Parameters
| Name | Type | Default | Kind |
|---|---|---|---|
bases |
ClientValue | - |
Parameter Details
organizer: A MeetingParticipantInfo object representing the meeting organizer. Defaults to an empty MeetingParticipantInfo instance if not provided. Contains details about the person who organized the meeting.
attendees: A list of MeetingParticipantInfo objects representing the meeting attendees. Can be None or an empty list. Will be wrapped in a ClientValueCollection for proper handling within the Office365 SDK framework.
Return Value
Instantiation returns a MeetingParticipants object with two attributes: 'organizer' (a MeetingParticipantInfo instance) and 'attendees' (a ClientValueCollection of MeetingParticipantInfo instances). This object can be used to represent and manipulate meeting participant data within the Office365 API context.
Class Interface
Methods
__init__(self, organizer=MeetingParticipantInfo(), attendees=None) -> None
Purpose: Initializes a MeetingParticipants instance with an organizer and optional list of attendees
Parameters:
organizer: MeetingParticipantInfo object representing the meeting organizer, defaults to empty MeetingParticipantInfo()attendees: Optional list of MeetingParticipantInfo objects representing attendees, defaults to None
Returns: None (constructor)
Attributes
| Name | Type | Description | Scope |
|---|---|---|---|
organizer |
MeetingParticipantInfo | The organizer of the meeting, stored as a MeetingParticipantInfo instance | instance |
attendees |
ClientValueCollection[MeetingParticipantInfo] | A collection of meeting attendees, wrapped in a ClientValueCollection for proper SDK handling | instance |
Dependencies
office365
Required Imports
from office365.communications.onlinemeetings.participant_info import MeetingParticipantInfo
from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import ClientValueCollection
Usage Example
from office365.communications.onlinemeetings.participant_info import MeetingParticipantInfo
from office365.communications.onlinemeetings.participants import MeetingParticipants
# Create organizer
organizer = MeetingParticipantInfo()
# Create attendees
attendee1 = MeetingParticipantInfo()
attendee2 = MeetingParticipantInfo()
attendees_list = [attendee1, attendee2]
# Instantiate MeetingParticipants with organizer and attendees
participants = MeetingParticipants(organizer=organizer, attendees=attendees_list)
# Access organizer
meeting_organizer = participants.organizer
# Access attendees collection
meeting_attendees = participants.attendees
# Create with defaults (empty organizer, no attendees)
default_participants = MeetingParticipants()
Best Practices
- Always provide a valid MeetingParticipantInfo object for the organizer parameter to ensure proper meeting organization
- The attendees parameter can be None or an empty list if there are no attendees initially; the ClientValueCollection will handle this gracefully
- This class is a data container and does not perform validation; ensure MeetingParticipantInfo objects are properly initialized before adding them
- As a ClientValue subclass, this object is designed for serialization and transmission via the Office365 API
- The class is immutable after instantiation in terms of structure, but the organizer and attendees attributes can be modified
- Use this class when working with Office365 online meetings API to represent participant information in a structured format
Tags
Similar Components
AI-powered semantic similarity - components with related functionality:
-
class MeetingParticipantInfo 76.4% similar
-
class MeetingInfo 68.5% similar
-
class Attendee 64.2% similar
-
class Participant 62.1% similar
-
class InvitationParticipantInfo 61.6% similar