Files
tgstation-server/_i_chat_authority_8cs_source.html

126 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>tgstation-server: src/Tgstation.Server.Host/Authority/IChatAuthority.cs Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.19.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_34761767c1c3cd212f9d2f80ea0828a8.html">Tgstation.Server.Host</a></li><li class="navelem"><a class="el" href="dir_7b5e30ed08996bf1ab2c41e458010f21.html">Authority</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">IChatAuthority.cs</div></div>
</div><!--header-->
<div class="contents">
<a href="_i_chat_authority_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="keyword">using </span>System.Collections.Generic;</div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="keyword">using </span>System.Threading;</div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a>;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html">Tgstation.Server.Host.Authority.Core</a>;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a>;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">interface </span><a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html">IChatAuthority</a> : <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority.html">IAuthority</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html#a81d7e0d027b8653a23a9fd85e870c648"> 28</a></span> <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">RequirementsGated&lt;AuthorityResponse&lt;ChatBot&gt;</a>&gt; <a class="code hl_function" href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html#a81d7e0d027b8653a23a9fd85e870c648">Create</a>(</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> IEnumerable&lt;Models.ChatChannel&gt; initialChannels,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">string</span> name,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordtype">string</span> connectionString,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_enumeration" href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2d962413bc23404156feea75066e39cc">ChatProvider</a> provider,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">long</span> instanceId,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> uint? reconnectionInterval,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ushort? channelLimit,</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">bool</span> enabled,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> CancellationToken cancellationToken);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_requirements_gated.html">Tgstation.Server.Host.Authority.Core.RequirementsGated</a></div><div class="ttdoc">Evaluates a set of IAuthorizationRequirements to be checked before executing a response.</div><div class="ttdef"><b>Definition</b> <a href="_requirements_gated_02_t_result_03_8cs_source.html#l00016">RequirementsGated{TResult}.cs:17</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_1_1_i_authority.html">Tgstation.Server.Host.Authority.Core.IAuthority</a></div><div class="ttdoc">Business logic for interating with the server.</div><div class="ttdef"><b>Definition</b> <a href="_i_authority_8cs_source.html#l00008">IAuthority.cs:9</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html">Tgstation.Server.Host.Authority.IChatAuthority</a></div><div class="ttdoc">IAuthority for manipulating chat bots.</div><div class="ttdef"><b>Definition</b> <a href="_i_chat_authority_8cs_source.html#l00013">IChatAuthority.cs:14</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority_html_a81d7e0d027b8653a23a9fd85e870c648"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_authority_1_1_i_chat_authority.html#a81d7e0d027b8653a23a9fd85e870c648">Tgstation.Server.Host.Authority.IChatAuthority.Create</a></div><div class="ttdeci">RequirementsGated&lt; AuthorityResponse&lt; ChatBot &gt; &gt; Create(IEnumerable&lt; Models.ChatChannel &gt; initialChannels, string name, string connectionString, ChatProvider provider, long instanceId, uint? reconnectionInterval, ushort? channelLimit, bool enabled, CancellationToken cancellationToken)</div><div class="ttdoc">Create a new ChatBot.</div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html">Tgstation.Server.Api.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_tgstation_8_server_8_api_2_models_2_chat_channel_8cs_source.html#l00005">ChatChannel.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_api_1_1_models_html_a2d962413bc23404156feea75066e39cc"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_api_1_1_models.html#a2d962413bc23404156feea75066e39cc">Tgstation.Server.Api.Models.ChatProvider</a></div><div class="ttdeci">ChatProvider</div><div class="ttdoc">Represents a chat service provider.</div><div class="ttdef"><b>Definition</b> <a href="_chat_provider_8cs_source.html#l00006">ChatProvider.cs:7</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority_1_1_core.html">Tgstation.Server.Host.Authority.Core</a></div><div class="ttdef"><b>Definition</b> <a href="_authority_base_8cs_source.html#l00013">AuthorityBase.cs:14</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_authority_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_authority.html">Tgstation.Server.Host.Authority</a></div><div class="ttdef"><b>Definition</b> <a href="_administration_authority_8cs_source.html#l00025">AdministrationAuthority.cs:26</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_models_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_models.html">Tgstation.Server.Host.Models</a></div><div class="ttdef"><b>Definition</b> <a href="_models_2_chat_bot_8cs_source.html#l00008">ChatBot.cs:9</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>