Skip to content

Latest commit

History

History
26 lines (20 loc) 路 1.17 KB

CollectionCapabilities.md

File metadata and controls

26 lines (20 loc) 路 1.17 KB

FlatApi::CollectionCapabilities

Properties

Name Type Description Notes
can_edit Boolean Whether the current user can modify the metadata for the collection
can_share Boolean Whether the current user can modify the sharing settings for the collection
can_delete Boolean Whether the current user can delete the collection
can_add_scores Boolean Whether the current user can add scores to the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score.
can_delete_scores Boolean Whether the current user can delete scores from the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score.

Example

require 'flat_api'

instance = FlatApi::CollectionCapabilities.new(
  can_edit: null,
  can_share: null,
  can_delete: null,
  can_add_scores: null,
  can_delete_scores: null
)