amiibo-service/docs/data/documentation/amiiboservice/amiiboliveclient.json

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"},"metadata":{"roleHeading":"Structure","externalID":"s:13AmiiboService0A10LiveClientV","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"symbolKind":"struct","title":"AmiiboLiveClient","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"role":"symbol","modules":[{"name":"AmiiboService"}]},"schemaVersion":{"patch":0,"minor":3,"major":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init()"],"generated":true,"anchor":"Initializers"},{"title":"Instance Methods","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()"],"generated":true,"anchor":"Instance-Methods"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboliveclient"]}],"abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"relationshipsSections":[{"title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/AmiiboService\/s8CopyableP"],"type":"conformsTo"}],"seeAlsoSections":[{"title":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient"],"generated":true,"anchor":"Clients"}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"platforms":["macOS"]}]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"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"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"type":"topic","title":"AmiiboClient","url":"\/documentation\/amiiboservice\/amiiboclient","kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboSeries(by:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/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":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"AmiiboSeries","preciseIdentifier":"s:13AmiiboService0A6SeriesV"},{"kind":"text","text":"]"}],"abstract":[],"kind":"symbol","title":"getAmiiboSeries(by:)","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiiboseries(by:)","type":"topic","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiibos(by:)":{"url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibos(by:)","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiibos(by:)","abstract":[],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiibos"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier","text":"AmiiboFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V"},{"kind":"text","text":"]"}],"role":"symbol","title":"getAmiibos(by:)","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameSeries(by:)":{"kind":"symbol","title":"getGameSeries(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getGameSeries","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"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":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","kind":"typeIdentifier"},{"text":") -> [","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries"},{"text":"]","kind":"text"}],"abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgameseries(by:)","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getLastUpdated()":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getLastUpdated()","type":"topic","title":"getLastUpdated()","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getlastupdated()","abstract":[],"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLastUpdated"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"AmiiboServiceError","preciseIdentifier":"s:13AmiiboService0aB5ErrorO"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Date","preciseIdentifier":"s:10Foundation4DateV"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboMockClient":{"role":"symbol","url":"\/documentation\/amiiboservice\/amiibomockclient","kind":"symbol","navigatorTitle":[{"text":"AmiiboMockClient","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboMockClient"}],"title":"AmiiboMockClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboMockClient","type":"topic","abstract":[{"type":"text","text":"A type that implements a mock client, for testing purposes."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/init()":{"kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/init()","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/init()","title":"init()","abstract":[{"type":"text","text":"Initializes this client."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"()"}],"role":"symbol"},"doc://AmiiboService/s8CopyableP":{"title":"Swift.Copyable","identifier":"doc:\/\/AmiiboService\/s8CopyableP","type":"unresolvable"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getGameCharacters(by:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameCharacters(by:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameCharacters","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"GameCharacterFilter","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError","kind":"typeIdentifier"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"GameCharacter","preciseIdentifier":"s:13AmiiboService13GameCharacterV"},{"kind":"text","text":"]"}],"abstract":[],"type":"topic","title":"getGameCharacters(by:)","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getgamecharacters(by:)","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","kind":"symbol","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":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"role":"collection","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}],"type":"topic","title":"AmiiboLiveClient","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboservice","role":"symbol","type":"topic","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient/getAmiiboTypes(by:)":{"title":"getAmiiboTypes(by:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A10TypeFilterV","kind":"typeIdentifier","text":"AmiiboTypeFilter"},{"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:13AmiiboService0A4TypeV","kind":"typeIdentifier","text":"AmiiboType"},{"kind":"text","text":"]"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getAmiiboTypes(by:)","type":"topic","abstract":[],"role":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient\/getamiibotypes(by:)"}}}