AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/parlor/client/ParlorService.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

357 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ParlorService (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ParlorService (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ParlorService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/ParlorService.html" target="_top">Frames</a></li>
<li><a href="ParlorService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.parlor.client</div>
<h2 title="Interface ParlorService" class="title">Interface ParlorService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.threerings.presents.client.InvocationService</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html" title="class in com.threerings.parlor.data">ParlorMarshaller</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ParlorService</span>
extends com.threerings.presents.client.InvocationService</pre>
<div class="block">Provides an interface to the various parlor invocation services. Presently these services are
limited to the various matchmaking mechanisms. It is unlikely that client code will want to make
direct use of this class, instead they would make use of the programmatic interface provided by
the <a href="../../../../com/threerings/parlor/client/ParlorDirector.html" title="class in com.threerings.parlor.client"><code>ParlorDirector</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static interface&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a></span></code>
<div class="block">Used to communicate responses to <a href="../../../../com/threerings/parlor/client/ParlorService.html#invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-"><code>invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</code></a> requests.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.presents.client.InvocationService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.presents.client.InvocationService</h3>
<code>com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorService.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">cancel</a></span>(int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">You probably don't want to call this directly, but want to call <a href="../../../../com/threerings/parlor/client/Invitation.html#cancel--"><code>Invitation.cancel()</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorService.html#invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-">invite</a></span>(com.threerings.util.Name&nbsp;invitee,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
<a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a>&nbsp;listener)</code>
<div class="block">You probably don't want to call this directly, but want to generate your invitation request
via <a href="../../../../com/threerings/parlor/client/ParlorDirector.html#invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.InvitationResponseObserver-"><code>ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver)</code></a>.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorService.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">respond</a></span>(int&nbsp;inviteId,
int&nbsp;code,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;arg,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">You probably don't want to call this directly, but want to call one of <a href="../../../../com/threerings/parlor/client/Invitation.html#accept--"><code>Invitation.accept()</code></a>, <a href="../../../../com/threerings/parlor/client/Invitation.html#refuse-java.lang.String-"><code>Invitation.refuse(java.lang.String)</code></a>, or <a href="../../../../com/threerings/parlor/client/Invitation.html#counter-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.InvitationResponseObserver-"><code>Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver)</code></a>.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">startSolitaire</a></span>(<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</code>
<div class="block">Requests to start a single player game with the specified game configuration.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invite</h4>
<pre>void&nbsp;invite(com.threerings.util.Name&nbsp;invitee,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
<a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a>&nbsp;listener)</pre>
<div class="block">You probably don't want to call this directly, but want to generate your invitation request
via <a href="../../../../com/threerings/parlor/client/ParlorDirector.html#invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.InvitationResponseObserver-"><code>ParlorDirector.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver)</code></a>. Requests that an invitation be delivered to the named
user, requesting that they join the inviting user in a game, the details of which are
specified in the supplied game config object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>invitee</code> - the username of the user to be invited.</dd>
<dd><code>config</code> - a game config object detailing the type and configuration of the game to be
created.</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>respond</h4>
<pre>void&nbsp;respond(int&nbsp;inviteId,
int&nbsp;code,
<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;arg,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">You probably don't want to call this directly, but want to call one of <a href="../../../../com/threerings/parlor/client/Invitation.html#accept--"><code>Invitation.accept()</code></a>, <a href="../../../../com/threerings/parlor/client/Invitation.html#refuse-java.lang.String-"><code>Invitation.refuse(java.lang.String)</code></a>, or <a href="../../../../com/threerings/parlor/client/Invitation.html#counter-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.InvitationResponseObserver-"><code>Invitation.counter(com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.InvitationResponseObserver)</code></a>. Requests that
an invitation response be delivered with the specified parameters.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inviteId</code> - the unique id previously assigned by the server to this invitation.</dd>
<dd><code>code</code> - the response code to use in responding to the invitation.</dd>
<dd><code>arg</code> - the argument associated with the response (a string message from the player
explaining why the response was refused in the case of an invitation refusal or an updated
game configuration object in the case of a counter-invitation, or null in the case of an
accepted invitation).</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>void&nbsp;cancel(int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">You probably don't want to call this directly, but want to call <a href="../../../../com/threerings/parlor/client/Invitation.html#cancel--"><code>Invitation.cancel()</code></a>. Requests that an outstanding invitation be cancelled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inviteId</code> - the unique id previously assigned by the server to this invitation.</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>startSolitaire</h4>
<pre>void&nbsp;startSolitaire(<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;listener)</pre>
<div class="block">Requests to start a single player game with the specified game configuration.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ParlorService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/ParlorService.html" target="_top">Frames</a></li>
<li><a href="ParlorService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink