API Reference
Class
OfficeDocumentReadResultSchema
Stable schema values for the OfficeIMO document read result transport contract.
Inheritance
- Object
- OfficeDocumentReadResultSchema
Methods
public static Void EnsureSupported(String schemaId, Int32 schemaVersion) #Returns:
VoidThrows when a schema header cannot be consumed by this package.
Parameters
- schemaId System.String
- schemaVersion System.Int32
public static String GetJsonSchema() #Returns:
StringLoads the JSON Schema artifact embedded in the assembly and included in the NuGet package.
public static Boolean IsSupported(String schemaId, Int32 schemaVersion) #Returns:
BooleanReturns true when a schema header can be consumed by this package.
Parameters
- schemaId System.String
- schemaVersion System.Int32
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Fields
public const String Id #Stable schema identifier for shared document readback results.
Value:
officeimo.document.read-resultpublic const Int32 MinimumSupportedVersion #First schema version covered by the stable compatibility contract. Versions 1 through 4 were experimental and are not accepted by the transport reader.
Value:
5public const Int32 CurrentVersion #Current schema version emitted and accepted by this package.
Value:
5public const String JsonSchemaId #Stable JSON Schema identifier for version 5 payloads.
Value:
urn:officeimo:schema:document-read-result:5public const String JsonSchemaFileName #File name used for the packaged version 5 JSON Schema artifact.
Value:
officeimo.document.read-result.v5.schema.json