File: C:/Ruby27-x64/share/doc/ruby/html/Gem/UserInteraction.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::UserInteraction - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="DefaultUserInteraction.html">Gem::DefaultUserInteraction</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-alert">#alert</a>
<li ><a href="#method-i-alert_error">#alert_error</a>
<li ><a href="#method-i-alert_warning">#alert_warning</a>
<li ><a href="#method-i-ask">#ask</a>
<li ><a href="#method-i-ask_for_password">#ask_for_password</a>
<li ><a href="#method-i-ask_yes_no">#ask_yes_no</a>
<li ><a href="#method-i-choose_from_list">#choose_from_list</a>
<li ><a href="#method-i-say">#say</a>
<li ><a href="#method-i-terminate_interaction">#terminate_interaction</a>
<li ><a href="#method-i-verbose">#verbose</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::UserInteraction">
<h1 id="module-Gem::UserInteraction" class="module">
module Gem::UserInteraction
</h1>
<section class="description">
<p><a href="UserInteraction.html"><code>UserInteraction</code></a> allows RubyGems to interact with the user through standard methods that can be replaced with more-specific UI methods for different displays.</p>
<p>Since <a href="UserInteraction.html"><code>UserInteraction</code></a> dispatches to a concrete UI class you may need to reference other classes for specific behavior such as <a href="ConsoleUI.html"><code>Gem::ConsoleUI</code></a> or <a href="SilentUI.html"><code>Gem::SilentUI</code></a>.</p>
<p>Example:</p>
<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">X</span>
<span class="ruby-identifier">include</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">UserInteraction</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">get_answer</span>
<span class="ruby-identifier">n</span> = <span class="ruby-identifier">ask</span>(<span class="ruby-string">"What is the meaning of life?"</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
</pre>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-alert" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert</span><span
class="method-args">(statement, question = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays an alert <code>statement</code>. Asks a <code>question</code> if given.</p>
<div class="method-source-code" id="alert-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">alert</span> <span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-alert_error" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert_error</span><span
class="method-args">(statement, question = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays an error <code>statement</code> to the error output location. Asks a <code>question</code> if given.</p>
<div class="method-source-code" id="alert_error-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 109</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert_error</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">alert_error</span> <span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-alert_warning" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert_warning</span><span
class="method-args">(statement, question = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays a warning <code>statement</code> to the warning output location. Asks a <code>question</code> if given.</p>
<div class="method-source-code" id="alert_warning-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 117</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert_warning</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">alert_warning</span> <span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask</span><span
class="method-args">(question)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Asks a <code>question</code> and returns the answer.</p>
<div class="method-source-code" id="ask-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 124</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask</span>(<span class="ruby-identifier">question</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">ask</span> <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask_for_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask_for_password</span><span
class="method-args">(prompt)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Asks for a password with a <code>prompt</code></p>
<div class="method-source-code" id="ask_for_password-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 131</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask_for_password</span>(<span class="ruby-identifier">prompt</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">ask_for_password</span> <span class="ruby-identifier">prompt</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask_yes_no" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask_yes_no</span><span
class="method-args">(question, default = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Asks a yes or no <code>question</code>. Returns true for yes, false for no.</p>
<div class="method-source-code" id="ask_yes_no-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 138</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask_yes_no</span>(<span class="ruby-identifier">question</span>, <span class="ruby-identifier">default</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">ask_yes_no</span> <span class="ruby-identifier">question</span>, <span class="ruby-identifier">default</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-choose_from_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">choose_from_list</span><span
class="method-args">(question, list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Asks the user to answer <code>question</code> with an answer from the given <code>list</code>.</p>
<div class="method-source-code" id="choose_from_list-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 145</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">choose_from_list</span>(<span class="ruby-identifier">question</span>, <span class="ruby-identifier">list</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">choose_from_list</span> <span class="ruby-identifier">question</span>, <span class="ruby-identifier">list</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-say" class="method-detail ">
<div class="method-heading">
<span class="method-name">say</span><span
class="method-args">(statement = '')</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Displays the given <code>statement</code> on the standard output (or equivalent).</p>
<div class="method-source-code" id="say-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 152</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">say</span>(<span class="ruby-identifier">statement</span> = <span class="ruby-string">''</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">say</span> <span class="ruby-identifier">statement</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-terminate_interaction" class="method-detail ">
<div class="method-heading">
<span class="method-name">terminate_interaction</span><span
class="method-args">(exit_code = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Terminates the RubyGems process with the given <code>exit_code</code></p>
<div class="method-source-code" id="terminate_interaction-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 159</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">terminate_interaction</span>(<span class="ruby-identifier">exit_code</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">ui</span>.<span class="ruby-identifier">terminate_interaction</span> <span class="ruby-identifier">exit_code</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-verbose" class="method-detail ">
<div class="method-heading">
<span class="method-name">verbose</span><span
class="method-args">(msg = nil) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls <code>say</code> with <code>msg</code> or the results of the block if really_verbose is true.</p>
<div class="method-source-code" id="verbose-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 167</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">verbose</span>(<span class="ruby-identifier">msg</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">say</span>(<span class="ruby-identifier">clean_text</span>(<span class="ruby-identifier">msg</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">yield</span>)) <span class="ruby-keyword">if</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">really_verbose</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>