<spanid="evennia-comms-comms"></span><h1>evennia.comms.comms<aclass="headerlink"href="#module-evennia.comms.comms"title="Permalink to this headline">¶</a></h1>
<emclass="property">class </em><codeclass="sig-prename descclassname">evennia.comms.comms.</code><codeclass="sig-name descname">DefaultChannel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">objects</code><emclass="property"> = <evennia.comms.managers.ChannelManager object></em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.objects"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_first_save</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_first_save"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_first_save"title="Permalink to this definition">¶</a></dt>
<dd><p>Called by the typeclass system the very first time the channel
is saved to the database. Generally, don’t overload this but
<codeclass="sig-name descname">basetype_setup</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.basetype_setup"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.basetype_setup"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_channel_creation</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_channel_creation"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_channel_creation"title="Permalink to this definition">¶</a></dt>
<dd><p>Called once, when the channel is first created.</p>
<codeclass="sig-name descname">has_connection</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.has_connection"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.has_connection"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">mutelist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.mutelist"title="Permalink to this definition">¶</a></dt>
<emclass="property">property </em><codeclass="sig-name descname">wholist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.wholist"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">mute</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.mute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.mute"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">unmute</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.unmute"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.unmute"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">connect</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.connect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.connect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">disconnect</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">subscriber</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.disconnect"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.disconnect"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">access</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">accessing_obj</span></em>, <emclass="sig-param"><spanclass="n">access_type</span><spanclass="o">=</span><spanclass="default_value">'listen'</span></em>, <emclass="sig-param"><spanclass="n">default</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="n">no_superuser_bypass</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.access"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.access"title="Permalink to this definition">¶</a></dt>
<emclass="property">classmethod </em><codeclass="sig-name descname">create</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">key</span></em>, <emclass="sig-param"><spanclass="n">account</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">*</span><spanclass="n">args</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.create"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.create"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">delete</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.delete"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Deletes channel while also cleaning up channelhandler.</p>
<dd><p>Generates the formatted string sent to listeners on a channel.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a>) – Message object to send.</p></li>
<li><p><strong>emit</strong> (<em>bool</em><em>, </em><em>optional</em>) – In emit mode the message is not associated
with a specific sender name.</p></li>
<li><p><strong>prefix</strong> (<em>bool</em><em>, </em><em>optional</em>) – Prefix <strong>msg</strong> with a text given by <strong>self.channel_prefix</strong>.</p></li>
<li><p><strong>sender_strings</strong> (<em>list</em><em>, </em><em>optional</em>) – Used by bots etc, one string per external sender.</p></li>
<li><p><strong>external</strong> (<em>bool</em><em>, </em><em>optional</em>) – If this is an external sender or not.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">distribute_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">online</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.distribute_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.distribute_message"title="Permalink to this definition">¶</a></dt>
<dd><p>Method for grabbing all listeners that a message should be
sent to on this channel, and sending them a message.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em> or </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a>) – Message to distribute.</p></li>
<li><p><strong>online</strong> (<em>bool</em>) – Only send to receivers who are actually online
(not currently used):</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
</dl>
<pclass="rubric">Notes</p>
<p>This is also where logging happens, if enabled.</p>
<dd><p>Send the given message to all accounts connected to channel. Note that
no permission-checking is done here; it is assumed to have been
done before calling this method. The optional keywords are not used if
persistent is False.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em>, </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a><em> or </em><em>str</em>) – If a Msg/TempMsg, the remaining
keywords will be ignored (since the Msg/TempMsg object already
has all the data). If a string, this will either be sent as-is
(if persistent=False) or it will be used together with <strong>header</strong>
and <strong>senders</strong> keywords to create a Msg instance on the fly.</p></li>
<li><p><strong>header</strong> (<em>str</em><em>, </em><em>optional</em>) – A header for building the message.</p></li>
<li><p><strong>senders</strong> (<em>Object</em><em>, </em><em>Account</em><em> or </em><em>list</em><em>, </em><em>optional</em>) – Optional if persistent=False, used
to build senders for the message.</p></li>
<li><p><strong>sender_strings</strong> (<em>list</em><em>, </em><em>optional</em>) – Name strings of senders. Used for external
connections where the sender is not an account or object.
<li><p><strong>keep_log</strong> (<em>bool</em><em> or </em><em>None</em><em>, </em><em>optional</em>) – This allows to temporarily change the logging status of
this channel message. If <strong>None</strong>, the Channel’s <strong>keep_log</strong> Attribute will
be used. If <strong>True</strong> or <strong>False</strong>, that logging status will be used for this
message only (note that for unlogged channels, a <strong>True</strong> value here will
create a new log file only for this message).</p></li>
<li><p><strong>online</strong> (<em>bool</em><em>, </em><em>optional</em>) – online. Otherwise, messages all accounts connected. This can
make things faster, but may not trigger listeners on accounts
that are offline.</p></li>
<li><p><strong>emit</strong> (<em>bool</em><em>, </em><em>optional</em>) – not to be directly associated with a name.</p></li>
<li><p><strong>external</strong> (<em>bool</em><em>, </em><em>optional</em>) – Treat this message as being
<codeclass="sig-name descname">tempmsg</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">message</span></em>, <emclass="sig-param"><spanclass="n">header</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">senders</span><spanclass="o">=</span><spanclass="default_value">None</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.tempmsg"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.tempmsg"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">channel_prefix</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msg</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="n">emit</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.channel_prefix"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.channel_prefix"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">format_senders</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">senders</span><spanclass="o">=</span><spanclass="default_value">None</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_senders"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_senders"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">pose_transform</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">sender_string</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pose_transform"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pose_transform"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Detects if the sender is posing, and modifies the
message accordingly.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em> or </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a>) – The message to analyze for a pose.</p></li>
<li><p><strong>sender_string</strong> (<em>str</em>) – The name of the sender/poser.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
<codeclass="sig-name descname">format_external</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">senders</span></em>, <emclass="sig-param"><spanclass="n">emit</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_external"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_external"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Used for formatting external messages. This is
needed as a separate operation because the senders of external
messages may not be in-game objects/accounts, and so cannot
have things like custom user preferences.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em> or </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a>) – The message to send.</p></li>
<li><p><strong>senders</strong> (<em>list</em>) – Strings, one per sender.</p></li>
<li><p><strong>emit</strong> (<em>bool</em><em>, </em><em>optional</em>) – A sender-agnostic message or not.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>transformed (str)</em>– A formatted string.</p>
<codeclass="sig-name descname">format_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msgobj</span></em>, <emclass="sig-param"><spanclass="n">emit</span><spanclass="o">=</span><spanclass="default_value">False</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.format_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.format_message"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Formats a message body for display.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msgobj</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em> or </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a>) – The message object to send.</p></li>
<li><p><strong>emit</strong> (<em>bool</em><em>, </em><em>optional</em>) – The message is agnostic of senders.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>transformed (str)</em>– The formatted message.</p>
<codeclass="sig-name descname">pre_join_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">joiner</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_join_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_join_channel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">post_join_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">joiner</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_join_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_join_channel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">pre_leave_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">leaver</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_leave_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_leave_channel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">post_leave_channel</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">leaver</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_leave_channel"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_leave_channel"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">pre_send_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msg</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.pre_send_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.pre_send_message"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. Runs before a message is sent to the channel and
should return the message object, after any transformations.
If the message is to be discarded, return a false value.</p>
<dlclass="field-list simple">
<dtclass="field-odd">Parameters</dt>
<ddclass="field-odd"><ulclass="simple">
<li><p><strong>msg</strong> (<aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.Msg"title="evennia.comms.models.Msg"><em>Msg</em></a><em> or </em><aclass="reference internal"href="evennia.comms.models.html#evennia.comms.models.TempMsg"title="evennia.comms.models.TempMsg"><em>TempMsg</em></a>) – Message to send.</p></li>
<li><p><strong>**kwargs</strong> (<em>dict</em>) – Arbitrary, optional arguments for users
overriding the call (unused by default).</p></li>
</ul>
</dd>
<dtclass="field-even">Returns</dt>
<ddclass="field-even"><p><em>result (Msg, TempMsg or bool)</em>– If False, abort send.</p>
<codeclass="sig-name descname">post_send_message</code><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n">msg</span></em>, <emclass="sig-param"><spanclass="o">**</span><spanclass="n">kwargs</span></em><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.post_send_message"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.post_send_message"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">at_init</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.at_init"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.at_init"title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method. This is always called whenever this channel is
initiated – that is, whenever it its typeclass is cached from
memory. This happens on-demand first time the channel is used
or activated in some way after being created but also after
<codeclass="sig-name descname">web_get_admin_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_admin_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_admin_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for the Django Admin page for this object.</p>
<emclass="property">classmethod </em><codeclass="sig-name descname">web_get_create_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_create_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_create_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to create new
instances of this object.</p>
<p>ex. Chargen = ‘/characters/create/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-create’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_detail_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_detail_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_detail_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-detail’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_update_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_update_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_update_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to update this
object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/change/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-update’ would be referenced by this method.</p>
<codeclass="sig-name descname">web_get_delete_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="reference internal"href="../_modules/evennia/comms/comms.html#DefaultChannel.web_get_delete_url"><spanclass="viewcode-link">[source]</span></a><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.web_get_delete_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to delete this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/delete/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-delete’ would be referenced by this method.</p>
<codeclass="sig-name descname">get_absolute_url</code><spanclass="sig-paren">(</span><spanclass="sig-paren">)</span><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.get_absolute_url"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the URI path for a View that allows users to view details for
this object.</p>
<p>ex. Oscar (Character) = ‘/characters/oscar/1/’</p>
<p>For this to work, the developer must have defined a named view somewhere
in urls.py that follows the format ‘modelname-action’, so in this case
a named view of ‘channel-detail’ would be referenced by this method.</p>
<emclass="property">exception </em><codeclass="sig-name descname">DoesNotExist</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.DoesNotExist"title="Permalink to this definition">¶</a></dt>
<emclass="property">exception </em><codeclass="sig-name descname">MultipleObjectsReturned</code><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.MultipleObjectsReturned"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">path</code><emclass="property"> = 'evennia.comms.comms.DefaultChannel'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.path"title="Permalink to this definition">¶</a></dt>
<codeclass="sig-name descname">typename</code><emclass="property"> = 'DefaultChannel'</em><aclass="headerlink"href="#evennia.comms.comms.DefaultChannel.typename"title="Permalink to this definition">¶</a></dt>
