apidoc

<!DOCTYPE html> <html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <title>Loading...</title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> </head> <body class="container-fluid"> <script id="template-sidenav" type="text/x-handlebars-template"> <nav id="scrollingNav"> <div class="sidenav-search"> <input class="form-control search" type="text" placeholder="{{__ "Filter..."}}"> <span class="search-reset">x</span> </div> <ul class="sidenav nav nav-list list"> {{#each nav}} {{#if title}} {{#if isHeader}} {{#if isFixed}} <li class="nav-fixed nav-header navbar-btn nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-name="show-api-{{group}}" class="show-api api-{{group}}-init">{{underscoreToSpace title}}</a></li> {{else}} <li class="nav-header nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-group="show-api-{{group}}" class="show-group api-{{group}}-init">{{underscoreToSpace title}}</a></li> {{/if}} {{else}} <li class="{{#if hidden}}hide {{/if}}" data-group="{{group}}" data-name="{{name}}" data-version="{{version}}"> <a href="#api-{{group}}-{{name}}" title="{{url}}" data-group="show-api-{{group}}" data-name="show-api-{{group}}-{{name}}" class="nav-list-item show-api api-{{group}}-{{name}}-init">{{title}}<div class="nav-list-url-item hide">{{url}}</div></a> </li> {{/if}} {{/if}} {{/each}} </ul> </nav> </script> <script id="template-project" type="text/x-handlebars-template"> <div class="pull-left"> <h1>{{name}}</h1> {{#if description}}<h2>{{{nl2br description}}}</h2>{{/if}} </div> <div class="pull-right"> {{#if template.withCompare}} <div class="btn-group"> <button id="version" class="btn btn-lg btn-default dropdown-toggle" data-toggle="dropdown"> <strong>{{version}}</strong> <span class="caret"></span> </button> <ul id="versions" class="dropdown-menu open-left"> <li><a id="compareAllWithPredecessor" href="#">{{__ "Compare all with predecessor"}}</a></li> <li class="divider"></li> <li class="disabled"><a href="#">{{__ "show up to version:"}}</a></li> {{#each versions}} <li class="version"><a href="#">{{this}}</a></li> {{/each}} </ul> </div> {{else}} <div id="version" class="well well-sm"> <strong>{{version}}</strong> </div> {{/if}} </div> <div class="clearfix"></div> </script> <script id="template-header" type="text/x-handlebars-template"> {{#if content}} <div id="api-_" class="show-api-article show-api-_-article">{{{content}}}</div> {{/if}} </script> <script id="template-footer" type="text/x-handlebars-template"> {{#if content}} <div id="api-_footer" class="show-api-article show-api-_-article">{{{content}}}</div> {{/if}} </script> <script id="template-generator" type="text/x-handlebars-template"> {{#if template.withGenerator}} {{#if generator}} <div class="content"> {{__ "Generated with"}} <a href="{{{generator.url}}}">{{{generator.name}}}</a> {{{generator.version}}} - {{{generator.time}}} </div> {{/if}} {{/if}} </script> <script id="template-sections" type="text/x-handlebars-template"> <section id="api-{{group}}" class="show-api-group show-api-{{group}}-group {{#if aloneDisplay}} hide{{/if}}"> <h1>{{underscoreToSpace title}}</h1> {{#if description}} <p>{{{nl2br description}}}</p> {{/if}} {{#each articles}} <div id="api-{{group}}-{{name}}" class="show-api-article show-api-{{group}}-article show-api-{{group}}-{{name}}-article {{#if aloneDisplay}} hide{{/if}}"> {{{article}}} </div> {{/each}} </section> </script> <script id="template-article" type="text/x-handlebars-template"> <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" {{#if hidden}}class="hide"{{/if}} data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}"> <div class="pull-left"> <h1>{{underscoreToSpace article.groupTitle}}{{#if article.title}} - {{article.title}}{{/if}}</h1> </div> {{#if template.withCompare}} <div class="pull-right"> <div class="btn-group"> <button class="version btn btn-default dropdown-toggle" data-toggle="dropdown"> <strong>{{article.version}}</strong> <span class="caret"></span> </button> <ul class="versions dropdown-menu open-left"> <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li> {{#each versions}} <li class="version"><a href="#">{{this}}</a></li> {{/each}} </ul> </div> </div> {{/if}} <div class="clearfix"></div> {{#if article.author}}<h4 class="muted">Authored by: {{article.author}}</h4>{{/if}} {{#if article.deprecated}} <p class="deprecated"><span>{{__ "DEPRECATED"}}</span> {{{markdown article.deprecated.content}}} </p> {{/if}} {{#if article.description}} <p>{{{nl2br article.description}}}</p> {{/if}} <span class="type type__{{toLowerCase article.type}}">{{toLowerCase article.type}}</span> <pre data-type="{{toLowerCase article.type}}"><code class="language-http">{{article.url}}</code></pre> {{#if article.permission}} <p> {{__ "Permission:"}} {{#each article.permission}} {{name}} {{#if title}} <button type="button" class="btn btn-info btn-xs" data-title="{{title}}" data-content="{{nl2br description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{/if}} {{/each}} </p> {{/if}} {{!-- CODE EXAMPLES IN TABS --}} {{#if_gt article.examples.length compare=0}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each article.examples}} <li{{#if_eq @index compare=0}} class="active"{{/if_eq}}> <a href="#examples-{{../id}}-{{@index}}">{{title}}</a> </li> {{/each}} </ul> <div class="tab-content"> {{#each article.examples}} <div class="tab-pane{{#if_eq @index compare=0}} active{{/if_eq}}" id="examples-{{../id}}-{{@index}}"> <pre data-type="{{type}}"><code class="language-{{type}}">{{content}}</code></pre> </div> {{/each}} </div> {{/if_gt}} {{subTemplate "article-param-block" params=article.header _hasType=_hasTypeInHeaderFields section="header"}} {{subTemplate "article-param-block" params=article.parameter _hasType=_hasTypeInParameterFields section="parameter"}} {{subTemplate "article-param-block" params=article.success _hasType=_hasTypeInSuccessFields section="success"}} {{subTemplate "article-query-block" params=article.query _hasType=_hasTypeInParameterFields section="query"}} {{subTemplate "article-body-block" params=article.body _hasType=_hasTypeInParameterFields section="body"}} {{subTemplate "article-param-block" params=article.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}} {{subTemplate "article-sample-request" article=article id=id}} </article> </script> <script id="template-article-query-block" type="text/x-handlebars-template"> {{#if article.query}} <h2>Query Parameter(s)</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if_neq this.Type compare=null}} <th style="width: 10%">{{__ "Type"}}</th> {{/if_neq}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> <tbody> {{#each params}} <tr> <td class="code">{{this.field}}</td> {{#if_neq this.Type compare=null}} <td>{{this.type}}</td> {{/if_neq}} <td>{{{nl2br this.description}}}</td> </tr> {{/each}} </tbody> </table> {{/if}} </script> <script id="template-article-body-block" type="text/x-handlebars-template"> {{#if article.body}} <h2>Request Body</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if_neq this.Type compare=null}} <th style="width: 10%">{{__ "Type"}}</th> {{/if_neq}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> <tbody> {{#each params}} <tr> <td class="code">{{this.field}}</td> {{#if_neq this.Type compare=null}} <td>{{this.type}}</td> {{/if_neq}} <td> {{{nl2br this.description}}} {{#if defaultValue}} <p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p> {{/if}} {{#if size}} <p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p> {{/if}} {{#if allowedValues}} <p class="type-size">{{__ "Allowed values:"}} {{#each allowedValues}} <code>{{{this}}}</code>{{#unless @last}}, {{/unless}} {{/each}} </p> {{/if}} </td> </tr> {{/each}} </tbody> </table> {{/if}} </script> <script id="template-article-param-block" type="text/x-handlebars-template"> {{#if params}} {{#each params.fields}} <h2>{{__ @key}}</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> <tbody> {{#each this}} <tr> <td class="code">{{{splitFill field "." "  "}}}{{#if optional}} <span class="label label-optional">{{__ "optional"}}</span>{{/if}}</td> {{#if ../../_hasType}} <td> {{{type}}} </td> {{/if}} <td> {{{nl2br description}}} {{#if defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}} {{#if size}}<p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}} {{#if allowedValues}}<p class="type-size">{{__ "Allowed values:"}} {{#each allowedValues}} <code>{{{this}}}</code>{{#unless @last}}, {{/unless}} {{/each}} </p> {{/if}} </td> </tr> {{/each}} </tbody> </table> {{/each}} {{#if_gt params.examples.length compare=0}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each params.examples}} <li{{#if_eq @index compare=0}} class="active"{{/if_eq}}> <a href="#{{../section}}-examples-{{../id}}-{{@index}}">{{title}}</a> </li> {{/each}} </ul> <div class="tab-content"> {{#each params.examples}} <div class="tab-pane{{#if_eq @index compare=0}} active{{/if_eq}}" id="{{../section}}-examples-{{../id}}-{{@index}}"> <pre data-type="{{type}}"><code class="language-{{type}}">{{reformat content type}}</code></pre> </div> {{/each}} </div> {{/if_gt}} {{/if}} </script> <script id="template-article-sample-request" type="text/x-handlebars-template"> {{#if article.sampleRequest}} <h2>{{__ "Send a Sample Request"}}</h2> <form class="form-horizontal"> <fieldset> <div class="form-group"> <label class="col-md-3 control-label" for="{{../id}}-sample-request-url"></label> <div class="input-group"> <input id="{{../id}}-sample-request-url" type="text" class="form-control sample-request-url" value="{{article.sampleRequest.0.url}}" /> <span class="input-group-addon">{{__ "url"}}</span> </div> </div> {{#if article.header}} {{#if article.header.fields}} <h3>{{__ "Headers"}}</h3> {{#each article.header.fields}} <h4><input type="checkbox" data-sample-request-header-group-id="sample-request-header-{{@index}}" name="{{../id}}-sample-request-header" value="{{@index}}" class="sample-request-header sample-request-switch" checked />{{__ @key}}</h4> <div class="{{../id}}-sample-request-header-fields"> {{#each this}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-header-field-{{field}}">{{field}}</label> <div class="input-group"> <input type="text" placeholder="{{field}}" value="{{defaultValue}}" id="sample-request-header-field-{{field}}" class="form-control sample-request-header" data-sample-request-header-name="{{field}}" data-sample-request-header-group="sample-request-header-{{@../index}}"> <span class="input-group-addon">{{{type}}}</span> </div> </div> {{/each}} </div> {{/each}} {{/if}} {{/if}} {{#if article.parameter}} {{#if article.parameter.fields}} <h3>{{__ "Parameters"}}</h3> {{#each article.parameter.fields}} <h4><input type="checkbox" data-sample-request-param-group-id="sample-request-param-{{@index}}" name="{{../id}}-sample-request-param" value="{{@index}}" class="sample-request-param sample-request-switch" checked/>{{__ @key}} <select name="{{../id}}-sample-header-content-type" class="{{../id}}-sample-request-param-select sample-header-content-type sample-header-content-type-switch"> <option value="undefined" selected>ajax-auto</option> <option value="body-json" >body/json</option> <option value="body-form-data" >body/form-data</option> </select> </h4> <div class="{{../id}}-sample-request-param-body {{../id}}-sample-header-content-type-body hide"> <div class="form-group"> <div class="input-group"> <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible" {{#if optional}}data-sample-request-param-optional="true"{{/if}}></textarea> <div class="input-group-addon">json</div> </div> </div> </div> <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields"> {{#each this}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label> <div class="input-group"> <input id="sample-request-param-field-{{field}}" type="{{setInputType type}}" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true"{{/if}}> <div class="input-group-addon">{{{type}}}</div> </div> </div> {{/each}} </div> {{/each}} {{/if}} {{/if}} {{#if article.query}} <h3>{{__ "Query Parameters"}}</h3> <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields"> {{#each article.query}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label> <div class="input-group"> <input id="sample-request-param-field-{{field}}" type="{{setInputType type}}" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true" {{/if}}> <div class="input-group-addon">{{{type}}}</div> </div> </div> {{/each}} </div> {{/if}} {{#if article.body}} {{log this}} <h3>{{__ "Body"}}</h3> <h4><input type="checkbox" data-sample-request-param-group-id="sample-request-param-{{@index}}" name="{{this.id}}-sample-request-param" value="{{@index}}" class="sample-request-param sample-request-switch" checked />{{__ @key}} <select name="{{this.id}}-sample-header-content-type" class="{{this.id}}-sample-request-param-select sample-header-content-type sample-header-content-type-switch"> <option value="body-json" selected>body/json</option> <option value="body-form-data">body/form-data</option> </select> </h4> <div class="{{this.id}}-sample-request-param-body {{this.id}}-sample-header-content-type-body"> <div class="form-group"> <div class="input-group"> <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible" {{#if optional}}data-sample-request-param-optional="true" {{/if}}>{{gen_body article.body}}</textarea> <div class="input-group-addon">json</div> </div> </div> </div> <div class="{{this.id}}-sample-request-param-fields {{this.id}}-sample-header-content-type-fields hide"> {{#each article.body}} <div class="form-group"> <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label> <div class="input-group"> <input id="sample-request-param-field-{{field}}" type="{{setInputType type}}" placeholder="{{field}}" class="form-control sample-request-param" data-sample-request-param-name="{{field}}" data-sample-request-param-group="sample-request-param-{{@../index}}" {{#if optional}}data-sample-request-param-optional="true" {{/if}}> <div class="input-group-addon">{{{type}}}</div> </div> </div> {{/each}} </div> {{/if}} <div class="form-group"> <div class="controls pull-right"> <button class="btn btn-primary sample-request-send" data-sample-request-type="{{article.type}}">{{__ "Send"}}</button> </div> </div> <div class="form-group sample-request-response" style="display: none;"> <h3> {{__ "Response"}} <button class="btn btn-default btn-xs pull-right sample-request-clear">X</button> </h3> <pre data-type="json"><code class="language-json sample-request-response-json"></code></pre> </div> </fieldset> </form> {{/if}} </script> <script id="template-compare-article" type="text/x-handlebars-template"> <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" {{#if hidden}}class="hide"{{/if}} data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}" data-compare-version="{{compare.version}}"> <div class="pull-left"> <h1>{{underscoreToSpace article.group}} - {{{showDiff article.title compare.title}}}</h1> </div> <div class="pull-right"> <div class="btn-group"> <button class="btn btn-success" disabled> <strong>{{article.version}}</strong> {{__ "compared to"}} </button> <button class="version btn btn-danger dropdown-toggle" data-toggle="dropdown"> <strong>{{compare.version}}</strong> <span class="caret"></span> </button> <ul class="versions dropdown-menu open-left"> <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li> <li class="divider"></li> {{#each versions}} <li class="version"><a href="#">{{this}}</a></li> {{/each}} </ul> </div> </div> <div class="clearfix"></div> {{#if article.description}} <p>{{{showDiff article.description compare.description "nl2br"}}}</p> {{else}} {{#if compare.description}} <p>{{{showDiff "" compare.description "nl2br"}}}</p> {{/if}} {{/if}} <pre data-type="{{toLowerCase article.type}}"><code class="language-html">{{{showDiff article.url compare.url}}}</code></pre> {{subTemplate "article-compare-permission" article=article compare=compare}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each_compare_title article.examples compare.examples}} {{#if typeSame}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}">{{{showDiff source.title compare.title}}}</a> </li> {{/if}} {{#if typeIns}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}"><ins>{{{source.title}}}</ins></a> </li> {{/if}} {{#if typeDel}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#compare-examples-{{../../article.id}}-{{index}}"><del>{{{compare.title}}}</del></a> </li> {{/if}} {{/each_compare_title}} </ul> <div class="tab-content"> {{#each_compare_title article.examples compare.examples}} {{#if typeSame}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{showDiff source.content compare.content}}}</code></pre> </div> {{/if}} {{#if typeIns}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{source.content}}}</code></pre> </div> {{/if}} {{#if typeDel}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{compare.type}}"><code class="language-{{source.type}}">{{{compare.content}}}</code></pre> </div> {{/if}} {{/each_compare_title}} </div> {{subTemplate "article-compare-param-block" source=article.parameter compare=compare.parameter _hasType=_hasTypeInParameterFields section="parameter"}} {{subTemplate "article-compare-param-block" source=article.success compare=compare.success _hasType=_hasTypeInSuccessFields section="success"}} {{subTemplate "article-compare-param-block" source=article.error compare=compare.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}} {{subTemplate "article-sample-request" article=article id=id}} </article> </script> <script id="template-article-compare-permission" type="text/x-handlebars-template"> <p> {{__ "Permission:"}} {{#each_compare_list_field article.permission compare.permission field="name"}} {{#if source}} {{#if typeSame}} {{source.name}} {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeIns}} <ins>{{source.name}}</ins> {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeDel}} <del>{{source.name}}</del> {{#if source.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{else}} {{#if typeSame}} {{compare.name}} {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeIns}} <ins>{{compare.name}}</ins> {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{#if typeDel}} <del>{{compare.name}}</del> {{#if compare.title}} <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover"> <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> </button> {{#unless _last}}, {{/unless}} {{/if}} {{/if}} {{/if}} {{/each_compare_list_field}} </p> </script> <script id="template-article-compare-param-block" type="text/x-handlebars-template"> {{#if source}} {{#each_compare_keys source.fields compare.fields}} {{#if typeSame}} <h2>{{__ source.key}}</h2> <table> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=source.value compare=compare.value _hasType=../_hasType}} </table> {{/if}} {{#if typeIns}} <h2><ins>{{__ source.key}}</ins></h2> <table class="ins"> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=source.value compare=source.value _hasType=../_hasType}} </table> {{/if}} {{#if typeDel}} <h2><del>{{__ compare.key}}</del></h2> <table class="del"> <thead> <tr> <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th> {{#if ../_hasType}}<th style="width: 10%">{{__ "Type"}}</th>{{/if}} <th style="width: {{#if ../_hasType}}60%{{else}}70%{{/if}}">{{__ "Description"}}</th> </tr> </thead> {{subTemplate "article-compare-param-block-body" source=compare.value compare=compare.value _hasType=../_hasType}} </table> {{/if}} {{/each_compare_keys}} {{#if source.examples}} <ul class="nav nav-tabs nav-tabs-examples"> {{#each_compare_title source.examples compare.examples}} {{#if typeSame}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#{{../../section}}-compare-examples-{{../../article.id}}-{{index}}">{{{showDiff source.title compare.title}}}</a> </li> {{/if}} {{#if typeIns}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"><ins>{{{source.title}}}</ins></a> </li> {{/if}} {{#if typeDel}} <li{{#if_eq index compare=0}} class="active"{{/if_eq}}> <a href="#{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"><del>{{{compare.title}}}</del></a> </li> {{/if}} {{/each_compare_title}} </ul> <div class="tab-content"> {{#each_compare_title source.examples compare.examples}} {{#if typeSame}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{showDiff source.content compare.content}}}</code></pre> </div> {{/if}} {{#if typeIns}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{source.type}}"><code class="language-{{source.type}}">{{{source.content}}}</code></pre> </div> {{/if}} {{#if typeDel}} <div class="tab-pane{{#if_eq index compare=0}} active{{/if_eq}}" id="{{../../section}}-compare-examples-{{../../article.id}}-{{index}}"> <pre data-type="{{compare.type}}"><code class="language-{{source.type}}">{{{compare.content}}}</code></pre> </div> {{/if}} {{/each_compare_title}} </div> {{/if}} {{/if}} </script> <script id="template-article-compare-param-block-body" type="text/x-handlebars-template"> <tbody> {{#each_compare_field source compare}} {{#if typeSame}} <tr> <td class="code"> {{{splitFill source.field "." "  "}}} {{#if source.optional}} {{#if compare.optional}} <span class="label label-optional">{{__ "optional"}}</span> {{else}} <span class="label label-optional label-ins">{{__ "optional"}}</span> {{/if}} {{else}} {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}} {{/if}} </td> {{#if source.type}} {{#if compare.type}} <td>{{{showDiff source.type compare.type}}}</td> {{else}} <td>{{{source.type}}}</td> {{/if}} {{else}} {{#if compare.type}} <td>{{{compare.type}}}</td> {{else}} {{#if ../../../../_hasType}}<td></td>{{/if}} {{/if}} {{/if}} <td> {{{showDiff source.description compare.description "nl2br"}}} {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{showDiff source.defaultValue compare.defaultValue}}}</code><p>{{/if}} </td> </tr> {{/if}} {{#if typeIns}} <tr class="ins"> <td class="code"> {{{splitFill source.field "." "  "}}} {{#if source.optional}} <span class="label label-optional label-ins">{{__ "optional"}}</span>{{/if}} </td> {{#if source.type}} <td>{{{source.type}}}</td> {{else}} {{{typRowTd}}} {{/if}} <td> {{{nl2br source.description}}} {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{source.defaultValue}}}</code><p>{{/if}} </td> </tr> {{/if}} {{#if typeDel}} <tr class="del"> <td class="code"> {{{splitFill compare.field "." "  "}}} {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}} </td> {{#if compare.type}} <td>{{{compare.type}}}</td> {{else}} {{{typRowTd}}} {{/if}} <td> {{{nl2br compare.description}}} {{#if compare.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{compare.defaultValue}}}</code><p>{{/if}} </td> </tr> {{/if}} {{/each_compare_field}} </tbody> </script> <div class="container-fluid"> <div class="row"> <div id="sidenav" class="span2"></div> <div id="content"> <div id="project"></div> <div id="header"></div> <div id="sections"></div> <div id="footer"></div> <div id="generator"></div> </div> </div> </div> <div id="loader"> <div class="spinner"> <div class="spinner-container container1"> <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div> </div> <div class="spinner-container container2"> <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div> </div> <div class="spinner-container container3"> <div class="circle1"></div><div class="circle2"></div><div class="circle3"></div><div class="circle4"></div> </div> <p>Loading...</p> </div> </div> </body> </html> <script> var APIDATA = {api: __API_DATA__} var APIPROJECT = __API_PROJECT__ </script> <style>/*! * Bootstrap v3.4.1 (https://getbootstrap.com/) * Copyright 2011-2019 Twitter,Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:none;text-decoration:underline;-webkit-text-decoration:underline dotted;-moz-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type=checkbox],input[type=radio]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-appearance:textfield;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}@media print{*,:after,:before{color:#000!important;text-shadow:none!important;background:0 0!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}blockquote,pre{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}img,tr{page-break-inside:avoid}img{max-width:100%!important}h2,h3,p{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.label{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered td,.table-bordered th{border:1px solid #ddd!important}}@font-face{font-family:"Glyphicons Halflings";src:url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.eot);src:url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.eot?#iefix) format("embedded-opentype"),url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.woff2) format("woff2"),url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.woff) format("woff"),url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.ttf) format("truetype"),url(/home/ktr/.dev/apidoc/template/fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular) format("svg")}.glyphicon{position:relative;top:1px;display:inline-block;font-family:"Glyphicons Halflings";font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"\002a"}.glyphicon-plus:before{content:"\002b"}.glyphicon-eur:before,.glyphicon-euro:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\00a5"}.glyphicon-jpy:before{content:"\00a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before