class documentation
class RESTList(RESTBase, Sequence): (source)
Known subclasses: mailmanclient.restobjects.address.Addresses
, mailmanclient.restobjects.ban.Bans
, mailmanclient.restobjects.header_match.HeaderMatches
, mailmanclient.restobjects.templates.TemplateList
Base class for REST data that behaves like a list.
The _factory
attribute is a callable that will be applied on each
returned member of the list.
Method | __delitem__ |
Undocumented |
Method | __getitem__ |
Undocumented |
Method | __iter__ |
Undocumented |
Method | __len__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | clear |
Undocumented |
Property | rest |
Get data from API and cache it (only once per instance). |
Class Variable | _factory |
Undocumented |
Inherited from RESTBase
:
Method | __init__ |
No summary |
Method | save |
Undocumented |
Method | _get |
Undocumented |
Method | _reset |
Undocumented |
Method | _set |
Undocumented |
Class Variable | _autosave |
automatically send a PATCH request to the API when a value is changed. Otherwise, the save() method must be called. |
Class Variable | _properties |
the list of expected entity properties. This is required for API elements that behave like an object, with REST data accessed through attributes. If this value is None, the REST data is used to list available properties. |
Class Variable | _read |
list of properties that cannot be written to (defaults to self_link only). |
Class Variable | _writable |
list of properties that can be written to using a PATCH request. If this value is None , all properties are writable. |
Instance Variable | _changed |
Undocumented |
Instance Variable | _connection |
Undocumented |
Instance Variable | _rest |
Undocumented |
Instance Variable | _url |
Undocumented |
overridden in
mailmanclient.restobjects.ban.Bans
, mailmanclient.restobjects.header_match.HeaderMatches
Undocumented