EngineGetFileSystemItemAsync Method |
IT Hit User File System
Gets file or folder item corresponding to the remote storage item ID.
Namespace:
ITHit.FileSystem
Assembly:
ITHit.FileSystem (in ITHit.FileSystem.dll) Version: 8.3.27213.0
Syntax public abstract Task<IFileSystemItem> GetFileSystemItemAsync(
byte[] itemId,
FileSystemItemType itemType,
IContext context,
ILogger logger = null
)
Public MustOverride Function GetFileSystemItemAsync (
itemId As Byte(),
itemType As FileSystemItemType,
context As IContext,
Optional logger As ILogger = Nothing
) As Task(Of IFileSystemItem)
public:
virtual Task<IFileSystemItem^>^ GetFileSystemItemAsync(
array<unsigned char>^ itemId,
FileSystemItemType itemType,
IContext^ context,
ILogger^ logger = nullptr
) abstract
abstract GetFileSystemItemAsync :
itemId : byte[] *
itemType : FileSystemItemType *
context : IContext *
?logger : ILogger
(* Defaults:
let _logger = defaultArg logger null
*)
-> Task<IFileSystemItem>
Parameters
- itemId
- Type: SystemByte
- itemType
- Type: ITHit.FileSystemFileSystemItemType
Item type - file or folder. - context
- Type: ITHit.FileSystemIContext
Additional platform-dependant information.
- logger (Optional)
- Type: ITHit.FileSystemILogger
Logger.
Return Value
Type:
TaskIFileSystemItem
File or folder item that corresponds to the
remoteStorageItemId.
Implements
IEngineGetFileSystemItemAsync(Byte, FileSystemItemType, IContext, ILogger)Remarks
This is a factory method that returns file and folder items.
In your implementation you will return file or folder item that corresponds to the provided
remoteStorageItemId parameter.
Your file must implement IFile interface. Your folder must implement IFolder interface.
The Engine will then call IFile and IFolder methods to execute operations
requested by the platform.
Note that this method may be called for files that does not exist in the user file system,
for example when a file handle is closed after the file has been deleted.
In case of macOS platform, there is no access to the local file system.
You should NOT try to determine item type or read local files/folders on macOS.
See Also