Files
amiibo-service/docs/data/documentation/amiiboservice/amiiboserviceerror.json

1 line
11 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"sections":[],"topicSections":[{"anchor":"Request-errors","title":"Request errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled"]},{"anchor":"Response-errors","title":"Response errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound"]},{"anchor":"Service-errors","title":"Service errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/LocalizedError-Implementations"]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"metadata":{"symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"title":"AmiiboServiceError","modules":[{"name":"AmiiboService"}],"externalID":"s:13AmiiboService0aB5ErrorO","navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}],"role":"symbol","roleHeading":"Enumeration"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/AmiiboService\/10Foundation14LocalizedErrorP","doc:\/\/AmiiboService\/s8CopyableP","doc:\/\/AmiiboService\/SQ","doc:\/\/AmiiboService\/s5ErrorP","doc:\/\/AmiiboService\/s9EscapableP","doc:\/\/AmiiboService\/s8SendableP","doc:\/\/AmiiboService\/s16SendableMetatypeP"]}],"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboserviceerror"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"references":{"doc://AmiiboService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/AmiiboService\/s16SendableMetatypeP"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/unknown":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/unknown","role":"symbol","title":"AmiiboServiceError.unknown","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"unknown"}],"kind":"symbol","abstract":[{"type":"text","text":"An unexpected error that does not fall into any other category."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/unknown"},"doc://AmiiboService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/AmiiboService\/s8SendableP"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Error-Implementations":{"title":"Error Implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Error-Implementations","abstract":[],"kind":"article","role":"collectionGroup","type":"topic","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/error-implementations"},"doc://AmiiboService/documentation/AmiiboService":{"title":"AmiiboService","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"kind":"symbol","role":"collection","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"url":"\/documentation\/amiiboservice\/amiiboservice","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"title":"AmiiboService","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/cancelled":{"type":"topic","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/cancelled","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/cancelled","kind":"symbol","abstract":[{"type":"text","text":"The request was cancelled before a response was received."}],"role":"symbol","title":"AmiiboServiceError.cancelled","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"cancelled"}]},"doc://AmiiboService/10Foundation14LocalizedErrorP":{"type":"unresolvable","title":"Foundation.LocalizedError","identifier":"doc:\/\/AmiiboService\/10Foundation14LocalizedErrorP"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/undocumented(_:)":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/undocumented(_:)","role":"symbol","title":"AmiiboServiceError.undocumented(_:)","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":")"}],"kind":"symbol","abstract":[{"type":"text","text":"The server returned an undocumented HTTP status code."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/undocumented(_:)"},"doc://AmiiboService/s9EscapableP":{"type":"unresolvable","title":"Swift.Escapable","identifier":"doc:\/\/AmiiboService\/s9EscapableP"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/badRequest":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/badRequest","type":"topic","title":"AmiiboServiceError.badRequest","abstract":[{"type":"text","text":"The request was malformed or contained invalid filter parameters."}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/badrequest","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"badRequest"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/decoding":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/decoding","role":"symbol","title":"AmiiboServiceError.decoding","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"decoding","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"The response body could not be decoded into the expected model."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/decoding"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/LocalizedError-Implementations":{"title":"LocalizedError Implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/LocalizedError-Implementations","abstract":[],"kind":"article","role":"collectionGroup","type":"topic","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/localizederror-implementations"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/Equatable-Implementations":{"title":"Equatable Implementations","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/Equatable-Implementations","abstract":[],"kind":"article","role":"collectionGroup","type":"topic","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/equatable-implementations"},"doc://AmiiboService/s8CopyableP":{"type":"unresolvable","title":"Swift.Copyable","identifier":"doc:\/\/AmiiboService\/s8CopyableP"},"doc://AmiiboService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/AmiiboService\/SQ"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notAvailable":{"url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notavailable","role":"symbol","title":"AmiiboServiceError.notAvailable","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"notAvailable"}],"kind":"symbol","abstract":[{"type":"text","text":"The backend service is currently unreachable due to a network or server issue."}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notAvailable"},"doc://AmiiboService/s5ErrorP":{"type":"unresolvable","title":"Swift.Error","identifier":"doc:\/\/AmiiboService\/s5ErrorP"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError/notFound":{"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"}],"title":"AmiiboServiceError.notFound","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError\/notFound","abstract":[{"type":"text","text":"No results were found matching the given filter criteria."}],"kind":"symbol","role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiiboserviceerror\/notfound"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiiboserviceerror","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}],"role":"symbol","abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"text":" service could throw.","type":"text"}],"title":"AmiiboServiceError","type":"topic"}}}