1 line
10 KiB
JSON
1 line
10 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","interfaceLanguage":"swift"},"abstract":[{"text":"Gets a list of amiibo items based on a given filter.","type":"text"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiibos","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"title":"getAmiibos(by:)","externalID":"s:13AmiiboService0A10LiveClientV10getAmiibos2bySayAA0A0VGAA0A6FilterV_tYaKF","modules":[{"name":"AmiiboService"}],"role":"symbol","roleHeading":"Instance Method","extendedModule":"AmiiboService"},"kind":"symbol","seeAlsoSections":[{"anchor":"Amiibo-endpoints","title":"Amiibo endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)"],"generated":true}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)"]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV","text":"AmiiboFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","text":"Amiibo"},{"kind":"text","text":"]"}],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"A filter to remove unwanted items from the result."}]}],"name":"filter"}],"kind":"parameters"},{"content":[{"text":"Return Value","level":2,"anchor":"return-value","type":"heading"},{"inlineContent":[{"text":"A list of filtered amiibo items.","type":"text"}],"type":"paragraph"}],"kind":"content"},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","type":"reference","isActive":true},{"type":"text","text":" error in case some issue is encountered while generating the result."}]}],"name":"Throws","type":"aside"}],"kind":"content"}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","role":"symbol","title":"AmiiboLiveClient","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"kind":"symbol","abstract":[{"text":"A type that implements a live client to the ","type":"text"},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.org","type":"reference"},{"text":" online service.","type":"text"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiiboliveclient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"url":"\/documentation\/amiiboservice\/amiiboservice","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"title":"AmiiboService","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","type":"topic","title":"AmiiboFilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo items.","type":"text"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"kind":"symbol","url":"\/documentation\/amiiboservice\/amiibofilter","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboFilter","kind":"identifier"}]},"https://www.amiiboapi.org":{"title":"Amiibo API","type":"link","titleInlineContent":[{"text":"Amiibo API","type":"text"}],"url":"https:\/\/www.amiiboapi.org","identifier":"https:\/\/www.amiiboapi.org"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiibos(by:)":{"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)","role":"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","text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"kind":"symbol","role":"collection","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboSeries(by:)":{"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)","role":"symbol","title":"getAmiiboSeries(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AmiiboSeriesFilter","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"AmiiboSeries","preciseIdentifier":"s:13AmiiboService0A6SeriesV"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"text":" service could throw.","type":"text"}],"title":"AmiiboServiceError","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboTypes(by:)":{"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibotypes(by:)","role":"symbol","title":"getAmiiboTypes(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AmiiboTypeFilter","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"AmiiboType","preciseIdentifier":"s:13AmiiboService0A4TypeV"},{"kind":"text","text":"]"}],"kind":"symbol","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"navigatorTitle":[{"text":"Amiibo","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibo","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Amiibo","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A model that represents an amiibo.","type":"text"}],"type":"topic","title":"Amiibo"}}} |