Files
marvel-service/docs/data/documentation/marvelservice/client/geteventsbycharacterid(path:query:headers:).json
T

1 line
17 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Client"]]},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getEventsByCharacterId(path:query:headers:)","interfaceLanguage":"swift"},"metadata":{"title":"getEventsByCharacterId(path:query:headers:)","externalID":"s:13MarvelService11APIProtocolPAAE22getEventsByCharacterId4path5query7headersAA10OperationsOADO6OutputOAJ5InputV4PathV_AN5QueryVAN7HeadersVtYaKF::SYNTHESIZED::s:13MarvelService6ClientV","role":"symbol","roleHeading":"Instance Method","modules":[{"name":"MarvelService"}],"symbolKind":"method","extendedModule":"MarvelService","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByCharacterId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","text":"getEventsByCharacterId","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","text":"Input","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV5QueryV","text":"Query","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO"}]},"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getEventsByCharacterId","kind":"identifier"},{"kind":"text","text":"("},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"text":"getEventsByCharacterId","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV"},{"kind":"text","text":"."},{"text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Path-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV4PathV"},{"kind":"text","text":", "},{"text":"query","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier","text":"getEventsByCharacterId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId"},{"text":".","kind":"text"},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","kind":"typeIdentifier","text":"Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Query-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV5QueryV"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier","text":"getEventsByCharacterId","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Headers-swift.struct","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier","text":"getEventsByCharacterId"},{"kind":"text","text":"."},{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO","kind":"typeIdentifier","text":"Output"}]}]},{"content":[{"text":"Discussion","anchor":"discussion","level":2,"type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Fetches lists of events in which a specific character appears, with optional filters.","type":"text"}]},{"type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/characters\/{characterId}\/events"},{"type":"text","text":"."}]}],"style":"note","name":"Remark"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/characters\/{characterId}\/events\/get(getEventsByCharacterId)"},{"text":".","type":"text"}]}],"name":"Remark","style":"note","type":"aside"}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/client\/geteventsbycharacterid(path:query:headers:)"]}],"abstract":[{"type":"text","text":"Fetches lists of events filtered by a character id."}],"references":{"doc://MarvelService/documentation/MarvelService/Operations":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/marvelservice\/operations","title":"Operations","role":"symbol","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Input/Headers-swift.struct":{"title":"Operations.getEventsByCharacterId.Input.Headers","abstract":[],"url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/input\/headers-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Headers-swift.struct","type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Output":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.getEventsByCharacterId.Output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/output"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Input":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.getEventsByCharacterId.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/input","type":"topic"},"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/Client/getEventsByCharacterId(path:query:headers:)":{"title":"getEventsByCharacterId(path:query:headers:)","abstract":[{"type":"text","text":"Fetches lists of events filtered by a character id."}],"url":"\/documentation\/marvelservice\/client\/geteventsbycharacterid(path:query:headers:)","kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client\/getEventsByCharacterId(path:query:headers:)","type":"topic","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getEventsByCharacterId","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"getEventsByCharacterId","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:13MarvelService10OperationsO22getEventsByCharacterIdO6OutputO","kind":"typeIdentifier"}]},"doc://MarvelService/documentation/MarvelService/Client":{"abstract":[{"text":"The Marvel Comics RESTful API.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"title":"Client","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"kind":"symbol","url":"\/documentation\/marvelservice\/client","type":"topic"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Input/Path-swift.struct":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Path-swift.struct","title":"Operations.getEventsByCharacterId.Input.Path","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/input\/path-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Path"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId":{"abstract":[{"text":"Fetches lists of events filtered by a character id.","type":"text"}],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId","navigatorTitle":[{"kind":"identifier","text":"getEventsByCharacterId"}],"title":"Operations.getEventsByCharacterId","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEventsByCharacterId"}],"kind":"symbol","type":"topic","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid"},"doc://MarvelService/documentation/MarvelService/Operations/getEventsByCharacterId/Input/Query-swift.struct":{"abstract":[],"role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEventsByCharacterId\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"title":"Operations.getEventsByCharacterId.Input.Query","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"kind":"symbol","url":"\/documentation\/marvelservice\/operations\/geteventsbycharacterid\/input\/query-swift.struct","type":"topic"}}}