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

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