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

{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"type":"text","text":"Get all the collection folders of a user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getcollectionfolders(path:headers:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionFolders(path:headers:)"},"metadata":{"title":"getCollectionFolders(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionFolders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","kind":"typeIdentifier"}],"role":"symbol","extendedModule":"DiscogsService","modules":[{"name":"DiscogsService"}],"symbolKind":"method","externalID":"s:14DiscogsService11APIProtocolPAAE20getCollectionFolders4path7headersAA10OperationsO03GeteF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","roleHeading":"Instance Method"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCollectionFolders"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input\/Path-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV4PathV","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","text":"Output"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Retrieves a list of folders in a collection of a user."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"In case the collection has been made private by its owner, authentication as the collection owner is required. Otherwise, only folder `ID 0`` (the “All” folder) will be visible only if the requested collection of a user is public."}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/collection\/folders"},{"type":"text","text":"."}]}]},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/collection\/folders\/get(getCollectionFolders)"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Input/Headers-swift.struct":{"abstract":[],"kind":"symbol","title":"Operations.GetCollectionFolders.Input.Headers","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input\/Headers-swift.struct","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/input\/headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Output":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}],"title":"Operations.GetCollectionFolders.Output","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Output","abstract":[],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Client/getCollectionFolders(path:headers:)":{"kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionFolders","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV4PathV","text":"Path","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO5InputV7HeadersV","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:14DiscogsService10OperationsO20GetCollectionFoldersO","text":"GetCollectionFolders","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO20GetCollectionFoldersO6OutputO","text":"Output","kind":"typeIdentifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/client\/getcollectionfolders(path:headers:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionFolders(path:headers:)","type":"topic","abstract":[{"type":"text","text":"Get all the collection folders of a user."}],"title":"getCollectionFolders(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders":{"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"GetCollectionFolders","kind":"identifier"}],"abstract":[{"type":"text","text":"Get all the collection folders of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders","title":"Operations.GetCollectionFolders","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetCollectionFolders"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Client":{"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"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"}]},{"text":", ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"text":". Your application can also manage ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","title":"Client","url":"\/documentation\/discogsservice\/client","role":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","url":"\/documentation\/discogsservice\/operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Input":{"title":"Operations.GetCollectionFolders.Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/input","abstract":[],"role":"symbol","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionFolders/Input/Path-swift.struct":{"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.GetCollectionFolders.Input.Path","url":"\/documentation\/discogsservice\/operations\/getcollectionfolders\/input\/path-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionFolders\/Input\/Path-swift.struct","abstract":[],"kind":"symbol"}}}