Anchor to CollectionSubCollectionEligibilityStateCollection
objectCollection Sub Collection Eligibility State
Requires access scope.
Whether a collection is eligible for one role (inclusion or exclusion) in a sub-collection relationship, plus the reason it isn't if applicable.
Anchor to FieldsFields
- eligible (Boolean!)
- ineligibleReason (SubCollectionIneligibleReason)
- Anchor to eligibleeligible•Boolean!non-null
Whether the collection can be used in this sub-collection role.
- Anchor to ineligibleReasonineligible•Sub
Reason Collection Ineligible Reason Stable identifier describing why the collection is ineligible. Null when
eligibleis true. Clients can map this to user-facing copy or use it as a feature flag.
Was this section helpful?