allow filters to be specified in most Get() calls

[plcapi.git] / PLC / Methods / GetPeers.py

diff --git a/PLC/Methods/GetPeers.py b/PLC/Methods/GetPeers.py
index cc85ef1..e4fd459 100644 (file)
--- a/PLC/Methods/GetPeers.py
+++ b/PLC/Methods/GetPeers.py
@@ -5,24 +5,29 @@
 from PLC.Faults import *
 from PLC.Method import Method
 from PLC.Parameter import Parameter, Mixed
+from PLC.Filter import Filter
 from PLC.Auth import Auth
 
 from PLC.Peers import Peer, Peers
 
 class GetPeers (Method):
     """
-    returns information on known peers
+    Returns an array of structs containing details about peers. If
+    person_filter is specified and is an array of peer identifiers or
+    peer names, or a struct of peer attributes, only peers matching
+    the filter will be returned.
     """
 
     roles = ['admin']
 
-    accepts = [Auth(),
-              [Mixed(Peer.fields['peer_id'],
-                     Peer.fields['peername'])],
-              ]
+    accepts = [
+        Auth(),
+        Mixed([Mixed(Peer.fields['peer_id'],
+                     Peer.fields['peername'])],
+              Filter(Peer.fields))
+        ]
 
     returns = [Peer.fields]
 
-    def call (self, auth, peer_id_or_peername_list = None):
-
-       return Peers (self.api, peer_id_or_peername_list).values()
+    def call (self, auth, peer_filter = None):
+       return Peers(self.api, peer_filter).values()