SwiftKit/data/documentation/swiftkit/standarddirectoryservice.json

{"seeAlsoSections":[{"title":"Files","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/BundleFileFinder","doc:\/\/SwiftKit\/documentation\/SwiftKit\/DirectoryService","doc:\/\/SwiftKit\/documentation\/SwiftKit\/FileExporter","doc:\/\/SwiftKit\/documentation\/SwiftKit\/FileFinder","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardFileExporter"],"generated":true}],"schemaVersion":{"major":0,"minor":2,"patch":0},"metadata":{"fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardDirectoryService"}],"title":"StandardDirectoryService","roleHeading":"Class","role":"symbol","symbolKind":"class","externalID":"s:8SwiftKit24StandardDirectoryServiceC","modules":[{"name":"SwiftKit"}],"navigatorTitle":[{"kind":"identifier","text":"StandardDirectoryService"}]},"abstract":[{"type":"text","text":"This is a standard implementation of the "},{"type":"codeVoice","code":"DirectoryService"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"You can inherit and override any parts of it."}],"sections":[],"identifier":{"url":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/DirectoryService"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/SwiftKit\/documentation\/SwiftKit"]]},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/init(directory:fileManager:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/init(fileManager:directoryUrl:)"]},{"title":"Instance Properties","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/directoryUrl"]},{"title":"Instance Methods","identifiers":["doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/createFile(named:contents:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/fileExists(withName:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getAttributesForFile(named:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getFileNames()","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getFileNames(matching:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getSizeOfAllFiles()","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getSizeOfFile(named:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getUrlForFile(named:)","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getUrlsForAllFiles()","doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/removeFile(named:)"]}],"variants":[{"paths":["\/documentation\/swiftkit\/standarddirectoryservice"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardDirectoryService"}],"languages":["swift"],"platforms":["iOS"]}]}],"references":{"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getFileNames()":{"role":"symbol","title":"getFileNames()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFileNames"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getFileNames()","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/getfilenames()"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService":{"role":"symbol","title":"StandardDirectoryService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardDirectoryService"}],"abstract":[{"type":"text","text":"This is a standard implementation of the "},{"type":"codeVoice","code":"DirectoryService"},{"type":"text","text":"."},{"type":"text","text":" "},{"type":"text","text":"You can inherit and override any parts of it."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StandardDirectoryService"}],"url":"\/documentation\/swiftkit\/standarddirectoryservice"},"doc://SwiftKit/documentation/SwiftKit":{"role":"collection","title":"SwiftKit","abstract":[{"type":"text","text":"SwiftKit adds extra functionality to the Swift framework, like extensions to native types, utilites, services etc."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/init(fileManager:directoryUrl:)":{"role":"symbol","title":"init(fileManager:directoryUrl:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"fileManager"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":", "},{"kind":"externalParam","text":"directoryUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/init(fileManager:directoryUrl:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/init(filemanager:directoryurl:)"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getSizeOfAllFiles()":{"role":"symbol","title":"getSizeOfAllFiles()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSizeOfAllFiles"},{"kind":"text","text":"() -> "},{"kind":"typeIdentifier","text":"UInt64","preciseIdentifier":"s:s6UInt64V"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getSizeOfAllFiles()","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/getsizeofallfiles()"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/directoryUrl":{"role":"symbol","title":"directoryUrl","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"directoryUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/directoryUrl","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/directoryurl"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/fileExists(withName:)":{"role":"symbol","title":"fileExists(withName:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"fileExists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"withName"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/fileExists(withName:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/fileexists(withname:)"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/removeFile(named:)":{"role":"symbol","title":"removeFile(named:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"removeFile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"named"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/removeFile(named:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/removefile(named:)"},"doc://SwiftKit/documentation/SwiftKit/FileExporter":{"role":"symbol","title":"FileExporter","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileExporter"}],"abstract":[{"type":"text","text":"This protocol can be implemented by any classes that can be"},{"type":"text","text":" "},{"type":"text","text":"used to export data to the file system."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/FileExporter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileExporter"}],"url":"\/documentation\/swiftkit\/fileexporter"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/createFile(named:contents:)":{"role":"symbol","title":"createFile(named:contents:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"createFile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"named"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":", "},{"kind":"externalParam","text":"contents"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Data","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":"?) -> "},{"kind":"typeIdentifier","text":"Bool","preciseIdentifier":"s:Sb"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/createFile(named:contents:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/createfile(named:contents:)"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/init(directory:fileManager:)":{"role":"symbol","title":"init(directory:fileManager:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"?("},{"kind":"externalParam","text":"directory"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"SearchPathDirectory","preciseIdentifier":"c:@E@NSSearchPathDirectory"},{"kind":"text","text":", "},{"kind":"externalParam","text":"fileManager"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"FileManager","preciseIdentifier":"c:objc(cs)NSFileManager"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/init(directory:fileManager:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/init(directory:filemanager:)"},"doc://SwiftKit/documentation/SwiftKit/DirectoryService":{"role":"symbol","title":"DirectoryService","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"DirectoryService"}],"abstract":[{"type":"text","text":"This service can be implemented by classes that can be used"},{"type":"text","text":" "},{"type":"text","text":"to handle files within a certain local file directory."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/DirectoryService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DirectoryService"}],"url":"\/documentation\/swiftkit\/directoryservice"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getSizeOfFile(named:)":{"role":"symbol","title":"getSizeOfFile(named:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getSizeOfFile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"named"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"UInt64","preciseIdentifier":"s:s6UInt64V"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getSizeOfFile(named:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/getsizeoffile(named:)"},"doc://SwiftKit/documentation/SwiftKit/BundleFileFinder":{"role":"symbol","title":"BundleFileFinder","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"BundleFileFinder"}],"abstract":[{"type":"text","text":"This class can be used to find files witin a certain bundle."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/BundleFileFinder","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"BundleFileFinder"}],"url":"\/documentation\/swiftkit\/bundlefilefinder"},"doc://SwiftKit/documentation/SwiftKit/StandardFileExporter":{"role":"symbol","title":"StandardFileExporter","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"StandardFileExporter"}],"abstract":[{"type":"text","text":"This file exporter can export data to the file system using"},{"type":"text","text":" "},{"type":"text","text":"a file manager and a certain directory."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardFileExporter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"StandardFileExporter"}],"url":"\/documentation\/swiftkit\/standardfileexporter"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getFileNames(matching:)":{"role":"symbol","title":"getFileNames(matching:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getFileNames"},{"kind":"text","text":"("},{"kind":"externalParam","text":"matching"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]) -> ["},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getFileNames(matching:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/getfilenames(matching:)"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getUrlForFile(named:)":{"role":"symbol","title":"getUrlForFile(named:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getUrlForFile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"named"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"?"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getUrlForFile(named:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/geturlforfile(named:)"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getUrlsForAllFiles()":{"role":"symbol","title":"getUrlsForAllFiles()","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getUrlsForAllFiles"},{"kind":"text","text":"() -> ["},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"},{"kind":"text","text":"]"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getUrlsForAllFiles()","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/geturlsforallfiles()"},"doc://SwiftKit/documentation/SwiftKit/FileFinder":{"role":"symbol","title":"FileFinder","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"FileFinder"}],"abstract":[{"type":"text","text":"This protocol can be implemented by types that can look for"},{"type":"text","text":" "},{"type":"text","text":"files in various ways."}],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/FileFinder","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"FileFinder"}],"url":"\/documentation\/swiftkit\/filefinder"},"doc://SwiftKit/documentation/SwiftKit/StandardDirectoryService/getAttributesForFile(named:)":{"role":"symbol","title":"getAttributesForFile(named:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAttributesForFile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"named"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":") -> ["},{"kind":"typeIdentifier","text":"FileAttributeKey","preciseIdentifier":"c:@T@NSFileAttributeKey"},{"kind":"text","text":" : "},{"kind":"keyword","text":"Any"},{"kind":"text","text":"]?"}],"abstract":[],"identifier":"doc:\/\/SwiftKit\/documentation\/SwiftKit\/StandardDirectoryService\/getAttributesForFile(named:)","kind":"symbol","type":"topic","url":"\/documentation\/swiftkit\/standarddirectoryservice\/getattributesforfile(named:)"}}}