410a200661
This PR contains the work done to: * Update the `Library` article in the DocC documentation catalog in the project; * Generate the DocC documentation of the library for GitHub Pages; * Written the `README` file in the project. Reviewed-on: #5 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
7.1 KiB
JSON
1 line
7.1 KiB
JSON
{"metadata":{"roleHeading":"Instance Method","externalID":"s:13AmiiboService0A10LiveClientV13getGameSeries2bySayAA0fG0VGAA0fG6FilterV_tYaAA0aB5ErrorOYKF","extendedModule":"AmiiboService","symbolKind":"method","title":"getGameSeries(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameSeries"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"by"},{"text":": ","kind":"text"},{"text":"GameSeriesFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":"(","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError"},{"text":") -> [","kind":"text"},{"text":"GameSeries","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService10GameSeriesV"},{"kind":"text","text":"]"}],"role":"symbol","modules":[{"name":"AmiiboService"}]},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"]]},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient\/getGameSeries(by:)","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboliveclient\/getgameseries(by:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"text":"GameSeriesFilter","kind":"typeIdentifier","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":"(","kind":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0aB5ErrorO","text":"AmiiboServiceError"},{"kind":"text","text":") -> ["},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries"},{"kind":"text","text":"]"}]}],"kind":"declarations"}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboServiceError"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"kind":"symbol","role":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","title":"AmiiboServiceError","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true},{"type":"text","text":" service could throw."}]},"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/GameSeriesFilter":{"title":"GameSeriesFilter","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeriesFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game series."}],"role":"symbol","navigatorTitle":[{"text":"GameSeriesFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/gameseriesfilter"},"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/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/GameSeries":{"role":"symbol","url":"\/documentation\/amiiboservice\/gameseries","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeries"}],"title":"GameSeries","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","type":"topic","abstract":[{"type":"text","text":"A model that represents a game series."}]},"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"}}} |