UNPKG

ai.videokit.videokit

Version:

The cross-platform media solution for Unity Engine.

665 lines (664 loc) 198 kB
<?xml version="1.0"?> <doc> <assembly> <name>NJsonSchema</name> </assembly> <members> <member name="T:NJsonSchema.Annotations.CanBeNullAttribute"> <summary>Indicates that the value of the marked element is nullable.</summary> </member> <member name="T:NJsonSchema.Annotations.IJsonSchemaExtensionDataAttribute"> <summary>Interface to add an extension data property to a class or property, implementation needs to inherit from System.Attribute.</summary> </member> <member name="P:NJsonSchema.Annotations.IJsonSchemaExtensionDataAttribute.Key"> <summary>Gets the property name.</summary> </member> <member name="P:NJsonSchema.Annotations.IJsonSchemaExtensionDataAttribute.Value"> <summary>Gets the value.</summary> </member> <member name="T:NJsonSchema.Annotations.ItemsCanBeNullAttribute"> <summary>Annotation to specify that array items or dictionary values are nullable.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaAbstractAttribute"> <summary>Annotation to merge all inherited properties into this class/schema.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaAbstractAttribute.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAbstractAttribute"/> class.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaAbstractAttribute.#ctor(System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAbstractAttribute"/> class.</summary> <param name="isAbstract">The explicit flag to override the global setting (i.e. disable the generation for a type).</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaAbstractAttribute.IsAbstract"> <summary>Gets or sets a value indicating whether to set the x-abstract property for given type.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaAttribute"> <summary>Annotation to specify the JSON Schema type for the given class.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaAttribute.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute"/> class.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaAttribute.#ctor(System.String)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute" /> class.</summary> <param name="name">The identifier of the schema which is used as key in the 'definitions' list.</param> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaAttribute.#ctor(NJsonSchema.JsonObjectType)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute"/> class.</summary> <param name="type">The JSON Schema type.</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaAttribute.Name"> <summary>Gets or sets the name identifier of the schema which is used as key in the 'definitions' list.</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaAttribute.Type"> <summary>Gets the JSON Schema type (default: <see cref="F:NJsonSchema.JsonObjectType.None"/>, i.e. derived from <see cref="T:System.Type"/>).</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaAttribute.Format"> <summary>Gets or sets the JSON format type (default: <c>null</c>, i.e. derived from <see cref="T:System.Type"/>).</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaAttribute.ArrayItem"> <summary>Gets or sets the array item type.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaDateAttribute"> <summary>Annotation to mark a property or class as string type with format 'date'.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaDateAttribute.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute"/> class.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaExtensionDataAttribute"> <summary>Adds an extension data property to a class or property.</summary> <seealso cref="T:System.Attribute" /> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaExtensionDataAttribute.#ctor(System.String,System.Object)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaExtensionDataAttribute"/> class.</summary> <param name="key">The key.</param> <param name="value">The value.</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaExtensionDataAttribute.Key"> <summary>Gets the property name.</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaExtensionDataAttribute.Value"> <summary>Gets the value.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaFlattenAttribute"> <summary>Annotation to merge all inherited properties into this class/schema.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaFlattenAttribute.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaFlattenAttribute"/> class.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaFlattenAttribute.#ctor(System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAbstractAttribute"/> class.</summary> <param name="flatten">The explicit flag to override the global setting (i.e. disable the generation for a type).</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaFlattenAttribute.Flatten"> <summary>Gets or sets a value indicating whether to flatten the given type.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaIgnoreAttribute"> <summary>Indicates that the marked class is ignored during the JSON Schema generation.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaPatternPropertiesAttribute"> <summary>Annotation to specify the JSON Schema pattern properties.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaPatternPropertiesAttribute.#ctor(System.String)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute" /> class.</summary> <param name="regularExpression">The pattern property regular expression.</param> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaPatternPropertiesAttribute.#ctor(System.String,System.Type)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaAttribute" /> class.</summary> <param name="regularExpression">The pattern property regular expression.</param> <param name="type">The pattern properties type.</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaPatternPropertiesAttribute.RegularExpression"> <summary>Gets the pattern properties regular expression.</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaPatternPropertiesAttribute.Type"> <summary>Gets the pattern properties type.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaProcessorAttribute"> <summary>Registers an schema processor for the given class.</summary> <seealso cref="T:System.Attribute" /> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaProcessorAttribute.#ctor(System.Type,System.Object[])"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaProcessorAttribute"/> class.</summary> <param name="type">The schema processor type (must implement ISchemaProcessor).</param> <param name="parameters">The parameters.</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaProcessorAttribute.Type"> <summary>Gets or sets the type of the operation processor (must implement ISchemaProcessor).</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaProcessorAttribute.Parameters"> <summary>Gets or sets the type of the constructor parameters.</summary> </member> <member name="T:NJsonSchema.Annotations.JsonSchemaTypeAttribute"> <summary>Specifies the type to use for JSON Schema generation.</summary> </member> <member name="M:NJsonSchema.Annotations.JsonSchemaTypeAttribute.#ctor(System.Type)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.JsonSchemaTypeAttribute"/> class.</summary> <param name="type">The type of the schema.</param> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaTypeAttribute.Type"> <summary>Gets or sets the response type.</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaTypeAttribute.IsNullable"> <summary>Gets or sets a value indicating whether the schema can be null (default: null = unchanged).</summary> </member> <member name="P:NJsonSchema.Annotations.JsonSchemaTypeAttribute.IsNullableRaw"> <summary>Gets the raw nullable information.</summary> </member> <member name="T:NJsonSchema.Annotations.MultipleOfAttribute"> <summary>Attribute to set the multipleOf parameter of a JSON Schema.</summary> </member> <member name="M:NJsonSchema.Annotations.MultipleOfAttribute.#ctor(System.Double)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.MultipleOfAttribute"/> class.</summary> <param name="multipleOf">The multipleOf value.</param> </member> <member name="M:NJsonSchema.Annotations.MultipleOfAttribute.#ctor(System.Decimal)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Annotations.MultipleOfAttribute"/> class.</summary> <param name="multipleOf">The multipleOf value.</param> </member> <member name="P:NJsonSchema.Annotations.MultipleOfAttribute.MultipleOf"> <summary>Gets the value whose modulo the the JSON value must be zero.</summary> </member> <member name="T:NJsonSchema.Annotations.NotNullAttribute"> <summary>Indicates that the value of the marked element could never be <c>null</c>.</summary> </member> <member name="T:NJsonSchema.ObservableCollectionExtensions"> <summary> Performance helpers avoiding struct enumerator building and generally faster accessing. </summary> </member> <member name="T:NJsonSchema.Collections.ObservableDictionary`2"> <summary>An implementation of an observable dictionary. </summary> <typeparam name="TKey">The type of the key. </typeparam> <typeparam name="TValue">The type of the value. </typeparam> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1})"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> <param name="dictionary">The dictionary to initialize this dictionary. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> <param name="comparer">The comparer. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor(System.Int32)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> <param name="capacity">The capacity. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1},System.Collections.Generic.IEqualityComparer{`0})"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> <param name="dictionary">The dictionary to initialize this dictionary. </param> <param name="comparer">The comparer. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.#ctor(System.Int32,System.Collections.Generic.IEqualityComparer{`0})"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Collections.ObservableDictionary`2"/> class. </summary> <param name="capacity">The capacity. </param> <param name="comparer">The comparer. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.AddRange(System.Collections.Generic.IDictionary{`0,`1})"> <summary>Adds multiple key-value pairs the the dictionary. </summary> <param name="items">The key-value pairs. </param> </member> <member name="M:NJsonSchema.Collections.ObservableDictionary`2.Insert(`0,`1,System.Boolean)"> <summary>Inserts a key-value pair into the dictionary. </summary> <param name="key">The key. </param> <param name="value">The value. </param> <param name="add">If true and key already exists then an exception is thrown. </param> </member> <member name="T:NJsonSchema.ConversionUtilities"> <summary>Provides name conversion utility methods.</summary> </member> <member name="M:NJsonSchema.ConversionUtilities.ConvertToLowerCamelCase(System.String,System.Boolean)"> <summary>Converts the first letter to lower case and dashes to camel case.</summary> <param name="input">The input.</param> <param name="firstCharacterMustBeAlpha">Specifies whether to add an _ when the first character is not alpha.</param> <returns>The converted input.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.ConvertToUpperCamelCase(System.String,System.Boolean)"> <summary>Converts the first letter to upper case and dashes to camel case.</summary> <param name="input">The input.</param> <param name="firstCharacterMustBeAlpha">Specifies whether to add an _ when the first character is not alpha.</param> <returns>The converted input.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.ConvertToStringLiteral(System.String)"> <summary>Converts the string to a string literal which can be used in C# or TypeScript code.</summary> <param name="input">The input.</param> <returns>The literal.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.ConvertToCamelCase(System.String)"> <summary>Converts the input to a camel case identifier.</summary> <param name="input">The input.</param> <returns>The converted input. </returns> </member> <member name="M:NJsonSchema.ConversionUtilities.TrimWhiteSpaces(System.String)"> <summary>Trims white spaces from the text.</summary> <param name="text">The text.</param> <returns>The updated text.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.RemoveLineBreaks(System.String)"> <summary>Removes the line breaks from the text.</summary> <param name="text">The text.</param> <returns>The updated text.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.Singularize(System.String)"> <summary>Singularizes the given noun in plural.</summary> <param name="word">The plural noun.</param> <returns>The singular noun.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.Tab(System.String,System.Int32)"> <summary>Add tabs to the given string.</summary> <param name="input">The input.</param> <param name="tabCount">The tab count.</param> <returns>The output.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.Tab(System.String,System.Int32,System.IO.TextWriter)"> <summary>Add tabs to the given string.</summary> <param name="input">The input.</param> <param name="tabCount">The tab count.</param> <param name="writer">Stream to write transformed content into.</param> <returns>The output.</returns> </member> <member name="M:NJsonSchema.ConversionUtilities.ConvertCSharpDocs(System.String,System.Int32)"> <summary>Converts all line breaks in a string into '\n' and removes white spaces.</summary> <param name="input">The input.</param> <param name="tabCount">The tab count.</param> <returns>The output.</returns> </member> <member name="T:NJsonSchema.Converters.JsonExceptionConverter"> <summary>A converter to correctly serialize exception objects.</summary> </member> <member name="M:NJsonSchema.Converters.JsonExceptionConverter.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonExceptionConverter"/> class.</summary> </member> <member name="M:NJsonSchema.Converters.JsonExceptionConverter.#ctor(System.Boolean,System.Collections.Generic.IDictionary{System.String,System.Reflection.Assembly})"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonExceptionConverter" /> class.</summary> <param name="hideStackTrace">If set to <c>true</c> the serializer hides stack trace (i.e. sets the StackTrace to 'HIDDEN').</param> <param name="searchedNamespaces">The namespaces to search for exception types.</param> </member> <member name="P:NJsonSchema.Converters.JsonExceptionConverter.CanWrite"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can write JSON.</summary> </member> <member name="M:NJsonSchema.Converters.JsonExceptionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Writes the JSON representation of the object.</summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="M:NJsonSchema.Converters.JsonExceptionConverter.CanConvert(System.Type)"> <summary>Determines whether this instance can convert the specified object type.</summary> <param name="objectType">Type of the object.</param> <returns><c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.</returns> </member> <member name="M:NJsonSchema.Converters.JsonExceptionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Reads the JSON representation of the object.</summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="T:NJsonSchema.Converters.JsonInheritanceAttribute"> <summary>Defines a child class in the inheritance chain.</summary> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceAttribute.#ctor(System.String,System.Type)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceAttribute"/> class.</summary> <param name="key">The discriminator key.</param> <param name="type">The child class type.</param> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceAttribute.Key"> <summary>Gets the discriminator key.</summary> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceAttribute.Type"> <summary>Gets the child class type.</summary> </member> <member name="T:NJsonSchema.Converters.JsonInheritanceConverter"> <summary>Defines the class as inheritance base class and adds a discriminator property to the serialized object.</summary> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceConverter.DefaultDiscriminatorName"> <summary>Gets the default discriminiator name.</summary> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class.</summary> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor(System.String)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class.</summary> <param name="discriminatorName">The discriminator.</param> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor(System.String,System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class.</summary> <param name="discriminatorName">The discriminator property name.</param> <param name="readTypeProperty">Read the $type property to determine the type (fallback, should not be used as it might lead to security problems).</param> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor(System.Type)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class which only applies for the given base type.</summary> <remarks>Use this constructor for global registered converters (not defined on class).</remarks> <param name="baseType">The base type.</param> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor(System.Type,System.String)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class which only applies for the given base type.</summary> <remarks>Use this constructor for global registered converters (not defined on class).</remarks> <param name="baseType">The base type.</param> <param name="discriminatorName">The discriminator.</param> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.#ctor(System.Type,System.String,System.Boolean)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Converters.JsonInheritanceConverter"/> class which only applies for the given base type.</summary> <remarks>Use this constructor for global registered converters (not defined on class).</remarks> <param name="baseType">The base type.</param> <param name="discriminatorName">The discriminator.</param> <param name="readTypeProperty">Read the $type property to determine the type (fallback, should not be used as it might lead to security problems).</param> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceConverter.DiscriminatorName"> <summary>Gets the discriminator property name.</summary> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Writes the JSON representation of the object.</summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceConverter.CanWrite"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can write JSON.</summary> </member> <member name="P:NJsonSchema.Converters.JsonInheritanceConverter.CanRead"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can read JSON.</summary> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.CanConvert(System.Type)"> <summary>Determines whether this instance can convert the specified object type.</summary> <param name="objectType">Type of the object.</param> <returns><c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.</returns> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Reads the JSON representation of the object.</summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.GetDiscriminatorValue(System.Type)"> <summary>Gets the discriminator value for the given type.</summary> <param name="type">The object type.</param> <returns>The discriminator value.</returns> </member> <member name="M:NJsonSchema.Converters.JsonInheritanceConverter.GetDiscriminatorType(Newtonsoft.Json.Linq.JObject,System.Type,System.String)"> <summary>Gets the type for the given discriminator value.</summary> <param name="jObject">The JSON object.</param> <param name="objectType">The object (base) type.</param> <param name="discriminatorValue">The discriminator value.</param> <returns></returns> </member> <member name="T:NJsonSchema.Converters.JsonReferenceConverter"> <summary>Regenerates reference paths and correctly generates $ref properties.</summary> </member> <member name="P:NJsonSchema.Converters.JsonReferenceConverter.CanWrite"> <summary>Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter" /> can write JSON.</summary> </member> <member name="M:NJsonSchema.Converters.JsonReferenceConverter.CanConvert(System.Type)"> <summary>Determines whether this instance can convert the specified object type.</summary> <param name="objectType">Type of the object.</param> <returns><c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.</returns> </member> <member name="M:NJsonSchema.Converters.JsonReferenceConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Reads the JSON representation of the object.</summary> <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader" /> to read from.</param> <param name="objectType">Type of the object.</param> <param name="existingValue">The existing value of object being read.</param> <param name="serializer">The calling serializer.</param> <returns>The object value.</returns> </member> <member name="M:NJsonSchema.Converters.JsonReferenceConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)"> <summary>Writes the JSON representation of the object.</summary> <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter" /> to write to.</param> <param name="value">The value.</param> <param name="serializer">The calling serializer.</param> </member> <member name="T:NJsonSchema.DefaultTypeNameGenerator"> <summary>Converts the last part of the full type name to upper case.</summary> </member> <member name="P:NJsonSchema.DefaultTypeNameGenerator.ReservedTypeNames"> <summary>Gets or sets the reserved names.</summary> </member> <member name="P:NJsonSchema.DefaultTypeNameGenerator.TypeNameMappings"> <summary>Gets the name mappings.</summary> </member> <member name="M:NJsonSchema.DefaultTypeNameGenerator.Generate(NJsonSchema.JsonSchema,System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary>Generates the type name for the given schema respecting the reserved type names.</summary> <param name="schema">The schema.</param> <param name="typeNameHint">The type name hint.</param> <param name="reservedTypeNames">The reserved type names.</param> <returns>The type name.</returns> </member> <member name="M:NJsonSchema.DefaultTypeNameGenerator.Generate(NJsonSchema.JsonSchema,System.String)"> <summary>Generates the type name for the given schema.</summary> <param name="schema">The schema.</param> <param name="typeNameHint">The type name hint.</param> <returns>The type name.</returns> </member> <member name="M:NJsonSchema.DefaultTypeNameGenerator.RemoveIllegalCharacters(System.String)"> <summary> Replaces all characters that are not normals letters, numbers or underscore, with an underscore. Will prepend an underscore if the first characters is a number. In case there are this would result in multiple underscores in a row, strips down to one underscore. Will trim any underscores at the end of the type name. </summary> </member> <member name="T:NJsonSchema.Generation.DefaultReflectionService"> <summary>The default reflection service implementation.</summary> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.GetDescription(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaGeneratorSettings)"> <summary>Creates a <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/> from a <see cref="T:System.Type"/>. </summary> <param name="contextualType">The type.</param> <param name="settings">The settings.</param> <returns>The <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/>. </returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.GetDescription(Namotion.Reflection.ContextualType,NJsonSchema.Generation.ReferenceTypeNullHandling,NJsonSchema.Generation.JsonSchemaGeneratorSettings)"> <summary>Creates a <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/> from a <see cref="T:System.Type"/>. </summary> <param name="contextualType">The type.</param> <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param> <param name="settings">The settings.</param> <returns>The <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/>. </returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsNullable(Namotion.Reflection.ContextualType,NJsonSchema.Generation.ReferenceTypeNullHandling)"> <summary>Checks whether a type is nullable.</summary> <param name="contextualType">The type.</param> <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param> <returns>true if the type can be null.</returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsStringEnum(Namotion.Reflection.ContextualType,Newtonsoft.Json.JsonSerializerSettings)"> <summary>Checks whether the give type is a string enum.</summary> <param name="contextualType">The type.</param> <param name="serializerSettings">The serializer settings.</param> <returns>The result.</returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsBinary(Namotion.Reflection.ContextualType)"> <summary>Checks whether the given type is a file/binary type.</summary> <param name="contextualType">The type.</param> <returns>true or false.</returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsIAsyncEnumerableType(Namotion.Reflection.ContextualType)"> <summary>Checks whether the given type is an IAsyncEnumerable type.</summary> <remarks> See this issue: https://github.com/RicoSuter/NSwag/issues/2582#issuecomment-576165669 </remarks> <param name="contextualType">The type.</param> <returns>true or false.</returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsArrayType(Namotion.Reflection.ContextualType)"> <summary>Checks whether the given type is an array type.</summary> <param name="contextualType">The type.</param> <returns>true or false.</returns> </member> <member name="M:NJsonSchema.Generation.DefaultReflectionService.IsDictionaryType(Namotion.Reflection.ContextualType)"> <summary>Checks whether the given type is a dictionary type.</summary> <param name="contextualType">The type.</param> <returns>true or false.</returns> </member> <member name="T:NJsonSchema.Generation.DefaultSchemaNameGenerator"> <summary>The default schema name generator implementation.</summary> </member> <member name="M:NJsonSchema.Generation.DefaultSchemaNameGenerator.Generate(System.Type)"> <summary>Generates the name of the JSON Schema.</summary> <param name="type">The type.</param> <returns>The new name.</returns> </member> <member name="T:NJsonSchema.Generation.EnumHandling"> <summary>Defines the enum handling.</summary> </member> <member name="F:NJsonSchema.Generation.EnumHandling.Integer"> <summary>Generates an integer field without enumeration (except when using StringEnumConverter).</summary> </member> <member name="F:NJsonSchema.Generation.EnumHandling.String"> <summary>Generates a string field with JSON Schema enumeration.</summary> </member> <member name="F:NJsonSchema.Generation.EnumHandling.CamelCaseString"> <summary>Generates a camel-cased string field with JSON Schema enumeration.</summary> </member> <member name="T:NJsonSchema.Generation.IReflectionService"> <summary>Provides methods to reflect on types.</summary> </member> <member name="M:NJsonSchema.Generation.IReflectionService.GetDescription(Namotion.Reflection.ContextualType,NJsonSchema.Generation.ReferenceTypeNullHandling,NJsonSchema.Generation.JsonSchemaGeneratorSettings)"> <summary>Creates a <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/> from a <see cref="T:System.Type"/>. </summary> <param name="contextualType">The type.</param> <param name="defaultReferenceTypeNullHandling">The default reference type null handling.</param> <param name="settings">The settings.</param> <returns>The <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/>. </returns> </member> <member name="M:NJsonSchema.Generation.IReflectionService.GetDescription(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaGeneratorSettings)"> <summary>Creates a <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/> from a <see cref="T:System.Type"/>. </summary> <param name="contextualType">The type.</param> <param name="settings">The settings.</param> <returns>The <see cref="T:NJsonSchema.Generation.JsonTypeDescription"/>. </returns> </member> <member name="M:NJsonSchema.Generation.IReflectionService.IsNullable(Namotion.Reflection.ContextualType,NJsonSchema.Generation.ReferenceTypeNullHandling)"> <summary>Checks whether a type is nullable.</summary> <param name="contextualType">The type.</param> <param name="defaultReferenceTypeNullHandling">The default reference type null handling used when no nullability information is available.</param> <returns>true if the type can be null.</returns> </member> <member name="M:NJsonSchema.Generation.IReflectionService.IsStringEnum(Namotion.Reflection.ContextualType,Newtonsoft.Json.JsonSerializerSettings)"> <summary>Checks whether the give type is a string enum.</summary> <param name="contextualType">The type.</param> <param name="serializerSettings">The serializer settings.</param> <returns>The result.</returns> </member> <member name="T:NJsonSchema.Generation.ISchemaNameGenerator"> <summary>The schema name generator.</summary> </member> <member name="M:NJsonSchema.Generation.ISchemaNameGenerator.Generate(System.Type)"> <summary>Generates the name of the JSON Schema for the given type.</summary> <param name="type">The type.</param> <returns>The new name.</returns> </member> <member name="T:NJsonSchema.Generation.ISchemaProcessor"> <summary>The schema processor interface.</summary> </member> <member name="M:NJsonSchema.Generation.ISchemaProcessor.Process(NJsonSchema.Generation.SchemaProcessorContext)"> <summary>Processes the specified JSON Schema.</summary> <param name="context">The schema context.</param> </member> <member name="T:NJsonSchema.Generation.IXmlDocsSettings"> <summary>The XML Docs related settings.</summary> </member> <member name="P:NJsonSchema.Generation.IXmlDocsSettings.UseXmlDocumentation"> <summary>Gets or sets a value indicating whether to read XML Docs (default: true).</summary> </member> <member name="P:NJsonSchema.Generation.IXmlDocsSettings.ResolveExternalXmlDocumentation"> <summary>Gets or sets a value indicating whether tho resolve the XML Docs from the NuGet cache or .NET SDK directory (default: true).</summary> </member> <member name="P:NJsonSchema.Generation.IXmlDocsSettings.XmlDocumentationFormatting"> <summary>Gets or sets the XML Docs formatting (default: None).</summary> </member> <member name="T:NJsonSchema.Generation.JsonSchemaGenerator"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema"/> object for a given type. </summary> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.#ctor(NJsonSchema.Generation.JsonSchemaGeneratorSettings)"> <summary>Initializes a new instance of the <see cref="T:NJsonSchema.Generation.JsonSchemaGenerator"/> class.</summary> <param name="settings">The settings.</param> </member> <member name="P:NJsonSchema.Generation.JsonSchemaGenerator.Settings"> <summary>Gets the settings.</summary> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate(System.Type)"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <param name="type">The type.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate(System.Type,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <param name="type">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate``1(System.Type,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <param name="type">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <param name="contextualType">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate``1(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates a <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <param name="contextualType">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate``1(``0,System.Type,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates into the given <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <typeparam name="TSchemaType">The type of the schema.</typeparam> <param name="schema">The schema.</param> <param name="type">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.Generate``1(``0,Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaResolver)"> <summary>Generates into the given <see cref="T:NJsonSchema.JsonSchema" /> object for the given type and adds the mapping to the given resolver.</summary> <typeparam name="TSchemaType">The type of the schema.</typeparam> <param name="schema">The schema.</param> <param name="contextualType">The type.</param> <param name="schemaResolver">The schema resolver.</param> <returns>The schema.</returns> <exception cref="T:System.InvalidOperationException">Could not find value type of dictionary type.</exception> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.GenerateWithReference``1(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaResolver,System.Action{``0,NJsonSchema.JsonSchema})"> <summary>Generetes a schema directly or referenced for the requested schema type; does NOT change nullability.</summary> <typeparam name="TSchemaType">The resulted schema type which may reference the actual schema.</typeparam> <param name="contextualType">The type of the schema to generate.</param> <param name="schemaResolver">The schema resolver.</param> <param name="transformation">An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).</param> <returns>The requested schema object.</returns> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.GenerateWithReferenceAndNullability``1(Namotion.Reflection.ContextualType,NJsonSchema.Generation.JsonSchemaResolver,System.Action{``0,NJsonSchema.JsonSchema})"> <summary>Generetes a schema directly or referenced for the requested schema type; also adds nullability if required by looking at the type's <see cref="T:NJsonSchema.Generation.JsonTypeDescription" />.</summary> <typeparam name="TSchemaType">The resulted schema type which may reference the actual schema.</typeparam> <param name="contextualType">The type of the schema to generate.</param> <param name="schemaResolver">The schema resolver.</param> <param name="transformation">An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).</param> <returns>The requested schema object.</returns> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.GenerateWithReferenceAndNullability``1(Namotion.Reflection.ContextualType,System.Boolean,NJsonSchema.Generation.JsonSchemaResolver,System.Action{``0,NJsonSchema.JsonSchema})"> <summary>Generetes a schema directly or referenced for the requested schema type; also adds nullability if required.</summary> <typeparam name="TSchemaType">The resulted schema type which may reference the actual schema.</typeparam> <param name="contextualType">The type of the schema to generate.</param> <param name="isNullable">Specifies whether the property, parameter or requested schema type is nullable.</param> <param name="schemaResolver">The schema resolver.</param> <param name="transformation">An action to transform the resulting schema (e.g. property or parameter) before the type of reference is determined (with $ref or allOf/oneOf).</param> <returns>The requested schema object.</returns> </member> <member name="M:NJsonSchema.Generation.JsonSchemaGenerator.GetPropertyName(Newtonsoft.Json.Serialization.JsonProperty,Namotion.Reflection.ContextualAccessorInfo)"> <summary>Gets the converted property name.</summary>