amiibo-service/docs/data/documentation/amiiboservice/amiiboservice/getamiibos(_:).json

{"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]]},"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboservice\/getamiibos(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"text":"Gets a list of amiibo items based on a given filter.","type":"text"}],"metadata":{"role":"symbol","roleHeading":"Instance Method","modules":[{"name":"AmiiboService"}],"symbolKind":"method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"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":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"text":"Amiibo","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A0V"},{"text":"]","kind":"text"}],"title":"getAmiibos(_:)","externalID":"s:13AmiiboServiceAAV10getAmiibosySayAA0A0VGAA0A6FilterVYaAA0aB5ErrorOYKF"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)"},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","kind":"typeIdentifier","text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"text":"AmiiboServiceError","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"text":") -> [","kind":"text"},{"text":"Amiibo","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"text":"]","kind":"text"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"filter","content":[{"type":"paragraph","inlineContent":[{"text":"A filter to remove unwanted items from the result.","type":"text"}]}]}]},{"content":[{"text":"Return Value","type":"heading","anchor":"return-value","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"A list of filtered amiibo items."}]}],"kind":"content"},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","isActive":true},{"type":"text","text":" error in case some issue is encountered while generating the result."}]}],"style":"note","name":"Throws","type":"aside"}],"kind":"content"}],"references":{"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","role":"collection","type":"topic","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/amiiboservice","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiibos(_:)":{"type":"topic","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}],"title":"getAmiibos(_:)","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiibos(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiibos","kind":"identifier"},{"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":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","kind":"symbol","title":"AmiiboService","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboservice","type":"topic","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboServiceError","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"type":"topic","title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","role":"symbol","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"text":" service could throw.","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"abstract":[{"text":"A model that represents an amiibo item.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/amiibo","title":"Amiibo","navigatorTitle":[{"text":"Amiibo","kind":"identifier"}],"type":"topic","kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"title":"AmiiboFilter","role":"symbol","navigatorTitle":[{"text":"AmiiboFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibofilter","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboFilter","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo items."}]}}}