🔍 Code Extractor

A data class representing information about a participant in a meeting, including their identity, role, and user principal name.

Purpose

This class serves as a data container for meeting participant information within the Office 365 API integration. It inherits from ClientValue, making it suitable for serialization and transmission in API requests/responses. The class encapsulates three key pieces of information about a meeting participant: their identity (represented by an IdentitySet object), their role in the meeting, and their user principal name (UPN). This is typically used when working with Microsoft Teams or other Office 365 meeting services to represent participant metadata.

Source Code

class MeetingParticipantInfo(ClientValue):
    """Information about a participant in a meeting."""

    def __init__(self, identity=IdentitySet(), role=None, upn=None):
        """
        :param IdentitySet identity: Identity information of the participant.
        :param str role: Specifies the participant's role in the meeting.
        :param str upn: User principal name of the participant.
        """
        self.identity = identity
        self.role = role
        self.upn = upn

Parameters

Parameter Details

identity: An IdentitySet object containing identity information of the participant. Defaults to an empty IdentitySet() if not provided. This typically includes details like display name, ID, and other identity-related information.

role: A string specifying the participant's role in the meeting (e.g., 'organizer', 'presenter', 'attendee'). Defaults to None if not specified. The exact values depend on the meeting platform's role definitions.

upn: User principal name (UPN) of the participant, typically in email format (e.g., 'user@domain.com'). This is a unique identifier in Azure Active Directory. Defaults to None if not provided.

Return Value

Instantiation returns a MeetingParticipantInfo object with three attributes (identity, role, upn) set to the provided values or their defaults. The object can be used to represent participant information in Office 365 API operations.

Class Interface

Methods

Attributes

Dependencies

• office365.directory.permissions.identity_set
• office365.runtime.client_value

Required Imports

from office365.directory.permissions.identity_set import IdentitySet
from office365.runtime.client_value import ClientValue

Usage Example

from office365.directory.permissions.identity_set import IdentitySet
from office365.runtime.client_value import ClientValue

# Create a basic participant with default identity
participant1 = MeetingParticipantInfo()

# Create a participant with specific role and UPN
participant2 = MeetingParticipantInfo(
    identity=IdentitySet(),
    role='presenter',
    upn='john.doe@company.com'
)

# Access participant information
print(participant2.role)  # Output: 'presenter'
print(participant2.upn)   # Output: 'john.doe@company.com'

# Create a participant with custom identity
custom_identity = IdentitySet()
participant3 = MeetingParticipantInfo(
    identity=custom_identity,
    role='attendee',
    upn='jane.smith@company.com'
)

Best Practices

• Always provide a valid IdentitySet object for the identity parameter when creating participants with known identity information
• Use standard role values that are recognized by the Office 365 meeting platform (e.g., 'organizer', 'presenter', 'attendee')
• Ensure the UPN follows the standard email format and corresponds to a valid Azure Active Directory user
• This class is immutable after instantiation - attributes can be modified directly but consider creating new instances for different participants
• When using with Office 365 API calls, ensure the parent ClientValue serialization methods are properly utilized
• The class inherits from ClientValue, which likely provides serialization capabilities for API communication - leverage these inherited methods when transmitting data

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class MeetingParticipants 76.4% similar

  A data class representing participants in a meeting, including an organizer and a collection of attendees.

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

• class ParticipantInfo 76.4% similar

  A data class that stores additional properties about a participant's identity, specifically their country code location information.

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

• class MeetingInfo 73.3% similar

  An abstract base class that serves as a container for meeting-specific information, inheriting from ClientValue to provide serialization capabilities for Office 365 API interactions.

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

• class InvitationParticipantInfo 71.1% similar

  A data class representing an entity being invited to a group call, containing participant identification, visibility settings, and call routing configuration.

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

• class JoinMeetingIdMeetingInfo 63.9% similar

  A class representing meeting information for joining an existing Microsoft Teams/Office 365 meeting using a joinMeetingId and optional passcode.

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