API Reference
HtmlCapabilityGalleryArtifact
Describes one artifact emitted by an HTML capability-gallery scenario.
Inheritance
- Object
- HtmlCapabilityGalleryArtifact
Usage
Explore 6 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 4
Accepted by parameters 2
Constructors
public HtmlCapabilityGalleryArtifact(String id, String kind, String path, String mediaType, Int64 length, String sha256) #Creates an artifact descriptor.
Parameters
- id System.String
- Stable artifact identifier within the scenario.
- kind System.String
- Artifact kind, such as input-html, docx, or roundtrip-html.
- path System.String
- Artifact file path.
- mediaType System.String
- Artifact media type.
- length System.Int64
- Artifact length in bytes.
- sha256 System.String
- Lowercase hexadecimal SHA-256 hash of the artifact bytes.
Methods
public static HtmlCapabilityGalleryArtifact FromFile(String id, String kind, String path, String mediaType) #HtmlCapabilityGalleryArtifactCreates an artifact descriptor from an existing file.
Parameters
- id System.String
- Stable artifact identifier within the scenario.
- kind System.String
- Artifact kind, such as input-html, docx, or roundtrip-html.
- path System.String
- Artifact file path.
- mediaType System.String
- Artifact media type.
Returns
A descriptor containing file length and SHA-256 hash.
public HtmlCapabilityGalleryArtifact WithEvidence(HtmlCapabilityGalleryArtifactEvidence evidence) #HtmlCapabilityGalleryArtifactReturns a descriptor with immutable artifact observations attached.
Parameters
- evidence OfficeIMO.Html.HtmlCapabilityGalleryArtifactEvidence
public static HtmlCapabilityGalleryArtifact WriteTextFile(String id, String kind, String path, String mediaType, String content) #HtmlCapabilityGalleryArtifactWrites text content to an artifact file and returns its descriptor.
Parameters
- id System.String
- Stable artifact identifier within the scenario.
- kind System.String
- Artifact kind, such as semantic-html or manifest-json.
- path System.String
- Artifact file path.
- mediaType System.String
- Artifact media type.
- content System.String
- Text content to write.
Returns
A descriptor containing file length and SHA-256 hash.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Id { get; } #Stable artifact identifier within the scenario.
public String Kind { get; } #Artifact kind, such as input-html, docx, or roundtrip-html.
public String Sha256 { get; } #Lowercase hexadecimal SHA-256 hash of the artifact bytes.
public HtmlCapabilityGalleryArtifactEvidence? Evidence { get; private set; } #Optional observations captured from the operation that produced these exact bytes.