Files
amiibo-service/docs/data/documentation/amiiboservice/amiibomockclient.json
T

1 line
14 KiB
JSON

{"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}],"seeAlsoSections":[{"anchor":"Clients","generated":true,"title":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboMockClient","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}]}],"topicSections":[{"identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)"],"anchor":"Initializers","title":"Initializers","generated":true},{"anchor":"Instance-Methods","generated":true,"title":"Instance Methods","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboTypes(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getLastUpdated()"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiibomockclient"]}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0A10MockClientV","title":"AmiiboMockClient","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboMockClient","kind":"identifier"}],"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"AmiiboMockClient"}],"symbolKind":"struct"},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/AmiiboService\/s8CopyableP"]}],"sections":[],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"type":"topic","title":"AmiiboLiveClient","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getAmiiboTypes(by:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboTypes","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","kind":"typeIdentifier","text":"AmiiboTypeFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"text":") -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","kind":"typeIdentifier","text":"AmiiboType"},{"text":"]","kind":"text"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient\/getamiibotypes(by:)","kind":"symbol","title":"getAmiiboTypes(by:)","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboTypes(by:)","abstract":[]},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getGameCharacters(by:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameCharacters(by:)","role":"symbol","kind":"symbol","abstract":[],"title":"getGameCharacters(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameCharacters"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","kind":"typeIdentifier","text":"GameCharacterFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","kind":"typeIdentifier","text":"GameCharacter"},{"kind":"text","text":"]"}],"url":"\/documentation\/amiiboservice\/amiibomockclient\/getgamecharacters(by:)","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getGameSeries(by:)":{"type":"topic","abstract":[],"role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"getGameSeries","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","kind":"typeIdentifier","text":"GameSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","kind":"typeIdentifier","text":"GameSeries"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getGameSeries(by:)","url":"\/documentation\/amiiboservice\/amiibomockclient\/getgameseries(by:)","kind":"symbol","title":"getGameSeries(by:)"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"type":"text","text":" backend service."}],"kind":"symbol","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","role":"symbol","abstract":[{"text":"A type that implements a mock client, for testing purposes.","type":"text"}],"kind":"symbol","title":"AmiiboMockClient","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboMockClient","kind":"identifier"}],"navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getAmiibos(by:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiibos(by:)","role":"symbol","abstract":[],"kind":"symbol","title":"getAmiibos(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6FilterV","text":"AmiiboFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo"},{"kind":"text","text":"]"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient\/getamiibos(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getLastUpdated()":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLastUpdated","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient\/getlastupdated()","kind":"symbol","title":"getLastUpdated()","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getLastUpdated()","abstract":[]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"type":"topic","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","title":"AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/getAmiiboSeries(by:)":{"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiibomockclient\/getamiiboseries(by:)","kind":"symbol","title":"getAmiiboSeries(by:)","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/getAmiiboSeries(by:)","abstract":[]},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient/init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient\/init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)","role":"symbol","kind":"symbol","title":"init(amiibos:amiiboSeries:amiiboTypes:gameCharacters:gameSeries:lastUpdated:error:)","abstract":[{"text":"Initializes this client.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"amiibos","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"amiiboSeries","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"amiiboTypes","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A4TypeV","text":"AmiiboType","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"gameCharacters","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"gameSeries","kind":"externalParam"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries","kind":"typeIdentifier"},{"text":"]?, ","kind":"text"},{"text":"lastUpdated","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:10Foundation4DateV","text":"Date","kind":"typeIdentifier"},{"text":"?, ","kind":"text"},{"text":"error","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"text":"?)","kind":"text"}],"url":"\/documentation\/amiiboservice\/amiibomockclient\/init(amiibos:amiiboseries:amiibotypes:gamecharacters:gameseries:lastupdated:error:)","type":"topic"},"doc://AmiiboService/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/AmiiboService\/s8CopyableP","title":"Swift.Copyable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"type":"topic","kind":"symbol","title":"AmiiboClient","url":"\/documentation\/amiiboservice\/amiiboclient","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","abstract":[{"text":"A concrete representation of the types of client that a ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true,"type":"reference"},{"text":" service can utilize.","type":"text"}]}}}