SceneClient

class wwt_api_client.constellations.scenes.SceneClient(client: CxClient, id: str)

Bases: object

A client for the WWT Constellations APIs calls related to a specific scene.

Parameters:

clientCxClient

The parent client for making API calls.

id: str

The ID of the scene of interest.

Methods Summary

get()	Get information about this scene.
permissions()	Get information about the logged-in user's permissions with regards to this scene.
place_folder()	Get a WWT WTML Folder object containing this scene as a WWT Place, if possible.
place_object()	Get a WWT WTML Place object representing this scene, if possible.
place_wtml_url()	Get a URL that will yield a WTML folder representing this scene as a WWT Place, if possible.
update(updates)	Update various attributes of this scene.

Methods Documentation

get() → SceneHydrated

Get information about this scene.

This method corresponds to the GET /scene/:id API endpoint.

permissions() → ScenePermissions

Get information about the logged-in user’s permissions with regards to this scene.

This method corresponds to the GET /scene/:id/permissions API endpoint. See that documentation for important guidance about when and how to use this API. In most cases you should not use it, and just go ahead and attempt whatever operation wish to perform.

place_folder() → Folder

Get a WWT WTML Folder object containing this scene as a WWT Place, if possible.

Returns:

wwt_data_formats.folder.Folder

See also

place_wtml_url, place_object

Notes

The API request will return a 404 error if the scene cannot be represented as a WWT Place (as well as if the scene ID is unrecognized).

place_object() → Place

Get a WWT WTML Place object representing this scene, if possible.

Returns:

wwt_data_formats.place.Place

See also

place_wtml_url, place_folder

Notes

The API request will return a 404 error if the scene cannot be represented as a WWT Place (as well as if the scene ID is unrecognized).

place_wtml_url() → str

Get a URL that will yield a WTML folder representing this scene as a WWT Place, if possible.

Returns:

The WTML URL.

See also

place_folder, place_object

Notes

The API request will return a 404 error if the scene cannot be represented as a WWT Place (as well as if the scene ID is unrecognized).

update(updates: SceneUpdate)

Update various attributes of this scene.

This method corresponds to the PATCH /scene/:id API endpoint.