class OnlineMeeting
Contains information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/onlinemeetings/online_meeting.py
10 - 118
moderate
Purpose
Contains information about a meeting, including the URL used to join a meeting, the attendees list, and the description.
Source Code
class OnlineMeeting(Entity):
"""
Contains information about a meeting, including the URL used to join a meeting,
the attendees list, and the description.
"""
@property
def allow_attendee_to_enable_camera(self):
# type: () -> Optional[bool]
"""Indicates whether attendees can turn on their camera."""
return self.properties.get("allowAttendeeToEnableCamera", None)
@property
def allow_attendee_to_enable_mic(self):
# type: () -> Optional[bool]
"""Indicates whether attendees can turn on their microphone."""
return self.properties.get("allowAttendeeToEnableMic", None)
@property
def allowed_presenters(self):
"""Specifies who can be a presenter in a meeting. Possible values are listed in the following table."""
return self.properties.get("allowedPresenters", StringCollection())
@property
def allow_meeting_chat(self):
# type: () -> Optional[bool]
"""Specifies the mode of meeting chat."""
return self.properties.get("allowMeetingChat", None)
@property
def allow_participants_to_change_name(self):
# type: () -> Optional[bool]
"""Specifies if participants are allowed to rename themselves in an instance of the meeting."""
return self.properties.get("allowParticipantsToChangeName", None)
@property
def attendee_report(self):
# type: () -> Optional[AnyStr]
"""The content stream of the attendee report of a Microsoft Teams live event."""
return self.properties.get("attendeeReport", None)
@property
def participants(self):
"""
The participants associated with the online meeting. This includes the organizer and the attendees.
"""
return self.properties.get("participants", MeetingParticipants())
@property
def subject(self):
# type: () -> Optional[str]
"""The subject of the online meeting."""
return self.properties.get("subject", None)
@subject.setter
def subject(self, value):
# type: (str) -> None
self.set_property("subject", value)
@property
def start_datetime(self):
"""Gets the meeting start time in UTC."""
return self.properties.get("startDateTime", datetime.min)
@start_datetime.setter
def start_datetime(self, value):
# type: (datetime) -> None
"""
Sets the meeting start time in UTC.
"""
self.set_property("startDateTime", value.isoformat())
@property
def end_datetime(self):
"""Gets the meeting end time in UTC."""
return self.properties.get("endDateTime", datetime.min)
@end_datetime.setter
def end_datetime(self, value):
# type: (datetime) -> None
"""Sets the meeting end time in UTC."""
self.set_property("endDateTime", value.isoformat())
@property
def join_information(self):
"""The join URL of the online meeting. Read-only."""
return self.properties.get("joinInformation", ItemBody())
@property
def join_web_url(self):
# type: () -> Optional[str]
"""The join URL of the online meeting. Read-only."""
return self.properties.get("joinWebUrl", None)
@property
def video_teleconference_id(self):
# type: () -> Optional[str]
"""The video teleconferencing ID."""
return self.properties.get("videoTeleconferenceId", None)
def get_property(self, name, default_value=None):
if default_value is None:
property_mapping = {
"endDateTime": self.end_datetime,
"joinInformation": self.join_information,
"startDateTime": self.start_datetime,
}
default_value = property_mapping.get(name, None)
return super(OnlineMeeting, self).get_property(name, default_value)
Parameters
| Name | Type | Default | Kind |
|---|---|---|---|
bases |
Entity | - |
Parameter Details
bases: Parameter of type Entity
Return Value
Returns unspecified type
Class Interface
Methods
allow_attendee_to_enable_camera(self)
property
Purpose: Indicates whether attendees can turn on their camera.
Returns: None
allow_attendee_to_enable_mic(self)
property
Purpose: Indicates whether attendees can turn on their microphone.
Returns: None
allowed_presenters(self)
property
Purpose: Specifies who can be a presenter in a meeting. Possible values are listed in the following table.
Returns: None
allow_meeting_chat(self)
property
Purpose: Specifies the mode of meeting chat.
Returns: None
allow_participants_to_change_name(self)
property
Purpose: Specifies if participants are allowed to rename themselves in an instance of the meeting.
Returns: None
attendee_report(self)
property
Purpose: The content stream of the attendee report of a Microsoft Teams live event.
Returns: None
participants(self)
property
Purpose: The participants associated with the online meeting. This includes the organizer and the attendees.
Returns: None
subject(self)
property
Purpose: The subject of the online meeting.
Returns: None
subject(self, value)
Purpose: Performs subject
Parameters:
value: Parameter
Returns: None
start_datetime(self)
property
Purpose: Gets the meeting start time in UTC.
Returns: None
start_datetime(self, value)
Purpose: Sets the meeting start time in UTC.
Parameters:
value: Parameter
Returns: None
end_datetime(self)
property
Purpose: Gets the meeting end time in UTC.
Returns: None
end_datetime(self, value)
Purpose: Sets the meeting end time in UTC.
Parameters:
value: Parameter
Returns: None
join_information(self)
property
Purpose: The join URL of the online meeting. Read-only.
Returns: None
join_web_url(self)
property
Purpose: The join URL of the online meeting. Read-only.
Returns: None
video_teleconference_id(self)
property
Purpose: The video teleconferencing ID.
Returns: None
get_property(self, name, default_value)
Purpose: Retrieves property
Parameters:
name: Parameterdefault_value: Parameter
Returns: None
Required Imports
from datetime import datetime
from typing import AnyStr
from typing import Optional
from office365.communications.onlinemeetings.participants import MeetingParticipants
from office365.entity import Entity
Usage Example
# Example usage:
# result = OnlineMeeting(bases)
Tags
Similar Components
AI-powered semantic similarity - components with related functionality:
-
class JoinMeetingIdMeetingInfo 62.1% similar
-
class OnlineMeetingCollection 60.3% similar
-
class MeetingInfo 56.9% similar
-
class MeetingParticipants 55.5% similar
-
class Presence 52.8% similar