ImageClient

class wwt_api_client.constellations.images.ImageClient(client: CxClient, id: str)

Bases: object

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

Parameters:

clientCxClient

The parent client for making API calls.

id: str

The ID of the image of interest.

Methods Summary

get()	Get information about this image.
imageset_folder()	Get a WWT WTML Folder object containing this image as an imageset.
imageset_object()	Get a WWT WTML ImageSet object representing this image.
imageset_wtml_url()	Get a URL that will yield a WTML folder containing this image as an imageset.
permissions()	Get information about the logged-in user's permissions with regards to this image.
update(updates)	Update various attributes of this image.

Methods Documentation

get() → ImageInfo

Get information about this image.

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

imageset_folder() → Folder

Get a WWT WTML Folder object containing this image as an imageset.

Returns:

wwt_data_formats.folder.Folder

See also

imageset_wtml_url, imageset_object

imageset_object() → ImageSet

Get a WWT WTML ImageSet object representing this image.

Returns:

wwt_data_formats.imageset.ImageSet

See also

imageset_wtml_url, imageset_folder

imageset_wtml_url() → str

Get a URL that will yield a WTML folder containing this image as an imageset.

Returns:

The WTML URL.

See also

imageset_folder, imageset_object

permissions() → ImageApiPermissions

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

This method corresponds to the GET /image/: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.

update(updates: ImageUpdate)

Update various attributes of this image.

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