Skip to content

Commit 22ed3eb

Browse files
pjleonard37Release SDK bot for Maps SDK team
andauthored
Make Featureset Descriptor properties public (#2344)
Co-authored-by: Release SDK bot for Maps SDK team <[email protected]>
1 parent 5653c42 commit 22ed3eb

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

Sources/MapboxMaps/Interactions/FeaturesetDescriptor.swift

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,28 @@
1212
@_spi(Experimental)
1313
@_documentation(visibility: public)
1414
public struct FeaturesetDescriptor<FeatureType: FeaturesetFeatureType>: Equatable {
15-
private let featuresetId: String?
16-
private let importId: String?
17-
private let layerId: String?
15+
/// An optional unique identifier for the featureset within the style.
16+
/// This id is used to reference a specific featureset.
17+
///
18+
/// * Note: If `featuresetId` is provided and valid, it takes precedence over `layerId`,
19+
/// meaning `layerId` will not be considered even if it has a valid value.
20+
@_documentation(visibility: public)
21+
public let featuresetId: String?
22+
23+
/// An optional import id that is required if the featureset is defined within an imported style.
24+
/// If the featureset belongs to the current style, this field should be set to a null string.
25+
///
26+
/// * Note: `importId` is only applicable when used in conjunction with `featuresetId`
27+
/// and has no effect when used with `layerId`.
28+
@_documentation(visibility: public)
29+
public let importId: String?
30+
31+
/// An optional unique identifier for the layer within the current style.
32+
///
33+
/// * Note: If `featuresetId` is valid, `layerId` will be ignored even if it has a valid value.
34+
/// Additionally, `importId` does not apply when using `layerId`.
35+
@_documentation(visibility: public)
36+
public let layerId: String?
1837

1938
private init(featuresetId: String? = nil, importId: String? = nil, layerId: String? = nil) {
2039
self.featuresetId = featuresetId

0 commit comments

Comments
 (0)