rock-n-code/amiibo-service
1
0
Fork 0
Code Issues 1 Pull Requests Releases 8 Wiki Activity

Written the documentation for the AmiiboFilter filter.

Browse Source
This commit is contained in:
Javier Cicchelli 2023-04-23 13:17:54 +02:00
parent 46dca64589
commit 118e824989
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Sources/Filters/AmiiboFilter.swift
View File

@ -1,3 +1,4 @@
/// This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos.
public struct AmiiboFilter { public struct AmiiboFilter {
// MARK: Properties // MARK: Properties
@ -14,6 +15,17 @@ public struct AmiiboFilter {
// MARK: Initialisers // MARK: Initialisers
/// Initialises this filter.
/// - Parameters:
/// - id: An amiibo `id` value to match against.
/// - head: An amiibo `head` value to match against.
/// - tail: An amiibo `tail` value to match against.
/// - name: An amiibo `name` value to match against.
/// - type: An amiibo `type` key or name value to match against.
/// - gameSeries: An amiibo `gameSeries` key or name value to match against.
/// - amiiboSeries: An amiibo `amiiboSeries` key or name value to match against.
/// - character: An amiibo `character` key or name value to match against.
/// - showExtras: A ``ShowExtras`` enumeration that indicates whether amiibo extra information need to be retrieved or not.
public init( public init(
id: String? = nil, id: String? = nil,
head: String? = nil, head: String? = nil,
@ -95,9 +107,13 @@ extension AmiiboFilter: Filter {
// MARK: - Enumerations // MARK: - Enumerations
/// This enumeration indicates if extra information for amiibos need to be retrieved.
public enum ShowExtras { public enum ShowExtras {
/// No extra information needs to be retrieved.
case none case none
/// Amiibo games information needs to be retrieved.
case games case games
/// Amiibo games and its usage information needs to be retrieved.
case usage case usage
} }