clerie/mitel_ommclient2
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Expose connection object directly instead of proxying the request method

Browse Source
This commit is contained in:
clerie 2022-04-02 21:10:05 +02:00
parent 8f4a7b1f6d
commit 7076eb1543
2 changed files with 10 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/manual/client.rst
View File

@ -37,6 +37,7 @@ validate common API requests. See class documentation to get and overview and op
Making custom requests Making custom requests
---------------------- ----------------------
:func:`mitel_ommclient2.client.OMMClient2.request` allowes you to send custom requests. :class:`mitel_ommclient2.client.OMMClient2` holds its :class:`mitel_ommclient2.connection.Connection`
It just passes arguments and results to :func:`mitel_ommclient2.connection.Connection.request`. in the connection attribute.
Use :func:`mitel_ommclient2.connection.Connection.request` directly for making some custom requests.
See :doc:`/manual/connection` about using this. See :doc:`/manual/connection` about using this.

29
mitel_ommclient2/client.py
View File

@ -23,7 +23,7 @@ class OMMClient2:
Use request to send custom messages:: Use request to send custom messages::
>>> r = s.request(mitel_ommclient2.messages.Ping()) >>> r = s.connection.request(mitel_ommclient2.messages.Ping())
""" """
def __init__(self, host, username, password, port=None, ommsync=False): def __init__(self, host, username, password, port=None, ommsync=False):
@ -39,28 +39,13 @@ class OMMClient2:
kwargs["port"] = self._port kwargs["port"] = self._port
# Connect # Connect
self._connection = Connection(self._host, **kwargs) self.connection = Connection(self._host, **kwargs)
self._connection.connect() self.connection.connect()
# Login # Login
r = self.request(messages.Open(self._username, self._password, UserDeviceSyncClient=self._ommsync)) r = self.connection.request(messages.Open(self._username, self._password, UserDeviceSyncClient=self._ommsync))
r.raise_on_error() r.raise_on_error()
def request(self, request):
"""
Sends a request, waits for response and returns response
:param request: Request object
Usage::
>>> r = c.request(mitel_ommclient2.messages.Ping())
>>> r.name
'PingResp'
"""
return self._connection.request(request)
def get_account(self, id): def get_account(self, id):
""" """
Get account Get account
@ -68,7 +53,7 @@ class OMMClient2:
:param id: User id :param id: User id
""" """
r = self.request(messages.GetAccount(id)) r = self.connection.request(messages.GetAccount(id))
r.raise_on_error() r.raise_on_error()
if r.account is None: if r.account is None:
return None return None
@ -80,7 +65,7 @@ class OMMClient2:
:param id: Device id :param id: Device id
""" """
r = self.request(messages.GetPPDev(ppn)) r = self.connection.request(messages.GetPPDev(ppn))
r.raise_on_error() r.raise_on_error()
if r.pp is None: if r.pp is None:
return None return None
@ -93,7 +78,7 @@ class OMMClient2:
Returns `True` when response is received. Returns `True` when response is received.
""" """
r = self.request(messages.Ping()) r = self.connection.request(messages.Ping())
if r.errCode is None: if r.errCode is None:
return True return True
return False return False