MyFileExplorerSDK class

This class allows for the easy exploration of this app's working directory.

Constructors

MyFileExplorerSDK()

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

cleanPath(String filePath) → String

Removes leading and trailing path separators from the given filePath.

createPath({required LocalDir localDir, required String subPath}) → Future<String>

Allows for the easy creation of a path string.

createPathToFile({required LocalDir localDir, String? subPath, required String fileName, bool validateFileName = true}) → Future<String>

Allows for the easy creation of a path string containing a file at the end.

fetchDir(LocalDir localDir) → Future<Directory>

Fetches the local directory that matches the given localDir.

fetchFile(String filePath) → Future<File>

Returns the file that is found with the given filePath.

fetchPath(LocalDir localDir) → Future<String>

Fetches the local directory path that matches the given localDir.

getBaseName(String filePath) → String?

This method gets the file base name from a path.

getFileName(String filePath) → String?

This method gets the file name from a path.

getNewNameWithPath(String filePath, String newFileName) → String

Returns a new file path by combining the given filePath and newFileName.

isSterileFileName(String fileName) → bool

Whether the given fileName is legal or not.

isSterilePath(String filePath) → bool

Whether the given filePath is legal or not.

isValidFileName(String fileName) → bool

Whether the giving fileName is valid.

parseFileExt(String fileName) → String

Returns the file extension of fileName.

sterilizeFileName(String fileName) → String

Removes illegal characters from the givin fileName.

sterilizePath(String filePath) → String

Removes illegal characters from the givin filePath.

tryFetchFile(String filePath) → Future<File?>

Like fetchFile except that this function returns null where a similar call to fetchFile would throw a FileSystemException.

tryGetNewNameWithPath(String filePath, String newFileName) → String?

Like getNewNameWithPath except that this function returns null where a similar call to getNewNameWithPath would throw a FormatException.

tryParseFileExt(String fileName) → String?

Like parseFileExt except that this function returns null where a similar call to parseFileExt would throw a FormatException.