Skip to contents

Fetch status and visibility for one collection

Source: R/app-settings.R
get_collection_settings.Rd

[Experimental]

Retrieves settings for a single collection from the database. Returns default values if no settings exist for the collection.

Usage

get_collection_settings(collection, cn = NULL)

Arguments

collection

Character. Collection UUID. Validated with artcore::validate_uuid() where applicable.

cn

Database connection. If NULL, creates a connection via artcore::dbc() and closes it on exit. Pass an existing connection to batch multiple queries efficiently.

Value

List with collection settings:

collection_uuid

The collection UUID

status

'wip' or 'complete'

visibility_override

NA, 'visible', or 'hidden'

extended_settings

List of additional settings

created_at

Timestamp of record creation

updated_at

Timestamp of last update

Details

Queries settings.collection_settings table. If no record exists for the collection, returns a list with default values (status = "wip", no visibility override, empty extended_settings).

See also

Other settings: get_collect_visibility(), get_collections_settings(), is_collection_visible(), update_collection_settings(), upsert_artist_preferences()