Publishing¶
Related to the Publishing API
-
class
koordinates.publishing.
PublishManager
(client)¶ Bases:
koordinates.base.Manager
Accessor for querying Publish groups.
Access via the
publishing
property of akoordinates.client.Client
instance.-
create
(publish)¶ Creates a new publish group.
-
expand
(*args, **kwargs)¶ Returns an expanded Query view of the model objects. Equivalent to calling
.list().expand()
. Using expansions may have significant performance implications for some API requests. Seekoordinates.base.Query.expand()
.
-
filter
(*args, **kwargs)¶ Returns a filtered Query view of the model objects. Equivalent to calling
.list().filter(...)
. Seekoordinates.base.Query.filter()
.
-
get
(id, expand=[])¶ Fetches a Model instance determined by the value of id.
- Parameters
id – numeric ID for the Model.
-
list
()¶ Fetches a set of model objects
- Return type
koordinates.base.Query
-
order_by
(*args, **kwargs)¶ Returns an ordered Query view of the model objects. Equivalent to calling
.list().order_by(...)
. Seekoordinates.base.Query.order_by()
.
-
-
class
koordinates.publishing.
Publish
(**kwargs)¶ Bases:
koordinates.base.Model
Represents an active publishing group.
-
add_layer_item
(layer)¶ Adds a Layer to the publish group.
-
add_table_item
(table)¶ Adds a Table to the publish group.
-
cancel
()¶ Cancel a pending publish task
-
get_items
()¶ Return the item models associated with this Publish group.
-
refresh
()¶ Refresh this model from the server.
Updates attributes with the server-defined values. This is useful where the Model instance came from a partial response (eg. a list query) and additional details are required.
Existing attribute values will be overwritten.
-