IEngineGetFileSystemItemAsync Method

Task<IFileSystemItem> GetFileSystemItemAsync(
	byte[] remoteStorageItemId,
	FileSystemItemType itemType,
	IContext context,
	ILogger logger = null
)

Function GetFileSystemItemAsync ( 
	remoteStorageItemId As Byte(),
	itemType As FileSystemItemType,
	context As IContext,
	Optional logger As ILogger = Nothing
) As Task(Of IFileSystemItem)

Task<IFileSystemItem^>^ GetFileSystemItemAsync(
	array<unsigned char>^ remoteStorageItemId, 
	FileSystemItemType itemType, 
	IContext^ context, 
	ILogger^ logger = nullptr
)

abstract GetFileSystemItemAsync : 
        remoteStorageItemId : byte[] * 
        itemType : FileSystemItemType * 
        context : IContext * 
        ?logger : ILogger 
(* Defaults:
        let _logger = defaultArg logger null
*)
-> Task<IFileSystemItem> 

Parameters

remoteStorageItemId

Type: SystemByte
Item ID or null if the remote storage item ID was never set or if the item is not a placeholder (for example this is a new item). See the RemoteStorageItemId description for more details.

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

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.

Reference