Show / Hide Table of Contents

Class FileHandler

Inheritance
System.Object
BaseHandler
FileHandler
Inherited Members
BaseHandler.GetReusableApiRequest<T>()
BaseHandler.GetHandlerStoragePath<T>()
BaseHandler.JSON_FOLDER_NAME
BaseHandler.GetHandlerJsonFolderPath<K>()
BaseHandler.GetApiJsonFullPath<T, K>()
BaseHandler.GetApiJsonFullPath<T, K>(UserProfile)
BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile)
BaseHandler.GetApiJsonFullPath<T, K>(UserProfile, Int32, String)
BaseHandler.GetApiJsonFullPath<T, K>(T, UserProfile, Int32, String)
BaseHandler.GetApiDownloadedBytesFullPath<T, K>(T, UserProfile, Int32, String)
BaseHandler.GetContentFromFileProcess(String, Action<Byte[]>, DataTransferStatus)
BaseHandler.SaveContentToFileProcess(Byte[], String, Action<Boolean>)
BaseHandler.DeleteFileProcess(String, Action<Boolean>)
BaseHandler.CopyFileToDestinationProcess(String, String, Action<Boolean>)
BaseHandler.IsThereExistingMediaWithMatchingChecksum(String, String)
BaseHandler.GetChecksumFromExistingFile(String)
BaseHandler.ClearHandlerCache<T>(Action<Boolean>)
BaseHandler.TokenUsedForDownloads
BaseHandler.DownloadGenericFile(String, String, String, Boolean, Action<Byte[]>, DataTransferStatus)
BaseHandler.GetEmsContentFileSize(String, Action<Nullable<Int64>>)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Appearition
Assembly: Appearition.SDK.dll
Syntax
public class FileHandler : BaseHandler

Methods

View Source

CopyExistingFileToDestination(String, String, Action<Boolean>)

Copies a local file at a given path to a destination at a given path.

Declaration
public static void CopyExistingFileToDestination(string pathToSourceFile, string pathToDestinationFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.String pathToSourceFile

The full path to the original file, including filename and extension.

System.String pathToDestinationFile

The full path to the destination file location, including filename and extension.

System.Action<System.Boolean> onComplete

Called once the process is complete. Includes whether or not the action was successful.

View Source

CopyExistingFileToDestinationProcess(String, String, Action<Boolean>)

Copies a local file at a given path to a destination at a given path.

Declaration
public static IEnumerator CopyExistingFileToDestinationProcess(string pathToSourceFile, string pathToDestinationFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.String pathToSourceFile

The full path to the original file, including filename and extension.

System.String pathToDestinationFile

The full path to the destination file location, including filename and extension.

System.Action<System.Boolean> onComplete

Called once the process is complete. Includes whether or not the action was successful.

Returns
Type Description
System.Collections.IEnumerator
View Source

DeleteExistingFile(String, Action<Boolean>)

Deletes the file at a given location.

Declaration
public static void DeleteExistingFile(string pathToFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.String pathToFile

The full path to the file, including filename and extension.

System.Action<System.Boolean> onComplete

Called once the process is complete. Includes whether or not the action was successful.

View Source

DeleteExistingFileProcess(String, Action<Boolean>)

Deletes the file at a given location.

Declaration
public static IEnumerator DeleteExistingFileProcess(string pathToFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.String pathToFile

The full path to the file, including filename and extension.

System.Action<System.Boolean> onComplete

Called once the process is complete. Includes whether or not the action was successful.

Returns
Type Description
System.Collections.IEnumerator
View Source

LoadBytesFromFile(String, Action<Byte[]>)

Fetches the content of a local file at a given path.

Declaration
public static void LoadBytesFromFile(string pathToFile, Action<byte[]> onComplete = null)
Parameters
Type Name Description
System.String pathToFile

Full path to the file to load.

System.Action<System.Byte[]> onComplete

Called once the file loading process has completed. Contains the file content.

View Source

LoadBytesFromFileProcess(String, Action<Byte[]>)

Fetches the content of a local file at a given path.

Declaration
public static IEnumerator LoadBytesFromFileProcess(string pathToFile, Action<byte[]> onComplete = null)
Parameters
Type Name Description
System.String pathToFile

Full path to the file to load.

System.Action<System.Byte[]> onComplete

Called once the file loading process has completed. Contains the file content.

Returns
Type Description
System.Collections.IEnumerator
View Source

SaveBytesToFile(Byte[], String, Action<Boolean>)

Declaration
public static void SaveBytesToFile(byte[] data, string pathToFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.Byte[] data
System.String pathToFile
System.Action<System.Boolean> onComplete
View Source

SaveBytesToFileProcess(Byte[], String, Action<Boolean>)

Saves given content to a file at a given full path.

Declaration
public static IEnumerator SaveBytesToFileProcess(byte[] data, string pathToFile, Action<bool> onComplete = null)
Parameters
Type Name Description
System.Byte[] data

The content that the file should contain.

System.String pathToFile

The full path to the file, including filename and extension.

System.Action<System.Boolean> onComplete

Called once the process is complete. Includes whether or not the action was successful.

Returns
Type Description
System.Collections.IEnumerator

Extension Methods

ObjectExtension.ToStream(Object)
  • View Source
Back to top Generated by DocFX