Class DependencyFile

Files marked as dependencies for the BCM content. Used for conversion from and to native formats.

Inheritance
object
ExtensionDataContainer
MetadataContainer
DependencyFile
Implements
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
[DataContract]
public class DependencyFile : MetadataContainer, IEquatable<MetadataContainer>, ICloneable<DependencyFile>, IEquatable<DependencyFile>

Constructors

DependencyFile()

Declaration
public DependencyFile()

Properties

EmbeddedContent

Gets or sets the embedded content.

Declaration
[DataMember(Name = "embeddedContent")]
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
public string EmbeddedContent { get; set; }
Property Value
Type Description
string

The embedded content.
Remarks

In the cases where the dependency file is stored inline, this will contain the B64-encoded ZIP archive of the dependency file

FileId

The id of the given file in the BCM document. This is used for multi-file sections in the BCM document and for matching the dependency section to the given file section in the BCM document

Declaration
[DataMember(Name = "fileId")]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public string FileId { get; set; }
Property Value
Type Description
string

FileName

Gets or sets the name of the file.

Declaration
[DataMember(Name = "fileName")]
public string FileName { get; set; }
Property Value
Type Description
string

The name of the file.

Id

The DependencyFile Id.

Declaration
[DataMember(Name = "id")]
public string Id { get; set; }
Property Value
Type Description
string

Location

Gets or sets the file location.

Declaration
[DataMember(Name = "location")]
public string Location { get; set; }
Property Value
Type Description
string

The file location.

Provider

Gets or sets the system providing the file.

Declaration
[DataMember(Name = "provider")]
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Ignore, NullValueHandling = NullValueHandling.Ignore)]
public string Provider { get; set; }
Property Value
Type Description
string

The system providing the file.

Usage

Gets or sets the purpose of the dependency file.

Declaration
[DataMember(Name = "usage")]
[JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
public DependencyFileUsage Usage { get; set; }
Property Value
Type Description
DependencyFileUsage

The purpose of the dependency file.

Methods

Clone()

Clones this instance.

Declaration
public DependencyFile Clone()
Returns
Type Description
DependencyFile

Equals(DependencyFile)

Performs a deep-equals comparison.

Declaration
public bool Equals(DependencyFile other)
Parameters
Type Name Description
DependencyFile other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Performs a deep-equals comparison.
System.Object.Equals(object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetHashCode()

Returns a hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for this instance.
Overrides

Implements