Class FileMetadata

File metadata.

Inheritance

System.Object

FileMetadata

Implements

IFileMetadata

Namespace: OpenText.Fusion.AdapterSdk.Api

Assembly: OpenText.Fusion.AdapterSdk.Api.dll

Syntax

public class FileMetadata : object, IFileMetadata

Remarks

Represents a repository file metadata. In most cases, the default implementation should be used, FileMetadata.

Constructors

FileMetadata()

Initializes a new instance of the FileMetadata class.

Declaration

public FileMetadata()

FileMetadata(String, String)

Initializes a new instance of the FileMetadata class.

Declaration

public FileMetadata(string name, string fileLocation)

Parameters

Type	Name	Description
System.String	name	The file name.
System.String	fileLocation	The file location.

Properties

AccessedTime

File last accessed date time.

Declaration

public DateTime? AccessedTime { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

AdditionalMetadata

Gets the additional metadata.

Declaration

public IDictionary<string, IEnumerable<string>> AdditionalMetadata { get; set; }

Property Value

Type	Description
IDictionary<System.String, IEnumerable<System.String>>	The additional metadata.

Remarks

Important metadata to attach to a file that is not covered by other properties.

CreatedTime

File created date time.

Declaration

public DateTime? CreatedTime { get; set; }

Property Value

Type	Description
System.Nullable<DateTime>

FileLocation

File location - full path or repository identifier.

Declaration

public string FileLocation { get; set; }

Property Value

Type	Description
System.String

Remarks

This property should contain everything that is needed to locate and retrieve a file from the repository. This property is required.

FilePath

File path.

Declaration

public string? FilePath { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

ModifiedTime

File modified date time.

Declaration

public DateTime ModifiedTime { get; set; }

Property Value

Type	Description
DateTime

Remarks

Value of the ModifiedTime will be used when detecting updated documents.

Name

File name.

Declaration

public string? Name { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Title

File title.

Declaration

public string? Title { get; set; }

Property Value

Type	Description
System.Nullable<System.String>

Version

Revision number if available.

Declaration

public int? Version { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

WrapStringDictionary(IDictionary<String, IEnumerable<String>>)

Creates an IFileMetadata instance that is backed by the specified dictionary.

Declaration

public static IFileMetadata WrapStringDictionary(IDictionary<string, IEnumerable<string>> metadata)

Parameters

Type	Name	Description
IDictionary<System.String, IEnumerable<System.String>>	metadata	The string dictionary that contains the file metadata.

Returns

Type	Description
IFileMetadata	A file metadata object that reads from the dictionary.

Implements

IFileMetadata