The api.objects.Events class¶
Inherits from ABC > SimvueObject
Methods¶
__init__()¶
commit()¶
Send updates to the server, or if offline, store locally.
count()¶
Return the total number of entries for this object type from the server.
Returns
int
total from server database for current user.
delete()¶
Event set deletion not implemented.
Raises
NotImplementedError
as event set deletion not supported
get()¶
histogram()¶
ids(...)¶
Retrieve a list of all object identifiers.
Parameters
| count | int | None |
= None |
limit number of objects |
| offset | int | None |
= None |
set start index for objects list |
Yields
str
identifiers for all objects of this type.
new()¶
Create a new Events entry on the Simvue server
on_reconnect()¶
read_only(...)¶
Set whether this object is in read only state.
Parameters
| is_read_only | bool |
whether object is read only. |
refresh()¶
Refresh staging from local data if in read-only mode.
to_dict()¶
Convert object to serializable dictionary.
Returns
dict[str, Any]
dictionary representation of this object
Properties¶
id¶
The identifier for this object if applicable.
Returns
str | None
staged¶
Return currently staged changes to this object.
Returns
dict[str, Any] | None
the locally staged data if available.
url¶
The URL for accessing this object on the server.
Returns
simvue.api.url.URL | None