Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4c7de71 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@MarvinOehlerkingCap
MarvinOehlerkingCap committed Aug 9, 2024
1 parent 932d3d3 commit c8391d7
Show file tree
Hide file tree
Showing 160 changed files with 15,986 additions and 12,716 deletions.
369 changes: 369 additions & 0 deletions controllers/AdminApiContextExternalToolController.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,369 @@
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>schulcloud-server documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">

<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<script>
// Blocking script to avoid flickering dark mode
// Dark mode toggle button
var useDark = window.matchMedia('(prefers-color-scheme: dark)');
var darkModeState = useDark.matches;
var $darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
var $darkModeToggles = document.querySelectorAll('.dark-mode-switch');
var darkModeStateLocal = localStorage.getItem('compodoc_darkmode-state');

function checkToggle(check) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].checked = check;
}
}

function toggleDarkMode(state) {
if (window.localStorage) {
localStorage.setItem('compodoc_darkmode-state', state);
}

checkToggle(state);

const hasClass = document.body.classList.contains('dark');

if (state) {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.add('dark');
}
if (!hasClass) {
document.body.classList.add('dark');
}
} else {
for (var i = 0; i < $darkModeToggles.length; i++) {
$darkModeToggles[i].classList.remove('dark');
}
if (hasClass) {
document.body.classList.remove('dark');
}
}
}

useDark.addEventListener('change', function (evt) {
toggleDarkMode(evt.matches);
});
if (darkModeStateLocal) {
darkModeState = darkModeStateLocal === 'true';
}
toggleDarkMode(darkModeState);
</script>

<div class="navbar navbar-default navbar-fixed-top d-md-none p-0">
<div class="d-flex">
<a href="../" class="navbar-brand">schulcloud-server documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
</div>

<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>

<div class="container-fluid main">
<div class="row main">
<div class="d-none d-md-block menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content controller">
<div class="content-data">





<ol class="breadcrumb">
<li class="breadcrumb-item">Controllers</li>
<li class="breadcrumb-item" >AdminApiContextExternalToolController</li>
</ol>

<ul class="nav nav-tabs" role="tablist">
<li class="nav-item">
<a href="#info"
class="nav-link"
class="nav-link active"
role="tab" id="info-tab" data-bs-toggle="tab" data-link="info">Info</a>
</li>
<li class="nav-item">
<a href="#source"
class="nav-link"

role="tab" id="source-tab" data-bs-toggle="tab" data-link="source">Source</a>
</li>
</ul>

<div class="tab-content">
<div class="tab-pane fade active in" id="info">
<p class="comment">
<h3>File</h3>
</p>
<p class="comment">
<code>apps/server/src/modules/tool/context-external-tool/controller/admin-api-context-external-tool.controller.ts</code>
</p>

<p class="comment">
<h3>Prefix</h3>
</p>
<p class="comment">
<code>admin/tools/context-external-tools</code>
</p>






<section data-compodoc="block-index">
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>

<tr>
<td class="col-md-4">
<h6><b>Methods</b></h6>
</td>
</tr>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier">Async</span>
<a href="#createContextExternalTool" >createContextExternalTool</a>
</li>
</ul>
</td>
</tr>





</tbody>
</table>
</section>

<section data-compodoc="block-methods">

<h3 id="methods">
Methods
</h3>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="createContextExternalTool"></a>
<span class="name">
<span class="modifier"></span>
<span class="modifier"></span>
<span class="modifier">Async</span>
<span ><b>createContextExternalTool</b></span>
<a href="#createContextExternalTool"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<span class="modifier-icon icon ion-ios-reset"></span>
<code>createContextExternalTool(body: <a href="../classes/ContextExternalToolPostParams.html" target="_self">ContextExternalToolPostParams</a>)</code>
</td>
</tr>

<tr>
<td class="col-md-4">
<b>Decorators : </b>
<br />
<code>@Post()<br />@ApiOperation({summary: &#x27;Creates a ContextExternalTool&#x27;})<br /></code>
</td>
</tr>

<tr>
<td class="col-md-4">
<div class="io-line">Defined in <a href="" data-line="18"
class="link-to-prism">apps/server/src/modules/tool/context-external-tool/controller/admin-api-context-external-tool.controller.ts:18</a></div>
</td>
</tr>


<tr>
<td class="col-md-4">

<div class="io-description">
<b>Parameters :</b>

<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Type</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>body</td>
<td>
<code><a href="../classes/ContextExternalToolPostParams.html" target="_self" >ContextExternalToolPostParams</a></code>
</td>

<td>
No
</td>


</tr>
</tbody>
</table>
</div>
<div class="io-description">
<b>Returns : </b> <code>Promise&lt;ContextExternalToolResponse&gt;</code>

</div>
<div class="io-description">

</div>
</td>
</tr>
</tbody>
</table>
</section> </div>


<div class="tab-pane fade tab-source-code" id="source">
<pre class="line-numbers compodoc-sourcecode"><code class="language-typescript">import { Body, Controller, Post, UseGuards } from &#x27;@nestjs/common&#x27;;
import { AuthGuard } from &#x27;@nestjs/passport&#x27;;
import { ApiOperation, ApiTags } from &#x27;@nestjs/swagger&#x27;;
import { ContextExternalTool } from &#x27;../domain&#x27;;
import { ContextExternalToolRequestMapper, ContextExternalToolResponseMapper } from &#x27;../mapper&#x27;;
import { AdminApiContextExternalToolUc } from &#x27;../uc&#x27;;
import { ContextExternalToolDto } from &#x27;../uc/dto/context-external-tool.types&#x27;;
import { ContextExternalToolPostParams, ContextExternalToolResponse } from &#x27;./dto&#x27;;

@ApiTags(&#x27;AdminApi: Context External Tool&#x27;)
@UseGuards(AuthGuard(&#x27;api-key&#x27;))
@Controller(&#x27;admin/tools/context-external-tools&#x27;)
export class AdminApiContextExternalToolController {
constructor(private readonly adminApiContextExternalToolUc: AdminApiContextExternalToolUc) {}

@Post()
@ApiOperation({ summary: &#x27;Creates a ContextExternalTool&#x27; })
async createContextExternalTool(@Body() body: ContextExternalToolPostParams): Promise&lt;ContextExternalToolResponse&gt; {
const contextExternalToolProps: ContextExternalToolDto &#x3D;
ContextExternalToolRequestMapper.mapContextExternalToolRequest(body);

const contextExternalTool: ContextExternalTool &#x3D; await this.adminApiContextExternalToolUc.createContextExternalTool(
contextExternalToolProps
);

const response: ContextExternalToolResponse &#x3D;
ContextExternalToolResponseMapper.mapContextExternalToolResponse(contextExternalTool);

return response;
}
}
</code></pre>
</div>
</div>
















</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>

<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>

<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'controller';
var COMPODOC_CURRENT_PAGE_URL = 'AdminApiContextExternalToolController.html';
var MAX_SEARCH_RESULTS = 15;
</script>

<script>
$darkModeToggleSwitchers = document.querySelectorAll('.dark-mode-switch input');
checkToggle(darkModeState);
if ($darkModeToggleSwitchers.length > 0) {
for (var i = 0; i < $darkModeToggleSwitchers.length; i++) {
$darkModeToggleSwitchers[i].addEventListener('change', function (event) {
darkModeState = !darkModeState;
toggleDarkMode(darkModeState);
});
}
}
</script>

<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>

<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>

<script src="../js/libs/bootstrap-native.js"></script>

<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>

<script src="../js/compodoc.js"></script>

<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>


</body>
</html>
Loading

0 comments on commit c8391d7

Please sign in to comment.