marvel-service/docs/data/documentation/marvelservice/operations/getcharactersbyeventid/input/query-swift.struct.json

{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct"},"relationshipsSections":[{"kind":"relationships","type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"]}],"topicSections":[{"generated":true,"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:series:stories:orderBy:limit:offset:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/comics","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/modifiedSince","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/name","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/nameStartsWith","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderBy","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/series","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/stories"]},{"title":"Type Aliases","generated":true,"anchor":"Type-Aliases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderByPayload"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderByPayloadPayload"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/Equatable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"platforms":["macOS"]}]},{"content":[{"type":"heading","text":"Overview","level":2,"anchor":"overview"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/v1\/public\/events\/{eventId}\/characters\/GET\/query"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Remark"}],"kind":"content"}],"metadata":{"modules":[{"name":"MarvelService"}],"roleHeading":"Structure","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input.Query","externalID":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","symbolKind":"struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct"]}],"references":{"doc://MarvelService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/MarvelService\/s8SendableP"},"doc://MarvelService/documentation/MarvelService":{"url":"\/documentation\/marvelservice","kind":"symbol","title":"MarvelService","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","type":"topic","abstract":[{"text":"A library that allows the developer to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Marvel Comics API","type":"text"}]},{"text":" backend service.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/init(name:nameStartsWith:modifiedSince:comics:series:stories:orderBy:limit:offset:)":{"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"nameStartsWith"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"modifiedSince"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"comics"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"series"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"stories"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"orderBy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"orderByPayload","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV05orderF7Payloada"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"limit"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"offset"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?)"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Query"},{"type":"text","text":"."}],"kind":"symbol","role":"symbol","title":"init(name:nameStartsWith:modifiedSince:comics:series:stories:orderBy:limit:offset:)","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:series:stories:orderBy:limit:offset:)","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/init(name:namestartswith:modifiedsince:comics:series:stories:orderby:limit:offset:)"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/modifiedSince":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/modifiedSince","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"modifiedSince","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/modifiedsince","title":"modifiedSince","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return only characters which have been modified since the specified date."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/orderByPayload":{"type":"topic","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderByPayload"}],"abstract":[],"navigatorTitle":[{"kind":"identifier","text":"orderByPayload"}],"kind":"symbol","role":"symbol","title":"Operations.getCharactersByEventId.Input.Query.orderByPayload","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderByPayload","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/orderbypayload"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/orderBy":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/orderby","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderBy","type":"topic","kind":"symbol","role":"symbol","title":"orderBy","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"orderBy","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getCharactersByEventId","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"orderByPayload","preciseIdentifier":"s:13MarvelService10OperationsO22getCharactersByEventIdO5InputV5QueryV05orderF7Payloada","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Order the result set by a field or fields. Add a “-” to the value sort in descending order. Multiple values are given priority in the order in which they are passed."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/series":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/series","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/series","kind":"symbol","role":"symbol","title":"series","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"series"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?"}],"abstract":[{"text":"Return only characters which appear the specified series (accepts a comma-separated list of ids).","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersByEventId","kind":"identifier"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid","title":"Operations.getCharactersByEventId","kind":"symbol","role":"symbol","navigatorTitle":[{"text":"getCharactersByEventId","kind":"identifier"}],"abstract":[{"text":"Fetches lists of characters filtered by an event id.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations":{"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","kind":"symbol","title":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","role":"symbol","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/stories":{"type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stories","kind":"identifier"},{"text":": [","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"]?","kind":"text"}],"abstract":[{"text":"Return only characters which appear the specified stories (accepts a comma-separated list of ids).","type":"text"}],"kind":"symbol","role":"symbol","title":"stories","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/stories","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/stories"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/orderByPayloadPayload":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/orderByPayloadPayload","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/orderbypayloadpayload","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"orderByPayloadPayload"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input.Query.orderByPayloadPayload","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderByPayloadPayload"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/offset":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/offset","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/offset","title":"offset","kind":"symbol","role":"symbol","abstract":[{"text":"Skip the specified number of resources in the result set.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/comics":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/comics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/comics","kind":"symbol","role":"symbol","title":"comics","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"comics"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?"}],"abstract":[{"text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids).","type":"text"}]},"doc://MarvelService/SH":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SH","title":"Swift.Hashable"},"doc://MarvelService/SQ":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/SQ","title":"Swift.Equatable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/nameStartsWith":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/nameStartsWith","type":"topic","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nameStartsWith","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/namestartswith","title":"nameStartsWith","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return characters with names that begin with the specified string."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/name":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/name","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/name","title":"name","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return only characters matching the specified full character name."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","title":"Operations.getCharactersByEventId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"abstract":[]},"doc://MarvelService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/Equatable-Implementations":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/Equatable-Implementations","url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/equatable-implementations","title":"Equatable Implementations","kind":"article","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersByEventId/Input/Query-swift.struct/limit":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersByEventId\/Input\/Query-swift.struct\/limit","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"limit","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyeventid\/input\/query-swift.struct\/limit","title":"limit","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Limit the result set to the specified number of resources."}]}}}