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

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