diff --git a/README.md b/README.md index 94d17fd..8a2b5dd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,296 @@ -# sn-benchmark +# Sense/Net Benchmark +[![Join the chat at https://gitter.im/SenseNet/sn-benchmark](https://badges.gitter.im/SenseNet/sn-benchmark.svg)](https://gitter.im/SenseNet/sn-benchmark?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Join the chat at https://gitter.im/SenseNet/sn-benchmark](https://badges.gitter.im/SenseNet/sn-benchmark.svg)](https://gitter.im/SenseNet/sn-benchmark?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) \ No newline at end of file +[Sense/Net ECM](http://sensenet.com), an enterprise content management platform that is capable of handling many users and a huge number of content in a single Content Repository, constantly evolves. This requires a stable **benchmarking method** that lets us measure the impact of our decisions along the way. It may also help measuring performance on specific implementations, not just the core platform. + +![Benchmark diagram 1](http://wiki.sensenet.com/images/6/66/Becnhmark-01.png "Benchmark diagram 1") + +## Table of contents +1. [How it works](#HowItWorks) +2. [The tool](#TheTool) +3. [Execution workflow](#ExecutionWorkflow) +4. [Profiles](#Profiles) +5. [Usage](#Usage) +6. [Benchmark results](#BenchmarkResults) +7. [Profile example: the Visitor](#ProfileExampleTheVisitor) +8. [Benchmark Profile Definition Language](#BenchmarkProfileDefinitionLanguage) +9. [Resources](#Resources) +10. [Hardware](#Hardware) + +## How it works + +Sense/Net ECM benchmarking is built around **Profiles**. A profile represents a typical user (e.g. Visitor, Editor) that can be described by a **set of simple actions**. The benchmark tool will start to "attack" the site with a configured number of profiles (e.g. 20 Visitors) then it adds more and more visitors gradually. The tool stops when the portal starts responding slower than a predefined treshold. + +The idea is that after a few iterations you will be able to determine the **optimal set of profiles** (e.g. 40 Visitors, 5 Editors and 2 Administrators) that may use the portal concurrently without significant performance degradation. + +## The tool + +**SnBenchmark** is a *command line tool* that measures the performance of a Sense/Net ECM instance and helps you determine real-life capabilities of your site. It requires a running portal, but no modifications are required on the portal side. The tool accesses the site through its *REST API* (or to be precise the [Sense/Net Client library](http://wiki.sensenet.com/Client_library) built on top of it). As it is written using an *asynchronous* architecture, it does not consume too much resources on the client you are executing it on. + +The result of a benchmark execution will be a *csv file* containing request/response times and other collected data that you can use to visualize the behavior of your site under different load. See an example later in this document. + +## Execution workflow + +This is what the tool does, when you execute it: +1. loads the provided profiles from text files +2. starts measurement with a short warmup period +3. adds more profiles periodically +4. collects average response times during a period +5. stops adding more profiles when a *predefined hypotetical limit* is reached +6. waits while all the remaining requests finish + +As a result, the tool will generate a csv file (see below) and it will provide the last average response times *before the limit has been reached*. + +## Profiles + +Benchmark profiles are defined using a simple script language. A profile is a *text file* that consists of lines describing simple actions, like loading a content or performing an [OData action](http://wiki.sensenet.com/OData_REST_API). + +We provide a basic set of profiles that we use for measuring the core product, but you can create **custom profiles** that better represent your user base. + +See an example **Visitor** profile below. + +## Usage + +There are a couple of *required* and *optional* parameters by which you can define the behavior of the tool. +```text +SnBenchmark.exe -PROFILE:"Visitor:10+5" -SITE:"http://localhost" -USR:admin -PWD:admin -WARMUP:10 -GROW:10 -LIMIT:"Normal:4.0;Slow:8.0" +``` +Parameter order is irrelevant. Parameters have shorter aliases if you prefer them and names are case insensitive. +Recommended parameter format: *-NAME:value* or */NAME:value* + +##### PROFILE (alias: P) - required +Comma separated 'name:count+growth|limit' structures. +* *name*: profile name (e.g. Visitor) +* *count*: initial number of profiles of that type to start with (required). "Visitor:10" means benchmarking will start with 10 visitors. +* *growth*: number of new profiles added in every period (required, but can be 0). "Visitor:10+1" means that one new visitor profile will be added to the pool periodically (about periods see the *GROW* parameter below). +* *limit*: the maximum number of running instances of this profile (optional). + +```text +Profile1:5+1,Profile2:1+1,Profile3:5+1|50 +``` + +It is recommended to set the number of added profiles to a small number to let the benchmark tool increase the load gradually. Some examples for a complex profile set: +```text +"Visitor:10+2,Aministrator:5+1" +"Visitor:16+4|200,Editor:8+2|20,Aministrator:4+1|10" +``` + +##### SITE (alias: S) - required +Comma separated url list (e.g.: *'http://mysite1,http://mysite1'*). These urls will be selected and used in a random order and will be supplemented by the relative urls from the current profile. + +##### USERNAME (alias: USR) - required +The user's name and domain (e.g. 'Admin' or 'demo\someone). In a future version it will be possible to set a custom user/password for a single request (profile action). Currently these credentials are used for every request. + +##### PASSWORD (alias: PWD) - required +Password of the user above. + +##### WARMUPTIME (aliases: W, WARMUP) - optional +Warmup time in seconds. Default: 60. During this period the response times are not compared to the limits (see below). + +##### GROWINGTIME (aliases: G, GROW, GROWING) - optional +Length of a load period in seconds. Default: 30. Defines a time interval for executing profiles. After it expires, additional profiles are added to the already running list. The growth rate (number of new profiles) is defined by the *PROFILE* parameter. + +##### LIMIT (alias: L) - optional +Average *response time limits* per speed category in seconds (e.g.: NORMAL:4;FAST:2;SLOW:6.3). The speed category default is 10. Profiles can assign a speed category to every request definition. Undefined speed is the default: NORMAL. + +During benchmarking the average response times are calculated by speed category. If the average response time exceeds the category limit, the measuring will be terminated. The benchmark result is the average value *before* any limit has been reached. It is strongly recommended to define only a few categories (3-5 types max). + +##### MAXERRORS (aliases: E, ERRORS) - optional +Maximum allowed error count. Default: 10. + +##### VERBOSE (alias: V) - optional +If set, a detailed benchmark measuring progress is written to the console. This parameter has no value. + +##### OUTPUT (aliases: O, OUT) - optional +Output file for further analysis in csv format. The file is always written to the disk. This parameter controls the output file's name an location. Default location is the *Output* subirectory in the appdomain's base directory (exe location). + +Default: *Benchmark-Output_????-??-??_??-??-??.csv* (question marks are replaced by the current date and time). + +The parameter value can be in one of the following formats: +- an absolute path: e.g. "C:\BenchmarkLogs\Monday\Benchmark.csv" +- a relative path: e.g. "..\..\Logs\Benchmark.csv" (base directory is: exelocation\Output) +- a file name: "Benchmark.csv" (directory is: exelocation\Output) + +The parameter value can contain one *asterisk* (*) as a placeholder character that will be replaced by the current date and time. In the following case the file will be written as *exelocation\Output\Benchmark_2016-09-27_05-38-45.csv*. +```text +-OUT:Benchmark_*.csv +``` + +## Benchmark results + +##### Console output +Default: +```text +Pcount Active NORMAL SLOW + 2,00 5,00 +10 0 0,00 0,00 ---- WARMUP ----- +15 2 0,00 0,00 ---- GROWING ------------- +``` + +Verbose: +```text +Pcount Active Req/sec NORMAL SLOW Lnormal Lslow +---- WARMUP +10 0 0 0,00 0,00 2,00 5,00 +10 3 4 0,00 0,00 2,00 5,00 +---- GROWING +15 2 1 0,00 0,00 2,00 5,00 +15 4 6 0,00 0,00 2,00 5,00 +15 7 7 0,00 0,00 2,00 5,00 +``` + +##### Headers +- **Pcount**: Currently executing profile count. +- **Active**: average active requests (request sent but response has not arrived yet). +- **Req/sec**: average complete request-responses per sec. +- **NORMAL, SLOW**: average response times for each speed category. +- **Lnormal, Lslow**: Speed category limits (control values for drawing charts). + +##### Output file +The benchmark result cannot be an exact value because the limits are set by us and they are just theoretical values that ensure that the tool terminates. Valid benchmark results can be visualized from the data in the output file. + +The output file is the CSV mutation of the verbose console that can be opened in *Microsoft Excel*. The first few lines of the file contain the execution values (e.g. start time) for logging purposes. + +Below that there is a running log table that can be visualized as a graph. Follow these steps to do that. + +1. Delete the benchmark info at the top, so that the table header becomes the first row. +2. Select all relevant columns: click the "D" column header and drag right to the last column (the first 3 columns are not needed for the chart). +3. Click the "INSERT" tab in the ribbon, click the "Insert line chart" and select the first 2-D line chart. +4. Resize the chart if necessary. + +On the chart the horizontal lines are the speed category limits. You can see the average response times for each speed category. The first section (on the left with many zeroes) is whe warmup. + +(On the right side there is a break in all lines that is caused by an extra line in the table. This line is the benchmark result that was written when one of the average values reached the defined limit. You can delete the line and the break disappears.) + +![Benchmark diagram 2](http://wiki.sensenet.com/images/f/f8/Becnhmark-02.png "Benchmark diagram 2") + +Usually there is a point during the benchmark when average request times start to grow significantly. That point is way before reaching the defined speed limit (the flat line on the chart above), but that is the purpose of this benchmark: we are looking for the optimal set of profiles that can be served by the portal without performance loss. So in the example above the maximum number of profiles (in this hardware environment) is determined by the red arrows. + +## Profile example: the Visitor + +A Visitor usually performs actions similar to these: +1. visit the main page +2. perform a search +3. paging on the search page +4. visit one of the results + +This is how it looks like translated to the script language of the SnBenchmark tool. Note the delays between the requests (defined in seconds): the ensure that the profile simulates a real life user correctly. + +```text +; get main page +REQ: / +WAIT: 2000 + +; quick search by a simple word: "demo" (through the REST API +REQ: GET /OData.svc/Root/Sites/Default_Site?$top=10&query=demo&$inlinecount=allpages&metadata=no + +; get the search result html page once to simulate real usage +REQ: /features/Search?text=demo +WAIT: 2000 + +; get 2nd page of the search result +REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=10&query=demo&$inlinecount=allpages&metadata=no +WAIT: 2000 + +; get 3rd page of the search result +REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=20&query=demo&$inlinecount=allpages&metadata=no +WAIT: 2000 + +; get 4th page of the search result +REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=30&query=demo&$inlinecount=allpages&metadata=no +WAIT: 2000 + +; browse one of the result content +REQ: /OData.svc/infos/features('kpiworkspacesinfo') +WAIT: 8000 +``` + +For a more complex example please check the Editor profile provided by us in the source directory. If you want to create a custom profile, put those text files in the *Profiles* folder next to the tool. See the language details in the following section. + +## Benchmark Profile Definition Language + +The Profile Definition is a text file that describes an action sequence. Possible actions: sending a web request, memorizing data from the response as a variable, waiting for a couple of seconds. + +At the beginnig of the line there is a *control character or word* that defines the purpose of that line. Empty lines and lines starting with an unrecognized control word will be skipped. + +### Comment +If the line starts with a semicolon character (;) the line will be skipped. +```text +; PROFILE DESCRIPTION: Small content editor task +``` +There is only line comment, it is not possible to write an inline comment. + +### WAIT +The profile execution will be suspended for a time. Parameter value is defined in milliseconds. +```text +WAIT: 2000 +``` +This causes a 2 seconds async pause. + +### REQ +Describes a web request. Two parameters are allowed: *http verb* and *url** +- HTTP verb: GET, POST, DELETE and so on. If the verb is missing, the *default is GET*. +- URL: absolute url without the protocol and domain. Must start with a slash (/). +```text +; Default main page GET request +REQ: / +; Subpage html request +REQ: GET /workspaces +; OData request +REQ: DELETE /odata.svc/content(1234) +``` + +There are a couple of extensions to the request line above. They can be written as separate lines after a request line. The following keywords can be used: *DATA, SPEED, VAR* + +#### DATA +There are many OData requests that require some data in the request stream. This is how you define a post data. +```text +; Create a new memo +REQ: POST /OData.svc/workspaces/Project/madridprojectworkspace/Memos +DATA: models=[{"__ContentType":"Memo","Description":"asdf qwer"}] +``` + +#### SPEED +Defines the *speed category* of the current request. Optional, default is "NORMAL". Category name is case insensitive. Categories are defined when you execute the benchmark tool (see parameters above). Requests that are put into a certain category will be taken into account when we compare the average response times to category limits. +```text +SPEED: Slow +``` + +#### VAR +There is a simple way to memorize and reuse data from an OData response: you can define a variable that will hold a value extracted from the response object. This is useful when you are working with dynamic content items and values that you do not know at the time when you create the script. + +Response object reference id *"@Response"*. + +Variable names must start with the *'@'* character. Only a property path is allowed on the right side, expressions are forbidden. +```text +VAR: @Name = @Response.d.Name +``` + +### Templating: using variables +In request urls or data it is possible to mark places for substitution with variables defined earlier. + +Placeholder format: *<< variablename >>*. + +```text +; Create a new memo and memorize its name (generated by the server) +REQ: POST /OData.svc/workspaces/Project/madridprojectworkspace/Memos +DATA: models=[{"__ContentType":"Memo","Description":"asdf qwer"}] +VAR: @Name = @Response.d.Name + +; 5 seconds pause +WAIT: 5000 + +; Modify a field of the created content +REQ: PATCH /OData.svc/workspaces/Project/madridprojectworkspace/Memos('<<@Name>>') +DATA: models=[{"Description":"description of <<@Name>>"}] +``` + +## Resources + +The SnBenchmark tool itself does not consume too much resources. It is written as a completely asynchronous tool, you can start it on an average machine. + +You should pay attention to the generated log files though: after a few iterations the csv or error files may consume a significant amout of disk space. + +## Hardware + +The hardware your site runs on is important from the measurement's point of view. It does not make sense to compare two performance measurements made on a different hardware - unless you want to measure the performance of the hardware which is usually not the case. diff --git a/src/SnBenchmark/README.md b/src/SnBenchmark/README.md deleted file mode 100644 index f8d0348..0000000 --- a/src/SnBenchmark/README.md +++ /dev/null @@ -1,295 +0,0 @@ -# SenseNet Benchmark -[SenseNet ECM](http://sensenet.com), an enterprise content management platform that is capable of handling many users and a huge number of content in a single Content Repository, constantly evolves. This requires a stable **benchmarking method** that lets us measure the impact of our decisions along the way. It may also help measuring performance on specific implementations, not just the core platform. - -We publish our benchmark results and the details of our test environment on [sensenet.com](http://sensenet.com/benchmark). - -![Benchmark diagram 1](/images/benchmark-diagram1.png "Benchmark diagram 1") - -## Table of contents -1. [How it works](#HowItWorks) -2. [The tool](#TheTool) -3. [Execution workflow](#ExecutionWorkflow) -4. [Profiles](#Profiles) -5. [Usage](#Usage) -6. [Benchmark results](#BenchmarkResults) -7. [Profile example: the Visitor](#ProfileExampleTheVisitor) -8. [Benchmark Profile Definition Language](#BenchmarkProfileDefinitionLanguage) -9. [Resources](#Resources) -10. [Hardware](#Hardware) - -## How it works - -SenseNet ECM benchmarking is built around **Profiles**. A profile represents a typical user (e.g. Visitor, Editor) that can be described by a **set of simple actions**. The benchmark tool will start to "attack" the site with a configured number of profiles (e.g. 20 Visitors) then it adds more and more visitors gradually. The tool stops when the portal starts responding slower than a predefined treshold. - -The idea is that after a few iterations you will be able to determine the **optimal set of profiles** (e.g. 40 Visitors, 5 Editors and 2 Administrators) that may use the portal concurrently without significant performance degradation. - -## The tool - -**SnBenchmark** is a *command line tool* that measures the performance of a SenseNet ECM instance and helps you determine real-life capabilities of your site. It requires a running portal, but no modifications are required on the portal side. The tool accesses the site through its *REST API* (or to be precise the [SenseNet Client library](http://wiki.sensenet.com/Client_library) built on top of it). As it is written using an *asynchronous* architecture, it does not consume too much resources on the client you are executing it on. - -The result of a benchmark execution will be a *csv file* containing request/response times and other collected data that you can use to visualize the behavior of your site under different load. See an example later in this document. - -## Execution workflow - -This is what the tool does, when you execute it: -1. loads the provided profiles from text files -2. starts measurement with a short warmup period -3. adds more profiles periodically -4. collects average response times during a period -5. stops adding more profiles when a *predefined hypotetical limit* is reached -6. waits while all the remaining requests finish - -As a result, the tool will generate a csv file (see below) and it will provide the last average response times *before the limit has been reached*. - -## Profiles - -Benchmark profiles are defined using a simple script language. A profile is a *text file* that consists of lines describing simple actions, like loading a content or performing an [OData action](http://wiki.sensenet.com/OData_REST_API). - -We provide a basic set of profiles that we use for measuring the core product, but you can create **custom profiles** that better represent your user base. - -See an example **Visitor** profile below. - -## Usage - -There are a couple of *required* and *optional* parameters by which you can define the behavior of the tool. -```text -SnBenchmark.exe -PROFILE:"Visitor:10+5" -SITE:"http://localhost" -USR:admin -PWD:admin -WARMUP:10 -GROW:10 -LIMIT:"Normal:4.0;Slow:8.0" -``` -Parameter order is irrelevant. Parameters have shorter aliases if you prefer them and names are case insensitive. -Recommended parameter format: *-NAME:value* or */NAME:value* - -##### PROFILE (alias: P) - required -Comma separated 'name:count+growth|limit' structures. -* *name*: profile name (e.g. Visitor) -* *count*: initial number of profiles of that type to start with (required). "Visitor:10" means benchmarking will start with 10 visitors. -* *growth*: number of new profiles added in every period (required, but can be 0). "Visitor:10+1" means that one new visitor profile will be added to the pool periodically (about periods see the *GROW* parameter below). -* *limit*: the maximum number of running instances of this profile (optional). - -```text -Profile1:5+1,Profile2:1+1,Profile3:5+1|50 -``` - -It is recommended to set the number of added profiles to a small number to let the benchmark tool increase the load gradually. Some examples for a complex profile set: -```text -"Visitor:10+2,Aministrator:5+1" -"Visitor:16+4|200,Editor:8+2|20,Aministrator:4+1|10" -``` - -##### SITE (alias: S) - required -Comma separated url list (e.g.: *'http://mysite1,http://mysite1'*). These urls will be selected and used in a random order and will be supplemented by the relative urls from the current profile. - -##### USERNAME (alias: USR) - required -The user's name and domain (e.g. 'Admin' or 'demo\someone). In a future version it will be possible to set a custom user/password for a single request (profile action). Currently these credentials are used for every request. - -##### PASSWORD (alias: PWD) - required -Password of the user above. - -##### WARMUPTIME (aliases: W, WARMUP) - optional -Warmup time in seconds. Default: 60. During this period the response times are not compared to the limits (see below). - -##### GROWINGTIME (aliases: G, GROW, GROWING) - optional -Length of a load period in seconds. Default: 30. Defines a time interval for executing profiles. After it expires, additional profiles are added to the already running list. The growth rate (number of new profiles) is defined by the *PROFILE* parameter. - -##### LIMIT (alias: L) - optional -Average *response time limits* per speed category in seconds (e.g.: NORMAL:4;FAST:2;SLOW:6.3). The speed category default is 10. Profiles can assign a speed category to every request definition. Undefined speed is the default: NORMAL. - -During benchmarking the average response times are calculated by speed category. If the average response time exceeds the category limit, the measuring will be terminated. The benchmark result is the average value *before* any limit has been reached. It is strongly recommended to define only a few categories (3-5 types max). - -##### MAXERRORS (aliases: E, ERRORS) - optional -Maximum allowed error count. Default: 10. - -##### VERBOSE (alias: V) - optional -If set, a detailed benchmark measuring progress is written to the console. This parameter has no value. - -##### OUTPUT (aliases: O, OUT) - optional -Output file for further analysis in csv format. The file is always written to the disk. This parameter controls the output file's name an location. Default location is the *Output* subirectory in the appdomain's base directory (exe location). - -Default: *Benchmark-Output_????-??-??_??-??-??.csv* (question marks are replaced by the current date and time). - -The parameter value can be in one of the following formats: -- an absolute path: e.g. "C:\BenchmarkLogs\Monday\Benchmark.csv" -- a relative path: e.g. "..\..\Logs\Benchmark.csv" (base directory is: exelocation\Output) -- a file name: "Benchmark.csv" (directory is: exelocation\Output) - -The parameter value can contain one *asterisk* (*) as a placeholder character that will be replaced by the current date and time. In the following case the file will be written as *exelocation\Output\Benchmark_2016-09-27_05-38-45.csv*. -```text --OUT:Benchmark_*.csv -``` - -## Benchmark results - -##### Console output -Default: -```text -Pcount Active NORMAL SLOW - 2,00 5,00 -10 0 0,00 0,00 ---- WARMUP ----- -15 2 0,00 0,00 ---- GROWING ------------- -``` - -Verbose: -```text -Pcount Active Req/sec NORMAL SLOW Lnormal Lslow ----- WARMUP -10 0 0 0,00 0,00 2,00 5,00 -10 3 4 0,00 0,00 2,00 5,00 ----- GROWING -15 2 1 0,00 0,00 2,00 5,00 -15 4 6 0,00 0,00 2,00 5,00 -15 7 7 0,00 0,00 2,00 5,00 -``` - -##### Headers -- **Pcount**: Currently executing profile count. -- **Active**: average active requests (request sent but response has not arrived yet). -- **Req/sec**: average complete request-responses per sec. -- **NORMAL, SLOW**: average response times for each speed category. -- **Lnormal, Lslow**: Speed category limits (control values for drawing charts). - -##### Output file -The benchmark result cannot be an exact value because the limits are set by us and they are just theoretical values that ensure that the tool terminates. Valid benchmark results can be visualized from the data in the output file. - -The output file is the CSV mutation of the verbose console that can be opened in *Microsoft Excel*. The first few lines of the file contain the execution values (e.g. start time) for logging purposes. - -Below that there is a running log table that can be visualized as a graph. Follow these steps to do that. -1. Delete the benchmark info at the top, so that the table header becomes the first row. -2. Select all relevant columns: click the "D" column header and drag right to the last column (the first 3 columns are not needed for the chart). -3. Click the "INSERT" tab in the ribbon, click the "Insert line chart" and select the first 2-D line chart. -4. Resize the chart if necessary. - -![Benchmark diagram 2](/images/benchmark-diagram2.png "Benchmark diagram 2") - -On the chart the horizontal lines are the speed category limits. You can see the average response times for each speed category. The first section (on the left with many zeroes) is whe warmup. - -(On the right side there is a break in all lines that is caused by an extra line in the table. This line is the benchmark result that was written when one of the average values reached the defined limit. You can delete the line and the break disappears.) - -As you can see on the diagram above, there was a point during the benchmark when average request times started to grow significantly. That point is way before reaching the defined speed limit (the flat line above), but that is the purpose of this benchmark: we are looking for the optimal set of profiles that can be served by the portal without performance loss. So in the example above the maximum number of profiles (in this hardware environment) is determined by the red arrows. - -## Profile example: the Visitor - -A Visitor usually performs actions similar to these: -1. visit the main page -2. perform a search -3. paging on the search page -4. visit one of the results - -This is how it looks like translated to the script language of the SnBenchmark tool. Note the delays between the requests (defined in seconds): the ensure that the profile simulates a real life user correctly. - -```text -; get main page -REQ: / -WAIT: 2000 - -; quick search by a simple word: "demo" (through the REST API -REQ: GET /OData.svc/Root/Sites/Default_Site?$top=10&query=demo&$inlinecount=allpages&metadata=no - -; get the search result html page once to simulate real usage -REQ: /features/Search?text=demo -WAIT: 2000 - -; get 2nd page of the search result -REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=10&query=demo&$inlinecount=allpages&metadata=no -WAIT: 2000 - -; get 3rd page of the search result -REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=20&query=demo&$inlinecount=allpages&metadata=no -WAIT: 2000 - -; get 4th page of the search result -REQ: /OData.svc/Root/Sites/Default_Site?$top=10&$skip=30&query=demo&$inlinecount=allpages&metadata=no -WAIT: 2000 - -; browse one of the result content -REQ: /OData.svc/infos/features('kpiworkspacesinfo') -WAIT: 8000 -``` - -For a more complex example please check the Editor profile provided by us in the source directory. If you want to create a custom profile, put those text files in the *Profiles* folder next to the tool. See the language details in the following section. - -## Benchmark Profile Definition Language - -The Profile Definition is a text file that describes an action sequence. Possible actions: sending a web request, memorizing data from the response as a variable, waiting for a couple of seconds. - -At the beginnig of the line there is a *control character or word* that defines the purpose of that line. Empty lines and lines starting with an unrecognized control word will be skipped. - -### Comment -If the line starts with a semicolon character (;) the line will be skipped. -```text -; PROFILE DESCRIPTION: Small content editor task -``` -There is only line comment, it is not possible to write an inline comment. - -### WAIT -The profile execution will be suspended for a time. Parameter value is defined in milliseconds. -```text -WAIT: 2000 -``` -This causes a 2 seconds async pause. - -### REQ -Describes a web request. Two parameters are allowed: *http verb* and *url** -- HTTP verb: GET, POST, DELETE and so on. If the verb is missing, the *default is GET*. -- URL: absolute url without the protocol and domain. Must start with a slash (/). -```text -; Default main page GET request -REQ: / -; Subpage html request -REQ: GET /workspaces -; OData request -REQ: DELETE /odata.svc/content(1234) -``` - -There are a couple of extensions to the request line above. They can be written as separate lines after a request line. The following keywords can be used: *DATA, SPEED, VAR* - -#### DATA -There are many OData requests that require some data in the request stream. This is how you define a post data. -```text -; Create a new memo -REQ: POST /OData.svc/workspaces/Project/madridprojectworkspace/Memos -DATA: models=[{"__ContentType":"Memo","Description":"asdf qwer"}] -``` - -#### SPEED -Defines the *speed category* of the current request. Optional, default is "NORMAL". Category name is case insensitive. Categories are defined when you execute the benchmark tool (see parameters above). Requests that are put into a certain category will be taken into account when we compare the average response times to category limits. -```text -SPEED: Slow -``` - -#### VAR -There is a simple way to memorize and reuse data from an OData response: you can define a variable that will hold a value extracted from the response object. This is useful when you are working with dynamic content items and values that you do not know at the time when you create the script. - -Response object reference id *"@Response"*. - -Variable names must start with the *'@'* character. Only a property path is allowed on the right side, expressions are forbidden. -```text -VAR: @Name = @Response.d.Name -``` - -### Templating: using variables -In request urls or data it is possible to mark places for substitution with variables defined earlier. - -Placeholder format: *<< variablename >>*. - -```text -; Create a new memo and memorize its name (generated by the server) -REQ: POST /OData.svc/workspaces/Project/madridprojectworkspace/Memos -DATA: models=[{"__ContentType":"Memo","Description":"asdf qwer"}] -VAR: @Name = @Response.d.Name - -; 5 seconds pause -WAIT: 5000 - -; Modify a field of the created content -REQ: PATCH /OData.svc/workspaces/Project/madridprojectworkspace/Memos('<<@Name>>') -DATA: models=[{"Description":"description of <<@Name>>"}] -``` - -## Resources - -The SnBenchmark tool itself does not consume too much resources. It is written as a completely asynchronous tool, you can start it on an average machine. - -You should pay attention to the generated log files though: after a few iterations the csv or error files may consume a significant amout of disk space. - -## Hardware - -The hardware your site runs on is important from the measurement's point of view. It does not make sense to compare two performance measurements made on a different hardware - unless you want to measure the performance of the hardware which is usually not the case. \ No newline at end of file diff --git a/src/SnBenchmark/SnBenchmark.csproj b/src/SnBenchmark/SnBenchmark.csproj index 4a9cfb9..f8319af 100644 --- a/src/SnBenchmark/SnBenchmark.csproj +++ b/src/SnBenchmark/SnBenchmark.csproj @@ -41,15 +41,17 @@ false - - False - ..\references\Newtonsoft.Json.dll + + ..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll + True - - ..\references\SenseNet.Client.dll + + ..\packages\SenseNet.Client.1.1.0.0\lib\net45\SenseNet.Client.dll + True - - ..\references\SenseNet.Tools.dll + + ..\packages\SenseNet.Tools.2.1.0.0\lib\net45\SenseNet.Tools.dll + True @@ -78,7 +80,7 @@ - + diff --git a/src/SnBenchmark/packages.config b/src/SnBenchmark/packages.config new file mode 100644 index 0000000..66a6ef4 --- /dev/null +++ b/src/SnBenchmark/packages.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/src/SnBenchmarkTest/SnBenchmarkTest.csproj b/src/SnBenchmarkTest/SnBenchmarkTest.csproj index 89c19df..ab3d5ba 100644 --- a/src/SnBenchmarkTest/SnBenchmarkTest.csproj +++ b/src/SnBenchmarkTest/SnBenchmarkTest.csproj @@ -39,8 +39,9 @@ 4 - - ..\references\SenseNet.Tools.dll + + ..\packages\SenseNet.Tools.2.1.0.0\lib\net45\SenseNet.Tools.dll + True @@ -66,6 +67,9 @@ SnBenchmark + + + diff --git a/src/SnBenchmarkTest/packages.config b/src/SnBenchmarkTest/packages.config new file mode 100644 index 0000000..c8b46e0 --- /dev/null +++ b/src/SnBenchmarkTest/packages.config @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/src/references/Newtonsoft.Json.xml b/src/references/Newtonsoft.Json.xml deleted file mode 100644 index 4ecec60..0000000 --- a/src/references/Newtonsoft.Json.xml +++ /dev/null @@ -1,8777 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Initializes a new instance of the class. - - The Oid value. - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Initializes a new instance of the class with the specified . - - - - - Reads the next JSON token from the stream. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a []. - - A [] or a null reference 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 stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the state based on current token type. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the to Closed. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the underlying stream or - should be closed when the reader is closed. - - - true to close the underlying stream or when - the reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Get or set how time zones are handling when reading JSON. - - - - - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Get or set how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets The Common Language Runtime (CLR) type for 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 or sets the culture used when reading JSON. Defaults to . - - - - - Specifies the state of the reader. - - - - - The Read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The Close method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Initializes a new instance of the class. - - The stream. - - - - Initializes a new instance of the class. - - The reader. - - - - Initializes a new instance of the class. - - The stream. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The reader. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the stream as a []. - - - A [] or a null reference 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 stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - - A . This method will return null at the end of an array. - - - - - Reads the next JSON token from the stream. - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the to Closed. - - - - - Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Creates an instance of the JsonWriter class. - - - - - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. - - - - - Closes this stream and the underlying stream. - - - - - 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 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 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 . - A null value can be passed to the method for token's 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 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. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes out a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes out the given white space. - - The string of white space characters. - - - - Sets the state of the JsonWriter, - - The JsonToken being written. - The value being written. - - - - Gets or sets a value indicating whether the underlying stream or - should be closed when the writer is closed. - - - true to close the underlying stream or when - the 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. - - - - - Indicates how JSON text output is formatted. - - - - - Get or set how dates are written to JSON text. - - - - - Get or set how time zones are handling when writing JSON text. - - - - - Get or set how strings are escaped when writing JSON text. - - - - - Get or set how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Get or set how and values are formatting when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - The stream. - - - - Initializes a new instance of the class. - - The writer. - - - - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes out a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - 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 the beginning of a Json array. - - - - - Writes the beginning of a Json object. - - - - - Writes the property name of a name/value pair on a Json object. - - The name of the property. - - - - Closes this stream and the underlying stream. - - - - - 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 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. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to single paramatized constructor, then the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a paramatized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets the of the JSON produced by the JsonConverter. - - The of the JSON produced by the JsonConverter. - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Create a custom object - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework EntityKey to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an ExpandoObject to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Converts a to and from a JavaScript date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Initializes a new instance of the class. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets a value indicating whether integer values are allowed. - - true if integers are allowed; otherwise, false. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the attributeName is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - True if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements. - - The name of the deserialize root element. - - - - 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. - - true if the array attibute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - Specifies default value handling options for the . - - - - - - - - - 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. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that is is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and sets members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if LineNumber and LinePosition can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, HasLineInfo returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, HasLineInfo returns false). - - - - Instructs the how to serialize the collection. - - - - - Instructs the how to serialize the object. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the JsonConverter described by ItemConverterType. - If null, the default constructor is used. - When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, - order, and type of these parameters. - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Provides methods for converting between common language runtime types and JSON types. - - - - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output is formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output is formatted. - A collection converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - A JSON string representation of the object. - - - - - Asynchronously serializes the specified object to a JSON string. - Serialization will happen on a new thread. - - The object to serialize. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - - - - - Asynchronously serializes the specified object to a JSON string using formatting. - Serialization will happen on a new thread. - - The object to serialize. - Indicates how the output is formatted. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - - - - - Asynchronously serializes the specified object to a JSON string using formatting and a collection of . - Serialization will happen on a new thread. - - The object to serialize. - Indicates how the output is formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be infered from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be infered from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Asynchronously deserializes the JSON to the specified .NET type. - Deserialization will happen on a new thread. - - The type of the object to deserialize to. - The JSON to deserialize. - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - - - - - Asynchronously deserializes the JSON to the specified .NET type using . - Deserialization will happen on a new thread. - - The type of the object to deserialize to. - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - - - - - Asynchronously deserializes the JSON to the specified .NET type. - Deserialization will happen on a new thread. - - The JSON to deserialize. - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - - - - - Asynchronously deserializes the JSON to the specified .NET type using . - Deserialization will happen on a new thread. - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. - - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Asynchronously populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - A task that represents the asynchronous populate operation. - - - - - Serializes the XML node to a JSON string. - - The node to serialize. - A JSON string of the XmlNode. - - - - Serializes the XML node to a JSON string using formatting. - - The node to serialize. - Indicates how the output is formatted. - A JSON string of the XmlNode. - - - - Serializes the XML node to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output is formatted. - Omits writing the root object. - A JSON string of the XmlNode. - - - - Deserializes the XmlNode from a JSON string. - - The JSON string. - The deserialized XmlNode - - - - Deserializes the XmlNode from a JSON string nested in a root elment specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized XmlNode - - - - Deserializes the XmlNode from a JSON string nested in a root elment specified by - and writes a .NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - 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. - - The deserialized XmlNode - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the XNode. - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output is formatted. - A JSON string of the XNode. - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output is formatted. - Omits writing the root object. - A JSON string of the XNode. - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized XNode - - - - Deserializes the from a JSON string nested in a root elment specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized XNode - - - - Deserializes the from a JSON string nested in a root elment specified by - and writes a .NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - 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. - - The deserialized XNode - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Initializes a new instance of the class. - - Type of the converter. - - - - Initializes a new instance of the class. - - Type of the converter. - Parameter list to use when constructing the JsonConverter. Can be null. - - - - Gets the type of the converter. - - The type of the converter. - - - - The parameter list to use when constructing the JsonConverter described by ConverterType. - If null, the default constructor is used. - - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during Json serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with 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 a null reference (Nothing in Visual Basic) 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). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Instructs the how to serialize the object. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Gets or sets the member serialization. - - The member 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. - - - - - Instructs the to always serialize the member with the specified name. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - The parameter list to use when constructing the JsonConverter described by ItemConverterType. - If null, the default constructor is used. - When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number, - order, and type of these parameters. - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization and deserialization of a member. - - The numeric order of serialization or deserialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - 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. - - - - The exception thrown when an error occurs while reading Json text. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with 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 a null reference (Nothing in Visual Basic) 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). - - - - 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. - - - - The exception thrown when an error occurs during Json serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with 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 a null reference (Nothing in Visual Basic) 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). - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings. - - - A new instance. - The will not use default settings. - - - - - Creates a new instance using the specified . - The will not use default settings. - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings. - - - - - Creates a new instance. - The will use default settings. - - - A new instance. - The will use default settings. - - - - - Creates a new instance using the specified . - The will use default settings. - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings. - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to reader values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to reader values from. - The target object to populate values onto. - - - - Deserializes the Json structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the Json structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the Json structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the Json structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the Json structure - to a Stream using the specified . - - The used to write the Json structure. - The to serialize. - - - - Serializes the specified and writes the Json structure - to a Stream using the specified . - - The used to write the Json structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - - - Serializes the specified and writes the Json structure - to a Stream using the specified . - - The used to write the Json structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifing the type is optional. - - - - - Serializes the specified and writes the Json structure - to a Stream using the specified . - - The used to write the Json structure. - The to serialize. - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - - - - - Get or set how reference loops (e.g. a class referencing itself) is handled. - - - - - Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - - - - - Get or set how null values are handled during serialization and deserialization. - - - - - Get or set how null default are handled during serialization and deserialization. - - - - - Gets or sets how objects are created during deserialization. - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - - - - - Get or set how dates are written to JSON text. - - - - - Get or set how time zones are handling during serialization and deserialization. - - - - - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Get or set how special floating point numbers, e.g. , - and , - are written as JSON text. - - - - - Get or set how strings are escaped when writing JSON text. - - - - - Get or set how and values are formatting when writing JSON text. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Specifies the settings on a object. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - - Null value handling. - - - - Gets or sets how null default are handled during serialization and deserialization. - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Get or set how and values are formatting when writing JSON text. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Indicates how JSON text output is formatted. - - - - - Get or set how dates are written to JSON text. - - - - - Get or set how time zones are handling during serialization and deserialization. - - - - - Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Get or set how special floating point numbers, e.g. , - and , - are written as JSON. - - - - - Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Get or set how strings are escaped when writing JSON text. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Initializes a new instance of the class with the specified . - - The TextReader containing the XML data to read. - - - - Reads the next JSON token from the stream. - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the stream as a []. - - - A [] or a null reference 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 stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Changes the state to closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if LineNumber and LinePosition can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, HasLineInfo returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, HasLineInfo returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Creates an instance of the JsonWriter class using the specified . - - The TextWriter to write to. - - - - Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. - - - - - Closes this stream and the underlying stream. - - - - - 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 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 out a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes out the given white space. - - The string of white space characters. - - - - Gets or sets how many IndentChars to write for each level in the hierarchy when is set to Formatting.Indented. - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to Formatting.Indented. - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Specifies the type of Json token. - - - - - This is returned by the if a 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. - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Reads the next JSON token from the stream as a . - - A . - - - - Reads the next JSON token from the stream as a []. - - - A [] or a null reference if the next JSON token is null. - - - - - Reads the next JSON token from the stream as a . - - A . - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . - - - - Reads the next JSON token from the stream. - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - 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 Common Language Runtime (CLR) type for the current JSON token. - - - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - The exception thrown when an error occurs while reading Json text. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with 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 a null reference (Nothing in Visual Basic) 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). - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - 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 with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Represents a token that can contain other tokens. - - - - - Represents an abstract JSON token. - - - - - 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. - - - - 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 converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - 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 is formatted. - A collection of 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 . - - 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 . - - 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 . - - 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 . - - 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 . - - 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 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 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 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 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. - - - - Creates an for this token. - - An 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 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 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 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 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 . - - An positioned at the token to read into this . - - An that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by 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. - - - - Creates a from a . - - An positioned at the token to read into this . - - An that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by 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 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 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. - - - - 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. - - - - - 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. - - - - - Gets the with the specified key. - - The with the specified key. - - - - 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 . - - - - 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. - - - - 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 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 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 an that can be used to add tokens to the . - - An that is ready to have content written to it. - - - - Replaces the children 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. - - - - 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. - - - - 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 . - - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens - - - - 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 . - - - - Load a from a string that contains JSON. - - A that contains JSON. - 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. - - - - 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 . - The is read-only. - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - The is read-only. - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - The is read-only. - - - - Removes all items from the . - - The is read-only. - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies to. - - The array. - Index of the array. - - - - 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 . - - The is read-only. - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Represents a JSON constructor. - - - - - 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. - - - - 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 . - - - - 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. - - - - Gets the with the specified key. - - The with the specified key. - - - - 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 iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - 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. - - - - - Gets the with the specified key. - - - - - - Represents a JSON object. - - - - - - - - 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 an of this object's properties. - - An of this object's properties. - - - - Gets a the specified name. - - The property name. - A with the specified name or null. - - - - Gets an of this object's property values. - - An of this object's property values. - - - - 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 . - - - - Load a from a string that contains JSON. - - A that contains JSON. - 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 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 then - the 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 then - the 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 the get value. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that iterates 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 properties for this instance of a component. - - - A that represents the properties for this component instance. - - - - - Returns the properties for this instance of a component using the attribute array as a filter. - - An array of type that is used as a filter. - - A that represents the filtered properties for this component instance. - - - - - Returns a collection of custom attributes for this instance of a component. - - - An containing the attributes for this object. - - - - - Returns the class name of this instance of a component. - - - The class name of the object, or null if the class does not have a name. - - - - - Returns the name of this instance of a component. - - - The name of the object, or null if the object does not have a name. - - - - - Returns a type converter for this instance of a component. - - - A that is the converter for this object, or null if there is no for this object. - - - - - Returns the default event for this instance of a component. - - - An that represents the default event for this object, or null if this object does not have events. - - - - - Returns the default property for this instance of a component. - - - A that represents the default property for this object, or null if this object does not have properties. - - - - - Returns an editor of the specified type for this instance of a component. - - A that represents the editor for this object. - - An of the specified type that is the editor for this object, or null if the editor cannot be found. - - - - - Returns the events for this instance of a component using the specified attribute array as a filter. - - An array of type that is used as a filter. - - An that represents the filtered events for this component instance. - - - - - Returns the events for this instance of a component. - - - An that represents the events for this component instance. - - - - - Returns an object that contains the property described by the specified property descriptor. - - A that represents the property whose owner is to be found. - - An that represents the owner of the specified property. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Gets the node type for this . - - The type. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Specifies the settings used when merging JSON. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Represents a JSON property. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - 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 an from a . - - A that will be read for the content of the . - 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. - - - - Gets the node type for this . - - The type. - - - - 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 a raw JSON string. - - - - - Represents a value in JSON (string, integer, date, etc). - - - - - 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. - - - - 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 null value. - - A null value. - - - - Writes this token to a . - - A into which this method will write. - A collection of 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. - - - The parameter is null. - - - - - 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: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not the same type as this instance. - - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - 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. - - - - 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. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Reads the next JSON token from the stream as a []. - - - A [] or a null reference 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 stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the stream. - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the at the reader's current position. - - - - - 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. - - - - - 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 streams and also flushes the underlying stream. - - - - - Closes this stream and the underlying stream. - - - - - 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 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 out 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. - - - - Gets the at the writer's current position. - - - - - Gets the token being writen. - - The token being writen. - - - - 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 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 must be 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 ISerializable. - - - - - - - - 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. - - - - - Contains the JSON schema extension methods. - - - - - Determines whether the is valid. - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - Determines whether the is valid. - - 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 . - - The source to test. - The schema to test with. - - - - Validates the specified . - - The source to test. - The schema to test with. - The validation event handler. - - - - An in-memory representation of a JSON Schema. - - - - - 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 schema JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Parses the specified json. - - The json. - The resolver. - A populated from the string that contains JSON. - - - - 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 . - - - - - 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 divisble by. - - A number that the value should be divisble 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 disallow 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. - - - - Returns detailed information about the schema exception. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with 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 a null reference (Nothing in Visual Basic) 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). - - - - 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. - - - - Generates a from a specified . - - - - - 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. - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Resolves from an id. - - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - The value types allowed by the . - - - - - 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 . - - - - - 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 . - - - - - 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 . - - - - - Resolves member mappings for a type, camel casing property names. - - - - - Used by to resolves a for a given . - - - - - Used by to resolves a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - If set to true the will use a cached shared with other resolvers of the same type. - Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only - happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different - results. When set to false it is highly recommended to reuse instances with the . - - - - - 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. - Name of the property. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - 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. - - - - - Initializes a new instance of the class. - - - - - Resolves the name of the property. - - Name of the property. - The property name camel cased. - - - - 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 - - - - Gets the reference for the sepecified 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. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - 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. - - - - - Represents a trace 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. - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error 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. - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Get and set values for a using dynamic methods. - - - - - 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. - - - - 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. - - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - 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. - - - - 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. - - - - Contract details for a used by the . - - - - - Contract details for a used by the . - - - - - 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 method called immediately after deserialization of the object. - - The method called immediately after deserialization of the object. - - - - Gets or sets the method called during deserialization of the object. - - The method called during deserialization of the object. - - - - Gets or sets the method called after serialization of the object graph. - - The method called after serialization of the object graph. - - - - Gets or sets the method called before serialization of the object. - - The method called before serialization of the object. - - - - Gets or sets the method called when an error is thrown during the serialization of the object. - - The method 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. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - 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. - - - - 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. - - - - 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 . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Gets or sets the ISerializable object constructor. - - The ISerializable object constructor. - - - - 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 . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - 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 the constructor parameters required for any non-default constructor - - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the override constructor used to create the object. - This is set when a constructor is marked up using the - JsonConstructor attribute. - - The override constructor. - - - - Gets or sets the parametrized constructor used to create the object. - - The parametrized constructor. - - - - 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. - - - - - 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. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - 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 and deserialization of a member. - - The numeric order of serialization or deserialization. - - - - 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 presidence 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 serialize. - - A predicate used to determine whether the property should be serialize. - - - - 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. - - - - 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 the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the 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 propertyName and then - a 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 JsonConverter type described by the argument. - - The JsonConverter type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - Create a factory function that can be used to create instances of a JsonConverter described by the - argument type. The returned function can then be used to either invoke the converter's default ctor, or any - parameterized constructors by way of an object array. - - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - 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. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of Info will exclude Verbose messages and include Info, - Warning and Error messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - 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. - - - - - 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. - - - - 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 . - - - - - 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. - - - - - 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 IList. - - The list to add to. - The collection of elements to add. - - - - Returns the index of the first occurrence in a sequence by using a specified IEqualityComparer. - - The type of the elements of source. - A sequence in which to locate a value. - The object to locate in the sequence - An equality comparer to compare values. - The zero-based index of the first occurrence of value within the entire sequence, if found; otherwise, –1. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value 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 value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Gets a dictionary of the names and values of an Enum 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 StringBuilder this class lets you reuse it's 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. - - - - - Nulls an empty string. - - The string. - Null if the string was null, otherwise the string unchanged. - - - - 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 results in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - A array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - diff --git a/src/references/SenseNet.Client.XML b/src/references/SenseNet.Client.XML deleted file mode 100644 index b1e615b..0000000 --- a/src/references/SenseNet.Client.XML +++ /dev/null @@ -1,1528 +0,0 @@ - - - - SenseNet.Client - - - - - Holds globally available context properties (e.g. username, urls, etc.). Please fill the - properties of the ClientContext.Current singleton instance. - - - - - A singleton client context instance. Use this for every context-related - operation (e.g. setting the upload chunk size) after initializing the context. - - - - - Initializes the global context instance. You have to call this method - before using the client context. - - - - - - The available servers that can be a target of client operations. - - - - - One of the configured servers, chosen randomly. - - - - - Number of bytes sent to the server in one chunk during upload operations. Default: 10 MB. - - - - - The exception that is thrown when an error occurs during any of the - client operations. It contains organized information about the error - parsed from the response. - - - - - Parsed OData error details from the exception thrown on the server. - - - - - Initializes a new instance of the ClientException class. - - - - - Initializes a new instance of the ClientException class. - - - - - The HTTP error status code of the response. - - - - - Raw response text. - - - - - Represents the properties of the exception thrown by the server. - - - - - SenseNet OData-specific code of the error. - - - - - HTTP status code parsed from the error response. This is a technical - property, check the ClientException.StatusCode property instead. - - - - - .Net type name of the exception thrown on the server. - - - - - Human readable error message information. - - - - - Stack trace information from the server. - - - - - Human readable error message information parsed from the response. - - - - - Language code of the text in the Value property. - - - - - Human readable error message. - - - - - Server code stack trace information about the exception. - - - - - Server code stack trace text. - - - - - Helper class for parsing the error response. - - - - - Central class for all content-related client operations. It contains predefined content - properties and can be extended with custom fields as it is a dynamic type. - - - - - Content id. - - - - - Id of the parent content. - - - - - Content path. - - - - - Path of the parent content if available. - - - - - Content name. - - - - - The target server that this content belongs to. - - - - - Internal constructor for client content. - - Target server. If null, the first one will be used from the configuration. - - - - Internal constructor for client content. - - Target server. If null, the first one will be used from the configuration. - A JSON response that contains content fields. - - - - Creates a new in-memory local representation of an existing content without loading it from the server. - - Content id. - Target server. - - - - Creates a new in-memory local representation of an existing content without loading it from the server. - - Content path. - Target server. - - - - Creates a new content in memory without saving it. - - Parent content path in the Content Repository. - Content type name. - Name of the new content. - Content template path. - Target server. - - - - Creates a new specialized content in memory without saving it. - - One of the specialized client content types inheriting from Content (e.g. Group). - Parent content path in the Content Repository. - Content type name. - Name of the new content. - Content template path. - Target server. - - - - Loads a content from the server. - - Content id. - Target server. - - - - Loads a content from the server. - - Content path. - Target server. - - - - Loads a content from the server. Use this method to specify a detailed - content request, for example wich fields you want to expand or select. - - Detailed information that will be sent as part of the request. - Target server. - - - - Checks whether a content exists on the server with the provided path. - - Content path. - Target server. - - - - Loads children of a container. - - Path of the container. - Target server. - - - - - Queries the server for content items using the provided request data. - - Detailed information that will be sent as part of the request. - For example Top, Skip, Select, etc. - Target server. - - - - Loads referenced content from a reference field. - - Content id. - Reference field name. - Field names of the referenced content items to select. - Target server. - - - - Loads referenced content from a reference field. - - Content path. - Reference field name. - Field names of the referenced content items to select. - Target server. - - - - Executes a count-only query in a subfolder on the server. - - Content path. - Content query text. If it is empty, the count of children will be returned. - Target server. - Count of result content. - - - - Executes a query on the server and returns results filtered and expanded - based on the provided parameters. Both lifespan and system content filters - are disabled. - - Content query text. - Fields to select. - Fields to expand. - Query settings. - Target server. - - - - Executes a query on the server and returns results filtered and expanded - based on the provided parameters. - - Content query text. - Fields to select. - Fields to expand. - Query settings. - Target server. - - - - Uploads a file to the server into the provided container. - - Parent path. - Name of the file to upload. - File contents. - Content type of the file. - Name of the field to upload to. Default is Binary. - Target server. - An optional callback method that is called after each chunk is uploaded to the server. - The uploaded file content returned at the end of the upload request. - - - - Uploads a file to the server into the provided container. - - Parent id. - Name of the file to upload. - File contents. - Content type of the file. Default is determined by the container. - Name of the field to upload to. Default is Binary. - Target server. - An optional callback method that is called after each chunk is uploaded to the server. - The uploaded file content returned at the end of the upload request. - - - - Uploads a file or a custom binary property of a content in the provided container. - - Parent path. - Name of the content to create or update. - Full length of the binary data. - An action that is called between the initial and the finalizer requests. - Use this to actually save the binary through the blob storage component. - Parameters: contentId, versionId, token - Content type of the new content. Default is determined by the allowed child types in the container. - Binary file name. Default is the content name. - Binary field name. Default is "Binary". - Target server. - - - - Uploads a file or a custom binary property of a content in the provided container. - - Parent id. - Name of the content to create or update. - Full length of the binary data. - An action that is called between the initial and the finalizer requests. - Use this to actually save the binary through the blob storage component. - Parameters: contentId, versionId, token - Content type of the new content. Default is determined by the allowed child types in the container. - Binary file name. Default is the content name. - Binary field name. Default is "Binary". - Target server. - - - - Gets a blob storage token that identifies a binary in the storage. - - Content id. - Content version (e.g. V2.3D). If not provided, the highest version - accessible to the current user will be served. - Binary field name. Default is Binary. - Target server. - A token that can be used with the Blob storage API. - - - - Gets a blob storage token that identifies a binary in the storage. - - Content path. - Content version (e.g. V2.3D). If not provided, the highest version - accessible to the current user will be served. - Binary field name. Default is Binary. - Target server. - A token that can be used with the Blob storage API. - - - - Saves the content to the server. - - - - - Deletes the content. - - Delete the content permanently or into the Trash. - - - - Moves the content to the target location. - - Target path. - - - - Creates a copy of the content to the target location. - - Target path. - - - - Locks the content for the current user. - - - - - Check in the content. - - - - - Undo all modifications on the content since the last checkout operation. - - - - - Checks whether a user has the provided permissions on the content. - - Permission names to check. - The user who's permissions need to be checked. If it is not provided, the server checks the current user. - Target server. - - - - Breaks permissions on the content. - - Target server. - - - - Removes permission break on the content. - - Target server. - - - - Gets a dynamic property value, for example value of a content field (DynamicObject implementation). - - Property binder definition. - Field value if found. - Whether the field value was found or not. - - - - Sets a dynamic property value, for example value of a content field (DynamicObject implementation). - - Property binder definition. - Field value to set. - This operation is always succesful. - - - - Calls a dynamic method on a content. It will be resolved into an asynchronous OData action request (DynamicObject implementation). - - Method binder definition. - Method arguments provided by the caller. - An awaitable Task<dynamic> object containing the response of the action request. - Aleays true. - - - - Gets or sets a content field value. If the value has been set locally, it returns that. - Otherwise it checks the fields returned from the server. - - Name of the field. - The field value if found, otherwise null. - - - - Offers extension methods for client Content operations. - - - - - Converts a dynamic collection to a collection of client Content. - - List of dynamic items (e.g a reference field value in a content JSON) that can be coverted to Content items. - Optional server argument for content items. - - - - Converts a JArray to a collection of client Content. - - Array of JTokens (e.g a reference field value in a content JSON) that can be coverted to Content items. - Optional server argument for content items. - - - - Obsolete file system enumerator class. For importing documents please use the Importer class instead. - - - - - Specialized client content for handling group-related operations. - - - - - Initializes an instance of a Group. - - - - - - Adds members to a group. - - Group id. - Ids of members to add to the group. - Target server. - - - - Removes members from a group. - - Group id. - Ids of members to remove from the group. - Target server. - - - - Adds members to a group. - - Ids of members to add to the group. - - - - Removes members from a group. - - Ids of members to remove from the group. - - - - Available algorithms for importing files and folders from the file system. - - - - - Uses a ConcurrentQueue for managing the subfolders to process next. - - - - - Uses a ConcurrentStack for managing the subfolders to process next. - - - - - Options for customizing the import behavior. - - - - - Determines how many concurrent operations (e.g. file uploads or - folder creations) may occur at the same time. Default is 5. - 1 means sequential processing. - - - - - Processing order of folders. - - - - - Whether to upload all files to the root folder. Default is false; - - - - - Determines the algorithm used for importing files and folders, affecting the order of creation. - - - - - Whether the importer should overwrite existing files or not. Default is True. - - - - - Search pattern for files. Default is "*" - - - - - Search pattern for folders. Default is "*" - - - - - Optional content type name for folder content (e.g. MyCustomFolder). - The importer will use this type when creating folders. - - - - - Optional content type name for files (e.g. MyCustomFile). - The importer will use this type when uploading files. - - - - - Called after creating a folder. - - - - - Called after uploading a file. - - - - - Creates a new instance of ImportOptions for configuring the import behavior. - - - - - Provides an API for importing files and folders from the file system. - - - - - Imports files and folders from the file system to the content repository through its REST API. - - File system path (folder or file) to import. - Content Repository path to import to. - Import options. - - - - Provides helper methods for JSON operations. - - - - - Default serializer settings with ISO date format and None as type name handling option. - - - - - Serializes the specified object as a JSON string. - - The object to serialize. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a dynamic JObject. - - The JSON to deserialize. - A dynamic JObject deserialized from the JSON string. - - - - Serializes a .NET object to JSON and wraps it into a 'models=[...]' array - that can be sent to the OData REST API. - - A .NET object to serialize. - - - - Expected format of the OData response. - - - - - No metadata. - - - - - Only a self url and a content type is returned. - - - - - Contains the self url, content type and all available actions and functions. - - - - - Values for enabling or disabling content query filters. - - - - - Default (actual value depends on the server). - - - - - The filter is enabled. - - - - - The filter is disabled. - - - - - Encapsulates all parameters that an OData REST API request can handle. Use it - for constructing advanced OData requests. - - - - - Content path that will be the base of the OData request if the Content id is not provided. - - - - - Content id that will be the base of the OData request. - - - - - Site URL that represents the server to send the request to. - - - - - Content field or property name. - - - - - Action name. - - - - - Version request parameter. - - - - - Top query parameter. - - - - - Skip query parameter. - - - - - Count only query parameter. - - - - - List of selectable fields. - - - - - List of expandable fields. - - - - - Whether this is a request that targets a single OData resource or a collection. - - - - - Format of the requested metadata information. Default is None. - - - - - Custom URL parameters. - - - - - Initializes an instance of the ODataRequest class. - - - - - Compiles the properties of the request to a single URI string. - - - - - Compiles the properties of the request to a single URI. - - - - - Creates the first path of the url, without properties and parameters - - - - - Encapsulates select and the corresponding expand parameters for an OData request. Use a property - path list to initialize a Projection. A single property path is like 'Members.Manager.Address'. - - - - - Initializes a new instance of the Projection class. - - List of property paths. A single path is like 'asdf.qwer.yxcv'. - - - - Represents Content Query settings in an OData request. - - - - - Top query parameter. - - - - - Skip query parameter. - - - - - Enable autofilters query parameter. - - - - - Enable lifespan filter query parameter. - - - - - Creates query settings with filters switched off. - - - - - - Client side helper methods for Content Repository paths. - - - - - Separator character in paths. - - - - - Gets the content name (the last segment) from a Content Repository path. - - Content Repository path. - - - - Gets the parent path from a Content Repository path. - - Content Repository path. - - - - Combines two Content Repository path segments. - - Left segment. - Right segment. - - - - Determines whether a character is allowed in a content name or not. - - A character to check. - - - - Predefined HTTP methods to be used in OData requests. - - - - - PATCH method. - - - - - POST method. - - - - - Sends HTTP requests to the SenseNet OData REST API. - - - - - Loads a content from the server. - - Content id. - Target server. - - - - Loads a content from the server. - - Content path. - Target server. - - - - Loads a content from the server. - - OData request parameters, for example select or expand. - Target server. - - - - Loads children of a container. - - Content path. - Target server. - - - - Queries the server for content items using the provided request data. - - OData request parameters, for example select or expand. - Target server. - - - - Executes a count-only query on the server. - - OData request parameters, most importantly the query. - Target server. - - - - Gets the raw response of an OData single content request from the server. - - Content id. - Action name. - HTTP method (SenseNet.Client.HttpMethods class has a few predefined methods). - Request body. - Target server. - Raw HTTP response. - - - - Gets the raw response of an OData single content request from the server. - - Content path. - Action name. - HTTP method (SenseNet.Client.HttpMethods class has a few predefined methods). - Request body. - Target server. - Raw HTTP response. - - - - Gets the raw response of a general HTTP request from the server. - - Request URI. - HTTP method (SenseNet.Client.HttpMethods class has a few predefined methods). - Request body. - Target server. - Raw HTTP response. - - - - Gets the response of an OData request as a dynamic JSON object. - - OData request parameters, for example select or expand. - Target server. - Http method (e.g. Post). Default is Get. - An object containing properties to be sent in the body. It will be serialized to JSON. - A dynamic JSON object deserialized from the response. - - - - Assembles an http request that gets a stream from the portal containing binary data. - Use this inside a using block to asynchronously get the response stream. - Please catch WebExceptions and parse them using the GetClientExceptionAsync method. - - Content id. - Content version (e.g. V2.3D). If not provided, the highest version - accessible to the current user will be served. - Binary field name. Default is Binary. - Target server. - - - - Sends a POST OData request to the server containing the specified data. - - Content Repository path to send the response to. - A .NET object to serialize as post data. - Target server. - A deserialized dynamic JSON object parsed from the response. - - - - Sends a PATCH OData request to the server containing the specified data. - - Content id - A .NET object to serialize as post data. - Target server. - A deserialized dynamic JSON object parsed from the response. - - - - Sends a PATCH OData request to the server containing the specified data. - - Content path - A .NET object to serialize as post data. - Target server. - A deserialized dynamic JSON object parsed from the response. - - - - Sends a PUT OData request to the server containing the specified data. - - Content path - A .NET object to serialize as post data. - Target server. - A deserialized dynamic JSON object parsed from the response. - - - - Uploads a file to the server into the provided container. - - File contents. - Upload parameters. - Parent id. - Target server. - An optional callback method that is called after each chunk is uploaded to the server. - The uploaded file content returned at the end of the upload request. - - - - Uploads a file to the server into the provided container. - - File contents. - Upload parameters. - Parent path. - Target server. - An optional callback method that is called after each chunk is uploaded to the server. - The uploaded file content returned at the end of the upload request. - - - - Parses an error response and wraps all the information in it into a ClientException. - - Original web exception. - Request url that caused the web exception. - Http method (e.g GET or POST) - Request body. - A client exception that contains parsed server info (e.g. OData exception type, - status code, original response text, etc.) and the original exception as an inner exception. - - - - Appends a key=value pair to a string with the '&' character as a separator. - - - - - Permission names needed by the permission client API (e.g. the HasPermission method). - - - - - Static API for permission-related operations. - - - - - Sets the provided permissions on the provided content. - - Id of a content. - Permission settings to be sent to the server. - Target server. - - - - Checks whether a user has the provided permissions on the provided content. - - Id of a content. - Permission names to check. - The user who's permissions need to be checked. If it is not provided, the server checks the current user. - Target server. - - - - Breaks permissions on the provided content. - - Id of a content. - Target server. - - - - Removes permission break on the provided content. - - Id of a content. - Target server. - - - - Represents the possible values of permissions. - - - - - Not defined. - - - - - Allow this permission. - - - - - Deny this permission. - - - - - Represents the data that is sent to the server during a permission request. Fill only - the permission values that you want to set or change. - - - - - Id or Path of a user, group or organizational unit. - - - - - Whether this permission is local only or inheritable. - - - - - See permission. - - - - - Preview permission. - - - - - PreviewWithoutWatermark permission. - - - - - PreviewWithoutRedaction permission. - - - - - Open permission. - - - - - OpenMinor permission. - - - - - Save permission. - - - - - Publish permission. - - - - - ForceCheckin permission. - - - - - AddNew permission. - - - - - Approve permission. - - - - - Delete permission. - - - - - RecallOldVersion permission. - - - - - DeleteOldVersion permission. - - - - - SeePermissions permission. - - - - - SetPermissions permission. - - - - - RunApplication permission. - - - - - ManageListsAndWorkspaces permission. - - - - - Custom01 permission. - - - - - Custom02 permission. - - - - - Custom03 permission. - - - - - Custom04 permission. - - - - - Custom05 permission. - - - - - Custom06 permission. - - - - - Custom07 permission. - - - - - Custom08 permission. - - - - - Custom09 permission. - - - - - Custom10 permission. - - - - - Custom11 permission. - - - - - Custom12 permission. - - - - - Custom13 permission. - - - - - Custom14 permission. - - - - - Custom15 permission. - - - - - Custom16 permission. - - - - - Custom17 permission. - - - - - Custom18 permission. - - - - - Custom19 permission. - - - - - Custom20permission. - - - - - Custom21 permission. - - - - - Custom22 permission. - - - - - Custom23 permission. - - - - - Custom24 permission. - - - - - Custom25 permission. - - - - - Custom26 permission. - - - - - Custom27 permission. - - - - - Custom28 permission. - - - - - Custom29 permission. - - - - - Custom30 permission. - - - - - Custom31 permission. - - - - - Custom32 permission. - - - - - Creates a copy of this permission request object. - - - - - - Represents a connection to a server. - - - - - Username used for authenticating all requests made to this server. - In case of an empty username DefaultCredentials will be used. - - - - - Password for the username. - - - - - Server URL. - - - - - Gets a URL from a server instance for sending requests. In case of a null - instance the first one from the currently configured list will be used. - - Server context object. - - - - Client tools. - - - - - Creates a memory stream from the provided string. Please always use the result of this method - in a using statement - or make sure that the stream is closed eventually. - - - A mempory stream. - - - - Checks if the provided repository path exists and creates the missing containers all the way up to the root. - - The path to create containers for. - Optional: content type name of created containers. Default is Folder. - The newly created container. If it already exists, this method returns null. - - - - Contains upload properties to be filled during an upload request. - - - - - File name to be uploaded. - - - - - Content id. Filled in case of existing content. - - - - - Content type name. - - - - - Property name. - - - - - Whether upload data in chunks or not. - - - - - Whether overwrite existing files or not. - - - - - Chunk token received from the server during the first upload request. - Fill this in case of subsequent requests. - - - - - Length of the file to be uploaded. - - - - - Initializes a new UploadData object. - - - - - Compiles upload data properties into a single string that can be sent as a post data. - - - - - Assembles all filled properties of the upload data object to a dictionary for serialization. - - - - diff --git a/src/references/SenseNet.Tools.xml b/src/references/SenseNet.Tools.xml deleted file mode 100644 index 54f8057..0000000 --- a/src/references/SenseNet.Tools.xml +++ /dev/null @@ -1,1159 +0,0 @@ - - - - SenseNet.Tools - - - - - Annotates a property that can be linked to an argument without a name. - - - - - Determines parameter order on the usage screen. - - - - - Required in argument array or not. - - - - - Name of the argument on the usage screen. - - - - - Text displayed in the detailed parameter information on the usage screen. - - - - - Initializes a new instance of the NoNameOptionAttribute class. - - Parameter order. Required. - Required in argument array or not. Optional, default: false - Name of the argument on the usage screen. Optional, default: null. - Text displayed in the detailed parameter information on the usage screen. Optional, default: null. - - - - Annotates a property that can be linked to a named argument. - - - - - Comma or semicolon separated words that will be synonyms of the name. - - - - - Name of the argument. Optional, default: the name of the annotated property. - - - - - Required in argument array or not. - - - - - Text displayed in the detailed parameter information on the usage screen. - - - - - Initializes a new instance of the CommandLineArgumentAttribute class. - - Name of the argument. Optional, default: the name of the annotated property. - Required in argument array or not. Optional, default: false - Comma or semicolon separated words that will be synonyms of the name. - Text displayed in the detailed parameter information on the usage screen. Optional, default: null. - - - - Defines the category of the parsing result. - - - - Successfully parsed. - - - Unknown error occured. - - - Unknown argument in the argument array. - - - A required argument is missing. - - - Only a value is provided. - - - Required value is missing. - - - Wrong value type (e.g. trying to convert a string to an integer). - - - - Provides methods to analyze the given configuration object by its annotated properties, - fills it with values in an argument array and generates information about the analyzed object. - - - - - Analyzes the target object by its annotations and fills its properties - with the values in the given argument array. - - An instance of the parser to provide more information. - - - - Gets a value that indicates wether the argument list contains a help request. - If that is the case, the configuration object will not be filled and the help - text should be provided to the user, using the GetHelpText method of the parser. - - - - - Returns with the generated calling information. For example: - ToolName [-OptionalParameter:String] <-Limit:String> - - - - - Returns the name of the assembly and its current version e.g.: "SnBenchmark 1.0.0.0" - - - - - - Returns detailed information about how to use the tool. - Contains the app name and version, usage information and list of the - available command line arguments. - - - - - Represents an argument parsing error. - - - - - Type of the error that occured during parsing arguments. See the ResultState enumeration for possible values. - - - - - Original parser instance that can provide a formatted message and a generated help text. - - - - - Error message to write to the console. - - - - - Initializes a new instance of the ParsingException class with serialized data. - - - - - Class for extension methods - - - - - Enumerates a collection in parallel and calls an async method on each item. Useful for making - parallel async calls, e.g. independent web requests when the degree of parallelism needs to be - limited. - - Generic type of collection items. - Source collection. - Number of partitions that the source collection is divided to. - An async action to call on each item. - A task tham completes when the action has completed on all items. - - - - Provides methods that help retrying an operation. You can provide - the maximum number of retry attempts, the callback that should be - called and the exception type that should be suppressed. - - - - - Calls the callback method safely. If the given type of exception is caught, - waits and calls the action again. The maximum number of attempts is determined - by the count parameter. - - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Type of exception that is suppressed and triggers the next attempt. - Void, parameterless method that the retrier executes. - - - - Calls the callback method safely. If the given type of exception is caught, - waits and calls the function again. The maximum number of attempts is determined - by the count parameter. - - The type of the returned object. - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Type of exception that is suppressed and triggers the next attempt. - Parameterless method with T return type. - Result of the callback method. - - - - Performs an operation, and based on a condition it retries it a given number of times. - The checkCondition method is always called, even if there was no exception during - the operation. If it returns true, there will be no retries and the metod will exit. - - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Parameterless method that performs the operation that will be retried. - Function that will decide about trying again. - This method must have 2 parameters with the following types in this order: int, Exception. - The first parameter is the number of the current attempt, the second is the caught exception or null. - If the decider method returns with true, the main method returns immediately. Otherwise the next - attempt will be performed. - - - - - Performs an operation, and based on a condition it retries it a given number of times. - The checkCondition method is always called, even if there was no exception during - the operation. If it returns true, there will be no retries and the metod will exit. - - The type of the returned object. - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Parameterless method with T return type. - Function that will decide about trying again. - This method must have 3 parameters with the following types in this order: T, int, Exception. - The first parameter is the return value of the current attempt, second is the number of the - current attempt and the third is the caught exception or null. If this checker method - returns with true, the main method returns with the callback's result immediately. - Otherwise the next attempt will be performed. - - Result of the callback method. - - - - Performs an async operation, and based on a condition it retries it a given number of times. - The checkCondition method is always called, even if there was no exception during the operation. - If it returns true, there will be no retries and the metod will exit. - - The type of the returned object. - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Parameterless method with T return type. - Function that will decide about trying again. - This method must have 3 parameters with the following types in this order: T, int, Exception. - The first parameter is the return value of the current attempt, second is the number of the - current attempt and the third is the caught exception or null. If this checker method - returns with true, the main method returns with the callback's result immediately. - Otherwise the next attempt will be performed. - - Result of the callback method. - - - - Performs an operation asynchronously, and based on a condition it retries it a given number of times. - The checkCondition method is always called, even if there was no exception during the operation. - If it returns true, there will be no retries and the metod will exit. - - Maximum number of attempts before throwing the caught exception. - Milliseconds to wait between two attempts. - Parameterless method that performs the operation that will be retried. - Function that will decide about trying again. - This method must have 2 parameters with the following types in this order: int, Exception. - The first parameter is the number of the current attempt and the second is the caught exception or null. - If this checker method returns with true, the main method returns immediately. - Otherwise the next attempt will be performed. - - - - - Represents a type loading error. - - - - - Initializes a new instance of the TypeNotFoundException class. - - - - - Initializes a new instance of the TypeNotFoundException class. - - Name of the type that was not found. - - - - Initializes a new instance of the TypeNotFoundException class. - - Name of the type that was not found. - Original exception. - - - - Initializes a new instance of the TypeNotFoundException class with serialized data. - - - - - Provides methods for loading available types in the system. - - - - - Creates an instance of the specified type. - - Type of the object to create. - Name of the type to use. - A newly created object of type T. - - - - Creates an instance of the specified type. - - Type of the object to create. - Name of the type to use. - An array of arguments that match in number, order, and type the parameters - of the constructor to invoke. - A newly created object of type T. - - - - Creates an instance of the specified type. - - Name of the type to use. - A newly created object of the provided type. - - - - Creates an instance of the specified type. - - Name of the type to use. - An array of arguments that match in number, order, and type the parameters - of the constructor to invoke. - A newly created object of the provided type. - - - - Loads the type with the specified name. First looks for the type using - the built-in Type.GetType method, than (in case it is not found) uses - the type cache and an app domain search as a fallback. - - Name of the type to load. - Whether to throw an error when a type is not found. - - - - Loads the type with the specified name from the type cache or from the current app domain. - - Name of the type to load. - Whether to throw an error when a type is not found. - - - - Loads all assemblies in the current app domain. - - - - - Loads all assemblies from the specified file system path. - - A file system path where assemblies should be loaded from. - An array of file names of loaded assemblies in the specified folder. - - - - Loads all types that implement the specified interface. - - Interface type to look for. - - - - Loads all types that inherit from the specified base type. - - Base type to look for. - - - - A helper class containing common utility methods. - - - - - Contains converter methods. - - - - - Converts an array of bytes to a long value. - - The byte array to convert. - - - - Converts a long value to an array of bytes. - - The long value to convert. - - - - Walks through an inner exception chain of the provided exception - and collects all the messages, properties and stack trace lines - into a single string. - - An exception to crawl. - - - - Contains available values of the Category column. - EXPERIMENTAL FEATURE - - - - ContentOperation category - - - Database category - - - Index category - - - IndexQueue category - - - Query category - - - Repository category - - - Messaging category - - - Security category - - - SecurityQueue category - - - System category - - - Web category - - - Workflow category - - - Test category - - - Event category - - - Custom category - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - - EXPERIMENTAL FEATURE - - - - - - EXPERIMENTAL FEATURE - - - - - - EXPERIMENTAL FEATURE - - - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - EXPERIMENTAL FEATURE - - - - - - Contains available values of the Status column. - EXPERIMENTAL FEATURE - - - - Value is "" - - - Value is "Start" - - - Value is "End" - - - Value is "UNSUCCESSFUL" - - - Value is "ERROR" - - - - Represents a line in the trace file. - EXPERIMENTAL FEATURE - - - - - Field index helper - - - - Value = 0 - - - Value = 1 - - - Value = 2 - - - Value = 3 - - - Value = 4 - - - Value = 5 - - - Value = 6 - - - Value = 7 - - - Value = 8 - - - - True if this line is the first in the block that written to disk in one step. - - - - - Identifier number of the line. Unique is in the AppDomain. - - - - - Creation time of the line. - - - - - Trace category - - - - - AppDomain name - - - - - Current thread id. - - - - - Id of the operation - - - - - Value can be empty, "Start", "End", "UNTERMINATED" or "ERROR" - - - - - Duration if this line is the end of an operation - - - - - The subject of the line - - - - - Original line data. - - - - - Creates an SnTraceEntry from one line of the trace file - - - - - Returns a string that represents the current object. - - - - - Logger implementation for writing messages to the debug trace. - - - - - Writes a message and its properties to the debug trace. - - A message to log. - Optional list of log categories. - Event priority. - Event id. - Event type. - Event title. - Optional list of event properties. - - - - Writes a message to the debug trace. - - - - - Represents an audit event. - - - - - Event id. - - - - - Message to log. - - - - - Event title. - - - - - Defines an API for logger implementations for writing general event messages. - For verbose logging please use SnTrace instead. - - - - - Writes a message and its properties to the log. - - A message to log. - List of log categories. - Event priority. - Event id. - Event type. - Event title. - Event properties. - - - - Defines an interface for exception types that need to redefine the default - severity (Error) when they are logged. Custom exception classes can implement - this interface and override the EventType property to return a different - log level - e.g. Warning instead of Error. - - - - - Event level when logging a custom exception. Default: TraceEventType.Error - - - - - Built-in, lightweight IEventLogger implementation that writes events into the selected and existing windows event log. - - - - - Initializes an instance of the SnEventLogger class by passed logName and logSourceName. - The defined log and logsource must be exist. - - Name of the log. Cannot be null or empty. - Name of the log source. Cannot be null or empty. - - - - Writes a message and its properties to the log. - - A message to log. - List of log categories. - Event priority. - Event id. - Event type. - Event title. - Event properties. - - - - Returns a formatted string representation of the whole log entry by the passed parameters. - - - - - Returns a formatted string representation of the categories. - Currently it is a comma separated list of the passed categories. - If the list is null or empty, the value is "General". - - Category collection. Can be null or empty. - - - - Returns a formattedd string representation of the passedd properties. - - - - - Main logger API for writing events on different levels (e.g. Warning, Error). - - - - - Logger instance used by the dedicated static methods. Set this property - once when your application starts. - - - - - Writes an exception to the log. All the inner exceptions will be extracted and logged too. - - The exception to log. - Event message. - Event id. - List of event categories. - Event priority. - Event title. - Event properties. - - - - Writes an error message to the log. - - Event message. - Event id. - List of event categories. - Event priority. - Event title. - Event properties. - - - - Writes a warning message to the log. - - Event message. - Event id. - List of event categories. - Event priority. - Event title. - Event properties. - - - - Writes an information message to the log. - - Event message. - Event id. - List of event categories. - Event priority. - Event title. - Event properties. - - - - Writes an audit message to the log. Event level will be Verbose; it is - the responsibility of the logger to channel this event to the appropriate - log storage based on the provided category. - - An object that represents an audit event. - Event properties. - - - - Efficient and scalable tracing component. Provides methods for recording - verbose information about the running system. Collects messages into a buffer - and writes them to the file system periodically. - This class cannot be inherited. - - - - - Represents an execution block that needs a start and finish log message - regardless of whether the execution was successful or not. The two - messages can be associated by their common operation id. - Setting the Successful property to true is mandatory when the execution - was successful - otherwise the logger would assume that the operation failed. - Tipical usage: - using (var op = SnTrace.StartOperation("message")) { ...; op.Successful = true; } - - - - - Gets the operation identifier that is unique in the current AppDomain. - - - - - Gets the category name. - - - - - Gets the time when the operation started. - - - - - Gets the operation message that is written at start and at the end. - - - - - Gets or sets a value indicating whether the operation is finished correctly. - Always set this flag to true when the code block executed correctly. - Default is false. - - - - - Finishes the operation and writes the trace line containing the message and the running time. - - - - - Releases the unmanaged resources used by the Operation object and optionally releases the managed resources. - - True to release both managed and unmanaged resources or false to release only unmanaged resources. - - - - Represents an SnTrace category. It helps differentiating trace lines - that are generated by different features. - - - - - Gets the name of the category. - - - - - Gets or sets whether the category is enabled or not. Messages sent to - a disabled category will not be writted to the trace log. - - - - - Starts a traced operation in the current category. The message will be written - to the trace with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - A disposable operation object usually encapsulated in a using block. - - - - Writes a line to the trace with the current category. The message will be written with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - - - - Writes an error line to the trace with the current category. The message will be written with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - - - ContentOperation category - - - Database category - - - Index category - - - IndexQueue category - - - Query category - - - Repository category - - - Messaging category - - - Security category - - - SecurityQueue category - - - System category - - - Web category - - - Workflow category - - - Test category - - - Event category - - - Custom category - - - - Contains all SnTrace categories to help enumerate them. - - - - - Creates a dynamic trace category. - - Category name. - A category object that is enabled (meaning messages written into it will be persisted) if the Custom category is enabled. - - - - Starts a traced operation in the "Custom" category. The message will be written to the trace with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - - - - - Writes a line to the trace in the "Custom" category. The message will be written with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - - - - Writes an error line to the trace in the "Custom" category. The message will be written with smart formatting. - - Message template that works as a composite format string (see string.Format method). - Parameters that will be substituted into the message template. - Null values will be written as "null". IEnumerable values will be written as comma separated lists. - All control characters (including tabs, return and line feed) are changed to '.' - - - - - Enables all categories. - - - - - Disables all categories. - - - - Statistical data: the longest gap between p0 and p1 - - - - Extends the given directory with the partial path of the detailed log directory ("App_Data\DetailedLog") - - Directory that will contain the log directory - - - - Writes any buffered data to the underlying device and empties the internal buffer. - - - - - Logger implementation for writing messages to the trace. - - - - - Writes a message and its properties to the trace. - - A message to log. - Optional list of log categories. - Event priority. - Event id. - Event type. - Event title. - Optional list of event properties. - - - - Writes a message to the trace. - - - - - Contains all event ids in Sense/Net ECM including satellite applications and external components. - In your custom code please consider defining custom event ids and use these built-in values only - if the event is truly related to the feature it is defined for. - - - - General, not classified event. Value: 1. - - - Event if the feature is not supported in the current context. Value: 10. - - - Serialization / deserialization related event. Value: 11 - - - General event for the Content Repository. Value: 20 - - - Event during starting and stopping the Content Repository. Value:21 - - - Messaging related event. Used when communicating with other app domains. Value: 30 - - - Security related event. Value: 40 - - - Lucene indexing related event. Value: 50 - - - Content Query related event. Value: 60 - - - ActionFramework related event. Value: 70 - - - DirectoryServices (AdSync) related event. Value: 80 - - - Packaging (SnAdmin) related event. Value: 90 - - - TreeLock related event. Value: 100 - - - Transaction related event. Value: 110 - - - Portal component (e.g. Portlet, ContentView etc.) related event. Value: 120 - - - Service related event. Value: 130 - - - Load test event. Value: 140 - - - SenseNet.Client related event. Value: 150 - - - Preview generation related event. Value: 160 - - - Contains Task Management related event ids. - - - General task management event. Value: 500 - - - Events during starting or stopping any task management related component. Value: 510 - - - Any communication related event in task management. Value: 520 - - -