marvel-service/docs/data/documentation/marvelservice/components/schemas/characterlist.json

{"sections":[],"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/MarvelService\/Se","doc:\/\/MarvelService\/SE","doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"],"kind":"relationships"}],"abstract":[{"type":"text","text":"A resource list containing characters which appear in this story."}],"seeAlsoSections":[{"title":"Core Entity List","anchor":"Core-Entity-List","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesList","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryList"],"generated":true}],"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterList","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/CharacterList"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Components","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas"]]},"topicSections":[{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/init(available:returned:collectionURI:items:)","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/init(from:)"],"generated":true},{"title":"Instance Properties","anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/available","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/collectionURI","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/items","doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/returned"],"generated":true},{"title":"Enumerations","anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/CodingKeys"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/Equatable-Implementations"],"generated":true}],"metadata":{"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"CharacterList","kind":"identifier"}],"externalID":"s:13MarvelService10ComponentsO7SchemasO13CharacterListV","roleHeading":"Structure","title":"Components.Schemas.CharacterList","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterList","kind":"identifier"}],"modules":[{"name":"MarvelService"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"variants":[{"paths":["\/documentation\/marvelservice\/components\/schemas\/characterlist"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/collectionURI":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/collectionURI","title":"collectionURI","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"collectionURI","kind":"identifier"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/collectionuri","role":"symbol","abstract":[{"type":"text","text":"The path to the full list of characters in this collection."}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/init(available:returned:collectionURI:items:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"CharacterList"},{"type":"text","text":"."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/init(available:returned:collectionURI:items:)","title":"init(available:returned:collectionURI:items:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"available"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"returned"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"collectionURI"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":", "},{"kind":"externalParam","text":"items"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO16CharacterSummaryV","text":"CharacterSummary","kind":"typeIdentifier"},{"kind":"text","text":"])"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/init(available:returned:collectionuri:items:)"},"doc://MarvelService/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH"},"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/StoryList":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StoryList","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/StoryList","kind":"symbol","navigatorTitle":[{"text":"StoryList","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components\/schemas\/storylist","title":"Components.Schemas.StoryList","role":"symbol","abstract":[{"type":"text","text":"A resource list containing stories which are related to this story."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/returned":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/returned","title":"returned","type":"topic","abstract":[{"type":"text","text":"The number of characters returned in this collection."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/returned","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"returned"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/ComicList":{"abstract":[{"text":"A resource list containing comics which feature this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/ComicList","navigatorTitle":[{"text":"ComicList","kind":"identifier"}],"title":"Components.Schemas.ComicList","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ComicList","kind":"identifier"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/comiclist"},"doc://MarvelService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP"},"doc://MarvelService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/CodingKeys":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/codingkeys","title":"Components.Schemas.CharacterList.CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"type":"topic","abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/CodingKeys","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist","title":"Components.Schemas.CharacterList","navigatorTitle":[{"text":"CharacterList","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A resource list containing characters which appear in this story."}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CharacterList","kind":"identifier"}]},"doc://MarvelService/documentation/MarvelService":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","kind":"symbol","url":"\/documentation\/marvelservice","title":"MarvelService","role":"collection","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"type":"text","text":" backend service."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CreatorList":{"abstract":[{"text":"A resource list containing creators whose work appears in this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CreatorList","navigatorTitle":[{"text":"CreatorList","kind":"identifier"}],"title":"Components.Schemas.CreatorList","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"CreatorList","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/marvelservice\/components\/schemas\/creatorlist","type":"topic"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/SeriesList":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/SeriesList","title":"Components.Schemas.SeriesList","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"SeriesList"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/serieslist","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"SeriesList"}],"abstract":[{"type":"text","text":"A resource list containing series in which this story appears."}]},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/init(from:)":{"title":"init(from:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/init(from:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/init(from:)","role":"symbol","abstract":[]},"doc://MarvelService/SE":{"title":"Swift.Encodable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/SE"},"doc://MarvelService/Se":{"title":"Swift.Decodable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/Se"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/items":{"title":"items","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/items","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"items","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Components","preciseIdentifier":"s:13MarvelService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Schemas","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"CharacterSummary","preciseIdentifier":"s:13MarvelService10ComponentsO7SchemasO16CharacterSummaryV","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/items","role":"symbol","abstract":[{"type":"text","text":"The list of returned characters in this collection."}]},"doc://MarvelService/documentation/MarvelService/Components":{"navigatorTitle":[{"text":"Components","kind":"identifier"}],"url":"\/documentation\/marvelservice\/components","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"role":"symbol","type":"topic","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/EventList":{"abstract":[{"text":"A resource list containing events which feature this story.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/EventList","navigatorTitle":[{"kind":"identifier","text":"EventList"}],"title":"Components.Schemas.EventList","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"EventList"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/components\/schemas\/eventlist"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/Equatable-Implementations":{"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/equatable-implementations","title":"Equatable Implementations","type":"topic","abstract":[],"role":"collectionGroup","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/Equatable-Implementations","kind":"article"},"doc://MarvelService/documentation/MarvelService/Components/Schemas":{"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas","url":"\/documentation\/marvelservice\/components\/schemas","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}],"role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Components/Schemas/CharacterList/available":{"title":"available","abstract":[{"type":"text","text":"The number of total available characters in this list. Will always be greater than or equal to the “returned” value."}],"url":"\/documentation\/marvelservice\/components\/schemas\/characterlist\/available","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Components\/Schemas\/CharacterList\/available","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"available"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}]}}}