Class MediaType.FileValidation

Used to determine whether the MediaFile is respecting the EMS's rulesets for this MediaType.

Inheritance
System.Object
MediaType.FileValidation
Inherited Members
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.Common
Assembly: Appearition.SDK.dll
Syntax
[Serializable]
public class FileValidation

Constructors

View Source

FileValidation()

Declaration
public FileValidation()
View Source

FileValidation(MediaType.FileValidation)

Copy Constructor

Declaration
public FileValidation(MediaType.FileValidation cc)
Parameters
Type Name Description
MediaType.FileValidation cc

C.

Fields

View Source

AllowFileNameWhitespace

Declaration
public bool AllowFileNameWhitespace
Field Value
Type Description
System.Boolean
View Source

AllowSameNamedFile

Declaration
public bool AllowSameNamedFile
Field Value
Type Description
System.Boolean
View Source

CheckForInvalidFileNameChars

Declaration
public bool CheckForInvalidFileNameChars
Field Value
Type Description
System.Boolean
View Source

Id

Declaration
public int Id
Field Value
Type Description
System.Int32
View Source

InvalidFileNameCharsCsv

Declaration
public string InvalidFileNameCharsCsv
Field Value
Type Description
System.String
View Source

MaxHeight

Declaration
public int MaxHeight
Field Value
Type Description
System.Int32
View Source

MaxWidth

Declaration
public int MaxWidth
Field Value
Type Description
System.Int32
View Source

MediaTypeName

Declaration
public string MediaTypeName
Field Value
Type Description
System.String
View Source

MinHeight

Declaration
public int MinHeight
Field Value
Type Description
System.Int32
View Source

MinWidth

Declaration
public int MinWidth
Field Value
Type Description
System.Int32
View Source

Notes

Declaration
public string Notes
Field Value
Type Description
System.String
View Source

PlatformType

Declaration
public string PlatformType
Field Value
Type Description
System.String
View Source

ValidFileMimeTypeCsv

Declaration
public string ValidFileMimeTypeCsv
Field Value
Type Description
System.String
View Source

ValidFileNameExtensionCsv

Declaration
public string ValidFileNameExtensionCsv
Field Value
Type Description
System.String
View Source

ValidFileSizeInBytes

Declaration
public long ValidFileSizeInBytes
Field Value
Type Description
System.Int64
View Source

ValidFileSizeInKBytes

Declaration
public long ValidFileSizeInKBytes
Field Value
Type Description
System.Int64
View Source

ValidFileSizeInMBytes

Declaration
public long ValidFileSizeInMBytes
Field Value
Type Description
System.Int64

Methods

View Source

ContainsExtension(String)

Returns whether or not this File Validation contains the given extension as a rule.

Declaration
public bool ContainsExtension(string extension)
Parameters
Type Name Description
System.String extension

Extension.
Returns
Type Description
System.Boolean

true, if extension was containsed, false otherwise.
View Source

GetAllInvalidCharacters()

Returns all the invalid characters a filename cannot have, as a char array.

Declaration
public char[] GetAllInvalidCharacters()
Returns
Type Description
System.Char[]
View Source

GetFileExtensions(Boolean, Boolean)

Returns a list of all the file extensions allowed for this file validation.

Declaration
public string[] GetFileExtensions(bool includeDot = true, bool includeStar = false)
Parameters
Type Name Description
System.Boolean includeDot

eg .mp4
System.Boolean includeStar

eg *.mp4
Returns
Type Description
System.String[]

The file extensions.
View Source

GetMimeTypeForExtension(String)

From a given extension, finds and fetches a mimetype.

Declaration
public string GetMimeTypeForExtension(string extension)
Parameters
Type Name Description
System.String extension

Extension.
Returns
Type Description
System.String

The MIME type for extension.
View Source

GetMimeTypes()

Returns a container with all available mimetypes for this file validation.

Declaration
public string[] GetMimeTypes()
Returns
Type Description
System.String[]

The MIME types.
View Source

IsFileValid(String, Int32)

Handle the file validation for this specific file validation content. The MediaType should be having the final word on whether the file is valid or not.

Declaration
public bool IsFileValid(string fileNameWithExtension, int fileSizeInBytes)
Parameters
Type Name Description
System.String fileNameWithExtension

File name with extension.
System.Int32 fileSizeInBytes

File size in bytes.
Returns
Type Description
System.Boolean

true if this instance is file valid the specified fileNameWithExtension fileSizeInBytes; otherwise, false.

Extension Methods