Class Snippet

Inheritance

System.Object

Snippet

Namespace: CycloneDX.Spdx.Models.v2_2

Assembly: CycloneDX.Spdx.dll

Syntax

public class Snippet : object

Properties

Annotations

Provide additional information about an SpdxElement.

Declaration

public List<Annotation> Annotations { get; set; }

Property Value

Type	Description
List<Annotation>

AttributionTexts

This field provides a place for the SPDX data creator to record acknowledgements that may be required to be communicated in some contexts. This is not meant to include theactual complete license text (see licenseConculded and licenseDeclared), and may or may not include copyright notices (see also copyrightText). The SPDX data creator may use this field to record other acknowledgements, such as particular clauses from license texts, which may be necessary or desirable to reproduce.

Declaration

public List<string> AttributionTexts { get; set; }

Property Value

Type	Description
List<System.String>

Comment

Declaration

public string Comment { get; set; }

Property Value

Type	Description
System.String

CopyrightText

The text of copyright declarations recited in the Package or File.

Declaration

public string CopyrightText { get; set; }

Property Value

Type	Description
System.String

LicenseComments

The licenseComments property allows the preparer of the SPDX document to describe why the licensing in spdx:licenseConcluded was chosen.

Declaration

public string LicenseComments { get; set; }

Property Value

Type	Description
System.String

LicenseConcluded

License expression for licenseConcluded. The licensing that the preparer of this SPDX document has concluded, based on the evidence, actually applies to the package.

Declaration

public string LicenseConcluded { get; set; }

Property Value

Type	Description
System.String

LicenseInfoInSnippets

Licensing information that was discovered directly in the subject snippet. This is also considered a declared license for the snippet.

Declaration

public List<string> LicenseInfoInSnippets { get; set; }

Property Value

Type	Description
List<System.String>

Name

Identify name of this SpdxElement.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

Ranges

This field defines the byte range in the original host file (in X.2) that the snippet information applies to

Declaration

public List<Range> Ranges { get; set; }

Property Value

Type	Description
List<Range>

SnippetFromFile

SPDX ID for File. File containing the SPDX element (e.g. the file contaning a snippet).

Declaration

public string SnippetFromFile { get; set; }

Property Value

Type	Description
System.String

SPDXID

Uniquely identify any element in an SPDX document which may be referenced by other elements.

Declaration

public string SPDXID { get; set; }

Property Value

Type	Description
System.String