Module exchangelib.services.get_rooms

Expand source code
from .common import EWSService
from ..properties import Room
from ..util import create_element, set_xml_value, MNS
from ..version import EXCHANGE_2010


class GetRooms(EWSService):
    """MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/getrooms-operation"""

    SERVICE_NAME = 'GetRooms'
    element_container_name = '{%s}Rooms' % MNS
    supported_from = EXCHANGE_2010

    def call(self, roomlist):
        return self._elems_to_objs(self._get_elements(payload=self.get_payload(roomlist=roomlist)))

    def _elems_to_objs(self, elems):
        for elem in elems:
            if isinstance(elem, Exception):
                yield elem
                continue
            yield Room.from_xml(elem=elem, account=None)

    def get_payload(self, roomlist):
        getrooms = create_element('m:%s' % self.SERVICE_NAME)
        set_xml_value(getrooms, roomlist, version=self.protocol.version)
        return getrooms

Classes

class GetRooms (protocol, chunk_size=None, timeout=None)
Expand source code
class GetRooms(EWSService):
    """MSDN: https://docs.microsoft.com/en-us/exchange/client-developer/web-service-reference/getrooms-operation"""

    SERVICE_NAME = 'GetRooms'
    element_container_name = '{%s}Rooms' % MNS
    supported_from = EXCHANGE_2010

    def call(self, roomlist):
        return self._elems_to_objs(self._get_elements(payload=self.get_payload(roomlist=roomlist)))

    def _elems_to_objs(self, elems):
        for elem in elems:
            if isinstance(elem, Exception):
                yield elem
                continue
            yield Room.from_xml(elem=elem, account=None)

    def get_payload(self, roomlist):
        getrooms = create_element('m:%s' % self.SERVICE_NAME)
        set_xml_value(getrooms, roomlist, version=self.protocol.version)
        return getrooms

Ancestors

Class variables

var SERVICE_NAME
var element_container_name
var supported_from

Methods

def call(self, roomlist)
Expand source code
def call(self, roomlist):
    return self._elems_to_objs(self._get_elements(payload=self.get_payload(roomlist=roomlist)))
def get_payload(self, roomlist)
Expand source code
def get_payload(self, roomlist):
    getrooms = create_element('m:%s' % self.SERVICE_NAME)
    set_xml_value(getrooms, roomlist, version=self.protocol.version)
    return getrooms

Inherited members