API Reference
OfficeDocumentReadResultSchema
Stable schema values for the OfficeIMO document read result transport contract.
Inheritance
- Object
- OfficeDocumentReadResultSchema
Methods
public static Void EnsureSupported(String schemaId, Int32 schemaVersion) #VoidThrows when a schema header cannot be consumed by this package.
Parameters
- schemaId System.String
- schemaVersion System.Int32
public static String GetJsonSchema() #StringLoads the JSON Schema artifact embedded in the assembly and included in the NuGet package.
public static String GetJsonSchema(Int32 schemaVersion) #StringLoads one supported versioned JSON Schema artifact embedded in the assembly and included in the NuGet package.
Parameters
- schemaVersion System.Int32
public static Boolean IsSupported(String schemaId, Int32 schemaVersion) #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) #BooleanParameters
- obj Object
Fields
public const String Id #Stable schema identifier for shared document readback results.
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.
5public const Int32 CurrentVersion #Current schema version emitted and accepted by this package.
6public const String JsonSchemaId #Stable JSON Schema identifier for current version 6 payloads.
urn:officeimo:schema:document-read-result:6public const String JsonSchemaFileName #File name used for the packaged current JSON Schema artifact.
officeimo.document.read-result.v6.schema.json