discogs-service/docs/data/documentation/discogsservice/client/getcollectionitemsbyfolder(path:query:headers:).json

{"metadata":{"externalID":"s:14DiscogsService11APIProtocolPAAE26getCollectionItemsByFolder4path5query7headersAA10OperationsO03GetefgH0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","title":"getCollectionItemsByFolder(path:query:headers:)","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionItemsByFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","text":"GetCollectionItemsByFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO","text":"Output","kind":"typeIdentifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService"},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionItemsByFolder(path:query:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"abstract":[{"type":"text","text":"Get collection items of a user inside a specified folder."}],"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionItemsByFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","text":"GetCollectionItemsByFolder","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Path-swift.struct","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","text":"GetCollectionItemsByFolder","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","text":"Input"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV","kind":"typeIdentifier"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO","text":"GetCollectionItemsByFolder"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV","text":"Input"},{"kind":"text","text":"."},{"text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"GetCollectionItemsByFolder","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns the list of items in a specified collection folder of a user.","type":"text"}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoint provides pagination parameters and also, requires authentication as an owner of a collection only in case the "},{"code":"folder_id","type":"codeVoice"},{"type":"text","text":" is not "},{"code":"0","type":"codeVoice"},{"type":"text","text":", or the collection has been made private by its owner. Otherwise, only public notes fields will be visible."}]},{"content":[{"type":"paragraph","inlineContent":[{"text":"HTTP ","type":"text"},{"code":"GET \/users\/{username}\/collection\/folders\/{folder_id}\/releases","type":"codeVoice"},{"text":".","type":"text"}]}],"type":"aside","style":"note","name":"Remark"},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/get(getCollectionItemsByFolder)","type":"codeVoice"},{"text":".","type":"text"}]}]}],"kind":"content"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getcollectionitemsbyfolder(path:query:headers:)"]}],"sections":[],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input":{"title":"Operations.GetCollectionItemsByFolder.Input","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder","navigatorTitle":[{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"abstract":[{"type":"text","text":"Get collection items of a user inside a specified folder."}],"title":"Operations.GetCollectionItemsByFolder","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","navigatorTitle":[{"kind":"identifier","text":"Client"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"text":"Wantlists","type":"text"}]},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"type":"text","text":" listings, and more."}],"title":"Client","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Path-swift.struct":{"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Path-swift.struct","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}],"title":"Operations.GetCollectionItemsByFolder.Input.Path","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/path-swift.struct","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Headers-swift.struct":{"title":"Operations.GetCollectionItemsByFolder.Input.Headers","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/headers-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"Headers","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Headers-swift.struct","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/input\/query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Input\/Query-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionItemsByFolder.Input.Query"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByFolder/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByFolder\/Output","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"Operations.GetCollectionItemsByFolder.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyfolder\/output"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Client/getCollectionItemsByFolder(path:query:headers:)":{"url":"\/documentation\/discogsservice\/client\/getcollectionitemsbyfolder(path:query:headers:)","abstract":[{"type":"text","text":"Get collection items of a user inside a specified folder."}],"title":"getCollectionItemsByFolder(path:query:headers:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionItemsByFolder","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByFolder","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO26GetCollectionItemsByFolderO6OutputO"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionItemsByFolder(path:query:headers:)","role":"symbol"}}}