Bin
de-DE
ShipRush.Language.resources.DLL.zip
es-MX
ShipRush.Language.resources.DLL.zip
fr-CA
ShipRush.Language.resources.DLL.zip
ru-RU
ShipRush.Language.resources.DLL.zip
Example Labels
Common.Logging.Core
<?xml version="1.0"?>
-<doc>
-<assembly>
<name>Common.Logging.Core</name>
</assembly>
-<members>
-<member name="T:AssemblyDoc">
-<summary>
This assembly contains the core functionality of the Common.Logging framework.In particular, checkout
<see cref="T:Common.Logging.LogManager"/>
and
<see cref="T:Common.Logging.ILog"/>
for usage information.
</summary>
</member>
-<member name="T:CoverageExcludeAttribute">
<summary>Indicates classes or members to be ignored by NCover </summary>
<remarks>Note, the key is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage" </remarks>
<author>Erich Eichinger</author>
</member>
-<member name="T:Common.Logging.Configuration.NameValueCollection">
<summary>Substitute NameValueCollection in System.Collections.Specialized. </summary>
</member>
-<member name="M:Common.Logging.Configuration.NameValueCollection.#ctor">
-<summary>
Creates a new instance of
<seealso cref="T:Common.Logging.Configuration.NameValueCollection">NameValueCollection</seealso>
.
</summary>
</member>
-<member name="M:Common.Logging.Configuration.NameValueCollection.GetValues(System.String)">
<summary>Gets the values (only a single one) for the specified key (configuration name) </summary>
<param key="key">The key.</param>
<returns>an array with one value, or null if no value exist</returns>
</member>
-<member name="P:Common.Logging.Configuration.NameValueCollection.Item(System.String)">
<summary>Gets or sets the value with the specified key. </summary>
<value>The value corrsponding to the key, or null if no value exist </value>
<param key="key">The key.</param>
<returns>value store for the key</returns>
</member>
-<member name="T:Common.Logging.Factory.AbstractLogger">
<summary>Provides base implementation suitable for almost all logger adapters </summary>
<author>Erich Eichinger</author>
</member>
-<member name="T:Common.Logging.ILog">
<summary>A simple logging interface abstracting logging APIs. </summary>
-<remarks>
-<para>
Implementations should defer calling a message's
<see cref="M:System.Object.ToString"/>
until the message really needsto be logged to avoid performance penalties.
</para>
-<para>
Each
<see cref="T:Common.Logging.ILog"/>
log method offers to pass in a
<see cref="T:System.Action`1"/>
instead of the actual message.Using this style has the advantage to defer possibly expensive message argument evaluation and formatting (and formatting arguments!) until the message getsactually logged. If the message is not logged at all (e.g. due to
<see cref="T:Common.Logging.LogLevel"/>
settings),you won't have to pay the peformance penalty of creating the message.
</para>
</remarks>
-<example>
The example below demonstrates using callback style for creating the message, where the call to the
<see cref="M:System.Random.NextDouble"/>
and the underlying
<see cref="M:System.String.Format(System.String,System.Object[])"/>
only happens, if level
<see cref="F:Common.Logging.LogLevel.Debug"/>
is enabled:
<code>Log.Debug( m=>m("result is {0}", random.NextDouble()) );Log.Debug(delegate(m) { m("result is {0}", random.NextDouble()); }); </code>
</example>
<seealso cref="T:System.Action`1"/>
<author>Mark Pollack</author>
<author>Bruno Baia</author>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.TraceFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.TraceFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.TraceFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.TraceFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.DebugFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.DebugFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.DebugFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.ILog.Info(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Info(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.InfoFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.InfoFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.InfoFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Info(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Info(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.WarnFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.WarnFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.WarnFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.ILog.Error(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Error(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.ErrorFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.ErrorFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.ErrorFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Error(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Error(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.FatalFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.FatalFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.FatalFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.ILog.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="P:Common.Logging.ILog.IsTraceEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
</member>
-<member name="P:Common.Logging.ILog.IsDebugEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
</member>
-<member name="P:Common.Logging.ILog.IsErrorEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
</member>
-<member name="P:Common.Logging.ILog.IsFatalEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
</member>
-<member name="P:Common.Logging.ILog.IsInfoEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
</member>
-<member name="P:Common.Logging.ILog.IsWarnEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
</member>
-<member name="F:Common.Logging.Factory.AbstractLogger.Write">
<summary>Holds the method for writing a message to the log system. </summary>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.#ctor">
-<summary>
Creates a new logger instance using
<see cref="M:Common.Logging.Factory.AbstractLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)"/>
forwriting log events to the underlying log system.
</summary>
<seealso cref="M:Common.Logging.Factory.AbstractLogger.GetWriteHandler"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.GetWriteHandler">
-<summary>
Override this method to use a different method than
<see cref="M:Common.Logging.Factory.AbstractLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)"/>
for writing log events to the underlying log system.
</summary>
-<remarks>
Usually you don't need to override thise method. The default implementation returns
<c>null</c>
to indicate that the default handler
<see cref="M:Common.Logging.Factory.AbstractLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)"/>
should beused.
</remarks>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
<summary>Actually sends the message to the underlying log system. </summary>
<param key="level">the level of this log event.</param>
<param key="message">the message to log</param>
<param key="exception">the exception to log (may be null)</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level includingthe stack trace of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.TraceFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.TraceFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.TraceFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.TraceFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level includingthe stack Debug of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.DebugFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.DebugFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.DebugFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level includingthe stack Info of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.InfoFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.InfoFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.InfoFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Info"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level includingthe stack Warn of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Warnrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.WarnFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Warnrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.WarnFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.WarnFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level includingthe stack Error of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Errorrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.ErrorFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Errorrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.ErrorFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.ErrorFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Error"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.Object)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
<param key="message">The message object to log.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.Object,System.Exception)">
-<summary>
Log a message object with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level includingthe stack Fatal of the
<see cref="T:System.Exception"/>
passedas a parameter.
</summary>
<param key="message">The message object to log.</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Fatalrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FatalFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Fatalrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FatalFormat(System.String,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FatalFormat(System.String,System.Exception,System.Object[])">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of format arguments</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
-<summary>
Log a message with the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level using a callback to obtain the message
</summary>
<remarks>Using this method avoids the cost of creating a message and evaluating message argumentsthat probably won't be logged due to loglevel settings. </remarks>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsTraceEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Trace"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsDebugEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Debug"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsInfoEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Info"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsWarnEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Warn"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsErrorEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Error"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="P:Common.Logging.Factory.AbstractLogger.IsFatalEnabled">
-<summary>
Checks if this logger is enabled for the
<see cref="F:Common.Logging.LogLevel.Fatal"/>
level.
</summary>
<remarks>Override this in your derived class to comply with the underlying logging system </remarks>
</member>
-<member name="T:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage">
<summary>Format message on demand. </summary>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage.#ctor(System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage"/>
class.
</summary>
<param key="formatMessageCallback">The format message callback.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage.#ctor(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage"/>
class.
</summary>
<param key="formatProvider">The format provider.</param>
<param key="formatMessageCallback">The format message callback.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage.ToString">
-<summary>
Calls
<see cref="F:Common.Logging.Factory.AbstractLogger.FormatMessageCallbackFormattedMessage.formatMessageCallback"/>
and returns result.
</summary>
<returns/>
</member>
-<member name="T:Common.Logging.Factory.AbstractLogger.StringFormatFormattedMessage">
<summary>Format string on demand. </summary>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.StringFormatFormattedMessage.#ctor(System.IFormatProvider,System.String,System.Object[])">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Factory.AbstractLogger.StringFormatFormattedMessage"/>
class.
</summary>
<param key="formatProvider">The format provider.</param>
<param key="message">The message.</param>
<param key="args">The args.</param>
</member>
-<member name="M:Common.Logging.Factory.AbstractLogger.StringFormatFormattedMessage.ToString">
-<summary>
Runs
<see cref="M:System.String.Format(System.IFormatProvider,System.String,System.Object[])"/>
on supplied arguemnts.
</summary>
<returns>string</returns>
</member>
-<member name="T:Common.Logging.Factory.AbstractLogger.WriteHandler">
<summary>Represents a method responsible for writing a message to the log system. </summary>
</member>
-<member name="T:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter">
-<summary>
An implementation of
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
that caches loggers handed out by this factory.
</summary>
-<remarks>
Implementors just need to override
<see cref="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.CreateLogger(System.String)"/>
.
</remarks>
<author>Erich Eichinger</author>
</member>
-<member name="T:Common.Logging.ILoggerFactoryAdapter">
<summary>LoggerFactoryAdapter interface is used internally by LogManagerOnly developers wishing to write new Common.Logging adapters need toworry about this interface. </summary>
<author>Gilles Bayon</author>
</member>
-<member name="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)">
<summary>Get a ILog instance by type. </summary>
<param key="type">The type to use for the logger</param>
<returns/>
</member>
-<member name="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.String)">
<summary>Get a ILog instance by key. </summary>
<param key="key">The key of the logger</param>
<returns/>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.#ctor">
<summary>Creates a new instance, the logger cache being case-sensitive. </summary>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.#ctor(System.Boolean)">
-<summary>
Creates a new instance, the logger cache being
<paramref key="caseSensitiveLoggerCache"/>
.
</summary>
<param key="caseSensitiveLoggerCache"/>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.ClearLoggerCache">
<summary>Purges all loggers from cache </summary>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.CreateLogger(System.String)">
<summary>Create the specified named logger instance </summary>
<remarks>Derived factories need to implement this method to create theactual logger instance. </remarks>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.GetLogger(System.Type)">
-<summary>
Get a ILog instance by
<see cref="T:System.Type"/>
.
</summary>
-<param key="type">
Usually the
<see cref="T:System.Type"/>
of the current class.
</param>
-<returns>
An ILog instance either obtained from the internal cache or created by a call to
<see cref="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.CreateLogger(System.String)"/>
.
</returns>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.GetLogger(System.String)">
<summary>Get a ILog instance by key. </summary>
-<param key="key">
Usually a
<see cref="T:System.Type"/>
's Name or FullName property.
</param>
-<returns>
An ILog instance either obtained from the internal cache or created by a call to
<see cref="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.CreateLogger(System.String)"/>
.
</returns>
</member>
-<member name="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.GetLoggerInternal(System.String)">
<summary>Get or create a ILog instance by key. </summary>
-<param key="key">
Usually a
<see cref="T:System.Type"/>
's Name or FullName property.
</param>
-<returns>
An ILog instance either obtained from the internal cache or created by a call to
<see cref="M:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter.CreateLogger(System.String)"/>
.
</returns>
</member>
-<member name="T:Common.Logging.Simple.CapturingLogger">
-<summary>
A logger created by
<see cref="T:Common.Logging.Simple.CapturingLoggerFactoryAdapter"/>
thatsends all log events to the owning adapter's
<see cref="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.AddEvent(Common.Logging.Simple.CapturingLoggerEvent)"/>
</summary>
<author>Erich Eichinger</author>
</member>
-<member name="T:Common.Logging.Simple.AbstractSimpleLogger">
<summary>Abstract class providing a standard implementation of simple loggers. </summary>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLogger.#ctor(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
<summary>Creates and initializes a the simple logger. </summary>
<param key="logName">The key, usually type key of the calling class, of the logger.</param>
<param key="logLevel">The current logging threshold. Messages recieved that are beneath this threshold will not be logged.</param>
<param key="showlevel">Include level in the log message.</param>
<param key="showDateTime">Include the current time in the log message.</param>
<param key="showLogName">Include the instance key in the log message.</param>
<param key="dateTimeFormat">The date and time format to use in the log message.</param>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLogger.FormatOutput(System.Text.StringBuilder,Common.Logging.LogLevel,System.Object,System.Exception)">
-<summary>
Appends the formatted message to the specified
<see cref="T:System.Text.StringBuilder"/>
.
</summary>
-<param key="stringBuilder">
the
<see cref="T:System.Text.StringBuilder"/>
that receíves the formatted message.
</param>
<param key="level"/>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLogger.IsLevelEnabled(Common.Logging.LogLevel)">
<summary>Determines if the given log level is currently enabled. </summary>
<param key="level"/>
<returns/>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.Name">
<summary>The key of the logger. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.ShowLevel">
<summary>Include the current log level in the log message. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.ShowDateTime">
<summary>Include the current time in the log message. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.ShowLogName">
<summary>Include the instance key in the log message. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.CurrentLogLevel">
<summary>The current logging threshold. Messages recieved that are beneath this threshold will not be logged. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.DateTimeFormat">
<summary>The date and time format to use in the log message. </summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.HasDateTimeFormat">
-<summary>
Determines Whether
<see cref="P:Common.Logging.Simple.AbstractSimpleLogger.DateTimeFormat"/>
is set.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsTraceEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Trace"/>
. If it is, all messages will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsDebugEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Debug"/>
. If it is, all messages will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsInfoEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Info"/>
. If it is, only messages with a
<see cref="T:Common.Logging.LogLevel"/>
of
<see cref="F:Common.Logging.LogLevel.Info"/>
,
<see cref="F:Common.Logging.LogLevel.Warn"/>
,
<see cref="F:Common.Logging.LogLevel.Error"/>
, and
<see cref="F:Common.Logging.LogLevel.Fatal"/>
will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsWarnEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Warn"/>
. If it is, only messages with a
<see cref="T:Common.Logging.LogLevel"/>
of
<see cref="F:Common.Logging.LogLevel.Warn"/>
,
<see cref="F:Common.Logging.LogLevel.Error"/>
, and
<see cref="F:Common.Logging.LogLevel.Fatal"/>
will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsErrorEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Error"/>
. If it is, only messages with a
<see cref="T:Common.Logging.LogLevel"/>
of
<see cref="F:Common.Logging.LogLevel.Error"/>
and
<see cref="F:Common.Logging.LogLevel.Fatal"/>
will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLogger.IsFatalEnabled">
-<summary>
Returns
<see langword="true"/>
if the current
<see cref="T:Common.Logging.LogLevel"/>
is greater than orequal to
<see cref="F:Common.Logging.LogLevel.Fatal"/>
. If it is, only messages with a
<see cref="T:Common.Logging.LogLevel"/>
of
<see cref="F:Common.Logging.LogLevel.Fatal"/>
will be sent to
<see cref="!:Console.Out"/>
.
</summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLogger.Owner">
<summary>The adapter that created this logger instance. </summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLogger.Clear">
<summary>Clears all captured events </summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLogger.ClearLastEvent">
-<summary>
Resets the
<see cref="P:Common.Logging.Simple.CapturingLogger.LastEvent"/>
to
<c>null</c>
.
</summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLogger.LoggerEvents">
<summary>Holds the list of logged events. </summary>
<remarks>To access this collection in a multithreaded application, put a lock on the list instance. </remarks>
</member>
-<member name="M:Common.Logging.Simple.CapturingLogger.AddEvent(Common.Logging.Simple.CapturingLoggerEvent)">
-<summary>
<see cref="T:Common.Logging.Simple.CapturingLogger"/>
instances send their captured log events to this method.
</summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLogger.#ctor(Common.Logging.Simple.CapturingLoggerFactoryAdapter,System.String)">
<summary>Create a new logger instance. </summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
-<summary>
Create a new
<see cref="T:Common.Logging.Simple.CapturingLoggerEvent"/>
and send it to
<see cref="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.AddEvent(Common.Logging.Simple.CapturingLoggerEvent)"/>
</summary>
<param key="level"/>
<param key="message"/>
<param key="exception"/>
</member>
-<member name="P:Common.Logging.Simple.CapturingLogger.LastEvent">
<summary>Holds the last log event received from any of this adapter's loggers. </summary>
</member>
-<member name="T:Common.Logging.Simple.CapturingLoggerEvent">
-<summary>
A logging event captured by
<see cref="T:Common.Logging.Simple.CapturingLogger"/>
</summary>
<author>Erich Eichinger</author>
</member>
-<member name="F:Common.Logging.Simple.CapturingLoggerEvent.Source">
<summary>The logger that logged this event </summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLoggerEvent.Level">
<summary>The level used to log this event </summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLoggerEvent.MessageObject">
<summary>The raw message object </summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLoggerEvent.Exception">
<summary>A logged exception </summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerEvent.#ctor(Common.Logging.Simple.CapturingLogger,Common.Logging.LogLevel,System.Object,System.Exception)">
<summary>Create a new event instance </summary>
</member>
-<member name="P:Common.Logging.Simple.CapturingLoggerEvent.RenderedMessage">
<summary>Retrieves the formatted message text </summary>
</member>
-<member name="T:Common.Logging.Simple.CapturingLoggerFactoryAdapter">
-<summary>
An adapter, who's loggers capture all log events and send them to
<see cref="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.AddEvent(Common.Logging.Simple.CapturingLoggerEvent)"/>
.Retrieve the list of log events from
<see cref="F:Common.Logging.Simple.CapturingLoggerFactoryAdapter.LoggerEvents"/>
.
</summary>
-<remarks>
This logger factory is mainly for debugging and test purposes.
-<example>
This is an example how you might use this adapter for testing:
<code>// configure for capturingCapturingLoggerFactoryAdapter adapter = new CapturingLoggerFactoryAdapter();LogManager.Adapter = adapter;// reset capture stateadapter.Clear();// log somethingILog log = LogManager.GetCurrentClassLogger();log.DebugFormat("Current Time:{0}", DateTime.Now);// check logged dataAssert.AreEqual(1, adapter.LoggerEvents.Count);Assert.AreEqual(LogLevel.Debug, adapter.LastEvent.Level); </code>
</example>
</remarks>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.Clear">
<summary>Clears all captured events </summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.ClearLastEvent">
-<summary>
Resets the
<see cref="P:Common.Logging.Simple.CapturingLoggerFactoryAdapter.LastEvent"/>
to
<c>null</c>
.
</summary>
</member>
-<member name="F:Common.Logging.Simple.CapturingLoggerFactoryAdapter.LoggerEvents">
<summary>Holds the list of logged events. </summary>
<remarks>To access this collection in a multithreaded application, put a lock on the list instance. </remarks>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.AddEvent(Common.Logging.Simple.CapturingLoggerEvent)">
-<summary>
<see cref="T:Common.Logging.Simple.CapturingLogger"/>
instances send their captured log events to this method.
</summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.GetLogger(System.Type)">
-<summary>
Get a
<see cref="T:Common.Logging.Simple.CapturingLogger"/>
instance for the given type.
</summary>
</member>
-<member name="M:Common.Logging.Simple.CapturingLoggerFactoryAdapter.GetLogger(System.String)">
-<summary>
Get a
<see cref="T:Common.Logging.Simple.CapturingLogger"/>
instance for the given key.
</summary>
</member>
-<member name="P:Common.Logging.Simple.CapturingLoggerFactoryAdapter.LastEvent">
<summary>Holds the last log event received from any of this adapter's loggers. </summary>
</member>
-<member name="T:Common.Logging.ConfigurationException">
<summary>The exception that is thrown when a configuration system error has occurred with Common.Logging </summary>
<author>Mark Pollack</author>
</member>
-<member name="M:Common.Logging.ConfigurationException.#ctor">
<summary>Creates a new instance of the ObjectsException class.</summary>
</member>
-<member name="M:Common.Logging.ConfigurationException.#ctor(System.String)">
<summary>Creates a new instance of the ConfigurationException class. with the specified message. </summary>
<param key="message">A message about the exception. </param>
</member>
-<member name="M:Common.Logging.ConfigurationException.#ctor(System.String,System.Exception)">
<summary>Creates a new instance of the ConfigurationException class with the specified messageand root cause. </summary>
<param key="message">A message about the exception. </param>
<param key="rootCause">The root exception that is being wrapped. </param>
</member>
-<member name="T:Common.Logging.Configuration.DefaultConfigurationReader">
-<summary>
Implementation of
<see cref="T:Common.Logging.IConfigurationReader"/>
that uses the standard .NETconfiguration APIs, ConfigurationSettings in 1.x and ConfigurationManager in 2.0
</summary>
<author>Mark Pollack</author>
</member>
-<member name="T:Common.Logging.IConfigurationReader">
<summary>Interface for basic operations to read .NET application configuration information. </summary>
<remarks>Provides a simple abstraction to handle BCL API differences between .NET 1.x and 2.0. Alsouseful for testing scenarios.</remarks>
<author>Mark Pollack</author>
</member>
-<member name="M:Common.Logging.IConfigurationReader.GetSection(System.String)">
<summary>Parses the configuration section and returns the resulting object. </summary>
-<remarks>
<p>Primary purpose of this method is to allow us to parse andload configuration sections using the same API regardlessof the .NET framework version. </p>
See also
<c>System.Configuration.ConfigurationManager</c>
</remarks>
<param key="sectionName">Name of the configuration section.</param>
-<returns>
Object created by a corresponding
<see cref="!:IConfigurationSectionHandler"/>
.
</returns>
</member>
-<member name="M:Common.Logging.Configuration.DefaultConfigurationReader.GetSection(System.String)">
-<summary>
Parses the configuration section and returns the resulting object.Using the
<c>System.Configuration.ConfigurationManager</c>
</summary>
<param key="sectionName">Name of the configuration section.</param>
-<returns>
Object created by a corresponding
<c>IConfigurationSectionHandler"</c>
</returns>
-<remarks>
<p>Primary purpose of this method is to allow us to parse andload configuration sections using the same API regardlessof the .NET framework version. </p>
</remarks>
</member>
-<member name="T:Common.Logging.Factory.NamespaceDoc">
-<summary>
This namespace contains convenience base classes for implementing your own
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
s.
</summary>
</member>
-<member name="T:Common.Logging.Configuration.ArgUtils">
<summary>Various utility methods for using during factory and logger instance configuration </summary>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.#cctor">
<summary>Initialize all members before any of this class' methods can be accessed (avoids beforeFieldInit) </summary>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.RegisterTypeParser``1(Common.Logging.Configuration.ArgUtils.ParseHandler{``0})">
<summary>Adds the parser to the list of known type parsers. </summary>
<remarks>.NET intrinsic types are pre-registerd: short, int, long, float, double, decimal, bool </remarks>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.GetValue(Common.Logging.Configuration.NameValueCollection,System.String)">
-<summary>
Retrieves the named value from the specified
<see cref="T:Common.Logging.Configuration.NameValueCollection"/>
.
</summary>
<param key="values">may be null</param>
<param key="key">the value's key</param>
-<returns>
if
<paramref key="values"/>
is not null, the value returned by values[key].
<c>null</c>
otherwise.
</returns>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.GetValue(Common.Logging.Configuration.NameValueCollection,System.String,System.String)">
-<summary>
Retrieves the named value from the specified
<see cref="T:Common.Logging.Configuration.NameValueCollection"/>
.
</summary>
<param key="values">may be null</param>
<param key="key">the value's key</param>
<param key="defaultValue">the default value, if not found</param>
-<returns>
if
<paramref key="values"/>
is not null, the value returned by values[key].
<c>null</c>
otherwise.
</returns>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.Coalesce(System.String[])">
<summary>Returns the first nonnull, nonempty value among its arguments. </summary>
-<remarks>
Returns
<c>null</c>
, if the initial list was null or empty.
</remarks>
<seealso cref="M:Common.Logging.Configuration.ArgUtils.Coalesce``1(System.Predicate{``0},``0[])"/>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.Coalesce``1(System.Predicate{``0},``0[])">
<summary>Returns the first nonnull, nonempty value among its arguments. </summary>
<remarks>Also </remarks>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.TryParseEnum``1(``0,System.String)">
-<summary>
Tries parsing
<paramref key="stringValue"/>
into an enum of the type of
<paramref key="defaultValue"/>
.
</summary>
<param key="defaultValue">the default value to return if parsing fails</param>
<param key="stringValue">the string value to parse</param>
-<returns>
the successfully parsed value,
<paramref key="defaultValue"/>
otherwise.
</returns>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.TryParse``1(``0,System.String)">
-<summary>
Tries parsing
<paramref key="stringValue"/>
into the specified return type.
</summary>
<param key="defaultValue">the default value to return if parsing fails</param>
<param key="stringValue">the string value to parse</param>
-<returns>
the successfully parsed value,
<paramref key="defaultValue"/>
otherwise.
</returns>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.AssertNotNull``1(System.String,``0)">
-<summary>
Throws a
<see cref="T:System.ArgumentNullException"/>
if
<paramref key="val"/>
is
<c>null</c>
.
</summary>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.AssertNotNull``1(System.String,``0,System.String,System.Object[])">
-<summary>
Throws a
<see cref="T:System.ArgumentNullException"/>
if
<paramref key="val"/>
is
<c>null</c>
.
</summary>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.AssertIsAssignable``1(System.String,System.Type)">
-<summary>
Throws a
<see cref="T:System.ArgumentOutOfRangeException"/>
if an object of type
<paramref key="valType"/>
is notassignable to type
<typeparam key="T"/>
.
</summary>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.AssertIsAssignable``1(System.String,System.Type,System.String,System.Object[])">
-<summary>
Throws a
<see cref="T:System.ArgumentOutOfRangeException"/>
if an object of type
<paramref key="valType"/>
is notassignable to type
<typeparam key="T"/>
.
</summary>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.Guard(Common.Logging.Configuration.ArgUtils.Action,System.String,System.Object[])">
-<summary>
Ensures any exception thrown by the given
<paramref key="action"/>
is wrapped with an
<see cref="T:Common.Logging.ConfigurationException"/>
.
</summary>
-<remarks>
If
<paramref key="action"/>
already throws a ConfigurationException, it will not be wrapped.
</remarks>
<param key="action">the action to execute</param>
-<param key="messageFormat">
the message to be set on the thrown
<see cref="T:Common.Logging.ConfigurationException"/>
</param>
-<param key="args">
args to be passed to
<see cref="M:System.String.Format(System.String,System.Object[])"/>
to format the message
</param>
</member>
-<member name="M:Common.Logging.Configuration.ArgUtils.Guard``1(Common.Logging.Configuration.ArgUtils.Function{``0},System.String,System.Object[])">
-<summary>
Ensures any exception thrown by the given
<paramref key="function"/>
is wrapped with an
<see cref="T:Common.Logging.ConfigurationException"/>
.
</summary>
-<remarks>
If
<paramref key="function"/>
already throws a ConfigurationException, it will not be wrapped.
</remarks>
<param key="function">the action to execute</param>
-<param key="messageFormat">
the message to be set on the thrown
<see cref="T:Common.Logging.ConfigurationException"/>
</param>
-<param key="args">
args to be passed to
<see cref="M:System.String.Format(System.String,System.Object[])"/>
to format the message
</param>
</member>
-<member name="T:Common.Logging.Configuration.ArgUtils.ParseHandler`1">
<summary>A delegate converting a string representation into the target type </summary>
</member>
-<member name="T:Common.Logging.Configuration.ArgUtils.Action">
<summary>An anonymous action delegate with no arguments and no return value. </summary>
<seealso cref="M:Common.Logging.Configuration.ArgUtils.Guard(Common.Logging.Configuration.ArgUtils.Action,System.String,System.Object[])"/>
</member>
-<member name="T:Common.Logging.Configuration.ArgUtils.Function`1">
<summary>An anonymous action delegate with no arguments and no return value. </summary>
<seealso cref="M:Common.Logging.Configuration.ArgUtils.Guard``1(Common.Logging.Configuration.ArgUtils.Function{``0},System.String,System.Object[])"/>
</member>
-<member name="T:Common.Logging.FormatMessageHandler">
-<summary>
The type of method that is passed into e.g.
<see cref="M:Common.Logging.ILog.Debug(System.Action{Common.Logging.FormatMessageHandler})"/>
and allows the callback method to "submit" it's message to the underlying output system.
</summary>
-<param key="format">
the format argument as in
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
-<param key="args">
the argument list as in
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<seealso cref="T:Common.Logging.ILog"/>
<author>Erich Eichinger</author>
</member>
-<member name="T:Common.Logging.LogLevel">
<summary>The 7 possible logging levels </summary>
<author>Gilles Bayon</author>
</member>
-<member name="F:Common.Logging.LogLevel.All">
<summary>All logging levels </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Trace">
<summary>A trace logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Debug">
<summary>A debug logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Info">
<summary>A info logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Warn">
<summary>A warn logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Error">
<summary>An error logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Fatal">
<summary>A fatal logging level </summary>
</member>
-<member name="F:Common.Logging.LogLevel.Off">
<summary>Do not log anything. </summary>
</member>
-<member name="T:Common.Logging.LogManager">
-<summary>
Use the LogManager's
<see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
or
<see cref="M:Common.Logging.LogManager.GetLogger(System.Type)"/>
methods to obtain
<see cref="T:Common.Logging.ILog"/>
instances for logging.
</summary>
-<remarks>
For configuring the underlying log system using application configuration, see the exampleat
<c>System.Configuration.ConfigurationManager</c>
For configuring programmatically, see the example section below.
</remarks>
-<example>
The example below shows the typical use of LogManager to obtain a reference to a loggerand log an exception:
<code>ILog log = LogManager.GetLogger(this.GetType());...try{/* .... */}catch(Exception ex){log.ErrorFormat("Hi {0}", ex, "dude");} </code>
The example below shows programmatic configuration of the underlying log system:
<code>// create propertiesNameValueCollection properties = new NameValueCollection();properties["showDateTime"] = "true";// set AdapterCommon.Logging.LogManager.Adapter = newCommon.Logging.Simple.ConsoleOutLoggerFactoryAdapter(properties); </code>
</example>
<seealso cref="T:Common.Logging.ILog"/>
<seealso cref="P:Common.Logging.LogManager.Adapter"/>
<seealso cref="T:Common.Logging.ILoggerFactoryAdapter"/>
<author>Gilles Bayon</author>
</member>
-<member name="F:Common.Logging.LogManager.COMMON_LOGGING_SECTION">
<summary>The key of the default configuration section to read settings from. </summary>
-<remarks>
You can always change the source of your configuration settings by setting another
<see cref="T:Common.Logging.IConfigurationReader"/>
instanceon
<see cref="P:Common.Logging.LogManager.ConfigurationReader"/>
.
</remarks>
</member>
-<member name="M:Common.Logging.LogManager.#cctor">
-<summary>
Performs static 1-time init of LogManager by calling
<see cref="M:Common.Logging.LogManager.Reset"/>
</summary>
</member>
-<member name="M:Common.Logging.LogManager.Reset">
-<summary>
Reset the
<see cref="N:Common.Logging"/>
infrastructure to its default settings. This means, that configuration settingswill be re-read from section
<c><common/logging></c>
of your
<c>app.config</c>
.
</summary>
-<remarks>
This is mainly used for unit testing, you wouldn't normally use this in your applications.
<br/>
<b>Note:</b>
<see cref="T:Common.Logging.ILog"/>
instances already handed out from this LogManager are not(!) affected.Resetting LogManager only affects new instances being handed out.
</remarks>
</member>
-<member name="M:Common.Logging.LogManager.Reset(Common.Logging.IConfigurationReader)">
-<summary>
Reset the
<see cref="N:Common.Logging"/>
infrastructure to its default settings. This means, that configuration settingswill be re-read from section
<c><common/logging></c>
of your
<c>app.config</c>
.
</summary>
-<remarks>
This is mainly used for unit testing, you wouldn't normally use this in your applications.
<br/>
<b>Note:</b>
<see cref="T:Common.Logging.ILog"/>
instances already handed out from this LogManager are not(!) affected.Resetting LogManager only affects new instances being handed out.
</remarks>
-<param key="reader">
the
<see cref="T:Common.Logging.IConfigurationReader"/>
instance to obtain settings forre-initializing the LogManager.
</param>
</member>
-<member name="M:Common.Logging.LogManager.GetCurrentClassLogger">
-<summary>
Gets the logger by calling
<see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
on the currently configured
<see cref="P:Common.Logging.LogManager.Adapter"/>
using the type of the calling class.
</summary>
-<remarks>
This method needs to inspect the
<see cref="!:StackTrace"/>
in order to determine the callingclass. This of course comes with a performance penalty, thus you shouldn't call it toooften in your application.
</remarks>
<seealso cref="M:Common.Logging.LogManager.GetLogger(System.Type)"/>
-<returns>
the logger instance obtained from the current
<see cref="P:Common.Logging.LogManager.Adapter"/>
</returns>
</member>
-<member name="F:Common.Logging.LogManager._getCallingMethod">
<summary>Cache the function returned from CreateGetClassNameFunction </summary>
</member>
-<member name="M:Common.Logging.LogManager.CreateGetClassNameFunction">
<summary>Creates a function which creates a new StackFrame and get the Method 3 (2 from the callee's perspective)steps up in the callstack </summary>
<returns>A function, returning the calling the Method invoking the function</returns>
<exception cref="T:System.PlatformNotSupportedException">System.Diagnostics.StackFrame does not exist on the platform (ex. windows phone)orStackFrame(int skipFrames) constructor not presentorStackFrame.GetMethod() not present </exception>
</member>
-<member name="M:Common.Logging.LogManager.GetLogger``1">
-<summary>
Gets the logger by calling
<see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
on the currently configured
<see cref="P:Common.Logging.LogManager.Adapter"/>
using the specified type.
</summary>
-<returns>
the logger instance obtained from the current
<see cref="P:Common.Logging.LogManager.Adapter"/>
</returns>
</member>
-<member name="M:Common.Logging.LogManager.GetLogger(System.Type)">
-<summary>
Gets the logger by calling
<see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.Type)"/>
on the currently configured
<see cref="P:Common.Logging.LogManager.Adapter"/>
using the specified type.
</summary>
<param key="type">The type.</param>
-<returns>
the logger instance obtained from the current
<see cref="P:Common.Logging.LogManager.Adapter"/>
</returns>
</member>
-<member name="M:Common.Logging.LogManager.GetLogger(System.String)">
-<summary>
Gets the logger by calling
<see cref="M:Common.Logging.ILoggerFactoryAdapter.GetLogger(System.String)"/>
on the currently configured
<see cref="P:Common.Logging.LogManager.Adapter"/>
using the specified key.
</summary>
<param key="key">The key.</param>
-<returns>
the logger instance obtained from the current
<see cref="P:Common.Logging.LogManager.Adapter"/>
</returns>
</member>
-<member name="M:Common.Logging.LogManager.BuildLoggerFactoryAdapter">
<summary>Builds the logger factory adapter. </summary>
-<returns>
a factory adapter instance. Is never
<c>null</c>
.
</returns>
</member>
-<member name="M:Common.Logging.LogManager.BuildLoggerFactoryAdapterFromLogSettings(Common.Logging.Configuration.LogSetting)">
-<summary>
Builds a
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
instance from the given
<see cref="T:Common.Logging.Configuration.LogSetting"/>
using
<see cref="T:System.Activator"/>
.
</summary>
<param key="setting"/>
-<returns>
the
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
instance. Is never
<c>null</c>
</returns>
</member>
-<member name="P:Common.Logging.LogManager.ConfigurationReader">
<summary>Gets the configuration reader used to initialize the LogManager. </summary>
<remarks>Primarily used for testing purposes but maybe useful to obtain configurationinformation from some place other than the .NET application configuration file.</remarks>
<value>The configuration reader.</value>
</member>
-<member name="P:Common.Logging.LogManager.Adapter">
<summary>Gets or sets the adapter. </summary>
<value>The adapter.</value>
</member>
-<member name="T:Common.Logging.Configuration.LogSetting">
<summary>Container used to hold configuration information from config file. </summary>
<author>Gilles Bayon</author>
</member>
-<member name="M:Common.Logging.Configuration.LogSetting.#ctor(System.Type,Common.Logging.Configuration.NameValueCollection)">
<summary> </summary>
-<param key="factoryAdapterType">
The
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
typethat will be used for creating
<see cref="T:Common.Logging.ILog"/>
</param>
-<param key="properties">
Additional user supplied properties that are passed to the
<paramref key="factoryAdapterType"/>
's constructor.
</param>
</member>
-<member name="P:Common.Logging.Configuration.LogSetting.FactoryAdapterType">
-<summary>
The
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
type that will be used for creating
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="P:Common.Logging.Configuration.LogSetting.Properties">
-<summary>
Additional user supplied properties that are passed to the
<see cref="P:Common.Logging.Configuration.LogSetting.FactoryAdapterType"/>
's constructor.
</summary>
</member>
-<member name="T:Common.Logging.NamespaceDoc">
<summary>This namespace contains all core classes making up the Common.Logging framework. </summary>
</member>
-<member name="T:Common.Logging.Simple.ExceptionFormatter">
<summary> </summary>
</member>
-<member name="T:Common.Logging.Simple.NamespaceDoc">
-<summary>
-<para>
This namespace contains portable out-of-the-box adapters, namely
<see cref="T:Common.Logging.Simple.DebugLoggerFactoryAdapter"/>
and theall output suppressing
<see cref="T:Common.Logging.Simple.NoOpLoggerFactoryAdapter"/>
.
</para>
-<para>
For unit testing, you may also want to have a look at
<see cref="T:Common.Logging.Simple.CapturingLoggerFactoryAdapter"/>
that allows to easily inspect logged messages.
</para>
</summary>
</member>
-<member name="T:Common.Logging.Configuration.NamespaceDoc">
<summary>This namespace contains various utility classes. </summary>
</member>
-<member name="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter">
-<summary>
Base factory implementation for creating simple
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
-<remarks>
Default settings are LogLevel.All, showDateTime = true, showLogName = true, and no DateTimeFormat.The keys in the NameValueCollection to configure this adapter are the following
-<list type="bullet">
<item>level</item>
<item>showDateTime</item>
<item>showLogName</item>
<item>dateTimeFormat</item>
</list>
-<example>
Here is an example how to implement your own logging adapter:
<code>public class ConsoleOutLogger : AbstractSimpleLogger{public ConsoleOutLogger(string logName, LogLevel logLevel, bool showLevel, bool showDateTime,bool showLogName, string dateTimeFormat): base(logName, logLevel, showLevel, showDateTime, showLogName, dateTimeFormat){}protected override void WriteInternal(LogLevel level, object message, Exception e){// Use a StringBuilder for better performanceStringBuilder sb = new StringBuilder();FormatOutput(sb, level, message, e);// Print to the appropriate destinationConsole.Out.WriteLine(sb.ToString());}}public class ConsoleOutLoggerFactoryAdapter : AbstractSimpleLoggerFactoryAdapter{public ConsoleOutLoggerFactoryAdapter(NameValueCollection properties): base(properties){ }protected override ILog CreateLogger(string key, LogLevel level, bool showLevel, boolshowDateTime, bool showLogName, string dateTimeFormat){ILog log = new ConsoleOutLogger(key, level, showLevel, showDateTime, showLogName,dateTimeFormat);return log;}} </code>
</example>
</remarks>
<seealso cref="P:Common.Logging.LogManager.Adapter"/>
<author>Gilles Bayon</author>
<author>Mark Pollack</author>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
class.
</summary>
-<remarks>
Looks for level, showDateTime, showLogName, dateTimeFormat items from
<paramref key="properties"/>
for use when the GetLogger methods are called.
<c>System.Configuration.ConfigurationManager</c>
for more information on how to use thestandard .NET application configuraiton file (App.config/Web.config)to configure this adapter.
</remarks>
<param key="properties">The key value collection, typically specified by the user ina configuration section named common/logging.</param>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
class withdefault settings for the loggers created by this factory.
</summary>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.CreateLogger(System.String)">
<summary>Create the specified logger instance </summary>
</member>
-<member name="M:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
<summary>Derived factories need to implement this method to create theactual logger instance. </summary>
-<returns>
a new logger instance. Must never be
<c>null</c>
!
</returns>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.Level">
-<summary>
The default
<see cref="T:Common.Logging.LogLevel"/>
to use when creating new
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.ShowLevel">
-<summary>
The default setting to use when creating new
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.ShowDateTime">
-<summary>
The default setting to use when creating new
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.ShowLogName">
-<summary>
The default setting to use when creating new
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="P:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter.DateTimeFormat">
-<summary>
The default setting to use when creating new
<see cref="T:Common.Logging.ILog"/>
instances.
</summary>
</member>
-<member name="T:NamespaceDoc">
-<summary>
<h1>Overview</h1>
<para>There are a variety of logging implementations for .NET currently in use, log4net, EnterpriseLibrary Logging, NLog, to key the most popular. The downside of having differerent implementationis that they do not share a common interface and therefore impose a particular loggingimplementation on the users of your library. To solve this dependency problem the Common.Logginglibrary introduces a simple abstraction to allow you to select a specific logging implementation atruntime. </para>
<para>The library is based on work done by the developers of IBatis.NET and it's usage is inspired bylog4net. Many thanks to the developers of those projects! </para>
<h1>Usage</h1>
-<para>
The core logging library Common.Logging provides the base logging
<see cref="T:Common.Logging.ILog"/>
interface aswell as the global
<see cref="T:Common.Logging.LogManager"/>
that you use to instrument your code:
</para>
<code lang="C#">ILog log = LogManager.GetLogger(this.GetType());log.DebugFormat("Hi {0}", "dude"); </code>
<para>To output the information logged, you need to tell Common.Logging, what underlying logging systemto use. Common.Logging already includes simple console and trace based logger implementationsusable out of the box. Adding the following configuration snippet to your app.config causesCommon.Logging to output all information to the console: </para>
<code lang="XML"><configuration><configSections><sectionGroup key="common"><section key="logging" type="Common.Logging.ConfigurationSectionHandler, Common.Logging" /></sectionGroup></configSections><common><logging><factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"><arg key="level" value="DEBUG" /></factoryAdapter></logging></common></configuration> </code>
<h1>Customizing</h1>
-<para>
In the case you want to integrate your own logging system that is not supported by Common.Logging yet, it is easilypossible to implement your own plugin by implementing
<see cref="T:Common.Logging.ILoggerFactoryAdapter"/>
.For convenience there is a base
<see cref="T:Common.Logging.Factory.AbstractCachingLoggerFactoryAdapter"/>
implementation available that usuallymakes implementing your own adapter a breeze.
</para>
<h1><system.diagnostics> Integration</h1>
-<para>
If your code already uses the .NET framework's built-in
<a href="http://msdn.microsoft.com/library/system.diagnostics.trace.aspx">System.Diagnostics.Trace</a>
system, you can use
<c>CommonLoggingTraceListener</c>
in Common.Logging to redirect all trace output to theCommon.Logging infrastructure.
</para>
</summary>
</member>
-<member name="T:Common.Logging.Simple.DebugOutLogger">
-<summary>
Sends log messages to
<see cref="T:System.Diagnostics.Debug"/>
.
</summary>
<author>Gilles Bayon</author>
</member>
-<member name="M:Common.Logging.Simple.DebugOutLogger.#ctor(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
-<summary>
Creates and initializes a logger that writes messages to
<see cref="T:System.Diagnostics.Debug"/>
.
</summary>
<param key="logName">The key, usually type key of the calling class, of the logger.</param>
<param key="logLevel">The current logging threshold. Messages recieved that are beneath this threshold will not be logged.</param>
<param key="showLevel">Include the current log level in the log message.</param>
<param key="showDateTime">Include the current time in the log message.</param>
<param key="showLogName">Include the instance key in the log message.</param>
<param key="dateTimeFormat">The date and time format to use in the log message.</param>
</member>
-<member name="M:Common.Logging.Simple.DebugOutLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
-<summary>
Do the actual logging by constructing the log message using a
<see cref="T:System.Text.StringBuilder"/>
thensending the output to
<see cref="!:Console.Out"/>
.
</summary>
-<param key="level">
The
<see cref="T:Common.Logging.LogLevel"/>
of the message.
</param>
<param key="message">The log message.</param>
-<param key="e">
An optional
<see cref="T:System.Exception"/>
associated with the message.
</param>
</member>
-<member name="T:Common.Logging.Simple.DebugLoggerFactoryAdapter">
-<summary>
Factory for creating
<see cref="T:Common.Logging.ILog"/>
instances that write data using
<see cref="M:System.Diagnostics.Debug.WriteLine(System.String)"/>
.
</summary>
-<remarks>
-<example>
Below is an example how to configure this adapter:
<code><configuration><configSections><sectionGroup key="common"><section key="logging"type="Common.Logging.ConfigurationSectionHandler, Common.Logging"requirePermission="false" /></sectionGroup></configSections><common><logging><factoryAdapter type="Common.Logging.Simple.DebugLoggerFactoryAdapter, Common.Logging"><arg key="level" value="ALL" /></factoryAdapter></logging></common></configuration> </code>
</example>
</remarks>
<seealso cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
<seealso cref="P:Common.Logging.LogManager.Adapter"/>
<author>Gilles Bayon</author>
<author>Mark Pollack</author>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Simple.DebugLoggerFactoryAdapter.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Simple.DebugLoggerFactoryAdapter"/>
class using defaultsettings.
</summary>
</member>
-<member name="M:Common.Logging.Simple.DebugLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Simple.DebugLoggerFactoryAdapter"/>
class.
</summary>
-<remarks>
Looks for level, showDateTime, showLogName, dateTimeFormat items from
<paramref key="properties"/>
for use when the GetLogger methods are called.
<see cref="!:System.Configuration.ConfigurationManager"/>
for more information on how to use thestandard .NET application configuraiton file (App.config/Web.config)to configure this adapter.
</remarks>
<param key="properties">The key value collection, typically specified by the user ina configuration section named common/logging.</param>
</member>
-<member name="M:Common.Logging.Simple.DebugLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
class withdefault settings for the loggers created by this factory.
</summary>
</member>
-<member name="M:Common.Logging.Simple.DebugLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
-<summary>
Creates a new
<see cref="T:Common.Logging.Simple.DebugOutLogger"/>
instance.
</summary>
</member>
-<member name="T:Common.Logging.Simple.NoOpLogger">
<summary>Silently ignores all log messages. </summary>
<author>Gilles Bayon</author>
<author>Erich Eichinger</author>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.TraceFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.TraceFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.TraceFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.TraceFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Trace(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack trace.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.DebugFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.DebugFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.DebugFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.DebugFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Debug(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Debug.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.InfoFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.InfoFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.InfoFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.InfoFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Info(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Info.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.WarnFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.WarnFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.WarnFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Warnrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.WarnFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Warnrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Warn(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Warn.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.ErrorFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.ErrorFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.ErrorFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Errorrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.ErrorFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Errorrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Error(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Error.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.Object)">
<summary>Ignores message. </summary>
<param key="message"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.Object,System.Exception)">
<summary>Ignores message. </summary>
<param key="message"/>
<param key="e"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.FatalFormat(System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args"/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.FatalFormat(System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.FatalFormat(System.IFormatProvider,System.String,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Fatalrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.FatalFormat(System.IFormatProvider,System.String,System.Exception,System.Object[])">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting Fatalrmation.
</param>
-<param key="format">
The format of the message object to log.
<see cref="M:System.String.Format(System.String,System.Object[])"/>
</param>
<param key="exception">The exception to log.</param>
<param key="args">the list of message format arguments</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler})">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
</member>
-<member name="M:Common.Logging.Simple.NoOpLogger.Fatal(System.IFormatProvider,System.Action{Common.Logging.FormatMessageHandler},System.Exception)">
<summary>Ignores message. </summary>
-<param key="formatProvider">
An
<see cref="T:System.IFormatProvider"/>
that supplies culture-specific formatting information.
</param>
<param key="formatMessageCallback">A callback used by the logger to obtain the message if log level is matched</param>
<param key="exception">The exception to log, including its stack Fatal.</param>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsTraceEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsDebugEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsInfoEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsWarnEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsErrorEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="P:Common.Logging.Simple.NoOpLogger.IsFatalEnabled">
-<summary>
Always returns
<see langword="false"/>
.
</summary>
</member>
-<member name="T:Common.Logging.Simple.NoOpLoggerFactoryAdapter">
-<summary>
Factory for creating
<see cref="T:Common.Logging.ILog"/>
instances that silently ignoreslogging requests.
</summary>
-<remarks>
This logger adapter is the default used by Common.Logging if unconfigured. Using this logger adapter is the most efficientway to suppress any logging output.
-<example>
Below is an example how to configure this adapter:
<code><configuration><configSections><sectionGroup key="common"><section key="logging"type="Common.Logging.ConfigurationSectionHandler, Common.Logging"requirePermission="false" /></sectionGroup></configSections><common><logging><factoryAdapter type="Common.Logging.Simple.NoOpLoggerFactoryAdapter, Common.Logging"><arg key="level" value="ALL" /></factoryAdapter></logging></common></configuration> </code>
</example>
</remarks>
<seealso cref="P:Common.Logging.LogManager.Adapter"/>
<author>Gilles Bayon</author>
</member>
-<member name="M:Common.Logging.Simple.NoOpLoggerFactoryAdapter.#ctor">
<summary>Constructor </summary>
</member>
-<member name="M:Common.Logging.Simple.NoOpLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
<summary>Constructor </summary>
</member>
-<member name="M:Common.Logging.Simple.NoOpLoggerFactoryAdapter.GetLogger(System.Type)">
<summary>Get a ILog instance by type </summary>
<param key="type"/>
<returns/>
</member>
-<member name="M:Common.Logging.Simple.NoOpLoggerFactoryAdapter.Common#Logging#ILoggerFactoryAdapter#GetLogger(System.String)">
<summary>Get a ILog instance by type key </summary>
<param key="key"/>
<returns/>
</member>
</members>
</doc>Log4net
Newtonsoft.Json
<?xml version="1.0"?>
-<doc>
-<assembly>
<name>Newtonsoft.Json</name>
</assembly>
-<members>
-<member name="T:Newtonsoft.Json.Bson.BsonObjectId">
<summary>Represents a BSON Oid (object id). </summary>
</member>
-<member name="P:Newtonsoft.Json.Bson.BsonObjectId.Value">
<summary>Gets or sets the value of the Oid. </summary>
<value>The value of the Oid.</value>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonObjectId.#ctor(System.Byte[])">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/>
class.
</summary>
<param name="value">The Oid value.</param>
</member>
-<member name="T:Newtonsoft.Json.Bson.BsonReader">
<summary>Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. </summary>
</member>
-<member name="P:Newtonsoft.Json.Bson.BsonReader.JsonNet35BinaryCompatibility">
<summary>Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. </summary>
-<value>
<c>true</c>
if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.Bson.BsonReader.ReadRootValueAsArray">
<summary>Gets or sets a value indicating whether the root object will be read as a JSON array. </summary>
-<value>
<c>true</c>
if the root object will be read as a JSON array; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.Bson.BsonReader.DateTimeKindHandling">
-<summary>
Gets or sets the
<see cref="T:System.DateTimeKind"/>
used when reading
<see cref="T:System.DateTime"/>
values from BSON.
</summary>
-<value>
The
<see cref="T:System.DateTimeKind"/>
used when reading
<see cref="T:System.DateTime"/>
values from BSON.
</value>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonReader"/>
class.
</summary>
-<param name="stream">
The
<see cref="T:System.IO.Stream"/>
containing the BSON data to read.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonReader"/>
class.
</summary>
-<param name="reader">
The
<see cref="T:System.IO.BinaryReader"/>
containing the BSON data to read.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonReader"/>
class.
</summary>
-<param name="stream">
The
<see cref="T:System.IO.Stream"/>
containing the BSON data to read.
</param>
-<param name="readRootValueAsArray">
if set to
<c>true</c>
the root object will be read as a JSON array.
</param>
-<param name="dateTimeKindHandling">
The
<see cref="T:System.DateTimeKind"/>
used when reading
<see cref="T:System.DateTime"/>
values from BSON.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonReader"/>
class.
</summary>
-<param name="reader">
The
<see cref="T:System.IO.BinaryReader"/>
containing the BSON data to read.
</param>
-<param name="readRootValueAsArray">
if set to
<c>true</c>
the root object will be read as a JSON array.
</param>
-<param name="dateTimeKindHandling">
The
<see cref="T:System.DateTimeKind"/>
used when reading
<see cref="T:System.DateTime"/>
values from BSON.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.Read">
-<summary>
Reads the next JSON token from the underlying
<see cref="T:System.IO.Stream"/>
.
</summary>
-<returns>
<c>true</c>
if the next token was read successfully;
<c>false</c>
if there are no more tokens to read.
</returns>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonReader.Close">
-<summary>
Changes the reader's state to
<see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>
.If
<see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/>
is set to
<c>true</c>
, the underlying
<see cref="T:System.IO.Stream"/>
is also closed.
</summary>
</member>
-<member name="T:Newtonsoft.Json.Bson.BsonWriter">
<summary>Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. </summary>
</member>
-<member name="P:Newtonsoft.Json.Bson.BsonWriter.DateTimeKindHandling">
-<summary>
Gets or sets the
<see cref="T:System.DateTimeKind"/>
used when writing
<see cref="T:System.DateTime"/>
values to BSON.When set to
<see cref="F:System.DateTimeKind.Unspecified"/>
no conversion will occur.
</summary>
-<value>
The
<see cref="T:System.DateTimeKind"/>
used when writing
<see cref="T:System.DateTime"/>
values to BSON.
</value>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.Stream)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonWriter"/>
class.
</summary>
-<param name="stream">
The
<see cref="T:System.IO.Stream"/>
to write to.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.BinaryWriter)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Bson.BsonWriter"/>
class.
</summary>
-<param name="writer">
The
<see cref="T:System.IO.BinaryWriter"/>
to write to.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.Flush">
-<summary>
Flushes whatever is in the buffer to the underlying
<see cref="T:System.IO.Stream"/>
and also flushes the underlying stream.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
<summary>Writes the end. </summary>
<param name="token">The token.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteComment(System.String)">
-<summary>
Writes a comment
<c>/*...*/</c>
containing the specified text.
</summary>
<param name="text">Text to place inside the comment.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartConstructor(System.String)">
<summary>Writes the start of a constructor with the given name. </summary>
<param name="name">The name of the constructor.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRaw(System.String)">
<summary>Writes raw JSON. </summary>
<param name="json">The raw JSON to write.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRawValue(System.String)">
<summary>Writes raw JSON where a value is expected and updates the writer's state. </summary>
<param name="json">The raw JSON to write.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartArray">
<summary>Writes the beginning of a JSON array. </summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartObject">
<summary>Writes the beginning of a JSON object. </summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WritePropertyName(System.String)">
<summary>Writes the property name of a name/value pair on a JSON object. </summary>
<param name="name">The name of the property.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.Close">
-<summary>
Closes this writer.If
<see cref="P:Newtonsoft.Json.JsonWriter.CloseOutput"/>
is set to
<c>true</c>
, the underlying
<see cref="T:System.IO.Stream"/>
is also closed.If
<see cref="P:Newtonsoft.Json.JsonWriter.AutoCompleteOnClose"/>
is set to
<c>true</c>
, the JSON is auto-completed.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Object)">
-<summary>
Writes a
<see cref="T:System.Object"/>
value.An error will raised if the value cannot be written as a single JSON token.
</summary>
-<param name="value">
The
<see cref="T:System.Object"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteNull">
<summary>Writes a null value. </summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteUndefined">
<summary>Writes an undefined value. </summary>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.String)">
-<summary>
Writes a
<see cref="T:System.String"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.String"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int32)">
-<summary>
Writes a
<see cref="T:System.Int32"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Int32"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt32)">
-<summary>
Writes a
<see cref="T:System.UInt32"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.UInt32"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int64)">
-<summary>
Writes a
<see cref="T:System.Int64"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Int64"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt64)">
-<summary>
Writes a
<see cref="T:System.UInt64"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.UInt64"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Single)">
-<summary>
Writes a
<see cref="T:System.Single"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Single"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Double)">
-<summary>
Writes a
<see cref="T:System.Double"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Double"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Boolean)">
-<summary>
Writes a
<see cref="T:System.Boolean"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Boolean"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int16)">
-<summary>
Writes a
<see cref="T:System.Int16"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Int16"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt16)">
-<summary>
Writes a
<see cref="T:System.UInt16"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.UInt16"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Char)">
-<summary>
Writes a
<see cref="T:System.Char"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Char"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte)">
-<summary>
Writes a
<see cref="T:System.Byte"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Byte"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.SByte)">
-<summary>
Writes a
<see cref="T:System.SByte"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.SByte"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Decimal)">
-<summary>
Writes a
<see cref="T:System.Decimal"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Decimal"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTime)">
-<summary>
Writes a
<see cref="T:System.DateTime"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.DateTime"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTimeOffset)">
-<summary>
Writes a
<see cref="T:System.DateTimeOffset"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.DateTimeOffset"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte[])">
-<summary>
Writes a
<see cref="T:System.Byte"/>
[] value.
</summary>
-<param name="value">
The
<see cref="T:System.Byte"/>
[] value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Guid)">
-<summary>
Writes a
<see cref="T:System.Guid"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Guid"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.TimeSpan)">
-<summary>
Writes a
<see cref="T:System.TimeSpan"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.TimeSpan"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Uri)">
-<summary>
Writes a
<see cref="T:System.Uri"/>
value.
</summary>
-<param name="value">
The
<see cref="T:System.Uri"/>
value to write.
</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteObjectId(System.Byte[])">
-<summary>
Writes a
<see cref="T:System.Byte"/>
[] value that represents a BSON object id.
</summary>
<param name="value">The Object ID value to write.</param>
</member>
-<member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRegex(System.String,System.String)">
<summary>Writes a BSON regex. </summary>
<param name="pattern">The regex pattern.</param>
<param name="options">The regex options.</param>
</member>
-<member name="T:Newtonsoft.Json.ConstructorHandling">
-<summary>
Specifies how constructors are used when initializing objects during deserialization by the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.ConstructorHandling.Default">
<summary>First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. </summary>
</member>
-<member name="F:Newtonsoft.Json.ConstructorHandling.AllowNonPublicDefaultConstructor">
<summary>Json.NET will use a non-public default constructor before falling back to a parameterized constructor. </summary>
</member>
-<member name="T:Newtonsoft.Json.Converters.BinaryConverter">
<summary>Converts a binary value to and from a base 64 string value. </summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.BinaryConverter.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:Newtonsoft.Json.Converters.BinaryConverter.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:Newtonsoft.Json.Converters.BinaryConverter.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="T:Newtonsoft.Json.Converters.BsonObjectIdConverter">
-<summary>
Converts a
<see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/>
to and from JSON and BSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.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:Newtonsoft.Json.Converters.BsonObjectIdConverter.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:Newtonsoft.Json.Converters.BsonObjectIdConverter.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="T:Newtonsoft.Json.Converters.CustomCreationConverter`1">
<summary>Creates a custom object. </summary>
<typeparam name="T">The object type to convert.</typeparam>
</member>
-<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.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:Newtonsoft.Json.Converters.CustomCreationConverter`1.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:Newtonsoft.Json.Converters.CustomCreationConverter`1.Create(System.Type)">
<summary>Creates an object which will then be populated by the serializer. </summary>
<param name="objectType">Type of the object.</param>
<returns>The created object.</returns>
</member>
-<member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.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="P:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanWrite">
-<summary>
Gets a value indicating whether this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON.
</summary>
-<value>
<c>true</c>
if this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="T:Newtonsoft.Json.Converters.DataSetConverter">
-<summary>
Converts a
<see cref="T:System.Data.DataSet"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.DataSetConverter.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:Newtonsoft.Json.Converters.DataSetConverter.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:Newtonsoft.Json.Converters.DataSetConverter.CanConvert(System.Type)">
<summary>Determines whether this instance can convert the specified value type. </summary>
<param name="valueType">Type of the value.</param>
-<returns>
<c>true</c>
if this instance can convert the specified value type; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="T:Newtonsoft.Json.Converters.DataTableConverter">
-<summary>
Converts a
<see cref="T:System.Data.DataTable"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.DataTableConverter.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:Newtonsoft.Json.Converters.DataTableConverter.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:Newtonsoft.Json.Converters.DataTableConverter.CanConvert(System.Type)">
<summary>Determines whether this instance can convert the specified value type. </summary>
<param name="valueType">Type of the value.</param>
-<returns>
<c>true</c>
if this instance can convert the specified value type; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="T:Newtonsoft.Json.Converters.DateTimeConverterBase">
-<summary>
Provides a base class for converting a
<see cref="T:System.DateTime"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.DateTimeConverterBase.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="T:Newtonsoft.Json.Converters.DiscriminatedUnionConverter">
<summary>Converts a F# discriminated union type to and from JSON. </summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.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:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.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:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.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="T:Newtonsoft.Json.Converters.EntityKeyMemberConverter">
-<summary>
Converts an Entity Framework
<see cref="T:System.Data.EntityKeyMember"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.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:Newtonsoft.Json.Converters.EntityKeyMemberConverter.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:Newtonsoft.Json.Converters.EntityKeyMemberConverter.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="T:Newtonsoft.Json.Converters.ExpandoObjectConverter">
-<summary>
Converts an
<see cref="T:System.Dynamic.ExpandoObject"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.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:Newtonsoft.Json.Converters.ExpandoObjectConverter.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:Newtonsoft.Json.Converters.ExpandoObjectConverter.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="P:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanWrite">
-<summary>
Gets a value indicating whether this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON.
</summary>
-<value>
<c>true</c>
if this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="T:Newtonsoft.Json.Converters.IsoDateTimeConverter">
-<summary>
Converts a
<see cref="T:System.DateTime"/>
to and from the ISO 8601 date format (e.g.
<c>"2008-04-12T12:53Z"</c>
).
</summary>
</member>
-<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeStyles">
<summary>Gets or sets the date time styles used when converting a date to and from JSON. </summary>
<value>The date time styles used when converting a date to and from JSON.</value>
</member>
-<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeFormat">
<summary>Gets or sets the date time format used when converting a date to and from JSON. </summary>
<value>The date time format used when converting a date to and from JSON.</value>
</member>
-<member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.Culture">
<summary>Gets or sets the culture used when converting a date to and from JSON. </summary>
<value>The culture used when converting a date to and from JSON.</value>
</member>
-<member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.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:Newtonsoft.Json.Converters.IsoDateTimeConverter.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:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter">
-<summary>
Converts a
<see cref="T:System.DateTime"/>
to and from a JavaScript
<c>Date</c>
constructor (e.g.
<c>new Date(52231943)</c>
).
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.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:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.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 property value of the JSON that is being converted.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
-<member name="T:Newtonsoft.Json.Converters.KeyValuePairConverter">
-<summary>
Converts a
<see cref="T:System.Collections.Generic.KeyValuePair`2"/>
to and from JSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.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:Newtonsoft.Json.Converters.KeyValuePairConverter.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:Newtonsoft.Json.Converters.KeyValuePairConverter.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="T:Newtonsoft.Json.Converters.RegexConverter">
-<summary>
Converts a
<see cref="T:System.Text.RegularExpressions.Regex"/>
to and from JSON and BSON.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.RegexConverter.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:Newtonsoft.Json.Converters.RegexConverter.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:Newtonsoft.Json.Converters.RegexConverter.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="T:Newtonsoft.Json.Converters.StringEnumConverter">
-<summary>
Converts an
<see cref="T:System.Enum"/>
to and from its name string value.
</summary>
</member>
-<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.CamelCaseText">
<summary>Gets or sets a value indicating whether the written enum text should be camel case. </summary>
-<value>
<c>true</c>
if the written enum text will be camel case; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
<summary>Gets or sets a value indicating whether integer values are allowed when deserializing. </summary>
-<value>
<c>true</c>
if integers are allowed when deserializing; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor(System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/>
class.
</summary>
-<param name="camelCaseText">
<c>true</c>
if the written enum text will be camel case; otherwise,
<c>false</c>
.
</param>
</member>
-<member name="M:Newtonsoft.Json.Converters.StringEnumConverter.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:Newtonsoft.Json.Converters.StringEnumConverter.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:Newtonsoft.Json.Converters.StringEnumConverter.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="T:Newtonsoft.Json.Converters.VersionConverter">
-<summary>
Converts a
<see cref="T:System.Version"/>
to and from a string (e.g.
<c>"1.2.3.4"</c>
).
</summary>
</member>
-<member name="M:Newtonsoft.Json.Converters.VersionConverter.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:Newtonsoft.Json.Converters.VersionConverter.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 property value of the JSON that is being converted.</param>
<param name="serializer">The calling serializer.</param>
<returns>The object value.</returns>
</member>
-<member name="M:Newtonsoft.Json.Converters.VersionConverter.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="T:Newtonsoft.Json.Converters.XmlNodeConverter">
<summary>Converts XML to and from JSON. </summary>
</member>
-<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.DeserializeRootElementName">
<summary>Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. </summary>
<value>The name of the deserialized root element.</value>
</member>
-<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
<summary>Gets or sets a flag to indicate whether to write the Json.NET array attribute.This attribute helps preserve arrays when converting the written XML back to JSON. </summary>
-<value>
<c>true</c>
if the array attribute is written to the XML; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.OmitRootObject">
<summary>Gets or sets a value indicating whether to write the root JSON object. </summary>
-<value>
<c>true</c>
if the JSON root object is omitted; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.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="serializer">The calling serializer.</param>
<param name="value">The value.</param>
</member>
-<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.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:Newtonsoft.Json.Converters.XmlNodeConverter.IsNamespaceAttribute(System.String,System.String@)">
-<summary>
Checks if the
<paramref name="attributeName"/>
is a namespace attribute.
</summary>
<param name="attributeName">Attribute name to test.</param>
<param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param>
-<returns>
<c>true</c>
if attribute name is for a namespace attribute, otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.CanConvert(System.Type)">
<summary>Determines whether this instance can convert the specified value type. </summary>
<param name="valueType">Type of the value.</param>
-<returns>
<c>true</c>
if this instance can convert the specified value type; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="T:Newtonsoft.Json.FloatParseHandling">
<summary>Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary>
</member>
-<member name="F:Newtonsoft.Json.FloatParseHandling.Double">
-<summary>
Floating point numbers are parsed to
<see cref="F:Newtonsoft.Json.FloatParseHandling.Double"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.FloatParseHandling.Decimal">
-<summary>
Floating point numbers are parsed to
<see cref="F:Newtonsoft.Json.FloatParseHandling.Decimal"/>
.
</summary>
</member>
-<member name="T:Newtonsoft.Json.DateFormatHandling">
<summary>Specifies how dates are formatted when writing JSON text. </summary>
</member>
-<member name="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat">
-<summary>
Dates are written in the ISO 8601 format, e.g.
<c>"2012-03-21T05:40Z"</c>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat">
-<summary>
Dates are written in the Microsoft JSON format, e.g.
<c>"\/Date(1198908717056)\/"</c>
.
</summary>
</member>
-<member name="T:Newtonsoft.Json.DateParseHandling">
-<summary>
Specifies how date formatted strings, e.g.
<c>"\/Date(1198908717056)\/"</c>
and
<c>"2012-03-21T05:40Z"</c>
, are parsed when reading JSON text.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateParseHandling.None">
<summary>Date formatted strings are not parsed to a date type and are read as strings. </summary>
</member>
-<member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
-<summary>
Date formatted strings, e.g.
<c>"\/Date(1198908717056)\/"</c>
and
<c>"2012-03-21T05:40Z"</c>
, are parsed to
<see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
-<summary>
Date formatted strings, e.g.
<c>"\/Date(1198908717056)\/"</c>
and
<c>"2012-03-21T05:40Z"</c>
, are parsed to
<see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>
.
</summary>
</member>
-<member name="T:Newtonsoft.Json.DateTimeZoneHandling">
-<summary>
Specifies how to treat the time value when converting between string and
<see cref="T:System.DateTime"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Local">
-<summary>
Treat as local time. If the
<see cref="T:System.DateTime"/>
object represents a Coordinated Universal Time (UTC), it is converted to the local time.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Utc">
-<summary>
Treat as a UTC. If the
<see cref="T:System.DateTime"/>
object represents a local time, it is converted to a UTC.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateTimeZoneHandling.Unspecified">
-<summary>
Treat as a local time if a
<see cref="T:System.DateTime"/>
is being converted to a string.If a string is being converted to
<see cref="T:System.DateTime"/>
, convert to a local time if a time zone is specified.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind">
<summary>Time zone information should be preserved when converting. </summary>
</member>
-<member name="T:Newtonsoft.Json.DefaultValueHandling">
-<summary>
Specifies default value handling options for the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
.
</summary>
-<example>
<code title="DefaultValueHandling Class" lang="cs" region="ReducingSerializedJsonSizeDefaultValueHandlingObject" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs"/>
<code title="DefaultValueHandling Ignore Example" lang="cs" region="ReducingSerializedJsonSizeDefaultValueHandlingExample" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs"/>
</example>
</member>
-<member name="F:Newtonsoft.Json.DefaultValueHandling.Include">
<summary>Include members where the member value is the same as the member's default value when serializing objects.Included members are written to JSON. Has no effect when deserializing. </summary>
</member>
-<member name="F:Newtonsoft.Json.DefaultValueHandling.Ignore">
-<summary>
Ignore members where the member value is the same as the member's default value when serializing objectsso that it is not written to JSON.This option will ignore all default values (e.g.
<c>null</c>
for objects and nullable types;
<c>0</c>
for integers,decimals and floating point numbers; and
<c>false</c>
for booleans). The default value ignored can be changed byplacing the
<see cref="T:System.ComponentModel.DefaultValueAttribute"/>
on the property.
</summary>
</member>
-<member name="F:Newtonsoft.Json.DefaultValueHandling.Populate">
<summary>Members with a default value but no JSON will be set to their default value when deserializing. </summary>
</member>
-<member name="F:Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate">
<summary>Ignore members where the member value is the same as the member's default value when serializing objectsand set members to their default value when deserializing. </summary>
</member>
-<member name="T:Newtonsoft.Json.FloatFormatHandling">
-<summary>
Specifies float format handling options when writing special floating point numbers, e.g.
<see cref="F:System.Double.NaN"/>
,
<see cref="F:System.Double.PositiveInfinity"/>
and
<see cref="F:System.Double.NegativeInfinity"/>
with
<see cref="T:Newtonsoft.Json.JsonWriter"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.FloatFormatHandling.String">
-<summary>
Write special floating point values as strings in JSON, e.g.
<c>"NaN"</c>
,
<c>"Infinity"</c>
,
<c>"-Infinity"</c>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.FloatFormatHandling.Symbol">
-<summary>
Write special floating point values as symbols in JSON, e.g.
<c>NaN</c>
,
<c>Infinity</c>
,
<c>-Infinity</c>
.Note that this will produce non-valid JSON.
</summary>
</member>
-<member name="F:Newtonsoft.Json.FloatFormatHandling.DefaultValue">
-<summary>
Write special floating point values as the property's default value in JSON, e.g. 0.0 for a
<see cref="T:System.Double"/>
property,
<c>null</c>
for a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
property.
</summary>
</member>
-<member name="T:Newtonsoft.Json.Formatting">
-<summary>
Specifies formatting options for the
<see cref="T:Newtonsoft.Json.JsonTextWriter"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.Formatting.None">
<summary>No special formatting is applied. This is the default. </summary>
</member>
-<member name="F:Newtonsoft.Json.Formatting.Indented">
-<summary>
Causes child objects to be indented according to the
<see cref="P:Newtonsoft.Json.JsonTextWriter.Indentation"/>
and
<see cref="P:Newtonsoft.Json.JsonTextWriter.IndentChar"/>
settings.
</summary>
</member>
-<member name="T:Newtonsoft.Json.IArrayPool`1">
<summary>Provides an interface for using pooled arrays. </summary>
<typeparam name="T">The array type content.</typeparam>
</member>
-<member name="M:Newtonsoft.Json.IArrayPool`1.Rent(System.Int32)">
<summary>Rent an array from the pool. This array must be returned when it is no longer needed. </summary>
<param name="minimumLength">The minimum required length of the array. The returned array may be longer.</param>
<returns>The rented array from the pool. This array must be returned when it is no longer needed.</returns>
</member>
-<member name="M:Newtonsoft.Json.IArrayPool`1.Return(`0[])">
<summary>Return an array to the pool. </summary>
<param name="array">The array that is being returned.</param>
</member>
-<member name="T:Newtonsoft.Json.IJsonLineInfo">
<summary>Provides an interface to enable a class to return line and position information. </summary>
</member>
-<member name="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo">
<summary>Gets a value indicating whether the class can return line information. </summary>
-<returns>
<c>true</c>
if
<see cref="P:Newtonsoft.Json.IJsonLineInfo.LineNumber"/>
and
<see cref="P:Newtonsoft.Json.IJsonLineInfo.LinePosition"/>
can be provided; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="P:Newtonsoft.Json.IJsonLineInfo.LineNumber">
<summary>Gets the current line number. </summary>
-<value>
The current line number or 0 if no line information is available (for example, when
<see cref="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo"/>
returns
<c>false</c>
).
</value>
</member>
-<member name="P:Newtonsoft.Json.IJsonLineInfo.LinePosition">
<summary>Gets the current line position. </summary>
-<value>
The current line position or 0 if no line information is available (for example, when
<see cref="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo"/>
returns
<c>false</c>
).
</value>
</member>
-<member name="T:Newtonsoft.Json.JsonArrayAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
how to serialize the collection.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonArrayAttribute.AllowNullItems">
<summary>Gets or sets a value indicating whether null items are allowed in the collection. </summary>
-<value>
<c>true</c>
if null items are allowed in the collection; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonArrayAttribute"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonObjectAttribute"/>
class with a flag indicating whether the array can contain null items.
</summary>
<param name="allowNullItems">A flag indicating whether the array can contain null items.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonArrayAttribute"/>
class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
-<member name="T:Newtonsoft.Json.JsonConstructorAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
to use the specified constructor when deserializing that object.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonContainerAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
how to serialize the object.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.Id">
<summary>Gets or sets the id. </summary>
<value>The id.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.Title">
<summary>Gets or sets the title. </summary>
<value>The title.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.Description">
<summary>Gets or sets the description. </summary>
<value>The description.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType">
<summary>Gets or sets the collection's items converter. </summary>
<value>The collection's items converter.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterParameters">
-<summary>
The parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
described by
<see cref="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType"/>
.If
<c>null</c>
, the default constructor is used.When non-
<c>null</c>
, there must be a constructor defined in the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
that exactly matches the number,order, and type of these parameters.
</summary>
-<example>
<code>[JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] </code>
</example>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyType">
-<summary>
Gets or sets the
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
.
</summary>
-<value>
The
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyParameters">
-<summary>
The parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
described by
<see cref="P:Newtonsoft.Json.JsonContainerAttribute.NamingStrategyType"/>
.If
<c>null</c>
, the default constructor is used.When non-
<c>null</c>
, there must be a constructor defined in the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
that exactly matches the number,order, and type of these parameters.
</summary>
-<example>
<code>[JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] </code>
</example>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.IsReference">
<summary>Gets or sets a value that indicates whether to preserve object references. </summary>
-<value>
<c>true</c>
to keep object reference; otherwise,
<c>false</c>
. The default is
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemIsReference">
<summary>Gets or sets a value that indicates whether to preserve collection's items references. </summary>
-<value>
<c>true</c>
to keep collection's items object references; otherwise,
<c>false</c>
. The default is
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemReferenceLoopHandling">
<summary>Gets or sets the reference loop handling used when serializing the collection's items. </summary>
<value>The reference loop handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemTypeNameHandling">
<summary>Gets or sets the type name handling used when serializing the collection's items. </summary>
<value>The type name handling.</value>
</member>
-<member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonContainerAttribute"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonContainerAttribute"/>
class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
-<member name="T:Newtonsoft.Json.JsonConvert">
<summary>Provides methods for converting between .NET types and JSON types. </summary>
-<example>
<code title="Serializing and Deserializing JSON with JsonConvert" lang="cs" region="SerializeObject" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs"/>
</example>
</member>
-<member name="P:Newtonsoft.Json.JsonConvert.DefaultSettings">
-<summary>
Gets or sets a function that creates default
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.Default settings are automatically used by serialization methods on
<see cref="T:Newtonsoft.Json.JsonConvert"/>
,and
<see cref="M:Newtonsoft.Json.Linq.JToken.ToObject``1"/>
and
<see cref="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)"/>
on
<see cref="T:Newtonsoft.Json.Linq.JToken"/>
.To serialize without using any default settings create a
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
with
<see cref="M:Newtonsoft.Json.JsonSerializer.Create"/>
.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.True">
-<summary>
Represents JavaScript's boolean value
<c>true</c>
as a string. This field is read-only.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.False">
-<summary>
Represents JavaScript's boolean value
<c>false</c>
as a string. This field is read-only.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.Null">
-<summary>
Represents JavaScript's
<c>null</c>
as a string. This field is read-only.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.Undefined">
-<summary>
Represents JavaScript's
<c>undefined</c>
as a string. This field is read-only.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.PositiveInfinity">
<summary>Represents JavaScript's positive infinity as a string. This field is read-only. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.NegativeInfinity">
<summary>Represents JavaScript's negative infinity as a string. This field is read-only. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonConvert.NaN">
-<summary>
Represents JavaScript's
<c>NaN</c>
as a string. This field is read-only.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime)">
-<summary>
Converts the
<see cref="T:System.DateTime"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.DateTime"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime,Newtonsoft.Json.DateFormatHandling,Newtonsoft.Json.DateTimeZoneHandling)">
-<summary>
Converts the
<see cref="T:System.DateTime"/>
to its JSON string representation using the
<see cref="T:Newtonsoft.Json.DateFormatHandling"/>
specified.
</summary>
<param name="value">The value to convert.</param>
<param name="format">The format the date will be converted to.</param>
<param name="timeZoneHandling">The time zone handling when the date is converted to a string.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.DateTime"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset)">
-<summary>
Converts the
<see cref="T:System.DateTimeOffset"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.DateTimeOffset"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset,Newtonsoft.Json.DateFormatHandling)">
-<summary>
Converts the
<see cref="T:System.DateTimeOffset"/>
to its JSON string representation using the
<see cref="T:Newtonsoft.Json.DateFormatHandling"/>
specified.
</summary>
<param name="value">The value to convert.</param>
<param name="format">The format the date will be converted to.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.DateTimeOffset"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Boolean)">
-<summary>
Converts the
<see cref="T:System.Boolean"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Boolean"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Char)">
-<summary>
Converts the
<see cref="T:System.Char"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Char"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Enum)">
-<summary>
Converts the
<see cref="T:System.Enum"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Enum"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int32)">
-<summary>
Converts the
<see cref="T:System.Int32"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Int32"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int16)">
-<summary>
Converts the
<see cref="T:System.Int16"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Int16"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt16)">
-<summary>
Converts the
<see cref="T:System.UInt16"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.UInt16"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt32)">
-<summary>
Converts the
<see cref="T:System.UInt32"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.UInt32"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int64)">
-<summary>
Converts the
<see cref="T:System.Int64"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Int64"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt64)">
-<summary>
Converts the
<see cref="T:System.UInt64"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.UInt64"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Single)">
-<summary>
Converts the
<see cref="T:System.Single"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Single"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Double)">
-<summary>
Converts the
<see cref="T:System.Double"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Double"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Byte)">
-<summary>
Converts the
<see cref="T:System.Byte"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Byte"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.SByte)">
-<summary>
Converts the
<see cref="T:System.SByte"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.SByte"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Decimal)">
-<summary>
Converts the
<see cref="T:System.Decimal"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.SByte"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
-<summary>
Converts the
<see cref="T:System.Guid"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Guid"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.TimeSpan)">
-<summary>
Converts the
<see cref="T:System.TimeSpan"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.TimeSpan"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Uri)">
-<summary>
Converts the
<see cref="T:System.Uri"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Uri"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String)">
-<summary>
Converts the
<see cref="T:System.String"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.String"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char)">
-<summary>
Converts the
<see cref="T:System.String"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<param name="delimiter">The string delimiter character.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.String"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char,Newtonsoft.Json.StringEscapeHandling)">
-<summary>
Converts the
<see cref="T:System.String"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
<param name="delimiter">The string delimiter character.</param>
<param name="stringEscapeHandling">The string escape handling.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.String"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Object)">
-<summary>
Converts the
<see cref="T:System.Object"/>
to its JSON string representation.
</summary>
<param name="value">The value to convert.</param>
-<returns>
A JSON string representation of the
<see cref="T:System.Object"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object)">
<summary>Serializes the specified object to a JSON string. </summary>
<param name="value">The object to serialize.</param>
<returns>A JSON string representation of the object.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting)">
<summary>Serializes the specified object to a JSON string using formatting. </summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<returns>A JSON string representation of the object. </returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonConverter[])">
-<summary>
Serializes the specified object to a JSON string using a collection of
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
<param name="value">The object to serialize.</param>
<param name="converters">A collection of converters used while serializing.</param>
<returns>A JSON string representation of the object.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])">
-<summary>
Serializes the specified object to a JSON string using formatting and a collection of
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="converters">A collection of converters used while serializing.</param>
<returns>A JSON string representation of the object.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Serializes the specified object to a JSON string using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The object to serialize.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to serialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>A JSON string representation of the object. </returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Serializes the specified object to a JSON string using a type, formatting and
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The object to serialize.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to serialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
-<param name="type">
The type of the value being serialized.This parameter is used when
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/>
is
<see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/>
to write out the type name if the type of the value does not match.Specifying the type is optional.
</param>
<returns>A JSON string representation of the object. </returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Serializes the specified object to a JSON string using formatting and
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to serialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>A JSON string representation of the object. </returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Serializes the specified object to a JSON string using a type, formatting and
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The object to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to serialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
-<param name="type">
The type of the value being serialized.This parameter is used when
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/>
is
<see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/>
to write out the type name if the type of the value does not match.Specifying the type is optional.
</param>
<returns>A JSON string representation of the object. </returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String)">
<summary>Deserializes the JSON to a .NET object. </summary>
<param name="value">The JSON to deserialize.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Deserializes the JSON to a .NET object using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The JSON to deserialize.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to deserialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type)">
<summary>Deserializes the JSON to the specified .NET type. </summary>
<param name="value">The JSON to deserialize.</param>
-<param name="type">
The
<see cref="T:System.Type"/>
of object being deserialized.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String)">
<summary>Deserializes the JSON to the specified .NET type. </summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The JSON to deserialize.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0)">
<summary>Deserializes the JSON to the given anonymous type. </summary>
<typeparam name="T">The anonymous type to deserialize to. This can't be specifiedtraditionally and must be inferred from the anonymous type passedas a parameter. </typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="anonymousTypeObject">The anonymous type object.</param>
<returns>The deserialized anonymous type from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Deserializes the JSON to the given anonymous type using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<typeparam name="T">The anonymous type to deserialize to. This can't be specifiedtraditionally and must be inferred from the anonymous type passedas a parameter. </typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="anonymousTypeObject">The anonymous type object.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to deserialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>The deserialized anonymous type from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonConverter[])">
-<summary>
Deserializes the JSON to the specified .NET type using a collection of
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The JSON to deserialize.</param>
<param name="converters">Converters to use while deserializing.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Deserializes the JSON to the specified .NET type using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<typeparam name="T">The type of the object to deserialize to.</typeparam>
<param name="value">The object to deserialize.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to deserialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonConverter[])">
-<summary>
Deserializes the JSON to the specified .NET type using a collection of
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="type">The type of the object to deserialize.</param>
<param name="converters">Converters to use while deserializing.</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Deserializes the JSON to the specified .NET type using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The JSON to deserialize.</param>
<param name="type">The type of the object to deserialize to.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to deserialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
<returns>The deserialized object from the JSON string.</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object)">
<summary>Populates the object with values from the JSON string. </summary>
<param name="value">The JSON to populate values from.</param>
<param name="target">The target object to populate values onto.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Populates the object with values from the JSON string using
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
<param name="value">The JSON to populate values from.</param>
<param name="target">The target object to populate values onto.</param>
-<param name="settings">
The
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
used to deserialize the object.If this is
<c>null</c>
, default serialization settings will be used.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)">
-<summary>
Serializes the
<see cref="T:System.Xml.XmlNode"/>
to a JSON string.
</summary>
<param name="node">The node to serialize.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)">
-<summary>
Serializes the
<see cref="T:System.Xml.XmlNode"/>
to a JSON string using formatting.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)">
-<summary>
Serializes the
<see cref="T:System.Xml.XmlNode"/>
to a JSON string using formatting and omits the root object if
<paramref name="omitRootObject"/>
is
<c>true</c>
.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)">
-<summary>
Deserializes the
<see cref="T:System.Xml.XmlNode"/>
from a JSON string.
</summary>
<param name="value">The JSON string.</param>
-<returns>
The deserialized
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)">
-<summary>
Deserializes the
<see cref="T:System.Xml.XmlNode"/>
from a JSON string nested in a root element specified by
<paramref name="deserializeRootElementName"/>
.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
-<returns>
The deserialized
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)">
-<summary>
Deserializes the
<see cref="T:System.Xml.XmlNode"/>
from a JSON string nested in a root element specified by
<paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">A flag to indicate whether to write the Json.NET array attribute.This attribute helps preserve arrays when converting the written XML back to JSON. </param>
-<returns>
The deserialized
<see cref="T:System.Xml.XmlNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
-<summary>
Serializes the
<see cref="T:System.Xml.Linq.XNode"/>
to a JSON string.
</summary>
<param name="node">The node to convert to JSON.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting)">
-<summary>
Serializes the
<see cref="T:System.Xml.Linq.XNode"/>
to a JSON string using formatting.
</summary>
<param name="node">The node to convert to JSON.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting,System.Boolean)">
-<summary>
Serializes the
<see cref="T:System.Xml.Linq.XNode"/>
to a JSON string using formatting and omits the root object if
<paramref name="omitRootObject"/>
is
<c>true</c>
.
</summary>
<param name="node">The node to serialize.</param>
<param name="formatting">Indicates how the output should be formatted.</param>
<param name="omitRootObject">Omits writing the root object.</param>
-<returns>
A JSON string of the
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String)">
-<summary>
Deserializes the
<see cref="T:System.Xml.Linq.XNode"/>
from a JSON string.
</summary>
<param name="value">The JSON string.</param>
-<returns>
The deserialized
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String)">
-<summary>
Deserializes the
<see cref="T:System.Xml.Linq.XNode"/>
from a JSON string nested in a root element specified by
<paramref name="deserializeRootElementName"/>
.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
-<returns>
The deserialized
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean)">
-<summary>
Deserializes the
<see cref="T:System.Xml.Linq.XNode"/>
from a JSON string nested in a root element specified by
<paramref name="deserializeRootElementName"/>
and writes a Json.NET array attribute for collections.
</summary>
<param name="value">The JSON string.</param>
<param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
<param name="writeArrayAttribute">A flag to indicate whether to write the Json.NET array attribute.This attribute helps preserve arrays when converting the written XML back to JSON. </param>
-<returns>
The deserialized
<see cref="T:System.Xml.Linq.XNode"/>
.
</returns>
</member>
-<member name="T:Newtonsoft.Json.JsonConverter">
<summary>Converts an object to and from JSON. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonConverter.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:Newtonsoft.Json.JsonConverter.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:Newtonsoft.Json.JsonConverter.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="P:Newtonsoft.Json.JsonConverter.CanRead">
-<summary>
Gets a value indicating whether this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can read JSON.
</summary>
-<value>
<c>true</c>
if this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can read JSON; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonConverter.CanWrite">
-<summary>
Gets a value indicating whether this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON.
</summary>
-<value>
<c>true</c>
if this
<see cref="T:Newtonsoft.Json.JsonConverter"/>
can write JSON; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="T:Newtonsoft.Json.JsonConverterAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
to use the specified
<see cref="T:Newtonsoft.Json.JsonConverter"/>
when serializing the member or class.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType">
-<summary>
Gets the
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
-<value>
The
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterParameters">
-<summary>
The parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
described by
<see cref="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType"/>
.If
<c>null</c>
, the default constructor is used.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonConverterAttribute"/>
class.
</summary>
-<param name="converterType">
Type of the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type,System.Object[])">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonConverterAttribute"/>
class.
</summary>
-<param name="converterType">
Type of the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</param>
-<param name="converterParameters">
Parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
. Can be
<c>null</c>
.
</param>
</member>
-<member name="T:Newtonsoft.Json.JsonConverterCollection">
-<summary>
Represents a collection of
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonDictionaryAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
how to serialize the collection.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/>
class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
-<member name="T:Newtonsoft.Json.JsonException">
<summary>The exception thrown when an error occurs during JSON serialization or deserialization. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonException.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonException"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonException.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonException"/>
classwith a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonException.#ctor(System.String,System.Exception)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonException"/>
classwith a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
-<param name="innerException">
The exception that is the cause of the current exception, or
<c>null</c>
if no inner exception is specified.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonException"/>
class.
</summary>
-<param name="info">
The
<see cref="T:System.Runtime.Serialization.SerializationInfo"/>
that holds the serialized object data about the exception being thrown.
</param>
-<param name="context">
The
<see cref="T:System.Runtime.Serialization.StreamingContext"/>
that contains contextual information about the source or destination.
</param>
-<exception cref="T:System.ArgumentNullException">
The
<paramref name="info"/>
parameter is
<c>null</c>
.
</exception>
-<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is
<c>null</c>
or
<see cref="P:System.Exception.HResult"/>
is zero (0).
</exception>
</member>
-<member name="T:Newtonsoft.Json.JsonExtensionDataAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
to deserialize properties with no matching class member into the specified collectionand write values during serialization.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.WriteData">
<summary>Gets or sets a value that indicates whether to write extension data when serializing the object. </summary>
-<value>
<c>true</c>
to write extension data when serializing the object; otherwise,
<c>false</c>
. The default is
<c>true</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.ReadData">
<summary>Gets or sets a value that indicates whether to read extension data when deserializing the object. </summary>
-<value>
<c>true</c>
to read extension data when deserializing the object; otherwise,
<c>false</c>
. The default is
<c>true</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.JsonExtensionDataAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonExtensionDataAttribute"/>
class.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonIgnoreAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
not to serialize the public field or public read/write property value.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonObjectAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
how to serialize the object.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonObjectAttribute.MemberSerialization">
<summary>Gets or sets the member serialization. </summary>
<value>The member serialization.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemRequired">
<summary>Gets or sets a value that indicates whether the object's properties are required. </summary>
<value>A value indicating whether the object's properties are required. </value>
</member>
-<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonObjectAttribute"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(Newtonsoft.Json.MemberSerialization)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonObjectAttribute"/>
class with the specified member serialization.
</summary>
<param name="memberSerialization">The member serialization.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonObjectAttribute"/>
class with the specified container Id.
</summary>
<param name="id">The container Id.</param>
</member>
-<member name="T:Newtonsoft.Json.JsonPropertyAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
to always serialize the member with the specified name.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
used when serializing the property's collection items.
</summary>
-<value>
The collection's items
<see cref="T:Newtonsoft.Json.JsonConverter"/>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
-<summary>
The parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
described by
<see cref="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType"/>
.If
<c>null</c>
, the default constructor is used.When non-
<c>null</c>
, there must be a constructor defined in the
<see cref="T:Newtonsoft.Json.JsonConverter"/>
that exactly matches the number,order, and type of these parameters.
</summary>
-<example>
<code>[JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] </code>
</example>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyType">
-<summary>
Gets or sets the
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
.
</summary>
-<value>
The
<see cref="T:System.Type"/>
of the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyParameters">
-<summary>
The parameter list to use when constructing the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
described by
<see cref="P:Newtonsoft.Json.JsonPropertyAttribute.NamingStrategyType"/>
.If
<c>null</c>
, the default constructor is used.When non-
<c>null</c>
, there must be a constructor defined in the
<see cref="T:Newtonsoft.Json.Serialization.NamingStrategy"/>
that exactly matches the number,order, and type of these parameters.
</summary>
-<example>
<code>[JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] </code>
</example>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.NullValueHandling">
<summary>Gets or sets the null value handling used when serializing this property. </summary>
<value>The null value handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.DefaultValueHandling">
<summary>Gets or sets the default value handling used when serializing this property. </summary>
<value>The default value handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ReferenceLoopHandling">
<summary>Gets or sets the reference loop handling used when serializing this property. </summary>
<value>The reference loop handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ObjectCreationHandling">
<summary>Gets or sets the object creation handling used when deserializing this property. </summary>
<value>The object creation handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.TypeNameHandling">
<summary>Gets or sets the type name handling used when serializing this property. </summary>
<value>The type name handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.IsReference">
<summary>Gets or sets whether this property's value is serialized as a reference. </summary>
<value>Whether this property's value is serialized as a reference.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.Order">
<summary>Gets or sets the order of serialization of a member. </summary>
<value>The numeric order of serialization.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.Required">
<summary>Gets or sets a value indicating whether this property is required. </summary>
<value>A value indicating whether this property is required. </value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.PropertyName">
<summary>Gets or sets the name of the property. </summary>
<value>The name of the property.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemReferenceLoopHandling">
<summary>Gets or sets the reference loop handling used when serializing the property's collection items. </summary>
<value>The collection's items reference loop handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemTypeNameHandling">
<summary>Gets or sets the type name handling used when serializing the property's collection items. </summary>
<value>The collection's items type name handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemIsReference">
<summary>Gets or sets whether this property's collection items are serialized as a reference. </summary>
<value>Whether this property's collection items are serialized as a reference.</value>
</member>
-<member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/>
class with the specified name.
</summary>
<param name="propertyName">Name of the property.</param>
</member>
-<member name="T:Newtonsoft.Json.JsonReader">
<summary>Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads the next JSON token from the source. </summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns
<c>true</c>
if the next token was read successfully;
<c>false</c>
if there are no more tokens to read.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.SkipAsync(System.Threading.CancellationToken)">
<summary>Asynchronously skips the children of the current token. </summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task"/>
that represents the asynchronous operation.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsBooleanAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsBytesAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Byte"/>
[].
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Byte"/>
[]. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimalAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDoubleAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32Async(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsStringAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.String"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.String"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.</remarks>
</member>
-<member name="T:Newtonsoft.Json.JsonReader.State">
<summary>Specifies the state of the reader. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Start">
-<summary>
A
<see cref="T:Newtonsoft.Json.JsonReader"/>
read method has not been called.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Complete">
<summary>The end of the file has been reached successfully. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Property">
<summary>Reader is at a property. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.ObjectStart">
<summary>Reader is at the start of an object. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Object">
<summary>Reader is in an object. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.ArrayStart">
<summary>Reader is at the start of an array. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Array">
<summary>Reader is in an array. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Closed">
-<summary>
The
<see cref="M:Newtonsoft.Json.JsonReader.Close"/>
method has been called.
</summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.PostValue">
<summary>Reader has just read a value. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.ConstructorStart">
<summary>Reader is at the start of a constructor. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Constructor">
<summary>Reader is in a constructor. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Error">
<summary>An error occurred that prevents the read operation from continuing. </summary>
</member>
-<member name="F:Newtonsoft.Json.JsonReader.State.Finished">
<summary>The end of the file has been reached successfully. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.CurrentState">
<summary>Gets the current reader state. </summary>
<value>The current reader state.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.CloseInput">
<summary>Gets or sets a value indicating whether the source should be closed when this reader is closed. </summary>
-<value>
<c>true</c>
to close the source when this reader is closed; otherwise
<c>false</c>
. The default is
<c>true</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.SupportMultipleContent">
<summary>Gets or sets a value indicating whether multiple pieces of JSON content canbe read from a continuous stream without erroring. </summary>
-<value>
<c>true</c>
to support reading multiple pieces of JSON content; otherwise
<c>false</c>
.The default is
<c>false</c>
.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.QuoteChar">
<summary>Gets the quotation mark character used to enclose the value of a string. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.DateTimeZoneHandling">
-<summary>
Gets or sets how
<see cref="T:System.DateTime"/>
time zones are handled when reading JSON.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.DateParseHandling">
<summary>Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.FloatParseHandling">
<summary>Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.DateFormatString">
<summary>Gets or sets how custom date formatted strings are parsed when reading JSON. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.MaxDepth">
-<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.TokenType">
<summary>Gets the type of the current JSON token. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.Value">
<summary>Gets the text value of the current JSON token. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.ValueType">
<summary>Gets the .NET type for the current JSON token. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.Depth">
<summary>Gets the depth of the current token in the JSON document. </summary>
<value>The depth of the current token in the JSON document.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.Path">
<summary>Gets the path of the current JSON token. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReader.Culture">
-<summary>
Gets or sets the culture used when reading JSON. Defaults to
<see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReader"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.Read">
<summary>Reads the next JSON token from the source. </summary>
-<returns>
<c>true</c>
if the next token was read successfully;
<c>false</c>
if there are no more tokens to read.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsString">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.String"/>
.
</summary>
-<returns>
A
<see cref="T:System.String"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsBytes">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Byte"/>
[].
</summary>
-<returns>
A
<see cref="T:System.Byte"/>
[] or
<c>null</c>
if the next JSON token is null. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDouble">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsBoolean">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimal">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTime">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffset">
-<summary>
Reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
.
</summary>
-<returns>
A
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
. This method will return
<c>null</c>
at the end of an array.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.Skip">
<summary>Skips the children of the current token. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken)">
<summary>Sets the current token. </summary>
<param name="newToken">The new token.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object)">
<summary>Sets the current token and value. </summary>
<param name="newToken">The new token.</param>
<param name="value">The value.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object,System.Boolean)">
<summary>Sets the current token and value. </summary>
<param name="newToken">The new token.</param>
<param name="value">The value.</param>
<param name="updateIndex">A flag indicating whether the position index inside an array should be updated.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.SetStateBasedOnCurrent">
<summary>Sets the state based on current token type. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.Dispose(System.Boolean)">
<summary>Releases unmanaged and - optionally - managed resources. </summary>
-<param name="disposing">
<c>true</c>
to release both managed and unmanaged resources;
<c>false</c>
to release only unmanaged resources.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReader.Close">
-<summary>
Changes the reader's state to
<see cref="F:Newtonsoft.Json.JsonReader.State.Closed"/>
.If
<see cref="P:Newtonsoft.Json.JsonReader.CloseInput"/>
is set to
<c>true</c>
, the source is also closed.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonReaderException">
<summary>The exception thrown when an error occurs while reading JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonReaderException.LineNumber">
<summary>Gets the line number indicating where the error occurred. </summary>
<value>The line number indicating where the error occurred.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReaderException.LinePosition">
<summary>Gets the line position indicating where the error occurred. </summary>
<value>The line position indicating where the error occurred.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonReaderException.Path">
<summary>Gets the path to the JSON where the error occurred. </summary>
<value>The path to the JSON where the error occurred.</value>
</member>
-<member name="M:Newtonsoft.Json.JsonReaderException.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
classwith a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.Exception)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
classwith a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
-<param name="innerException">
The exception that is the cause of the current exception, or
<c>null</c>
if no inner exception is specified.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
class.
</summary>
-<param name="info">
The
<see cref="T:System.Runtime.Serialization.SerializationInfo"/>
that holds the serialized object data about the exception being thrown.
</param>
-<param name="context">
The
<see cref="T:System.Runtime.Serialization.StreamingContext"/>
that contains contextual information about the source or destination.
</param>
-<exception cref="T:System.ArgumentNullException">
The
<paramref name="info"/>
parameter is
<c>null</c>
.
</exception>
-<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is
<c>null</c>
or
<see cref="P:System.Exception.HResult"/>
is zero (0).
</exception>
</member>
-<member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.String,System.Int32,System.Int32,System.Exception)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
classwith a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="path">The path to the JSON where the error occurred.</param>
<param name="lineNumber">The line number indicating where the error occurred.</param>
<param name="linePosition">The line position indicating where the error occurred.</param>
-<param name="innerException">
The exception that is the cause of the current exception, or
<c>null</c>
if no inner exception is specified.
</param>
</member>
-<member name="T:Newtonsoft.Json.JsonRequiredAttribute">
-<summary>
Instructs the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
to always serialize the member, and to require that the member has a value.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonSerializationException">
<summary>The exception thrown when an error occurs during JSON serialization or deserialization. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializationException"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializationException"/>
classwith a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.Exception)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializationException"/>
classwith a specified error message and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
-<param name="innerException">
The exception that is the cause of the current exception, or
<c>null</c>
if no inner exception is specified.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializationException"/>
class.
</summary>
-<param name="info">
The
<see cref="T:System.Runtime.Serialization.SerializationInfo"/>
that holds the serialized object data about the exception being thrown.
</param>
-<param name="context">
The
<see cref="T:System.Runtime.Serialization.StreamingContext"/>
that contains contextual information about the source or destination.
</param>
-<exception cref="T:System.ArgumentNullException">
The
<paramref name="info"/>
parameter is
<c>null</c>
.
</exception>
-<exception cref="T:System.Runtime.Serialization.SerializationException">
The class name is
<c>null</c>
or
<see cref="P:System.Exception.HResult"/>
is zero (0).
</exception>
</member>
-<member name="T:Newtonsoft.Json.JsonSerializer">
-<summary>
Serializes and deserializes objects into and from the JSON format.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
enables you to control how objects are encoded into JSON.
</summary>
</member>
-<member name="E:Newtonsoft.Json.JsonSerializer.Error">
-<summary>
Occurs when the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
errors during serialization and deserialization.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.ReferenceResolver">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/>
used by the serializer when resolving references.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.Binder">
-<summary>
Gets or sets the
<see cref="P:Newtonsoft.Json.JsonSerializer.SerializationBinder"/>
used by the serializer when resolving type names.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.SerializationBinder">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.ISerializationBinder"/>
used by the serializer when resolving type names.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.TraceWriter">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/>
used by the serializer when writing trace messages.
</summary>
<value>The trace writer.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.EqualityComparer">
<summary>Gets or sets the equality comparer used by the serializer when comparing references. </summary>
<value>The equality comparer.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling">
<summary>Gets or sets how type name writing and reading is handled by the serializer. </summary>
-<remarks>
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/>
should be used with caution when your application deserializes JSON from an external source.Incoming types should be validated with a custom
<see cref="P:Newtonsoft.Json.JsonSerializer.SerializationBinder"/>
when deserializing with a value other than
<see cref="F:Newtonsoft.Json.TypeNameHandling.None"/>
.
</remarks>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormat">
<summary>Gets or sets how a type name assembly is written and resolved by the serializer. </summary>
<value>The type name assembly format.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormatHandling">
<summary>Gets or sets how a type name assembly is written and resolved by the serializer. </summary>
<value>The type name assembly format.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.PreserveReferencesHandling">
<summary>Gets or sets how object references are preserved by the serializer. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.ReferenceLoopHandling">
<summary>Gets or sets how reference loops (e.g. a class referencing itself) is handled. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.MissingMemberHandling">
<summary>Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.NullValueHandling">
<summary>Gets or sets how null values are handled during serialization and deserialization. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.DefaultValueHandling">
<summary>Gets or sets how default values are handled during serialization and deserialization. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.ObjectCreationHandling">
<summary>Gets or sets how objects are created during deserialization. </summary>
<value>The object creation handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.ConstructorHandling">
<summary>Gets or sets how constructors are used during deserialization. </summary>
<value>The constructor handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.MetadataPropertyHandling">
<summary>Gets or sets how metadata properties are used during deserialization. </summary>
<value>The metadata properties handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.Converters">
-<summary>
Gets a collection
<see cref="T:Newtonsoft.Json.JsonConverter"/>
that will be used during serialization.
</summary>
-<value>
Collection
<see cref="T:Newtonsoft.Json.JsonConverter"/>
that will be used during serialization.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.ContractResolver">
<summary>Gets or sets the contract resolver used by the serializer whenserializing .NET objects to JSON and vice versa. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.Context">
-<summary>
Gets or sets the
<see cref="T:System.Runtime.Serialization.StreamingContext"/>
used by the serializer when invoking serialization callback methods.
</summary>
<value>The context.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.Formatting">
<summary>Indicates how JSON text output is formatted. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.DateFormatHandling">
<summary>Gets or sets how dates are written to JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.DateTimeZoneHandling">
-<summary>
Gets or sets how
<see cref="T:System.DateTime"/>
time zones are handled during serialization and deserialization.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.DateParseHandling">
-<summary>
Gets or sets how date formatted strings, e.g.
<c>"\/Date(1198908717056)\/"</c>
and
<c>"2012-03-21T05:40Z"</c>
, are parsed when reading JSON.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.FloatParseHandling">
<summary>Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.FloatFormatHandling">
-<summary>
Gets or sets how special floating point numbers, e.g.
<see cref="F:System.Double.NaN"/>
,
<see cref="F:System.Double.PositiveInfinity"/>
and
<see cref="F:System.Double.NegativeInfinity"/>
,are written as JSON text.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.StringEscapeHandling">
<summary>Gets or sets how strings are escaped when writing JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.DateFormatString">
-<summary>
Gets or sets how
<see cref="T:System.DateTime"/>
and
<see cref="T:System.DateTimeOffset"/>
values are formatted when writing JSON text,and the expected date format when reading JSON text.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.Culture">
-<summary>
Gets or sets the culture used when reading JSON. Defaults to
<see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.MaxDepth">
-<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializer.CheckAdditionalContent">
<summary>Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. </summary>
-<value>
<c>true</c>
if there will be a check for additional JSON content after deserializing an object; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
class.
</summary>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Create">
-<summary>
Creates a new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will not use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</summary>
-<returns>
A new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will not use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Create(Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Creates a new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance using the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will not use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</summary>
-<param name="settings">
The settings to be applied to the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
.
</param>
-<returns>
A new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance using the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will not use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault">
-<summary>
Creates a new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</summary>
-<returns>
A new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault(Newtonsoft.Json.JsonSerializerSettings)">
-<summary>
Creates a new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance using the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
as well as the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</summary>
-<param name="settings">
The settings to be applied to the
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
.
</param>
-<returns>
A new
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
instance using the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.The
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
will use default settingsfrom
<see cref="P:Newtonsoft.Json.JsonConvert.DefaultSettings"/>
as well as the specified
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Populate(System.IO.TextReader,System.Object)">
<summary>Populates the JSON values onto the target object. </summary>
-<param name="reader">
The
<see cref="T:System.IO.TextReader"/>
that contains the JSON structure to reader values from.
</param>
<param name="target">The target object to populate values onto.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
<summary>Populates the JSON values onto the target object. </summary>
-<param name="reader">
The
<see cref="T:Newtonsoft.Json.JsonReader"/>
that contains the JSON structure to reader values from.
</param>
<param name="target">The target object to populate values onto.</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
-<summary>
Deserializes the JSON structure contained by the specified
<see cref="T:Newtonsoft.Json.JsonReader"/>
.
</summary>
-<param name="reader">
The
<see cref="T:Newtonsoft.Json.JsonReader"/>
that contains the JSON structure to deserialize.
</param>
-<returns>
The
<see cref="T:System.Object"/>
being deserialized.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
-<summary>
Deserializes the JSON structure contained by the specified
<see cref="T:System.IO.StringReader"/>
into an instance of the specified type.
</summary>
-<param name="reader">
The
<see cref="T:System.IO.TextReader"/>
containing the object.
</param>
-<param name="objectType">
The
<see cref="T:System.Type"/>
of object being deserialized.
</param>
-<returns>
The instance of
<paramref name="objectType"/>
being deserialized.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize``1(Newtonsoft.Json.JsonReader)">
-<summary>
Deserializes the JSON structure contained by the specified
<see cref="T:Newtonsoft.Json.JsonReader"/>
into an instance of the specified type.
</summary>
-<param name="reader">
The
<see cref="T:Newtonsoft.Json.JsonReader"/>
containing the object.
</param>
<typeparam name="T">The type of the object to deserialize.</typeparam>
-<returns>
The instance of
<typeparamref name="T"/>
being deserialized.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader,System.Type)">
-<summary>
Deserializes the JSON structure contained by the specified
<see cref="T:Newtonsoft.Json.JsonReader"/>
into an instance of the specified type.
</summary>
-<param name="reader">
The
<see cref="T:Newtonsoft.Json.JsonReader"/>
containing the object.
</param>
-<param name="objectType">
The
<see cref="T:System.Type"/>
of object being deserialized.
</param>
-<returns>
The instance of
<paramref name="objectType"/>
being deserialized.
</returns>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object)">
-<summary>
Serializes the specified
<see cref="T:System.Object"/>
and writes the JSON structureusing the specified
<see cref="T:System.IO.TextWriter"/>
.
</summary>
-<param name="textWriter">
The
<see cref="T:System.IO.TextWriter"/>
used to write the JSON structure.
</param>
-<param name="value">
The
<see cref="T:System.Object"/>
to serialize.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object,System.Type)">
-<summary>
Serializes the specified
<see cref="T:System.Object"/>
and writes the JSON structureusing the specified
<see cref="T:Newtonsoft.Json.JsonWriter"/>
.
</summary>
-<param name="jsonWriter">
The
<see cref="T:Newtonsoft.Json.JsonWriter"/>
used to write the JSON structure.
</param>
-<param name="value">
The
<see cref="T:System.Object"/>
to serialize.
</param>
-<param name="objectType">
The type of the value being serialized.This parameter is used when
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/>
is
<see cref="F:Newtonsoft.Json.TypeNameHandling.Auto"/>
to write out the type name if the type of the value does not match.Specifying the type is optional.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object,System.Type)">
-<summary>
Serializes the specified
<see cref="T:System.Object"/>
and writes the JSON structureusing the specified
<see cref="T:System.IO.TextWriter"/>
.
</summary>
-<param name="textWriter">
The
<see cref="T:System.IO.TextWriter"/>
used to write the JSON structure.
</param>
-<param name="value">
The
<see cref="T:System.Object"/>
to serialize.
</param>
-<param name="objectType">
The type of the value being serialized.This parameter is used when
<see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/>
is Auto to write out the type name if the type of the value does not match.Specifying the type is optional.
</param>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object)">
-<summary>
Serializes the specified
<see cref="T:System.Object"/>
and writes the JSON structureusing the specified
<see cref="T:Newtonsoft.Json.JsonWriter"/>
.
</summary>
-<param name="jsonWriter">
The
<see cref="T:Newtonsoft.Json.JsonWriter"/>
used to write the JSON structure.
</param>
-<param name="value">
The
<see cref="T:System.Object"/>
to serialize.
</param>
</member>
-<member name="T:Newtonsoft.Json.JsonSerializerSettings">
-<summary>
Specifies the settings on a
<see cref="T:Newtonsoft.Json.JsonSerializer"/>
object.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceLoopHandling">
<summary>Gets or sets how reference loops (e.g. a class referencing itself) are handled. </summary>
<value>Reference loop handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.MissingMemberHandling">
<summary>Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. </summary>
<value>Missing member handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ObjectCreationHandling">
<summary>Gets or sets how objects are created during deserialization. </summary>
<value>The object creation handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.NullValueHandling">
<summary>Gets or sets how null values are handled during serialization and deserialization. </summary>
<value>Null value handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.DefaultValueHandling">
<summary>Gets or sets how default values are handled during serialization and deserialization. </summary>
<value>The default value handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Converters">
-<summary>
Gets or sets a
<see cref="T:Newtonsoft.Json.JsonConverter"/>
collection that will be used during serialization.
</summary>
<value>The converters.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.PreserveReferencesHandling">
<summary>Gets or sets how object references are preserved by the serializer. </summary>
<value>The preserve references handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling">
<summary>Gets or sets how type name writing and reading is handled by the serializer. </summary>
-<remarks>
<see cref="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling"/>
should be used with caution when your application deserializes JSON from an external source.Incoming types should be validated with a custom
<see cref="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder"/>
when deserializing with a value other than
<see cref="F:Newtonsoft.Json.TypeNameHandling.None"/>
.
</remarks>
<value>The type name handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.MetadataPropertyHandling">
<summary>Gets or sets how metadata properties are used during deserialization. </summary>
<value>The metadata properties handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormat">
<summary>Gets or sets how a type name assembly is written and resolved by the serializer. </summary>
<value>The type name assembly format.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormatHandling">
<summary>Gets or sets how a type name assembly is written and resolved by the serializer. </summary>
<value>The type name assembly format.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ConstructorHandling">
<summary>Gets or sets how constructors are used during deserialization. </summary>
<value>The constructor handling.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ContractResolver">
<summary>Gets or sets the contract resolver used by the serializer whenserializing .NET objects to JSON and vice versa. </summary>
<value>The contract resolver.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.EqualityComparer">
<summary>Gets or sets the equality comparer used by the serializer when comparing references. </summary>
<value>The equality comparer.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolver">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/>
used by the serializer when resolving references.
</summary>
<value>The reference resolver.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolverProvider">
-<summary>
Gets or sets a function that creates the
<see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/>
used by the serializer when resolving references.
</summary>
-<value>
A function that creates the
<see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/>
used by the serializer when resolving references.
</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.TraceWriter">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/>
used by the serializer when writing trace messages.
</summary>
<value>The trace writer.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Binder">
-<summary>
Gets or sets the
<see cref="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder"/>
used by the serializer when resolving type names.
</summary>
<value>The binder.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.SerializationBinder">
-<summary>
Gets or sets the
<see cref="T:Newtonsoft.Json.Serialization.ISerializationBinder"/>
used by the serializer when resolving type names.
</summary>
<value>The binder.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Error">
<summary>Gets or sets the error handler called during serialization and deserialization. </summary>
<value>The error handler called during serialization and deserialization.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Context">
-<summary>
Gets or sets the
<see cref="T:System.Runtime.Serialization.StreamingContext"/>
used by the serializer when invoking serialization callback methods.
</summary>
<value>The context.</value>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatString">
-<summary>
Gets or sets how
<see cref="T:System.DateTime"/>
and
<see cref="T:System.DateTimeOffset"/>
values are formatted when writing JSON text,and the expected date format when reading JSON text.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.MaxDepth">
-<summary>
Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a
<see cref="T:Newtonsoft.Json.JsonReaderException"/>
.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Formatting">
<summary>Indicates how JSON text output is formatted. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatHandling">
<summary>Gets or sets how dates are written to JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateTimeZoneHandling">
-<summary>
Gets or sets how
<see cref="T:System.DateTime"/>
time zones are handled during serialization and deserialization.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.DateParseHandling">
<summary>Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatFormatHandling">
-<summary>
Gets or sets how special floating point numbers, e.g.
<see cref="F:System.Double.NaN"/>
,
<see cref="F:System.Double.PositiveInfinity"/>
and
<see cref="F:System.Double.NegativeInfinity"/>
,are written as JSON.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatParseHandling">
<summary>Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.StringEscapeHandling">
<summary>Gets or sets how strings are escaped when writing JSON text. </summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.Culture">
-<summary>
Gets or sets the culture used when reading JSON. Defaults to
<see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>
.
</summary>
</member>
-<member name="P:Newtonsoft.Json.JsonSerializerSettings.CheckAdditionalContent">
<summary>Gets a value indicating whether there will be a check for additional content after deserializing an object. </summary>
-<value>
<c>true</c>
if there will be a check for additional content after deserializing an object; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="M:Newtonsoft.Json.JsonSerializerSettings.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>
class.
</summary>
</member>
-<member name="T:Newtonsoft.Json.JsonTextReader">
<summary>Represents a reader that provides fast, non-cached, forward-only access to JSON text data. </summary>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsync(System.Threading.CancellationToken)">
<summary>Asynchronously reads the next JSON token from the source. </summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns
<c>true</c>
if the next token was read successfully;
<c>false</c>
if there are no more tokens to read.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBooleanAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Boolean"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBytesAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Byte"/>
[].
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Byte"/>
[]. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTime"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeOffsetAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.DateTimeOffset"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDecimalAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Decimal"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDoubleAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Double"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsInt32Async(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.Nullable`1"/>
of
<see cref="T:System.Int32"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.ReadAsStringAsync(System.Threading.CancellationToken)">
-<summary>
Asynchronously reads the next JSON token from the source as a
<see cref="T:System.String"/>
.
</summary>
-<param name="cancellationToken">
The token to monitor for cancellation requests. The default value is
<see cref="P:System.Threading.CancellationToken.None"/>
.
</param>
-<returns>
A
<see cref="T:System.Threading.Tasks.Task`1"/>
that represents the asynchronous read. The
<see cref="P:System.Threading.Tasks.Task`1.Result"/>
property returns the
<see cref="T:System.String"/>
. This result will be
<c>null</c>
at the end of an array.
</returns>
<remarks>Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.</remarks>
</member>
-<member name="M:Newtonsoft.Json.JsonTextReader.#ctor(System.IO.TextReader)">
-<summary>
Initializes a new instance of the
<see cref="T:Newtonsoft.Json.JsonTextReader"/>
class with the specified
<see cref="T:System.IO.TextReader"/>
.
</summary>
-<param name="reader">
The
<see cref="T:System.IO.TextReader"/>
containing the JSON data to read.
</param>
</member>
Gets or sets the reader's character buffer pool.
Reads the next JSON token from the underlying
.
true
if the next token was read successfully;
false
if there are no more tokens to read.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
.
A
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
[].
A
[] or
null
if the next JSON token is null. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Changes the reader's state to
.If
is set to
true
, the underlying
is also closed.
Gets a value indicating whether the class can return line information.
true
if
and
can be provided; otherwise,
false
.
Gets the current line number.
The current line number or 0 if no line information is available (for example,
returns
false
).
Gets the current line position.
The current line position or 0 if no line information is available (for example,
returns
false
).
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the JSON value delimiter.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the specified end token.
The end token to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously closes this writer.If
is set to
true
, the destination is also closed.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the end of the current JSON object or array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes indent characters.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes an indent space.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes raw JSON without changing the writer's state.
The raw JSON to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a null value.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the property name of a name/value pair of a JSON object.
The name of the property.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the property name of a name/value pair of a JSON object.
The name of the property.
A flag to indicate whether the text should be escaped when it is written as a JSON property name.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the beginning of a JSON array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the beginning of a JSON object.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the start of a constructor with the given name.
The name of the constructor.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes an undefined value.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the given white space.
The string of white space characters.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
[] value.
The
[] value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes a comment
/*...*/
containing the specified text.
Text to place inside the comment.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the end of an array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the end of a constructor.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes the end of a JSON object.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Asynchronously writes raw JSON where a value is expected and updates the writer's state.
The raw JSON to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
Derived classes must override this method to get asynchronous behaviour. Otherwise it willexecute synchronously, returning an already-completed task.
Gets or sets the writer's character array pool.
Gets or sets how many
s to write for each level in the hierarchy when
is set to
.
Gets or sets which character to use to quote attribute values.
Gets or sets which character to use for indenting when
is set to
.
Gets or sets a value indicating whether object names will be surrounded with quotes.
Initializes a new instance of the
class using the specified
.
The
to write to.
Flushes whatever is in the buffer to the underlying
and also flushes the underlying
.
Closes this writer.If
is set to
true
, the underlying
is also closed.If
is set to
true
, the JSON is auto-completed.
Writes the beginning of a JSON object.
Writes the beginning of a JSON array.
Writes the start of a constructor with the given name.
The name of the constructor.
Writes the specified end token.
The end token to write.
Writes the property name of a name/value pair on a JSON object.
The name of the property.
Writes the property name of a name/value pair on a JSON object.
The name of the property.
A flag to indicate whether the text should be escaped when it is written as a JSON property name.
Writes indent characters.
Writes the JSON value delimiter.
Writes an indent space.
Writes a
value.An error will raised if the value cannot be written as a single JSON token.
The
value to write.
Writes a null value.
Writes an undefined value.
Writes raw JSON.
The raw JSON to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
value.
The
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
[] value.
The
[] value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a comment
/*...*/
containing the specified text.
Text to place inside the comment.
Writes the given white space.
The string of white space characters.
Specifies the type of JSON token.
This is returned by the
if a read method has not been called.
An object start token.
An array start token.
A constructor start token.
An object property name.
A comment.
Raw JSON.
An integer.
A float.
A string.
A boolean.
A null token.
An undefined token.
An object end token.
An array end token.
A constructor end token.
A Date.
Byte data.
Represents a reader that provides
validation.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Sets an event handler for receiving schema validation errors.
Gets the text value of the current JSON token.
Gets the depth of the current token in the JSON document.
The depth of the current token in the JSON document.
Gets the path of the current JSON token.
Gets the quotation mark character used to enclose the value of a string.
Gets the type of the current JSON token.
Gets the .NET type for the current JSON token.
Initializes a new instance of the
class thatvalidates the content returned from the given
.
The
to read from while validating.
Gets or sets the schema.
The schema.
Gets the
used to construct this
.
The
specified in the constructor.
Changes the reader's state to
.If
is set to
true
, the underlying
is also closed.
Reads the next JSON token from the underlying
as a
of
.
A
of
.
Reads the next JSON token from the underlying
as a
[].
A
[] or
null
if the next JSON token is null.
Reads the next JSON token from the underlying
as a
of
.
A
of
.
Reads the next JSON token from the underlying
as a
of
.
A
of
.
Reads the next JSON token from the underlying
as a
of
.
A
of
.
Reads the next JSON token from the underlying
as a
.
A
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
. This method will return
null
at the end of an array.
Reads the next JSON token from the underlying
as a
of
.
A
of
.
Reads the next JSON token from the underlying
.
true
if the next token was read successfully;
false
if there are no more tokens to read.
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
Asynchronously closes this writer.If
is set to
true
, the destination is also closed.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the specified end token.
The end token to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes indent characters.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the JSON value delimiter.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes an indent space.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes raw JSON without changing the writer's state.
The raw JSON to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the end of the current JSON object or array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the end of an array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the end of a constructor.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the end of a JSON object.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a null value.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the property name of a name/value pair of a JSON object.
The name of the property.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the property name of a name/value pair of a JSON object.
The name of the property.
A flag to indicate whether the text should be escaped when it is written as a JSON property name.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the beginning of a JSON array.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a comment
/*...*/
containing the specified text.
Text to place inside the comment.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes raw JSON where a value is expected and updates the writer's state.
The raw JSON to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the start of a constructor with the given name.
The name of the constructor.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the beginning of a JSON object.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the current
token.
The
to read the token from.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the current
token.
The
to read the token from.
A flag indicating whether the current token's children should be written.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the
token and its value.
The
to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the
token and its value.
The
to write.
The value to write.A value is only required for tokens that have an associated value, e.g. the
property name for
.
null
can be passed to the method for tokens that don't have a value, e.g.
.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
[] value.
The
[] value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
value.
The
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes a
of
value.
The
of
value to write.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes an undefined value.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously writes the given white space.
The string of white space characters.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Asynchronously ets the state of the
.
The
being written.
The value being written.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous operation.
The default behaviour is to execute synchronously, returning an already-completed task. Derivedclasses can override this behaviour for true asychronousity.
Gets or sets a value indicating whether the destination should be closed when this writer is closed.
true
to close the destination when this writer is closed; otherwise
false
. The default is
true
.
Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed.
true
to auto-complete the JSON when this writer is closed; otherwise
false
. The default is
true
.
Gets the top.
The top.
Gets the state of the writer.
Gets the path of the writer.
Gets or sets a value indicating how JSON text output should be formatted.
Gets or sets how dates are written to JSON text.
Gets or sets how
time zones are handled when writing JSON text.
Gets or sets how strings are escaped when writing JSON text.
Gets or sets how special floating point numbers, e.g.
,
and
,are written to JSON text.
Gets or sets how
and
values are formatted when writing JSON text.
Gets or sets the culture used when writing JSON. Defaults to
.
Initializes a new instance of the
class.
Flushes whatever is in the buffer to the destination and also flushes the destination.
Closes this writer.If
is set to
true
, the destination is also closed.If
is set to
true
, the JSON is auto-completed.
Writes the beginning of a JSON object.
Writes the end of a JSON object.
Writes the beginning of a JSON array.
Writes the end of an array.
Writes the start of a constructor with the given name.
The name of the constructor.
Writes the end constructor.
Writes the property name of a name/value pair of a JSON object.
The name of the property.
Writes the property name of a name/value pair of a JSON object.
The name of the property.
A flag to indicate whether the text should be escaped when it is written as a JSON property name.
Writes the end of the current JSON object or array.
Writes the current
token and its children.
The
to read the token from.
Writes the current
token.
The
to read the token from.
A flag indicating whether the current token's children should be written.
Writes the
token and its value.
The
to write.
The value to write.A value is only required for tokens that have an associated value, e.g. the
property name for
.
null
can be passed to the method for tokens that don't have a value, e.g.
.
Writes the
token.
The
to write.
Writes the specified end token.
The end token to write.
Writes indent characters.
Writes the JSON value delimiter.
Writes an indent space.
Writes a null value.
Writes an undefined value.
Writes raw JSON without changing the writer's state.
The raw JSON to write.
Writes raw JSON where a value is expected and updates the writer's state.
The raw JSON to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
of
value.
The
of
value to write.
Writes a
[] value.
The
[] value to write.
Writes a
value.
The
value to write.
Writes a
value.An error will raised if the value cannot be written as a single JSON token.
The
value to write.
Writes a comment
/*...*/
containing the specified text.
Text to place inside the comment.
Writes the given white space.
The string of white space characters.
Releases unmanaged and - optionally - managed resources.
true
to release both managed and unmanaged resources;
false
to release only unmanaged resources.
Sets the state of the
.
The
being written.
The value being written.
The exception thrown when an error occurs while writing JSON text.
Gets the path to the JSON where the error occurred.
The path to the JSON where the error occurred.
Initializes a new instance of the
class.
Initializes a new instance of the
classwith a specified error message.
The error message that explains the reason for the exception.
Initializes a new instance of the
classwith a specified error message and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or
null
if no inner exception is specified.
Initializes a new instance of the
class.
The
that holds the serialized object data about the exception being thrown.
The
that contains contextual information about the source or destination.
The
parameter is
null
.
The class name is
null
or
is zero (0).
Initializes a new instance of the
classwith a specified error message, JSON path and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The path to the JSON where the error occurred.
The exception that is the cause of the current exception, or
null
if no inner exception is specified.
Specifies how JSON comments are handled when loading JSON.
Ignore comments.
Load comments as a
with type
.
Specifies how line information is handled when loading JSON.
Ignore line information.
Load line information.
Contains the LINQ to JSON extension methods.
Returns a collection of tokens that contains the ancestors of every token in the source collection.
The type of the objects in source, constrained to
.
An
of
that contains the source collection.
An
of
that contains the ancestors of every token in the source collection.
Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection.
The type of the objects in source, constrained to
.
An
of
that contains the source collection.
An
of
that contains every token in the source collection, the ancestors of every token in the source collection.
Returns a collection of tokens that contains the descendants of every token in the source collection.
The type of the objects in source, constrained to
.
An
of
that contains the source collection.
An
of
that contains the descendants of every token in the source collection.
Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection.
The type of the objects in source, constrained to
.
An
of
that contains the source collection.
An
of
that contains every token in the source collection, and the descendants of every token in the source collection.
Returns a collection of child properties of every object in the source collection.
An
of
that contains the source collection.
An
of
that contains the properties of every object in the source collection.
Returns a collection of child values of every object in the source collection with the given key.
An
of
that contains the source collection.
The token key.
An
of
that contains the values of every token in the source collection with the given key.
Returns a collection of child values of every object in the source collection.
An
of
that contains the source collection.
An
of
that contains the values of every token in the source collection.
Returns a collection of converted child values of every object in the source collection with the given key.
The type to convert the values to.
An
of
that contains the source collection.
The token key.
An
that contains the converted values of every token in the source collection with the given key.
Returns a collection of converted child values of every object in the source collection.
The type to convert the values to.
An
of
that contains the source collection.
An
that contains the converted values of every token in the source collection.
Converts the value.
The type to convert the value to.
A
cast as a
of
.
A converted value.
Converts the value.
The source collection type.
The type to convert the value to.
A
cast as a
of
.
A converted value.
Returns a collection of child tokens of every array in the source collection.
The source collection type.
An
of
that contains the source collection.
An
of
that contains the values of every token in the source collection.
Returns a collection of converted child tokens of every array in the source collection.
An
of
that contains the source collection.
The type to convert the values to.
The source collection type.
An
that contains the converted values of every token in the source collection.
Returns the input typed as
.
An
of
that contains the source collection.
The input typed as
.
Returns the input typed as
.
The source collection type.
An
of
that contains the source collection.
The input typed as
.
Represents a collection of
objects.
The type of token.
Gets the
of
with the specified key.
Represents a JSON array.
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
representing the asynchronous load. The
property contains the JSON that was read from the specified
.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
representing the asynchronous load. The
property contains the JSON that was read from the specified
.
Gets the container's children tokens.
The container's children tokens.
Gets the node type for this
.
The type.
Initializes a new instance of the
class.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Initializes a new instance of the
class with the specified content.
The contents of the array.
Initializes a new instance of the
class with the specified content.
The contents of the array.
Loads an
from a
.
A
that will be read for the content of the
.
A
that contains the JSON that was read from the specified
.
Loads an
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the JSON that was read from the specified
.
Load a
from a string that contains JSON.
A
that contains JSON.
A
populated from the string that contains JSON.
Load a
from a string that contains JSON.
A
that contains JSON.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
populated from the string that contains JSON.
Creates a
from an object.
The object that will be used to create
.
A
with the values of the specified object.
Creates a
from an object.
The object that will be used to create
.
The
that will be used to read the object.
A
with the values of the specified object.
Writes this token to a
.
A
into which this method will write.
A collection of
which will be used when writing the token.
Gets the
with the specified key.
The
with the specified key.
Gets or sets the
at the specified index.
Determines the index of a specific item in the
.
The object to locate in the
.
The index of
if found in the list; otherwise, -1.
Inserts an item to the
at the specified index.
The zero-based index at which
should be inserted.
The object to insert into the
.
is not a valid index in the
.
Removes the
item at the specified index.
The zero-based index of the item to remove.
is not a valid index in the
.
Returns an enumerator that iterates through the collection.
A
of
that can be used to iterate through the collection.
Adds an item to the
.
The object to add to the
.
Removes all items from the
.
Determines whether the
contains a specific value.
The object to locate in the
.
true
if
is found in the
; otherwise,
false
.
Copies the elements of the
to an array, starting at a particular array index.
The array.
Index of the array.
Gets a value indicating whether the
is read-only.
true
if the
is read-only; otherwise,
false
.
Removes the first occurrence of a specific object from the
.
The object to remove from the
.
true
if
was successfully removed from the
; otherwise,
false
. This method also returns
false
if
is not found in the original
.
Represents a JSON constructor.
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous load. The
property returns a
that contains the JSON that was read from the specified
.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous load. The
property returns a
that contains the JSON that was read from the specified
.
Gets the container's children tokens.
The container's children tokens.
Gets or sets the name of this constructor.
The constructor name.
Gets the node type for this
.
The type.
Initializes a new instance of the
class.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Initializes a new instance of the
class with the specified name and content.
The constructor name.
The contents of the constructor.
Initializes a new instance of the
class with the specified name and content.
The constructor name.
The contents of the constructor.
Initializes a new instance of the
class with the specified name.
The constructor name.
Writes this token to a
.
A
into which this method will write.
A collection of
which will be used when writing the token.
Gets the
with the specified key.
The
with the specified key.
Loads a
from a
.
A
that will be read for the content of the
.
A
that contains the JSON that was read from the specified
.
Loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the JSON that was read from the specified
.
Represents a token that can contain other tokens.
Occurs when the list changes or an item in the list changes.
Occurs before an item is added to the collection.
Occurs when the items list of the collection has changed, or the collection is reset.
Gets the container's children tokens.
The container's children tokens.
Raises the
event.
The
instance containing the event data.
Raises the
event.
The
instance containing the event data.
Raises the
event.
The
instance containing the event data.
Gets a value indicating whether this token has child tokens.
true
if this token has child values; otherwise,
false
.
Get the first child token of this token.
A
containing the first child token of the
.
Get the last child token of this token.
A
containing the last child token of the
.
Returns a collection of the child tokens of this token, in document order.
An
of
containing the child tokens of this
, in document order.
Returns a collection of the child values of this token, in document order.
The type to convert the values to.
A
containing the child values of this
, in document order.
Returns a collection of the descendant tokens for this token in document order.
An
of
containing the descendant tokens of the
.
Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order.
An
of
containing this token, and all the descendant tokens of the
.
Adds the specified content as children of this
.
The content to be added.
Adds the specified content as the first children of this
.
The content to be added.
Creates a
that can be used to add tokens to the
.
A
that is ready to have content written to it.
Replaces the child nodes of this token with the specified content.
The content.
Removes the child nodes from this token.
Merge the specified content into this
.
The content to be merged.
Merge the specified content into this
using
.
The content to be merged.
The
used to merge the content.
Gets the count of child JSON tokens.
The count of child JSON tokens.
Represents a collection of
objects.
The type of token.
An empty collection of
objects.
Initializes a new instance of the
struct.
The enumerable.
Returns an enumerator that can be used to iterate through the collection.
A
that can be used to iterate through the collection.
Gets the
of
with the specified key.
Determines whether the specified
is equal to this instance.
The
to compare with this instance.
true
if the specified
is equal to this instance; otherwise,
false
.
Determines whether the specified
is equal to this instance.
The
to compare with this instance.
true
if the specified
is equal to this instance; otherwise,
false
.
Returns a hash code for this instance.
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Represents a JSON object.
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous load. The
property returns a
that contains the JSON that was read from the specified
.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous load. The
property returns a
that contains the JSON that was read from the specified
.
Gets the container's children tokens.
The container's children tokens.
Occurs when a property value changes.
Occurs when a property value is changing.
Initializes a new instance of the
class.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Initializes a new instance of the
class with the specified content.
The contents of the object.
Initializes a new instance of the
class with the specified content.
The contents of the object.
Gets the node type for this
.
The type.
Gets an
of
of this object's properties.
An
of
of this object's properties.
Gets a
the specified name.
The property name.
A
with the specified name or
null
.
Gets a
of
of this object's property values.
A
of
of this object's property values.
Gets the
with the specified key.
The
with the specified key.
Gets or sets the
with the specified property name.
Loads a
from a
.
A
that will be read for the content of the
.
A
that contains the JSON that was read from the specified
.
is not valid JSON.
Loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the JSON that was read from the specified
.
is not valid JSON.
Load a
from a string that contains JSON.
A
that contains JSON.
A
populated from the string that contains JSON.
is not valid JSON.
Load a
from a string that contains JSON.
A
that contains JSON.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
populated from the string that contains JSON.
is not valid JSON.
Creates a
from an object.
The object that will be used to create
.
A
with the values of the specified object.
Creates a
from an object.
The object that will be used to create
.
The
that will be used to read the object.
A
with the values of the specified object.
Writes this token to a
.
A
into which this method will write.
A collection of
which will be used when writing the token.
Gets the
with the specified property name.
Name of the property.
The
with the specified property name.
Gets the
with the specified property name.The exact property name will be searched for first and if no matching property is found thenthe
will be used to match a property.
Name of the property.
One of the enumeration values that specifies how the strings will be compared.
The
with the specified property name.
Tries to get the
with the specified property name.The exact property name will be searched for first and if no matching property is found thenthe
will be used to match a property.
Name of the property.
The value.
One of the enumeration values that specifies how the strings will be compared.
true
if a value was successfully retrieved; otherwise,
false
.
Adds the specified property name.
Name of the property.
The value.
Removes the property with the specified name.
Name of the property.
true
if item was successfully removed; otherwise,
false
.
Tries to get the
with the specified property name.
Name of the property.
The value.
true
if a value was successfully retrieved; otherwise,
false
.
Returns an enumerator that can be used to iterate through the collection.
A
that can be used to iterate through the collection.
Raises the
event with the provided arguments.
Name of the property.
Raises the
event with the provided arguments.
Name of the property.
Returns the
responsible for binding operations performed on this object.
The expression tree representation of the runtime value.
The
to bind this object.
Represents a JSON property.
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The token to monitor for cancellation requests. The default value is
.
A
representing the asynchronous creation. The
property returns a
that contains the JSON that was read from the specified
.
Asynchronously loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
representing the asynchronous creation. The
property returns a
that contains the JSON that was read from the specified
.
Gets the container's children tokens.
The container's children tokens.
Gets the property name.
The property name.
Gets or sets the property value.
The property value.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Gets the node type for this
.
The type.
Initializes a new instance of the
class.
The property name.
The property content.
Initializes a new instance of the
class.
The property name.
The property content.
Writes this token to a
.
A
into which this method will write.
A collection of
which will be used when writing the token.
Loads a
from a
.
A
that will be read for the content of the
.
A
that contains the JSON that was read from the specified
.
Loads a
from a
.
A
that will be read for the content of the
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the JSON that was read from the specified
.
Represents a raw JSON string.
Asynchronously creates an instance of
with the content of the reader's current token.
The reader.
The token to monitor for cancellation requests. The default value is
.
A
representing the asynchronous creation. The
property returns an instance of
with the content of the reader's current token.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Initializes a new instance of the
class.
The raw json.
Creates an instance of
with the content of the reader's current token.
The reader.
An instance of
with the content of the reader's current token.
Specifies the settings used when merging JSON.
Gets or sets the method used when merging JSON arrays.
The method used when merging JSON arrays.
Gets or sets how null value properties are merged.
How null value properties are merged.
Represents a view of a
.
Initializes a new instance of the
class.
The name.
When overridden in a derived class, returns whether resetting an object changes its value.
true
if resetting the component changes its value; otherwise,
false
.
The component to test for reset capability.
When overridden in a derived class, gets the current value of the property on a component.
The value of a property for a given component.
The component with the property for which to retrieve the value.
When overridden in a derived class, resets the value for this property of the component to the default value.
The component with the property value that is to be reset to the default value.
When overridden in a derived class, sets the value of the component to a different value.
The component with the property value that is to be set.
The new value.
When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.
true
if the property should be persisted; otherwise,
false
.
The component with the property to be examined for persistence.
When overridden in a derived class, gets the type of the component this property is bound to.
A
that represents the type of component this property is bound to.When the
or
methods are invoked, the object specified might be an instance of this type.
When overridden in a derived class, gets a value indicating whether this property is read-only.
true
if the property is read-only; otherwise,
false
.
When overridden in a derived class, gets the type of the property.
A
that represents the type of the property.
Gets the hash code for the name of the member.
The hash code for the name of the member.
Represents an abstract JSON token.
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Writes this token to a
asynchronously.
A
into which this method will write.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Asynchronously creates a
from a
.
An
positioned at the token to read into this
.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous creation. The
property returns a
that containsthe token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Asynchronously creates a
from a
.
An
positioned at the token to read into this
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous creation. The
property returns a
that containsthe token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Asynchronously creates a
from a
.
A
positioned at the token to read into this
.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous creation. The
property returns a
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Asynchronously creates a
from a
.
A
positioned at the token to read into this
.
The
used to load the JSON.If this is
null
, default load settings will be used.
The token to monitor for cancellation requests. The default value is
.
A
that represents the asynchronous creation. The
property returns a
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Gets a comparer that can compare two tokens for value equality.
A
that can compare two nodes for value equality.
Gets or sets the parent.
The parent.
Gets the root
of this
.
The root
of this
.
Gets the node type for this
.
The type.
Gets a value indicating whether this token has child tokens.
true
if this token has child values; otherwise,
false
.
Compares the values of two tokens, including the values of all descendant tokens.
The first
to compare.
The second
to compare.
true
if the tokens are equal; otherwise
false
.
Gets the next sibling token of this node.
The
that contains the next sibling token.
Gets the previous sibling token of this node.
The
that contains the previous sibling token.
Gets the path of the JSON token.
Adds the specified content immediately after this token.
A content object that contains simple content or a collection of content objects to be added after this token.
Adds the specified content immediately before this token.
A content object that contains simple content or a collection of content objects to be added before this token.
Returns a collection of the ancestor tokens of this token.
A collection of the ancestor tokens of this token.
Returns a collection of tokens that contain this token, and the ancestors of this token.
A collection of tokens that contain this token, and the ancestors of this token.
Returns a collection of the sibling tokens after this token, in document order.
A collection of the sibling tokens after this tokens, in document order.
Returns a collection of the sibling tokens before this token, in document order.
A collection of the sibling tokens before this token, in document order.
Gets the
with the specified key.
The
with the specified key.
Gets the
with the specified key converted to the specified type.
The type to convert the token to.
The token key.
The converted token value.
Get the first child token of this token.
A
containing the first child token of the
.
Get the last child token of this token.
A
containing the last child token of the
.
Returns a collection of the child tokens of this token, in document order.
An
of
containing the child tokens of this
, in document order.
Returns a collection of the child tokens of this token, in document order, filtered by the specified type.
The type to filter the child tokens on.
A
containing the child tokens of this
, in document order.
Returns a collection of the child values of this token, in document order.
The type to convert the values to.
A
containing the child values of this
, in document order.
Removes this token from its parent.
Replaces this token with the specified token.
The value.
Writes this token to a
.
A
into which this method will write.
A collection of
which will be used when writing the token.
Returns the indented JSON for this token.
The indented JSON for this token.
Returns the JSON for this token using the given formatting and converters.
Indicates how the output should be formatted.
A collection of
s which will be used when writing the token.
The JSON for this token using the given formatting and converters.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
[].
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
of
.
The value.
The result of the conversion.
Performs an explicit conversion from
to
.
The value.
The result of the conversion.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
[] to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
to
.
The value to create a
from.
The
initialized with the specified value.
Performs an implicit conversion from
of
to
.
The value to create a
from.
The
initialized with the specified value.
Creates a
for this token.
A
that can be used to read this token and its descendants.
Creates a
from an object.
The object that will be used to create
.
A
with the value of the specified object.
Creates a
from an object using the specified
.
The object that will be used to create
.
The
that will be used when reading the object.
A
with the value of the specified object.
Creates an instance of the specified .NET type from the
.
The object type that the token will be deserialized to.
The new object created from the JSON value.
Creates an instance of the specified .NET type from the
.
The object type that the token will be deserialized to.
The new object created from the JSON value.
Creates an instance of the specified .NET type from the
using the specified
.
The object type that the token will be deserialized to.
The
that will be used when creating the object.
The new object created from the JSON value.
Creates an instance of the specified .NET type from the
using the specified
.
The object type that the token will be deserialized to.
The
that will be used when creating the object.
The new object created from the JSON value.
Creates a
from a
.
A
positioned at the token to read into this
.
A
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Creates a
from a
.
An
positioned at the token to read into this
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Load a
from a string that contains JSON.
A
that contains JSON.
A
populated from the string that contains JSON.
Load a
from a string that contains JSON.
A
that contains JSON.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
populated from the string that contains JSON.
Creates a
from a
.
A
positioned at the token to read into this
.
The
used to load the JSON.If this is
null
, default load settings will be used.
A
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Creates a
from a
.
A
positioned at the token to read into this
.
A
that contains the token and its descendant tokensthat were read from the reader. The runtime type of the token is determinedby the token type of the first token encountered in the reader.
Selects a
using a JPath expression. Selects the token that matches the object path.
A
that contains a JPath expression.
A
, or
null
.
Selects a
using a JPath expression. Selects the token that matches the object path.
A
that contains a JPath expression.
A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.
A
.
Selects a collection of elements using a JPath expression.
A
that contains a JPath expression.
An
of
that contains the selected elements.
Selects a collection of elements using a JPath expression.
A
that contains a JPath expression.
A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.
An
of
that contains the selected elements.
Returns the
responsible for binding operations performed on this object.
The expression tree representation of the runtime value.
The
to bind this object.
Returns the
responsible for binding operations performed on this object.
The expression tree representation of the runtime value.
The
to bind this object.
Creates a new instance of the
. All child tokens are recursively cloned.
A new instance of the
.
Adds an object to the annotation list of this
.
The annotation to add.
Get the first annotation object of the specified type from this
.
The type of the annotation to retrieve.
The first annotation object that matches the specified type, or
null
if no annotation is of the specified type.
Gets the first annotation object of the specified type from this
.
The
of the annotation to retrieve.
The first annotation object that matches the specified type, or
null
if no annotation is of the specified type.
Gets a collection of annotations of the specified type for this
.
The type of the annotations to retrieve.
An
that contains the annotations for this
.
Gets a collection of annotations of the specified type for this
.
The
of the annotations to retrieve.
An
of
that contains the annotations that match the specified type for this
.
Removes the annotations of the specified type from this
.
The type of annotations to remove.
Removes the annotations of the specified type from this
.
The
of annotations to remove.
Compares tokens to determine whether they are equal.
Determines whether the specified objects are equal.
The first object of type
to compare.
The second object of type
to compare.
true
if the specified objects are equal; otherwise,
false
.
Returns a hash code for the specified object.
The
for which a hash code is to be returned.
A hash code for the specified object.
The type of
is a reference type and
is
null
.
Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
Gets the
at the reader's current position.
Initializes a new instance of the
class.
The token to read from.
Reads the next JSON token from the underlying
.
true
if the next token was read successfully;
false
if there are no more tokens to read.
Gets the path of the current JSON token.
Specifies the type of token.
No token type has been set.
A JSON object.
A JSON array.
A JSON constructor.
A JSON object property.
A comment.
An integer value.
A float value.
A string value.
A boolean value.
A null value.
An undefined value.
A date value.
A raw JSON value.
A collection of bytes value.
A Guid value.
A Uri value.
A TimeSpan value.
Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
Gets the
at the writer's current position.
Gets the token being written.
The token being written.
Initializes a new instance of the
class writing to the given
.
The container being written to.
Initializes a new instance of the
class.
Flushes whatever is in the buffer to the underlying
.
Closes this writer.If
is set to
true
, the JSON is auto-completed.
Setting
to
true
has no additional effect, since the underlying
is a type that cannot be closed.
Writes the beginning of a JSON object.
Writes the beginning of a JSON array.
Writes the start of a constructor with the given name.
The name of the constructor.
Writes the end.
The token.
Writes the property name of a name/value pair on a JSON object.
The name of the property.
Writes a
value.An error will be raised if the value cannot be written as a single JSON token.
The
value to write.
Writes a null value.
Writes an undefined value.
Writes raw JSON.
The raw JSON to write.
Writes a comment
/*...*/
containing the specified text.
Text to place inside the comment.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
[] value.
The
[] value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Writes a
value.
The
value to write.
Represents a value in JSON (string, integer, date, etc).
Writes this token to a
asynchronously.
A
into which this method will write.
The token to monitor for cancellation requests.
A collection of
which will be used when writing the token.
A
that represents the asynchronous write operation.
Initializes a new instance of the
class from another
object.
A
object to copy from.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Initializes a new instance of the
class with the given value.
The value.
Gets a value indicating whether this token has child tokens.
true
if this token has child values; otherwise,
false
.
Creates a
comment with the given value.
The value.
A
comment with the given value.
Creates a
string with the given value.
The value.
A
string with the given value.
Creates a
null value.
A
null value.
Creates a
undefined value.
A
undefined value.
Gets the node type for this
.
The type.
Gets or sets the underlying token value.
The underlying token value.
Writes this token to a
.
A
into which this method will write.
A collection of
s which will be used when writing the token.
Indicates whether the current object is equal to another object of the same type.
true
if the current object is equal to the
parameter; otherwise,
false
.
An object to compare with this object.
Determines whether the specified
is equal to the current
.
The
to compare with the current
.
true
if the specified
is equal to the current
; otherwise,
false
.
Serves as a hash function for a particular type.
A hash code for the current
.
Returns a
that represents this instance.
A
that represents this instance.
Returns a
that represents this instance.
The format.
A
that represents this instance.
Returns a
that represents this instance.
The format provider.
A
that represents this instance.
Returns a
that represents this instance.
The format.
The format provider.
A
that represents this instance.
Returns the
responsible for binding operations performed on this object.
The expression tree representation of the runtime value.
The
to bind this object.
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
An object to compare with this instance.
A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings:ValueMeaningLess than zeroThis instance is less than
.ZeroThis instance is equal to
.Greater than zeroThis instance is greater than
.
is not of the same type as this instance.
Specifies the settings used when loading JSON.
Initializes a new instance of the
class.
Gets or sets how JSON comments are handled when loading JSON.
The JSON comment handling.
Gets or sets how JSON line info is handled when loading JSON.
The JSON line info handling.
Specifies how JSON arrays are merged together.
Concatenate arrays.
Union arrays, skipping items that already exist.
Replace all array items.
Merge array items together, matched by index.
Specifies how null value properties are merged.
The content's null value properties will be ignored during merging.
The content's null value properties will be merged.
Specifies the member serialization options for the
.
All public members are serialized by default. Members can be excluded using
or
.This is the default member serialization mode.
Only members marked with
or
are serialized.This member serialization mode can also be set by marking the class with
.
All public and private fields are serialized. Members can be excluded using
or
.This member serialization mode can also be set by marking the class with
and setting IgnoreSerializableAttribute on
to
false
.
Specifies metadata property handling options for the
.
Read metadata properties located at the start of a JSON object.
Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance.
Do not try to read metadata properties.
Specifies missing member handling options for the
.
Ignore a missing member and do not attempt to deserialize it.
Throw a
when a missing member is encountered during deserialization.
Specifies null value handling options for the
.
Include null values when serializing and deserializing objects.
Ignore null values when serializing and deserializing objects.
Specifies how object creation is handled by the
.
Reuse existing objects, create new objects when needed.
Only reuse existing objects.
Always create new objects.
Specifies reference handling options for the
.Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement
.
Do not preserve references when serializing types.
Preserve references when serializing into a JSON object structure.
Preserve references when serializing into a JSON array structure.
Preserve references when serializing.
Specifies reference loop handling options for the
.
Throw a
when a loop is encountered.
Ignore loop references and do not serialize.
Serialize loop references.
Indicating whether a property is required.
The property is not required. The default state.
The property must be defined in JSON but can be a null value.
The property must be defined in JSON and cannot be a null value.
The property is not required but it cannot be a null value.
Contains the JSON schema extension methods.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Determines whether the
is valid.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
The source
to test.
The schema to test with.
true
if the specified
is valid; otherwise,
false
.
Determines whether the
is valid.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
The source
to test.
The schema to test with.
When this method returns, contains any error messages generated while validating.
true
if the specified
is valid; otherwise,
false
.
Validates the specified
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
The source
to test.
The schema to test with.
Validates the specified
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
The source
to test.
The schema to test with.
The validation event handler.
An in-memory representation of a JSON Schema.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Gets or sets the id.
Gets or sets the title.
Gets or sets whether the object is required.
Gets or sets whether the object is read-only.
Gets or sets whether the object is visible to users.
Gets or sets whether the object is transient.
Gets or sets the description of the object.
Gets or sets the types of values allowed by the object.
The type.
Gets or sets the pattern.
The pattern.
Gets or sets the minimum length.
The minimum length.
Gets or sets the maximum length.
The maximum length.
Gets or sets a number that the value should be divisible by.
A number that the value should be divisible by.
Gets or sets the minimum.
The minimum.
Gets or sets the maximum.
The maximum.
Gets or sets a flag indicating whether the value can not equal the number defined by the
minimum
attribute (
).
A flag indicating whether the value can not equal the number defined by the
minimum
attribute (
).
Gets or sets a flag indicating whether the value can not equal the number defined by the
maximum
attribute (
).
A flag indicating whether the value can not equal the number defined by the
maximum
attribute (
).
Gets or sets the minimum number of items.
The minimum number of items.
Gets or sets the maximum number of items.
The maximum number of items.
Gets or sets the
of items.
The
of items.
Gets or sets a value indicating whether items in an array are validated using the
instance at their array position from
.
true
if items are validated using their array position; otherwise,
false
.
Gets or sets the
of additional items.
The
of additional items.
Gets or sets a value indicating whether additional items are allowed.
true
if additional items are allowed; otherwise,
false
.
Gets or sets whether the array items must be unique.
Gets or sets the
of properties.
The
of properties.
Gets or sets the
of additional properties.
The
of additional properties.
Gets or sets the pattern properties.
The pattern properties.
Gets or sets a value indicating whether additional properties are allowed.
true
if additional properties are allowed; otherwise,
false
.
Gets or sets the required property if this property is present.
The required property if this property is present.
Gets or sets the a collection of valid enum values allowed.
A collection of valid enum values allowed.
Gets or sets disallowed types.
The disallowed types.
Gets or sets the default value.
The default value.
Gets or sets the collection of
that this schema extends.
The collection of
that this schema extends.
Gets or sets the format.
The format.
Initializes a new instance of the
class.
Reads a
from the specified
.
The
containing the JSON Schema to read.
The
object representing the JSON Schema.
Reads a
from the specified
.
The
containing the JSON Schema to read.
The
to use when resolving schema references.
The
object representing the JSON Schema.
Load a
from a string that contains JSON Schema.
A
that contains JSON Schema.
A
populated from the string that contains JSON Schema.
Load a
from a string that contains JSON Schema using the specified
.
A
that contains JSON Schema.
The resolver.
A
populated from the string that contains JSON Schema.
Writes this schema to a
.
A
into which this method will write.
Writes this schema to a
using the specified
.
A
into which this method will write.
The resolver used.
Returns a
that represents the current
.
A
that represents the current
.
Returns detailed information about the schema exception.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Gets the line number indicating where the error occurred.
The line number indicating where the error occurred.
Gets the line position indicating where the error occurred.
The line position indicating where the error occurred.
Gets the path to the JSON where the error occurred.
The path to the JSON where the error occurred.
Initializes a new instance of the
class.
Initializes a new instance of the
classwith a specified error message.
The error message that explains the reason for the exception.
Initializes a new instance of the
classwith a specified error message and a reference to the inner exception that is the cause of this exception.
The error message that explains the reason for the exception.
The exception that is the cause of the current exception, or
null
if no inner exception is specified.
Initializes a new instance of the
class.
The
that holds the serialized object data about the exception being thrown.
The
that contains contextual information about the source or destination.
The
parameter is
null
.
The class name is
null
or
is zero (0).
Generates a
from a specified
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Gets or sets how undefined schemas are handled by the serializer.
Gets or sets the contract resolver.
The contract resolver.
Generate a
from the specified type.
The type to generate a
from.
A
generated from the specified type.
Generate a
from the specified type.
The type to generate a
from.
The
used to resolve schema references.
A
generated from the specified type.
Generate a
from the specified type.
The type to generate a
from.
Specify whether the generated root
will be nullable.
A
generated from the specified type.
Generate a
from the specified type.
The type to generate a
from.
The
used to resolve schema references.
Specify whether the generated root
will be nullable.
A
generated from the specified type.
Resolves
from an id.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Gets or sets the loaded schemas.
The loaded schemas.
Initializes a new instance of the
class.
Gets a
for the specified reference.
The id.
A
for the specified reference.
The value types allowed by the
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
No type specified.
String type.
Float type.
Integer type.
Boolean type.
Object type.
Array type.
Null type.
Any type.
Specifies undefined schema Id handling options for the
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Do not infer a schema Id.
Use the .NET type name as the schema Id.
Use the assembly qualified .NET type name as the schema Id.
Returns detailed information related to the
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Gets the
associated with the validation error.
The JsonSchemaException associated with the validation error.
Gets the path of the JSON location where the validation error occurred.
The path of the JSON location where the validation error occurred.
Gets the text description corresponding to the validation error.
The text description.
Represents the callback method that will handle JSON schema validation events and the
.
JSON Schema validation has been moved to its own package. See
http://www.newtonsoft.com/jsonschema
for more details.
Allows users to control class loading and mandate what class to load.
When implemented, controls the binding of a serialized object to a type.
Specifies the
name of the serialized object.
Specifies the
name of the serialized object
The type of the object the formatter creates a new instance of.
When implemented, controls the binding of a serialized object to a type.
The type of the object the formatter creates a new instance of.
Specifies the
name of the serialized object.
Specifies the
name of the serialized object.
A snake case naming strategy.
Initializes a new instance of the
class.
A flag indicating whether dictionary keys should be processed.
A flag indicating whether explicitly specified property names should be processed,e.g. a property name customized with a
.
Initializes a new instance of the
class.
A flag indicating whether dictionary keys should be processed.
A flag indicating whether explicitly specified property names should be processed,e.g. a property name customized with a
.
A flag indicating whether extension data names should be processed.
Initializes a new instance of the
class.
Resolves the specified property name.
The property name to resolve.
The resolved property name.
A camel case naming strategy.
Initializes a new instance of the
class.
A flag indicating whether dictionary keys should be processed.
A flag indicating whether explicitly specified property names should be processed,e.g. a property name customized with a
.
Initializes a new instance of the
class.
A flag indicating whether dictionary keys should be processed.
A flag indicating whether explicitly specified property names should be processed,e.g. a property name customized with a
.
A flag indicating whether extension data names should be processed.
Initializes a new instance of the
class.
Resolves the specified property name.
The property name to resolve.
The resolved property name.
Resolves member mappings for a type, camel casing property names.
Initializes a new instance of the
class.
Resolves the contract for a given type.
The type to resolve a contract for.
The contract for a given type.
Used by
to resolve a
for a given
.
Gets a value indicating whether members are being get and set using dynamic code generation.This value is determined by the runtime permissions available.
true
if using dynamic code generation; otherwise,
false
.
Gets or sets the default members search flags.
The default members search flags.
Gets or sets a value indicating whether compiler generated members should be serialized.
true
if serialized compiler generated members; otherwise,
false
.
Gets or sets a value indicating whether to ignore the
interface when serializing and deserializing types.
true
if the
interface will be ignored when serializing and deserializing types; otherwise,
false
.
Gets or sets a value indicating whether to ignore the
attribute when serializing and deserializing types.
true
if the
attribute will be ignored when serializing and deserializing types; otherwise,
false
.
Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized.
The naming strategy used to resolve how property names and dictionary keys are serialized.
Initializes a new instance of the
class.
Resolves the contract for a given type.
The type to resolve a contract for.
The contract for a given type.
Gets the serializable members for the type.
The type to get serializable members for.
The serializable members for the type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates the constructor parameters.
The constructor to create properties for.
The type's member properties.
Properties for the given
.
Creates a
for the given
.
The matching member property.
The constructor parameter.
A created
for the given
.
Resolves the default
for the contract.
Type of the object.
The contract's default
.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Creates a
for the given type.
Type of the object.
A
for the given type.
Determines which contract type is created for the given type.
Type of the object.
A
for the given type.
Creates properties for the given
.
The type to create properties for.
///
The member serialization mode for the type.
Properties for the given
.
Creates the
used by the serializer to get and set values from a member.
The member.
The
used by the serializer to get and set values from a member.
Creates a
for the given
.
The member's parent
.
The member to create a
for.
A created
for the given
.
Resolves the name of the property.
Name of the property.
Resolved name of the property.
Resolves the name of the extension data. By default no changes are made to extension data names.
Name of the extension data.
Resolved name of the extension data.
Resolves the key of the dictionary. By default
is used to resolve dictionary keys.
Key of the dictionary.
Resolved key of the dictionary.
Gets the resolved name of the property.
Name of the property.
Name of the property.
The default naming strategy. Property names and dictionary keys are unchanged.
Resolves the specified property name.
The property name to resolve.
The resolved property name.
The default serialization binder used when resolving and loading classes from type names.
Initializes a new instance of the
class.
When overridden in a derived class, controls the binding of a serialized object to a type.
Specifies the
name of the serialized object.
Specifies the
name of the serialized object.
The type of the object the formatter creates a new instance of.
When overridden in a derived class, controls the binding of a serialized object to a type.
The type of the object the formatter creates a new instance of.
Specifies the
name of the serialized object.
Specifies the
name of the serialized object.
Represents a trace writer that writes to the application's
instances.
Gets the
that will be used to filter the trace messages passed to the writer.For example a filter level of
will exclude
messages and include
,
and
messages.
The
that will be used to filter the trace messages passed to the writer.
Writes the specified trace level, message and optional exception.
The
at which to write this trace.
The trace message.
The trace exception. This parameter is optional.
Get and set values for a
using dynamic methods.
Initializes a new instance of the
class.
The member info.
Sets the value.
The target to set the value on.
The value to set on the target.
Gets the value.
The target to get the value from.
The value.
Provides information surrounding an error.
Gets the error.
The error.
Gets the original object that caused the error.
The original object that caused the error.
Gets the member that caused the error.
The member that caused the error.
Gets the path of the JSON location where the error occurred.
The path of the JSON location where the error occurred.
Gets or sets a value indicating whether this
is handled.
true
if handled; otherwise,
false
.
Provides data for the Error event.
Gets the current object the error event is being raised against.
The current object the error event is being raised against.
Gets the error context.
The error context.
Initializes a new instance of the
class.
The current object.
The error context.
Get and set values for a
using dynamic methods.
Initializes a new instance of the
class.
The member info.
Sets the value.
The target to set the value on.
The value to set on the target.
Gets the value.
The target to get the value from.
The value.
Provides methods to get attributes.
Returns a collection of all of the attributes, or an empty collection if there are no attributes.
When
true
, look up the hierarchy chain for the inherited custom attribute.
A collection of
s, or an empty collection.
Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
The type of the attributes.
When
true
, look up the hierarchy chain for the inherited custom attribute.
A collection of
s, or an empty collection.
Used by
to resolve a
for a given
.
Resolves the contract for a given type.
The type to resolve a contract for.
The contract for a given type.
A base class for resolving how property names and dictionary keys are serialized.
A flag indicating whether dictionary keys should be processed.Defaults to
false
.
A flag indicating whether extension data names should be processed.Defaults to
false
.
A flag indicating whether explicitly specified property names,e.g. a property name customized with a
, should be processed.Defaults to
false
.
Gets the serialized name for a given property name.
The initial property name.
A flag indicating whether the property has had a name explicitly specified.
The serialized property name.
Gets the serialized name for a given extension data name.
The initial extension data name.
The serialized extension data name.
Gets the serialized key for a given dictionary key.
The initial dictionary key.
The serialized dictionary key.
Resolves the specified property name.
The property name to resolve.
The resolved property name.
Used to resolve references when serializing and deserializing JSON by the
.
Resolves a reference to its object.
The serialization context.
The reference to resolve.
The object that was resolved from the reference.
Gets the reference for the specified object.
The serialization context.
The object to get a reference for.
The reference to the object.
Determines whether the specified object is referenced.
The serialization context.
The object to test for a reference.
true
if the specified object is referenced; otherwise,
false
.
Adds a reference to the specified object.
The serialization context.
The reference.
The object to reference.
Represents a trace writer.
Gets the
that will be used to filter the trace messages passed to the writer.For example a filter level of
will exclude
messages and include
,
and
messages.
The
that will be used to filter the trace messages passed to the writer.
Writes the specified trace level, message and optional exception.
The
at which to write this trace.
The trace message.
The trace exception. This parameter is optional.
Provides methods to get and set values.
Sets the value.
The target to set the value on.
The value to set on the target.
Gets the value.
The target to get the value from.
The value.
Contract details for a
used by the
.
Gets the
of the collection items.
The
of the collection items.
Gets a value indicating whether the collection type is a multidimensional array.
true
if the collection type is a multidimensional array; otherwise,
false
.
Gets or sets the function used to create the object. When set this function will override
.
The function used to create the object.
Gets a value indicating whether the creator has a parameter with the collection values.
true
if the creator has a parameter with the collection values; otherwise,
false
.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Gets or sets the default collection items
.
The converter.
Gets or sets a value indicating whether the collection items preserve object references.
true
if collection items preserve object references; otherwise,
false
.
Gets or sets the collection item reference loop handling.
The reference loop handling.
Gets or sets the collection item type name handling.
The type name handling.
Initializes a new instance of the
class.
The underlying type for the contract.
Handles
serialization callback events.
The object that raised the callback event.
The streaming context.
Handles
serialization error callback events.
The object that raised the callback event.
The streaming context.
The error context.
Sets extension data for an object during deserialization.
The object to set extension data on.
The extension data key.
The extension data value.
Gets extension data for an object during serialization.
The object to set extension data on.
Contract details for a
used by the
.
Gets the underlying type for the contract.
The underlying type for the contract.
Gets or sets the type created during deserialization.
The type created during deserialization.
Gets or sets whether this type contract is serialized as a reference.
Whether this type contract is serialized as a reference.
Gets or sets the default
for this contract.
The converter.
Gets or sets all methods called immediately after deserialization of the object.
The methods called immediately after deserialization of the object.
Gets or sets all methods called during deserialization of the object.
The methods called during deserialization of the object.
Gets or sets all methods called after serialization of the object graph.
The methods called after serialization of the object graph.
Gets or sets all methods called before serialization of the object.
The methods called before serialization of the object.
Gets or sets all method called when an error is thrown during the serialization of the object.
The methods called when an error is thrown during the serialization of the object.
Gets or sets the default creator method used to create the object.
The default creator method used to create the object.
Gets or sets a value indicating whether the default creator is non-public.
true
if the default object creator is non-public; otherwise,
false
.
Contract details for a
used by the
.
Gets or sets the dictionary key resolver.
The dictionary key resolver.
Gets the
of the dictionary keys.
The
of the dictionary keys.
Gets the
of the dictionary values.
The
of the dictionary values.
Gets or sets the function used to create the object. When set this function will override
.
The function used to create the object.
Gets a value indicating whether the creator has a parameter with the dictionary values.
true
if the creator has a parameter with the dictionary values; otherwise,
false
.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Gets the object's properties.
The object's properties.
Gets or sets the property name resolver.
The property name resolver.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Gets or sets the
object constructor.
The
object constructor.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Gets or sets the object member serialization.
The member object serialization.
Gets or sets a value that indicates whether the object's properties are required.
A value indicating whether the object's properties are required.
Gets the object's properties.
The object's properties.
Gets a collection of
instances that define the parameters used with
.
Gets or sets the function used to create the object. When set this function will override
.
This function is called with a collection of arguments which are defined by the collection.
The function used to create the object.
Gets or sets the extension data setter.
Gets or sets the extension data getter.
Gets or sets the extension data value type.
Gets or sets the extension data name resolver.
The extension data name resolver.
Initializes a new instance of the
class.
The underlying type for the contract.
Contract details for a
used by the
.
Initializes a new instance of the
class.
The underlying type for the contract.
Maps a JSON property to a .NET member or constructor parameter.
Gets or sets the name of the property.
The name of the property.
Gets or sets the type that declared this property.
The type that declared this property.
Gets or sets the order of serialization of a member.
The numeric order of serialization.
Gets or sets the name of the underlying member or parameter.
The name of the underlying member or parameter.
Gets the
that will get and set the
during serialization.
The
that will get and set the
during serialization.
Gets or sets the
for this property.
The
for this property.
Gets or sets the type of the property.
The type of the property.
Gets or sets the
for the property.If set this converter takes precedence over the contract converter for the property type.
The converter.
Gets or sets the member converter.
The member converter.
Gets or sets a value indicating whether this
is ignored.
true
if ignored; otherwise,
false
.
Gets or sets a value indicating whether this
is readable.
true
if readable; otherwise,
false
.
Gets or sets a value indicating whether this
is writable.
true
if writable; otherwise,
false
.
Gets or sets a value indicating whether this
has a member attribute.
true
if has a member attribute; otherwise,
false
.
Gets the default value.
The default value.
Gets or sets a value indicating whether this
is required.
A value indicating whether this
is required.
Gets or sets a value indicating whether this property preserves object references.
true
if this instance is reference; otherwise,
false
.
Gets or sets the property null value handling.
The null value handling.
Gets or sets the property default value handling.
The default value handling.
Gets or sets the property reference loop handling.
The reference loop handling.
Gets or sets the property object creation handling.
The object creation handling.
Gets or sets or sets the type name handling.
The type name handling.
Gets or sets a predicate used to determine whether the property should be serialized.
A predicate used to determine whether the property should be serialized.
Gets or sets a predicate used to determine whether the property should be deserialized.
A predicate used to determine whether the property should be deserialized.
Gets or sets a predicate used to determine whether the property should be serialized.
A predicate used to determine whether the property should be serialized.
Gets or sets an action used to set whether the property has been deserialized.
An action used to set whether the property has been deserialized.
Returns a
that represents this instance.
A
that represents this instance.
Gets or sets the converter used when serializing the property's collection items.
The collection's items converter.
Gets or sets whether this property's collection items are serialized as a reference.
Whether this property's collection items are serialized as a reference.
Gets or sets the type name handling used when serializing the property's collection items.
The collection's items type name handling.
Gets or sets the reference loop handling used when serializing the property's collection items.
The collection's items reference loop handling.
A collection of
objects.
Initializes a new instance of the
class.
The type.
When implemented in a derived class, extracts the key from the specified element.
The element from which to extract the key.
The key for the specified element.
Adds a
object.
The property to add to the collection.
Gets the closest matching
object.First attempts to get an exact case match of
and thena case insensitive match.
Name of the property.
A matching property if found.
Gets a property by property name.
The name of the property to get.
Type property name string comparison.
A matching property if found.
Contract details for a
used by the
.
Initializes a new instance of the
class.
The underlying type for the contract.
Lookup and create an instance of the
type described by the argument.
The
type to create.
Optional arguments to pass to an initializing constructor of the JsonConverter.If
null
, the default constructor is used.
Represents a trace writer that writes to memory. When the trace message limit isreached then old trace messages will be removed as new messages are added.
Gets the
that will be used to filter the trace messages passed to the writer.For example a filter level of
will exclude
messages and include
,
and
messages.
The
that will be used to filter the trace messages passed to the writer.
Initializes a new instance of the
class.
Writes the specified trace level, message and optional exception.
The
at which to write this trace.
The trace message.
The trace exception. This parameter is optional.
Returns an enumeration of the most recent trace messages.
An enumeration of the most recent trace messages.
Returns a
of the most recent trace messages.
A
of the most recent trace messages.
Represents a method that constructs an object.
The object type to create.
When applied to a method, specifies that the method is called when an error occurs serializing an object.
Provides methods to get attributes from a
,
,
or
.
Initializes a new instance of the
class.
The instance to get attributes for. This parameter should be a
,
,
or
.
Returns a collection of all of the attributes, or an empty collection if there are no attributes.
When
true
, look up the hierarchy chain for the inherited custom attribute.
A collection of
s, or an empty collection.
Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
The type of the attributes.
When
true
, look up the hierarchy chain for the inherited custom attribute.
A collection of
s, or an empty collection.
Get and set values for a
using reflection.
Initializes a new instance of the
class.
The member info.
Sets the value.
The target to set the value on.
The value to set on the target.
Gets the value.
The target to get the value from.
The value.
Indicates the method that will be used during deserialization for locating and loading assemblies.
In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the
LoadWithPartialName
method of the
class is used to load the assembly.
In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The
Load
method of the
class is used to load the assembly.
Specifies how strings are escaped when writing JSON text.
Only control characters (e.g. newline) are escaped.
All non-ASCII and control characters (e.g. newline) are escaped.
HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped.
Specifies type name handling options for the
.
should be used with caution when your application deserializes JSON from an external source.Incoming types should be validated with a custom
when deserializing with a value other than
.
Do not include the .NET type name when serializing types.
Include the .NET type name when serializing into a JSON object structure.
Include the .NET type name when serializing into a JSON array structure.
Always include the .NET type name when serializing.
Include the .NET type name when the type of the object being serialized is not the same as its declared type.Note that this doesn't include the root serialized object by default. To include the root object's type name in JSONyou must specify a root type object with
or
.
Determines whether the collection is
null
or empty.
The collection.
true
if the collection is
null
or empty; otherwise,
false
.
Adds the elements of the specified collection to the specified generic
.
The list to add to.
The collection of elements to add.
Converts the value to the specified type. If the value is unable to be converted, thevalue is checked whether it assignable to the specified type.
The value to convert.
The culture to use when converting.
The type to convert or cast the value to.
The converted type. If conversion was unsuccessful, the initial valueis returned if assignable to the target type.
Helper method for generating a MetaObject which calls aspecific method on Dynamic that returns a result
Helper method for generating a MetaObject which calls aspecific method on Dynamic, but uses one of the arguments forthe result.
Helper method for generating a MetaObject which calls aspecific method on Dynamic, but uses one of the arguments forthe result.
Returns a Restrictions object which includes our current restrictions mergedwith a restriction limiting our type
Gets a dictionary of the names and values of an
type.
Gets a dictionary of the names and values of an Enum type.
The enum type to get names and values for.
Gets the type of the typed collection's items.
The type.
The type of the typed collection's items.
Gets the member's underlying type.
The member.
The underlying type of the member.
Determines whether the member is an indexed property.
The member.
true
if the member is an indexed property; otherwise,
false
.
Determines whether the property is an indexed property.
The property.
true
if the property is an indexed property; otherwise,
false
.
Gets the member's value on the object.
The member.
The target object.
The member's value on the object.
Sets the member's value on the target object.
The member.
The target.
The value.
Determines whether the specified MemberInfo can be read.
The MemberInfo to determine whether can be read.
///
if set to
true
then allow the member to be gotten non-publicly.
true
if the specified MemberInfo can be read; otherwise,
false
.
Determines whether the specified MemberInfo can be set.
The MemberInfo to determine whether can be set.
if set to
true
then allow the member to be set non-publicly.
if set to
true
then allow the member to be set if read-only.
true
if the specified MemberInfo can be set; otherwise,
false
.
Builds a string. Unlike
this class lets you reuse its internal buffer.
Determines whether the string is all white space. Empty string will return
false
.
The string to test whether it is all white space.
true
if the string is all white space; otherwise,
false
.
Specifies the state of the
.
An exception has been thrown, which has left the
in an invalid state.You may call the
method to put the
in the
Closed
state.Any other
method calls result in an
being thrown.
The
method has been called.
An object is being written.
An array is being written.
A constructor is being written.
A property is being written.
A
write method has not been called.
</members>
</doc>Ninject.Common
<?xml version="1.0"?>
-<doc>
-<assembly>
<name>Ninject.Common</name>
</assembly>
-<members>
-<member name="T:Ninject.ActivationException">
<summary>Indicates that an error occured during activation of an instance. </summary>
</member>
-<member name="M:Ninject.ActivationException.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.ActivationException"/>
class.
</summary>
</member>
-<member name="M:Ninject.ActivationException.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.ActivationException"/>
class.
</summary>
<param name="message">The exception message.</param>
</member>
-<member name="M:Ninject.ActivationException.#ctor(System.String,System.Exception)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.ActivationException"/>
class.
</summary>
<param name="message">The exception message.</param>
<param name="innerException">The inner exception.</param>
</member>
-<member name="T:Ninject.Activation.Blocks.IActivationBlock">
<summary>A block used for deterministic disposal of activated instances. When the block isdisposed, all instances activated via it will be deactivated. </summary>
</member>
-<member name="T:Ninject.Syntax.IResolutionRoot">
<summary>Provides a path to resolve instances. </summary>
</member>
-<member name="T:Ninject.Syntax.IFluentSyntax">
-<summary>
A hack to hide methods defined on
<see cref="T:System.Object"/>
for IntelliSenseon fluent interfaces. Credit to Daniel Cazzulino.
</summary>
</member>
-<member name="M:Ninject.Syntax.IFluentSyntax.GetType">
<summary>Gets the type of this instance. </summary>
<returns>The type of this instance.</returns>
</member>
-<member name="M:Ninject.Syntax.IFluentSyntax.GetHashCode">
<summary>Returns a hash code for this instance. </summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns>
</member>
-<member name="M:Ninject.Syntax.IFluentSyntax.ToString">
-<summary>
Returns a
<see cref="T:System.String"/>
that represents this instance.
</summary>
-<returns>
A
<see cref="T:System.String"/>
that represents this instance.
</returns>
</member>
-<member name="M:Ninject.Syntax.IFluentSyntax.Equals(System.Object)">
-<summary>
Determines whether the specified
<see cref="T:System.Object"/>
is equal to this instance.
</summary>
-<param name="other">
The
<see cref="T:System.Object"/>
to compare with this instance.
</param>
-<returns>
<c>true</c>
if the specified
<see cref="T:System.Object"/>
is equal to this instance; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Syntax.IResolutionRoot.CanResolve(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Syntax.IResolutionRoot.CanResolve(Ninject.Activation.IRequest,System.Boolean)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<param name="ignoreImplicitBindings">
if set to
<c>true</c>
implicit bindings are ignored.
</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Syntax.IResolutionRoot.Resolve(Ninject.Activation.IRequest)">
<summary>Resolves instances for the specified request. The instances are not actually resolveduntil a consumer iterates over the enumerator. </summary>
<param name="request">The request to resolve.</param>
<returns>An enumerator of instances that match the request.</returns>
</member>
-<member name="M:Ninject.Syntax.IResolutionRoot.CreateRequest(System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},System.Collections.Generic.IEnumerable{Ninject.Parameters.IParameter},System.Boolean,System.Boolean)">
<summary>Creates a request for the specified service. </summary>
<param name="service">The service that is being requested.</param>
<param name="constraint">The constraint to apply to the bindings to determine if they match the request.</param>
<param name="parameters">The parameters to pass to the resolution.</param>
-<param name="isOptional">
<c>True</c>
if the request is optional; otherwise,
<c>false</c>
.
</param>
-<param name="isUnique">
<c>True</c>
if the request should return a unique result; otherwise,
<c>false</c>
.
</param>
<returns>The created request.</returns>
</member>
-<member name="M:Ninject.Syntax.IResolutionRoot.Release(System.Object)">
<summary>Deactivates and releases the specified instance if it is currently managed by Ninject. </summary>
<param name="instance">The instance to release.</param>
-<returns>
<see langword="True"/>
if the instance was found and released; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="T:Ninject.Infrastructure.Disposal.INotifyWhenDisposed">
<summary>An object that fires an event when it is disposed. </summary>
</member>
-<member name="T:Ninject.Infrastructure.Disposal.IDisposableObject">
<summary>An object that can report whether or not it is disposed. </summary>
</member>
-<member name="P:Ninject.Infrastructure.Disposal.IDisposableObject.IsDisposed">
<summary>Gets a value indicating whether this instance is disposed. </summary>
</member>
-<member name="E:Ninject.Infrastructure.Disposal.INotifyWhenDisposed.Disposed">
<summary>Occurs when the object is disposed. </summary>
</member>
-<member name="T:Ninject.Activation.Caching.IActivationCache">
<summary>Stores the objects that were activated </summary>
</member>
-<member name="T:Ninject.Components.INinjectComponent">
<summary>A component that contributes to the internals of Ninject. </summary>
</member>
-<member name="P:Ninject.Components.INinjectComponent.Settings">
<summary>Gets or sets the settings. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.IActivationCache.Clear">
<summary>Clears the cache. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.IActivationCache.AddActivatedInstance(System.Object)">
<summary>Adds an activated instance. </summary>
<param name="instance">The instance to be added.</param>
</member>
-<member name="M:Ninject.Activation.Caching.IActivationCache.AddDeactivatedInstance(System.Object)">
<summary>Adds an deactivated instance. </summary>
<param name="instance">The instance to be added.</param>
</member>
-<member name="M:Ninject.Activation.Caching.IActivationCache.IsActivated(System.Object)">
<summary>Determines whether the specified instance is activated. </summary>
<param name="instance">The instance.</param>
-<returns>
<c>true</c>
if the specified instance is activated; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.IActivationCache.IsDeactivated(System.Object)">
<summary>Determines whether the specified instance is deactivated. </summary>
<param name="instance">The instance.</param>
-<returns>
<c>true</c>
if the specified instance is deactivated; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="T:Ninject.Activation.Caching.ICache">
<summary>Tracks instances for re-use in certain scopes. </summary>
</member>
-<member name="T:Ninject.Activation.Caching.IPruneable">
<summary>An object that is prunealble. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.IPruneable.Prune">
<summary>Removes instances from the cache which should no longer be re-used. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.ICache.Remember(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Stores the specified instance in the cache. </summary>
<param name="context">The context to store.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ICache.TryGet(Ninject.Activation.IContext)">
<summary>Tries to retrieve an instance to re-use in the specified context. </summary>
<param name="context">The context that is being activated.</param>
-<returns>
The instance for re-use, or
<see langword="null"/>
if none has been stored.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.ICache.Release(System.Object)">
<summary>Deactivates and releases the specified instance from the cache. </summary>
<param name="instance">The instance to release.</param>
-<returns>
<see langword="True"/>
if the instance was found and released; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.ICache.Clear(System.Object)">
<summary>Immediately deactivates and removes all instances in the cache that are owned bythe specified scope. </summary>
<param name="scope">The scope whose instances should be deactivated.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ICache.Clear">
<summary>Immediately deactivates and removes all instances in the cache, regardless of scope. </summary>
</member>
-<member name="P:Ninject.Activation.Caching.ICache.Count">
<summary>Gets the number of entries currently stored in the cache. </summary>
</member>
-<member name="T:Ninject.Activation.Caching.ICachePruner">
-<summary>
Prunes instances from an
<see cref="T:Ninject.Activation.Caching.ICache"/>
based on environmental information.
</summary>
</member>
-<member name="M:Ninject.Activation.Caching.ICachePruner.Start(Ninject.Activation.Caching.IPruneable)">
<summary>Starts pruning the specified cache based on the rules of the pruner. </summary>
<param name="cache">The cache that will be pruned.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ICachePruner.Stop">
<summary>Stops pruning. </summary>
</member>
-<member name="T:Ninject.Activation.IContext">
<summary>Contains information about the activation of a single instance. </summary>
</member>
-<member name="M:Ninject.Activation.IContext.GetProvider">
<summary>Gets the provider that should be used to create the instance for this context. </summary>
<returns>The provider that should be used.</returns>
</member>
-<member name="M:Ninject.Activation.IContext.GetScope">
<summary>Gets the scope for the context that "owns" the instance activated therein. </summary>
<returns>The object that acts as the scope.</returns>
</member>
-<member name="M:Ninject.Activation.IContext.Resolve">
<summary>Resolves this instance for this context. </summary>
<returns>The resolved instance.</returns>
</member>
-<member name="P:Ninject.Activation.IContext.Kernel">
<summary>Gets the kernel that is driving the activation. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.Request">
<summary>Gets the request. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.Binding">
<summary>Gets the binding. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.Plan">
<summary>Gets or sets the activation plan. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.Parameters">
<summary>Gets the parameters that were passed to manipulate the activation process. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.GenericArguments">
<summary>Gets the generic arguments for the request, if any. </summary>
</member>
-<member name="P:Ninject.Activation.IContext.HasInferredGenericArguments">
<summary>Gets a value indicating whether the request involves inferred generic arguments. </summary>
</member>
-<member name="T:Ninject.Activation.InstanceReference">
<summary>Holds an instance during activation or after it has been cached. </summary>
</member>
-<member name="M:Ninject.Activation.InstanceReference.Is``1">
<summary>Returns a value indicating whether the instance is of the specified type. </summary>
<typeparam name="T">The type in question.</typeparam>
-<returns>
<see langword="True"/>
if the instance is of the specified type, otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.Activation.InstanceReference.As``1">
<summary>Returns the instance as the specified type. </summary>
<typeparam name="T">The requested type.</typeparam>
<returns>The instance.</returns>
</member>
-<member name="M:Ninject.Activation.InstanceReference.IfInstanceIs``1(System.Action{``0})">
<summary>Executes the specified action if the instance if of the specified type. </summary>
<typeparam name="T">The type in question.</typeparam>
<param name="action">The action to execute.</param>
</member>
-<member name="P:Ninject.Activation.InstanceReference.Instance">
<summary>Gets or sets the instance. </summary>
</member>
-<member name="T:Ninject.Activation.IPipeline">
<summary>Drives the activation (injection, etc.) of an instance. </summary>
</member>
-<member name="M:Ninject.Activation.IPipeline.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Activates the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="M:Ninject.Activation.IPipeline.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Deactivates the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="P:Ninject.Activation.IPipeline.Strategies">
<summary>Gets the strategies that contribute to the activation and deactivation processes. </summary>
</member>
-<member name="T:Ninject.Activation.IProvider">
<summary>Creates instances of services. </summary>
</member>
-<member name="M:Ninject.Activation.IProvider.Create(Ninject.Activation.IContext)">
<summary>Creates an instance within the specified context. </summary>
<param name="context">The context.</param>
<returns>The created instance.</returns>
</member>
-<member name="P:Ninject.Activation.IProvider.Type">
<summary>Gets the type (or prototype) of instances the provider creates. </summary>
</member>
-<member name="T:Ninject.Activation.IProvider`1">
<summary>Provides instances ot the type T </summary>
<typeparam name="T">The type provides by this implementation.</typeparam>
</member>
-<member name="T:Ninject.Activation.IRequest">
<summary>Describes the request for a service resolution. </summary>
</member>
-<member name="M:Ninject.Activation.IRequest.Matches(Ninject.Planning.Bindings.IBinding)">
<summary>Determines whether the specified binding satisfies the constraint defined on this request. </summary>
<param name="binding">The binding.</param>
-<returns>
<c>True</c>
if the binding satisfies the constraint; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.IRequest.GetScope">
<summary>Gets the scope if one was specified in the request. </summary>
<returns>The object that acts as the scope.</returns>
</member>
-<member name="M:Ninject.Activation.IRequest.CreateChild(System.Type,Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Creates a child request. </summary>
<param name="service">The service that is being requested.</param>
<param name="parentContext">The context in which the request was made.</param>
<param name="target">The target that will receive the injection.</param>
<returns>The child request.</returns>
</member>
-<member name="P:Ninject.Activation.IRequest.Service">
<summary>Gets the service that was requested. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.ParentRequest">
<summary>Gets the parent request. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.ParentContext">
<summary>Gets the parent context. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.Target">
<summary>Gets the target that will receive the injection, if any. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.Constraint">
<summary>Gets the constraint that will be applied to filter the bindings used for the request. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.Parameters">
<summary>Gets the parameters that affect the resolution. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.ActiveBindings">
<summary>Gets the stack of bindings which have been activated by either this request or its ancestors. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.Depth">
<summary>Gets the recursive depth at which this request occurs. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.IsOptional">
<summary>Gets or sets value indicating whether the request is optional. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.IsUnique">
<summary>Gets or sets value indicating whether the request should return a unique result. </summary>
</member>
-<member name="P:Ninject.Activation.IRequest.ForceUnique">
<summary>Gets or sets value indicating whether the request should force to return a unique value even if the request is optional.If this value is set true the request will throw an ActivationException if there are multiple satisfying bingings ratherthan returning null for the request is optional. For none optional requests this parameter does not change anything. </summary>
</member>
-<member name="T:Ninject.Activation.Provider`1">
<summary>A simple abstract provider for instances of a specific type. </summary>
<typeparam name="T">The type of instances the provider creates.</typeparam>
</member>
-<member name="M:Ninject.Activation.Provider`1.Create(Ninject.Activation.IContext)">
<summary>Creates an instance within the specified context. </summary>
<param name="context">The context.</param>
<returns>The created instance.</returns>
</member>
-<member name="M:Ninject.Activation.Provider`1.CreateInstance(Ninject.Activation.IContext)">
<summary>Creates an instance within the specified context. </summary>
<param name="context">The context.</param>
<returns>The created instance.</returns>
</member>
-<member name="P:Ninject.Activation.Provider`1.Type">
<summary>Gets the type (or prototype) of instances the provider creates. </summary>
</member>
-<member name="T:Ninject.Activation.Providers.CallbackProvider`1">
<summary>A provider that delegates to a callback method to create instances. </summary>
<typeparam name="T">The type of instances the provider creates.</typeparam>
</member>
-<member name="M:Ninject.Activation.Providers.CallbackProvider`1.#ctor(System.Func{Ninject.Activation.IContext,`0})">
<summary>Initializes a new instance of the CallbackProvider<T> class. </summary>
<param name="method">The callback method that will be called to create instances.</param>
</member>
-<member name="M:Ninject.Activation.Providers.CallbackProvider`1.CreateInstance(Ninject.Activation.IContext)">
<summary>Invokes the callback method to create an instance. </summary>
<param name="context">The context.</param>
<returns>The created instance.</returns>
</member>
-<member name="P:Ninject.Activation.Providers.CallbackProvider`1.Method">
<summary>Gets the callback method used by the provider. </summary>
</member>
-<member name="T:Ninject.Activation.Providers.ConstantProvider`1">
<summary>A provider that always returns the same constant value. </summary>
<typeparam name="T">The type of value that is returned.</typeparam>
</member>
-<member name="M:Ninject.Activation.Providers.ConstantProvider`1.#ctor(`0)">
<summary>Initializes a new instance of the ConstantProvider<T> class. </summary>
<param name="value">The value that the provider should return.</param>
</member>
-<member name="M:Ninject.Activation.Providers.ConstantProvider`1.CreateInstance(Ninject.Activation.IContext)">
<summary>Creates an instance within the specified context. </summary>
<param name="context">The context.</param>
<returns>The constant value this provider returns.</returns>
</member>
-<member name="P:Ninject.Activation.Providers.ConstantProvider`1.Value">
<summary>Gets the value that the provider will return. </summary>
</member>
-<member name="T:Ninject.Activation.Providers.StandardProvider">
-<summary>
The standard provider for types, which activates instances via a
<see cref="T:Ninject.Activation.IPipeline"/>
.
</summary>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.#ctor(System.Type,Ninject.Planning.IPlanner,Ninject.Selection.Heuristics.IConstructorScorer)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Providers.StandardProvider"/>
class.
</summary>
<param name="type">The type (or prototype) of instances the provider creates.</param>
<param name="planner">The planner component.</param>
<param name="constructorScorer">The constructor scorer component.</param>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.Create(Ninject.Activation.IContext)">
<summary>Creates an instance within the specified context. </summary>
<param name="context">The context.</param>
<returns>The created instance.</returns>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.GetValue(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Gets the value to inject into the specified target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>The value to inject into the specified target.</returns>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.GetImplementationType(System.Type)">
<summary>Gets the implementation type that the provider will activate an instance offor the specified service. </summary>
<param name="service">The service in question.</param>
<returns>The implementation type that will be activated.</returns>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.GetCreationCallback(System.Type)">
-<summary>
Gets a callback that creates an instance of the
<see cref="T:Ninject.Activation.Providers.StandardProvider"/>
for the specified type.
</summary>
<param name="prototype">The prototype the provider instance will create.</param>
<returns>The created callback.</returns>
</member>
-<member name="M:Ninject.Activation.Providers.StandardProvider.GetCreationCallback(System.Type,System.Reflection.ConstructorInfo)">
-<summary>
Gets a callback that creates an instance of the
<see cref="T:Ninject.Activation.Providers.StandardProvider"/>
for the specified type and constructor.
</summary>
<param name="prototype">The prototype the provider instance will create.</param>
<param name="constructor">The constructor.</param>
<returns>The created callback.</returns>
</member>
-<member name="P:Ninject.Activation.Providers.StandardProvider.Type">
<summary>Gets the type (or prototype) of instances the provider creates. </summary>
</member>
-<member name="P:Ninject.Activation.Providers.StandardProvider.Planner">
<summary>Gets or sets the planner component. </summary>
</member>
-<member name="P:Ninject.Activation.Providers.StandardProvider.ConstructorScorer">
<summary>Gets or sets the selector component. </summary>
</member>
-<member name="T:Ninject.Activation.Strategies.IActivationStrategy">
-<summary>
Contributes to a
<see cref="T:Ninject.Activation.IPipeline"/>
, and is called during the activationand deactivation of an instance.
</summary>
</member>
-<member name="M:Ninject.Activation.Strategies.IActivationStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the activation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.IActivationStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the deactivation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="T:Ninject.ConstraintAttribute">
<summary>Defines a constraint on the decorated member. </summary>
</member>
-<member name="M:Ninject.ConstraintAttribute.Matches(Ninject.Planning.Bindings.IBindingMetadata)">
<summary>Determines whether the specified binding metadata matches the constraint. </summary>
<param name="metadata">The metadata in question.</param>
-<returns>
<c>True</c>
if the metadata matches; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="T:Ninject.InjectAttribute">
<summary>Indicates that the decorated member should be injected. </summary>
</member>
-<member name="T:Ninject.NamedAttribute">
<summary>Indicates that the decorated member should only be injected using binding(s) registeredwith the specified name. </summary>
</member>
-<member name="M:Ninject.NamedAttribute.#ctor(System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.NamedAttribute"/>
class.
</summary>
<param name="name">The name of the binding(s) to use.</param>
</member>
-<member name="M:Ninject.NamedAttribute.Matches(Ninject.Planning.Bindings.IBindingMetadata)">
<summary>Determines whether the specified binding metadata matches the constraint. </summary>
<param name="metadata">The metadata in question.</param>
-<returns>
<c>True</c>
if the metadata matches; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="P:Ninject.NamedAttribute.Name">
<summary>Gets the binding name. </summary>
</member>
-<member name="T:Ninject.OptionalAttribute">
<summary>Indicates that the decorated member represents an optional dependency. </summary>
</member>
-<member name="T:Ninject.Components.IComponentContainer">
<summary>An internal container that manages and resolves components that contribute to Ninject. </summary>
</member>
-<member name="M:Ninject.Components.IComponentContainer.Add``2">
<summary>Registers a component in the container. </summary>
<typeparam name="TComponent">The component type.</typeparam>
<typeparam name="TImplementation">The component's implementation type.</typeparam>
</member>
-<member name="M:Ninject.Components.IComponentContainer.RemoveAll``1">
<summary>Removes all registrations for the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
</member>
-<member name="M:Ninject.Components.IComponentContainer.RemoveAll(System.Type)">
<summary>Removes all registrations for the specified component. </summary>
<param name="component">The component's type.</param>
</member>
-<member name="M:Ninject.Components.IComponentContainer.Remove``2">
<summary>Removes the specified registration. </summary>
<typeparam name="T">The component type.</typeparam>
<typeparam name="TImplementation">The implementation type.</typeparam>
</member>
-<member name="M:Ninject.Components.IComponentContainer.Get``1">
<summary>Gets one instance of the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
<returns>The instance of the component.</returns>
</member>
-<member name="M:Ninject.Components.IComponentContainer.GetAll``1">
<summary>Gets all available instances of the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
<returns>A series of instances of the specified component.</returns>
</member>
-<member name="M:Ninject.Components.IComponentContainer.Get(System.Type)">
<summary>Gets one instance of the specified component. </summary>
<param name="component">The component type.</param>
<returns>The instance of the component.</returns>
</member>
-<member name="M:Ninject.Components.IComponentContainer.GetAll(System.Type)">
<summary>Gets all available instances of the specified component. </summary>
<param name="component">The component type.</param>
<returns>A series of instances of the specified component.</returns>
</member>
-<member name="M:Ninject.Components.IComponentContainer.AddTransient``2">
<summary>Registers a transient component in the container. </summary>
<typeparam name="TComponent">The component type.</typeparam>
<typeparam name="TImplementation">The component's implementation type.</typeparam>
</member>
-<member name="P:Ninject.Components.IComponentContainer.Kernel">
<summary>Gets or sets the kernel that owns the component container. </summary>
</member>
-<member name="T:Ninject.Components.NinjectComponent">
<summary>A component that contributes to the internals of Ninject. </summary>
</member>
-<member name="T:Ninject.Infrastructure.Disposal.DisposableObject">
<summary>An object that notifies when it is disposed. </summary>
</member>
-<member name="M:Ninject.Infrastructure.Disposal.DisposableObject.Dispose">
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary>
</member>
-<member name="M:Ninject.Infrastructure.Disposal.DisposableObject.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
</member>
-<member name="M:Ninject.Infrastructure.Disposal.DisposableObject.Finalize">
<summary>Releases resources before the object is reclaimed by garbage collection. </summary>
</member>
-<member name="P:Ninject.Infrastructure.Disposal.DisposableObject.IsDisposed">
<summary>Gets a value indicating whether this instance is disposed. </summary>
</member>
-<member name="P:Ninject.Components.NinjectComponent.Settings">
<summary>Gets or sets the settings. </summary>
</member>
-<member name="T:Ninject.IInitializable">
<summary>A service that requires initialization after it is activated. </summary>
</member>
-<member name="M:Ninject.IInitializable.Initialize">
<summary>Initializes the instance. Called during activation. </summary>
</member>
-<member name="T:Ninject.IKernel">
-<summary>
A super-factory that can create objects of all kinds, following hints provided by
<see cref="T:Ninject.Planning.Bindings.IBinding"/>
s.
</summary>
</member>
-<member name="T:Ninject.Syntax.IBindingRoot">
<summary>Provides a path to register bindings. </summary>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Bind``1">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T">The service to bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Bind``2">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Bind``3">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<typeparam name="T3">The third service to bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Bind``4">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<typeparam name="T3">The third service to bind.</typeparam>
<typeparam name="T4">The fourth service to bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Bind(System.Type[])">
<summary>Declares a binding from the service to itself. </summary>
<param name="services">The services to bind.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Unbind``1">
<summary>Unregisters all bindings for the specified service. </summary>
<typeparam name="T">The service to unbind.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Unbind(System.Type)">
<summary>Unregisters all bindings for the specified service. </summary>
<param name="service">The service to unbind.</param>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Rebind``1">
<summary>Removes any existing bindings for the specified service, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Rebind``2">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Rebind``3">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<typeparam name="T3">The third service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Rebind``4">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<typeparam name="T3">The third service to re-bind.</typeparam>
<typeparam name="T4">The fourth service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.Rebind(System.Type[])">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<param name="services">The services to re-bind.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.AddBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Registers the specified binding. </summary>
<param name="binding">The binding to add.</param>
</member>
-<member name="M:Ninject.Syntax.IBindingRoot.RemoveBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Unregisters the specified binding. </summary>
<param name="binding">The binding to remove.</param>
</member>
-<member name="M:Ninject.IKernel.GetModules">
<summary>Gets the modules that have been loaded into the kernel. </summary>
<returns>A series of loaded modules.</returns>
</member>
-<member name="M:Ninject.IKernel.HasModule(System.String)">
<summary>Determines whether a module with the specified name has been loaded in the kernel. </summary>
<param name="name">The name of the module.</param>
-<returns>
<c>True</c>
if the specified module has been loaded; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.IKernel.Load(System.Collections.Generic.IEnumerable{Ninject.Modules.INinjectModule})">
<summary>Loads the module(s) into the kernel. </summary>
<param name="m">The modules to load.</param>
</member>
-<member name="M:Ninject.IKernel.Load(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads modules from the files that match the specified pattern(s). </summary>
<param name="filePatterns">The file patterns (i.e. "*.dll", "modules/*.rb") to match.</param>
</member>
-<member name="M:Ninject.IKernel.Load(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<summary>Loads modules defined in the specified assemblies. </summary>
<param name="assemblies">The assemblies to search.</param>
</member>
-<member name="M:Ninject.IKernel.Unload(System.String)">
<summary>Unloads the plugin with the specified name. </summary>
<param name="name">The plugin's name.</param>
</member>
-<member name="M:Ninject.IKernel.Inject(System.Object,Ninject.Parameters.IParameter[])">
<summary>Injects the specified existing instance, without managing its lifecycle. </summary>
<param name="instance">The instance to inject.</param>
<param name="parameters">The parameters to pass to the request.</param>
</member>
-<member name="M:Ninject.IKernel.GetBindings(System.Type)">
<summary>Gets the bindings registered for the specified service. </summary>
<param name="service">The service in question.</param>
<returns>A series of bindings that are registered for the service.</returns>
</member>
-<member name="M:Ninject.IKernel.BeginBlock">
<summary>Begins a new activation block, which can be used to deterministically dispose resolved instances. </summary>
<returns>The new activation block.</returns>
</member>
-<member name="P:Ninject.IKernel.Settings">
<summary>Gets the kernel settings. </summary>
</member>
-<member name="P:Ninject.IKernel.Components">
<summary>Gets the component container, which holds components that contribute to Ninject. </summary>
</member>
-<member name="T:Ninject.Infrastructure.IHaveBindingConfiguration">
-<summary>
Indicates the object has a reference to a
<see cref="T:Ninject.Planning.Bindings.IBinding"/>
.
</summary>
</member>
-<member name="P:Ninject.Infrastructure.IHaveBindingConfiguration.BindingConfiguration">
<summary>Gets the binding. </summary>
</member>
-<member name="T:Ninject.Infrastructure.IHaveKernel">
-<summary>
Indicates that the object has a reference to an
<see cref="T:Ninject.IKernel"/>
.
</summary>
</member>
-<member name="P:Ninject.Infrastructure.IHaveKernel.Kernel">
<summary>Gets the kernel. </summary>
</member>
-<member name="T:Ninject.Infrastructure.Introspection.ExceptionFormatter">
<summary>Provides meaningful exception messages. </summary>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.ModulesWithNullOrEmptyNamesAreNotSupported">
<summary>Generates a message saying that modules without names are not supported. </summary>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.TargetDoesNotHaveADefaultValue(Ninject.Planning.Targets.ITarget)">
<summary>Generates a message saying that modules without names are not supported. </summary>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.ModuleWithSameNameIsAlreadyLoaded(Ninject.Modules.INinjectModule,Ninject.Modules.INinjectModule)">
<summary>Generates a message saying that a module with the same name is already loaded. </summary>
<param name="newModule">The new module.</param>
<param name="existingModule">The existing module.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.NoModuleLoadedWithTheSpecifiedName(System.String)">
<summary>Generates a message saying that no module has been loaded with the specified name. </summary>
<param name="name">The module name.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.CouldNotUniquelyResolveBinding(Ninject.Activation.IRequest,System.String[])">
<summary>Generates a message saying that the binding could not be uniquely resolved. </summary>
<param name="request">The request.</param>
<param name="formattedMatchingBindings">The matching bindings, already formatted as strings</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.CouldNotResolveBinding(Ninject.Activation.IRequest)">
<summary>Generates a message saying that the binding could not be resolved on the specified request. </summary>
<param name="request">The request.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.CyclicalDependenciesDetected(Ninject.Activation.IContext)">
<summary>Generates a message saying that the specified context has cyclic dependencies. </summary>
<param name="context">The context.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.InvalidAttributeTypeUsedInBindingCondition(System.String,System.String,System.Type)">
<summary>Generates a message saying that an invalid attribute type is used in the binding condition. </summary>
<param name="serviceNames">The names of the services.</param>
<param name="methodName">Name of the method.</param>
<param name="type">The type.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.NoConstructorsAvailable(Ninject.Activation.IContext)">
<summary>Generates a message saying that no constructors are available on the specified context. </summary>
<param name="context">The context.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.NoConstructorsAvailableForComponent(System.Type,System.Type)">
<summary>Generates a message saying that no constructors are available for the given component. </summary>
<param name="component">The component.</param>
<param name="implementation">The implementation.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.NoSuchComponentRegistered(System.Type)">
<summary>Generates a message saying that the specified component is not registered. </summary>
<param name="component">The component.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.CouldNotResolvePropertyForValueInjection(Ninject.Activation.IRequest,System.String)">
<summary>Generates a message saying that the specified property could not be resolved on the specified request. </summary>
<param name="request">The request.</param>
<param name="propertyName">The property name.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.ProviderReturnedNull(Ninject.Activation.IContext)">
<summary>Generates a message saying that the provider on the specified context returned null. </summary>
<param name="context">The context.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.ConstructorsAmbiguous(Ninject.Activation.IContext,System.Linq.IGrouping{System.Int32,Ninject.Planning.Directives.IConstructorInjectionDirective})">
<summary>Generates a message saying that the constructor is ambiguous. </summary>
<param name="context">The context.</param>
<param name="bestDirectives">The best constructor directives.</param>
<returns>The exception message.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.FormatConstructor(System.Reflection.ConstructorInfo,System.IO.StringWriter)">
<summary>Formats the constructor. </summary>
<param name="constructor">The constructor.</param>
<param name="sw">The string writer.</param>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.ExceptionFormatter.FormatAttribute(System.IO.StringWriter,System.Attribute)">
<summary>Formats the attribute. </summary>
<param name="sw">The string writer.</param>
<param name="attribute">The attribute.</param>
</member>
-<member name="T:Ninject.Infrastructure.Introspection.FormatExtensions">
<summary>Provides extension methods for string formatting </summary>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.FormatExtensions.FormatActivationPath(Ninject.Activation.IRequest)">
<summary>Formats the activation path into a meaningful string representation. </summary>
<param name="request">The request to be formatted.</param>
<returns>The activation path formatted as string.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.FormatExtensions.Format(Ninject.Planning.Bindings.IBinding,Ninject.Activation.IContext)">
<summary>Formats the given binding into a meaningful string representation. </summary>
<param name="binding">The binding to be formatted.</param>
<param name="context">The context.</param>
<returns>The binding formatted as string</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.FormatExtensions.Format(System.Type)">
<summary>Formats the specified type into a meaningful string representation.. </summary>
<param name="type">The type to be formatted.</param>
<returns>The type formatted as string.</returns>
</member>
-<member name="T:Ninject.Infrastructure.Language.ExtensionsForIEnumerableOfT">
<summary>Provides extension methods for see cref="IEnumerable{T}"/> </summary>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForIEnumerableOfT.Map``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
<summary>Executes the given action for each of the elements in the enumerable. </summary>
<typeparam name="T"/>
<param name="series">The series.</param>
<param name="action">The action.</param>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForIEnumerableOfT.ToEnumerable``1(System.Collections.Generic.IEnumerable{``0})">
<summary>Converts the given enumerable type to prevent changed on the type behind. </summary>
<typeparam name="T">The type of the enumerable.</typeparam>
<param name="series">The series.</param>
<returns>The input type as real enumerable not castable to the original type.</returns>
</member>
-<member name="T:Ninject.Infrastructure.Language.ExtensionsForType">
<summary>Extension methods for type </summary>
<remarks/>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForType.GetAllBaseTypes(System.Type)">
<summary>Gets an enumerable containing the given type and all its base types </summary>
<param name="type">The type.</param>
<returns>An enumerable containing the given type and all its base types</returns>
</member>
-<member name="T:Ninject.Infrastructure.Multimap`2">
<summary>A data structure that contains multiple values for a each key. </summary>
<typeparam name="K">The type of key.</typeparam>
<typeparam name="V">The type of value.</typeparam>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.Add(`0,`1)">
<summary>Adds the specified value for the specified key. </summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.Remove(`0,`1)">
<summary>Removes the specified value for the specified key. </summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
-<returns>
<c>True</c>
if such a value existed and was removed; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.RemoveAll(`0)">
<summary>Removes all values for the specified key. </summary>
<param name="key">The key.</param>
-<returns>
<c>True</c>
if any such values existed; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.Clear">
<summary>Removes all values. </summary>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.ContainsKey(`0)">
<summary>Determines whether the multimap contains any values for the specified key. </summary>
<param name="key">The key.</param>
-<returns>
<c>True</c>
if the multimap has one or more values for the specified key; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.ContainsValue(`0,`1)">
<summary>Determines whether the multimap contains the specified value for the specified key. </summary>
<param name="key">The key.</param>
<param name="value">The value.</param>
-<returns>
<c>True</c>
if the multimap contains such a value; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Multimap`2.GetEnumerator">
<summary>Returns an enumerator that iterates through a the multimap. </summary>
-<returns>
An
<see cref="T:System.Collections.IEnumerator"/>
object that can be used to iterate through the multimap.
</returns>
</member>
-<member name="P:Ninject.Infrastructure.Multimap`2.Item(`0)">
<summary>Gets the collection of values stored under the specified key. </summary>
<param name="key">The key.</param>
</member>
-<member name="P:Ninject.Infrastructure.Multimap`2.Keys">
<summary>Gets the collection of keys. </summary>
</member>
-<member name="P:Ninject.Infrastructure.Multimap`2.Values">
<summary>Gets the collection of collections of values. </summary>
</member>
-<member name="T:Ninject.Infrastructure.ReferenceEqualWeakReference">
<summary>Weak reference that can be used in collections. It is equal to theobject it references and has the same hash code. </summary>
</member>
-<member name="M:Ninject.Infrastructure.ReferenceEqualWeakReference.#ctor(System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Infrastructure.ReferenceEqualWeakReference"/>
class.
</summary>
<param name="target">The target.</param>
</member>
-<member name="M:Ninject.Infrastructure.ReferenceEqualWeakReference.#ctor(System.Object,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Infrastructure.ReferenceEqualWeakReference"/>
class.
</summary>
<param name="target">The target.</param>
-<param name="trackResurrection">
if set to
<c>true</c>
[track resurrection].
</param>
</member>
-<member name="M:Ninject.Infrastructure.ReferenceEqualWeakReference.Equals(System.Object)">
-<summary>
Determines whether the specified
<see cref="T:System.Object"/>
is equal to this instance.
</summary>
-<param name="obj">
The
<see cref="T:System.Object"/>
to compare with this instance.
</param>
-<returns>
<c>true</c>
if the specified
<see cref="T:System.Object"/>
is equal to this instance; otherwise,
<c>false</c>
.
</returns>
-<exception cref="T:System.NullReferenceException">
The
<paramref name="obj"/>
parameter is null.
</exception>
</member>
-<member name="M:Ninject.Infrastructure.ReferenceEqualWeakReference.GetHashCode">
<summary>Returns a hash code for this instance. </summary>
<returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. </returns>
</member>
-<member name="T:Ninject.Infrastructure.StandardScopeCallbacks">
<summary>Scope callbacks for standard scopes. </summary>
</member>
-<member name="F:Ninject.Infrastructure.StandardScopeCallbacks.Transient">
<summary>Gets the callback for transient scope. </summary>
</member>
-<member name="F:Ninject.Infrastructure.StandardScopeCallbacks.Singleton">
<summary>Gets the callback for singleton scope. </summary>
</member>
-<member name="F:Ninject.Infrastructure.StandardScopeCallbacks.Thread">
<summary>Gets the callback for thread scope. </summary>
</member>
-<member name="T:Ninject.INinjectSettings">
<summary>Contains configuration options for Ninject. </summary>
</member>
-<member name="M:Ninject.INinjectSettings.Get``1(System.String,``0)">
<summary>Gets the value for the specified key. </summary>
<typeparam name="T">The type of value to return.</typeparam>
<param name="key">The setting's key.</param>
<param name="defaultValue">The value to return if no setting is available.</param>
<returns>The value, or the default value if none was found.</returns>
</member>
-<member name="M:Ninject.INinjectSettings.Set(System.String,System.Object)">
<summary>Sets the value for the specified key. </summary>
<param name="key">The setting's key.</param>
<param name="value">The setting's value.</param>
</member>
-<member name="P:Ninject.INinjectSettings.InjectAttribute">
<summary>Gets the attribute that indicates that a member should be injected. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.CachePruningInterval">
<summary>Gets the interval at which the cache should be pruned. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.DefaultScopeCallback">
<summary>Gets the default scope callback. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.LoadExtensions">
<summary>Gets a value indicating whether the kernel should automatically load extensions at startup. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.ExtensionSearchPatterns">
<summary>Gets the paths that should be searched for extensions. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.UseReflectionBasedInjection">
<summary>Gets a value indicating whether Ninject should use reflection-based injection instead ofthe (usually faster) lightweight code generation system. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.InjectNonPublic">
<summary>Gets a value indicating whether Ninject should inject non public members. </summary>
</member>
-<member name="P:Ninject.INinjectSettings.InjectParentPrivateProperties">
<summary>Gets a value indicating whether Ninject should inject private properties of base classes. </summary>
<remarks>Activating this setting has an impact on the performance. It is recomended notto use this feature and use constructor injection instead. </remarks>
</member>
-<member name="P:Ninject.INinjectSettings.ActivationCacheDisabled">
<summary>Gets or sets a value indicating whether the activation cache is disabled.If the activation cache is disabled less memory is used. But in some casesinstances are activated or deactivated multiple times. e.g. in the following scenario:Bind{A}().ToSelf();Bind{IA}().ToMethod(ctx => kernel.Get{IA}(); </summary>
-<value>
<c>true</c>
if activation cache is disabled; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Ninject.INinjectSettings.AllowNullInjection">
<summary>Gets or sets a value indicating whether Null is a valid value for injection.By defuault this is disabled and whenever a provider returns null an exception is thrown. </summary>
-<value>
<c>true</c>
if null is allowed as injected value otherwise false.
</value>
</member>
-<member name="T:Ninject.Injection.ConstructorInjector">
<summary>A delegate that can inject values into a constructor. </summary>
</member>
-<member name="T:Ninject.Injection.IInjectorFactory">
<summary>Creates injectors from members. </summary>
</member>
-<member name="M:Ninject.Injection.IInjectorFactory.Create(System.Reflection.ConstructorInfo)">
<summary>Gets or creates an injector for the specified constructor. </summary>
<param name="constructor">The constructor.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.IInjectorFactory.Create(System.Reflection.PropertyInfo)">
<summary>Gets or creates an injector for the specified property. </summary>
<param name="property">The property.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.IInjectorFactory.Create(System.Reflection.MethodInfo)">
<summary>Gets or creates an injector for the specified method. </summary>
<param name="method">The method.</param>
<returns>The created injector.</returns>
</member>
-<member name="T:Ninject.Injection.MethodInjector">
<summary>A delegate that can inject values into a method. </summary>
</member>
-<member name="T:Ninject.Injection.PropertyInjector">
<summary>A delegate that can inject values into a property. </summary>
</member>
-<member name="T:Ninject.IStartable">
<summary>A service that is started when activated, and stopped when deactivated. </summary>
</member>
-<member name="M:Ninject.IStartable.Start">
<summary>Starts this instance. Called during activation. </summary>
</member>
-<member name="M:Ninject.IStartable.Stop">
<summary>Stops this instance. Called during deactivation. </summary>
</member>
-<member name="T:Ninject.Modules.INinjectModule">
-<summary>
A pluggable unit that can be loaded into an
<see cref="T:Ninject.IKernel"/>
.
</summary>
</member>
-<member name="M:Ninject.Modules.INinjectModule.OnLoad(Ninject.IKernel)">
<summary>Called when the module is loaded into a kernel. </summary>
<param name="kernel">The kernel that is loading the module.</param>
</member>
-<member name="M:Ninject.Modules.INinjectModule.OnUnload(Ninject.IKernel)">
<summary>Called when the module is unloaded from a kernel. </summary>
<param name="kernel">The kernel that is unloading the module.</param>
</member>
-<member name="M:Ninject.Modules.INinjectModule.OnVerifyRequiredModules">
<summary>Called after loading the modules. A module can verify here if all other required modules are loaded. </summary>
</member>
-<member name="P:Ninject.Modules.INinjectModule.Name">
<summary>Gets the module's name. </summary>
</member>
-<member name="T:Ninject.Modules.NinjectModule">
<summary>A loadable unit that defines bindings for your application. </summary>
</member>
-<member name="T:Ninject.Syntax.BindingRoot">
<summary>Provides a path to register bindings. </summary>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Bind``1">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T">The service to bind.</typeparam>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Bind``2">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Bind``3">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<typeparam name="T3">The third service to bind.</typeparam>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Bind``4">
<summary>Declares a binding for the specified service. </summary>
<typeparam name="T1">The first service to bind.</typeparam>
<typeparam name="T2">The second service to bind.</typeparam>
<typeparam name="T3">The third service to bind.</typeparam>
<typeparam name="T4">The fourth service to bind.</typeparam>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Bind(System.Type[])">
<summary>Declares a binding for the specified service. </summary>
<param name="services">The services to bind.</param>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Unbind``1">
<summary>Unregisters all bindings for the specified service. </summary>
<typeparam name="T">The service to unbind.</typeparam>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Unbind(System.Type)">
<summary>Unregisters all bindings for the specified service. </summary>
<param name="service">The service to unbind.</param>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Rebind``1">
<summary>Removes any existing bindings for the specified service, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Rebind``2">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Rebind``3">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<typeparam name="T3">The third service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Rebind``4">
<summary>Removes any existing bindings for the specified services, and declares a new one. </summary>
<typeparam name="T1">The first service to re-bind.</typeparam>
<typeparam name="T2">The second service to re-bind.</typeparam>
<typeparam name="T3">The third service to re-bind.</typeparam>
<typeparam name="T4">The fourth service to re-bind.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.Rebind(System.Type[])">
<summary>Removes any existing bindings for the specified service, and declares a new one. </summary>
<param name="services">The services to re-bind.</param>
<returns>The fluent syntax</returns>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.AddBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Registers the specified binding. </summary>
<param name="binding">The binding to add.</param>
</member>
-<member name="M:Ninject.Syntax.BindingRoot.RemoveBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Unregisters the specified binding. </summary>
<param name="binding">The binding to remove.</param>
</member>
-<member name="P:Ninject.Syntax.BindingRoot.KernelInstance">
<summary>Gets the kernel. </summary>
<value>The kernel.</value>
</member>
-<member name="M:Ninject.Modules.NinjectModule.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Modules.NinjectModule"/>
class.
</summary>
</member>
-<member name="M:Ninject.Modules.NinjectModule.OnLoad(Ninject.IKernel)">
<summary>Called when the module is loaded into a kernel. </summary>
<param name="kernel">The kernel that is loading the module.</param>
</member>
-<member name="M:Ninject.Modules.NinjectModule.OnUnload(Ninject.IKernel)">
<summary>Called when the module is unloaded from a kernel. </summary>
<param name="kernel">The kernel that is unloading the module.</param>
</member>
-<member name="M:Ninject.Modules.NinjectModule.OnVerifyRequiredModules">
<summary>Called after loading the modules. A module can verify here if all other required modules are loaded. </summary>
</member>
-<member name="M:Ninject.Modules.NinjectModule.Load">
<summary>Loads the module into the kernel. </summary>
</member>
-<member name="M:Ninject.Modules.NinjectModule.Unload">
<summary>Unloads the module from the kernel. </summary>
</member>
-<member name="M:Ninject.Modules.NinjectModule.VerifyRequiredModulesAreLoaded">
<summary>Called after loading the modules. A module can verify here if all other required modules are loaded. </summary>
</member>
-<member name="M:Ninject.Modules.NinjectModule.Unbind(System.Type)">
<summary>Unregisters all bindings for the specified service. </summary>
<param name="service">The service to unbind.</param>
</member>
-<member name="M:Ninject.Modules.NinjectModule.AddBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Registers the specified binding. </summary>
<param name="binding">The binding to add.</param>
</member>
-<member name="M:Ninject.Modules.NinjectModule.RemoveBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Unregisters the specified binding. </summary>
<param name="binding">The binding to remove.</param>
</member>
-<member name="P:Ninject.Modules.NinjectModule.Kernel">
<summary>Gets the kernel that the module is loaded into. </summary>
</member>
-<member name="P:Ninject.Modules.NinjectModule.Name">
<summary>Gets the module's name. Only a single module with a given name can be loaded at one time. </summary>
</member>
-<member name="P:Ninject.Modules.NinjectModule.Bindings">
<summary>Gets the bindings that were registered by the module. </summary>
</member>
-<member name="P:Ninject.Modules.NinjectModule.KernelInstance">
<summary>Gets the kernel. </summary>
<value>The kernel.</value>
</member>
-<member name="T:Ninject.Parameters.ConstructorArgument">
<summary>Overrides the injected value of a constructor argument. </summary>
</member>
-<member name="T:Ninject.Parameters.Parameter">
<summary>Modifies an activation process in some way. </summary>
</member>
-<member name="T:Ninject.Parameters.IParameter">
<summary>Modifies an activation process in some way. </summary>
</member>
-<member name="M:Ninject.Parameters.IParameter.GetValue(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Gets the value for the parameter within the specified context. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>The value for the parameter.</returns>
</member>
-<member name="P:Ninject.Parameters.IParameter.Name">
<summary>Gets the name of the parameter. </summary>
</member>
-<member name="P:Ninject.Parameters.IParameter.ShouldInherit">
<summary>Gets a value indicating whether the parameter should be inherited into child requests. </summary>
</member>
-<member name="M:Ninject.Parameters.Parameter.#ctor(System.String,System.Object,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.Parameter"/>
class.
</summary>
<param name="name">The name of the parameter.</param>
<param name="value">The value of the parameter.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.Parameter.#ctor(System.String,System.Func{Ninject.Activation.IContext,System.Object},System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.Parameter"/>
class.
</summary>
<param name="name">The name of the parameter.</param>
<param name="valueCallback">The callback that will be triggered to get the parameter's value.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.Parameter.#ctor(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object},System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.Parameter"/>
class.
</summary>
<param name="name">The name of the parameter.</param>
<param name="valueCallback">The callback that will be triggered to get the parameter's value.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.Parameter.GetValue(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Gets the value for the parameter within the specified context. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>The value for the parameter.</returns>
</member>
-<member name="M:Ninject.Parameters.Parameter.Equals(System.Object)">
<summary>Determines whether the object equals the specified object. </summary>
<param name="obj">An object to compare with this object.</param>
-<returns>
<c>True</c>
if the objects are equal; otherwise
<c>false</c>
</returns>
</member>
-<member name="M:Ninject.Parameters.Parameter.GetHashCode">
<summary>Serves as a hash function for a particular type. </summary>
<returns>A hash code for the object.</returns>
</member>
-<member name="M:Ninject.Parameters.Parameter.Equals(Ninject.Parameters.IParameter)">
<summary>Indicates whether the current object is equal to another object of the same type. </summary>
<param name="other">An object to compare with this object.</param>
-<returns>
<c>True</c>
if the objects are equal; otherwise
<c>false</c>
</returns>
</member>
-<member name="P:Ninject.Parameters.Parameter.Name">
<summary>Gets the name of the parameter. </summary>
</member>
-<member name="P:Ninject.Parameters.Parameter.ShouldInherit">
<summary>Gets a value indicating whether the parameter should be inherited into child requests. </summary>
</member>
-<member name="P:Ninject.Parameters.Parameter.ValueCallback">
<summary>Gets or sets the callback that will be triggered to get the parameter's value. </summary>
</member>
-<member name="T:Ninject.Parameters.IConstructorArgument">
<summary>Defines the interface for constructor arguments. </summary>
</member>
-<member name="M:Ninject.Parameters.IConstructorArgument.AppliesToTarget(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Determines if the parameter applies to the given target. </summary>
<remarks>Only one parameter may return true. </remarks>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Tre if the parameter applies in the specified context to the specified target.</returns>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value to inject into the property.</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Object,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value to inject into the property.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Func{Ninject.Activation.IContext,System.Object},System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
-<param name="shouldInherit">
if set to
<c>true</c>
[should inherit].
</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.#ctor(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object},System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
-<param name="shouldInherit">
if set to
<c>true</c>
[should inherit].
</param>
</member>
-<member name="M:Ninject.Parameters.ConstructorArgument.AppliesToTarget(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Determines if the parameter applies to the given target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Tre if the parameter applies in the specified context to the specified target. </returns>
<remarks>Only one parameter may return true. </remarks>
</member>
-<member name="T:Ninject.Parameters.IPropertyValue">
<summary>Overrides the injected value of a property. </summary>
</member>
-<member name="T:Ninject.Parameters.PropertyValue">
<summary>Overrides the injected value of a property. </summary>
</member>
-<member name="M:Ninject.Parameters.PropertyValue.#ctor(System.String,System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.PropertyValue"/>
class.
</summary>
<param name="name">The name of the property to override.</param>
<param name="value">The value to inject into the property.</param>
</member>
-<member name="M:Ninject.Parameters.PropertyValue.#ctor(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.PropertyValue"/>
class.
</summary>
<param name="name">The name of the property to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
</member>
-<member name="M:Ninject.Parameters.PropertyValue.#ctor(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.PropertyValue"/>
class.
</summary>
<param name="name">The name of the property to override.</param>
<param name="valueCallback">The callback to invoke to get the value that should be injected.</param>
</member>
-<member name="T:Ninject.Parameters.TypeMatchingConstructorArgument">
<summary>Overrides the injected value of a constructor argument. </summary>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.#ctor(System.Type,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.TypeMatchingConstructorArgument"/>
class.
</summary>
<param name="type">The type of the argument to override.</param>
<param name="valueCallback">The callback that will be triggered to get the parameter's value.</param>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.#ctor(System.Type,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object},System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.TypeMatchingConstructorArgument"/>
class.
</summary>
<param name="type">The type of the argument to override.</param>
<param name="valueCallback">The callback that will be triggered to get the parameter's value.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.AppliesToTarget(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Determines if the parameter applies to the given target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>True if the parameter applies in the specified context to the specified target. </returns>
<remarks>Only one parameter may return true. </remarks>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.GetValue(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Gets the value for the parameter within the specified context. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>The value for the parameter.</returns>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.Equals(Ninject.Parameters.IParameter)">
<summary>Indicates whether the current object is equal to another object of the same type. </summary>
<param name="other">An object to compare with this object.</param>
-<returns>
<c>True</c>
if the objects are equal; otherwise
<c>false</c>
</returns>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.Equals(System.Object)">
<summary>Determines whether the object equals the specified object. </summary>
<param name="obj">An object to compare with this object.</param>
-<returns>
<c>True</c>
if the objects are equal; otherwise
<c>false</c>
</returns>
</member>
-<member name="M:Ninject.Parameters.TypeMatchingConstructorArgument.GetHashCode">
<summary>Serves as a hash function for a particular type. </summary>
<returns>A hash code for the object.</returns>
</member>
-<member name="P:Ninject.Parameters.TypeMatchingConstructorArgument.Name">
<summary>Gets the name of the parameter. </summary>
</member>
-<member name="P:Ninject.Parameters.TypeMatchingConstructorArgument.ShouldInherit">
<summary>Gets a value indicating whether the parameter should be inherited into child requests. </summary>
</member>
-<member name="P:Ninject.Parameters.TypeMatchingConstructorArgument.ValueCallback">
<summary>Gets or sets the callback that will be triggered to get the parameter's value. </summary>
</member>
-<member name="T:Ninject.Parameters.WeakConstructorArgument">
<summary>Overrides the injected value of a constructor argument. </summary>
</member>
-<member name="F:Ninject.Parameters.WeakConstructorArgument.weakReference">
<summary>A weak reference to the constructor argument value. </summary>
</member>
-<member name="M:Ninject.Parameters.WeakConstructorArgument.#ctor(System.String,System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value to inject into the property.</param>
</member>
-<member name="M:Ninject.Parameters.WeakConstructorArgument.#ctor(System.String,System.Object,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.ConstructorArgument"/>
class.
</summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value to inject into the property.</param>
<param name="shouldInherit">Whether the parameter should be inherited into child requests.</param>
</member>
-<member name="M:Ninject.Parameters.WeakConstructorArgument.AppliesToTarget(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Determines if the parameter applies to the given target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Tre if the parameter applies in the specified context to the specified target. </returns>
<remarks>Only one parameter may return true. </remarks>
</member>
-<member name="T:Ninject.Parameters.WeakPropertyValue">
<summary>Overrides the injected value of a property.Keeps a weak reference to the value. </summary>
</member>
-<member name="M:Ninject.Parameters.WeakPropertyValue.#ctor(System.String,System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Parameters.WeakPropertyValue"/>
class.
</summary>
<param name="name">The name of the property to override.</param>
<param name="value">The value to inject into the property.</param>
</member>
-<member name="T:Ninject.Planning.Bindings.Binding">
<summary>Contains information about a service registration. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.IBinding">
<summary>Contains information about a service registration. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.IBindingConfiguration">
<summary>The configuration of a binding. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingConfiguration.GetProvider(Ninject.Activation.IContext)">
<summary>Gets the provider for the binding. </summary>
<param name="context">The context.</param>
<returns>The provider to use.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingConfiguration.GetScope(Ninject.Activation.IContext)">
<summary>Gets the scope for the binding, if any. </summary>
<param name="context">The context.</param>
-<returns>
The object that will act as the scope, or
<see langword="null"/>
if the service is transient.
</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingConfiguration.Matches(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request satisfies the condition defined on the binding,if one was defined. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request satisfies the condition; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.Metadata">
<summary>Gets the binding's metadata. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.Target">
<summary>Gets or sets the type of target for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.IsImplicit">
<summary>Gets or sets a value indicating whether the binding was implicitly registered. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.IsConditional">
<summary>Gets a value indicating whether the binding has a condition associated with it. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.Condition">
<summary>Gets or sets the condition defined for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.ProviderCallback">
<summary>Gets or sets the callback that returns the provider that should be used by the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.ScopeCallback">
<summary>Gets or sets the callback that returns the object that will act as the binding's scope. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.Parameters">
<summary>Gets the parameters defined for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.ActivationActions">
<summary>Gets the actions that should be called after instances are activated via the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingConfiguration.DeactivationActions">
<summary>Gets the actions that should be called before instances are deactivated via the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.IBinding.BindingConfiguration">
<summary>Gets the binding configuration. </summary>
<value>The binding configuration.</value>
</member>
-<member name="P:Ninject.Planning.Bindings.IBinding.Service">
<summary>Gets the service type that is controlled by the binding. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Binding.#ctor(System.Type)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.Binding"/>
class.
</summary>
<param name="service">The service that is controlled by the binding.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.Binding.#ctor(System.Type,Ninject.Planning.Bindings.IBindingConfiguration)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.Binding"/>
class.
</summary>
<param name="service">The service that is controlled by the binding.</param>
<param name="configuration">The binding configuration.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.Binding.GetProvider(Ninject.Activation.IContext)">
<summary>Gets the provider for the binding. </summary>
<param name="context">The context.</param>
<returns>The provider to use.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.Binding.GetScope(Ninject.Activation.IContext)">
<summary>Gets the scope for the binding, if any. </summary>
<param name="context">The context.</param>
-<returns>
The object that will act as the scope, or
<see langword="null"/>
if the service is transient.
</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.Binding.Matches(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request satisfies the condition defined on the binding,if one was defined. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request satisfies the condition; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.BindingConfiguration">
<summary>Gets or sets the binding configuration. </summary>
<value>The binding configuration.</value>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.Service">
<summary>Gets the service type that is controlled by the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.Metadata">
<summary>Gets the binding's metadata. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.Target">
<summary>Gets or sets the type of target for the binding. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.IsImplicit">
<summary>Gets or sets a value indicating whether the binding was implicitly registered. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.IsConditional">
<summary>Gets a value indicating whether the binding has a condition associated with it. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.Condition">
<summary>Gets or sets the condition defined for the binding. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.ProviderCallback">
<summary>Gets or sets the callback that returns the provider that should be used by the binding. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.ScopeCallback">
<summary>Gets or sets the callback that returns the object that will act as the binding's scope. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.Parameters">
<summary>Gets the parameters defined for the binding. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.ActivationActions">
<summary>Gets the actions that should be called after instances are activated via the binding. </summary>
<value/>
</member>
-<member name="P:Ninject.Planning.Bindings.Binding.DeactivationActions">
<summary>Gets the actions that should be called before instances are deactivated via the binding. </summary>
<value/>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingBuilder.BindingConfiguration"/>
.
</summary>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.#ctor(Ninject.Planning.Bindings.IBindingConfiguration,Ninject.IKernel,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder"/>
class.
</summary>
<param name="bindingConfiguration">The binding to build.</param>
<param name="kernel">The kernel.</param>
<param name="serviceNames">The names of the services.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalTo``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalTo``1(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="T">The type of the returned syntax.</typeparam>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalToConfiguration``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.ToProviderInternal``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.ToProviderInternal``1(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="T">The type of the returned fleunt syntax</typeparam>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.InternalToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.AddConstructorArguments(System.Linq.Expressions.NewExpression,System.Linq.Expressions.ParameterExpression)">
<summary>Adds the constructor arguments for the specified constructor expression. </summary>
<param name="ctorExpression">The ctor expression.</param>
<param name="constructorArgumentSyntaxParameterExpression">The constructor argument syntax parameter expression.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.AddConstructorArgument(System.Linq.Expressions.Expression,System.String,System.Linq.Expressions.ParameterExpression)">
<summary>Adds a constructor argument for the specified argument expression. </summary>
<param name="argument">The argument.</param>
<param name="argumentName">Name of the argument.</param>
<param name="constructorArgumentSyntaxParameterExpression">The constructor argument syntax parameter expression.</param>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingBuilder.BindingConfiguration">
<summary>Gets the binding being built. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingBuilder.Kernel">
<summary>Gets the kernel. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingBuilder.ServiceNames">
<summary>Gets the names of the services. </summary>
<value>The names of the services.</value>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder.ConstructorArgumentSyntax">
<summary>Passed to ToConstructor to specify that a constructor value is Injected. </summary>
</member>
-<member name="T:Ninject.Syntax.IConstructorArgumentSyntax">
<summary>Passed to ToConstructor to specify that a constructor value is Injected. </summary>
</member>
-<member name="M:Ninject.Syntax.IConstructorArgumentSyntax.Inject``1">
<summary>Specifies that the argument is injected. </summary>
<typeparam name="T">The type of the parameter</typeparam>
<returns>Not used. This interface has no implementation.</returns>
</member>
-<member name="P:Ninject.Syntax.IConstructorArgumentSyntax.Context">
<summary>Gets the context. </summary>
<value>The context.</value>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.ConstructorArgumentSyntax.#ctor(Ninject.Activation.IContext)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder.ConstructorArgumentSyntax"/>
class.
</summary>
<param name="context">The context.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder.ConstructorArgumentSyntax.Inject``1">
<summary>Specifies that the argument is injected. </summary>
<typeparam name="T1">The type of the parameter</typeparam>
<returns>Not used. This interface has no implementation.</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingBuilder.ConstructorArgumentSyntax.Context">
<summary>Gets the context. </summary>
<value>The context.</value>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder`4">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingBuilder.BindingConfiguration"/>
.
</summary>
<typeparam name="T1">The first service type.</typeparam>
<typeparam name="T2">The second service type.</typeparam>
<typeparam name="T3">The third service type.</typeparam>
<typeparam name="T4">The fourth service type.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingToSyntax`4">
<summary>Used to define the target of a binding. </summary>
<typeparam name="T1">The first service type to be bound.</typeparam>
<typeparam name="T2">The second service type to be bound.</typeparam>
<typeparam name="T3">The third service type to be bound.</typeparam>
<typeparam name="T4">The fourth service type to be bound.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingSyntax">
<summary>Used to define a basic binding syntax builder. </summary>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`4.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.#ctor(Ninject.Planning.Bindings.IBindingConfiguration,Ninject.IKernel,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder`4"/>
class.
</summary>
<param name="bindingConfigurationConfiguration">The binding to build.</param>
<param name="kernel">The kernel.</param>
<param name="serviceNames">The names of the services.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`4.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder`3">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingBuilder.BindingConfiguration"/>
.
</summary>
<typeparam name="T1">The first service type.</typeparam>
<typeparam name="T2">The second service type.</typeparam>
<typeparam name="T3">The third service type.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingToSyntax`3">
<summary>Used to define the target of a binding. </summary>
<typeparam name="T1">The first service type to be bound.</typeparam>
<typeparam name="T2">The second service type to be bound.</typeparam>
<typeparam name="T3">The third service type to be bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`3.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.#ctor(Ninject.Planning.Bindings.IBindingConfiguration,Ninject.IKernel,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder`3"/>
class.
</summary>
<param name="bindingConfigurationConfiguration">The binding to build.</param>
<param name="kernel">The kernel.</param>
<param name="serviceNames">The names of the services.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`3.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder`2">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingBuilder.BindingConfiguration"/>
.
</summary>
<typeparam name="T1">The first service type.</typeparam>
<typeparam name="T2">The second service type.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingToSyntax`2">
<summary>Used to define the target of a binding. </summary>
<typeparam name="T1">The first service type to be bound.</typeparam>
<typeparam name="T2">The second service type to be bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`2.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.#ctor(Ninject.Planning.Bindings.IBindingConfiguration,Ninject.IKernel,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder`2"/>
class.
</summary>
<param name="bindingConfigurationConfiguration">The binding to build.</param>
<param name="kernel">The kernel.</param>
<param name="serviceNames">The names of the services.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToProvider``2">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`2.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingBuilder`1">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingBuilder`1.Binding"/>
.
</summary>
<typeparam name="T1">The service type.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingToSyntax`1">
<summary>Used to define the target of a binding. </summary>
<typeparam name="T1">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToSelf">
<summary>Indicates that the service should be self-bound. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToMethod(System.Func{Ninject.Activation.IContext,`0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingToSyntax`1.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the specified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.#ctor(Ninject.Planning.Bindings.IBinding,Ninject.IKernel,System.String)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingBuilder`1"/>
class.
</summary>
<param name="binding">The binding to build.</param>
<param name="kernel">The kernel.</param>
<param name="serviceNames">The names of the services.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToSelf">
<summary>Indicates that the service should be self-bound. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.To``1">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<typeparam name="TImplementation">The implementation type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.To(System.Type)">
<summary>Indicates that the service should be bound to the specified implementation type. </summary>
<param name="implementation">The implementation type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToConstructor``1(System.Linq.Expressions.Expression{System.Func{Ninject.Syntax.IConstructorArgumentSyntax,``0}})">
<summary>Indicates that the service should be bound to the speecified constructor. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="newExpression">The expression that specifies the constructor.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToProvider``1">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<typeparam name="TProvider">The type of provider to activate.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToProvider(System.Type)">
<summary>Indicates that the service should be bound to an instance of the specified provider type.The instance will be activated via the kernel when an instance of the service is activated. </summary>
<param name="providerType">The type of provider to activate.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToProvider``1(Ninject.Activation.IProvider{``0})">
<summary>Indicates that the service should be bound to the specified provider. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="provider">The provider.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToMethod(System.Func{Ninject.Activation.IContext,`0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToMethod``1(System.Func{Ninject.Activation.IContext,``0})">
<summary>Indicates that the service should be bound to the specified callback method. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="method">The method.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingBuilder`1.ToConstant``1(``0)">
<summary>Indicates that the service should be bound to the specified constant value. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="value">The constant value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingBuilder`1.Binding">
<summary>Gets the binding being built. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingConfiguration">
<summary>The configuration of a binding. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfiguration.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Bindings.BindingConfiguration"/>
class.
</summary>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfiguration.GetProvider(Ninject.Activation.IContext)">
<summary>Gets the provider for the binding. </summary>
<param name="context">The context.</param>
<returns>The provider to use.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfiguration.GetScope(Ninject.Activation.IContext)">
<summary>Gets the scope for the binding, if any. </summary>
<param name="context">The context.</param>
-<returns>
The object that will act as the scope, or
<see langword="null"/>
if the service is transient.
</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfiguration.Matches(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request satisfies the conditions defined on this binding. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request satisfies the conditions; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.Metadata">
<summary>Gets the binding's metadata. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.IsImplicit">
<summary>Gets or sets a value indicating whether the binding was implicitly registered. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.IsConditional">
<summary>Gets a value indicating whether the binding has a condition associated with it. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.Target">
<summary>Gets or sets the type of target for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.Condition">
<summary>Gets or sets the condition defined for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.ProviderCallback">
<summary>Gets or sets the callback that returns the provider that should be used by the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.ScopeCallback">
<summary>Gets or sets the callback that returns the object that will act as the binding's scope. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.Parameters">
<summary>Gets the parameters defined for the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.ActivationActions">
<summary>Gets the actions that should be called after instances are activated via the binding. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfiguration.DeactivationActions">
<summary>Gets the actions that should be called before instances are deactivated via the binding. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingConfigurationBuilder`1">
-<summary>
Provides a root for the fluent syntax associated with an
<see cref="P:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.BindingConfiguration"/>
.
</summary>
<typeparam name="T">The implementation type of the built binding.</typeparam>
</member>
-<member name="T:Ninject.Planning.Bindings.IBindingConfigurationSyntax`1">
<summary>The syntax to define bindings. </summary>
<typeparam name="T">The type of the service.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingWhenInNamedWithOrOnSyntax`1">
<summary>Used to set the condition, scope, name, or add additional information or actions to a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingWhenSyntax`1">
<summary>Used to define the conditions under which a binding should be used. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.When(System.Func{Ninject.Activation.IRequest,System.Boolean})">
<summary>Indicates that the binding should be used only for requests that support the specified condition. </summary>
<param name="condition">The condition.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedInto``1">
<summary>Indicates that the binding should be used only for injections on the specified type.Types that derive from the specified type are considered as valid targets. </summary>
<typeparam name="TParent">The type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedInto(System.Type)">
<summary>Indicates that the binding should be used only for injections on the specified type.Types that derive from the specified type are considered as valid targets. </summary>
<param name="parent">The type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedInto(System.Type[])">
<summary>Indicates that the binding should be used only for injections on the specified types.Types that derive from one of the specified types are considered as valid targets.Should match at lease one of the targets. </summary>
<param name="parents">The types to match.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedExactlyInto``1">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match exactly the specified type. Types that derive from the specified typewill not be considered as valid target. </summary>
<typeparam name="TParent">The type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedExactlyInto(System.Type)">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match exactly the specified type. Types that derive from the specified typewill not be considered as valid target. </summary>
<param name="parent">The type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenInjectedExactlyInto(System.Type[])">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match one of the specified types exactly. Types that derive from one of the specified typeswill not be considered as valid target.Should match at least one of the specified targets </summary>
<param name="parents">The types.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenClassHas``1">
<summary>Indicates that the binding should be used only when the class being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenMemberHas``1">
<summary>Indicates that the binding should be used only when the member being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenTargetHas``1">
<summary>Indicates that the binding should be used only when the target being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenClassHas(System.Type)">
<summary>Indicates that the binding should be used only when the class being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenMemberHas(System.Type)">
<summary>Indicates that the binding should be used only when the member being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenTargetHas(System.Type)">
<summary>Indicates that the binding should be used only when the target being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenParentNamed(System.String)">
<summary>Indicates that the binding should be used only when the service is being requestedby a service bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenAnyAnchestorNamed(System.String)">
<summary>Indicates that the binding should be used only when any ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenAnyAncestorNamed(System.String)">
<summary>Indicates that the binding should be used only when any ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenNoAncestorNamed(System.String)">
<summary>Indicates that the binding should be used only when no ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenAnyAncestorMatches(System.Predicate{Ninject.Activation.IContext})">
<summary>Indicates that the binding should be used only when any ancestor matches the specified predicate. </summary>
<param name="predicate">The predicate to match.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWhenSyntax`1.WhenNoAncestorMatches(System.Predicate{Ninject.Activation.IContext})">
<summary>Indicates that the binding should be used only when no ancestor matches the specified predicate. </summary>
<param name="predicate">The predicate to match.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Syntax.IBindingInSyntax`1">
<summary>Used to define the scope in which instances activated via a binding should be re-used. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingInSyntax`1.InSingletonScope">
<summary>Indicates that only a single instance of the binding should be created, and thenshould be re-used for all subsequent requests. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingInSyntax`1.InTransientScope">
<summary>Indicates that instances activated via the binding should not be re-used, nor havetheir lifecycle managed by Ninject. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingInSyntax`1.InThreadScope">
<summary>Indicates that instances activated via the binding should be re-used within the same thread. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingInSyntax`1.InScope(System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that instances activated via the binding should be re-used as long as the objectreturned by the provided callback remains alive (that is, has not been garbage collected). </summary>
<param name="scope">The callback that returns the scope.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Syntax.IBindingNamedSyntax`1">
<summary>Used to define the name of a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingNamedSyntax`1.Named(System.String)">
<summary>Indicates that the binding should be registered with the specified name. Names are notnecessarily unique; multiple bindings for a given service may be registered with the same name. </summary>
<param name="name">The name to give the binding.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Syntax.IBindingWithSyntax`1">
<summary>Used to add additional information to a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.String,System.Object)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument``1(``0)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<typeparam name="TValue">Specifies the argument type to override.</typeparam>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.Type,System.Object)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.Type,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithConstructorArgument(System.Type,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithPropertyValue(System.String,System.Object)">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="value">The value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithPropertyValue(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="callback">The callback to invoke to get the value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithPropertyValue(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="callback">The callback to invoke to get the value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithParameter(Ninject.Parameters.IParameter)">
<summary>Adds a custom parameter to the binding. </summary>
<param name="parameter">The parameter.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingWithSyntax`1.WithMetadata(System.String,System.Object)">
<summary>Sets the value of a piece of metadata on the binding. </summary>
<param name="key">The metadata key.</param>
<param name="value">The metadata value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Syntax.IBindingOnSyntax`1">
<summary>Used to add additional actions to be performed during activation or deactivation of instances via a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnActivation(System.Action{`0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnActivation``1(System.Action{``0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnActivation(System.Action{Ninject.Activation.IContext,`0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnActivation``1(System.Action{Ninject.Activation.IContext,``0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnDeactivation(System.Action{`0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnDeactivation``1(System.Action{``0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnDeactivation(System.Action{Ninject.Activation.IContext,`0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Syntax.IBindingOnSyntax`1.OnDeactivation``1(System.Action{Ninject.Activation.IContext,``0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="T:Ninject.Syntax.IBindingInNamedWithOrOnSyntax`1">
<summary>Used to set the scope, name, or add additional information or actions to a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingNamedWithOrOnSyntax`1">
<summary>Used to set the name, or add additional information or actions to a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="T:Ninject.Syntax.IBindingWithOrOnSyntax`1">
<summary>Used to add additional information or actions to a binding. </summary>
<typeparam name="T">The service being bound.</typeparam>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.serviceNames">
<summary>The names of the services added to the exceptions. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.#ctor(Ninject.Planning.Bindings.IBindingConfiguration,System.String,Ninject.IKernel)">
<summary>Initializes a new instance of the BindingBuilder<T> class. </summary>
<param name="bindingConfiguration">The binding configuration to build.</param>
<param name="serviceNames">The names of the configured services.</param>
<param name="kernel">The kernel.</param>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.When(System.Func{Ninject.Activation.IRequest,System.Boolean})">
<summary>Indicates that the binding should be used only for requests that support the specified condition. </summary>
<param name="condition">The condition.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedInto``1">
<summary>Indicates that the binding should be used only for injections on the specified type.Types that derive from the specified type are considered as valid targets. </summary>
<typeparam name="TParent">The type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedInto(System.Type)">
<summary>Indicates that the binding should be used only for injections on the specified type.Types that derive from the specified type are considered as valid targets. </summary>
<param name="parent">The type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedInto(System.Type[])">
<summary>Indicates that the binding should be used only for injections on the specified type.Types that derive from the specified type are considered as valid targets. </summary>
<param name="parents">The type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedExactlyInto``1">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match exactly the specified type. Types that derive from the specified typewill not be considered as valid target. </summary>
<typeparam name="TParent">The type.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedExactlyInto(System.Type)">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match exactly the specified type. Types that derive from the specified typewill not be considered as valid target. </summary>
<param name="parent">The type.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenInjectedExactlyInto(System.Type[])">
<summary>Indicates that the binding should be used only for injections on the specified type.The type must match exactly the specified type. Types that derive from the specified typewill not be considered as valid target.Should match at least one of the specified targets </summary>
<param name="parents">The types.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenClassHas``1">
<summary>Indicates that the binding should be used only when the class being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenMemberHas``1">
<summary>Indicates that the binding should be used only when the member being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenTargetHas``1">
<summary>Indicates that the binding should be used only when the target being injected hasan attribute of the specified type. </summary>
<typeparam name="TAttribute">The type of attribute.</typeparam>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenClassHas(System.Type)">
<summary>Indicates that the binding should be used only when the class being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenMemberHas(System.Type)">
<summary>Indicates that the binding should be used only when the member being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenTargetHas(System.Type)">
<summary>Indicates that the binding should be used only when the target being injected hasan attribute of the specified type. </summary>
<param name="attributeType">The type of attribute.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenParentNamed(System.String)">
<summary>Indicates that the binding should be used only when the service is being requestedby a service bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenAnyAnchestorNamed(System.String)">
<summary>Indicates that the binding should be used only when any ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenAnyAncestorNamed(System.String)">
<summary>Indicates that the binding should be used only when any ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenNoAncestorNamed(System.String)">
<summary>Indicates that the binding should be used only when no ancestor is bound with the specified name. </summary>
<param name="name">The name to expect.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenAnyAncestorMatches(System.Predicate{Ninject.Activation.IContext})">
<summary>Indicates that the binding should be used only when any ancestor matches the specified predicate. </summary>
<param name="predicate">The predicate to match.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WhenNoAncestorMatches(System.Predicate{Ninject.Activation.IContext})">
<summary>Indicates that the binding should be used only when no ancestor matches the specified predicate. </summary>
<param name="predicate">The predicate to match.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.Named(System.String)">
<summary>Indicates that the binding should be registered with the specified name. Names are notnecessarily unique; multiple bindings for a given service may be registered with the same name. </summary>
<param name="name">The name to give the binding.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.InSingletonScope">
<summary>Indicates that only a single instance of the binding should be created, and thenshould be re-used for all subsequent requests. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.InTransientScope">
<summary>Indicates that instances activated via the binding should not be re-used, nor havetheir lifecycle managed by Ninject. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.InThreadScope">
<summary>Indicates that instances activated via the binding should be re-used within the same thread. </summary>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.InScope(System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that instances activated via the binding should be re-used as long as the objectreturned by the provided callback remains alive (that is, has not been garbage collected). </summary>
<param name="scope">The callback that returns the scope.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.String,System.Object)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="name">The name of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument``1(``0)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<typeparam name="TValue">Specifies the argument type to override.</typeparam>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.Type,System.Object)">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="value">The value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.Type,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithConstructorArgument(System.Type,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified constructor argument should be overridden with the specified value. </summary>
<param name="type">The type of the argument to override.</param>
<param name="callback">The callback to invoke to get the value for the argument.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithPropertyValue(System.String,System.Object)">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="value">The value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithPropertyValue(System.String,System.Func{Ninject.Activation.IContext,System.Object})">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="callback">The callback to invoke to get the value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithPropertyValue(System.String,System.Func{Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Object})">
<summary>Indicates that the specified property should be injected with the specified value. </summary>
<param name="name">The name of the property to override.</param>
<param name="callback">The callback to invoke to get the value for the property.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithParameter(Ninject.Parameters.IParameter)">
<summary>Adds a custom parameter to the binding. </summary>
<param name="parameter">The parameter.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.WithMetadata(System.String,System.Object)">
<summary>Sets the value of a piece of metadata on the binding. </summary>
<param name="key">The metadata key.</param>
<param name="value">The metadata value.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnActivation(System.Action{`0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnActivation``1(System.Action{``0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnActivation(System.Action{Ninject.Activation.IContext,`0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnActivation``1(System.Action{Ninject.Activation.IContext,``0})">
<summary>Indicates that the specified callback should be invoked when instances are activated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnDeactivation(System.Action{`0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnDeactivation``1(System.Action{``0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnDeactivation(System.Action{Ninject.Activation.IContext,`0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.OnDeactivation``1(System.Action{Ninject.Activation.IContext,``0})">
<summary>Indicates that the specified callback should be invoked when instances are deactivated. </summary>
<typeparam name="TImplementation">The type of the implementation.</typeparam>
<param name="action">The action callback.</param>
<returns>The fluent syntax.</returns>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.BindingConfiguration">
<summary>Gets the binding being built. </summary>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingConfigurationBuilder`1.Kernel">
<summary>Gets the kernel. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingMetadata">
<summary>Additional information available about a binding, which can be used in constraintsto select bindings to use in activation. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.IBindingMetadata">
<summary>Additional information available about a binding, which can be used in constraintsto select bindings to use in activation. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingMetadata.Has(System.String)">
<summary>Determines whether a piece of metadata with the specified key has been defined. </summary>
<param name="key">The metadata key.</param>
-<returns>
<c>True</c>
if such a piece of metadata exists; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingMetadata.Get``1(System.String)">
<summary>Gets the value of metadata defined with the specified key, cast to the specified type. </summary>
<typeparam name="T">The type of value to expect.</typeparam>
<param name="key">The metadata key.</param>
<returns>The metadata value.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingMetadata.Get``1(System.String,``0)">
<summary>Gets the value of metadata defined with the specified key. </summary>
<param name="key">The metadata key.</param>
<param name="defaultValue">The value to return if the binding has no metadata set with the specified key.</param>
<returns>The metadata value, or the default value if none was set.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.IBindingMetadata.Set(System.String,System.Object)">
<summary>Sets the value of a piece of metadata. </summary>
<param name="key">The metadata key.</param>
<param name="value">The metadata value.</param>
</member>
-<member name="P:Ninject.Planning.Bindings.IBindingMetadata.Name">
<summary>Gets or sets the binding's name. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingMetadata.Has(System.String)">
<summary>Determines whether a piece of metadata with the specified key has been defined. </summary>
<param name="key">The metadata key.</param>
-<returns>
<c>True</c>
if such a piece of metadata exists; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingMetadata.Get``1(System.String)">
<summary>Gets the value of metadata defined with the specified key, cast to the specified type. </summary>
<typeparam name="T">The type of value to expect.</typeparam>
<param name="key">The metadata key.</param>
<returns>The metadata value.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingMetadata.Get``1(System.String,``0)">
<summary>Gets the value of metadata defined with the specified key. </summary>
<param name="key">The metadata key.</param>
<param name="defaultValue">The value to return if the binding has no metadata set with the specified key.</param>
<returns>The metadata value, or the default value if none was set.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.BindingMetadata.Set(System.String,System.Object)">
<summary>Sets the value of a piece of metadata. </summary>
<param name="key">The metadata key.</param>
<param name="value">The metadata value.</param>
</member>
-<member name="P:Ninject.Planning.Bindings.BindingMetadata.Name">
<summary>Gets or sets the binding's name. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.BindingTarget">
<summary>Describes the target of a binding. </summary>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingTarget.Self">
<summary>Indicates that the binding is from a type to itself. </summary>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingTarget.Type">
<summary>Indicates that the binding is from one type to another. </summary>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingTarget.Provider">
<summary>Indicates that the binding is from a type to a provider. </summary>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingTarget.Method">
<summary>Indicates that the binding is from a type to a callback method. </summary>
</member>
-<member name="F:Ninject.Planning.Bindings.BindingTarget.Constant">
<summary>Indicates that the binding is from a type to a constant value. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.IBindingResolver">
<summary>Contains logic about which bindings to use for a given service request. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.IBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},System.Type)">
<summary>Returns any bindings from the specified collection that match the specified service. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="service">The service in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.IMissingBindingResolver">
<summary>Contains logic about which bindings to use for a given service requestwhen other attempts have failed. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.IMissingBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},Ninject.Activation.IRequest)">
<summary>Returns any bindings from the specified collection that match the specified request. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="request">The request in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="T:Ninject.Planning.Directives.IConstructorInjectionDirective">
<summary> </summary>
</member>
-<member name="T:Ninject.Planning.Directives.IMethodInjectionDirectiveBase`1">
<summary> </summary>
<typeparam name="TInjector"/>
</member>
-<member name="T:Ninject.Planning.Directives.IDirective">
-<summary>
A piece of information used in an
<see cref="T:Ninject.Planning.IPlan"/>
. (Just a marker.)
</summary>
</member>
-<member name="P:Ninject.Planning.Directives.IMethodInjectionDirectiveBase`1.Injector">
<summary>Gets or sets the injector that will be triggered. </summary>
</member>
-<member name="P:Ninject.Planning.Directives.IMethodInjectionDirectiveBase`1.Targets">
<summary>Gets or sets the targets for the directive. </summary>
</member>
-<member name="P:Ninject.Planning.Directives.IConstructorInjectionDirective.Constructor">
<summary>The base .ctor definition. </summary>
</member>
-<member name="T:Ninject.Planning.IPlan">
<summary>Describes the means by which a type should be activated. </summary>
</member>
-<member name="M:Ninject.Planning.IPlan.Add(Ninject.Planning.Directives.IDirective)">
<summary>Adds the specified directive to the plan. </summary>
<param name="directive">The directive.</param>
</member>
-<member name="M:Ninject.Planning.IPlan.Has``1">
<summary>Determines whether the plan contains one or more directives of the specified type. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
-<returns>
<c>True</c>
if the plan has one or more directives of the type; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.IPlan.GetOne``1">
<summary>Gets the first directive of the specified type from the plan. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
-<returns>
The first directive, or
<see langword="null"/>
if no matching directives exist.
</returns>
</member>
-<member name="M:Ninject.Planning.IPlan.GetAll``1">
<summary>Gets all directives of the specified type that exist in the plan. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
<returns>A series of directives of the specified type.</returns>
</member>
-<member name="P:Ninject.Planning.IPlan.Type">
<summary>Gets the type that the plan describes. </summary>
</member>
-<member name="T:Ninject.Planning.IPlanner">
<summary>Generates plans for how to activate instances. </summary>
</member>
-<member name="M:Ninject.Planning.IPlanner.GetPlan(System.Type)">
<summary>Gets or creates an activation plan for the specified type. </summary>
<param name="type">The type for which a plan should be created.</param>
<returns>The type's activation plan.</returns>
</member>
-<member name="P:Ninject.Planning.IPlanner.Strategies">
<summary>Gets the strategies that contribute to the planning process. </summary>
</member>
-<member name="T:Ninject.Planning.Strategies.IPlanningStrategy">
-<summary>
Contributes to the generation of a
<see cref="T:Ninject.Planning.IPlan"/>
.
</summary>
</member>
-<member name="M:Ninject.Planning.Strategies.IPlanningStrategy.Execute(Ninject.Planning.IPlan)">
<summary>Contributes to the specified plan. </summary>
<param name="plan">The plan that is being generated.</param>
</member>
-<member name="T:Ninject.Planning.Targets.ITarget">
<summary>Represents a site on a type where a value will be injected. </summary>
</member>
-<member name="M:Ninject.Planning.Targets.ITarget.ResolveWithin(Ninject.Activation.IContext)">
<summary>Resolves a value for the target within the specified parent context. </summary>
<param name="parent">The parent context.</param>
<returns>The resolved value.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.ITarget.IsDefined(System.Type,System.Boolean)">
<summary>Determines if an attribute is defined on the target </summary>
<param name="attributeType">Type of attribute</param>
<param name="inherit">Check base types</param>
<returns/>
</member>
-<member name="M:Ninject.Planning.Targets.ITarget.IsDefinedOnParent(System.Type,System.Type)">
<summary>Determines if an attribute is defined on the target's parent </summary>
<param name="attributeType">Type of attribute</param>
<param name="parent">Parent type to check</param>
<returns/>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.Type">
<summary>Gets the type of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.Name">
<summary>Gets the name of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.Member">
<summary>Gets the member that contains the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.Constraint">
<summary>Gets the constraint defined on the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.IsOptional">
<summary>Gets a value indicating whether the target represents an optional dependency. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.HasDefaultValue">
<summary>Gets a value indicating whether the target has a default value. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ITarget.DefaultValue">
<summary>Gets the default value for the target. </summary>
<exception cref="T:System.InvalidOperationException">If the item does not have a default value.</exception>
</member>
-<member name="T:Ninject.Selection.Heuristics.IConstructorScorer">
<summary>Generates scores for constructors, to determine which is the best one to call during activation. </summary>
</member>
-<member name="M:Ninject.Selection.Heuristics.IConstructorScorer.Score(Ninject.Activation.IContext,Ninject.Planning.Directives.IConstructorInjectionDirective)">
<summary>Gets the score for the specified constructor. </summary>
<param name="context">The injection context.</param>
<param name="directive">The constructor.</param>
<returns>The constructor's score.</returns>
</member>
-<member name="T:Ninject.Selection.Heuristics.IInjectionHeuristic">
<summary>Determines whether members should be injected during activation. </summary>
</member>
-<member name="M:Ninject.Selection.Heuristics.IInjectionHeuristic.ShouldInject(System.Reflection.MemberInfo)">
<summary>Returns a value indicating whether the specified member should be injected. </summary>
<param name="member">The member in question.</param>
-<returns>
<c>True</c>
if the member should be injected; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="T:Ninject.Selection.Heuristics.SpecificConstructorSelector">
<summary>Constructor selector that selects the constructor matching the one passed to the constructor. </summary>
</member>
-<member name="M:Ninject.Selection.Heuristics.SpecificConstructorSelector.#ctor(System.Reflection.ConstructorInfo)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Selection.Heuristics.SpecificConstructorSelector"/>
class.
</summary>
<param name="constructorInfo">The constructor info of the constructor that shall be selected.</param>
</member>
-<member name="M:Ninject.Selection.Heuristics.SpecificConstructorSelector.Score(Ninject.Activation.IContext,Ninject.Planning.Directives.IConstructorInjectionDirective)">
<summary>Gets the score for the specified constructor. </summary>
<param name="context">The injection context.</param>
<param name="directive">The constructor.</param>
<returns>The constructor's score.</returns>
</member>
-<member name="T:Ninject.Selection.ISelector">
<summary>Selects members for injection. </summary>
</member>
-<member name="M:Ninject.Selection.ISelector.SelectConstructorsForInjection(System.Type)">
<summary>Selects the constructor to call on the specified type, by using the constructor scorer. </summary>
<param name="type">The type.</param>
-<returns>
The selected constructor, or
<see langword="null"/>
if none were available.
</returns>
</member>
-<member name="M:Ninject.Selection.ISelector.SelectPropertiesForInjection(System.Type)">
<summary>Selects properties that should be injected. </summary>
<param name="type">The type.</param>
<returns>A series of the selected properties.</returns>
</member>
-<member name="M:Ninject.Selection.ISelector.SelectMethodsForInjection(System.Type)">
<summary>Selects methods that should be injected. </summary>
<param name="type">The type.</param>
<returns>A series of the selected methods.</returns>
</member>
-<member name="P:Ninject.Selection.ISelector.ConstructorScorer">
<summary>Gets or sets the constructor scorer. </summary>
</member>
-<member name="P:Ninject.Selection.ISelector.InjectionHeuristics">
<summary>Gets the heuristics used to determine which members should be injected. </summary>
</member>
-<member name="T:Ninject.ResolutionExtensions">
<summary>Extensions that enhance resolution of services. </summary>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get``1(Ninject.Syntax.IResolutionRoot,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get``1(Ninject.Syntax.IResolutionRoot,System.String,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding with the specified name. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get``1(Ninject.Syntax.IResolutionRoot,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet``1(Ninject.Syntax.IResolutionRoot,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet``1(Ninject.Syntax.IResolutionRoot,System.String,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding with the specified name. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet``1(Ninject.Syntax.IResolutionRoot,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGetAndThrowOnInvalidBinding``1(Ninject.Syntax.IResolutionRoot,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGetAndThrowOnInvalidBinding``1(Ninject.Syntax.IResolutionRoot,System.String,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding with the specified name. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGetAndThrowOnInvalidBinding``1(Ninject.Syntax.IResolutionRoot,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll``1(Ninject.Syntax.IResolutionRoot,Ninject.Parameters.IParameter[])">
<summary>Gets all available instances of the specified service. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll``1(Ninject.Syntax.IResolutionRoot,System.String,Ninject.Parameters.IParameter[])">
<summary>Gets all instances of the specified service using bindings registered with the specified name. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll``1(Ninject.Syntax.IResolutionRoot,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Gets all instances of the specified service by using the bindings that match the specified constraint. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="constraint">The constraint to apply to the bindings.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get(Ninject.Syntax.IResolutionRoot,System.Type,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get(Ninject.Syntax.IResolutionRoot,System.Type,System.String,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding with the specified name. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.Get(Ninject.Syntax.IResolutionRoot,System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet(Ninject.Syntax.IResolutionRoot,System.Type,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet(Ninject.Syntax.IResolutionRoot,System.Type,System.String,Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding with the specified name. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.TryGet(Ninject.Syntax.IResolutionRoot,System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Tries to get an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
-<returns>
An instance of the service, or
<see langword="null"/>
if no implementation was available.
</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll(Ninject.Syntax.IResolutionRoot,System.Type,Ninject.Parameters.IParameter[])">
<summary>Gets all available instances of the specified service. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll(Ninject.Syntax.IResolutionRoot,System.Type,System.String,Ninject.Parameters.IParameter[])">
<summary>Gets all instances of the specified service using bindings registered with the specified name. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.GetAll(Ninject.Syntax.IResolutionRoot,System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Gets all instances of the specified service by using the bindings that match the specified constraint. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="constraint">The constraint to apply to the bindings.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>A series of instances of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve``1(Ninject.Syntax.IResolutionRoot,Ninject.Parameters.IParameter[])">
<summary>Evaluates if an instance of the specified service can be resolved. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve``1(Ninject.Syntax.IResolutionRoot,System.String,Ninject.Parameters.IParameter[])">
<summary>Evaluates if an instance of the specified service by using the first binding with the specified name can be resolved. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve``1(Ninject.Syntax.IResolutionRoot,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Evaluates if an instance of the specified service by using the first binding that matches the specified constraint can be resolved. </summary>
<typeparam name="T">The service to resolve.</typeparam>
<param name="root">The resolution root.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve(Ninject.Syntax.IResolutionRoot,System.Type,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve(Ninject.Syntax.IResolutionRoot,System.Type,System.String,Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding with the specified name. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="name">The name of the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
-<member name="M:Ninject.ResolutionExtensions.CanResolve(Ninject.Syntax.IResolutionRoot,System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},Ninject.Parameters.IParameter[])">
<summary>Gets an instance of the specified service by using the first binding that matches the specified constraint. </summary>
<param name="root">The resolution root.</param>
<param name="service">The service to resolve.</param>
<param name="constraint">The constraint to apply to the binding.</param>
<param name="parameters">The parameters to pass to the request.</param>
<returns>An instance of the service.</returns>
</member>
</members>
</doc>Ninject.Platform
<?xml version="1.0"?>
-<doc>
-<assembly>
<name>Ninject.Platform</name>
</assembly>
-<members>
-<member name="T:Ninject.Activation.Caching.ActivationCache">
<summary>Stores the objects that were activated </summary>
</member>
-<member name="F:Ninject.Activation.Caching.ActivationCache.activatedObjects">
<summary>The objects that were activated as reference equal weak references. </summary>
</member>
-<member name="F:Ninject.Activation.Caching.ActivationCache.deactivatedObjects">
<summary>The objects that were activated as reference equal weak references. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.#ctor(Ninject.Activation.Caching.ICachePruner)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Caching.ActivationCache"/>
class.
</summary>
<param name="cachePruner">The cache pruner.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.Clear">
<summary>Clears the cache. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.AddActivatedInstance(System.Object)">
<summary>Adds an activated instance. </summary>
<param name="instance">The instance to be added.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.AddDeactivatedInstance(System.Object)">
<summary>Adds an deactivated instance. </summary>
<param name="instance">The instance to be added.</param>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.IsActivated(System.Object)">
<summary>Determines whether the specified instance is activated. </summary>
<param name="instance">The instance.</param>
-<returns>
<c>true</c>
if the specified instance is activated; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.IsDeactivated(System.Object)">
<summary>Determines whether the specified instance is deactivated. </summary>
<param name="instance">The instance.</param>
-<returns>
<c>true</c>
if the specified instance is deactivated; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.Prune">
<summary>Prunes this instance. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.ActivationCache.RemoveDeadObjects(System.Collections.Generic.HashSet{System.Object})">
<summary>Removes all dead objects. </summary>
<param name="objects">The objects collection to be freed of dead objects.</param>
</member>
-<member name="P:Ninject.Activation.Caching.ActivationCache.ActivatedObjectCount">
<summary>Gets the activated object count. </summary>
<value>The activated object count.</value>
</member>
-<member name="P:Ninject.Activation.Caching.ActivationCache.DeactivatedObjectCount">
<summary>Gets the deactivated object count. </summary>
<value>The deactivated object count.</value>
</member>
-<member name="T:Ninject.Activation.Caching.Cache">
<summary>Tracks instances for re-use in certain scopes. </summary>
</member>
-<member name="F:Ninject.Activation.Caching.Cache.entries">
<summary>Contains all cached instances.This is a dictionary of scopes to a multimap for bindings to cache entries. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.#ctor(Ninject.Activation.IPipeline,Ninject.Activation.Caching.ICachePruner)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Caching.Cache"/>
class.
</summary>
<param name="pipeline">The pipeline component.</param>
<param name="cachePruner">The cache pruner component.</param>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
<param name="disposing"/>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Remember(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Stores the specified context in the cache. </summary>
<param name="context">The context to store.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.TryGet(Ninject.Activation.IContext)">
<summary>Tries to retrieve an instance to re-use in the specified context. </summary>
<param name="context">The context that is being activated.</param>
-<returns>
The instance for re-use, or
<see langword="null"/>
if none has been stored.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Release(System.Object)">
<summary>Deactivates and releases the specified instance from the cache. </summary>
<param name="instance">The instance to release.</param>
-<returns>
<see langword="True"/>
if the instance was found and released; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Prune">
<summary>Removes instances from the cache which should no longer be re-used. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Clear(System.Object)">
<summary>Immediately deactivates and removes all instances in the cache that are owned bythe specified scope. </summary>
<param name="scope">The scope whose instances should be deactivated.</param>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Clear">
<summary>Immediately deactivates and removes all instances in the cache, regardless of scope. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.GetAllBindingEntries(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{Ninject.Planning.Bindings.IBindingConfiguration,System.Collections.Generic.ICollection{Ninject.Activation.Caching.Cache.CacheEntry}}})">
<summary>Gets all entries for a binding withing the selected scope. </summary>
<param name="bindings">The bindings.</param>
<returns>All bindings of a binding.</returns>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.GetAllCacheEntries">
<summary>Gets all cache entries. </summary>
<returns>Returns all cache entries.</returns>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Forget(System.Collections.Generic.IEnumerable{Ninject.Activation.Caching.Cache.CacheEntry})">
<summary>Forgets the specified cache entries. </summary>
<param name="cacheEntries">The cache entries.</param>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.Forget(Ninject.Activation.Caching.Cache.CacheEntry)">
<summary>Forgets the specified entry. </summary>
<param name="entry">The entry.</param>
</member>
-<member name="P:Ninject.Activation.Caching.Cache.Pipeline">
<summary>Gets the pipeline component. </summary>
</member>
-<member name="P:Ninject.Activation.Caching.Cache.Count">
<summary>Gets the number of entries currently stored in the cache. </summary>
</member>
-<member name="T:Ninject.Activation.Caching.Cache.CacheEntry">
<summary>An entry in the cache. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.Cache.CacheEntry.#ctor(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Caching.Cache.CacheEntry"/>
class.
</summary>
<param name="context">The context.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="P:Ninject.Activation.Caching.Cache.CacheEntry.Context">
<summary>Gets the context of the instance. </summary>
<value>The context.</value>
</member>
-<member name="P:Ninject.Activation.Caching.Cache.CacheEntry.Reference">
<summary>Gets the instance reference. </summary>
<value>The instance reference.</value>
</member>
-<member name="T:Ninject.Infrastructure.Introspection.FormatExtensionsEx">
<summary>Provides extension methods for string formatting </summary>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.FormatExtensionsEx.Format(Ninject.Activation.IRequest)">
<summary>Formats the specified request into a meaningful string representation. </summary>
<param name="request">The request to be formatted.</param>
<returns>The request formatted as string.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Introspection.FormatExtensionsEx.Format(Ninject.Planning.Targets.ITarget)">
<summary>Formats the specified target into a meaningful string representation.. </summary>
<param name="target">The target to be formatted.</param>
<returns>The target formatted as string.</returns>
</member>
-<member name="T:Ninject.Infrastructure.Language.ExtensionsForMemberInfo">
<summary>Extensions for MemberInfo </summary>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForMemberInfo.HasAttribute``1(System.Reflection.MemberInfo)">
<summary>Determines whether the specified member has attribute. </summary>
<typeparam name="T">The type of the attribute.</typeparam>
<param name="member">The member.</param>
-<returns>
<c>true</c>
if the specified member has attribute; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForMemberInfo.HasAttribute(System.Reflection.MemberInfo,System.Type)">
<summary>Determines whether the specified member has attribute. </summary>
<param name="member">The member.</param>
<param name="type">The type of the attribute.</param>
-<returns>
<c>true</c>
if the specified member has attribute; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForMemberInfo.GetPropertyFromDeclaredType(System.Reflection.MemberInfo,System.Reflection.PropertyInfo,System.Reflection.BindingFlags)">
<summary>Gets the property info from its declared tpe. </summary>
<param name="memberInfo">The member info.</param>
<param name="propertyDefinition">The property definition.</param>
<param name="flags">The flags.</param>
<returns>The property info from the declared type of the property.</returns>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForMemberInfo.IsPrivate(System.Reflection.PropertyInfo)">
<summary>Determines whether the specified property info is private. </summary>
<param name="propertyInfo">The property info.</param>
-<returns>
<c>true</c>
if the specified property info is private; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Infrastructure.Language.ExtensionsForMemberInfo.GetCustomAttributesExtended(System.Reflection.MemberInfo,System.Type,System.Boolean)">
<summary>Gets the custom attributes.This version is able to get custom attributes for properties from base types even if the property is none public. </summary>
<param name="member">The member.</param>
<param name="attributeType">Type of the attribute.</param>
-<param name="inherited">
if set to
<c>true</c>
[inherited].
</param>
<returns/>
</member>
-<member name="T:Ninject.Activation.Caching.WeakReferenceEqualityComparer">
<summary>Compares ReferenceEqualWeakReferences to objects </summary>
</member>
-<member name="M:Ninject.Activation.Caching.WeakReferenceEqualityComparer.Equals(System.Object,System.Object)">
<summary>Returns if the specifed objects are equal. </summary>
<param name="x">The first object.</param>
<param name="y">The second object.</param>
<returns>True if the objects are equal; otherwise false</returns>
</member>
-<member name="M:Ninject.Activation.Caching.WeakReferenceEqualityComparer.GetHashCode(System.Object)">
<summary>Returns the hash code of the specified object. </summary>
<param name="obj">The object for which the hash code is calculated.</param>
<returns>The hash code of the specified object.</returns>
</member>
-<member name="T:Ninject.Activation.Strategies.ActivationCacheStrategy">
<summary>Adds all activated instances to the activation cache. </summary>
</member>
-<member name="F:Ninject.Activation.Strategies.ActivationCacheStrategy.activationCache">
<summary>The activation cache. </summary>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationCacheStrategy.#ctor(Ninject.Activation.Caching.IActivationCache)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Strategies.ActivationCacheStrategy"/>
class.
</summary>
<param name="activationCache">The activation cache.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationCacheStrategy.Dispose">
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationCacheStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the activation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationCacheStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the deactivation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="P:Ninject.Activation.Strategies.ActivationCacheStrategy.Settings">
<summary>Gets or sets the settings. </summary>
<value>The ninject settings.</value>
</member>
-<member name="T:Ninject.GlobalKernelRegistration">
<summary>Allows to register kernel globally to perform some tasks on all kernels.The registration is done by loading the GlobalKernelRegistrationModule to the kernel. </summary>
</member>
-<member name="M:Ninject.GlobalKernelRegistration.MapKernels(System.Action{Ninject.IKernel})">
<summary>Performs an action on all registered kernels. </summary>
<param name="action">The action.</param>
</member>
-<member name="T:Ninject.GlobalKernelRegistrationModule`1">
<summary>Registers the kernel into which the module is loaded on the GlobalKernelRegistry using thetype specified by TGlobalKernelRegistry. </summary>
<typeparam name="TGlobalKernelRegistry">The type that is used to register the kernel.</typeparam>
</member>
-<member name="M:Ninject.GlobalKernelRegistrationModule`1.Load">
<summary>Loads the module into the kernel. </summary>
</member>
-<member name="M:Ninject.GlobalKernelRegistrationModule`1.Unload">
<summary>Unloads the module from the kernel. </summary>
</member>
-<member name="T:Ninject.Infrastructure.BaseWeakReference">
<summary>Inheritable weak reference base class for Silverlight </summary>
</member>
-<member name="M:Ninject.Infrastructure.BaseWeakReference.#ctor(System.Object)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Infrastructure.ReferenceEqualWeakReference"/>
class.
</summary>
<param name="target">The target.</param>
</member>
-<member name="M:Ninject.Infrastructure.BaseWeakReference.#ctor(System.Object,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Infrastructure.ReferenceEqualWeakReference"/>
class.
</summary>
<param name="target">The target.</param>
-<param name="trackResurrection">
if set to
<c>true</c>
[track resurrection].
</param>
</member>
-<member name="P:Ninject.Infrastructure.BaseWeakReference.IsAlive">
<summary>Gets a value indicating whether this instance is alive. </summary>
-<value>
<c>true</c>
if this instance is alive; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Ninject.Infrastructure.BaseWeakReference.Target">
<summary>Gets or sets the target of this weak reference. </summary>
<value>The target of this weak reference.</value>
</member>
-<member name="T:Ninject.Modules.AssemblyNameRetriever">
<summary>Retrieves assembly names from file names using a temporary app domain. </summary>
</member>
-<member name="T:Ninject.Modules.IAssemblyNameRetriever">
<summary>Retrieves assembly names from file names using a temporary app domain. </summary>
</member>
-<member name="M:Ninject.Modules.IAssemblyNameRetriever.GetAssemblyNames(System.Collections.Generic.IEnumerable{System.String},System.Predicate{System.Reflection.Assembly})">
<summary>Gets all assembly names of the assemblies in the given files that match the filter. </summary>
<param name="filenames">The filenames.</param>
<param name="filter">The filter.</param>
<returns>All assembly names of the assemblies in the given files that match the filter.</returns>
</member>
-<member name="M:Ninject.Modules.AssemblyNameRetriever.GetAssemblyNames(System.Collections.Generic.IEnumerable{System.String},System.Predicate{System.Reflection.Assembly})">
<summary>Gets all assembly names of the assemblies in the given files that match the filter. </summary>
<param name="filenames">The filenames.</param>
<param name="filter">The filter.</param>
<returns>All assembly names of the assemblies in the given files that match the filter.</returns>
</member>
-<member name="M:Ninject.Modules.AssemblyNameRetriever.CreateTemporaryAppDomain">
<summary>Creates a temporary app domain. </summary>
<returns>The created app domain.</returns>
</member>
-<member name="T:Ninject.Modules.AssemblyNameRetriever.AssemblyChecker">
<summary>This class is loaded into the temporary appdomain to load and check if the assemblies match the filter. </summary>
</member>
-<member name="M:Ninject.Modules.AssemblyNameRetriever.AssemblyChecker.GetAssemblyNames(System.Collections.Generic.IEnumerable{System.String},System.Predicate{System.Reflection.Assembly})">
<summary>Gets the assembly names of the assemblies matching the filter. </summary>
<param name="filenames">The filenames.</param>
<param name="filter">The filter.</param>
<returns>All assembly names of the assemblies matching the filter.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.DefaultValueBindingResolver">
<summary> </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.DefaultValueBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},Ninject.Activation.IRequest)">
<summary>Returns any bindings from the specified collection that match the specified service. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="request">The service in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="T:Ninject.Activation.Caching.GarbageCollectionCachePruner">
-<summary>
Uses a
<see cref="T:System.Threading.Timer"/>
and some
<see cref="T:System.WeakReference"/>
magic to pollthe garbage collector to see if it has run.
</summary>
</member>
-<member name="F:Ninject.Activation.Caching.GarbageCollectionCachePruner.indicator">
<summary>indicator for if GC has been run. </summary>
</member>
-<member name="F:Ninject.Activation.Caching.GarbageCollectionCachePruner.caches">
<summary>The caches that are being pruned. </summary>
</member>
-<member name="F:Ninject.Activation.Caching.GarbageCollectionCachePruner.timer">
<summary>The timer used to trigger the cache pruning </summary>
</member>
-<member name="M:Ninject.Activation.Caching.GarbageCollectionCachePruner.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
</member>
-<member name="M:Ninject.Activation.Caching.GarbageCollectionCachePruner.Start(Ninject.Activation.Caching.IPruneable)">
<summary>Starts pruning the specified pruneable based on the rules of the pruner. </summary>
<param name="pruneable">The pruneable that will be pruned.</param>
</member>
-<member name="M:Ninject.Activation.Caching.GarbageCollectionCachePruner.Stop">
<summary>Stops pruning. </summary>
</member>
-<member name="T:Ninject.Activation.Context">
<summary>Contains information about the activation of a single instance. </summary>
</member>
-<member name="M:Ninject.Activation.Context.#ctor(Ninject.IKernel,Ninject.Activation.IRequest,Ninject.Planning.Bindings.IBinding,Ninject.Activation.Caching.ICache,Ninject.Planning.IPlanner,Ninject.Activation.IPipeline)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Context"/>
class.
</summary>
<param name="kernel">The kernel managing the resolution.</param>
<param name="request">The context's request.</param>
<param name="binding">The context's binding.</param>
<param name="cache">The cache component.</param>
<param name="planner">The planner component.</param>
<param name="pipeline">The pipeline component.</param>
</member>
-<member name="M:Ninject.Activation.Context.GetScope">
<summary>Gets the scope for the context that "owns" the instance activated therein. </summary>
<returns>The object that acts as the scope.</returns>
</member>
-<member name="M:Ninject.Activation.Context.GetProvider">
<summary>Gets the provider that should be used to create the instance for this context. </summary>
<returns>The provider that should be used.</returns>
</member>
-<member name="M:Ninject.Activation.Context.Resolve">
<summary>Resolves the instance associated with this hook. </summary>
<returns>The resolved instance.</returns>
</member>
-<member name="P:Ninject.Activation.Context.Kernel">
<summary>Gets the kernel that is driving the activation. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Request">
<summary>Gets the request. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Binding">
<summary>Gets the binding. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Plan">
<summary>Gets or sets the activation plan. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Parameters">
<summary>Gets the parameters that were passed to manipulate the activation process. </summary>
</member>
-<member name="P:Ninject.Activation.Context.GenericArguments">
<summary>Gets the generic arguments for the request, if any. </summary>
</member>
-<member name="P:Ninject.Activation.Context.HasInferredGenericArguments">
<summary>Gets a value indicating whether the request involves inferred generic arguments. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Cache">
<summary>Gets or sets the cache component. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Planner">
<summary>Gets or sets the planner component. </summary>
</member>
-<member name="P:Ninject.Activation.Context.Pipeline">
<summary>Gets or sets the pipeline component. </summary>
</member>
-<member name="T:Ninject.Activation.Request">
<summary>Describes the request for a service resolution. </summary>
</member>
-<member name="M:Ninject.Activation.Request.#ctor(System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},System.Collections.Generic.IEnumerable{Ninject.Parameters.IParameter},System.Func{System.Object},System.Boolean,System.Boolean)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Request"/>
class.
</summary>
<param name="service">The service that was requested.</param>
<param name="constraint">The constraint that will be applied to filter the bindings used for the request.</param>
<param name="parameters">The parameters that affect the resolution.</param>
<param name="scopeCallback">The scope callback, if an external scope was specified.</param>
-<param name="isOptional">
<c>True</c>
if the request is optional; otherwise,
<c>false</c>
.
</param>
-<param name="isUnique">
<c>True</c>
if the request should return a unique result; otherwise,
<c>false</c>
.
</param>
</member>
-<member name="M:Ninject.Activation.Request.#ctor(Ninject.Activation.IContext,System.Type,Ninject.Planning.Targets.ITarget,System.Func{System.Object})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Request"/>
class.
</summary>
<param name="parentContext">The parent context.</param>
<param name="service">The service that was requested.</param>
<param name="target">The target that will receive the injection.</param>
<param name="scopeCallback">The scope callback, if an external scope was specified.</param>
</member>
-<member name="M:Ninject.Activation.Request.Matches(Ninject.Planning.Bindings.IBinding)">
<summary>Determines whether the specified binding satisfies the constraints defined on this request. </summary>
<param name="binding">The binding.</param>
-<returns>
<c>True</c>
if the binding satisfies the constraints; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Request.GetScope">
<summary>Gets the scope if one was specified in the request. </summary>
<returns>The object that acts as the scope.</returns>
</member>
-<member name="M:Ninject.Activation.Request.CreateChild(System.Type,Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Creates a child request. </summary>
<param name="service">The service that is being requested.</param>
<param name="parentContext">The context in which the request was made.</param>
<param name="target">The target that will receive the injection.</param>
<returns>The child request.</returns>
</member>
-<member name="M:Ninject.Activation.Request.ToString">
<summary>Formats this object into a meaningful string representation. </summary>
<returns>The request formatted as string.</returns>
</member>
-<member name="P:Ninject.Activation.Request.Service">
<summary>Gets the service that was requested. </summary>
</member>
-<member name="P:Ninject.Activation.Request.ParentRequest">
<summary>Gets the parent request. </summary>
</member>
-<member name="P:Ninject.Activation.Request.ParentContext">
<summary>Gets the parent context. </summary>
</member>
-<member name="P:Ninject.Activation.Request.Target">
<summary>Gets the target that will receive the injection, if any. </summary>
</member>
-<member name="P:Ninject.Activation.Request.Constraint">
<summary>Gets the constraint that will be applied to filter the bindings used for the request. </summary>
</member>
-<member name="P:Ninject.Activation.Request.Parameters">
<summary>Gets the parameters that affect the resolution. </summary>
</member>
-<member name="P:Ninject.Activation.Request.ActiveBindings">
<summary>Gets the stack of bindings which have been activated by either this request or its ancestors. </summary>
</member>
-<member name="P:Ninject.Activation.Request.Depth">
<summary>Gets the recursive depth at which this request occurs. </summary>
</member>
-<member name="P:Ninject.Activation.Request.IsOptional">
<summary>Gets or sets value indicating whether the request is optional. </summary>
</member>
-<member name="P:Ninject.Activation.Request.IsUnique">
<summary>Gets or sets value indicating whether the request is for a single service. </summary>
</member>
-<member name="P:Ninject.Activation.Request.ForceUnique">
<summary>Gets or sets value indicating whether the request should force to return a unique value even if the request is optional.If this value is set true the request will throw an ActivationException if there are multiple satisfying bingings ratherthan returning null for the request is optional. For none optional requests this parameter does not change anything. </summary>
</member>
-<member name="P:Ninject.Activation.Request.ScopeCallback">
<summary>Gets the callback that resolves the scope for the request, if an external scope was provided. </summary>
</member>
-<member name="T:Ninject.Activation.Pipeline">
<summary>Drives the activation (injection, etc.) of an instance. </summary>
</member>
-<member name="F:Ninject.Activation.Pipeline.activationCache">
<summary>The activation cache. </summary>
</member>
-<member name="M:Ninject.Activation.Pipeline.#ctor(System.Collections.Generic.IEnumerable{Ninject.Activation.Strategies.IActivationStrategy},Ninject.Activation.Caching.IActivationCache)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Pipeline"/>
class.
</summary>
<param name="strategies">The strategies to execute during activation and deactivation.</param>
<param name="activationCache">The activation cache.</param>
</member>
-<member name="M:Ninject.Activation.Pipeline.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Activates the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="M:Ninject.Activation.Pipeline.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Deactivates the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">The instance reference.</param>
</member>
-<member name="P:Ninject.Activation.Pipeline.Strategies">
<summary>Gets the strategies that contribute to the activation and deactivation processes. </summary>
</member>
-<member name="T:Ninject.Activation.Strategies.ActivationStrategy">
-<summary>
Contributes to a
<see cref="T:Ninject.Activation.IPipeline"/>
, and is called during the activationand deactivation of an instance.
</summary>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the activation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.ActivationStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Contributes to the deactivation of the instance in the specified context. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.BindingActionStrategy">
<summary>Executes actions defined on the binding during activation and deactivation. </summary>
</member>
-<member name="M:Ninject.Activation.Strategies.BindingActionStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Calls the activation actions defined on the binding. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.BindingActionStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Calls the deactivation actions defined on the binding. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.InitializableStrategy">
-<summary>
During activation, initializes instances that implement
<see cref="T:Ninject.IInitializable"/>
.
</summary>
</member>
-<member name="M:Ninject.Activation.Strategies.InitializableStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Initializes the specified instance. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.StartableStrategy">
-<summary>
Starts instances that implement
<see cref="T:Ninject.IStartable"/>
during activation,and stops them during deactivation.
</summary>
</member>
-<member name="M:Ninject.Activation.Strategies.StartableStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Starts the specified instance. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.StartableStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Stops the specified instance. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.DisposableStrategy">
-<summary>
During deactivation, disposes instances that implement
<see cref="T:System.IDisposable"/>
.
</summary>
</member>
-<member name="M:Ninject.Activation.Strategies.DisposableStrategy.Deactivate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
<summary>Disposes the specified instance. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being deactivated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.MethodInjectionStrategy">
<summary>Injects methods on an instance during activation. </summary>
</member>
-<member name="M:Ninject.Activation.Strategies.MethodInjectionStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
-<summary>
Injects values into the properties as described by
<see cref="T:Ninject.Planning.Directives.MethodInjectionDirective"/>
scontained in the plan.
</summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="T:Ninject.Activation.Strategies.PropertyInjectionStrategy">
<summary>Injects properties on an instance during activation. </summary>
</member>
-<member name="M:Ninject.Activation.Strategies.PropertyInjectionStrategy.#ctor(Ninject.Injection.IInjectorFactory)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Strategies.PropertyInjectionStrategy"/>
class.
</summary>
<param name="injectorFactory">The injector factory component.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.PropertyInjectionStrategy.Activate(Ninject.Activation.IContext,Ninject.Activation.InstanceReference)">
-<summary>
Injects values into the properties as described by
<see cref="T:Ninject.Planning.Directives.PropertyInjectionDirective"/>
scontained in the plan.
</summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.PropertyInjectionStrategy.AssignProperyOverrides(Ninject.Activation.IContext,Ninject.Activation.InstanceReference,System.Collections.Generic.IList{Ninject.Parameters.IPropertyValue})">
<summary>Applies user supplied override values to instance properties. </summary>
<param name="context">The context.</param>
<param name="reference">A reference to the instance being activated.</param>
<param name="propertyValues">The parameter override value accessors.</param>
</member>
-<member name="M:Ninject.Activation.Strategies.PropertyInjectionStrategy.GetValue(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget,System.Collections.Generic.IEnumerable{Ninject.Parameters.IPropertyValue})">
<summary>Gets the value to inject into the specified target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<param name="allPropertyValues">all property values of the current request.</param>
<returns>The value to inject into the specified target.</returns>
</member>
-<member name="P:Ninject.Activation.Strategies.PropertyInjectionStrategy.InjectorFactory">
<summary>Gets the injector factory component. </summary>
</member>
-<member name="T:Ninject.Infrastructure.Future`1">
<summary>Represents a future value. </summary>
<typeparam name="T">The type of value.</typeparam>
</member>
-<member name="M:Ninject.Infrastructure.Future`1.#ctor(System.Func{`0})">
<summary>Initializes a new instance of the Future<T> class. </summary>
<param name="callback">The callback that will be triggered to read the value.</param>
</member>
-<member name="M:Ninject.Infrastructure.Future`1.op_Implicit(Ninject.Infrastructure.Future{`0})~`0">
<summary>Gets the value from the future. </summary>
<param name="future">The future.</param>
<returns>The future value.</returns>
</member>
-<member name="P:Ninject.Infrastructure.Future`1.Value">
<summary>Gets the value, resolving it if necessary. </summary>
</member>
-<member name="P:Ninject.Infrastructure.Future`1.Callback">
<summary>Gets the callback that will be called to resolve the value. </summary>
</member>
-<member name="T:Ninject.Injection.ReflectionInjectorFactory">
<summary>Creates injectors from members via reflective invocation. </summary>
</member>
-<member name="M:Ninject.Injection.ReflectionInjectorFactory.Create(System.Reflection.ConstructorInfo)">
<summary>Gets or creates an injector for the specified constructor. </summary>
<param name="constructor">The constructor.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.ReflectionInjectorFactory.Create(System.Reflection.PropertyInfo)">
<summary>Gets or creates an injector for the specified property. </summary>
<param name="property">The property.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.ReflectionInjectorFactory.Create(System.Reflection.MethodInfo)">
<summary>Gets or creates an injector for the specified method. </summary>
<param name="method">The method.</param>
<returns>The created injector.</returns>
</member>
-<member name="T:Ninject.Injection.DynamicMethodInjectorFactory">
-<summary>
Creates injectors for members via
<see cref="T:System.Reflection.Emit.DynamicMethod"/>
s.
</summary>
</member>
-<member name="M:Ninject.Injection.DynamicMethodInjectorFactory.Create(System.Reflection.ConstructorInfo)">
<summary>Gets or creates an injector for the specified constructor. </summary>
<param name="constructor">The constructor.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.DynamicMethodInjectorFactory.Create(System.Reflection.PropertyInfo)">
<summary>Gets or creates an injector for the specified property. </summary>
<param name="property">The property.</param>
<returns>The created injector.</returns>
</member>
-<member name="M:Ninject.Injection.DynamicMethodInjectorFactory.Create(System.Reflection.MethodInfo)">
<summary>Gets or creates an injector for the specified method. </summary>
<param name="method">The method.</param>
<returns>The created injector.</returns>
</member>
-<member name="T:Ninject.Modules.CompiledModuleLoaderPlugin">
<summary>Loads modules from compiled assemblies. </summary>
</member>
-<member name="T:Ninject.Modules.IModuleLoaderPlugin">
<summary>Loads modules at runtime by searching external files. </summary>
</member>
-<member name="M:Ninject.Modules.IModuleLoaderPlugin.LoadModules(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads modules from the specified files. </summary>
<param name="filenames">The names of the files to load modules from.</param>
</member>
-<member name="P:Ninject.Modules.IModuleLoaderPlugin.SupportedExtensions">
<summary>Gets the file extensions that the plugin understands how to load. </summary>
</member>
-<member name="F:Ninject.Modules.CompiledModuleLoaderPlugin.assemblyNameRetriever">
<summary>The assembly name retriever. </summary>
</member>
-<member name="F:Ninject.Modules.CompiledModuleLoaderPlugin.Extensions">
<summary>The file extensions that are supported. </summary>
</member>
-<member name="M:Ninject.Modules.CompiledModuleLoaderPlugin.#ctor(Ninject.IKernel,Ninject.Modules.IAssemblyNameRetriever)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Modules.CompiledModuleLoaderPlugin"/>
class.
</summary>
<param name="kernel">The kernel into which modules will be loaded.</param>
<param name="assemblyNameRetriever">The assembly name retriever.</param>
</member>
-<member name="M:Ninject.Modules.CompiledModuleLoaderPlugin.LoadModules(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads modules from the specified files. </summary>
<param name="filenames">The names of the files to load modules from.</param>
</member>
-<member name="P:Ninject.Modules.CompiledModuleLoaderPlugin.Kernel">
<summary>Gets the kernel into which modules will be loaded. </summary>
</member>
-<member name="P:Ninject.Modules.CompiledModuleLoaderPlugin.SupportedExtensions">
<summary>Gets the file extensions that the plugin understands how to load. </summary>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.OpenGenericBindingResolver">
<summary>Resolves bindings for open generic types. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.OpenGenericBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},System.Type)">
<summary>Returns any bindings from the specified collection that match the specified service. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="service">The service in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.SelfBindingResolver">
<summary> </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.SelfBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},Ninject.Activation.IRequest)">
<summary>Returns any bindings from the specified collection that match the specified service. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="request">The service in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.SelfBindingResolver.TypeIsSelfBindable(System.Type)">
<summary>Returns a value indicating whether the specified service is self-bindable. </summary>
<param name="service">The service.</param>
-<returns>
<see langword="True"/>
if the type is self-bindable; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="T:Ninject.Planning.Bindings.Resolvers.StandardBindingResolver">
<summary>Resolves bindings that have been registered directly for the service. </summary>
</member>
-<member name="M:Ninject.Planning.Bindings.Resolvers.StandardBindingResolver.Resolve(Ninject.Infrastructure.Multimap{System.Type,Ninject.Planning.Bindings.IBinding},System.Type)">
<summary>Returns any bindings from the specified collection that match the specified service. </summary>
<param name="bindings">The multimap of all registered bindings.</param>
<param name="service">The service in question.</param>
<returns>The series of matching bindings.</returns>
</member>
-<member name="T:Ninject.Planning.Directives.ConstructorInjectionDirective">
<summary>Describes the injection of a constructor. </summary>
</member>
-<member name="T:Ninject.Planning.Directives.MethodInjectionDirectiveBase`2">
<summary>Describes the injection of a method or constructor. </summary>
</member>
-<member name="M:Ninject.Planning.Directives.MethodInjectionDirectiveBase`2.#ctor(`0,`1)">
<summary>Initializes a new instance of the MethodInjectionDirectiveBase<TMethod, TInjector> class. </summary>
<param name="method">The method this directive represents.</param>
<param name="injector">The injector that will be triggered.</param>
</member>
-<member name="M:Ninject.Planning.Directives.MethodInjectionDirectiveBase`2.CreateTargetsFromParameters(`0)">
<summary>Creates targets for the parameters of the method. </summary>
<param name="method">The method.</param>
<returns>The targets for the method's parameters.</returns>
</member>
-<member name="P:Ninject.Planning.Directives.MethodInjectionDirectiveBase`2.Injector">
<summary>Gets or sets the injector that will be triggered. </summary>
</member>
-<member name="P:Ninject.Planning.Directives.MethodInjectionDirectiveBase`2.Targets">
<summary>Gets or sets the targets for the directive. </summary>
</member>
-<member name="M:Ninject.Planning.Directives.ConstructorInjectionDirective.#ctor(System.Reflection.ConstructorInfo,Ninject.Injection.ConstructorInjector)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Directives.ConstructorInjectionDirective"/>
class.
</summary>
<param name="constructor">The constructor described by the directive.</param>
<param name="injector">The injector that will be triggered.</param>
</member>
-<member name="P:Ninject.Planning.Directives.ConstructorInjectionDirective.Constructor">
<summary>The base .ctor definition. </summary>
</member>
-<member name="T:Ninject.Planning.Directives.MethodInjectionDirective">
<summary>Describes the injection of a method. </summary>
</member>
-<member name="M:Ninject.Planning.Directives.MethodInjectionDirective.#ctor(System.Reflection.MethodInfo,Ninject.Injection.MethodInjector)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Directives.MethodInjectionDirective"/>
class.
</summary>
<param name="method">The method described by the directive.</param>
<param name="injector">The injector that will be triggered.</param>
</member>
-<member name="T:Ninject.Planning.Targets.ITargetEx">
<summary>Represents a site on a type where a value will be injected. </summary>
</member>
-<member name="T:Ninject.ModuleLoadExtensions">
<summary>Extension methods that enhance module loading. </summary>
</member>
-<member name="M:Ninject.ModuleLoadExtensions.Load``1(Ninject.IKernel)">
<summary>Creates a new instance of the module and loads it into the kernel. </summary>
<typeparam name="TModule">The type of the module.</typeparam>
<param name="kernel">The kernel.</param>
</member>
-<member name="M:Ninject.ModuleLoadExtensions.Load(Ninject.IKernel,Ninject.Modules.INinjectModule[])">
<summary>Loads the module(s) into the kernel. </summary>
<param name="kernel">The kernel.</param>
<param name="modules">The modules to load.</param>
</member>
-<member name="M:Ninject.ModuleLoadExtensions.Load(Ninject.IKernel,System.String[])">
<summary>Loads modules from the files that match the specified pattern(s). </summary>
<param name="kernel">The kernel.</param>
<param name="filePatterns">The file patterns (i.e. "*.dll", "modules/*.rb") to match.</param>
</member>
-<member name="M:Ninject.ModuleLoadExtensions.Load(Ninject.IKernel,System.Reflection.Assembly[])">
<summary>Loads modules defined in the specified assemblies. </summary>
<param name="kernel">The kernel.</param>
<param name="assemblies">The assemblies to search.</param>
</member>
-<member name="T:Ninject.Modules.IModuleLoader">
<summary>Finds modules defined in external files. </summary>
</member>
-<member name="M:Ninject.Modules.IModuleLoader.LoadModules(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads any modules found in the files that match the specified patterns. </summary>
<param name="patterns">The patterns to search.</param>
</member>
-<member name="T:Ninject.Modules.ModuleLoader">
<summary>Automatically finds and loads modules from assemblies. </summary>
</member>
-<member name="M:Ninject.Modules.ModuleLoader.#ctor(Ninject.IKernel)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Modules.ModuleLoader"/>
class.
</summary>
<param name="kernel">The kernel into which modules will be loaded.</param>
</member>
-<member name="M:Ninject.Modules.ModuleLoader.LoadModules(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads any modules found in the files that match the specified patterns. </summary>
<param name="patterns">The patterns to search.</param>
</member>
-<member name="P:Ninject.Modules.ModuleLoader.Kernel">
<summary>Gets or sets the kernel into which modules will be loaded. </summary>
</member>
-<member name="T:Ninject.Activation.Blocks.ActivationBlock">
<summary>A block used for deterministic disposal of activated instances. When the block isdisposed, all instances activated via it will be deactivated. </summary>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.#ctor(Ninject.Syntax.IResolutionRoot)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Activation.Blocks.ActivationBlock"/>
class.
</summary>
<param name="parent">The parent resolution root.</param>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.CanResolve(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.CanResolve(Ninject.Activation.IRequest,System.Boolean)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<param name="ignoreImplicitBindings">
if set to
<c>true</c>
implicit bindings are ignored.
</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.Resolve(Ninject.Activation.IRequest)">
<summary>Resolves instances for the specified request. The instances are not actually resolveduntil a consumer iterates over the enumerator. </summary>
<param name="request">The request to resolve.</param>
<returns>An enumerator of instances that match the request.</returns>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.CreateRequest(System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},System.Collections.Generic.IEnumerable{Ninject.Parameters.IParameter},System.Boolean,System.Boolean)">
<summary>Creates a request for the specified service. </summary>
<param name="service">The service that is being requested.</param>
<param name="constraint">The constraint to apply to the bindings to determine if they match the request.</param>
<param name="parameters">The parameters to pass to the resolution.</param>
-<param name="isOptional">
<c>True</c>
if the request is optional; otherwise,
<c>false</c>
.
</param>
-<param name="isUnique">
<c>True</c>
if the request should return a unique result; otherwise,
<c>false</c>
.
</param>
<returns>The created request.</returns>
</member>
-<member name="M:Ninject.Activation.Blocks.ActivationBlock.Release(System.Object)">
<summary>Deactivates and releases the specified instance if it is currently managed by Ninject. </summary>
<param name="instance">The instance to release.</param>
-<returns>
<see langword="True"/>
if the instance was found and released; otherwise
<see langword="false"/>
.
</returns>
<remarks/>
</member>
-<member name="P:Ninject.Activation.Blocks.ActivationBlock.Parent">
<summary>Gets or sets the parent resolution root (usually the kernel). </summary>
</member>
-<member name="E:Ninject.Activation.Blocks.ActivationBlock.Disposed">
<summary>Occurs when the object is disposed. </summary>
</member>
-<member name="T:Ninject.NinjectSettings">
<summary>Contains configuration options for Ninject. </summary>
</member>
-<member name="M:Ninject.NinjectSettings.#ctor">
<summary>Creates a settings object </summary>
</member>
-<member name="M:Ninject.NinjectSettings.Get``1(System.String,``0)">
<summary>Gets the value for the specified key. </summary>
<typeparam name="T">The type of value to return.</typeparam>
<param name="key">The setting's key.</param>
<param name="defaultValue">The value to return if no setting is available.</param>
<returns>The value, or the default value if none was found.</returns>
</member>
-<member name="M:Ninject.NinjectSettings.Set(System.String,System.Object)">
<summary>Sets the value for the specified key. </summary>
<param name="key">The setting's key.</param>
<param name="value">The setting's value.</param>
</member>
-<member name="P:Ninject.NinjectSettings.InjectAttribute">
<summary>Gets or sets the attribute that indicates that a member should be injected. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.CachePruningInterval">
<summary>Gets or sets the interval at which the GC should be polled. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.DefaultScopeCallback">
<summary>Gets or sets the default scope callback. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.LoadExtensions">
<summary>Gets or sets a value indicating whether the kernel should automatically load extensions at startup. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.ExtensionSearchPatterns">
<summary>Gets or sets the paths that should be searched for extensions. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.UseReflectionBasedInjection">
<summary>Gets a value indicating whether Ninject should use reflection-based injection instead ofthe (usually faster) lightweight code generation system. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.InjectNonPublic">
<summary>Gets a value indicating whether Ninject should inject non public members. </summary>
</member>
-<member name="P:Ninject.NinjectSettings.InjectParentPrivateProperties">
<summary>Gets a value indicating whether Ninject should inject private properties of base classes. </summary>
<remarks>Activating this setting has an impact on the performance. It is recomended notto use this feature and use constructor injection instead. </remarks>
</member>
-<member name="P:Ninject.NinjectSettings.ActivationCacheDisabled">
<summary>Gets or sets a value indicating whether the activation cache is disabled.If the activation cache is disabled less memory is used. But in some casesinstances are activated or deactivated multiple times. e.g. in the following scenario:Bind{A}().ToSelf();Bind{IA}().ToMethod(ctx => kernel.Get{IA}(); </summary>
-<value>
<c>true</c>
if activation cache is disabled; otherwise,
<c>false</c>
.
</value>
</member>
-<member name="P:Ninject.NinjectSettings.AllowNullInjection">
<summary>Gets or sets a value indicating whether Null is a valid value for injection.By default this is disabled and whenever a provider returns null an exception is thrown. </summary>
-<value>
<c>true</c>
if null is allowed as injected value otherwise false.
</value>
</member>
-<member name="T:Ninject.Components.ComponentContainer">
<summary>An internal container that manages and resolves components that contribute to Ninject. </summary>
</member>
-<member name="M:Ninject.Components.ComponentContainer.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
</member>
-<member name="M:Ninject.Components.ComponentContainer.Add``2">
<summary>Registers a component in the container. </summary>
<typeparam name="TComponent">The component type.</typeparam>
<typeparam name="TImplementation">The component's implementation type.</typeparam>
</member>
-<member name="M:Ninject.Components.ComponentContainer.AddTransient``2">
<summary>Registers a transient component in the container. </summary>
<typeparam name="TComponent">The component type.</typeparam>
<typeparam name="TImplementation">The component's implementation type.</typeparam>
</member>
-<member name="M:Ninject.Components.ComponentContainer.RemoveAll``1">
<summary>Removes all registrations for the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
</member>
-<member name="M:Ninject.Components.ComponentContainer.Remove``2">
<summary>Removes the specified registration. </summary>
<typeparam name="T">The component type.</typeparam>
<typeparam name="TImplementation">The implementation type.</typeparam>
</member>
-<member name="M:Ninject.Components.ComponentContainer.RemoveAll(System.Type)">
<summary>Removes all registrations for the specified component. </summary>
<param name="component">The component type.</param>
</member>
-<member name="M:Ninject.Components.ComponentContainer.Get``1">
<summary>Gets one instance of the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
<returns>The instance of the component.</returns>
</member>
-<member name="M:Ninject.Components.ComponentContainer.GetAll``1">
<summary>Gets all available instances of the specified component. </summary>
<typeparam name="T">The component type.</typeparam>
<returns>A series of instances of the specified component.</returns>
</member>
-<member name="M:Ninject.Components.ComponentContainer.Get(System.Type)">
<summary>Gets one instance of the specified component. </summary>
<param name="component">The component type.</param>
<returns>The instance of the component.</returns>
</member>
-<member name="M:Ninject.Components.ComponentContainer.GetAll(System.Type)">
<summary>Gets all available instances of the specified component. </summary>
<param name="component">The component type.</param>
<returns>A series of instances of the specified component.</returns>
</member>
-<member name="P:Ninject.Components.ComponentContainer.Kernel">
<summary>Gets or sets the kernel that owns the component container. </summary>
</member>
-<member name="T:Ninject.Planning.Strategies.MethodReflectionStrategy">
<summary>Adds directives to plans indicating which methods should be injected during activation. </summary>
</member>
-<member name="M:Ninject.Planning.Strategies.MethodReflectionStrategy.#ctor(Ninject.Selection.ISelector,Ninject.Injection.IInjectorFactory)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Strategies.MethodReflectionStrategy"/>
class.
</summary>
<param name="selector">The selector component.</param>
<param name="injectorFactory">The injector factory component.</param>
</member>
-<member name="M:Ninject.Planning.Strategies.MethodReflectionStrategy.Execute(Ninject.Planning.IPlan)">
-<summary>
Adds a
<see cref="T:Ninject.Planning.Directives.MethodInjectionDirective"/>
to the plan for each methodthat should be injected.
</summary>
<param name="plan">The plan that is being generated.</param>
</member>
-<member name="P:Ninject.Planning.Strategies.MethodReflectionStrategy.Selector">
<summary>Gets the selector component. </summary>
</member>
-<member name="P:Ninject.Planning.Strategies.MethodReflectionStrategy.InjectorFactory">
<summary>Gets the injector factory component. </summary>
</member>
-<member name="T:Ninject.Planning.Strategies.PropertyReflectionStrategy">
<summary>Adds directives to plans indicating which properties should be injected during activation. </summary>
</member>
-<member name="M:Ninject.Planning.Strategies.PropertyReflectionStrategy.#ctor(Ninject.Selection.ISelector,Ninject.Injection.IInjectorFactory)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Strategies.PropertyReflectionStrategy"/>
class.
</summary>
<param name="selector">The selector component.</param>
<param name="injectorFactory">The injector factory component.</param>
</member>
-<member name="M:Ninject.Planning.Strategies.PropertyReflectionStrategy.Execute(Ninject.Planning.IPlan)">
-<summary>
Adds a
<see cref="T:Ninject.Planning.Directives.PropertyInjectionDirective"/>
to the plan for each propertythat should be injected.
</summary>
<param name="plan">The plan that is being generated.</param>
</member>
-<member name="P:Ninject.Planning.Strategies.PropertyReflectionStrategy.Selector">
<summary>Gets the selector component. </summary>
</member>
-<member name="P:Ninject.Planning.Strategies.PropertyReflectionStrategy.InjectorFactory">
<summary>Gets the injector factory component. </summary>
</member>
-<member name="T:Ninject.Planning.Targets.Target`1">
<summary>Represents a site on a type where a value can be injected. </summary>
<typeparam name="T">The type of site this represents.</typeparam>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.#ctor(System.Reflection.MemberInfo,`0)">
<summary>Initializes a new instance of the Target<T> class. </summary>
<param name="member">The member that contains the target.</param>
<param name="site">The site represented by the target.</param>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.GetCustomAttributes(System.Type,System.Boolean)">
<summary>Returns an array of custom attributes of a specified type defined on the target. </summary>
<param name="attributeType">The type of attribute to search for.</param>
<param name="inherit">Whether to look up the hierarchy chain for inherited custom attributes.</param>
<returns>An array of custom attributes of the specified type.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.GetCustomAttributes(System.Boolean)">
<summary>Returns an array of custom attributes defined on the target. </summary>
<param name="inherit">Whether to look up the hierarchy chain for inherited custom attributes.</param>
<returns>An array of custom attributes.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.IsDefined(System.Type,System.Boolean)">
<summary>Returns a value indicating whether an attribute of the specified type is defined on the target. </summary>
<param name="attributeType">The type of attribute to search for.</param>
<param name="inherit">Whether to look up the hierarchy chain for inherited custom attributes.</param>
-<returns>
<c>True</c>
if such an attribute is defined; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.IsDefinedOnParent(System.Type,System.Type)">
<summary>Determines whether the parent has attribute. </summary>
<param name="parent">The parent.</param>
<param name="attributeType">The type of the attribute.</param>
-<returns>
<c>true</c>
if the specified member has attribute; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.ResolveWithin(Ninject.Activation.IContext)">
<summary>Resolves a value for the target within the specified parent context. </summary>
<param name="parent">The parent context.</param>
<returns>The resolved value.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.GetValues(System.Type,Ninject.Activation.IContext)">
<summary>Gets the value(s) that should be injected into the target. </summary>
<param name="service">The service that the target is requesting.</param>
<param name="parent">The parent context in which the target is being injected.</param>
<returns>A series of values that are available for injection.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.GetValue(System.Type,Ninject.Activation.IContext)">
<summary>Gets the value that should be injected into the target. </summary>
<param name="service">The service that the target is requesting.</param>
<param name="parent">The parent context in which the target is being injected.</param>
<returns>The value that is to be injected.</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.ReadOptionalFromTarget">
<summary>Reads whether the target represents an optional dependency. </summary>
-<returns>
<see langword="True"/>
if it is optional; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Targets.Target`1.ReadConstraintFromTarget">
<summary>Reads the resolution constraint from target. </summary>
<returns>The resolution constraint.</returns>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.Member">
<summary>Gets the member that contains the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.Site">
<summary>Gets or sets the site (property, parameter, etc.) represented by the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.Name">
<summary>Gets the name of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.Type">
<summary>Gets the type of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.Constraint">
<summary>Gets the constraint defined on the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.IsOptional">
<summary>Gets a value indicating whether the target represents an optional dependency. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.HasDefaultValue">
<summary>Gets a value indicating whether the target has a default value. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.Target`1.DefaultValue">
<summary>Gets the default value for the target. </summary>
<exception cref="T:System.InvalidOperationException">If the item does not have a default value.</exception>
</member>
-<member name="T:Ninject.Selection.Heuristics.StandardInjectionHeuristic">
<summary>Determines whether members should be injected during activation by checkingif they are decorated with an injection marker attribute. </summary>
</member>
-<member name="M:Ninject.Selection.Heuristics.StandardInjectionHeuristic.ShouldInject(System.Reflection.MemberInfo)">
<summary>Returns a value indicating whether the specified member should be injected. </summary>
<param name="member">The member in question.</param>
-<returns>
<c>True</c>
if the member should be injected; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="T:Ninject.Selection.Heuristics.StandardConstructorScorer">
<summary>Scores constructors by either looking for the existence of an injection markerattribute, or by counting the number of parameters. </summary>
</member>
-<member name="M:Ninject.Selection.Heuristics.StandardConstructorScorer.Score(Ninject.Activation.IContext,Ninject.Planning.Directives.IConstructorInjectionDirective)">
<summary>Gets the score for the specified constructor. </summary>
<param name="context">The injection context.</param>
<param name="directive">The constructor.</param>
<returns>The constructor's score.</returns>
</member>
-<member name="M:Ninject.Selection.Heuristics.StandardConstructorScorer.BindingExists(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Checkes whether a binding exists for a given target. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Whether a binding exists for the target in the given context.</returns>
</member>
-<member name="M:Ninject.Selection.Heuristics.StandardConstructorScorer.BindingExists(Ninject.IKernel,Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Checkes whether a binding exists for a given target on the specified kernel. </summary>
<param name="kernel">The kernel.</param>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Whether a binding exists for the target in the given context.</returns>
</member>
-<member name="M:Ninject.Selection.Heuristics.StandardConstructorScorer.ParameterExists(Ninject.Activation.IContext,Ninject.Planning.Targets.ITarget)">
<summary>Checks whether any parameters exist for the geiven target.. </summary>
<param name="context">The context.</param>
<param name="target">The target.</param>
<returns>Whether a parameter exists for the target in the given context.</returns>
</member>
-<member name="T:Ninject.StandardKernel">
<summary>The standard implementation of a kernel. </summary>
</member>
-<member name="T:Ninject.KernelBase">
-<summary>
The base implementation of an
<see cref="T:Ninject.IKernel"/>
.
</summary>
</member>
-<member name="F:Ninject.KernelBase.HandleMissingBindingLockObject">
<summary>Lock used when adding missing bindings. </summary>
</member>
-<member name="M:Ninject.KernelBase.#ctor">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.KernelBase"/>
class.
</summary>
</member>
-<member name="M:Ninject.KernelBase.#ctor(Ninject.Modules.INinjectModule[])">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.KernelBase"/>
class.
</summary>
<param name="modules">The modules to load into the kernel.</param>
</member>
-<member name="M:Ninject.KernelBase.#ctor(Ninject.INinjectSettings,Ninject.Modules.INinjectModule[])">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.KernelBase"/>
class.
</summary>
<param name="settings">The configuration to use.</param>
<param name="modules">The modules to load into the kernel.</param>
</member>
-<member name="M:Ninject.KernelBase.#ctor(Ninject.Components.IComponentContainer,Ninject.INinjectSettings,Ninject.Modules.INinjectModule[])">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.KernelBase"/>
class.
</summary>
<param name="components">The component container to use.</param>
<param name="settings">The configuration to use.</param>
<param name="modules">The modules to load into the kernel.</param>
</member>
-<member name="M:Ninject.KernelBase.Dispose(System.Boolean)">
<summary>Releases resources held by the object. </summary>
</member>
-<member name="M:Ninject.KernelBase.Unbind(System.Type)">
<summary>Unregisters all bindings for the specified service. </summary>
<param name="service">The service to unbind.</param>
</member>
-<member name="M:Ninject.KernelBase.AddBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Registers the specified binding. </summary>
<param name="binding">The binding to add.</param>
</member>
-<member name="M:Ninject.KernelBase.RemoveBinding(Ninject.Planning.Bindings.IBinding)">
<summary>Unregisters the specified binding. </summary>
<param name="binding">The binding to remove.</param>
</member>
-<member name="M:Ninject.KernelBase.HasModule(System.String)">
<summary>Determines whether a module with the specified name has been loaded in the kernel. </summary>
<param name="name">The name of the module.</param>
-<returns>
<c>True</c>
if the specified module has been loaded; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.GetModules">
<summary>Gets the modules that have been loaded into the kernel. </summary>
<returns>A series of loaded modules.</returns>
</member>
-<member name="M:Ninject.KernelBase.Load(System.Collections.Generic.IEnumerable{Ninject.Modules.INinjectModule})">
<summary>Loads the module(s) into the kernel. </summary>
<param name="m">The modules to load.</param>
</member>
-<member name="M:Ninject.KernelBase.Load(System.Collections.Generic.IEnumerable{System.String})">
<summary>Loads modules from the files that match the specified pattern(s). </summary>
<param name="filePatterns">The file patterns (i.e. "*.dll", "modules/*.rb") to match.</param>
</member>
-<member name="M:Ninject.KernelBase.Load(System.Collections.Generic.IEnumerable{System.Reflection.Assembly})">
<summary>Loads modules defined in the specified assemblies. </summary>
<param name="assemblies">The assemblies to search.</param>
</member>
-<member name="M:Ninject.KernelBase.Unload(System.String)">
<summary>Unloads the plugin with the specified name. </summary>
<param name="name">The plugin's name.</param>
</member>
-<member name="M:Ninject.KernelBase.Inject(System.Object,Ninject.Parameters.IParameter[])">
<summary>Injects the specified existing instance, without managing its lifecycle. </summary>
<param name="instance">The instance to inject.</param>
<param name="parameters">The parameters to pass to the request.</param>
</member>
-<member name="M:Ninject.KernelBase.Release(System.Object)">
<summary>Deactivates and releases the specified instance if it is currently managed by Ninject. </summary>
<param name="instance">The instance to release.</param>
-<returns>
<see langword="True"/>
if the instance was found and released; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.CanResolve(Ninject.Activation.IRequest)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.CanResolve(Ninject.Activation.IRequest,System.Boolean)">
<summary>Determines whether the specified request can be resolved. </summary>
<param name="request">The request.</param>
-<param name="ignoreImplicitBindings">
if set to
<c>true</c>
implicit bindings are ignored.
</param>
-<returns>
<c>True</c>
if the request can be resolved; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.Resolve(Ninject.Activation.IRequest)">
<summary>Resolves instances for the specified request. The instances are not actually resolveduntil a consumer iterates over the enumerator. </summary>
<param name="request">The request to resolve.</param>
<returns>An enumerator of instances that match the request.</returns>
</member>
-<member name="M:Ninject.KernelBase.CreateRequest(System.Type,System.Func{Ninject.Planning.Bindings.IBindingMetadata,System.Boolean},System.Collections.Generic.IEnumerable{Ninject.Parameters.IParameter},System.Boolean,System.Boolean)">
<summary>Creates a request for the specified service. </summary>
<param name="service">The service that is being requested.</param>
<param name="constraint">The constraint to apply to the bindings to determine if they match the request.</param>
<param name="parameters">The parameters to pass to the resolution.</param>
-<param name="isOptional">
<c>True</c>
if the request is optional; otherwise,
<c>false</c>
.
</param>
-<param name="isUnique">
<c>True</c>
if the request should return a unique result; otherwise,
<c>false</c>
.
</param>
<returns>The created request.</returns>
</member>
-<member name="M:Ninject.KernelBase.BeginBlock">
<summary>Begins a new activation block, which can be used to deterministically dispose resolved instances. </summary>
<returns>The new activation block.</returns>
</member>
-<member name="M:Ninject.KernelBase.GetBindings(System.Type)">
<summary>Gets the bindings registered for the specified service. </summary>
<param name="service">The service in question.</param>
<returns>A series of bindings that are registered for the service.</returns>
</member>
-<member name="M:Ninject.KernelBase.GetBindingPrecedenceComparer">
<summary>Returns an IComparer that is used to determine resolution precedence. </summary>
<returns>An IComparer that is used to determine resolution precedence.</returns>
</member>
-<member name="M:Ninject.KernelBase.SatifiesRequest(Ninject.Activation.IRequest)">
<summary>Returns a predicate that can determine if a given IBinding matches the request. </summary>
<param name="request">The request/</param>
<returns>A predicate that can determine if a given IBinding matches the request.</returns>
</member>
-<member name="M:Ninject.KernelBase.AddComponents">
<summary>Adds components to the kernel during startup. </summary>
</member>
-<member name="M:Ninject.KernelBase.HandleMissingBinding(System.Type)">
<summary>Attempts to handle a missing binding for a service. </summary>
<param name="service">The service.</param>
-<returns>
<c>True</c>
if the missing binding can be handled; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.HandleMissingBinding(Ninject.Activation.IRequest)">
<summary>Attempts to handle a missing binding for a request. </summary>
<param name="request">The request.</param>
-<returns>
<c>True</c>
if the missing binding can be handled; otherwise
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.TypeIsSelfBindable(System.Type)">
<summary>Returns a value indicating whether the specified service is self-bindable. </summary>
<param name="service">The service.</param>
-<returns>
<see langword="True"/>
if the type is self-bindable; otherwise
<see langword="false"/>
.
</returns>
</member>
-<member name="M:Ninject.KernelBase.CreateContext(Ninject.Activation.IRequest,Ninject.Planning.Bindings.IBinding)">
<summary>Creates a context for the specified request and binding. </summary>
<param name="request">The request.</param>
<param name="binding">The binding.</param>
<returns>The created context.</returns>
</member>
-<member name="P:Ninject.KernelBase.Settings">
<summary>Gets the kernel settings. </summary>
</member>
-<member name="P:Ninject.KernelBase.Components">
<summary>Gets the component container, which holds components that contribute to Ninject. </summary>
</member>
-<member name="M:Ninject.StandardKernel.#ctor(Ninject.Modules.INinjectModule[])">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.StandardKernel"/>
class.
</summary>
<param name="modules">The modules to load into the kernel.</param>
</member>
-<member name="M:Ninject.StandardKernel.#ctor(Ninject.INinjectSettings,Ninject.Modules.INinjectModule[])">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.StandardKernel"/>
class.
</summary>
<param name="settings">The configuration to use.</param>
<param name="modules">The modules to load into the kernel.</param>
</member>
-<member name="M:Ninject.StandardKernel.AddComponents">
<summary>Adds components to the kernel during startup. </summary>
</member>
-<member name="P:Ninject.StandardKernel.KernelInstance">
<summary>Gets the kernel. </summary>
<value>The kernel.</value>
</member>
-<member name="T:Ninject.Planning.Directives.PropertyInjectionDirective">
<summary>Describes the injection of a property. </summary>
</member>
-<member name="M:Ninject.Planning.Directives.PropertyInjectionDirective.#ctor(System.Reflection.PropertyInfo,Ninject.Injection.PropertyInjector)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Directives.PropertyInjectionDirective"/>
class.
</summary>
<param name="member">The member the directive describes.</param>
<param name="injector">The injector that will be triggered.</param>
</member>
-<member name="M:Ninject.Planning.Directives.PropertyInjectionDirective.CreateTarget(System.Reflection.PropertyInfo)">
<summary>Creates a target for the property. </summary>
<param name="propertyInfo">The property.</param>
<returns>The target for the property.</returns>
</member>
-<member name="P:Ninject.Planning.Directives.PropertyInjectionDirective.Injector">
<summary>Gets or sets the injector that will be triggered. </summary>
</member>
-<member name="P:Ninject.Planning.Directives.PropertyInjectionDirective.Target">
<summary>Gets or sets the injection target for the directive. </summary>
</member>
-<member name="T:Ninject.Planning.Targets.PropertyTarget">
-<summary>
Represents an injection target for a
<see cref="T:System.Reflection.PropertyInfo"/>
.
</summary>
</member>
-<member name="M:Ninject.Planning.Targets.PropertyTarget.#ctor(System.Reflection.PropertyInfo)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Targets.PropertyTarget"/>
class.
</summary>
<param name="site">The property that this target represents.</param>
</member>
-<member name="P:Ninject.Planning.Targets.PropertyTarget.Name">
<summary>Gets the name of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.PropertyTarget.Type">
<summary>Gets the type of the target. </summary>
</member>
-<member name="T:Ninject.Planning.Targets.ParameterTarget">
-<summary>
Represents an injection target for a
<see cref="T:System.Reflection.ParameterInfo"/>
.
</summary>
</member>
-<member name="M:Ninject.Planning.Targets.ParameterTarget.#ctor(System.Reflection.MethodBase,System.Reflection.ParameterInfo)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Targets.ParameterTarget"/>
class.
</summary>
<param name="method">The method that defines the parameter.</param>
<param name="site">The parameter that this target represents.</param>
</member>
-<member name="P:Ninject.Planning.Targets.ParameterTarget.Name">
<summary>Gets the name of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ParameterTarget.Type">
<summary>Gets the type of the target. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ParameterTarget.HasDefaultValue">
<summary>Gets a value indicating whether the target has a default value. </summary>
</member>
-<member name="P:Ninject.Planning.Targets.ParameterTarget.DefaultValue">
<summary>Gets the default value for the target. </summary>
<exception cref="T:System.InvalidOperationException">If the item does not have a default value.</exception>
</member>
-<member name="T:Ninject.Selection.Selector">
<summary>Selects members for injection. </summary>
</member>
-<member name="M:Ninject.Selection.Selector.#ctor(Ninject.Selection.Heuristics.IConstructorScorer,System.Collections.Generic.IEnumerable{Ninject.Selection.Heuristics.IInjectionHeuristic})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Selection.Selector"/>
class.
</summary>
<param name="constructorScorer">The constructor scorer.</param>
<param name="injectionHeuristics">The injection heuristics.</param>
</member>
-<member name="M:Ninject.Selection.Selector.SelectConstructorsForInjection(System.Type)">
<summary>Selects the constructor to call on the specified type, by using the constructor scorer. </summary>
<param name="type">The type.</param>
-<returns>
The selected constructor, or
<see langword="null"/>
if none were available.
</returns>
</member>
-<member name="M:Ninject.Selection.Selector.SelectPropertiesForInjection(System.Type)">
<summary>Selects properties that should be injected. </summary>
<param name="type">The type.</param>
<returns>A series of the selected properties.</returns>
</member>
-<member name="M:Ninject.Selection.Selector.SelectMethodsForInjection(System.Type)">
<summary>Selects methods that should be injected. </summary>
<param name="type">The type.</param>
<returns>A series of the selected methods.</returns>
</member>
-<member name="P:Ninject.Selection.Selector.Flags">
<summary>Gets the default binding flags. </summary>
</member>
-<member name="P:Ninject.Selection.Selector.ConstructorScorer">
<summary>Gets or sets the constructor scorer. </summary>
</member>
-<member name="P:Ninject.Selection.Selector.InjectionHeuristics">
<summary>Gets the property injection heuristics. </summary>
</member>
-<member name="T:Ninject.Planning.Strategies.ConstructorReflectionStrategy">
<summary>Adds a directive to plans indicating which constructor should be injected during activation. </summary>
</member>
-<member name="M:Ninject.Planning.Strategies.ConstructorReflectionStrategy.#ctor(Ninject.Selection.ISelector,Ninject.Injection.IInjectorFactory)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Strategies.ConstructorReflectionStrategy"/>
class.
</summary>
<param name="selector">The selector component.</param>
<param name="injectorFactory">The injector factory component.</param>
</member>
-<member name="M:Ninject.Planning.Strategies.ConstructorReflectionStrategy.Execute(Ninject.Planning.IPlan)">
-<summary>
Adds a
<see cref="T:Ninject.Planning.Directives.ConstructorInjectionDirective"/>
to the plan for the constructorthat should be injected.
</summary>
<param name="plan">The plan that is being generated.</param>
</member>
-<member name="P:Ninject.Planning.Strategies.ConstructorReflectionStrategy.Selector">
<summary>Gets the selector component. </summary>
</member>
-<member name="P:Ninject.Planning.Strategies.ConstructorReflectionStrategy.InjectorFactory">
<summary>Gets the injector factory component. </summary>
</member>
-<member name="T:Ninject.Planning.Planner">
<summary>Generates plans for how to activate instances. </summary>
</member>
-<member name="M:Ninject.Planning.Planner.#ctor(System.Collections.Generic.IEnumerable{Ninject.Planning.Strategies.IPlanningStrategy})">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Planner"/>
class.
</summary>
<param name="strategies">The strategies to execute during planning.</param>
</member>
-<member name="M:Ninject.Planning.Planner.GetPlan(System.Type)">
<summary>Gets or creates an activation plan for the specified type. </summary>
<param name="type">The type for which a plan should be created.</param>
<returns>The type's activation plan.</returns>
</member>
-<member name="M:Ninject.Planning.Planner.CreateEmptyPlan(System.Type)">
<summary>Creates an empty plan for the specified type. </summary>
<param name="type">The type for which a plan should be created.</param>
<returns>The created plan.</returns>
</member>
-<member name="M:Ninject.Planning.Planner.CreateNewPlan(System.Type)">
<summary>Creates a new plan for the specified type.This method requires an active reader lock! </summary>
<param name="type">The type.</param>
<returns>The newly created plan.</returns>
</member>
-<member name="P:Ninject.Planning.Planner.Strategies">
<summary>Gets the strategies that contribute to the planning process. </summary>
</member>
-<member name="T:Ninject.Planning.Plan">
<summary>Describes the means by which a type should be activated. </summary>
</member>
-<member name="M:Ninject.Planning.Plan.#ctor(System.Type)">
-<summary>
Initializes a new instance of the
<see cref="T:Ninject.Planning.Plan"/>
class.
</summary>
<param name="type">The type the plan describes.</param>
</member>
-<member name="M:Ninject.Planning.Plan.Add(Ninject.Planning.Directives.IDirective)">
<summary>Adds the specified directive to the plan. </summary>
<param name="directive">The directive.</param>
</member>
-<member name="M:Ninject.Planning.Plan.Has``1">
<summary>Determines whether the plan contains one or more directives of the specified type. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
-<returns>
<c>True</c>
if the plan has one or more directives of the type; otherwise,
<c>false</c>
.
</returns>
</member>
-<member name="M:Ninject.Planning.Plan.GetOne``1">
<summary>Gets the first directive of the specified type from the plan. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
-<returns>
The first directive, or
<see langword="null"/>
if no matching directives exist.
</returns>
</member>
-<member name="M:Ninject.Planning.Plan.GetAll``1">
<summary>Gets all directives of the specified type that exist in the plan. </summary>
<typeparam name="TDirective">The type of directive.</typeparam>
<returns>A series of directives of the specified type.</returns>
</member>
-<member name="P:Ninject.Planning.Plan.Type">
<summary>Gets the type that the plan describes. </summary>
</member>
-<member name="P:Ninject.Planning.Plan.Directives">
<summary>Gets the directives defined in the plan. </summary>
</member>
</members>
</doc>Protobuf-net
<?xml version="1.0"?>
-<doc>
-<assembly>
<name>protobuf-net</name>
</assembly>
-<members>
-<member name="T:ProtoBuf.BclHelpers">
<summary>Provides support for common .NET types that do not have a direct representationin protobuf, using the definitions from bcl.proto </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.GetUninitializedObject(System.Type)">
<summary>Creates a new instance of the specified type, bypassing the constructor. </summary>
<param name="type">The type to create</param>
<returns>The new instance</returns>
<exception cref="T:System.NotSupportedException">If the platform does not support constructor-skipping</exception>
</member>
-<member name="M:ProtoBuf.BclHelpers.WriteTimeSpan(System.TimeSpan,ProtoBuf.ProtoWriter)">
<summary>Writes a TimeSpan to a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.ReadTimeSpan(ProtoBuf.ProtoReader)">
<summary>Parses a TimeSpan from a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.ReadDateTime(ProtoBuf.ProtoReader)">
<summary>Parses a DateTime from a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.WriteDateTime(System.DateTime,ProtoBuf.ProtoWriter)">
<summary>Writes a DateTime to a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.ReadDecimal(ProtoBuf.ProtoReader)">
<summary>Parses a decimal from a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.WriteDecimal(System.Decimal,ProtoBuf.ProtoWriter)">
<summary>Writes a decimal to a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.WriteGuid(System.Guid,ProtoBuf.ProtoWriter)">
<summary>Writes a Guid to a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.ReadGuid(ProtoBuf.ProtoReader)">
<summary>Parses a Guid from a protobuf stream </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.ReadNetObject(System.Object,ProtoBuf.ProtoReader,System.Int32,System.Type,ProtoBuf.BclHelpers.NetObjectOptions)">
<summary>Reads an *implementation specific* bundled .NET object, including (as options) type-metadata, identity/re-use, etc. </summary>
</member>
-<member name="M:ProtoBuf.BclHelpers.WriteNetObject(System.Object,ProtoBuf.ProtoWriter,System.Int32,ProtoBuf.BclHelpers.NetObjectOptions)">
<summary>Writes an *implementation specific* bundled .NET object, including (as options) type-metadata, identity/re-use, etc. </summary>
</member>
-<member name="T:ProtoBuf.BclHelpers.NetObjectOptions">
<summary>Optional behaviours that introduce .NET-specific functionality </summary>
</member>
-<member name="F:ProtoBuf.BclHelpers.NetObjectOptions.None">
<summary>No special behaviour </summary>
</member>
-<member name="F:ProtoBuf.BclHelpers.NetObjectOptions.AsReference">
<summary>Enables full object-tracking/full-graph support. </summary>
</member>
-<member name="F:ProtoBuf.BclHelpers.NetObjectOptions.DynamicType">
<summary>Embeds the type information into the stream, allowing usage with types not known in advance. </summary>
</member>
-<member name="F:ProtoBuf.BclHelpers.NetObjectOptions.UseConstructor">
<summary>If false, the constructor for the type is bypassed during deserialization, meaning any field initializersor other initialization code is skipped. </summary>
</member>
-<member name="F:ProtoBuf.BclHelpers.NetObjectOptions.LateSet">
<summary>Should the object index be reserved, rather than creating an object promptly </summary>
</member>
-<member name="T:ProtoBuf.BufferExtension">
-<summary>
Provides a simple buffer-based implementation of an
<see cref="T:ProtoBuf.IExtension">extension</see>
object.
</summary>
</member>
-<member name="T:ProtoBuf.IExtension">
<summary>Provides addition capability for supporting unexpected fields duringprotocol-buffer serialization/deserialization. This allows for loss-lessround-trip/merge, even when the data is not fully understood. </summary>
</member>
-<member name="M:ProtoBuf.IExtension.BeginAppend">
<summary>Requests a stream into which any unexpected fields can be persisted. </summary>
<returns>A new stream suitable for storing data.</returns>
</member>
-<member name="M:ProtoBuf.IExtension.EndAppend(System.IO.Stream,System.Boolean)">
<summary>Indicates that all unexpected fields have now been stored. Theimplementing class is responsible for closing the stream. If"commit" is not true the data may be discarded. </summary>
<param name="stream">The stream originally obtained by BeginAppend.</param>
<param name="commit">True if the append operation completed successfully.</param>
</member>
-<member name="M:ProtoBuf.IExtension.BeginQuery">
<summary>Requests a stream of the unexpected fields previously stored. </summary>
<returns>A prepared stream of the unexpected fields.</returns>
</member>
-<member name="M:ProtoBuf.IExtension.EndQuery(System.IO.Stream)">
<summary>Indicates that all unexpected fields have now been read. Theimplementing class is responsible for closing the stream. </summary>
<param name="stream">The stream originally obtained by BeginQuery.</param>
</member>
-<member name="M:ProtoBuf.IExtension.GetLength">
<summary>Requests the length of the raw binary stream; this is usedwhen serializing sub-entities to indicate the expected size. </summary>
<returns>The length of the binary stream representing unexpected data.</returns>
</member>
-<member name="T:ProtoBuf.ProtoBeforeSerializationAttribute">
<summary>Specifies a method on the root-contract in an hierarchy to be invoked before serialization.</summary>
</member>
-<member name="T:ProtoBuf.ProtoAfterSerializationAttribute">
<summary>Specifies a method on the root-contract in an hierarchy to be invoked after serialization.</summary>
</member>
-<member name="T:ProtoBuf.ProtoBeforeDeserializationAttribute">
<summary>Specifies a method on the root-contract in an hierarchy to be invoked before deserialization.</summary>
</member>
-<member name="T:ProtoBuf.ProtoAfterDeserializationAttribute">
<summary>Specifies a method on the root-contract in an hierarchy to be invoked after deserialization.</summary>
</member>
-<member name="M:ProtoBuf.Compiler.CompilerContext.LoadNullRef">
<summary>Pushes a null reference onto the stack. Note that this should onlybe used to return a null (or set a variable to null); for null-testsuse BranchIfTrue / BranchIfFalse. </summary>
</member>
-<member name="M:ProtoBuf.Compiler.CompilerContext.UsingBlock.#ctor(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
<summary>Creates a new "using" block (equivalent) around a variable;the variable must exist, and note that (unlike in C#) it isthe variables *final* value that gets disposed. If you need*original* disposal, copy your variable first.It is the callers responsibility to ensure that the variable'sscope fully-encapsulates the "using"; if not, the variablemay be re-used (and thus re-assigned) unexpectedly. </summary>
</member>
-<member name="T:ProtoBuf.DataFormat">
<summary>Sub-format to use when serializing/deserializing data </summary>
</member>
-<member name="F:ProtoBuf.DataFormat.Default">
<summary>Uses the default encoding for the data-type. </summary>
</member>
-<member name="F:ProtoBuf.DataFormat.ZigZag">
<summary>When applied to signed integer-based data (including Decimal), thisindicates that zigzag variant encoding will be used. This means that valueswith small magnitude (regardless of sign) take a small amountof space to encode. </summary>
</member>
-<member name="F:ProtoBuf.DataFormat.TwosComplement">
<summary>When applied to signed integer-based data (including Decimal), thisindicates that two's-complement variant encoding will be used.This means that any -ve number will take 10 bytes (even for 32-bit),so should only be used for compatibility. </summary>
</member>
-<member name="F:ProtoBuf.DataFormat.FixedSize">
<summary>When applied to signed integer-based data (including Decimal), thisindicates that a fixed amount of space will be used. </summary>
</member>
-<member name="F:ProtoBuf.DataFormat.Group">
<summary>When applied to a sub-message, indicates that the value should be treatedas group-delimited. </summary>
</member>
-<member name="T:ProtoBuf.Extensible">
<summary>Simple base class for supporting unexpected fields allowingfor loss-less round-tips/merge, even if the data is not understod.The additional fields are (by default) stored in-memory in a buffer. </summary>
<remarks>As an example of an alternative implementation, you mightchoose to use the file system (temporary files) as the back-end, trackingonly the paths [such an object would ideally be IDisposable and usea finalizer to ensure that the files are removed].</remarks>
<seealso cref="T:ProtoBuf.IExtensible"/>
</member>
-<member name="T:ProtoBuf.IExtensible">
-<summary>
Indicates that the implementing type has support for protocol-buffer
<see cref="T:ProtoBuf.IExtension">extensions</see>
.
</summary>
<remarks>Can be implemented by deriving from Extensible.</remarks>
</member>
-<member name="M:ProtoBuf.IExtensible.GetExtensionObject(System.Boolean)">
-<summary>
Retrieves the
<see cref="T:ProtoBuf.IExtension">extension</see>
object for the currentinstance, optionally creating it if it does not already exist.
</summary>
<param name="createIfMissing">Should a new extension object becreated if it does not already exist?</param>
<returns>The extension object if it exists (or was created), or nullif the extension object does not exist or is not available.</returns>
-<remarks>
The
<c>createIfMissing</c>
argument is false during serialization,and true during deserialization upon encountering unexpected fields.
</remarks>
</member>
-<member name="M:ProtoBuf.Extensible.GetExtensionObject(System.Boolean)">
-<summary>
Retrieves the
<see cref="T:ProtoBuf.IExtension">extension</see>
object for the currentinstance, optionally creating it if it does not already exist.
</summary>
<param name="createIfMissing">Should a new extension object becreated if it does not already exist?</param>
<returns>The extension object if it exists (or was created), or nullif the extension object does not exist or is not available.</returns>
-<remarks>
The
<c>createIfMissing</c>
argument is false during serialization,and true during deserialization upon encountering unexpected fields.
</remarks>
</member>
-<member name="M:ProtoBuf.Extensible.GetExtensionObject(ProtoBuf.IExtension@,System.Boolean)">
-<summary>
Provides a simple, default implementation for
<see cref="T:ProtoBuf.IExtension">extension</see>
support,optionally creating it if it does not already exist. Designed to be called byclasses implementing
<see cref="T:ProtoBuf.IExtensible"/>
.
</summary>
<param name="createIfMissing">Should a new extension object becreated if it does not already exist?</param>
<param name="extensionObject">The extension field to check (and possibly update).</param>
<returns>The extension object if it exists (or was created), or nullif the extension object does not exist or is not available.</returns>
-<remarks>
The
<c>createIfMissing</c>
argument is false during serialization,and true during deserialization upon encountering unexpected fields.
</remarks>
</member>
-<member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,``0)">
<summary>Appends the value as an additional (unexpected) data-field for the instance.Note that for non-repeated sub-objects, this equates to a merge operation;for repeated sub-objects this adds a new instance to the set; for simplevalues the new value supercedes the old value. </summary>
<remarks>Note that appending a value does not remove the old value fromthe stream; avoid repeatedly appending values for the same field.</remarks>
<typeparam name="TValue">The type of the value to append.</typeparam>
<param name="instance">The extensible object to append the value to.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="value">The value to append.</param>
</member>
-<member name="M:ProtoBuf.Extensible.AppendValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0)">
<summary>Appends the value as an additional (unexpected) data-field for the instance.Note that for non-repeated sub-objects, this equates to a merge operation;for repeated sub-objects this adds a new instance to the set; for simplevalues the new value supercedes the old value. </summary>
<remarks>Note that appending a value does not remove the old value fromthe stream; avoid repeatedly appending values for the same field.</remarks>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="format">The data-format to use when encoding the value.</param>
<param name="instance">The extensible object to append the value to.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="value">The value to append.</param>
</member>
-<member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned is the composed value after merging any duplicated content; if thevalue is "repeated" (a list), then use GetValues instead. </summary>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<returns>The effective value of the field, or the default value if not found.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.GetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned is the composed value after merging any duplicated content; if thevalue is "repeated" (a list), then use GetValues instead. </summary>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<returns>The effective value of the field, or the default value if not found.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,``0@)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned (in "value") is the composed value after merging any duplicated content;if the value is "repeated" (a list), then use GetValues instead. </summary>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="value">The effective value of the field, or the default value if not found.</param>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<returns>True if data for the field was present, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,``0@)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned (in "value") is the composed value after merging any duplicated content;if the value is "repeated" (a list), then use GetValues instead. </summary>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="value">The effective value of the field, or the default value if not found.</param>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<returns>True if data for the field was present, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.TryGetValue``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,``0@)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned (in "value") is the composed value after merging any duplicated content;if the value is "repeated" (a list), then use GetValues instead. </summary>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="value">The effective value of the field, or the default value if not found.</param>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<param name="allowDefinedTag">Allow tags that are present as part of the definition; for example, to query unknown enum values.</param>
<returns>True if data for the field was present, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.Each occurrence of the field is yielded separately, making this usage suitable for "repeated"(list) fields. </summary>
<remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<returns>An enumerator that yields each occurrence of the field.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.GetValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.Each occurrence of the field is yielded separately, making this usage suitable for "repeated"(list) fields. </summary>
<remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
<typeparam name="TValue">The data-type of the field.</typeparam>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<returns>An enumerator that yields each occurrence of the field.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.TryGetValue(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Object@)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.The value returned (in "value") is the composed value after merging any duplicated content;if the value is "repeated" (a list), then use GetValues instead. </summary>
<param name="type">The data-type of the field.</param>
<param name="model">The model to use for configuration.</param>
<param name="value">The effective value of the field, or the default value if not found.</param>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<param name="allowDefinedTag">Allow tags that are present as part of the definition; for example, to query unknown enum values.</param>
<returns>True if data for the field was present, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.GetValues(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat)">
<summary>Queries an extensible object for an additional (unexpected) data-field for the instance.Each occurrence of the field is yielded separately, making this usage suitable for "repeated"(list) fields. </summary>
<remarks>The extended data is processed lazily as the enumerator is iterated.</remarks>
<param name="model">The model to use for configuration.</param>
<param name="type">The data-type of the field.</param>
<param name="instance">The extensible object to obtain the value from.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="format">The data-format to use when decoding the value.</param>
<returns>An enumerator that yields each occurrence of the field.</returns>
</member>
-<member name="M:ProtoBuf.Extensible.AppendValue(ProtoBuf.Meta.TypeModel,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Object)">
<summary>Appends the value as an additional (unexpected) data-field for the instance.Note that for non-repeated sub-objects, this equates to a merge operation;for repeated sub-objects this adds a new instance to the set; for simplevalues the new value supercedes the old value. </summary>
<remarks>Note that appending a value does not remove the old value fromthe stream; avoid repeatedly appending values for the same field.</remarks>
<param name="model">The model to use for configuration.</param>
<param name="format">The data-format to use when encoding the value.</param>
<param name="instance">The extensible object to append the value to.</param>
<param name="tag">The field identifier; the tag should not be defined as a known data-field for the instance.</param>
<param name="value">The value to append.</param>
</member>
-<member name="T:ProtoBuf.ExtensibleUtil">
<summary>This class acts as an internal wrapper allowing us to do a dynamicmethodinfo invoke; an't put into Serializer as don't want on publicAPI; can't put into Serializer<T> since we need to invokeaccross classes, which isn't allowed in Silverlight) </summary>
</member>
-<member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValues``1(ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
<summary>All this does is call GetExtendedValuesTyped with the correct type for "instance";this ensures that we don't get issues with subclasses declaring conflicting types - the caller must respect the fields defined for the type they pass in. </summary>
</member>
-<member name="M:ProtoBuf.ExtensibleUtil.GetExtendedValues(ProtoBuf.Meta.TypeModel,System.Type,ProtoBuf.IExtensible,System.Int32,ProtoBuf.DataFormat,System.Boolean,System.Boolean)">
<summary>All this does is call GetExtendedValuesTyped with the correct type for "instance";this ensures that we don't get issues with subclasses declaring conflicting types - the caller must respect the fields defined for the type they pass in. </summary>
</member>
-<member name="T:ProtoBuf.Helpers">
<summary>Not all frameworks are created equal (fx1.1 vs fx2.0,micro-framework, compact-framework,silverlight, etc). This class simply wraps up a few things that wouldotherwise make the real code unnecessarily messy, providing fallbackimplementations if necessary. </summary>
</member>
-<member name="T:ProtoBuf.ProtoTypeCode">
<summary>Intended to be a direct map to regular TypeCode, but: - with missing types - existing on WinRT </summary>
</member>
-<member name="T:ProtoBuf.ImplicitFields">
<summary>Specifies the method used to infer field tags for members of the typeunder consideration. Tags are deduced using the invariant alphabeticsequence of the members' names; this makes implicit field tags very brittle,and susceptible to changes such as field names (normally an isolatedchange). </summary>
</member>
-<member name="F:ProtoBuf.ImplicitFields.None">
<summary>No members are serialized implicitly; all members require a suitableattribute such as [ProtoMember]. This is the recmomended mode formost scenarios. </summary>
</member>
-<member name="F:ProtoBuf.ImplicitFields.AllPublic">
<summary>Public properties and fields are eligible for implicit serialization;this treats the public API as a contract. Ordering beings from ImplicitFirstTag. </summary>
</member>
-<member name="F:ProtoBuf.ImplicitFields.AllFields">
<summary>Public and non-public fields are eligible for implicit serialization;this acts as a state/implementation serializer. Ordering beings from ImplicitFirstTag. </summary>
</member>
-<member name="T:ProtoBuf.Meta.CallbackSet">
<summary>Represents the set of serialization callbacks to be used when serializing/deserializing a type. </summary>
</member>
-<member name="P:ProtoBuf.Meta.CallbackSet.BeforeSerialize">
<summary>Called before serializing an instance</summary>
</member>
-<member name="P:ProtoBuf.Meta.CallbackSet.BeforeDeserialize">
<summary>Called before deserializing an instance</summary>
</member>
-<member name="P:ProtoBuf.Meta.CallbackSet.AfterSerialize">
<summary>Called after serializing an instance</summary>
</member>
-<member name="P:ProtoBuf.Meta.CallbackSet.AfterDeserialize">
<summary>Called after deserializing an instance</summary>
</member>
-<member name="P:ProtoBuf.Meta.CallbackSet.NonTrivial">
<summary>True if any callback is set, else False </summary>
</member>
-<member name="T:ProtoBuf.Meta.MetaType">
<summary>Represents a type at runtime for use with protobuf, allowing the field mappings (etc) to be defined </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.ToString">
<summary>Get the name of the type being represented </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.AddSubType(System.Int32,System.Type)">
<summary>Adds a known sub-type to the inheritance model </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.AddSubType(System.Int32,System.Type,ProtoBuf.DataFormat)">
<summary>Adds a known sub-type to the inheritance model </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.SetCallbacks(System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo)">
<summary>Assigns the callbacks to use during serialiation/deserialization. </summary>
<param name="beforeSerialize">The method (or null) called before serialization begins.</param>
<param name="afterSerialize">The method (or null) called when serialization is complete.</param>
<param name="beforeDeserialize">The method (or null) called before deserialization begins (or when a new instance is created during deserialization).</param>
<param name="afterDeserialize">The method (or null) called when deserialization is complete.</param>
<returns>The set of callbacks.</returns>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.SetCallbacks(System.String,System.String,System.String,System.String)">
<summary>Assigns the callbacks to use during serialiation/deserialization. </summary>
<param name="beforeSerialize">The name of the method (or null) called before serialization begins.</param>
<param name="afterSerialize">The name of the method (or null) called when serialization is complete.</param>
<param name="beforeDeserialize">The name of the method (or null) called before deserialization begins (or when a new instance is created during deserialization).</param>
<param name="afterDeserialize">The name of the method (or null) called when deserialization is complete.</param>
<returns>The set of callbacks.</returns>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.SetFactory(System.Reflection.MethodInfo)">
<summary>Designate a factory-method to use to create instances of this type </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.SetFactory(System.String)">
<summary>Designate a factory-method to use to create instances of this type </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.ThrowIfFrozen">
<summary>Throws an exception if the type has been made immutable </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String)">
<summary>Adds a member (by name) to the MetaType </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.AddField(System.Int32,System.String)">
<summary>Adds a member (by name) to the MetaType, returning the ValueMember rather than the fluent API.This is otherwise identical to Add. </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.Add(System.String)">
<summary>Adds a member (by name) to the MetaType </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.SetSurrogate(System.Type)">
<summary>Performs serialization of this type via a surrogate; allother serialization options are ignored and handledby the surrogate's configuration. </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.Add(System.String[])">
<summary>Adds a set of members (by name) to the MetaType </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String,System.Object)">
<summary>Adds a member (by name) to the MetaType </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.Add(System.Int32,System.String,System.Type,System.Type)">
<summary>Adds a member (by name) to the MetaType, including an itemType and defaultType for representing lists </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.AddField(System.Int32,System.String,System.Type,System.Type)">
<summary>Adds a member (by name) to the MetaType, including an itemType and defaultType for representing lists, returning the ValueMember rather than the fluent API.This is otherwise identical to Add. </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.GetFields">
<summary>Returns the ValueMember instances associated with this type </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.GetSubtypes">
<summary>Returns the SubType instances associated with this type </summary>
</member>
-<member name="M:ProtoBuf.Meta.MetaType.CompileInPlace">
<summary>Compiles the serializer for this type; this is *not* a fullstandalone compile, but can significantly boost performancewhile allowing additional types to be added. </summary>
<remarks>An in-place compile can access non-public types / members</remarks>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.BaseType">
<summary>Gets the base-type for this type </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.IncludeSerializerMethod">
<summary>When used to compile a model, should public serialization/deserialzation methodsbe included for this type? </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.AsReferenceDefault">
<summary>Should this type be treated as a reference by default? </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.HasCallbacks">
<summary>Indicates whether the current type has defined callbacks </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.HasSubtypes">
<summary>Indicates whether the current type has defined subtypes </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.Callbacks">
<summary>Returns the set of callbacks defined for this type </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.Name">
<summary>Gets or sets the name of this contract. </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.Type">
<summary>The runtime type that the meta-type represents </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.UseConstructor">
<summary>Gets or sets whether the type should use a parameterless constructor (the default),or whether the type should skip the constructor completely. This option is not supportedon compact-framework. </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.ConstructType">
<summary>The concrete type to create when a new instance of this type is needed; this may be useful when dealingwith dynamic proxies, or with interface-based APIs </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.Item(System.Int32)">
<summary>Returns the ValueMember that matchs a given field number, or null if not found </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.Item(System.Reflection.MemberInfo)">
<summary>Returns the ValueMember that matchs a given member (property/field), or null if not found </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.EnumPassthru">
<summary>Gets or sets a value indicating that an enum should be treated directly as an int/short/etc, ratherthan enforcing .proto enum rules. This is useful *in particul* for [Flags] enums. </summary>
</member>
-<member name="P:ProtoBuf.Meta.MetaType.IgnoreListHandling">
<summary>Gets or sets a value indicating that this type should NOT be treated as a list, even if it hasfamiliar list-like characteristics (enumerable, add, etc) </summary>
</member>
-<member name="T:ProtoBuf.Meta.RuntimeTypeModel">
<summary>Provides protobuf serialization support for a number of types that can be defined at runtime </summary>
</member>
-<member name="T:ProtoBuf.Meta.TypeModel">
<summary>Provides protobuf serialization support for a number of types </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.MapType(System.Type)">
<summary>Resolve a System.Type to the compiler-specific type </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.MapType(System.Type,System.Boolean)">
<summary>Resolve a System.Type to the compiler-specific type </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.TrySerializeAuxiliaryType(ProtoBuf.ProtoWriter,System.Type,ProtoBuf.DataFormat,System.Int32,System.Object,System.Boolean)">
<summary>This is the more "complete" version of Serialize, which handles single instances of mapped types.The value is written as a complete field, including field-header and (for sub-objects) alength-prefixIn addition to that, this provides support for: - basic values; individual int / string / Guid / etc - IEnumerable sequences of any type handled by TrySerializeAuxiliaryType </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.IO.Stream,System.Object)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.IO.Stream,System.Object,ProtoBuf.SerializationContext)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination stream to write to.</param>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Serialize(ProtoBuf.ProtoWriter,System.Object)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied writer. </summary>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination writer to write to.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32)">
<summary>Applies a protocol-buffer stream to an existing instance (or null), using length-prefixeddata - useful with network IO. </summary>
<param name="type">The type being merged.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver)">
<summary>Applies a protocol-buffer stream to an existing instance (or null), using length-prefixeddata - useful with network IO. </summary>
<param name="type">The type being merged.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="expectedField">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
<param name="resolver">Used to resolve types on a per-field basis.</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver,System.Int32@)">
<summary>Applies a protocol-buffer stream to an existing instance (or null), using length-prefixeddata - useful with network IO. </summary>
<param name="type">The type being merged.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="expectedField">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
<param name="resolver">Used to resolve types on a per-field basis.</param>
<param name="bytesRead">Returns the number of bytes consumed by this operation (includes length-prefix overheads and any skipped data).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems(System.IO.Stream,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver)">
-<summary>
Reads a sequence of consecutive length-prefixed items from a stream, usingeither base-128 or fixed-length prefixes. Base-128 prefixes with a tagare directly comparable to serializing multiple items in succession(use the
<see cref="F:ProtoBuf.Serializer.ListItemTag"/>
tag to emulate the implicit behaviorwhen serializing a list/array). When a tag isspecified, any records with different tags are silently omitted. Thetag is ignored. The tag is ignores for fixed-length prefixes.
</summary>
<param name="source">The binary stream containing the serialized records.</param>
<param name="style">The prefix style used in the data.</param>
<param name="expectedField">The tag of records to return (if non-positive, then no tag isexpected and all records are returned).</param>
<param name="resolver">On a field-by-field basis, the type of object to deserialize (can be null if "type" is specified). </param>
<param name="type">The type of object to deserialize (can be null if "resolver" is specified).</param>
<returns>The sequence of deserialized objects.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems(System.IO.Stream,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.Serializer.TypeResolver,ProtoBuf.SerializationContext)">
-<summary>
Reads a sequence of consecutive length-prefixed items from a stream, usingeither base-128 or fixed-length prefixes. Base-128 prefixes with a tagare directly comparable to serializing multiple items in succession(use the
<see cref="F:ProtoBuf.Serializer.ListItemTag"/>
tag to emulate the implicit behaviorwhen serializing a list/array). When a tag isspecified, any records with different tags are silently omitted. Thetag is ignored. The tag is ignores for fixed-length prefixes.
</summary>
<param name="source">The binary stream containing the serialized records.</param>
<param name="style">The prefix style used in the data.</param>
<param name="expectedField">The tag of records to return (if non-positive, then no tag isexpected and all records are returned).</param>
<param name="resolver">On a field-by-field basis, the type of object to deserialize (can be null if "type" is specified). </param>
<param name="type">The type of object to deserialize (can be null if "resolver" is specified).</param>
<returns>The sequence of deserialized objects.</returns>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
-<summary>
Reads a sequence of consecutive length-prefixed items from a stream, usingeither base-128 or fixed-length prefixes. Base-128 prefixes with a tagare directly comparable to serializing multiple items in succession(use the
<see cref="F:ProtoBuf.Serializer.ListItemTag"/>
tag to emulate the implicit behaviorwhen serializing a list/array). When a tag isspecified, any records with different tags are silently omitted. Thetag is ignored. The tag is ignores for fixed-length prefixes.
</summary>
<typeparam name="T">The type of object to deserialize.</typeparam>
<param name="source">The binary stream containing the serialized records.</param>
<param name="style">The prefix style used in the data.</param>
<param name="expectedField">The tag of records to return (if non-positive, then no tag isexpected and all records are returned).</param>
<returns>The sequence of deserialized objects.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.SerializationContext)">
-<summary>
Reads a sequence of consecutive length-prefixed items from a stream, usingeither base-128 or fixed-length prefixes. Base-128 prefixes with a tagare directly comparable to serializing multiple items in succession(use the
<see cref="F:ProtoBuf.Serializer.ListItemTag"/>
tag to emulate the implicit behaviorwhen serializing a list/array). When a tag isspecified, any records with different tags are silently omitted. Thetag is ignored. The tag is ignores for fixed-length prefixes.
</summary>
<typeparam name="T">The type of object to deserialize.</typeparam>
<param name="source">The binary stream containing the serialized records.</param>
<param name="style">The prefix style used in the data.</param>
<param name="expectedField">The tag of records to return (if non-positive, then no tag isexpected and all records are returned).</param>
<returns>The sequence of deserialized objects.</returns>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.SerializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream,with a length-prefix. This is useful for socket programming,as DeserializeWithLengthPrefix can be used to read the single object backfrom an ongoing stream. </summary>
<param name="type">The type being serialized.</param>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="dest">The destination stream to write to.</param>
<param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.SerializeWithLengthPrefix(System.IO.Stream,System.Object,System.Type,ProtoBuf.PrefixStyle,System.Int32,ProtoBuf.SerializationContext)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream,with a length-prefix. This is useful for socket programming,as DeserializeWithLengthPrefix can be used to read the single object backfrom an ongoing stream. </summary>
<param name="type">The type being serialized.</param>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="dest">The destination stream to write to.</param>
<param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="type">The type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,ProtoBuf.SerializationContext)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="type">The type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,System.Int32)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="type">The type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="length">The number of bytes to consume.</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.IO.Stream,System.Object,System.Type,System.Int32,ProtoBuf.SerializationContext)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="type">The type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="length">The number of bytes to consume (or -1 to read to the end of the stream).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(ProtoBuf.ProtoReader,System.Object,System.Type)">
<summary>Applies a protocol-buffer reader to an existing instance (which may be null). </summary>
<param name="type">The type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The reader to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.TryDeserializeAuxiliaryType(ProtoBuf.ProtoReader,ProtoBuf.DataFormat,System.Int32,System.Type,System.Object@,System.Boolean,System.Boolean,System.Boolean,System.Boolean)">
<summary>This is the more "complete" version of Deserialize, which handles single instances of mapped types.The value is read as a complete field, including field-header and (for sub-objects) alength-prefix..kmcIn addition to that, this provides support for: - basic values; individual int / string / Guid / etc - IList sets of any type handled by TryDeserializeAuxiliaryType </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Create">
<summary>Creates a new runtime model, to which the callercan add support for a range of types. A modelcan be used "as is", or can be compiled foroptimal performance. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.ResolveProxies(System.Type)">
<summary>Applies common proxy scenarios, resolving the actual type to consider </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.IsDefined(System.Type)">
<summary>Indicates whether the supplied type is explicitly modelled by the model </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.GetKey(System.Type@)">
<summary>Provides the key that represents a given type in the current model.The type is also normalized for proxies at the same time. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.GetKeyImpl(System.Type)">
<summary>Provides the key that represents a given type in the current model. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Serialize(System.Int32,System.Object,ProtoBuf.ProtoWriter)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="key">Represents the type (including inheritance) to consider.</param>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.Deserialize(System.Int32,System.Object,ProtoBuf.ProtoReader)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="key">Represents the type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.DeepClone(System.Object)">
<summary>Create a deep clone of the supplied instance; any sub-items are also cloned. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.ThrowUnexpectedSubtype(System.Type,System.Type)">
<summary>Indicates that while an inheritance tree exists, the exact type encountered was notspecified in that hierarchy and cannot be processed. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.ThrowUnexpectedType(System.Type)">
<summary>Indicates that the given type was not expected, and cannot be processed. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.ThrowCannotCreateInstance(System.Type)">
<summary>Indicates that the given type cannot be constructed; it may still be possible todeserialize into existing instances. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.CanSerializeContractType(System.Type)">
<summary>Returns true if the type supplied is either a recognised contract type,or a *list* of a recognised contract type. </summary>
<remarks>Note that primitives always return false, even though the enginewill, if forced, try to serialize such</remarks>
<returns>True if this type is recognised as a serializable entity, else false</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.CanSerialize(System.Type)">
<summary>Returns true if the type supplied is a basic type with inbuilt handling,a recognised contract type, or a *list* of a basic / contract type. </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.CanSerializeBasicType(System.Type)">
<summary>Returns true if the type supplied is a basic type with inbuilt handling,or a *list* of a basic type with inbuilt handling </summary>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.GetSchema(System.Type)">
<summary>Suggest a .proto definition for the given type </summary>
-<param name="type">
The type to generate a .proto definition for, or
<c>null</c>
to generate a .proto that represents the entire model
</param>
<returns>The .proto definition as a string</returns>
</member>
-<member name="M:ProtoBuf.Meta.TypeModel.CreateFormatter(System.Type)">
<summary>Creates a new IFormatter that uses protocol-buffer [de]serialization. </summary>
<returns>A new IFormatter to be used during [de]serialization.</returns>
<param name="type">The type of object to be [de]deserialized by the formatter.</param>
</member>
-<member name="E:ProtoBuf.Meta.TypeModel.DynamicTypeFormatting">
<summary>Used to provide custom services for writing and parsing type names when using dynamic types. Both parsing and formattingare provided on a single API as it is essential that both are mapped identically at all times. </summary>
</member>
-<member name="T:ProtoBuf.Meta.TypeModel.CallbackType">
<summary>Indicates the type of callback to be used </summary>
</member>
-<member name="F:ProtoBuf.Meta.TypeModel.CallbackType.BeforeSerialize">
<summary>Invoked before an object is serialized </summary>
</member>
-<member name="F:ProtoBuf.Meta.TypeModel.CallbackType.AfterSerialize">
<summary>Invoked after an object is serialized </summary>
</member>
-<member name="F:ProtoBuf.Meta.TypeModel.CallbackType.BeforeDeserialize">
<summary>Invoked before an object is deserialized (or when a new instance is created) </summary>
</member>
-<member name="F:ProtoBuf.Meta.TypeModel.CallbackType.AfterDeserialize">
<summary>Invoked after an object is deserialized </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetTypes">
<summary>Returns a sequence of the Type instances that can beprocessed by this model. </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetSchema(System.Type)">
<summary>Suggest a .proto definition for the given type </summary>
-<param name="type">
The type to generate a .proto definition for, or
<c>null</c>
to generate a .proto that represents the entire model
</param>
<returns>The .proto definition as a string</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Add(System.Type,System.Boolean)">
<summary>Adds support for an additional type in this model, optionallyappplying inbuilt patterns. If the type is already known to themodel, the existing type is returned **without** applyingany additional behaviour. </summary>
<remarks>Inbuilt patterns include:[ProtoContract]/[ProtoMember(n)][DataContract]/[DataMember(Order=n)][XmlType]/[XmlElement(Order=n)][On{Des|S}erializ{ing|ed}]ShouldSerialize*/*Specified </remarks>
<param name="type">The type to be supported</param>
<param name="applyDefaultBehaviour">Whether to apply the inbuilt configuration patterns (via attributes etc), orjust add the type with no additional configuration (the type must then be manually configured).</param>
<returns>The MetaType representing this type, allowingfurther configuration.</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.ThrowIfFrozen">
<summary>Verifies that the model is still open to changes; if not, an exception is thrown </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Freeze">
<summary>Prevents further changes to this model </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.GetKeyImpl(System.Type)">
<summary>Provides the key that represents a given type in the current model. </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Serialize(System.Int32,System.Object,ProtoBuf.ProtoWriter)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="key">Represents the type (including inheritance) to consider.</param>
<param name="value">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Deserialize(System.Int32,System.Object,ProtoBuf.ProtoReader)">
<summary>Applies a protocol-buffer stream to an existing instance (which may be null). </summary>
<param name="key">Represents the type (including inheritance) to consider.</param>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.CompileInPlace">
<summary>Compiles the serializers individually; this is *not* a fullstandalone compile, but can significantly boost performancewhile allowing additional types to be added. </summary>
<remarks>An in-place compile can access non-public types / members</remarks>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile">
<summary>Fully compiles the current model into a static-compiled model instance </summary>
<remarks>A full compilation is restricted to accessing public types / members</remarks>
<returns>An instance of the newly created compiled type-model</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile(System.String,System.String)">
<summary>Fully compiles the current model into a static-compiled serialization dll(the serialization dll still requires protobuf-net for support services). </summary>
<remarks>A full compilation is restricted to accessing public types / members</remarks>
<param name="name">The name of the TypeModel class to create</param>
<param name="path">The path for the new dll</param>
<returns>An instance of the newly created compiled type-model</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.Compile(ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions)">
<summary>Fully compiles the current model into a static-compiled serialization dll(the serialization dll still requires protobuf-net for support services). </summary>
<remarks>A full compilation is restricted to accessing public types / members</remarks>
<returns>An instance of the newly created compiled type-model</returns>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.SetDefaultFactory(System.Reflection.MethodInfo)">
<summary>Designate a factory-method to use to create instances of any type; note that this only affect types seen by the serializer *after* setting the factory. </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.InferTagFromNameDefault">
-<summary>
Global default thatenables/disables automatic tag generation based on the existing name / orderof the defined members. See
<seealso cref="P:ProtoBuf.ProtoContractAttribute.InferTagFromName"/>
for usage and
<b>important warning</b>
/ explanation.You must set the global default before attempting to serialize/deserialize anyimpacted type.
</summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoAddProtoContractTypesOnly">
-<summary>
Global default that determines whether types are considered serializableif they have [DataContract] / [XmlType]. With this enabled,
<b>ONLY</b>
types marked as [ProtoContract] are added automatically.
</summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.UseImplicitZeroDefaults">
<summary>Global switch that enables or disables the implicithandling of "zero defaults"; meanning: if no other default is specified,it assumes bools always default to false, integers to zero, etc.If this is disabled, no such assumptions are made and only *explicit*default values are processed. This is enabled by default topreserve similar logic to v1. </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.AllowParseableTypes">
-<summary>
Global switch that determines whether types with a
<c>.ToString()</c>
and a
<c>Parse(string)</c>
should be serialized as strings.
</summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.Default">
<summary>The default model, used to support ProtoBuf.Serializer </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.Item(System.Type)">
<summary>Obtains the MetaType associated with a given Type for the current model,allowing additional configuration. </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoCompile">
<summary>Should serializers be compiled on demand? It may be usefulto disable this for debugging purposes. </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.AutoAddMissingTypes">
<summary>Should support for unexpected types be added automatically?If false, an exception is thrown when unexpected typesare encountered. </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.MetadataTimeoutMilliseconds">
<summary>The amount of time to wait if there are concurrent metadata access operations </summary>
</member>
-<member name="E:ProtoBuf.Meta.RuntimeTypeModel.LockContended">
<summary>If a lock-contention is detected, this event signals the *owner* of the lock responsible for the blockage, indicatingwhat caused the problem; this is only raised if the lock-owning code successfully completes. </summary>
</member>
-<member name="T:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions">
<summary>Represents configuration options for compiling a model toa standalone assembly. </summary>
</member>
-<member name="M:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.SetFrameworkOptions(ProtoBuf.Meta.MetaType)">
<summary>Import framework options from an existing type </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TargetFrameworkName">
<summary>The TargetFrameworkAttribute FrameworkName value to burn into the generated assembly </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TargetFrameworkDisplayName">
<summary>The TargetFrameworkAttribute FrameworkDisplayName value to burn into the generated assembly </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.TypeName">
<summary>The name of the TypeModel class to create </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.OutputPath">
<summary>The path for the new dll </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.ImageRuntimeVersion">
<summary>The runtime version for the generated assembly </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.MetaDataVersion">
<summary>The runtime version for the generated assembly </summary>
</member>
-<member name="P:ProtoBuf.Meta.RuntimeTypeModel.CompilerOptions.Accessibility">
<summary>The acecssibility of the generated serializer </summary>
</member>
-<member name="T:ProtoBuf.Meta.RuntimeTypeModel.Accessibility">
<summary>Type accessibility </summary>
</member>
-<member name="F:ProtoBuf.Meta.RuntimeTypeModel.Accessibility.Public">
<summary>Available to all callers </summary>
</member>
-<member name="F:ProtoBuf.Meta.RuntimeTypeModel.Accessibility.Internal">
<summary>Available to all callers in the same assembly, or assemblies specified via [InternalsVisibleTo(...)] </summary>
</member>
-<member name="T:ProtoBuf.Meta.LockContentedEventArgs">
<summary>Contains the stack-trace of the owning code when a lock-contention scenario is detected </summary>
</member>
-<member name="P:ProtoBuf.Meta.LockContentedEventArgs.OwnerStackTrace">
<summary>The stack-trace of the code that owned the lock when a lock-contention scenario occurred </summary>
</member>
-<member name="T:ProtoBuf.Meta.LockContentedEventHandler">
<summary>Event-type that is raised when a lock-contention scenario is detected </summary>
</member>
-<member name="T:ProtoBuf.Meta.SubType">
<summary>Represents an inherited type in a type hierarchy. </summary>
</member>
-<member name="M:ProtoBuf.Meta.SubType.#ctor(System.Int32,ProtoBuf.Meta.MetaType,ProtoBuf.DataFormat)">
<summary>Creates a new SubType instance. </summary>
<param name="fieldNumber">The field-number that is used to encapsulate the data (as a nestedmessage) for the derived dype.</param>
<param name="derivedType">The sub-type to be considered.</param>
<param name="format">Specific encoding style to use; in particular, Grouped can be used to avoid buffering, but is not the default.</param>
</member>
-<member name="P:ProtoBuf.Meta.SubType.FieldNumber">
<summary>The field-number that is used to encapsulate the data (as a nestedmessage) for the derived dype. </summary>
</member>
-<member name="P:ProtoBuf.Meta.SubType.DerivedType">
<summary>The sub-type to be considered. </summary>
</member>
-<member name="T:ProtoBuf.Meta.TypeFormatEventArgs">
<summary>Event arguments needed to perform type-formatting functions; this could be resolving a Type to a string suitable for serialization, or couldbe requesting a Type from a string. If no changes are made, a default implementation will be used (from the assembly-qualified names). </summary>
</member>
-<member name="P:ProtoBuf.Meta.TypeFormatEventArgs.Type">
<summary>The type involved in this map; if this is initially null, a Type is expected to be provided for the string in FormattedName. </summary>
</member>
-<member name="P:ProtoBuf.Meta.TypeFormatEventArgs.FormattedName">
<summary>The formatted-name involved in this map; if this is initially null, a formatted-name is expected from the type in Type. </summary>
</member>
-<member name="T:ProtoBuf.Meta.TypeFormatEventHandler">
<summary>Delegate type used to perform type-formatting functions; the sender originates as the type-model. </summary>
</member>
-<member name="T:ProtoBuf.Meta.ValueMember">
<summary>Represents a member (property/field) that is mapped to a protobuf field </summary>
</member>
-<member name="M:ProtoBuf.Meta.ValueMember.#ctor(ProtoBuf.Meta.RuntimeTypeModel,System.Type,System.Int32,System.Reflection.MemberInfo,System.Type,System.Type,System.Type,ProtoBuf.DataFormat,System.Object)">
<summary>Creates a new ValueMember instance </summary>
</member>
-<member name="M:ProtoBuf.Meta.ValueMember.#ctor(ProtoBuf.Meta.RuntimeTypeModel,System.Int32,System.Type,System.Type,System.Type,ProtoBuf.DataFormat)">
<summary>Creates a new ValueMember instance </summary>
</member>
-<member name="M:ProtoBuf.Meta.ValueMember.SetSpecified(System.Reflection.MethodInfo,System.Reflection.MethodInfo)">
<summary>Specifies methods for working with optional data members. </summary>
<param name="getSpecified">Provides a method (null for none) to query whether this member shouldbe serialized; it must be of the form "bool {Method}()". The member is only serialized if themethod returns true.</param>
<param name="setSpecified">Provides a method (null for none) to indicate that a member wasdeserialized; it must be of the form "void {Method}(bool)", and will be called with "true"when data is found.</param>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.FieldNumber">
<summary>The number that identifies this member in a protobuf stream </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.Member">
<summary>Gets the member (field/property) which this member relates to. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.ItemType">
<summary>Within a list / array / etc, the type of object for each item in the list (especially useful with ArrayList) </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.MemberType">
<summary>The underlying type of the member </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.DefaultType">
<summary>For abstract types (IList etc), the type of concrete object to create (if required) </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.ParentType">
<summary>The type the defines the member </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.DefaultValue">
<summary>The default value of the item (members with this value will not be serialized) </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.DataFormat">
-<summary>
Specifies the rules used to process the field; this is used to determine the most appropriatewite-type, but also to describe subtypes
<i>within</i>
that wire-type (such as SignedVariant)
</summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.IsStrict">
<summary>Indicates whether this field should follow strict encoding rules; this means (for example) that if a "fixed32"is encountered when "variant" is defined, then it will fail (throw an exception) when parsing. Note thatwhen serializing the defined type is always used. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.IsPacked">
<summary>Indicates whether this field should use packed encoding (which can save lots of space for repeated primitive values).This option only applies to list/array data of primitive types (int, double, etc). </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.OverwriteList">
<summary>Indicates whether this field should *repace* existing values (the default is false, meaning *append*).This option only applies to list/array data. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.IsRequired">
<summary>Indicates whether this field is mandatory. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.AsReference">
<summary>Enables full object-tracking/full-graph support. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.DynamicType">
<summary>Embeds the type information into the stream, allowing usage with types not known in advance. </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.Name">
<summary>Gets the logical name for this member in the schema (this is not critical for binary serialization, but may be usedwhen inferring a schema). </summary>
</member>
-<member name="P:ProtoBuf.Meta.ValueMember.SupportNull">
<summary>Should lists have extended support for null values? Note this makes the serialization less efficient. </summary>
</member>
-<member name="T:ProtoBuf.PrefixStyle">
<summary>Specifies the type of prefix that should be applied to messages. </summary>
</member>
-<member name="F:ProtoBuf.PrefixStyle.None">
<summary>No length prefix is applied to the data; the data is terminated only be the end of the stream. </summary>
</member>
-<member name="F:ProtoBuf.PrefixStyle.Base128">
<summary>A base-128 length prefix is applied to the data (efficient for short messages). </summary>
</member>
-<member name="F:ProtoBuf.PrefixStyle.Fixed32">
<summary>A fixed-length (little-endian) length prefix is applied to the data (useful for compatibility). </summary>
</member>
-<member name="F:ProtoBuf.PrefixStyle.Fixed32BigEndian">
<summary>A fixed-length (big-endian) length prefix is applied to the data (useful for compatibility). </summary>
</member>
-<member name="T:ProtoBuf.ProtoContractAttribute">
<summary>Indicates that a type is defined for protocol-buffer serialization. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.Name">
<summary>Gets or sets the defined name of the type. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFirstTag">
<summary>Gets or sets the fist offset to use with implicit field tags;only uesd if ImplicitFields is set. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.UseProtoMembersOnly">
<summary>If specified, alternative contract markers (such as markers for XmlSerailizer or DataContractSerializer) are ignored. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.IgnoreListHandling">
<summary>If specified, do NOT treat this type as a list, even if it looks like one. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.ImplicitFields">
<summary>Gets or sets the mechanism used to automatically infer field tagsfor members. This option should be used in advanced scenarios only.Please review the important notes against the ImplicitFields enumeration. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.InferTagFromName">
<summary>Enables/disables automatic tag generation based on the existing name / orderof the defined members. This option is not used for members markedwith ProtoMemberAttribute, as intended to provide compatibility withWCF serialization. WARNING: when adding new fields you must takecare to increase the Order for new elements, otherwise data corruptionmay occur. </summary>
<remarks>If not explicitly specified, the default is assumed from Serializer.GlobalOptions.InferTagFromName.</remarks>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.InferTagFromNameHasValue">
<summary>Has a InferTagFromName value been explicitly set? if not, the default from the type-model is assumed. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.DataMemberOffset">
<summary>Specifies an offset to apply to [DataMember(Order=...)] markers;this is useful when working with mex-generated classes that havea different origin (usually 1 vs 0) than the original data-contract.This value is added to the Order of each member. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.SkipConstructor">
<summary>If true, the constructor for the type is bypassed during deserialization, meaning any field initializersor other initialization code is skipped. </summary>
</member>
-<member name="P:ProtoBuf.ProtoContractAttribute.AsReferenceDefault">
<summary>Should this type be treated as a reference by default? Please also see the implications of this,as recorded on ProtoMemberAttribute.AsReference </summary>
</member>
-<member name="T:ProtoBuf.ProtoEnumAttribute">
<summary>Used to define protocol-buffer specific behavior forenumerated values. </summary>
</member>
-<member name="M:ProtoBuf.ProtoEnumAttribute.HasValue">
<summary>Indicates whether this instance has a customised value mapping </summary>
<returns>true if a specific value is set</returns>
</member>
-<member name="P:ProtoBuf.ProtoEnumAttribute.Value">
<summary>Gets or sets the specific value to use for this enum during serialization. </summary>
</member>
-<member name="P:ProtoBuf.ProtoEnumAttribute.Name">
<summary>Gets or sets the defined name of the enum, as used in .proto(this name is not used during serialization). </summary>
</member>
-<member name="T:ProtoBuf.ProtoException">
<summary>Indicates an error during serialization/deserialization of a proto stream. </summary>
</member>
-<member name="M:ProtoBuf.ProtoException.#ctor">
<summary>Creates a new ProtoException instance.</summary>
</member>
-<member name="M:ProtoBuf.ProtoException.#ctor(System.String)">
<summary>Creates a new ProtoException instance.</summary>
</member>
-<member name="M:ProtoBuf.ProtoException.#ctor(System.String,System.Exception)">
<summary>Creates a new ProtoException instance.</summary>
</member>
-<member name="M:ProtoBuf.ProtoException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>Creates a new ProtoException instance.</summary>
</member>
-<member name="T:ProtoBuf.ProtoIgnoreAttribute">
<summary>Indicates that a member should be excluded from serialization; thisis only normally used when using implict fields. </summary>
</member>
-<member name="T:ProtoBuf.ProtoPartialIgnoreAttribute">
<summary>Indicates that a member should be excluded from serialization; thisis only normally used when using implict fields. This allowsProtoIgnoreAttribute usageeven for partial classes where the individual members are notunder direct control. </summary>
</member>
-<member name="M:ProtoBuf.ProtoPartialIgnoreAttribute.#ctor(System.String)">
<summary>Creates a new ProtoPartialIgnoreAttribute instance. </summary>
<param name="memberName">Specifies the member to be ignored.</param>
</member>
-<member name="P:ProtoBuf.ProtoPartialIgnoreAttribute.MemberName">
<summary>The name of the member to be ignored. </summary>
</member>
-<member name="T:ProtoBuf.ProtoIncludeAttribute">
<summary>Indicates the known-types to support for an individualmessage. This serializes each level in the hierarchy asa nested message to retain wire-compatibility withother protocol-buffer implementations. </summary>
</member>
-<member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.Type)">
<summary>Creates a new instance of the ProtoIncludeAttribute. </summary>
<param name="tag">The unique index (within the type) that will identify this data.</param>
<param name="knownType">The additional type to serialize/deserialize.</param>
</member>
-<member name="M:ProtoBuf.ProtoIncludeAttribute.#ctor(System.Int32,System.String)">
<summary>Creates a new instance of the ProtoIncludeAttribute. </summary>
<param name="tag">The unique index (within the type) that will identify this data.</param>
<param name="knownTypeName">The additional type to serialize/deserialize.</param>
</member>
-<member name="P:ProtoBuf.ProtoIncludeAttribute.Tag">
<summary>Gets the unique index (within the type) that will identify this data. </summary>
</member>
-<member name="P:ProtoBuf.ProtoIncludeAttribute.KnownTypeName">
<summary>Gets the additional type to serialize/deserialize. </summary>
</member>
-<member name="P:ProtoBuf.ProtoIncludeAttribute.KnownType">
<summary>Gets the additional type to serialize/deserialize. </summary>
</member>
-<member name="P:ProtoBuf.ProtoIncludeAttribute.DataFormat">
<summary>Specifies whether the inherited sype's sub-message should bewritten with a length-prefix (default), or with group markers. </summary>
</member>
-<member name="T:ProtoBuf.ProtoMemberAttribute">
<summary>Declares a member to be used in protocol-buffer serialization, usingthe given Tag. A DataFormat may be used to optimise the serializationformat (for instance, using zigzag encoding for negative numbers, orfixed-length encoding for large values. </summary>
</member>
-<member name="M:ProtoBuf.ProtoMemberAttribute.CompareTo(System.Object)">
<summary>Compare with another ProtoMemberAttribute for sorting purposes </summary>
</member>
-<member name="M:ProtoBuf.ProtoMemberAttribute.CompareTo(ProtoBuf.ProtoMemberAttribute)">
<summary>Compare with another ProtoMemberAttribute for sorting purposes </summary>
</member>
-<member name="M:ProtoBuf.ProtoMemberAttribute.#ctor(System.Int32)">
<summary>Creates a new ProtoMemberAttribute instance. </summary>
<param name="tag">Specifies the unique tag used to identify this member within the type.</param>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.Name">
<summary>Gets or sets the original name defined in the .proto; not usedduring serialization. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.DataFormat">
<summary>Gets or sets the data-format to be used when encoding this value. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.Tag">
<summary>Gets the unique tag used to identify this member within the type. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.IsRequired">
<summary>Gets or sets a value indicating whether this member is mandatory. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.IsPacked">
<summary>Gets a value indicating whether this member is packed.This option only applies to list/array data of primitive types (int, double, etc). </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.OverwriteList">
<summary>Indicates whether this field should *repace* existing values (the default is false, meaning *append*).This option only applies to list/array data. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.AsReference">
<summary>Enables full object-tracking/full-graph support. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.DynamicType">
<summary>Embeds the type information into the stream, allowing usage with types not known in advance. </summary>
</member>
-<member name="P:ProtoBuf.ProtoMemberAttribute.Options">
<summary>Gets or sets a value indicating whether this member is packed (lists/arrays). </summary>
</member>
-<member name="T:ProtoBuf.MemberSerializationOptions">
<summary>Additional (optional) settings that control serialization of members </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.None">
<summary>Default; no additional options </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.Packed">
<summary>Indicates that repeated elements should use packed (length-prefixed) encoding </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.Required">
<summary>Indicates that the given item is required </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.AsReference">
<summary>Enables full object-tracking/full-graph support </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.DynamicType">
<summary>Embeds the type information into the stream, allowing usage with types not known in advance </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.OverwriteList">
<summary>Indicates whether this field should *repace* existing values (the default is false, meaning *append*).This option only applies to list/array data. </summary>
</member>
-<member name="F:ProtoBuf.MemberSerializationOptions.AsReferenceHasValue">
<summary>Determines whether the types AsReferenceDefault value is used, or whether this member's AsReference should be used </summary>
</member>
-<member name="T:ProtoBuf.ProtoPartialMemberAttribute">
<summary>Declares a member to be used in protocol-buffer serialization, usingthe given Tag and MemberName. This allows ProtoMemberAttribute usageeven for partial classes where the individual members are notunder direct control.A DataFormat may be used to optimise the serializationformat (for instance, using zigzag encoding for negative numbers, orfixed-length encoding for large values. </summary>
</member>
-<member name="M:ProtoBuf.ProtoPartialMemberAttribute.#ctor(System.Int32,System.String)">
<summary>Creates a new ProtoMemberAttribute instance. </summary>
<param name="tag">Specifies the unique tag used to identify this member within the type.</param>
<param name="memberName">Specifies the member to be serialized.</param>
</member>
-<member name="P:ProtoBuf.ProtoPartialMemberAttribute.MemberName">
<summary>The name of the member to be serialized. </summary>
</member>
-<member name="T:ProtoBuf.ProtoReader">
<summary>A stateful reader, used to read a protobuf stream. Typical usage would be (sequentially) to callReadFieldHeader and (after matching the field) an appropriate Read* method. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext)">
<summary>Creates a new reader against a stream </summary>
<param name="source">The source stream</param>
<param name="model">The model to use for serialization; this can be null, but this will impair the ability to deserialize sub-objects</param>
<param name="context">Additional context about this serialization operation</param>
</member>
-<member name="M:ProtoBuf.ProtoReader.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext,System.Int32)">
<summary>Creates a new reader against a stream </summary>
<param name="source">The source stream</param>
<param name="model">The model to use for serialization; this can be null, but this will impair the ability to deserialize sub-objects</param>
<param name="context">Additional context about this serialization operation</param>
<param name="length">The number of bytes to read, or -1 to read until the end of the stream</param>
</member>
-<member name="M:ProtoBuf.ProtoReader.Dispose">
-<summary>
Releases resources used by the reader, but importantly
<b>does not</b>
Dispose theunderlying stream; in many typical use-cases the stream is used for differentprocesses, so it is assumed that the consumer will Dispose their stream separately.
</summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadUInt32">
<summary>Reads an unsigned 32-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadInt16">
<summary>Reads a signed 16-bit integer from the stream: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadUInt16">
<summary>Reads an unsigned 16-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadByte">
<summary>Reads an unsigned 8-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadSByte">
<summary>Reads a signed 8-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadInt32">
<summary>Reads a signed 32-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadInt64">
<summary>Reads a signed 64-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadString">
<summary>Reads a string from the stream (using UTF8); supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ThrowEnumException(System.Type,System.Int32)">
<summary>Throws an exception indication that the given value cannot be mapped to an enum. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadDouble">
<summary>Reads a double-precision number from the stream; supported wire-types: Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadObject(System.Object,System.Int32,ProtoBuf.ProtoReader)">
<summary>Reads (merges) a sub-message from the stream, internally calling StartSubItem and EndSubItem, and (in between)parsing the message in accordance with the model associated with the reader </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.EndSubItem(ProtoBuf.SubItemToken,ProtoBuf.ProtoReader)">
<summary>Makes the end of consuming a nested message in the stream; the stream must be either at the correct EndGroupmarker, or all fields of the sub-message must have been consumed (in either case, this means ReadFieldHeadershould return zero) </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.StartSubItem(ProtoBuf.ProtoReader)">
<summary>Begins consuming a nested message in the stream; supported wire-types: StartGroup, String </summary>
<remarks>The token returned must be help and used when callining EndSubItem</remarks>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadFieldHeader">
<summary>Reads a field header from the stream, setting the wire-type and retuning the field number. If nomore fields are available, then 0 is returned. This methods respects sub-messages. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.TryReadFieldHeader(System.Int32)">
<summary>Looks ahead to see whether the next field in the stream is what we expect(typically; what we've just finished reading - for example ot read successive list items) </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.Hint(ProtoBuf.WireType)">
<summary>Compares the streams current wire-type to the hinted wire-type, updating the reader if necessary; for example,a Variant may be updated to SignedVariant. If the hinted wire-type is unrelated then no change is made. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.Assert(ProtoBuf.WireType)">
<summary>Verifies that the stream's current wire-type is as expected, or a specialized sub-type (for example,SignedVariant) - in which case the current wire-type is updated. Otherwise an exception is thrown. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.SkipField">
<summary>Discards the data for the current field. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadUInt64">
<summary>Reads an unsigned 64-bit integer from the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadSingle">
<summary>Reads a single-precision number from the stream; supported wire-types: Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadBoolean">
<summary>Reads a boolean value from the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
<returns/>
</member>
-<member name="M:ProtoBuf.ProtoReader.AppendBytes(System.Byte[],ProtoBuf.ProtoReader)">
<summary>Reads a byte-sequence from the stream, appending them to an existing byte-sequence (which can be null); supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadLengthPrefix(System.IO.Stream,System.Boolean,ProtoBuf.PrefixStyle,System.Int32@)">
<summary>Reads the length-prefix of a message from a stream without buffering additional data, allowing a fixed-lengthreader to be created. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadLittleEndianInt32(System.IO.Stream)">
<summary>Reads a little-endian encoded integer. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadBigEndianInt32(System.IO.Stream)">
<summary>Reads a big-endian encoded integer. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadVarintInt32(System.IO.Stream)">
<summary>Reads a varint encoded integer. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadBytes(System.IO.Stream,System.Byte[],System.Int32,System.Int32)">
<summary>Reads a string (of a given lenth, in bytes) directly from the source into a pre-existing buffer. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadBytes(System.IO.Stream,System.Int32)">
<summary>Reads a given number of bytes directly from the source. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.DirectReadString(System.IO.Stream,System.Int32)">
<summary>Reads a string (of a given lenth, in bytes) directly from the source. An exception is thrown if the data is not all available. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadLengthPrefix(System.IO.Stream,System.Boolean,ProtoBuf.PrefixStyle,System.Int32@,System.Int32@)">
<summary>Reads the length-prefix of a message from a stream without buffering additional data, allowing a fixed-lengthreader to be created. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.TryReadUInt32Variant(System.IO.Stream,System.UInt32@)">
<returns>The number of bytes consumed; 0 if no data available</returns>
</member>
-<member name="M:ProtoBuf.ProtoReader.AppendExtensionData(ProtoBuf.IExtensible)">
<summary>Copies the current field into the instance as extension data </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.HasSubValue(ProtoBuf.WireType,ProtoBuf.ProtoReader)">
<summary>Indicates whether the reader still has data remaining in the current sub-item,additionally setting the wire-type for the next field if there is more data.This is used when decoding packed data. </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.NoteObject(System.Object,ProtoBuf.ProtoReader)">
<summary>Utility method, not intended for public use; this helps maintain the root object is complex scenarios </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.ReadType">
<summary>Reads a Type from the stream, using the model's DynamicTypeFormatting if appropriate; supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoReader.Merge(ProtoBuf.ProtoReader,System.Object,System.Object)">
<summary>Merge two objects using the details from the current reader; this is used to change the typeof objects when an inheritance relationship is discovered later than usual during deserilazation. </summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.FieldNumber">
<summary>Gets the number of the field being processed. </summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.WireType">
<summary>Indicates the underlying proto serialization format on the wire. </summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.InternStrings">
-<summary>
Gets / sets a flag indicating whether strings should be checked for repetition; iftrue, any repeated UTF-8 byte sequence will result in the same String instance, ratherthan a second instance of the same string. Enabled by default. Note that this usesa
<i>custom</i>
interner - the system-wide string interner is not used.
</summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.Context">
<summary>Addition information about this deserialization operation. </summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.Position">
<summary>Returns the position of the current reader (note that this is not necessarily the same as the positionin the underlying stream, if multiple readers are used on the same stream) </summary>
</member>
-<member name="P:ProtoBuf.ProtoReader.Model">
<summary>Get the TypeModel associated with this reader </summary>
</member>
-<member name="T:ProtoBuf.ProtoWriter">
<summary>Represents an output stream for writing protobuf data.Why is the API backwards (static methods with writer arguments)?See: http://marcgravell.blogspot.com/2010/03/last-will-be-first-and-first-will-be.html </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteObject(System.Object,System.Int32,ProtoBuf.ProtoWriter)">
<summary>Write an encapsulated sub-object, using the supplied unique key (reprasenting a type). </summary>
<param name="value">The object to write.</param>
<param name="key">The key that uniquely identifies the type within the model.</param>
<param name="writer">The destination.</param>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteRecursionSafeObject(System.Object,System.Int32,ProtoBuf.ProtoWriter)">
<summary>Write an encapsulated sub-object, using the supplied unique key (reprasenting a type) - but thecaller is asserting that this relationship is non-recursive; no recursion check will beperformed. </summary>
<param name="value">The object to write.</param>
<param name="key">The key that uniquely identifies the type within the model.</param>
<param name="writer">The destination.</param>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteFieldHeader(System.Int32,ProtoBuf.WireType,ProtoBuf.ProtoWriter)">
<summary>Writes a field-header, indicating the format of the next data we plan to write. </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteBytes(System.Byte[],ProtoBuf.ProtoWriter)">
<summary>Writes a byte-array to the stream; supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteBytes(System.Byte[],System.Int32,System.Int32,ProtoBuf.ProtoWriter)">
<summary>Writes a byte-array to the stream; supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.StartSubItem(System.Object,ProtoBuf.ProtoWriter)">
<summary>Indicates the start of a nested record. </summary>
<param name="instance">The instance to write.</param>
<param name="writer">The destination.</param>
<returns>A token representing the state of the stream; this token is given to EndSubItem.</returns>
</member>
-<member name="M:ProtoBuf.ProtoWriter.EndSubItem(ProtoBuf.SubItemToken,ProtoBuf.ProtoWriter)">
<summary>Indicates the end of a nested record. </summary>
<param name="token">The token obtained from StartubItem.</param>
<param name="writer">The destination.</param>
</member>
-<member name="M:ProtoBuf.ProtoWriter.#ctor(System.IO.Stream,ProtoBuf.Meta.TypeModel,ProtoBuf.SerializationContext)">
<summary>Creates a new writer against a stream </summary>
<param name="dest">The destination stream</param>
<param name="model">The model to use for serialization; this can be null, but this will impair the ability to serialize sub-objects</param>
<param name="context">Additional context about this serialization operation</param>
</member>
-<member name="M:ProtoBuf.ProtoWriter.Close">
<summary>Flushes data to the underlying stream, and releases any resources. The underlying stream is *not* disposedby this operation. </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.Flush(ProtoBuf.ProtoWriter)">
<summary>Writes any buffered data (if possible) to the underlying stream. </summary>
<param name="writer">The writer to flush</param>
<remarks>It is not always possible to fully flush, since some sequencesmay require values to be back-filled into the byte-stream.</remarks>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteUInt32Variant(System.UInt32,ProtoBuf.ProtoWriter)">
<summary>Writes an unsigned 32-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteString(System.String,ProtoBuf.ProtoWriter)">
<summary>Writes a string to the stream; supported wire-types: String </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteUInt64(System.UInt64,ProtoBuf.ProtoWriter)">
<summary>Writes an unsigned 64-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteInt64(System.Int64,ProtoBuf.ProtoWriter)">
<summary>Writes a signed 64-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteUInt32(System.UInt32,ProtoBuf.ProtoWriter)">
<summary>Writes an unsigned 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteInt16(System.Int16,ProtoBuf.ProtoWriter)">
<summary>Writes a signed 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteUInt16(System.UInt16,ProtoBuf.ProtoWriter)">
<summary>Writes an unsigned 16-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteByte(System.Byte,ProtoBuf.ProtoWriter)">
<summary>Writes an unsigned 8-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteSByte(System.SByte,ProtoBuf.ProtoWriter)">
<summary>Writes a signed 8-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteInt32(System.Int32,ProtoBuf.ProtoWriter)">
<summary>Writes a signed 32-bit integer to the stream; supported wire-types: Variant, Fixed32, Fixed64, SignedVariant </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteDouble(System.Double,ProtoBuf.ProtoWriter)">
<summary>Writes a double-precision number to the stream; supported wire-types: Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteSingle(System.Single,ProtoBuf.ProtoWriter)">
<summary>Writes a single-precision number to the stream; supported wire-types: Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.ThrowEnumException(ProtoBuf.ProtoWriter,System.Object)">
<summary>Throws an exception indicating that the given enum cannot be mapped to a serialized value. </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteBoolean(System.Boolean,ProtoBuf.ProtoWriter)">
<summary>Writes a boolean to the stream; supported wire-types: Variant, Fixed32, Fixed64 </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.AppendExtensionData(ProtoBuf.IExtensible,ProtoBuf.ProtoWriter)">
<summary>Copies any extension data stored for the instance to the underlying stream </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.SetPackedField(System.Int32,ProtoBuf.ProtoWriter)">
<summary>Used for packed encoding; indicates that the next field should be skipped rather thana field header written. Note that the field number must match, else an exception is thrownwhen the attempt is made to write the (incorrect) field. The wire-type is taken from thesubsequent call to WriteFieldHeader. Only primitive types can be packed. </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.SetRootObject(System.Object)">
<summary>Specifies a known root object to use during reference-tracked serialization </summary>
</member>
-<member name="M:ProtoBuf.ProtoWriter.WriteType(System.Type,ProtoBuf.ProtoWriter)">
<summary>Writes a Type to the stream, using the model's DynamicTypeFormatting if appropriate; supported wire-types: String </summary>
</member>
-<member name="P:ProtoBuf.ProtoWriter.Context">
<summary>Addition information about this serialization operation. </summary>
</member>
-<member name="P:ProtoBuf.ProtoWriter.Model">
<summary>Get the TypeModel associated with this writer </summary>
</member>
-<member name="T:ProtoBuf.SerializationContext">
<summary>Additional information about a serialization operation </summary>
</member>
-<member name="M:ProtoBuf.SerializationContext.op_Implicit(ProtoBuf.SerializationContext)~System.Runtime.Serialization.StreamingContext">
<summary>Convert a SerializationContext to a StreamingContext </summary>
</member>
-<member name="M:ProtoBuf.SerializationContext.op_Implicit(System.Runtime.Serialization.StreamingContext)~ProtoBuf.SerializationContext">
<summary>Convert a StreamingContext to a SerializationContext </summary>
</member>
-<member name="P:ProtoBuf.SerializationContext.Context">
<summary>Gets or sets a user-defined object containing additional information about this serialization/deserialization operation. </summary>
</member>
-<member name="P:ProtoBuf.SerializationContext.Default">
<summary>A default SerializationContext, with minimal information. </summary>
</member>
-<member name="P:ProtoBuf.SerializationContext.State">
<summary>Gets or sets the source or destination of the transmitted data. </summary>
</member>
-<member name="T:ProtoBuf.Serializer">
<summary>Provides protocol-buffer serialization capability for concrete, attributed types. Thisis a *default* model, but custom serializer models are also supported. </summary>
<remarks>Protocol-buffer serialization is a compact binary format, designed to takeadvantage of sparse data and knowledge of specific data types; it is alsoextensible, allowing a type to be deserialized / merged even if some data isnot recognised. </remarks>
</member>
-<member name="F:ProtoBuf.Serializer.ListItemTag">
<summary>The field number that is used as a default when serializing/deserializing a list of objects.The data is treated as repeated message with field number 1. </summary>
</member>
-<member name="M:ProtoBuf.Serializer.GetProto``1">
<summary>Suggest a .proto definition for the given type </summary>
<typeparam name="T">The type to generate a .proto definition for</typeparam>
<returns>The .proto definition as a string</returns>
</member>
-<member name="M:ProtoBuf.Serializer.DeepClone``1(``0)">
<summary>Create a deep clone of the supplied instance; any sub-items are also cloned. </summary>
</member>
-<member name="M:ProtoBuf.Serializer.Merge``1(System.IO.Stream,``0)">
<summary>Applies a protocol-buffer stream to an existing instance. </summary>
<typeparam name="T">The type being merged.</typeparam>
<param name="instance">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.Deserialize``1(System.IO.Stream)">
<summary>Creates a new instance from a protocol-buffer stream </summary>
<typeparam name="T">The type to be created.</typeparam>
<param name="source">The binary stream to apply to the new instance (cannot be null).</param>
<returns>A new, initialized instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.Serialize``1(System.IO.Stream,``0)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="destination">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Serializer.ChangeType``2(``0)">
<summary>Serializes a given instance and deserializes it as a different type;this can be used to translate between wire-compatible objects (wheretwo .NET types represent the same data), or to promote/demote a typethrough an inheritance hierarchy. </summary>
<remarks>No assumption of compatibility is made between the types.</remarks>
<typeparam name="TFrom">The type of the object being copied.</typeparam>
<typeparam name="TTo">The type of the new object to be created.</typeparam>
<param name="instance">The existing instance to use as a template.</param>
<returns>A new instane of type TNewType, with the data from TOldType.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.Serialize``1(System.Runtime.Serialization.SerializationInfo,``0)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied SerializationInfo. </summary>
<typeparam name="T">The type being serialized.</typeparam>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="info">The destination SerializationInfo to write to.</param>
</member>
-<member name="M:ProtoBuf.Serializer.Serialize``1(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext,``0)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied SerializationInfo. </summary>
<typeparam name="T">The type being serialized.</typeparam>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="info">The destination SerializationInfo to write to.</param>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Serializer.Serialize``1(System.Xml.XmlWriter,``0)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied XmlWriter. </summary>
<typeparam name="T">The type being serialized.</typeparam>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="writer">The destination XmlWriter to write to.</param>
</member>
-<member name="M:ProtoBuf.Serializer.Merge``1(System.Xml.XmlReader,``0)">
<summary>Applies a protocol-buffer from an XmlReader to an existing instance. </summary>
<typeparam name="T">The type being merged.</typeparam>
<param name="instance">The existing instance to be modified (cannot be null).</param>
<param name="reader">The XmlReader containing the data to apply to the instance (cannot be null).</param>
</member>
-<member name="M:ProtoBuf.Serializer.Merge``1(System.Runtime.Serialization.SerializationInfo,``0)">
<summary>Applies a protocol-buffer from a SerializationInfo to an existing instance. </summary>
<typeparam name="T">The type being merged.</typeparam>
<param name="instance">The existing instance to be modified (cannot be null).</param>
<param name="info">The SerializationInfo containing the data to apply to the instance (cannot be null).</param>
</member>
-<member name="M:ProtoBuf.Serializer.Merge``1(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext,``0)">
<summary>Applies a protocol-buffer from a SerializationInfo to an existing instance. </summary>
<typeparam name="T">The type being merged.</typeparam>
<param name="instance">The existing instance to be modified (cannot be null).</param>
<param name="info">The SerializationInfo containing the data to apply to the instance (cannot be null).</param>
<param name="context">Additional information about this serialization operation.</param>
</member>
-<member name="M:ProtoBuf.Serializer.PrepareSerializer``1">
<summary>Precompiles the serializer for a given type. </summary>
</member>
-<member name="M:ProtoBuf.Serializer.CreateFormatter``1">
<summary>Creates a new IFormatter that uses protocol-buffer [de]serialization. </summary>
<typeparam name="T">The type of object to be [de]deserialized by the formatter.</typeparam>
<returns>A new IFormatter to be used during [de]serialization.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.DeserializeItems``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
-<summary>
Reads a sequence of consecutive length-prefixed items from a stream, usingeither base-128 or fixed-length prefixes. Base-128 prefixes with a tagare directly comparable to serializing multiple items in succession(use the
<see cref="F:ProtoBuf.Serializer.ListItemTag"/>
tag to emulate the implicit behaviorwhen serializing a list/array). When a tag isspecified, any records with different tags are silently omitted. Thetag is ignored. The tag is ignores for fixed-length prefixes.
</summary>
<typeparam name="T">The type of object to deserialize.</typeparam>
<param name="source">The binary stream containing the serialized records.</param>
<param name="style">The prefix style used in the data.</param>
<param name="fieldNumber">The tag of records to return (if non-positive, then no tag isexpected and all records are returned).</param>
<returns>The sequence of deserialized objects.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle)">
<summary>Creates a new instance from a protocol-buffer stream that has a length-prefixon data (to assist with network IO). </summary>
<typeparam name="T">The type to be created.</typeparam>
<param name="source">The binary stream to apply to the new instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<returns>A new, initialized instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.DeserializeWithLengthPrefix``1(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32)">
<summary>Creates a new instance from a protocol-buffer stream that has a length-prefixon data (to assist with network IO). </summary>
<typeparam name="T">The type to be created.</typeparam>
<param name="source">The binary stream to apply to the new instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="fieldNumber">The expected tag of the item (only used with base-128 prefix style).</param>
<returns>A new, initialized instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.MergeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
<summary>Applies a protocol-buffer stream to an existing instance, using length-prefixeddata - useful with network IO. </summary>
<typeparam name="T">The type being merged.</typeparam>
<param name="instance">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream,with a length-prefix. This is useful for socket programming,as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object backfrom an ongoing stream. </summary>
<typeparam name="T">The type being serialized.</typeparam>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="destination">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Serializer.SerializeWithLengthPrefix``1(System.IO.Stream,``0,ProtoBuf.PrefixStyle,System.Int32)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream,with a length-prefix. This is useful for socket programming,as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object backfrom an ongoing stream. </summary>
<typeparam name="T">The type being serialized.</typeparam>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="destination">The destination stream to write to.</param>
<param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
</member>
-<member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,System.Int32@)">
<summary>Indicates the number of bytes expected for the next message.</summary>
<param name="source">The stream containing the data to investigate for a length.</param>
<param name="style">The algorithm used to encode the length.</param>
<param name="length">The length of the message, if it could be identified.</param>
<returns>True if a length could be obtained, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.TryReadLengthPrefix(System.Byte[],System.Int32,System.Int32,ProtoBuf.PrefixStyle,System.Int32@)">
<summary>Indicates the number of bytes expected for the next message.</summary>
<param name="buffer">The buffer containing the data to investigate for a length.</param>
<param name="index">The offset of the first byte to read from the buffer.</param>
<param name="count">The number of bytes to read from the buffer.</param>
<param name="style">The algorithm used to encode the length.</param>
<param name="length">The length of the message, if it could be identified.</param>
<returns>True if a length could be obtained, false otherwise.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.FlushPool">
<summary>Releases any internal buffers that have been reserved for efficiency; this does not affect any serializationoperations; simply: it can be used (optionally) to release the buffers for garbage collection (at the expenseof having to re-allocate a new buffer for the next operation, rather than re-use prior buffers). </summary>
</member>
-<member name="T:ProtoBuf.Serializer.NonGeneric">
<summary>Provides non-generic access to the default serializer. </summary>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.DeepClone(System.Object)">
<summary>Create a deep clone of the supplied instance; any sub-items are also cloned. </summary>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.Serialize(System.IO.Stream,System.Object)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream. </summary>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="dest">The destination stream to write to.</param>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.Deserialize(System.Type,System.IO.Stream)">
<summary>Creates a new instance from a protocol-buffer stream </summary>
<param name="type">The type to be created.</param>
<param name="source">The binary stream to apply to the new instance (cannot be null).</param>
<returns>A new, initialized instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.Merge(System.IO.Stream,System.Object)">
<summary>Applies a protocol-buffer stream to an existing instance.</summary>
<param name="instance">The existing instance to be modified (cannot be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<returns>The updated instance</returns>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.SerializeWithLengthPrefix(System.IO.Stream,System.Object,ProtoBuf.PrefixStyle,System.Int32)">
<summary>Writes a protocol-buffer representation of the given instance to the supplied stream,with a length-prefix. This is useful for socket programming,as DeserializeWithLengthPrefix/MergeWithLengthPrefix can be used to read the single object backfrom an ongoing stream. </summary>
<param name="instance">The existing instance to be serialized (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="destination">The destination stream to write to.</param>
<param name="fieldNumber">The tag used as a prefix to each record (only used with base-128 style prefixes).</param>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.TryDeserializeWithLengthPrefix(System.IO.Stream,ProtoBuf.PrefixStyle,ProtoBuf.Serializer.TypeResolver,System.Object@)">
<summary>Applies a protocol-buffer stream to an existing instance (or null), using length-prefixeddata - useful with network IO. </summary>
<param name="value">The existing instance to be modified (can be null).</param>
<param name="source">The binary stream to apply to the instance (cannot be null).</param>
<param name="style">How to encode the length prefix.</param>
<param name="resolver">Used to resolve types on a per-field basis.</param>
<returns>The updated instance; this may be different to the instance argument ifeither the original instance was null, or the stream defines a known sub-type of theoriginal instance.</returns>
</member>
-<member name="M:ProtoBuf.Serializer.NonGeneric.CanSerialize(System.Type)">
<summary>Indicates whether the supplied type is explicitly modelled by the model </summary>
</member>
-<member name="T:ProtoBuf.Serializer.GlobalOptions">
<summary>Global switches that change the behavior of protobuf-net </summary>
</member>
-<member name="P:ProtoBuf.Serializer.GlobalOptions.InferTagFromName">
-<summary>
<see cref="P:ProtoBuf.Meta.RuntimeTypeModel.InferTagFromNameDefault"/>
</summary>
</member>
-<member name="T:ProtoBuf.Serializer.TypeResolver">
<summary>Maps a field-number to a type </summary>
</member>
-<member name="M:ProtoBuf.Serializers.IProtoSerializer.Write(System.Object,ProtoBuf.ProtoWriter)">
<summary>Perform the steps necessary to serialize this data. </summary>
<param name="value">The value to be serialized.</param>
<param name="dest">The writer entity that is accumulating the output data.</param>
</member>
-<member name="M:ProtoBuf.Serializers.IProtoSerializer.Read(System.Object,ProtoBuf.ProtoReader)">
<summary>Perform the steps necessary to deserialize this data. </summary>
<param name="value">The current value, if appropriate.</param>
<param name="source">The reader providing the input data.</param>
<returns>The updated / replacement value.</returns>
</member>
-<member name="M:ProtoBuf.Serializers.IProtoSerializer.EmitWrite(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
<summary>Emit the IL necessary to perform the given actionsto serialize this data. </summary>
<param name="ctx">Details and utilities for the method being generated.</param>
<param name="valueFrom">The source of the data to work against;If the value is only needed once, then LoadValue is sufficient. Ifthe value is needed multiple times, then note that a "null"means "the top of the stack", in which case you should create yourown copy - GetLocalWithValue.</param>
</member>
-<member name="M:ProtoBuf.Serializers.IProtoSerializer.EmitRead(ProtoBuf.Compiler.CompilerContext,ProtoBuf.Compiler.Local)">
<summary>Emit the IL necessary to perform the given actions to deserialize this data. </summary>
<param name="ctx">Details and utilities for the method being generated.</param>
<param name="entity">For nested values, the instance holding the values; notethat this is not always provided - a null means not supplied. Since this is alwaysa variable or argument, it is not necessary to consume this value.</param>
</member>
-<member name="P:ProtoBuf.Serializers.IProtoSerializer.ExpectedType">
<summary>The type that this serializer is intended to work for. </summary>
</member>
-<member name="P:ProtoBuf.Serializers.IProtoSerializer.RequiresOldValue">
-<summary>
Indicates whether a Read operation
<em>replaces</em>
the existing value, or
<em>extends</em>
the value. If false, the "value" parameter to Read isdiscarded, and should be passed in as null.
</summary>
</member>
-<member name="P:ProtoBuf.Serializers.IProtoSerializer.ReturnsValue">
<summary>Now all Read operations return a value (although most do); if false novalue should be expected. </summary>
</member>
-<member name="T:ProtoBuf.ServiceModel.ProtoBehaviorAttribute">
<summary>Uses protocol buffer serialization on the specified operation; note that thismust be enabled on both the client and server. </summary>
</member>
-<member name="T:ProtoBuf.ServiceModel.ProtoBehaviorExtension">
<summary>Configuration element to swap out DatatContractSerilaizer with the XmlProtoSerializer for a given endpoint. </summary>
<seealso cref="T:ProtoBuf.ServiceModel.ProtoEndpointBehavior"/>
</member>
-<member name="M:ProtoBuf.ServiceModel.ProtoBehaviorExtension.#ctor">
<summary>Creates a new ProtoBehaviorExtension instance. </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.ProtoBehaviorExtension.CreateBehavior">
<summary>Creates a behavior extension based on the current configuration settings. </summary>
<returns>The behavior extension.</returns>
</member>
-<member name="P:ProtoBuf.ServiceModel.ProtoBehaviorExtension.BehaviorType">
<summary>Gets the type of behavior. </summary>
</member>
-<member name="T:ProtoBuf.ServiceModel.ProtoEndpointBehavior">
-<summary>
Behavior to swap out DatatContractSerilaizer with the XmlProtoSerializer for a given endpoint.
-<example>
Add the following to the server and client app.config in the system.serviceModel section:
-<behaviors>
-<endpointBehaviors>
-<behavior name="ProtoBufBehaviorConfig">
<ProtoBufSerialization/>
</behavior>
</endpointBehaviors>
</behaviors>
-<extensions>
-<behaviorExtensions>
<add name="ProtoBufSerialization" type="ProtoBuf.ServiceModel.ProtoBehaviorExtension, protobuf-net, Version=1.0.0.255, Culture=neutral, PublicKeyToken=257b51d87d2e4d67"/>
</behaviorExtensions>
</extensions>
Configure your endpoints to have a behaviorConfiguration as follows:
-<service name="TK.Framework.Samples.ServiceModel.Contract.SampleService">
<endpoint name="basicHttpProtoBuf" contract="ISampleServiceContract" bindingConfiguration="basicHttpBindingConfig" behaviorConfiguration="ProtoBufBehaviorConfig" binding="basicHttpBinding" address="http://myhost:9003/SampleService"/>
</service>
-<client>
<endpoint name="BasicHttpProtoBufEndpoint" contract="ISampleServiceContract" bindingConfiguration="basicHttpBindingConfig" behaviorConfiguration="ProtoBufBehaviorConfig" binding="basicHttpBinding" address="http://myhost:9003/SampleService"/>
</client>
</example>
</summary>
</member>
-<member name="T:ProtoBuf.ServiceModel.ProtoOperationBehavior">
<summary>Describes a WCF operation behaviour that can perform protobuf serialization </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.ProtoOperationBehavior.#ctor(System.ServiceModel.Description.OperationDescription)">
<summary>Create a new ProtoOperationBehavior instance </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.ProtoOperationBehavior.CreateSerializer(System.Type,System.Xml.XmlDictionaryString,System.Xml.XmlDictionaryString,System.Collections.Generic.IList{System.Type})">
<summary>Creates a protobuf serializer if possible (falling back to the default WCF serializer) </summary>
</member>
-<member name="P:ProtoBuf.ServiceModel.ProtoOperationBehavior.Model">
<summary>The type-model that should be used with this behaviour </summary>
</member>
-<member name="T:ProtoBuf.ServiceModel.XmlProtoSerializer">
<summary>An xml object serializer that can embed protobuf data in a base-64 hunk (looking like a byte[]) </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.TryCreate(ProtoBuf.Meta.TypeModel,System.Type)">
<summary>Attempt to create a new serializer for the given model and type </summary>
<returns>A new serializer instance if the type is recognised by the model; null otherwise</returns>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.#ctor(ProtoBuf.Meta.TypeModel,System.Type)">
<summary>Creates a new serializer for the given model and type </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteEndObject(System.Xml.XmlDictionaryWriter)">
<summary>Ends an object in the output </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteStartObject(System.Xml.XmlDictionaryWriter,System.Object)">
<summary>Begins an object in the output </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.WriteObjectContent(System.Xml.XmlDictionaryWriter,System.Object)">
<summary>Writes the body of an object in the output </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.IsStartObject(System.Xml.XmlDictionaryReader)">
<summary>Indicates whether this is the start of an object we are prepared to handle </summary>
</member>
-<member name="M:ProtoBuf.ServiceModel.XmlProtoSerializer.ReadObject(System.Xml.XmlDictionaryReader,System.Boolean)">
<summary>Reads the body of an object </summary>
</member>
-<member name="T:ProtoBuf.SubItemToken">
<summary>Used to hold particulars relating to nested objects. This is opaque to the caller - simplygive back the token you are given at the end of an object. </summary>
</member>
-<member name="T:ProtoBuf.WireType">
<summary>Indicates the encoding used to represent an individual value in a protobuf stream </summary>
</member>
-<member name="F:ProtoBuf.WireType.None">
<summary>Represents an error condition </summary>
</member>
-<member name="F:ProtoBuf.WireType.Variant">
<summary>Base-128 variant-length encoding </summary>
</member>
-<member name="F:ProtoBuf.WireType.Fixed64">
<summary>Fixed-length 8-byte encoding </summary>
</member>
-<member name="F:ProtoBuf.WireType.String">
<summary>Length-variant-prefixed encoding </summary>
</member>
-<member name="F:ProtoBuf.WireType.StartGroup">
<summary>Indicates the start of a group </summary>
</member>
-<member name="F:ProtoBuf.WireType.EndGroup">
<summary>Indicates the end of a group </summary>
</member>
-<member name="F:ProtoBuf.WireType.Fixed32">
<summary>Fixed-length 4-byte encoding </summary>
10
</member>
-<member name="F:ProtoBuf.WireType.SignedVariant">
<summary>This is not a formal wire-type in the "protocol buffers" spec, but denotes a variant integer that should be interpreted usingzig-zag semantics (so -ve numbers aren't a significant overhead) </summary>
</member>
</members>
</doc>Language
CommandLineDemo
ShipRush.SDK.CommandLineDemo.EXE.zip
ShipRush.SDK.CommandLineDemo.exe CONFIG.zip
ShipRush.SDK.CommandLineDemo.PDB.zip
SDK
Properties
using System.Reflection;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
// General Information about an assembly is controlled through the following
// set of attributes. Change these attribute values to modify the information
// associated with an assembly.
[assembly: AssemblyTitle("ShipRush.SDK.CommandLineDemo")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Descartes Systems")]
[assembly: AssemblyProduct("ShipRush.SDK.CommandLineDemo")]
[assembly: AssemblyCopyright("(c) Z-Firm LLC ALL RIGHTS RESERVED")]
[assembly: AssemblyTrademark("ShipRush is a registered trademark of Z-Firm LLC")]
[assembly: AssemblyCulture("")]
// Setting ComVisible to false makes the types in this assembly not visible
// to COM components. If you need to access a type in this assembly from
// COM, set the ComVisible attribute to true on that type.
[assembly: ComVisible(false)]
// The following GUID is for the ID of the typelib if this project is exposed to COM
[assembly: Guid("6efb0464-4ff4-4e28-ae65-de4aa0af759f")]
// Version information for an assembly consists of the following four values:
//
// Major Version
// Minor Version
// Build Number
// Revision
//
// You can specify all the values or you can default the Build and Revision Numbers
// by using the '*' as shown below:
// [assembly: AssemblyVersion("1.0.*")]
[assembly: AssemblyVersion("4.0.14.0471")]
[assembly: AssemblyFileVersion("4.0.14.0471")]Shipments
<?xml version="1.0"?>
-<Request>
-<ShipTransaction>
-<Shipment>
<ShipmentNumber>1ZX9894Y0390980783</ShipmentNumber>
<UOMWeight>LBS</UOMWeight>
<UPSServiceType>03</UPSServiceType>
<ShipmentChgType>PRE</ShipmentChgType>
<PaymentMediaTypeCode>10</PaymentMediaTypeCode>
<UOMDim>IN</UOMDim>
<CurrencyCode>USD</CurrencyCode>
<DocInd>3</DocInd>
<ExcCurrency>USD</ExcCurrency>
<ShipDate>06/26/2009 09:53:59</ShipDate>
<EarliestDeliveryTime>12/29/1899</EarliestDeliveryTime>
<CWTTier>1</CWTTier>
<FDXHomeDeliveryDate>12/30/1899</FDXHomeDeliveryDate>
<LatestPickupTime>00:00:00</LatestPickupTime>
<ReadyTime>00:00:00</ReadyTime>
<AccessTime>00:00:00</AccessTime>
<CutOffTime>00:00:00</CutOffTime>
<MerchantPhone>2063280000</MerchantPhone>
<IsProcessed>1</IsProcessed>
<InsuranceProvider>Carrier</InsuranceProvider>
-<Package>
<PackageTrackingNumber>1ZX9894Y0390980783</PackageTrackingNumber>
<RatesTotal>470</RatesTotal>
<PackageActualWeight>1</PackageActualWeight>
<DeliverToAttnName>eBay purchase: %ItemID%</DeliverToAttnName>
<PackagingType>02</PackagingType>
<CODFunds>00</CODFunds>
<CODCurrencyCode>USD</CODCurrencyCode>
<InsuranceType>EVS</InsuranceType>
<InsuranceCurrency>USD</InsuranceCurrency>
<RateWeight>1</RateWeight>
<ShipDate>06/26/2009 09:54:05</ShipDate>
<LabelFilename>c:\documents and settings\common\my documents\z-firm llc\shiprush\labels\1ZX9894Y0390980783.bmp</LabelFilename>
<LabelFormat>2</LabelFormat>
<RateBaseCharge>470</RateBaseCharge>
<UPSServiceType>03</UPSServiceType>
<DeliveryAddress>confirmed SEATTLE WA 98179</DeliveryAddress>
<ShipmentID>1502</ShipmentID>
<IsProcessed>1</IsProcessed>
<HistCompany>eBay purchase: %ItemID%</HistCompany>
<HistName>eBay purchase: %ItemID%</HistName>
<RateCarrierCharges>470</RateCarrierCharges>
<RateListBaseCharges>470</RateListBaseCharges>
<RateListCarrierCharges>470</RateListCarrierCharges>
<EffectiveCarrierCharges>470</EffectiveCarrierCharges>
<RatesListTotal>470</RatesListTotal>
<HistZIP>98179</HistZIP>
<HistAddress1>confirmed</HistAddress1>
<USPSMachinable>1</USPSMachinable>
</Package>
-<DeliveryAddress>
<AddressQualifier>18</AddressQualifier>
-<Address>
<FirstName>eBay</FirstName>
<LastName>purchase: %ItemID%</LastName>
<Company>eBay purchase: %ItemID%</Company>
<Address1>111 Main Street</Address1>
<City>SEATTLE</City>
<State>WA</State>
<PostalCode>98179</PostalCode>
<Country>US</Country>
<Phone>12063280000</Phone>
<AddrValID>98179</AddrValID>
<AddrValResult>00</AddrValResult>
<AddrValDate>12/30/1899</AddrValDate>
</Address>
</DeliveryAddress>
-<ShipperAddress>
<AddressQualifier>37</AddressQualifier>
-<Address>
<FirstName>Samuel</FirstName>
<LastName>Test</LastName>
<Company>ZForm</Company>
<Address1>120 lakeiside ave suite</Address1>
<Address2>Ste 101</Address2>
<City>SEATTLE</City>
<State>WA</State>
<PostalCode>98122</PostalCode>
<Country>US</Country>
<Phone>12063280000</Phone>
<EMail>asdf@asdf.com</EMail>
<AddrValResult>00</AddrValResult>
<AddrValDate>12/30/1899</AddrValDate>
</Address>
</ShipperAddress>
</Shipment>
</ShipTransaction>
</Request>
<?xml version="1.0" encoding="UTF-8"?>
-<Request>
-<ShipTransaction>
-<Shipment xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UPSServiceType>03</UPSServiceType>
<ShipmentChgType>PRE</ShipmentChgType>
<PaymentMediaTypeCode>10</PaymentMediaTypeCode>
<DocInd>3</DocInd>
<PartnerId>eBay</PartnerId>
<InsuranceProvider>Carrier</InsuranceProvider>
-<Package>
<PackageActualWeight>2</PackageActualWeight>
<PackageReference1>XM Radio Headphones</PackageReference1>
<InsuranceType>EVS</InsuranceType>
<InsuranceCurrency>USD</InsuranceCurrency>
<USPSMachinable>1</USPSMachinable>
</Package>
-<DeliveryAddress>
-<Address>
<FirstName>Sam</FirstName>
<LastName>Seller</LastName>
<Address1>2233 Main Street</Address1>
<City>seattle</City>
<State>WA</State>
<StateString>WA</StateString>
<CountryString>US</CountryString>
<PostalCode>98122</PostalCode>
<Country>US</Country>
<Phone>(707) 511-1111</Phone>
</Address>
</DeliveryAddress>
<ShipmentStatus>Unknown</ShipmentStatus>
<ShipmentType>Unknown</ShipmentType>
</Shipment>
</ShipTransaction>
</Request>
<?xml version="1.0" encoding="UTF-8"?>
-<Request>
-<ShipTransaction>
-<Order>
<ShipMethod>USPS Express</ShipMethod>
<AlternativeOrderNumber>267</AlternativeOrderNumber>
<OrderDate>2009-09-25T16:45:00.000Z</OrderDate>
<ItemsTotal>9</ItemsTotal>
<Total>2</Total>
<ShippingChargesPaid>0</ShippingChargesPaid>
<ItemsTax>0</ItemsTax>
<OrderNumber>110425958771</OrderNumber>
<ExternalID>ph_buyer 110425958771 432248742001</ExternalID>
<PaymentType>3</PaymentType>
<PaymentStatus>2</PaymentStatus>
<Currency>GBP</Currency>
<UnitsOfMeasureWeight>LBS</UnitsOfMeasureWeight>
<UnitsOfMeasureLinear>CM</UnitsOfMeasureLinear>
<PkgLength>1</PkgLength>
<PkgWidth>2</PkgWidth>
<PkgHeight>3</PkgHeight>
-<ShipmentOrderItem>
<Name>ShipRush Pen with FREE ShipRush for eBay Software</Name>
<Price>1</Price>
<ExternalID>110425958771</ExternalID>
<Quantity>9</Quantity>
<Total>9</Total>
<ItemLength>1</ItemLength>
<ItemWidth>2</ItemWidth>
<ItemHeight>3</ItemHeight>
</ShipmentOrderItem>
-<BillingAddress>
<FirstName>Peter</FirstName>
<LastName>Himmelman</LastName>
<NickName>ph_buyer</NickName>
<Address1>444 La Cienega.</Address1>
<City>Denver</City>
<StateString>CO</StateString>
<CountryString>US</CountryString>
<PostalCode>80212</PostalCode>
<Phone>(206) 111-2222</Phone>
<EMail>phimmelski@hotmail.com</EMail>
</BillingAddress>
-<ShippingAddress>
<FirstName>Peter</FirstName>
<LastName>Himmelman</LastName>
<Address1>444 La Cienega St.</Address1>
<City>Denver</City>
<StateString>CO</StateString>
<CountryString>US</CountryString>
<PostalCode>80212</PostalCode>
<Phone>(206) 111-2222</Phone>
<EMail>phimmelski@hotmail.com</EMail>
</ShippingAddress>
<ShipmentType>Pending</ShipmentType>
</Order>
-<Shipment>
<CurrencyCode>MXN</CurrencyCode>
<Carrier>3</Carrier>
<ShippingCharges>0</ShippingCharges>
<UPSServiceType>U05</UPSServiceType>
<ShipmentReference1>110425958771, ShipRush Pen with FREE ShipRush for eBay Software</ShipmentReference1>
<ShipDate>2009-09-25T16:45:00.000Z</ShipDate>
<IsProcessed>0</IsProcessed>
-<Package>
<PackageReference1>110425958771, ShipRush Pen with FREE ShipRush for eBay Software</PackageReference1>
<InsuranceAmount>0</InsuranceAmount>
<ShipDate>2009-09-25T16:45:00.000Z</ShipDate>
</Package>
-<ShipperAddress>
-<Address>
<FirstName>ASDF</FirstName>
<LastName>Himmelman</LastName>
<Company>ASDF</Company>
<Address1>777 La Cienega St.</Address1>
<City>Seattle</City>
<State>WA</State>
<StateString>WA</StateString>
<CountryString>US</CountryString>
<PostalCode>98122</PostalCode>
<Country>US</Country>
</Address>
</ShipperAddress>
-<DeliveryAddress>
-<Address>
<FirstName>Peter</FirstName>
<LastName>Himmelman</LastName>
<Company>eBay purchase: 2aa399f2-bc58-40aa-887b-9c8f00bc73eb</Company>
<Address1>444 La Cienega St.</Address1>
<City>Denver</City>
<State>CO</State>
<StateString>CO</StateString>
<CountryString>US</CountryString>
<PostalCode>80212</PostalCode>
<Country>US</Country>
<Phone>(206) 111-2222</Phone>
<EMail>phimmelski@hotmail.com</EMail>
</Address>
</DeliveryAddress>
<ShipmentStatus>Unknown</ShipmentStatus>
<ShipmentType>Pending</ShipmentType>
</Shipment>
</ShipTransaction>
</Request>
<?xml version="1.0" encoding="UTF-8"?>
-<Request>
-<ShipTransaction>
-<Shipment>
<UPSServiceType>U02</UPSServiceType>
<ShipmentReference1>109-5997097-8897034 - ShipRush Socks</ShipmentReference1>
<Carrier>1</Carrier>
-<Package>
<PackageActualWeight>1</PackageActualWeight>
<PackagingType>02</PackagingType>
<PkgLength>5</PkgLength>
<PkgWidth>2</PkgWidth>
<PkgHeight>5</PkgHeight>
<AdditionalHandling>0</AdditionalHandling>
<DCISType>F5</DCISType>
</Package>
-<ShipperAddress>
-<Address>
<LastName>Tusha Kutusha</LastName>
<Company>Acme Inc</Company>
<Address1>120 Lakeside ave</Address1>
<Address2>#101</Address2>
<City>Seattle</City>
<State>WA</State>
<Country>US</Country>
<PostalCode>98122</PostalCode>
<Phone>206-500-6000</Phone>
</Address>
</ShipperAddress>
-<DeliveryAddress>
-<Address>
<LastName>Masha Malasha</LastName>
<Company>Z-Firm LLC</Company>
<Address1>120 Lakeside ave</Address1>
<Address2>suite #101</Address2>
<City>Seattle</City>
<State>WA</State>
<Country>US</Country>
<PostalCode>98122</PostalCode>
<Phone>206-500-6000</Phone>
</Address>
</DeliveryAddress>
</Shipment>
-<Order>
<OrderNumber>109-5997097-8897034</OrderNumber>
-<ShipmentOrderItem>
<AccountingID>36892958790834</AccountingID>
<Name>ShipRush Socks</Name>
<Quantity>1</Quantity>
</ShipmentOrderItem>
</Order>
</ShipTransaction>
</Request>App Configuration
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
<section name="MyShipRush" type="System.Configuration.NameValueSectionHandler"/>
</configSections>
<log4net>
<appender name="LogToFile" type="log4net.Appender.FileAppender">
<file value="debug.log" />
<appendToFile value="true" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
</layout>
</appender>
<appender name="LogToConsole" type="log4net.Appender.ConsoleAppender">
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%n%d{HH:mm:ss.fff} %-5p - %m" />
</layout>
</appender>
<root>
<level value="DEBUG"/>
<appender-ref ref="LogToConsole" />
<appender-ref ref="LogToFile" />
</root>
</log4net>
<MyShipRush>
<add key="ServiceRootUrl" value="https://sandbox.api.my.shiprush.com/"/>
<add key="DeveloperToken" value="928bdf97-f0b3-4816-aabf-a1ce015f2621"/>
<add key="OpenBrowser" value="false"/>
<!-- Case 49802 -->
<!-- sandbox uses 'sdk_commandline_test@shiprush.com' (accountId=86f6b18b-9b57-4683-adbe-a720012543bf) shipping token to run postage/EOD tests -->
<add key="ShippingToken" value="0655ced1-4e64-48cf-bf04-b3c8ee8c155e"/>
</MyShipRush>
</configuration>Large Partner Scenario
/*
{ ************************************************************************** }
{ * * }
{ * This file contains information that is the confidential and * }
{ * proprietary property of Z-Firm LLC, and may not be copied, published, * }
{ * disclosed, or transmitted to others, or used for any purpose without * }
{ * the express written authorization of Z-Firm LLC. * }
{ * * }
{ * * }
{ * * }
{ * Copyright 2009-2013 Z-Firm LLC. All Rights Reserved. * }
{ * * }
{ ************************************************************************** }
*/
/*
My.ShipRush API Demonstration Application.
This is a "firehose" style demonstration app. The app just runs and executes all the API calls in sequence.
It keeps a log as debug.log.
If we were you.... we would take these steps:
1) Just set up the app.config, and run it, then review the log file.
2) At this point, you see the API calls being invoked, and the flow of the app.
3) Then, open this app in the Visual Studio debugger, and step through it.
4) Now you see each API call, with params, etc.
Note: Check the app.config file, that it is pointing to the desired target (sandbox
or production), and has the relevant developer token.
Support Libraries:
Z-Firm maintains a .NET "My.ShipRush API wrapper assembly": ShipRush.SDK.Proxies.dll
If you are working in .NET, you are welcome to use this as your interface to the
My.ShipRush API. This assembly is maintained by Z-Firm on an ongoing basis, and new API calls
and polishing will be done to it.
If you are not working in .NET, the source code to ShipRush.SDK.Proxies.dll should be reviewed
as part of your implementation.
"Fiddler Friendly"
If you are working in .NET, you can just use the proxy.dll and you are rolling.
If not, you may want to watch the API calls using Fiddler, so you can see the full
REST interaction.
Happy Coding!
*/
using log4net;
using ShipRush.SDK.Proxies;
using ShipRush.SDK.Proxies.AccountManagement;
using ShipRush.SDK.Proxies.InventoryManagement;
using ShipRush.SDK.Proxies.ShipmentManagement;
using ShipRush.SDK.Proxies.Shipping;
using ShipRush.SDK.Transport;
using ShipRush.SDK.Utils;
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.ExceptionServices;
using System.Threading;
namespace ShipRush.SDK.CommandLineDemo
{
// Demonstrates My.ShipRush abilities for large partners
// Each large partner has unique DEVELOPER_TOKEN that allows access to "Account" and "Shipment" APIs
public class LargePartnerScenario
{
const int acceptable_server_time_difference_seconds = 5;
private static ILog logger = LogManager.GetLogger(typeof(LargePartnerScenario));
private static Random rnd = new Random();
public void Run()
{
// Apply settings from App.Config file to ShipRushSDK context
ShipRushServiceSettings.ApplyToShipRushSDK_UserAndDeveloper();
LogShipRushSDKParameters();
CreateUserFailed();
// "Account" API can be access with DEVELOPER_TOKEN only.
// "Shipment" API requires DEVELOPER_TOKEN and USER_TOKEN.
// So first thing you have to do is get USER_TOKEN (by creating new user)
// Persist this user token for future reference
string userToken = CreateNewUser();
ShipRushSDK.UserToken = userToken;
LogShipRushSDKParameters();
AddGetUpdateShipmentAndOrder("003.xml");
// Add one pending shipment and test that it was added OK
AddGetUpdateShipment("001.xml");
// Use special API call to fill new user with some test data - WebStore and few shipments
AddTestDataToUser();
// List all available webstore types that can be created
GetAvailableWebstoreTypes();
// Create new empty webstore
var webstore = CreateWebstore("etsy");
// Add one pending shipment to specific webstore
AddGetUpdateShipment("002.xml", webstore.WebstoreId);
#if Compiled_for_Windows_Service_Case_35674
// Windows service may not have rights to run ShellExecute to start browser
// Skip this part of testing
#else
// Start web browser for interactive setup for newly created webstore
SetupWebstore(webstore.SetupUrl);
// Wait 45 seconds to allow user complete store registrations
// Nobody uses this test for full Etsy setup.
// This just adds 45 seconds of unneccessary waiting.
// Thread.Sleep(45*1000);
#endif
// Check user configuration, get list of configured webstores
GetUserResponse userInfo = GetUserSettings();
CheckWebstoreStatus(userInfo.Merchants, webstore.WebstoreId);
logger.Debug("--------------------------------");
logger.Debug("GetPendingShipmentsAll and mark one as shipped");
logger.Debug("--------------------------------");
// Get all shipments
var shipmentsAll = GetPendingShipmentsAll();
if (shipmentsAll.ShipTransactionHeaders.Count == 0)
throw new ApplicationException("Something is wrong: 0 pending shipments found");
logger.DebugFormat("ShipmentsAll: {0}", shipmentsAll.ShipTransactionHeaders.Count);
// Get one shipment
GetOneShipmentClickySimulation(shipmentsAll);
// Grap first shipment from response and mark it as shipped
MarkOneShipmentAsShipped(shipmentsAll);
// Get all shipments
var shipmentsAll_MinusOne = GetPendingShipmentsAll();
logger.DebugFormat("ShipmentsAll_MinusOne: {0}", shipmentsAll_MinusOne.ShipTransactionHeaders.Count);
if (shipmentsAll.ShipTransactionHeaders.Count != (shipmentsAll_MinusOne.ShipTransactionHeaders.Count + 1))
throw new ApplicationException(string.Format("One shipment must be marked as history. ShipmentsAll_MinusOne: {0} expected, {1} received",
shipmentsAll.ShipTransactionHeaders.Count - 1,
shipmentsAll_MinusOne.ShipTransactionHeaders.Count));
// Get pending shipments per merchant
foreach (MerchantInfo merchant in userInfo.Merchants)
{
// Get list of shipments
GetShipmentsResponse shipments = GetPendingShipmentsByMerchant(merchant);
// Mark all shipments as "shipped"
MarkShipmentsAsShipped(shipments);
}
// Delete webstore
DeleteWebstore(webstore.WebstoreId);
CheckAmazonPrimeSearchParameters(userInfo, webstore);
CheckShipmentExtendedParameters(userInfo, webstore);
if (!string.IsNullOrEmpty(ShipRushServiceSettings.ShippingToken))
{
// Shipping API tests
// There is no way to auto-create shipping token.
// So Shipping token is pre-configured and belongs to a different account.
ShipRushServiceSettings.ApplyToShipRushSDK_Shipping();
LogShipRushSDKParameters();
BuyPostage();
// Case 69056: SDK Command line demo must test ShipRushUSPS in BOTH EasyPost and PB modes
// Easiest way is to run all tests 3 TIMES, once in PB mode and once in EasyPost mode and once in "Auto"
var shipRushUSPS_CarrierModes = new List<TCarrierType>()
{
TCarrierType.Unknown,
TCarrierType.PitneyBowes,
// Case 69056
// Case 69293
// Case 69269
// Case 69356
// - There is no way to create bulk meter account user with Test API key
// - Running all tests in explicit EasyPost mode with production user results in $300..500 charges per day
// Conclusion: DO NOT run explicit EasyPost tests until we have Case 69293 solved
// Case 69356 is fixed and "EasyPost.PrintTestLabels" is set to "true" on Sandbox
TCarrierType.EasyPostUSPS
};
foreach (var prefererredCarrier in shipRushUSPS_CarrierModes)
{
SetPreferredCarrierMode(prefererredCarrier);
// Process "unvoided" Shiprush USPS shipments first, so EasyPost/PB have time to get ready for EndOfDay request
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSExpress, TPackageType.Package, false);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSPriority, TPackageType.Package, false);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.UPS, TUPSService.UPSGround);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.FedEx, TUPSService.FedEx2Day);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSExpress);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSPriority);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSFirstClass, TPackageType.Letter, false);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.EasyPostUSPS, TUPSService.USPSPriority);
Ship_Rate_RateShopping_ValidateAddress_ExpectFailure(TCarrierType.Amazon, TUPSService.UPSGround);
Ship_Rate_RateShopping_ValidateAddress_ExpectFailure(TCarrierType.FedEx, TUPSService.FedExInternationalPriority);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSExpress, TPackageType.Package, false);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.ShipRushUSPS, TUPSService.USPSPriority, TPackageType.Package, false);
Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType.FirstMile, TUPSService.FedEx2Day); //Case 68259
EndOfDay(prefererredCarrier);
}
}
else
{
logger.Warn("Shipping API tests skipped");
}
// Case 70955: Catalog and Inventory management Web API: Add into LargePartnerScenario
// Run catalog and inventory operations
// Case 75088: FIRST!!! Build failed
// RunInventoryManagementOperations();
logger.Debug("--------------------------- COMPLETED SUCCESS");
}
private void SetPreferredCarrierMode(TCarrierType prefererredCarrier)
{
try
{
logger.Debug(string.Format("UpdateUser - SetPreferredCarrierMode = {0}", prefererredCarrier));
var updateUserRequest = new ShipRush.SDK.Proxies.UpdateUserRequest()
{
AccountId = ShipRushSDK.AccountId,
ShipRushUSPSPreferredCarrier = prefererredCarrier.ToString()
};
var updateUserResponse = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.UpdateUserRequest, ShipRush.SDK.Proxies.UpdateUserResponse>(APICommands.UPDATE_USER, updateUserRequest);
if (updateUserResponse.ShipRushUSPSPreferredCarrier.ToEnum(TCarrierType.Unknown) != prefererredCarrier)
throw new ApplicationException("Could not set prefrerred customer");
logger.Debug("UpdateUser - call completed, waiting for cache to expire");
// Long sleep to allow settings cache inside webservice to expire
Thread.Sleep(30 * 1000);
logger.Debug("UpdateUser - Completed");
}
catch (Exception exc)
{
logger.Error(exc.Message);
throw;
}
}
private void EndOfDay(TCarrierType prefererredCarrier)
{
try
{
logger.DebugFormat("EndOfDay {0}", prefererredCarrier);
CheckServerTime();
var getShippingAccountsRequest = new ShipRush.SDK.Proxies.GetShippingAccountsRequest();
var getShippingAccountsResponse = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.GetShippingAccountsRequest, ShipRush.SDK.Proxies.GetShippingAccountsResponse>(APICommands.GET_SHIPPINGACCOUNTS, getShippingAccountsRequest);
var eodAccountsCount = 0;
foreach (var shippingAccount in getShippingAccountsResponse.ShippingAccounts)
{
// Case 56918
// At the moment SDK CommandLine Demo is only capable to verify EOD for PitneyBowes mode
// because it takes EasyPost several minutes to get EOD documents ready.
if (shippingAccount.CarrierType == TCarrierType.ShipRushUSPS)
{
int maxRetries = 3;
// Case 79934: LargePartnerScenario: Make it more robust!!
// PG: EOD call often fails because carrier service does not return EOD documents in expected time. In such situation we need to retrie this call.
for (int callCount = 0; callCount < maxRetries; callCount++)
{
try
{
logger.Debug($"EOD attempt {callCount + 1}");
CloseShippingDay(shippingAccount);
break; // PG: We got expected response, no need to retry
}
catch (Exception ex)
{
logger.Debug($"CloseShippingDay attempt {callCount + 1} failed: {ex.Message}");
if (callCount + 1 < maxRetries) // PG: We need to prevent going into sleep unnecasseary (Last loop)
{
// Will wait 1, 2, 3 minutes between failed calls.
int waitTime = 60 * 1000 * callCount;
Thread.Sleep(waitTime);
}
else
{
throw new ApplicationException("At least one document expected after EOD");
}
}
}
eodAccountsCount++;
}
}
if (eodAccountsCount == 0)
throw new ApplicationException("At least one EOD expected");
logger.DebugFormat("EndOfDay {0} - completed for {1} accounts", prefererredCarrier, eodAccountsCount);
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
catch (Exception exc)
{
// Case 56918, 69056
// SDK Command line demo must test ShipRushUSPS in BOTH EasyPost and PB modes
// At the moment SDK CommandLine Demo is only capable to verify EOD for PitneyBowes mode
// because it takes EasyPost several minutes to get EOD documents ready.
if (prefererredCarrier == TCarrierType.EasyPostUSPS)
{
logger.Debug("EXPECTED ERROR: " + exc.Message);
return;
}
logger.Error(exc.Message);
throw;
}
}
private static void CloseShippingDay(GetShippingAccountResponse shippingAccount)
{
logger.DebugFormat("EndOfDay for {0}, {1}", shippingAccount.AccountNumber, shippingAccount.ShippingAccountId);
EODRequest request = new EODRequest()
{
ShippingAccountId = shippingAccount.ShippingAccountId.ToString()
};
var response = ShipRushSDK.ExecuteCommand<EODRequest, EODResponse>(APICommands.SHIPMENT_EOD, request);
logger.DebugFormat("EndOfDay completed with {0} documents", response.Documents.Count);
if (!response.IsSuccess)
throw new ApplicationException(string.Format("EOD failed: {0}", response.GetErrorsAsText()));
// Case 57044: After 5pm PST ShipDateOnLabel sets to the next day and we do not see that shipment in EOD search
// if (DateTime.Now.Hour > 17)
// return;
var isSunday = DateTime.Now.DayOfWeek == DayOfWeek.Sunday;
// Case 56956
// It appears that you can never close shipping day on Sunday because Sunday is not a mail day.
// So if this test runs on Sunday - skip the document count check.
if (!isSunday)
{
if (response.Documents.Count == 0)
throw new ApplicationException("At least one document expected after EOD");
}
}
private void CheckShipmentExtendedParameters(GetUserResponse userInfo, MerchantInfo webstore)
{
logger.Debug("--------------------------------");
logger.Debug("CheckShipmentExtendedParameters");
logger.Debug("--------------------------------");
CheckServerTime();
var modifiedFrom = GetMyShipRushTime().AddSeconds(-10);
TRequest tRequest = GetNewOrderTRequest(webstore);
// Extended fields
tRequest.ShipTransaction[0].Shipment.PostbackUrl = rnd.Next(10000000).ToString();
// International fields
tRequest.ShipTransaction[0].Shipment.DeliveryAddress.Address.Country = TCountry.CA;
tRequest.ShipTransaction[0].Shipment.IsInternational = TBABoolean.ItemTrue;
tRequest.ShipTransaction[0].Shipment.International = new TIntlShipmentInfo() {
FreightCharges = rnd.Next(100) + 1,
CIComments = rnd.Next(10000000).ToString()
};
// Package HazMats fields
tRequest.ShipTransaction[0].Shipment.Package[0].HazMat = new THazMat[2]
{
new THazMat() { EmergencyPhoneNumber = rnd.Next(10000000).ToString() },
new THazMat() { EmergencyPhoneNumber = rnd.Next(10000000).ToString() }
};
// Case 56095, FreightCommodities
tRequest.ShipTransaction[0].Shipment.Package[0].FreightCommodities = new TFreightCommodity[3]
{
new TFreightCommodity() { ItemDescription = rnd.Next(10000000).ToString() },
new TFreightCommodity() { ItemDescription = rnd.Next(10000000).ToString() },
new TFreightCommodity() { ItemDescription = rnd.Next(10000000).ToString() }
};
AddOrder(tRequest, userInfo.UserId, webstore.WebstoreId);
// ------------------------------- GetShipments WITHOUT DETAILS (OrderManager style)
var pendingShipments = GetPendingShipmentsAll(new GetShipmentsRequest()
{
ShipmentType = ShipmentType.Pending,
ModifiedFrom = modifiedFrom,
ModifiedTo = DateTime.UtcNow.AddDays(1),
DetailLevel = DetailLevel.Full,
});
var returnedTShipTransaction = pendingShipments.ShipTransactions.FirstOrDefault(x => x.Order != null && x.Order.ExternalID == tRequest.ShipTransaction[0].Order.ExternalID);
if (returnedTShipTransaction == null)
throw new ApplicationException(string.Format("Expected order {0} not found", tRequest.ShipTransaction[0].Order.ExternalID));
if (returnedTShipTransaction.Shipment.PostbackUrl == tRequest.ShipTransaction[0].Shipment.PostbackUrl)
throw new ApplicationException("Expected that ShipmentExtendedField will NOT match");
if (returnedTShipTransaction.Shipment.International.CIComments == tRequest.ShipTransaction[0].Shipment.International.CIComments)
throw new ApplicationException("Expected that ShipmentInternational will NOT match");
// HazMat should NOT be returned when "ReturnExtendedPackageFields" == false
if (returnedTShipTransaction.Shipment.Package[0].HazMat != null)
throw new ApplicationException("Expected that PackageHazMat will NOT exist");
// ------------------------------- GetShipments WITH ALL DETAILS
pendingShipments = GetPendingShipmentsAll(new GetShipmentsRequest()
{
ShipmentType = ShipmentType.Pending,
ModifiedFrom = modifiedFrom,
ModifiedTo = DateTime.UtcNow.AddDays(1),
DetailLevel = DetailLevel.Full,
ReturnExtendedShipmentFields = BooleanPropertyWithDefault.True,
ReturnExtendedInternationalFields = BooleanPropertyWithDefault.True,
ReturnExtendedPackageFields = BooleanPropertyWithDefault.True,
});
returnedTShipTransaction = pendingShipments.ShipTransactions.FirstOrDefault(x => x.Order != null && x.Order.ExternalID == tRequest.ShipTransaction[0].Order.ExternalID);
if (returnedTShipTransaction == null)
throw new ApplicationException(string.Format("Expected order {0} not found", tRequest.ShipTransaction[0].Order.ExternalID));
if (returnedTShipTransaction.Shipment.PostbackUrl != tRequest.ShipTransaction[0].Shipment.PostbackUrl)
throw new ApplicationException("Expected that ShipmentExtendedField WILL match");
if (returnedTShipTransaction.Shipment.International.CIComments != tRequest.ShipTransaction[0].Shipment.International.CIComments)
throw new ApplicationException("Expected that ShipmentInternational WILL match");
// HazMat should be returned when "ReturnExtendedPackageFields" == true
// we need to cleanup our persistence before sharding
if (returnedTShipTransaction.Shipment.Package[0].HazMat == null)
throw new ApplicationException("Expected that Package.HazMat will be NOT NULL");
if (returnedTShipTransaction.Shipment.Package[0].HazMat.Length != tRequest.ShipTransaction[0].Shipment.Package[0].HazMat.Length)
throw new ApplicationException(string.Format("Expected that Package.HazMat will have {0} items", tRequest.ShipTransaction[0].Shipment.Package[0].HazMat.Length));
// FreightCommodities should be returned when "ReturnExtendedPackageFields" == true
if (returnedTShipTransaction.Shipment.Package[0].FreightCommodities == null)
throw new ApplicationException("Expected that Package.FreightCommodities will be NOT NULL");
if (returnedTShipTransaction.Shipment.Package[0].FreightCommodities.Length != tRequest.ShipTransaction[0].Shipment.Package[0].FreightCommodities.Length)
throw new ApplicationException(string.Format("Expected that Package.FreightCommodities will have {0} items", tRequest.ShipTransaction[0].Shipment.Package[0].HazMat.Length));
}
private void CheckAmazonPrimeSearchParameters(GetUserResponse userInfo, MerchantInfo webstore)
{
logger.Debug("--------------------------------");
logger.Debug("CheckAmazonPrimeSearchParameters");
logger.Debug("--------------------------------");
CheckServerTime();
var shipmentsBefore = GetPendingShipmentsAll();
// Add Amazon Prime order
var tRequest = GetNewOrderTRequest(webstore);
tRequest.ShipTransaction[0].Order.IsPrime = true;
AddOrder(tRequest, userInfo.UserId, webstore.WebstoreId);
var shipmentsAfter_Default = GetPendingShipmentsAll();
var shipmentsAfter_WithPrime = GetPendingShipmentsAll(BooleanPropertySearchType.CouldBeAnyValue);
var shipmentsAfter_PrimeOnly = GetPendingShipmentsAll(BooleanPropertySearchType.MustBeTrue);
logger.DebugFormat("shipmentsBefore {0}", shipmentsBefore.ShipTransactionHeaders.Count);
logger.DebugFormat("shipmentsAfter_Default {0}", shipmentsAfter_Default.ShipTransactionHeaders.Count);
logger.DebugFormat("shipmentsAfter_WithPrime {0}", shipmentsAfter_WithPrime.ShipTransactionHeaders.Count);
logger.DebugFormat("shipmentsAfter_PrimeOnly {0}", shipmentsAfter_PrimeOnly.ShipTransactionHeaders.Count);
if (shipmentsAfter_Default.ShipTransactionHeaders.Count != shipmentsBefore.ShipTransactionHeaders.Count)
throw new ApplicationException("AmazonPrime Orders should NOT be visible by default");
if ((shipmentsAfter_WithPrime.ShipTransactionHeaders.Count - 1) != shipmentsBefore.ShipTransactionHeaders.Count)
throw new ApplicationException("AmazonPrime Orders should be visible with 'CouldBeAnyValue' special parameter");
if ((shipmentsAfter_PrimeOnly.ShipTransactionHeaders.Count != 1))
throw new ApplicationException("Only AmazonPrime Orders should be visible with 'MustBeTrue' special parameter");
}
private static TRequest GetNewOrderTRequest(MerchantInfo webstore)
{
var tRequest = Serialization.DeserializeObject<TRequest>(GetStreamResource("ShipRush.SDK.CommandLineDemo.Shipments.003.xml"));
tRequest.ShipTransaction[0].Shipment.ShipmentType = ShipmentType.Pending;
tRequest.ShipTransaction[0].Order.OrderDate = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.000Z");
tRequest.ShipTransaction[0].Order.ExternalID = Guid.NewGuid().ToString();
tRequest.ShipTransaction[0].Shipment.WebstoreId = webstore.WebstoreId;
return tRequest;
}
private void GetOneShipmentClickySimulation(GetShipmentsResponse shipments)
{
foreach (TShipTransactionHeader transaction in shipments.ShipTransactionHeaders)
{
if (transaction.Shipment != null)
{
GetOneShipment(transaction.Shipment.ShipmentId);
return;
}
}
throw new ApplicationException("No shipments found. Unable to test 'GetOneShipment'");
}
private void GetOneShipment(string shipmentId)
{
logger.WarnFormat("Getting shipment {0}", shipmentId);
CheckServerTime();
var sessionTokenResponse = ShipRushSDK.ExecuteCommand<string, GetSessionTokenResponse>(APICommands.GET_SESSION_TOKEN, "");
var getShipmentCommand = new APICommand("GET", "shipmentservice.svc", string.Format("token/{0}/shipment/get/{1}", sessionTokenResponse.SessionToken, shipmentId));
var shipmentStream = ShipRushSDK.ExecuteCommandRaw(getShipmentCommand, "", null);
if ((shipmentStream == null) || (shipmentStream.Length == 0))
throw new ApplicationException("Shipment not found");
var shipment = Serialization.DeserializeObject<TRequest>(shipmentStream);
if (shipment.ShipTransaction[0].Shipment.ShipmentId != shipmentId)
throw new ApplicationException("Invalid shipment retrieved");
}
private void CheckWebstoreStatus(List<MerchantInfo> merchants, string webstoreId)
{
foreach (MerchantInfo merchant in merchants)
{
if (merchant.WebstoreId == webstoreId)
{
logger.DebugFormat("Webstore {0} status = {1}", webstoreId, merchant.Status);
logger.DebugFormat("Webstore {0} enabled = {1}", webstoreId, merchant.Enabled);
return;
}
}
logger.WarnFormat("Webstore {0} not found", webstoreId);
}
private void AddGetUpdateShipment(string xmlFilename, string webstoreId)
{
var shipmentId = AddShipment(xmlFilename, webstoreId);
GetShipment(shipmentId);
UpdateShipment(shipmentId);
}
private void AddGetUpdateShipmentAndOrder(string xmlFilename)
{
CheckServerTime();
// Check user configuration, get list of configured webstores
var createdUserInfo = GetUserSettings();
// Testing order/shipment updates
// Webstore should be "ebay" to avoid order XML conversion
var webstoreEBay = CreateWebstore("zencart");
TRequest request = Serialization.DeserializeObject<TRequest>(GetStreamResource("ShipRush.SDK.CommandLineDemo.Shipments." + xmlFilename));
request.ShipTransaction[0].Order.OrderDate = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss.000Z");
request.ShipTransaction[0].Shipment.WebstoreId = webstoreEBay.WebstoreId;
// ------------- Special Chars
request.ShipTransaction[0].Order.ShippingAddress.Address1 = "'Alex\"-another@ Test <> &";
// ------------- ADD ORDER
var orderId = AddOrder(request, createdUserInfo.UserId, webstoreEBay.WebstoreId);
var transOriginal = request.ShipTransaction[0];
// First get after insert
var transInserted = GetOrder(orderId);
var shipmentId = transInserted.Shipment.ShipmentId;
if (transInserted == null) throw new ApplicationException("Order not found after inserting.");
if (transInserted.Order == null) throw new ApplicationException("Order.Order is not assigned inserting.");
if (transInserted.Shipment == null) throw new ApplicationException("Order.Order is not assigned inserting.");
if (transInserted.Order.OrderId != orderId) throw new ApplicationException("Different order found.");
if (transInserted.Order.ShippingAddress.Address1 != transOriginal.Order.ShippingAddress.Address1) throw new ApplicationException(string.Format("ShippingAddress.Address1 does not match. {0}, {1}", transInserted.Order.ShippingAddress.Address1, transOriginal.Order.ShippingAddress.Address1));
if (transInserted.Order.OrderNumber != transOriginal.Order.OrderNumber) throw new ApplicationException("OrderNumber does not match.");
if (transInserted.Order.OrderDate != transOriginal.Order.OrderDate) throw new ApplicationException("OrderDate does not match.");
if (transInserted.Order.PaymentStatus != transOriginal.Order.PaymentStatus) throw new ApplicationException("PaymentStatus does not match.");
if (transInserted.Order.PaymentType != transOriginal.Order.PaymentType) throw new ApplicationException("PaymentType does not match.");
// We no longer persist Order.ShipmentType in the database. Shipment.ShipmentType is the correct place
if (transInserted.Shipment.ShipmentType != transOriginal.Shipment.ShipmentType) throw new ApplicationException("ShipmentType does not match.");
if (transInserted.Order.ShipmentOrderItem.Length != transOriginal.Order.ShipmentOrderItem.Length) throw new ApplicationException("ShipmentOrderItem.Length does not match.");
if (transInserted.Order.ShipMethod != transOriginal.Order.ShipMethod) throw new ApplicationException("ShipMethod does not match.");
if (transInserted.Shipment.UPSServiceType != transOriginal.Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does not match.");
if (transInserted.Shipment.Carrier != transOriginal.Shipment.Carrier) throw new ApplicationException(string.Format("Shipment.Carrier does not match. [Expected: {0}, Got: {1}]", transOriginal.Shipment.Carrier.ToHuman(), transInserted.Shipment.Carrier.ToHuman()));
if (transInserted.Shipment.ShipmentNumber != transOriginal.Shipment.ShipmentNumber) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transInserted.Shipment.ShipmentReference1 != transOriginal.Shipment.ShipmentReference1) throw new ApplicationException("Shipment.ShipmentReference1 does not match.");
if (transInserted.Order.PaymentType != transOriginal.Order.PaymentType) throw new ApplicationException("Order.PaymentType does not match.");
if (transInserted.Order.UnitsOfMeasureLinear != transOriginal.Order.UnitsOfMeasureLinear) throw new ApplicationException("Order.UnitsOfMeasureLinear does not match.");
if (transInserted.Order.UnitsOfMeasureWeight != transOriginal.Order.UnitsOfMeasureWeight) throw new ApplicationException("Order.UnitsOfMeasureWeight does not match.");
if (transInserted.Order.Currency != transOriginal.Order.Currency) throw new ApplicationException("Order.Currency does not match.");
// Shipment.CurrencyCode is "Extended" field. Please enter a "ReturnExtendedShipmentFields" in the request to get it
if (transInserted.Shipment.CurrencyCode != transOriginal.Shipment.CurrencyCode) throw new ApplicationException("Shipment.CurrencyCode does not match.");
CheckAddress(transOriginal.Order.ShippingAddress, transInserted.Order.ShippingAddress, "Order.ShippingAddress");
CheckAddress(transOriginal.Order.BillingAddress, transInserted.Order.BillingAddress, "Order.BillingAddress");
CheckAddressSegment(transOriginal.Shipment.ShipperAddress, transInserted.Shipment.ShipperAddress, "Order.ShipperAddress");
CheckAddressSegment(transOriginal.Shipment.DeliveryAddress, transInserted.Shipment.DeliveryAddress, "Order.DeliveryAddress");
CheckItems(transOriginal.Order.ShipmentOrderItem, transInserted.Order.ShipmentOrderItem, "Order.ShipmentOrderItem");
// ------------- UPDATE ORDER #1 - Shipment has tracking number now
logger.Debug("UPDATE ORDER #1 - Shipment has tracking number now");
var shipmentNumber = Guid.NewGuid().ToString();
request.ShipTransaction[0].Shipment.ShipmentNumber = shipmentNumber;
request.ShipTransaction[0].Shipment.Carrier = TCarrierType.FedEx;
request.ShipTransaction[0].Shipment.CarrierSpecified = true;
request.ShipTransaction[0].Shipment.UPSServiceType = TUPSService.FedEx1DayFreight;
var updatedOrderId = AddOrder(request, createdUserInfo.UserId, webstoreEBay.WebstoreId);
if (orderId != updatedOrderId) throw new ApplicationException("OrderId does not match.");
var transUpdated = GetOrder(orderId);
if (transUpdated.Order.OrderId != orderId) throw new ApplicationException("OrderId does not match.");
if (transUpdated.Shipment.ShipmentNumber != shipmentNumber) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transUpdated.Shipment.Carrier != request.ShipTransaction[0].Shipment.Carrier) throw new ApplicationException(string.Format("Shipment.Carrier does not match. [Expected: {0}, Got: {1}]", request.ShipTransaction[0].Shipment.Carrier.ToHuman(), transUpdated.Shipment.Carrier.ToHuman()));
if (transUpdated.Shipment.UPSServiceType != request.ShipTransaction[0].Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does not match.");
// ------------- UPDATE ORDER #2 - Shipment has tracking number now
logger.Debug("UPDATE ORDER #2 - Shipment has tracking number now");
var shipmentNumber2 = Guid.NewGuid().ToString();
request.ShipTransaction[0].Shipment.ShipmentNumber = shipmentNumber2;
request.ShipTransaction[0].Shipment.Carrier = TCarrierType.DHL;
request.ShipTransaction[0].Shipment.UPSServiceType = TUPSService.DHLGround;
var updatedOrderId2 = AddOrder(request, createdUserInfo.UserId, webstoreEBay.WebstoreId);
if (orderId != updatedOrderId2) throw new ApplicationException("OrderId does not match.");
var transUpdated2 = GetOrder(orderId);
if (transUpdated2.Order.OrderId != orderId) throw new ApplicationException("OrderId does not match.");
if (transUpdated2.Shipment.ShipmentNumber != shipmentNumber2) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transUpdated2.Shipment.Carrier != request.ShipTransaction[0].Shipment.Carrier) throw new ApplicationException(string.Format("Shipment.Carrier does not match. [Expected: {0}, Got: {1}]", request.ShipTransaction[0].Shipment.Carrier.ToHuman(), transUpdated2.Shipment.Carrier.ToHuman()));
if (transUpdated2.Shipment.UPSServiceType != request.ShipTransaction[0].Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does not match.");
// ------------- UPDATE SHIPMENT #1
logger.Debug("UPDATE SHIPMENT #1");
var shipmentNumber3 = Guid.NewGuid().ToString();
request.ShipTransaction[0].Shipment.ShipmentNumber = shipmentNumber3;
request.ShipTransaction[0].Shipment.Carrier = TCarrierType.USPS;
request.ShipTransaction[0].Shipment.UPSServiceType = TUPSService.USPSExpress;
request.ShipTransaction[0].Shipment.ShipmentId = shipmentId;
var updatedShipment1 = AddShipment(request, webstoreEBay.WebstoreId);
if (updatedShipment1 != shipmentId) throw new ApplicationException("ShipmentId does not match.");
var transUpdated3 = GetShipment(updatedShipment1);
if (transUpdated3.Order.OrderId != orderId) throw new ApplicationException("OrderId does not match.");
if (transUpdated3.Shipment.ShipmentId != shipmentId) throw new ApplicationException("ShipmentId does not match.");
if (transUpdated3.Shipment.ShipmentNumber != shipmentNumber3) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transUpdated3.Shipment.Carrier != request.ShipTransaction[0].Shipment.Carrier) throw new ApplicationException(string.Format("Shipment.Carrier does not match. [Expected: {0}, Got: {1}]", request.ShipTransaction[0].Shipment.Carrier.ToHuman(), transUpdated3.Shipment.Carrier.ToHuman()));
if (transUpdated3.Shipment.UPSServiceType != request.ShipTransaction[0].Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does not match.");
// ------------- UPDATE SHIPMENT #2
logger.Debug("UPDATE SHIPMENT #2");
var shipmentNumber4 = Guid.NewGuid().ToString();
request.ShipTransaction[0].Shipment.ShipmentNumber = shipmentNumber4;
request.ShipTransaction[0].Shipment.Carrier = TCarrierType.FedEx;
request.ShipTransaction[0].Shipment.UPSServiceType = TUPSService.FedEx2Day;
request.ShipTransaction[0].Shipment.ShipmentId = shipmentId;
var updatedShipment2 = AddShipment(request, webstoreEBay.WebstoreId);
if (updatedShipment2 != shipmentId) throw new ApplicationException("ShipmentId does not match.");
var transUpdated4 = GetShipment(updatedShipment1);
if (transUpdated4.Order.OrderId != orderId) throw new ApplicationException("OrderId does not match.");
if (transUpdated4.Shipment.ShipmentId != shipmentId) throw new ApplicationException("ShipmentId does not match.");
if (transUpdated4.Shipment.ShipmentNumber != shipmentNumber4) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transUpdated4.Shipment.Carrier != request.ShipTransaction[0].Shipment.Carrier) throw new ApplicationException(string.Format("Shipment.Carrier does not match. [Expected: {0}, Got: {1}]", request.ShipTransaction[0].Shipment.Carrier.ToHuman(), transUpdated4.Shipment.Carrier.ToHuman()));
if (transUpdated4.Shipment.UPSServiceType != request.ShipTransaction[0].Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does not match.");
// ------------- UPDATE ORDER - should not update
logger.Debug("UPDATE ORDER");
var shipmentNumber5 = Guid.NewGuid().ToString();
request.ShipTransaction[0].Shipment.ShipmentNumber = shipmentNumber5;
request.ShipTransaction[0].Shipment.Carrier = TCarrierType.UPS;
request.ShipTransaction[0].Shipment.UPSServiceType = TUPSService.UPS2ndDayAir;
var updatedOrderId5 = AddOrder(request, createdUserInfo.UserId, webstoreEBay.WebstoreId);
if (orderId != updatedOrderId5) throw new ApplicationException("OrderId does not match.");
var transUpdated5 = GetOrder(orderId);
if (transUpdated5.Order.OrderId != orderId) throw new ApplicationException("OrderId does not match.");
if (transUpdated5.Shipment.ShipmentNumber != shipmentNumber4) throw new ApplicationException("Shipment.ShipmentNumber does not match.");
if (transUpdated5.Shipment.ShipmentNumber == shipmentNumber5) throw new ApplicationException("Shipment.ShipmentNumber does match, where it should not.");
if (transUpdated5.Shipment.Carrier == request.ShipTransaction[0].Shipment.Carrier) throw new ApplicationException("Shipment.Carrier does match, where it should not.");
if (transUpdated5.Shipment.UPSServiceType == request.ShipTransaction[0].Shipment.UPSServiceType) throw new ApplicationException("Shipment.UPSServiceType does match, where it should not.");
// ----------------- UPDATE SHIPMENT via UpdateShipmentRequest
var updateRequest = new UpdateShipmentRequest()
{
ShipmentId = shipmentId,
TrackingNumber = Guid.NewGuid().ToString()
};
ShipRushSDK.ExecuteCommand<UpdateShipmentRequest, UpdateShipmentResponse>(APICommands.UPDATE_SHIPMENT, updateRequest);
var transUpdated6 = GetOrder(orderId);
if (transUpdated6.Shipment.ShipmentNumber != updateRequest.TrackingNumber) throw new ApplicationException("UpdateRequest.TrackingNumber does not match.");
}
private void CheckItems(TShipmentOrderItem[] originalOrderItems, TShipmentOrderItem[] responseOrderItems, string comment)
{
if (originalOrderItems.Length != responseOrderItems.Length)
throw new ApplicationException(comment + " segment must have the same length.");
for (var i = 0; i < originalOrderItems.Length; i++)
CheckItem(originalOrderItems[i], responseOrderItems[i], comment + " Item " + i.ToString());
}
private void CheckItem(TShipmentOrderItem originalOrderItems, TShipmentOrderItem responseOrderItems, string comment)
{
if (originalOrderItems.ItemLength != responseOrderItems.ItemLength) throw new ApplicationException(comment + ": ItemLength doesn't match");
if (originalOrderItems.ItemWidth != responseOrderItems.ItemWidth) throw new ApplicationException(comment + ": ItemWidth doesn't match");
if (originalOrderItems.ItemHeight != responseOrderItems.ItemHeight) throw new ApplicationException(comment + ": ItemHeight doesn't match");
}
private void CheckAddressSegment(TAddressSegment updated, TAddressSegment original, string comment)
{
if (original == null)
{
if (updated != null) throw new ApplicationException(comment + " segment must be null.");
}
else
CheckAddress(updated.Address, original.Address, comment);
}
private void CheckAddress(TAddress original, TAddress updated, string comment)
{
if (original == null)
{
if (updated != null) throw new ApplicationException(comment + " must be null.");
}
else
{
if (updated.Account != original.Account) throw new ApplicationException(comment + ".Account does not match.");
if (updated.Address1 != original.Address1) throw new ApplicationException(comment + ".Address1 does not match.");
if (updated.Address2 != original.Address2) throw new ApplicationException(comment + ".Address2 does not match.");
if (updated.Address3 != original.Address3) throw new ApplicationException(comment + ".Address3 does not match.");
if (updated.City != original.City) throw new ApplicationException(comment + ".City does not match.");
if (updated.Company != original.Company) throw new ApplicationException(comment + ".Company does not match.");
if (updated.LastName != original.LastName) throw new ApplicationException(comment + ".LastName does not match.");
if (updated.PostalCode != original.PostalCode) throw new ApplicationException(comment + ".PostalCode does not match.");
if (updated.NickName != original.NickName) throw new ApplicationException(comment + ".NickName does not match.");
if (updated.State != original.State) throw new ApplicationException(comment + ".StateAsString does not match.");
if (updated.StateAsString != original.StateAsString) throw new ApplicationException(comment + " does not match.");
if (updated.Country != original.Country) throw new ApplicationException(comment + ".Country does not match.");
if (updated.CountryAsString != original.CountryAsString) throw new ApplicationException(comment + ".CountryAsString does not match.");
if (updated.EMail != original.EMail) throw new ApplicationException(comment + ".EMail does not match.");
}
}
private void AddGetUpdateShipment(string xmlFilename)
{
AddGetUpdateShipment(xmlFilename, "");
}
// Show current ShipRushSDK settings - access url and tokens
private void LogShipRushSDKParameters()
{
logger.DebugFormat("URL = '{0}', DEVELOPER_TOKEN = '{1}', USER_TOKEN = '{2}', SHIPPING_TOKEN = '{3}'", ShipRushSDK.ServiceUrl, ShipRushSDK.DeveloperToken, ShipRushSDK.UserToken, ShipRushSDK.ShippingToken);
}
// API way of creating a new user
private string CreateNewUser()
{
try
{
CreateUserRequest request = new CreateUserRequest();
request.Company = "ACME Electronics";
request.Name = "John Smith";
request.ExternalUserId = GenerateRandomPartnerId();
request.ShowZFirmBranding = false;
logger.DebugFormat("Creating new user '{0}'", request.ExternalUserId);
var response = ShipRushSDK.ExecuteCommand<CreateUserRequest, CreateUserResponse>(APICommands.CREATE_USER, request);
logger.DebugFormat("User created. USER_TOKEN '{0}', userID '{1}'", response.UserToken, response.UserId);
return response.UserToken;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
// Here we are testing what exception from service is not compressed by IIS.
private void CreateUserFailed()
{
try
{
CreateUserRequest request = new CreateUserRequest();
ShipRushSDK.EnableHttpCompression = true;
request.Email = "john@acme.demo";
request.Company = "ACME Electronics";
request.Name = "John Smith";
request.ExternalUserId = "";
request.ShowZFirmBranding = false;
logger.DebugFormat("Creating new user '{0}'", request.ExternalUserId);
var response = ShipRushSDK.ExecuteCommand<CreateUserRequest, CreateUserResponse>(APICommands.CREATE_USER, request);
response = ShipRushSDK.ExecuteCommand<CreateUserRequest, CreateUserResponse>(APICommands.CREATE_USER, request);
throw new Exception("Failed. We had to receive exception.");
}
catch (ShipRushException exc)
{
if (exc.Message == "User 'john@acme.demo' already exists.")
logger.Error(exc.Message);
else
throw;
}
}
private void DeleteWebstore(string webstoreId)
{
try
{
DeleteWebstoreRequest request = new DeleteWebstoreRequest();
request.WebstoreId = webstoreId;
logger.DebugFormat("Deleting webstore '{0}'", request.WebstoreId);
ShipRushSDK.ExecuteCommand<DeleteWebstoreRequest, DeleteWebstoreResponse>(APICommands.DELETE_WEBSTORE, request);
logger.DebugFormat("Webstore {0} delete.", webstoreId);
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private List<AvailableMerchant> GetAvailableWebstoreTypes()
{
try
{
var request = new GetWebstoreTypesRequest();
var response = ShipRushSDK.ExecuteCommand<GetWebstoreTypesRequest, GetWebstoreTypesResponse>(APICommands.GET_AVAILABLE_WEBSTORE_TYPES, request);
foreach (var availableMerchant in response.Types)
{
logger.DebugFormat(availableMerchant.Name);
}
return response.Types;
}
catch (ShipRushException e)
{
logger.DebugFormat(e.Message);
throw;
}
}
// Create empty, not configured webstore
private MerchantInfo CreateWebstore(string merchantType)
{
try
{
CreateWebstoreRequest request = new CreateWebstoreRequest();
request.MerchantType = merchantType;
logger.DebugFormat("Creating new webstore '{0}'", request.MerchantType);
var response = ShipRushSDK.ExecuteCommand<CreateWebstoreRequest, CreateWebstoreResponse>(APICommands.CREATE_WEBSTORE, request);
logger.DebugFormat("Webstore created. WebstoreID '{0}', SetupUrl '{1}'", response.Merchant.WebstoreId, response.Merchant.SetupUrl);
return response.Merchant;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
// Add test (fake) webstore and shipments to the user
private void AddTestDataToUser()
{
try
{
logger.DebugFormat("Adding test data");
AddTestDataRequest request = new AddTestDataRequest();
var response = ShipRushSDK.ExecuteCommand<AddTestDataRequest, AddTestDataResponse>(APICommands.ADD_TEST_DATA, request);
logger.DebugFormat("{0}", response.ResultMessage);
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private GetUserResponse GetUserSettings()
{
try
{
logger.DebugFormat("Get user settings and configuration");
GetUserRequest request = new GetUserRequest();
var response = ShipRushSDK.ExecuteCommand<GetUserRequest, GetUserResponse>(APICommands.GET_USER, request);
logger.DebugFormat("User: {0}, {1}, {2}, {3}", response.Email, response.Name, response.UserId, response.Company);
if (response.Merchants != null)
{
logger.DebugFormat("Configured webstores = {0}", response.Merchants.Count);
foreach (MerchantInfo merchantInfo in response.Merchants)
{
logger.DebugFormat("Merchant: {0}, {1}, {2}, {3}", merchantInfo.WebstoreId, merchantInfo.Enabled, merchantInfo.WebstoreName, merchantInfo.MerchantType);
}
}
else
logger.DebugFormat("No configured webstores found");
return response;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private GetShipmentsResponse GetPendingShipmentsAll(BooleanPropertySearchType amazonPrimeSearchType = BooleanPropertySearchType.Unknown)
{
GetShipmentsRequest request = new GetShipmentsRequest();
CheckServerTime();
request.ShipmentType = ShipmentType.Pending;
// Case 63940: Build Fail because Sandbox3 and Sandbox4 clocks are 13 seconds apart
// Allow sandboxe clocks to be up to 1 minute apart
request.ModifiedTo = GetMyShipRushTime().AddMinutes(1);
request.AmazonPrimeSearchType = amazonPrimeSearchType;
return GetPendingShipmentsAll(request);
}
private GetShipmentsResponse GetPendingShipmentsAll(GetShipmentsRequest request)
{
try
{
logger.DebugFormat("Get all pending shipments. ModifiedTo={0}, AmazonPrimeSearchType={1}", request.ModifiedTo, request.AmazonPrimeSearchType);
CheckServerTime();
var response = ShipRushSDK.ExecuteCommand<GetShipmentsRequest, GetShipmentsResponse>(APICommands.GET_SHIPMENTS, request);
logger.DebugFormat("GetPendingShipmentsAll completed.");
if ((response.ShipTransactions != null) && ((response.ShipTransactions).Count > 0))
{
logger.DebugFormat("{0} shipments found", response.ShipTransactions.Count);
LogShipments(response.ShipTransactions);
}
else
if ((response.ShipTransactionHeaders != null) && (response.ShipTransactionHeaders.Count > 0))
{
logger.DebugFormat("{0} shipment headers found", response.ShipTransactionHeaders.Count);
}
else
logger.DebugFormat("No pending shipments found");
return response;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private GetShipmentsResponse GetPendingShipmentsByMerchant(MerchantInfo merchant)
{
try
{
logger.DebugFormat("Get pending shipments for merchant {0}, {1}", merchant.WebstoreId, merchant.WebstoreName);
CheckServerTime();
GetShipmentsRequest request = new GetShipmentsRequest();
request.WebstoreId = merchant.WebstoreId;
request.ShipmentType = ShipmentType.Pending;
// You should query by "Modified" date or by "ShipDate", but not by both
// Alternative #1: use last modified date of the transaction (could change)
request.ModifiedFrom = GetMyShipRushTime().AddDays(-1).AsUtcKind();
request.ModifiedTo = GetMyShipRushTime().AsUtcKind();
// Alternative #2: use original transaction date (ShipDate or OrderDate), does not change
// request.ShipDateFrom = GetMyShipRushTime().AddDays(-1).AsUtcKind();
// request.ShipDateTo = GetMyShipRushTime().AsUtcKind();
var response = ShipRushSDK.ExecuteCommand<GetShipmentsRequest, GetShipmentsResponse>(APICommands.GET_SHIPMENTS, request);
logger.DebugFormat("GetPendingShipmentsByMerchant completed");
if ((response.ShipTransactions != null) && (response.ShipTransactions.Count > 0))
{
LogShipments(response.ShipTransactions);
}
else
logger.DebugFormat("No shipments found for {0}, {1}", merchant.WebstoreId, merchant.WebstoreName);
return response;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private DateTime GetMyShipRushTime()
{
try
{
logger.DebugFormat("Get MyShipRush Time");
var response = ShipRushSDK.ExecuteCommand<string, GetMyShipRushTimeResponse>(APICommands.GET_MYSHIPRUSH_TIME, "");
logger.DebugFormat("GetMyShipRushTime completed. Time is {0}", response.MyShipRushTime);
return response.MyShipRushTime;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
public static string GetStringResource(string name)
{
Assembly _assembly = Assembly.GetExecutingAssembly();
StreamReader textStreamReader = new StreamReader(_assembly.GetManifestResourceStream(name));
return textStreamReader.ReadToEnd();
}
private static Stream GetStreamResource(string name)
{
Assembly _assembly = Assembly.GetExecutingAssembly();
return _assembly.GetManifestResourceStream(name);
}
private string AddShipment(string xmlFilename, string webstoreId)
{
return AddShipment(Serialization.DeserializeObject<TRequest>(GetStreamResource("ShipRush.SDK.CommandLineDemo.Shipments." + xmlFilename)), webstoreId);
}
private string AddShipment(TRequest request, string webstoreId)
{
try
{
logger.DebugFormat("AddShipment");
// Empty merchantSettingsId = just add shipment
// Non-Empty merchantSettingsId = add shipment to specific webstore
request.ShipTransaction[0].Shipment.WebstoreId = webstoreId;
var response = ShipRushSDK.ExecuteCommand<TRequest, AddShipmentResponse>(APICommands.ADD_SHIPMENT_HISTORY, request);
logger.DebugFormat("AddShipment completed.");
// Do not read immediately after write. The MySR platform
// does not allow reading "up to the second" data.
// See MySR API docs related to GetShipments()
Thread.Sleep(1000);
return response.ShipmentId;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private string AddOrder(TRequest request, string userId, string webstoreId)
{
try
{
logger.DebugFormat("AddOrder");
var response = ShipRushSDK.ExecuteCommand<TRequest, AddOrderResponse>(APICommands.ADD_ORDER(userId, webstoreId), request);
logger.DebugFormat("AddOrder completed.");
// Do not read immediately after write. The MySR platform
// does not allow reading "up to the second" data.
// See MySR API docs related to GetShipments()
Thread.Sleep(1000);
return response.OrderId;
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private TShipTransaction GetShipment(string shipmentId)
{
try
{
logger.DebugFormat("GetShipment");
GetShipmentsRequest request = new GetShipmentsRequest()
{
ShipmentId = shipmentId,
DetailLevel = DetailLevel.Full
};
var response = ShipRushSDK.ExecuteCommand<GetShipmentsRequest, GetShipmentsResponse>(APICommands.GET_SHIPMENTS, request);
logger.DebugFormat("GetShipment completed.");
if (response.ShipTransactions.Count != 1) throw new ApplicationException("One shipment expected.");
return response.ShipTransactions[0];
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private TShipTransaction GetOrder(string orderId)
{
try
{
logger.DebugFormat("GetOrder");
GetShipmentsRequest request = new GetShipmentsRequest()
{
OrderId = orderId,
DetailLevel = DetailLevel.Full,
// Required for getting Shipment.CurrencyCode
ReturnExtendedShipmentFields = BooleanPropertyWithDefault.True,
};
var response = ShipRushSDK.ExecuteCommand<GetShipmentsRequest, GetShipmentsResponse>(APICommands.GET_SHIPMENTS, request);
logger.DebugFormat("GetOrder completed.");
if (response.ShipTransactions.Count != 1) throw new ApplicationException("One shipment expected.");
return response.ShipTransactions[0];
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private void UpdateShipment(string shipmentId)
{
try
{
logger.DebugFormat("UpdateShipment");
var random = new Random();
var shippingCharges = random.Next(100);
var trackingNumber = random.Next(100000).ToString();
UpdateShipmentRequest updateRequest = new UpdateShipmentRequest()
{
ShipmentId = shipmentId,
ShippingCharges = shippingCharges,
SetCarrier = true,
Carrier = TCarrierType.USPS,
SetService = true,
Service = TUPSService.USPSExpress,
TrackingNumber = trackingNumber
};
ShipRushSDK.ExecuteCommand<UpdateShipmentRequest, UpdateShipmentResponse>(APICommands.UPDATE_SHIPMENT, updateRequest);
// Do not read immediately after write. The MySR platform
// does not allow reading "up to the second" data.
// See MySR API docs related to GetShipments()
Thread.Sleep(3000);
// check that shipment was updated
GetShipmentsRequest request = new GetShipmentsRequest()
{
ShipmentId = shipmentId,
DetailLevel = DetailLevel.Full
};
var response = ShipRushSDK.ExecuteCommand<GetShipmentsRequest, GetShipmentsResponse>(APICommands.GET_SHIPMENTS, request);
logger.DebugFormat("UpdateShipment completed.");
if (response.ShipTransactions.Count != 1) throw new ApplicationException("One shipment expected.");
var shipment = response.ShipTransactions[0].Shipment;
if (shipment.ShipmentId != shipmentId)
throw new ApplicationException(string.Format("This is a different shipment. {0} found {1} expected", shipment.ShipmentId, shipmentId));
if (shipment.Carrier != TCarrierType.USPS) throw new ApplicationException("USPS expected.");
if (shipment.UPSServiceType != TUPSService.USPSExpress) throw new ApplicationException("USPSExpress.");
if (shipment.ShippingCharges != shippingCharges.ToString())
throw new ApplicationException(string.Format("ShippingCharges mismatch. {0} actual, {1} expected", shipment.ShippingCharges, shippingCharges.ToString()));
if (shipment.ShipmentNumber != trackingNumber) throw new ApplicationException("TrackingNumber mismatch");
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private void LogShipments(IList transactions)
{
foreach (object transactionUntyped in transactions)
{
if (transactionUntyped is TShipTransaction)
{
TShipTransaction transaction = (TShipTransaction) transactionUntyped;
if (transaction.Shipment != null)
{
logger.DebugFormat("ShipmentId = {0}, ShipmentType = {1}", transaction.Shipment.ShipmentId,
transaction.Shipment.ShipmentType);
if ((transaction.Shipment.DeliveryAddress != null) &&
(transaction.Shipment.DeliveryAddress.Address != null))
{
logger.DebugFormat("ShipTo = {0}, {1}, {2}, {3}, {4}, {5}",
transaction.Shipment.DeliveryAddress.Address.Address1,
transaction.Shipment.DeliveryAddress.Address.Address2,
transaction.Shipment.DeliveryAddress.Address.City,
transaction.Shipment.DeliveryAddress.Address.State,
transaction.Shipment.DeliveryAddress.Address.PostalCode,
transaction.Shipment.DeliveryAddress.Address.EMail);
}
}
}
}
}
private void MarkOneShipmentAsShipped(GetShipmentsResponse shipments)
{
foreach (TShipTransactionHeader transaction in shipments.ShipTransactionHeaders)
{
if (transaction.Shipment != null)
{
MarkShipmentAsShipped(transaction.Shipment.ShipmentId);
return;
}
}
throw new ApplicationException("No shipments found. Unable to test 'MarkAsShipped'");
}
private void MarkShipmentsAsShipped(GetShipmentsResponse shipments)
{
foreach (TShipTransaction transaction in shipments.ShipTransactions)
{
if (transaction.Shipment != null)
{
MarkShipmentAsShipped(transaction.Shipment.ShipmentId);
}
}
}
private void MarkShipmentAsShipped(string shipmentId)
{
try
{
logger.DebugFormat("Marking ShipmentId = {0} as shipped", shipmentId);
UpdateShipmentRequest request = new UpdateShipmentRequest();
Random rnd = new Random();
request.ShipmentId = shipmentId;
request.MarkAsShipped = true;
// Create random number of dollars + 77 cents
request.ShippingCharges = rnd.Next(10) + 0.77;
request.TrackingNumber = "TEST" + rnd.Next(1000000);
var response = ShipRushSDK.ExecuteCommand<UpdateShipmentRequest, UpdateShipmentResponse>(APICommands.UPDATE_SHIPMENT, request);
logger.DebugFormat("UpdateShipmentRequest completed");
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private static string GenerateRandomPartnerId()
{
Random rnd = new Random();
return string.Format("Partner{0}.{1}", rnd.Next(1000000), rnd.Next(1000000));
}
private void SetupWebstore(string setupUrl)
{
// Note Developers! Uncomment the below to see the action when running
// interactively!
// (commented out to manage an internal issue on ZF Case 35674)
System.Diagnostics.Process.Start(setupUrl);
}
private void Ship_Rate_RateShopping_ValidateAddress_Void(TCarrierType carrier, TUPSService serviceType, TPackageType packageType = TPackageType.Package, bool doVoid = true)
{
try
{
logger.DebugFormat("Ship_Rate_RateShopping_ValidateAddress start for {0}, {1}", carrier, serviceType);
Shipping_Rate(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
Shipping_RateShopping(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
Shipping_ValidateAddress(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
var shippedResponse = Shipping_Ship(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
// We need couple non-voided shipments for EndOfDay
if (doVoid)
{
Shipping_Void(new TRequest()
{
ShipTransaction = new TShipTransaction[1] { shippedResponse.ShipTransaction }
});
}
else
{
logger.DebugFormat("Unvoided shipment {0}", shippedResponse.ShipTransaction.Shipment.ShipmentNumber);
}
// For ShipRush USPS ship second time and make sure that balance decreases
if (carrier == TCarrierType.ShipRushUSPS)
{
var shippedResponse2 = Shipping_Ship(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
if (doVoid)
{
Shipping_Void(new TRequest()
{
ShipTransaction = new TShipTransaction[1] { shippedResponse2.ShipTransaction }
});
}
else
{
logger.DebugFormat("Unvoided shipment {0}", shippedResponse.ShipTransaction.Shipment.ShipmentNumber);
}
if (shippedResponse.PostageBalance > shippedResponse2.PostageBalance)
logger.DebugFormat("Postage balance changed from {0} to {1}", shippedResponse.PostageBalance, shippedResponse2.PostageBalance);
else
throw new ApplicationException(string.Format("Postage balance did not change after shipping. {0} to {1}", shippedResponse.PostageBalance, shippedResponse2.PostageBalance));
}
logger.DebugFormat("Ship_Rate_RateShopping_ValidateAddress completed");
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Ship_Rate_RateShopping {0}, {1}: {2}", carrier, serviceType, exc.Message));
throw;
}
}
private void Ship_Rate_RateShopping_ValidateAddress_ExpectFailure(TCarrierType carrier, TUPSService serviceType, TPackageType packageType = TPackageType.Package)
{
try
{
try
{
logger.DebugFormat("Ship_Rate_RateShopping_ValidateAddress_ExpectFailure start for {0}, {1}", carrier, serviceType);
Shipping_Ship(GetTRequest_ForShippingAPI_Testing(carrier, serviceType, packageType));
logger.DebugFormat("Ship_Rate_RateShopping_ValidateAddress_ExpectFailure completed");
}
catch (Exception exc)
{
logger.Debug(string.Format("Expected fail for Shipping_Ship {0}, {1}: {2}", carrier, serviceType, exc.Message));
return;
}
throw new ApplicationException("This carrier/service combination must fail");
}
catch (Exception exc)
{
logger.Debug(string.Format("Expected fail for Shipping_Ship {0}, {1}: {2}", carrier, serviceType, exc.Message));
throw;
}
}
private static TRequest GetTRequest_ForShippingAPI_Testing(TCarrierType carrier, TUPSService serviceType, TPackageType packageType)
{
var tRequest = Serialization.DeserializeObject<TRequest>(GetStreamResource("ShipRush.SDK.CommandLineDemo.Shipments.ShippingAPI_001.xml"));
tRequest.ShipTransaction[0].Shipment.Carrier = carrier;
tRequest.ShipTransaction[0].Shipment.CarrierSpecified = true;
tRequest.ShipTransaction[0].Shipment.UPSServiceType = serviceType;
tRequest.ShipTransaction[0].Shipment.UPSServiceTypeSpecified = true;
// CommandLineDemo shipments MUST be processed with "today" on the label,
// otherwise CloseShippingDay() operation will fail with "no documents" error
tRequest.ShipTransaction[0].Shipment.ShipDateOnLabel = DateTime.Now.ToString("yyyy-MM-dd");
// Also test insurance charges
tRequest.ShipTransaction[0].Shipment.Package[0].InsuranceAmount = 250;
tRequest.ShipTransaction[0].Shipment.Package[0].PackagingType = packageType;
tRequest.ShipTransaction[0].Shipment.Package[0].PackagingTypeSpecified = true;
// http://support.pitneybowes.com/SearchArticles/VFP06_KnowledgeWithSidebarTroubleshoot?id=kA280000000TTPZCA4&popup=false&lang=en_US
if (carrier == TCarrierType.ShipRushUSPS)
{
tRequest.ShipTransaction[0].Shipment.Package[0].DCISTypeSpecified = true;
tRequest.ShipTransaction[0].Shipment.Package[0].DCISType = TDCIS.None;
}
// 4oz max for FirstClass
if (serviceType == TUPSService.USPSFirstClass)
{
tRequest.ShipTransaction[0].Shipment.Package[0].PackageActualWeight = 0.1;
}
return tRequest;
}
private ShipRush.SDK.Proxies.Shipping.ShipResponse Shipping_Ship(TRequest tRequest)
{
try
{
var request = new ShipRush.SDK.Proxies.Shipping.ShipRequest
{
ShipTransaction = tRequest.ShipTransaction[0]
};
logger.Debug(string.Format("Ship {0}, {1}", tRequest.ShipTransaction[0].Shipment.Carrier, tRequest.ShipTransaction[0].Shipment.UPSServiceType));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.Shipping.ShipRequest, ShipRush.SDK.Proxies.Shipping.ShipResponse>(APICommands.SHIPMENT_SHIP, request);
if (response.IsSuccess)
{
if (string.IsNullOrEmpty(response.ShipTransaction.Shipment.ShipmentNumber))
throw new ApplicationException("Tracking number not found");
// USPS "ship" transaction will return NO rate in reponse
if (response.ShipTransaction.Shipment.ShippingCharges.ToDouble() == 0 && response.ShipTransaction.Shipment.Carrier != TCarrierType.USPS)
throw new ApplicationException("Shipping charges not found");
if (response.ShipTransaction.Shipment.Documents.Count() == 0)
throw new ApplicationException("Shipping label not found");
if (string.IsNullOrEmpty(response.ShipTransaction.Shipment.ShippingAccount.AccountNumber))
throw new ApplicationException("Used shipping account not found");
if (response.ShipTransaction.Shipment.ShippingAccount.CarrierType != request.ShipTransaction.Shipment.Carrier)
throw new ApplicationException("Used shipping account is different from requested");
logger.Debug(string.Format("Ship Success. Tracking number {0}, ${1}, {2}", response.ShipTransaction.Shipment.ShipmentNumber, response.ShipTransaction.Shipment.ShippingCharges, response.ShipTransaction.Shipment.ShipmentId));
logger.Debug(string.Format("Used shipping account {0}, {1}", response.ShipTransaction.Shipment.ShippingAccount.AccountNumber, response.ShipTransaction.Shipment.ShippingAccount.ShippingAccountId));
foreach (var document in response.ShipTransaction.Shipment.Documents)
{
logger.Debug(string.Format("Document '{0}', {1}, {2} bytes", document.DocumentType, document.LabelFormat, document.ContentMimeEncoded.Length));
var filename = document.PaperDocumentId + "." + document.LabelFormat;
try
{
using (var fileStream = File.Create(filename))
{
((MemoryStream)Serialization.Base64StringToStream(document.ContentMimeEncoded)).WriteTo(fileStream);
logger.Debug(string.Format("Saved as '{0}'", filename));
}
}
catch (Exception ex)
{
// Ignore file system errors if run from network drive or under "program files"
logger.Error(string.Format("Unable to save label as '{0}'. {1}", filename, ex.Message));
}
}
return response;
}
else
{
logger.Error("Ship Error");
throw new ApplicationException("Error: " + response.GetErrorsAsText());
}
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_Ship: {0}", exc.Message));
throw;
}
}
private void Shipping_Rate(TRequest tRequest)
{
try
{
var request = new ShipRush.SDK.Proxies.Shipping.RateRequest
{
ShipTransaction = tRequest.ShipTransaction[0]
};
logger.Debug(string.Format("Rate {0}, {1}", tRequest.ShipTransaction[0].Shipment.Carrier, tRequest.ShipTransaction[0].Shipment.UPSServiceType));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.Shipping.RateRequest, ShipRush.SDK.Proxies.Shipping.RateResponse>(APICommands.SHIPMENT_RATE, request);
if (response.IsSuccess)
{
if (response.ShipTransaction.Shipment.ShippingCharges.ToDouble() <= 0)
throw new ApplicationException("Shipping charges not found");
}
else
{
logger.Error("Rate Error");
throw new ApplicationException("Error: " + response.GetErrorsAsText());
}
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_Rate: {0}", exc.Message));
throw;
}
}
private void Shipping_ValidateAddress(TRequest tRequest)
{
try
{
var request = new ShipRush.SDK.Proxies.Shipping.ValidateAddressRequest
{
ShipTransaction = tRequest.ShipTransaction[0]
};
logger.Debug(string.Format("ValidateAddress {0}, {1}", tRequest.ShipTransaction[0].Shipment.Carrier, tRequest.ShipTransaction[0].Shipment.UPSServiceType));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.Shipping.ValidateAddressRequest, ShipRush.SDK.Proxies.Shipping.ValidateAddressResponse>(APICommands.VALIDATE_ADDRESS, request);
if (response.IsSuccess)
{
if (response.ShipTransaction.Shipment.DeliveryAddress.Address.Address1 != response.ShipTransaction.Shipment.DeliveryAddress.Address.Address1.ToUpper())
throw new ApplicationException("response.ShipTransaction.Shipment.DeliveryAddress.Address.Address1: Uppercase Address1 expected");
}
else
{
logger.Error("ValidateAddress Error");
throw new ApplicationException("Error: " + response.GetErrorsAsText());
}
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_ValidateAddress: {0}", exc.Message));
throw;
}
}
private void Shipping_RateShopping(TRequest tRequest)
{
try
{
var request = new ShipRush.SDK.Proxies.Shipping.RateShoppingRequest
{
ShipTransaction = tRequest.ShipTransaction[0]
};
logger.Debug(string.Format("RateShopping {0}, {1}", tRequest.ShipTransaction[0].Shipment.Carrier, tRequest.ShipTransaction[0].Shipment.UPSServiceType));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.Shipping.RateShoppingRequest, ShipRush.SDK.Proxies.Shipping.RateShoppingResponse>(APICommands.SHIPMENT_RATESHOPPING, request);
if (response.IsSuccess)
{
// Rate shopping for Letter gives only 2 services in response
if (response.AvailableServices.Count < 2)
throw new ApplicationException("At least 2 services expected after rate shopping");
}
else
{
logger.Error("RateShopping Error");
throw new ApplicationException("Error: " + response.GetErrorsAsText());
}
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_RateShopping: {0}", exc.Message));
throw;
}
}
private void Shipping_Void(TRequest tRequest)
{
// Case 65916: Submit to PB: Voids are failing on PB Sandbox
// Always give carrier 1 sec after "ship" before voiding it
Thread.Sleep(3000);
try
{
Shipping_Void_Internal(tRequest);
}
catch (Exception ex)
{
// Case 65916: Submit to PB: Voids are failing on PB Sandbox
// It appears that calling Void right after Ship on PB sandbox generates "shipment not found" error
if (ex.Message.Contains("could not be found") || ex.Message.Contains("not found"))
{
Thread.Sleep(30 * 1000);
Shipping_Void_Internal(tRequest);
}
else
{
throw;
}
}
}
private void Shipping_Void_Internal(TRequest tRequest)
{
try
{
var request = new ShipRush.SDK.Proxies.Shipping.VoidRequest
{
ShipTransaction = tRequest.ShipTransaction[0]
};
request.ShipTransaction.Shipment.Documents = null;
logger.Debug(string.Format("Void {0}, {1}", tRequest.ShipTransaction[0].Shipment.Carrier, tRequest.ShipTransaction[0].Shipment.UPSServiceType));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.Shipping.VoidRequest, ShipRush.SDK.Proxies.Shipping.VoidResponse>(APICommands.SHIPMENT_VOID, request);
if (!string.IsNullOrEmpty(response.GetMessagesAsText()))
logger.Debug("Void messages: " + response.GetMessagesAsText());
if (response.IsSuccess)
{
if (request.ShipTransaction.Shipment.Carrier == TCarrierType.USPS ||
request.ShipTransaction.Shipment.Carrier == TCarrierType.ShipRushUSPS)
logger.Debug("Void success");
else
// We no longer do test shipments for ShipRushUSPS
logger.Debug("We expect Void to fail, because FedEx/UPS test shipments must be autovoided");
}
else
{
if (request.ShipTransaction.Shipment.Carrier == TCarrierType.USPS ||
request.ShipTransaction.Shipment.Carrier == TCarrierType.ShipRushUSPS)
{
throw new ApplicationException("Void Failed");
}
else
{
logger.Debug("Void expectedly failed");
if (response.Messages.Count == 0)
throw new ApplicationException("At least one message expected");
if (!response.Messages[0].Text.ToLower().Contains("already voided"))
throw new ApplicationException("'Already voided' error expected");
}
}
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_Void: {0}", exc.Message));
throw;
}
}
private void BuyPostage()
{
try
{
logger.Debug(string.Format("GetShippingAccounts"));
var getShippingAccountsRequest = new ShipRush.SDK.Proxies.GetShippingAccountsRequest();
var getShippingAccountsResponse = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.GetShippingAccountsRequest, ShipRush.SDK.Proxies.GetShippingAccountsResponse>(APICommands.GET_SHIPPINGACCOUNTS, getShippingAccountsRequest);
var postateAddedToAccountsCount = 0;
foreach (var shippingAccount in getShippingAccountsResponse.ShippingAccounts)
{
if (shippingAccount.CarrierType == TCarrierType.ShipRushUSPS)
{
var request = new ShipRush.SDK.Proxies.AddFundsRequest
{
ShippingAccountId = shippingAccount.ShippingAccountId,
Amount = shippingAccount.PostageBalance > 200
? 10
: 200
};
logger.Debug(string.Format("AddPostage"));
var response = ShipRushSDK.ExecuteCommand<ShipRush.SDK.Proxies.AddFundsRequest, ShipRush.SDK.Proxies.GetShippingAccountResponse>(APICommands.ADD_FUNDS, request);
if (response.PostageBalance <= shippingAccount.PostageBalance)
throw new ApplicationException(
string.Format("AddPostage should actuall add postage (same or less amount found) {0} vs {1}", response.PostageBalance, shippingAccount.PostageBalance));
postateAddedToAccountsCount++;
}
}
if (postateAddedToAccountsCount == 0)
throw new ApplicationException("At least one AddPostage call expected");
}
catch (Exception exc)
{
logger.Error(string.Format("Unable to Shipping_Rate: {0}", exc.Message));
throw;
}
}
private void CheckServerTime()
{
var dtLocalUTC = DateTime.UtcNow;
var dtServerUTC = GetMyShipRushTime();
var timespan = dtServerUTC - dtLocalUTC;
if (Math.Abs(timespan.TotalSeconds) > acceptable_server_time_difference_seconds)
{
throw new ApplicationException(
string.Format("The difference betweeen time on one of ShipRush server instances ({0}) and time on this machine ({1}) is greater then {2} seconds.", dtServerUTC, dtLocalUTC, acceptable_server_time_difference_seconds));
}
}
#region Inventory Management
private void RunInventoryManagementOperations()
{
logger.Debug("--------------------------------");
logger.Debug("Catalog and inventory operations");
logger.Debug("--------------------------------");
Guid webstoreId = new Guid();
try
{
// Use special API call to fill new user with some inventory and catalog test data - WebStore, few merchant locations, inventory items and PBCommodities
webstoreId = AddCatalogAndInventoyTestDataToUser();
// Get catalog
var catalogItems = GetCatalog();
// Pick first catalog item, we will need its ID, to perform additional calls to Web API
var firstCatalogItem = catalogItems.First();
// Get single catalog item by its ID
GetCatalogItemByCatalogItemId(firstCatalogItem.CatalogItemId);
// Get test web stores merchant locations
var merchantLocations = GetInventoryLocations(webstoreId.ToString());
// Load all inventory items
foreach (var merchantLocation in merchantLocations)
{
merchantLocation.InventoryItems = GetInventory(merchantLocation.MerchantLocationId.ToString());
}
// Pick first location - We'll do all tests against it
var firstMerchantLocation = merchantLocations.First(l => !l.IsDefaultLocation);
// Update qty on inventory item that is managed web store and verify if it was actually updated
UpdateInventoyOnItemManagedByWebStoreAndVerify(firstMerchantLocation);
// Pick first default location - We'll do all tests against it
var firstDefaultMerchantLocation = merchantLocations.First(l => l.IsDefaultLocation & l.InventoryItems.Any(i => !i.ManagedByWebStore));
// Try to do an update on item that is not being managed by web store -> Expected error response
TryUpdateInventoyOnItemNotManagedByWebStore(firstDefaultMerchantLocation);
// Pick first default location - We'll do all tests against it
var secondMerchantLocation = merchantLocations.Where(l => !l.IsDefaultLocation).Skip(1).Take(1).FirstOrDefault();
UpdateInventoyWithSameQuantityOnItemManagedByWebStoreAndVerify(secondMerchantLocation);
}
catch (Exception ex)
{
logger.Warn("Catalog API tests skipped");
throw;
}
finally
{
if (webstoreId != new Guid())
{
// Cleanup - Delete web store if it was created
DeleteWebstore(webstoreId.ToString());
}
}
}
private Guid AddCatalogAndInventoyTestDataToUser()
{
try
{
logger.DebugFormat("Adding catalog and inventory test data");
AddInventoryManagementTestDataRequest request = new AddInventoryManagementTestDataRequest();
var response = ShipRushSDK.ExecuteCommand<AddInventoryManagementTestDataRequest, AddInventoryManagementTestDataResponse>(APICommands.CATALOG_ADD_TEST_DATA, request);
logger.DebugFormat("{0}", response.ResultMessage);
if (!String.IsNullOrWhiteSpace(response.WebstoreId))
{
return new Guid(response.WebstoreId);
}
else
{
throw new ApplicationException("Test web store was not created as expected.");
}
}
catch (Exception exc)
{
logger.Error(String.Format("Add catalog and inventory test data failed: ", exc.Message));
throw;
}
}
private IList<CatalogItemView> GetCatalog()
{
try
{
logger.DebugFormat("Get all catalog items");
GetCatalogRequest request = new GetCatalogRequest()
{
ItemsPerPage = 100,
PageNumber = 0
};
var response = ShipRushSDK.ExecuteCommand<GetCatalogRequest, GetCatalogResponse>(APICommands.CATALOG_GET_CATALOG, request);
logger.DebugFormat("GetCatalog completed");
if ((response.CatalogItems != null) && (response.CatalogItems.Count > 0))
{
LogCatalogItems(response.CatalogItems);
}
else
{
throw new ApplicationException("No catalog items found. Expected to retrieve non empty catalog items list.");
}
return response.CatalogItems;
}
catch (Exception exc)
{
logger.Error(String.Format("Get all catalog items failed: ", exc.Message));
throw;
}
}
private void GetCatalogItemByCatalogItemId(string catalogItemId)
{
try
{
logger.DebugFormat("Get catalog item by CatalogItemId: {0}", catalogItemId);
GetCatalogItemRequest request = new GetCatalogItemRequest()
{
CatalogItemId = catalogItemId
};
var response = ShipRushSDK.ExecuteCommand<GetCatalogItemRequest, GetCatalogItemResponse>(APICommands.CATALOG_GET_CATALOG_ITEM, request);
logger.DebugFormat("Get catalog item by CatalogItemId completed");
if (response.CatalogItem != null)
{
LogCatalogItem(response.CatalogItem);
}
else
{
throw new ApplicationException("Catalog item not found. Expected non empty response.");
}
}
catch (Exception exc)
{
logger.Error(String.Format("Get catalog item by CatalogItemId failed: ", exc.Message));
throw;
}
}
private List<MerchantLocationView> GetInventoryLocations(string webStoreId)
{
try
{
logger.DebugFormat("Get inventory locations for web store: {0}", webStoreId);
GetInventoryLocationsRequest request = new GetInventoryLocationsRequest()
{
WebstoreId = webStoreId
};
var response = ShipRushSDK.ExecuteCommand<GetInventoryLocationsRequest, GetInventoryLocationsResponse>(APICommands.INVENTORY_GET_INVENTORYLOCATIONS, request);
logger.DebugFormat("Get inventory locations completed");
if ((response.MerchantLocations != null) && (response.MerchantLocations.Count > 0))
{
LogMerchantLocations(response.MerchantLocations);
}
else
{
throw new ApplicationException("No merchant locations items found. Expected non empty response.");
}
return response.MerchantLocations;
}
catch (Exception exc)
{
logger.Error(String.Format("Get inventory loactions for web store failed: ", exc.Message));
throw;
}
}
private List<InventoryItemView> GetInventory(string merchantLocationId)
{
try
{
logger.DebugFormat("Get inventory for merchant location: {0}", merchantLocationId);
GetInventoryRequest request = new GetInventoryRequest()
{
MerchantLocationId = merchantLocationId
};
var response = ShipRushSDK.ExecuteCommand<GetInventoryRequest, GetInventoryResponse>(APICommands.INVENTORY_GET_INVENTORY, request);
logger.DebugFormat("Get inventory completed");
if ((response.InventoryItems != null) && (response.InventoryItems.Count > 0))
{
LogInventoryItems(response.InventoryItems);
}
else
{
throw new ApplicationException("No inventory items found. Expected non empty response.");
}
return response.InventoryItems;
}
catch (Exception exc)
{
logger.Error(String.Format("Get inventory for merchant location failed: ", exc.Message));
throw;
}
}
private void UpdateInventoyOnItemManagedByWebStoreAndVerify(MerchantLocationView merchantLocation)
{
try
{
// Pick first inventory item that is managed by webstore
var firstInventoryItem = merchantLocation.InventoryItems.First(i => i.ManagedByWebStore);
logger.DebugFormat("Update inventory: {0}", firstInventoryItem.InventoryItemId);
int qty = ConvertToInt(firstInventoryItem.Quantity);
int newQty = qty + 15;
// Update qty on first item that is being managed by web store
UpdateInventory(firstInventoryItem.InventoryItemId, newQty);
logger.DebugFormat("Get updated inventory for web store: {0}", merchantLocation.WebstoreId);
var updatedInventory = GetInventory(merchantLocation.MerchantLocationId);
if (updatedInventory != null || updatedInventory.Count > 0)
{
// Find updated record and check its values
var updatedInventoryItem = updatedInventory.First(i => i.InventoryItemId == firstInventoryItem.InventoryItemId);
int updatedQty = ConvertToInt(updatedInventoryItem.Quantity);
if (updatedInventoryItem.RecordStatus != "MustUpdate")
{
throw new ApplicationException(String.Format("Expected RecordStatus after update: MustUpdate."));
}
if (updatedQty != newQty)
{
throw new ApplicationException(String.Format("Expected quantity after update: {0}.", newQty));
}
logger.DebugFormat("Updated inventory item:");
LogInventoryItem(updatedInventoryItem);
}
else
{
throw new ApplicationException("Could not retrieve updated record.");
}
}
catch (Exception exc)
{
logger.Error(String.Format("Inventory update failed: ", exc.Message));
throw;
}
}
private void TryUpdateInventoyOnItemNotManagedByWebStore(MerchantLocationView merchantLocation)
{
try
{
// Pick first inventory item that is NOT managed by web store
var firstInventoryItem = merchantLocation.InventoryItems.First(i => !i.ManagedByWebStore);
logger.DebugFormat("Update inventory on item that is not managed by web store: {0}", firstInventoryItem.InventoryItemId);
int qty = ConvertToInt(firstInventoryItem.Quantity);
int newQty = qty + 15;
// Update qty on first item that is being managed by web store
UpdateInventory(firstInventoryItem.InventoryItemId, newQty);
}
catch (Exception exc)
{
if (exc.Message.EndsWith("is not being tracked by web store. Inventory update is not allowed."))
{
// This is expected error. Message was already logged.
return;
}
else
{
logger.Error(String.Format("Inventory update failed: ", exc.Message));
throw;
}
}
}
private void UpdateInventoyWithSameQuantityOnItemManagedByWebStoreAndVerify(MerchantLocationView merchantLocation)
{
try
{
// Pick first inventory item that is managed by web store
var firstInventoryItem = merchantLocation.InventoryItems.First(i => i.ManagedByWebStore);
logger.DebugFormat("Update inventory to same quantity: {0}", firstInventoryItem.InventoryItemId);
int qty = ConvertToInt(firstInventoryItem.Quantity);
int newQty = qty; // Use same quantity
// Update qty on first item that is being managed by webstore
UpdateInventory(firstInventoryItem.InventoryItemId, newQty);
logger.DebugFormat("Get updated inventory for merchant location: {0}", merchantLocation.WebstoreId);
var updatedInventory = GetInventory(merchantLocation.MerchantLocationId);
if (updatedInventory != null || updatedInventory.Count > 0)
{
// Find updated record and check its values
var updatedInventoryItem = updatedInventory.First(i => i.InventoryItemId == firstInventoryItem.InventoryItemId);
int updatedQty = ConvertToInt(updatedInventoryItem.Quantity);
if (updatedInventoryItem.RecordStatus != "Valid")
{
throw new ApplicationException(String.Format("Expected RecordStatus after update: Valid."));
}
if (updatedQty != newQty)
{
throw new ApplicationException(String.Format("Expected quantity after update: {0}.", newQty));
}
logger.DebugFormat("Updated inventory item:");
LogInventoryItem(updatedInventoryItem);
}
else
{
throw new ApplicationException("Could not retrieve updated record.");
}
}
catch (Exception exc)
{
logger.Error(String.Format("Inventory update failed: ", exc.Message));
throw;
}
}
private void UpdateInventory(string inventoryItemId, int quantity)
{
try
{
logger.DebugFormat("Update inventory for inventory item: {0}", inventoryItemId);
UpdateInventoryRequest request = new UpdateInventoryRequest()
{
InventoryItems = new List<UpdateInventoryItemView>()
{
new UpdateInventoryItemView()
{
InventoryItemId = inventoryItemId,
Quantity = quantity
}
}
};
ShipRushSDK.ExecuteCommand<UpdateInventoryRequest>(APICommands.INVENTORY_UPDATE_INVENTORY, request);
logger.DebugFormat("Update inventory completed");
}
catch (ShipRushException exc)
{
logger.Error(exc.Message);
throw;
}
}
private void LogCatalogItems(IList<CatalogItemView> catalogItems)
{
logger.DebugFormat("{0} catalog items found:", catalogItems.Count);
foreach (var catalogItem in catalogItems)
{
LogCatalogItem(catalogItem);
}
}
private void LogCatalogItem(CatalogItemView catalogItem)
{
logger.DebugFormat(" CatalogItemId = {0}, SKU = {1}, Name = {2}",
catalogItem.CatalogItemId,
catalogItem.SKU,
catalogItem.Name);
}
private void LogMerchantLocations(IList<MerchantLocationView> merchantLocations)
{
logger.DebugFormat("{0} merchant locations found:", merchantLocations.Count);
foreach (var merchantLocation in merchantLocations)
{
LogMerchantLocation(merchantLocation);
}
}
private void LogMerchantLocation(MerchantLocationView merchantLocation)
{
logger.DebugFormat(" MerchantLocationId = {0}, IsDefaultLocation = {1}, ExternalLocationId = {2}",
merchantLocation.MerchantLocationId,
merchantLocation.IsDefaultLocation,
merchantLocation.ExternalLocationId);
if (merchantLocation.InventoryItems != null & merchantLocation.InventoryItems.Count > 0)
{
LogInventoryItems(merchantLocation.InventoryItems);
}
else
{
logger.WarnFormat(" Merchant location does not have inventory items assigned.");
}
}
private void LogInventoryItems(IList<InventoryItemView> inventoryItems)
{
logger.DebugFormat(" {0} inventory items found:", inventoryItems.Count);
foreach (var inventoryItem in inventoryItems)
{
LogInventoryItem(inventoryItem);
}
}
private void LogInventoryItem(InventoryItemView inventoryItem)
{
logger.DebugFormat(" InventoryItemId = {0}, CatalogItemId = {1}, ExternalCatalogItemId = {2}, ExternalVariationId = {3}, Quantity = {4}, ManagedByWebStore = {5}, ModifiedAt = {6}, RecordStatus = {7},",
inventoryItem.InventoryItemId,
inventoryItem.CatalogItemId,
inventoryItem.ExternalCatalogItemId,
inventoryItem.ExternalVariationId,
inventoryItem.Quantity,
inventoryItem.ManagedByWebStore,
inventoryItem.ModifiedAt,
inventoryItem.RecordStatus);
//LogCatalogItem(inventoryItem.CatalogItem);
}
private int ConvertToInt(string value)
{
int result = 0;
Int32.TryParse(value, out result);
return result;
}
#endregion
}
}Programs
/*
{ ************************************************************************** }
{ * * }
{ * This file contains information that is the confidential and * }
{ * proprietary property of Z-Firm LLC, and may not be copied, published, * }
{ * disclosed, or transmitted to others, or used for any purpose without * }
{ * the express written authorization of Z-Firm LLC. * }
{ * * }
{ * * }
{ * * }
{ * Copyright 2009 Z-Firm LLC. All Rights Reserved. * }
{ * * }
{ ************************************************************************** }
*/
/*
My.ShipRush API Demonstration Application.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Text;
using log4net;
namespace ShipRush.SDK.CommandLineDemo
{
class Program
{
static void Main(string[] args)
{
try
{
ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12 | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls;
// Configure log4net using the .config file
log4net.Config.XmlConfigurator.Configure();
var largePartnerDemo = new LargePartnerScenario();
largePartnerDemo.Run();
}
catch(Exception e)
{
LogManager.GetLogger(typeof(Program)).Error("Unable to run LargePartnerScenario: " + e.ToString(), e);
Console.WriteLine("Unable to run LargePartnerScenario: " + e.ToString());
Environment.Exit(-1);
}
}
}
}Command Line Demo
Csproj
<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
<BuildType Condition=" '$(BuildType)' == '' ">Development</BuildType>
<ProductVersion>9.0.30729</ProductVersion>
<SchemaVersion>2.0</SchemaVersion>
<ProjectGuid>{B5431D32-56C0-469A-A4BC-11424C108F42}</ProjectGuid>
<OutputType>Exe</OutputType>
<AppDesignerFolder>Properties</AppDesignerFolder>
<RootNamespace>ShipRush.SDK.CommandLineDemo</RootNamespace>
<AssemblyName>ShipRush.SDK.CommandLineDemo</AssemblyName>
<TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
<FileAlignment>512</FileAlignment>
<IsWebBootstrapper>true</IsWebBootstrapper>
<SccProjectName>SAK</SccProjectName>
<SccLocalPath>SAK</SccLocalPath>
<SccAuxPath>SAK</SccAuxPath>
<SccProvider>SAK</SccProvider>
<PublishUrl>http://localhost/ShipRush.SDK.CommandLineDemo/</PublishUrl>
<Install>true</Install>
<InstallFrom>Web</InstallFrom>
<UpdateEnabled>true</UpdateEnabled>
<UpdateMode>Foreground</UpdateMode>
<UpdateInterval>7</UpdateInterval>
<UpdateIntervalUnits>Days</UpdateIntervalUnits>
<UpdatePeriodically>false</UpdatePeriodically>
<UpdateRequired>false</UpdateRequired>
<MapFileExtensions>true</MapFileExtensions>
<ApplicationRevision>0</ApplicationRevision>
<ApplicationVersion>1.0.0.%2a</ApplicationVersion>
<UseApplicationTrust>false</UseApplicationTrust>
<BootstrapperEnabled>true</BootstrapperEnabled>
<FileUpgradeFlags>
</FileUpgradeFlags>
<UpgradeBackupLocation>
</UpgradeBackupLocation>
<OldToolsVersion>3.5</OldToolsVersion>
<TargetFrameworkProfile />
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
<DebugSymbols>true</DebugSymbols>
<DebugType>full</DebugType>
<Optimize>false</Optimize>
<OutputPath>bin\Debug\</OutputPath>
<DefineConstants>DEBUG;TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
<DebugType>pdbonly</DebugType>
<Optimize>true</Optimize>
<OutputPath>bin\Release\</OutputPath>
<DefineConstants>TRACE</DefineConstants>
<ErrorReport>prompt</ErrorReport>
<WarningLevel>4</WarningLevel>
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
<PropertyGroup Condition="'$(Configuration)|$(Platform)' == 'Certification|AnyCPU'">
<DebugSymbols>true</DebugSymbols>
<OutputPath>bin\Certification\</OutputPath>
<DefineConstants>DEBUG;TRACE</DefineConstants>
<DebugType>full</DebugType>
<PlatformTarget>AnyCPU</PlatformTarget>
<CodeAnalysisLogFile>bin\Debug\ShipRush.SDK.CommandLineDemo.exe.CodeAnalysisLog.xml</CodeAnalysisLogFile>
<CodeAnalysisUseTypeNameInSuppression>true</CodeAnalysisUseTypeNameInSuppression>
<CodeAnalysisModuleSuppressionsFile>GlobalSuppressions.cs</CodeAnalysisModuleSuppressionsFile>
<ErrorReport>prompt</ErrorReport>
<CodeAnalysisRuleSet>AllRules.ruleset</CodeAnalysisRuleSet>
<CodeAnalysisRuleSetDirectories>;C:\Program Files (x86)\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\\Rule Sets</CodeAnalysisRuleSetDirectories>
<CodeAnalysisIgnoreBuiltInRuleSets>true</CodeAnalysisIgnoreBuiltInRuleSets>
<CodeAnalysisRuleDirectories>;C:\Program Files (x86)\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\FxCop\\Rules</CodeAnalysisRuleDirectories>
<CodeAnalysisIgnoreBuiltInRules>true</CodeAnalysisIgnoreBuiltInRules>
</PropertyGroup>
<ItemGroup>
<Reference Include="log4net, Version=1.2.13.0, Culture=neutral, PublicKeyToken=669e0ddf0bb1aa2a, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
<HintPath>..\Tools\log4net\bin\net\2.0\release\log4net.dll</HintPath>
</Reference>
<Reference Include="System" />
<Reference Include="System.configuration" />
<Reference Include="System.Core">
<RequiredTargetFramework>3.5</RequiredTargetFramework>
</Reference>
<Reference Include="System.Xml.Linq">
<RequiredTargetFramework>3.5</RequiredTargetFramework>
</Reference>
<Reference Include="System.Data.DataSetExtensions">
<RequiredTargetFramework>3.5</RequiredTargetFramework>
</Reference>
<Reference Include="System.Data" />
<Reference Include="System.Xml" />
</ItemGroup>
<ItemGroup>
<Compile Include="LargePartnerScenario.cs" />
<Compile Include="Program.cs" />
<Compile Include="Properties\AssemblyInfo.cs" />
<Compile Include="ShipRushServiceSettings.cs" />
</ItemGroup>
<ItemGroup>
<None Include="App.config" />
</ItemGroup>
<ItemGroup>
<BootstrapperPackage Include="Microsoft.Net.Client.3.5">
<Visible>False</Visible>
<ProductName>.NET Framework Client Profile</ProductName>
<Install>false</Install>
</BootstrapperPackage>
<BootstrapperPackage Include="Microsoft.Net.Framework.2.0">
<Visible>False</Visible>
<ProductName>.NET Framework 2.0 %28x86%29</ProductName>
<Install>false</Install>
</BootstrapperPackage>
<BootstrapperPackage Include="Microsoft.Net.Framework.3.0">
<Visible>False</Visible>
<ProductName>.NET Framework 3.0 %28x86%29</ProductName>
<Install>false</Install>
</BootstrapperPackage>
<BootstrapperPackage Include="Microsoft.Net.Framework.3.5">
<Visible>False</Visible>
<ProductName>.NET Framework 3.5</ProductName>
<Install>false</Install>
</BootstrapperPackage>
<BootstrapperPackage Include="Microsoft.Net.Framework.3.5.SP1">
<Visible>False</Visible>
<ProductName>.NET Framework 3.5 SP1</ProductName>
<Install>true</Install>
</BootstrapperPackage>
<BootstrapperPackage Include="Microsoft.Windows.Installer.3.1">
<Visible>False</Visible>
<ProductName>Windows Installer 3.1</ProductName>
<Install>true</Install>
</BootstrapperPackage>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\ShipRush.SDK.Proxies\ShipRush.SDK.Proxies.csproj">
<Project>{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}</Project>
<Name>ShipRush.SDK.Proxies</Name>
</ProjectReference>
<ProjectReference Include="..\ShipRush.SDK\ShipRush.SDK.csproj">
<Project>{2920785A-C8A0-4E9B-A432-67A2EB866C17}</Project>
<Name>ShipRush.SDK</Name>
</ProjectReference>
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Shipments\001.xml" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Shipments\002.xml" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Shipments\003.xml" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="Shipments\ShippingAPI_001.xml" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
Other similar extension points exist, see Microsoft.Common.targets.
<Target Name="BeforeBuild">
</Target>
<Target Name="AfterBuild">
</Target>
-->
<PropertyGroup>
<PreBuildEvent>
</PreBuildEvent>
</PropertyGroup>
</Project>Vspscc
""
{
"FILE_VERSION" = "9237"
"ENLISTMENT_CHOICE" = "NEVER"
"PROJECT_FILE_RELATIVE_PATH" = "relative:ShipRush.SDK.CommandLineDemo"
"NUMBER_OF_EXCLUDED_FILES" = "0"
"ORIGINAL_PROJECT_FILE_PATH" = ""
"NUMBER_OF_NESTED_PROJECTS" = "0"
"SOURCE_CONTROL_SETTINGS_PROVIDER" = "PROVIDER"
}Sln
Microsoft Visual Studio Solution File, Format Version 10.00
# Visual Studio 2008
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ShipRush.SDK.CommandLineDemo", "ShipRush.SDK.CommandLineDemo.csproj", "{B5431D32-56C0-469A-A4BC-11424C108F42}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ShipRush.SDK", "..\ShipRush.SDK\ShipRush.SDK.csproj", "{2920785A-C8A0-4E9B-A432-67A2EB866C17}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ShipRush.SDK.Proxies", "..\ShipRush.SDK.Proxies\ShipRush.SDK.Proxies.csproj", "{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{B5431D32-56C0-469A-A4BC-11424C108F42}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B5431D32-56C0-469A-A4BC-11424C108F42}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B5431D32-56C0-469A-A4BC-11424C108F42}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B5431D32-56C0-469A-A4BC-11424C108F42}.Release|Any CPU.Build.0 = Release|Any CPU
{2920785A-C8A0-4E9B-A432-67A2EB866C17}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{2920785A-C8A0-4E9B-A432-67A2EB866C17}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2920785A-C8A0-4E9B-A432-67A2EB866C17}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2920785A-C8A0-4E9B-A432-67A2EB866C17}.Release|Any CPU.Build.0 = Release|Any CPU
{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{8CE19038-AC9D-46FF-8EF3-A7BA50BF5E1D}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
EndGlobal
Service Settings
/*
{ ************************************************************************** }
{ * * }
{ * This file contains information that is the confidential and * }
{ * proprietary property of Z-Firm LLC, and may not be copied, published, * }
{ * disclosed, or transmitted to others, or used for any purpose without * }
{ * the express written authorization of Z-Firm LLC. * }
{ * * }
{ * * }
{ * * }
{ * Copyright 2009 Z-Firm LLC. All Rights Reserved. * }
{ * * }
{ ************************************************************************** }
*/
/*
My.ShipRush API Demonstration Application.
*/
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Configuration;
using System.Linq;
using System.Text;
using ShipRush.SDK.Transport;
namespace ShipRush.SDK.CommandLineDemo
{
public static class ShipRushServiceSettings
{
static ShipRushServiceSettings()
{
Load();
}
private static void Load()
{
// General settings
NameValueCollection general = (NameValueCollection) ConfigurationManager.GetSection("MyShipRush");
if (general == null) return;
if (general["ServiceRootUrl"] != null) ServiceRootUrl = general["ServiceRootUrl"];
if (general["DeveloperToken"] != null) DeveloperToken = general["DeveloperToken"];
if (general["ShippingToken"] != null) ShippingToken = general["ShippingToken"];
if (general["OpenBrowser"] != null) OpenBrowser = bool.Parse(general["OpenBrowser"]);
}
public static string ServiceRootUrl = "";
public static string DeveloperToken = "";
public static string ShippingToken = "";
public static bool OpenBrowser = false;
public static void ApplyToShipRushSDK_UserAndDeveloper()
{
ShipRushSDK.ServiceUrl = ServiceRootUrl;
ShipRushSDK.DeveloperToken = DeveloperToken;
ShipRushSDK.ShippingToken = "";
}
public static void ApplyToShipRushSDK_Shipping()
{
ShipRushSDK.ServiceUrl = ServiceRootUrl;
ShipRushSDK.UserToken = "";
ShipRushSDK.DeveloperToken = "";
ShipRushSDK.ShippingToken = ShippingToken;
}
}
}