swift-libs/Documents/SwiftLibsCommunication.doccarchive/data/documentation/swiftlibscommunication/client/request(endpoint:as:).json

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Model"},{"kind":"text","text":">("},{"kind":"externalParam","text":"endpoint"},{"kind":"text","text":": some "},{"kind":"typeIdentifier","identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP","text":"Endpoint"},{"kind":"text","text":", "},{"kind":"externalParam","text":"as"},{"kind":"text","text":" "},{"kind":"internalParam","text":"model"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":".Type) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":" "},{"kind":"keyword","text":"where"},{"kind":"text","text":" "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":" : "},{"kind":"typeIdentifier","text":"Decodable","preciseIdentifier":"s:Se"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"name":"endpoint","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The endpoint for which to make a remote call."}]}]},{"name":"model","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"The model to cast an expected response from the remote location."}]}]}]},{"kind":"content","content":[{"anchor":"return-value","level":2,"type":"heading","text":"Return Value"},{"type":"paragraph","inlineContent":[{"type":"text","text":"A casted model instance created out of a response retrieved from a call to a remote endpoint."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/swiftlibscommunication\/client\/request(endpoint:as:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client\/request(endpoint:as:)","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"Makes a request to a remote location based on a given endpoint and expects to return a response casted as a given model type."}],"kind":"symbol","metadata":{"role":"symbol","title":"request(endpoint:as:)","roleHeading":"Instance Method","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Model"},{"kind":"text","text":">("},{"kind":"externalParam","text":"endpoint"},{"kind":"text","text":": some "},{"kind":"typeIdentifier","text":"Endpoint","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"as"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":".Type) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Model"}],"symbolKind":"method","externalID":"s:22SwiftLibsCommunication6ClientP7request8endpoint2asqd__qd_0__qd__mtYaKSeRd__AA8EndpointRd_0_r0_lF","required":true,"modules":[{"name":"SwiftLibsCommunication"}]},"hierarchy":{"paths":[["doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client"]]},"references":{"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client":{"role":"symbol","title":"Client","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"abstract":[{"type":"text","text":"This protocol defines a client that will be making the remote calls."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Client"}],"url":"\/documentation\/swiftlibscommunication\/client"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Client/request(endpoint:as:)":{"role":"symbol","title":"request(endpoint:as:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"request"},{"kind":"text","text":"<"},{"kind":"genericParameter","text":"Model"},{"kind":"text","text":">("},{"kind":"externalParam","text":"endpoint"},{"kind":"text","text":": some "},{"kind":"typeIdentifier","text":"Endpoint","preciseIdentifier":"s:22SwiftLibsCommunication8EndpointP"},{"kind":"text","text":", "},{"kind":"externalParam","text":"as"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Model"},{"kind":"text","text":".Type) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Model"}],"abstract":[{"type":"text","text":"Makes a request to a remote location based on a given endpoint and expects to return a response casted as a given model type."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Client\/request(endpoint:as:)","kind":"symbol","required":true,"type":"topic","url":"\/documentation\/swiftlibscommunication\/client\/request(endpoint:as:)"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication/Endpoint":{"role":"symbol","title":"Endpoint","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"Endpoint"}],"abstract":[{"type":"text","text":"This protocol defines an endpoint to be used in a remote call."}],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication\/Endpoint","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Endpoint"}],"url":"\/documentation\/swiftlibscommunication\/endpoint"},"doc://SwiftLibsCommunication/documentation/SwiftLibsCommunication":{"role":"collection","title":"SwiftLibsCommunication","abstract":[],"identifier":"doc:\/\/SwiftLibsCommunication\/documentation\/SwiftLibsCommunication","kind":"symbol","type":"topic","url":"\/documentation\/swiftlibscommunication"}}}