Scene lists are the M2M API's way of naming a set of scenes so that other endpoints can act on them in bulk: `download-options` and `scene-metadata-list` will not take scene ids inline, only a `listId`.
`M2MSceneSearch$products()` creates and uses one for you, so the usual pipeline never mentions scene lists. Reach for this class when the list itself is what you want - `$metadata()` fetches metadata for every scene in one call rather than one call per scene, and `$summary()` reports the set's combined extent.
Reattach to an existing list with `M2MSession$scene_list()`. Searches create the lists required for `$products()` internally. Not created directly.
Public fields
list_idThe scene list's identifier.
dataset_nameThe dataset alias the list belongs to, or `NA` if not yet known. Reattaching to a list by id leaves this `NA` until `$dataset()` resolves it, since the API does not report a list's dataset except through its summary.
removedWhether `$remove()` has deleted this list. Lists also expire on their own, which this does not track.
Methods
M2MSceneList$new()
Attach to a scene list. Use `M2MSession$scene_list()` instead.
Usage
M2MSceneList$new(session, list_id, dataset_name = NA_character_)M2MSceneList$dataset()
The dataset alias this list belongs to, looked up from the list's summary if it is not already known and cached thereafter.
A scene list can span several datasets, in which case there is no single answer and this errors - pass `dataset_name` to `M2MSession$scene_list()` to say which one you mean.
M2MSceneList$remove()
Delete the scene list from the M2M server. Lists also expire on their own after a period of inactivity.