🔍 Code Extractor

Represents a group of room objects (room list) defined in a Microsoft 365 tenant, providing access to room collections and their email addresses.

Purpose

This class models a room list in Microsoft 365/Outlook, which is a collection of meeting rooms. It extends the Place class to provide specific functionality for managing and accessing groups of rooms within a tenant. The class allows retrieval of the room list's email address and provides navigation to the individual Room objects contained within the list. It's primarily used in calendar and room booking scenarios within Microsoft 365 integrations.

Source Code

class RoomList(Place):
    """Represents a group of room objects defined in the tenant."""

    @property
    def email_address(self):
        # type: () -> Optional[str]
        """The email address of the room list"""
        return self.properties.get("emailAddress", None)

    @property
    def calendars(self):
        # type: () -> EntityCollection[Room]
        """The calendars in the calendar group. Navigation property. Read-only. Nullable."""
        return self.properties.get(
            "rooms",
            EntityCollection(
                self.context, Room, ResourcePath("rooms", self.resource_path)
            ),
        )

Parameters

Parameter Details

context: The client context object required for making API calls to Microsoft 365 services. Inherited from parent Place class, used to maintain connection state and authentication.

resource_path: The resource path identifying this room list in the Microsoft Graph API hierarchy. Inherited from parent Place class, used for constructing API endpoints.

Return Value

Instantiation returns a RoomList object that represents a specific room list in the tenant. The object provides access to the room list's properties including its email address and a collection of Room objects. Properties return either Optional[str] for email_address or EntityCollection[Room] for calendars/rooms.

Class Interface

Methods

Attributes

Dependencies

• typing
• office365.entity_collection
• office365.outlook.calendar.place
• office365.outlook.calendar.rooms.room
• office365.runtime.paths.resource_path

Required Imports

from typing import Optional
from office365.entity_collection import EntityCollection
from office365.outlook.calendar.place import Place
from office365.outlook.calendar.rooms.room import Room
from office365.runtime.paths.resource_path import ResourcePath

Usage Example

# Assuming you have a configured client context
from office365.outlook.calendar.rooms.room_list import RoomList
from office365.runtime.client_context import ClientContext

# Get a room list from the context (typically retrieved via API call)
room_list = context.get_room_list('room-list-id')

# Access the email address of the room list
email = room_list.email_address
print(f"Room list email: {email}")

# Access the collection of rooms in this list
rooms_collection = room_list.calendars
for room in rooms_collection:
    print(f"Room: {room.display_name}")

# The calendars property provides navigation to individual Room objects
rooms = room_list.calendars.get().execute_query()
for room in rooms:
    print(f"Room email: {room.email_address}")

Best Practices

• Always ensure the client context is properly authenticated before accessing RoomList properties
• The calendars property returns an EntityCollection which may require calling execute_query() to fetch actual data from the API
• Email address may be None if not set or not accessible, always check for None before using
• RoomList inherits from Place, so all Place properties and methods are available
• The properties dictionary is lazily loaded, so accessing properties may trigger API calls
• Use the calendars property to navigate to individual Room objects rather than accessing them directly
• Consider caching room list data if accessed frequently to minimize API calls
• Handle potential API errors when accessing properties that require network calls

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Room 75.0% similar

  Represents a room in a tenant within Exchange Online, where each room is associated with a room mailbox.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/rooms/room.py

• class Place 65.2% similar

  Represents a physical location with basic attributes including name, address, and phone number. Serves as a base class for more specialized location types like rooms and room lists.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/place.py

• class Location 60.1% similar

  Represents location information for calendar events in Microsoft Outlook/Office 365, supporting various location types including physical addresses, coordinates, and email-based locations.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/mail/location.py

• class CalendarGroup 58.9% similar

  A class representing a group of user calendars in Microsoft Office 365, providing access to calendar group properties and associated calendars.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/group.py

• class Event 56.5% similar

  Represents a calendar event in Microsoft 365, providing methods to manage event responses (accept, decline, cancel), reminders, and access to event properties like attendees, attachments, and scheduling details.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/outlook/calendar/events/event.py