docs/ExceptionHunter/Notifiers/SlackNotifier.html
<!DOCTYPE html><html> <head> <meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title> Class: ExceptionHunter::Notifiers::SlackNotifier — Documentation by YARD 0.9.26 </title> <link rel="stylesheet" href="../../css/style.css" type="text/css" /> <link rel="stylesheet" href="../../css/common.css" type="text/css" /> <script type="text/javascript"> pathId = "ExceptionHunter::Notifiers::SlackNotifier"; relpath = '../../';</script> <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script> </head> <body> <div class="nav_wrap"> <iframe id="nav" src="../../class_list.html?1"></iframe> <div id="resizer"></div> </div> <div id="main" tabindex="-1"> <div id="header"> <div id="menu"> <a href="../../_index.html">Index (S)</a> » <span class='title'><span class='object_link'><a href="../../ExceptionHunter.html" title="ExceptionHunter (module)">ExceptionHunter</a></span></span> » <span class='title'><span class='object_link'><a href="../Notifiers.html" title="ExceptionHunter::Notifiers (module)">Notifiers</a></span></span> » <span class="title">SlackNotifier</span> </div> <div id="search"> <a class="full_list_link" id="class_list_link" href="../../class_list.html"> <svg width="24" height="24"> <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect> <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect> </svg> </a> </div> <div class="clear"></div> </div> <div id="content"><h1>Class: ExceptionHunter::Notifiers::SlackNotifier </h1><div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">ExceptionHunter::Notifiers::SlackNotifier</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/exception_hunter/notifiers/slack_notifier.rb</dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Notifier that sends a message to a Slack channel every time an exception is tracked.</p> </div></div><div class="tags"> </div> <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#error-instance_method" title="#error (instance method)">#<strong>error</strong> ⇒ Object </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#notifier-instance_method" title="#notifier (instance method)">#<strong>notifier</strong> ⇒ Object </a> </span> <span class="note title readonly">readonly</span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <h2> Instance Method Summary <small><a href="#" class="summary_toggle">collapse</a></small> </h2> <ul class="summary"> <li class="public "> <span class="summary_signature"> <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(error, notifier) ⇒ SlackNotifier </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'><p>A new instance of SlackNotifier.</p></div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#notify-instance_method" title="#notify (instance method)">#<strong>notify</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #<strong>initialize</strong>(error, notifier) ⇒ <tt><span class='object_link'><a href="" title="ExceptionHunter::Notifiers::SlackNotifier (class)">SlackNotifier</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Returns a new instance of SlackNotifier.</p> </div></div><div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 10111213</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/exception_hunter/notifiers/slack_notifier.rb', line 10</span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_error'>error</span><span class='comma'>,</span> <span class='id identifier rubyid_notifier'>notifier</span><span class='rparen'>)</span> <span class='ivar'>@error</span> <span class='op'>=</span> <span class='id identifier rubyid_error'>error</span> <span class='ivar'>@notifier</span> <span class='op'>=</span> <span class='id identifier rubyid_notifier'>notifier</span><span class='kw'>end</span></pre> </td> </tr></table></div> </div> <div id="instance_attr_details" class="attr_details"> <h2>Instance Attribute Details</h2> <span id=""></span> <div class="method_details first"> <h3 class="signature first" id="error-instance_method"> #<strong>error</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> </div></div><div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 8910</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/exception_hunter/notifiers/slack_notifier.rb', line 8</span> <span class='kw'>def</span> <span class='id identifier rubyid_error'>error</span> <span class='ivar'>@error</span><span class='kw'>end</span></pre> </td> </tr></table></div> <span id=""></span> <div class="method_details "> <h3 class="signature " id="notifier-instance_method"> #<strong>notifier</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span> </h3><div class="docstring"> <div class="discussion"> </div></div><div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 8910</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/exception_hunter/notifiers/slack_notifier.rb', line 8</span> <span class='kw'>def</span> <span class='id identifier rubyid_notifier'>notifier</span> <span class='ivar'>@notifier</span><span class='kw'>end</span></pre> </td> </tr></table></div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="notify-instance_method"> #<strong>notify</strong> ⇒ <tt>Object</tt> </h3><div class="docstring"> <div class="discussion"> </div></div><div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 15161718</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/exception_hunter/notifiers/slack_notifier.rb', line 15</span> <span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span> <span class='id identifier rubyid_slack_notifier'>slack_notifier</span> <span class='op'>=</span> <span class='const'>Slack</span><span class='op'>::</span><span class='const'>Notifier</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_notifier'>notifier</span><span class='lbracket'>[</span><span class='symbol'>:options</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:webhook</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='id identifier rubyid_slack_notifier'>slack_notifier</span><span class='period'>.</span><span class='id identifier rubyid_ping'>ping</span><span class='lparen'>(</span><span class='id identifier rubyid_slack_notification_message'>slack_notification_message</span><span class='rparen'>)</span><span class='kw'>end</span></pre> </td> </tr></table></div> </div> </div> <div id="footer"> Generated on Fri Jul 30 14:46:20 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-2.6.5).</div> </div> </body></html>