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

496 lines
31 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>ParlorManager (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="ParlorManager (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/ParlorManager.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>Prev&nbsp;Class</li>
<li><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/server/ParlorManager.html" target="_top">Frames</a></li>
<li><a href="ParlorManager.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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.server</div>
<h2 title="Class ParlorManager" class="title">Class ParlorManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><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">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.server.ParlorManager</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</a>, <a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a>, com.threerings.presents.data.InvocationCodes, com.threerings.presents.server.InvocationProvider</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">ParlorManager</span>
extends <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>
implements <a href="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</a>, <a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a></pre>
<div class="block">The parlor manager is responsible for the parlor services in aggregate. This includes
maintaining the registry of active games, handling the necessary coordination for the
matchmaking services and anything else that falls outside the scope of an actual in-progress
game.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.parlor.data.ParlorCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.parlor.data.<a href="../../../../com/threerings/parlor/data/ParlorCodes.html" title="interface in com.threerings.parlor.data">ParlorCodes</a></h3>
<code><a href="../../../../com/threerings/parlor/data/ParlorCodes.html#ALREADY_AT_TABLE">ALREADY_AT_TABLE</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#BANNED_FROM_TABLE">BANNED_FROM_TABLE</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#GAME_ALREADY_STARTED">GAME_ALREADY_STARTED</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVALID_TABLE_POSITION">INVALID_TABLE_POSITION</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_ACCEPTED">INVITATION_ACCEPTED</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_COUNTERED">INVITATION_COUNTERED</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_REFUSED">INVITATION_REFUSED</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITEE_NOT_ONLINE">INVITEE_NOT_ONLINE</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#MUST_BE_CREATOR">MUST_BE_CREATOR</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SELF_BOOT">NO_SELF_BOOT</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#NO_SUCH_TABLE">NO_SUCH_TABLE</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#NOT_AT_TABLE">NOT_AT_TABLE</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#PARLOR_GROUP">PARLOR_GROUP</a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#TABLE_POSITION_OCCUPIED">TABLE_POSITION_OCCUPIED</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.presents.data.InvocationCodes">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.presents.data.InvocationCodes</h3>
<code>ACCESS_DENIED, E_ACCESS_DENIED, E_INTERNAL_ERROR, GLOBAL_GROUP, INTERNAL_ERROR</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/server/ParlorManager.html#ParlorManager-com.threerings.presents.server.InvocationManager-">ParlorManager</a></span>(com.threerings.presents.server.InvocationManager&nbsp;invmgr)</code>&nbsp;</td>
</tr>
</table>
</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/server/ParlorManager.html#cancel-com.threerings.presents.data.ClientObject-int-com.threerings.presents.client.InvocationService.InvocationListener-">cancel</a></span>(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-"><code>ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> request.</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/server/ParlorManager.html#cancelInvite-com.threerings.crowd.data.BodyObject-int-">cancelInvite</a></span>(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId)</code>
<div class="block">Requests that an outstanding invitation be cancelled.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/server/ParlorManager.html#invite-com.threerings.crowd.data.BodyObject-com.threerings.crowd.data.BodyObject-com.threerings.parlor.game.data.GameConfig-">invite</a></span>(com.threerings.crowd.data.BodyObject&nbsp;inviter,
com.threerings.crowd.data.BodyObject&nbsp;invitee,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config)</code>
<div class="block">Issues an invitation from the <code>inviter</code> to the <code>invitee</code> for a game as
described by the supplied config object.</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/server/ParlorManager.html#invite-com.threerings.presents.data.ClientObject-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-">invite</a></span>(com.threerings.presents.data.ClientObject&nbsp;caller,
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">Handles a <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>ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</code></a> request.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/server/ParlorManager.html#respond-com.threerings.presents.data.ClientObject-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">respond</a></span>(com.threerings.presents.data.ClientObject&nbsp;caller,
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">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-"><code>ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> request.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/server/ParlorManager.html#respondToInvite-com.threerings.crowd.data.BodyObject-int-int-java.lang.Object-">respondToInvite</a></span>(com.threerings.crowd.data.BodyObject&nbsp;source,
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)</code>
<div class="block">Effects a response to an invitation (accept, refuse or counter), made by the specified
source user with the specified arguments.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/server/ParlorManager.html#startSolitaire-com.threerings.presents.data.ClientObject-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">startSolitaire</a></span>(com.threerings.presents.data.ClientObject&nbsp;caller,
<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">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> request.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<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></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ParlorManager-com.threerings.presents.server.InvocationManager-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParlorManager</h4>
<pre>@Inject
public&nbsp;ParlorManager(com.threerings.presents.server.InvocationManager&nbsp;invmgr)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="invite-com.threerings.presents.data.ClientObject-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>public&nbsp;void&nbsp;invite(com.threerings.presents.data.ClientObject&nbsp;caller,
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)
throws com.threerings.presents.server.InvocationException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#invite-com.threerings.presents.data.ClientObject-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-">ParlorProvider</a></code></span></div>
<div class="block">Handles a <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>ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#invite-com.threerings.presents.data.ClientObject-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-">invite</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.threerings.presents.server.InvocationException</code></dd>
</dl>
</li>
</ul>
<a name="respond-com.threerings.presents.data.ClientObject-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>respond</h4>
<pre>public&nbsp;void&nbsp;respond(com.threerings.presents.data.ClientObject&nbsp;caller,
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"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#respond-com.threerings.presents.data.ClientObject-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">ParlorProvider</a></code></span></div>
<div class="block">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-"><code>ParlorService.respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#respond-com.threerings.presents.data.ClientObject-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">respond</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="cancel-com.threerings.presents.data.ClientObject-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public&nbsp;void&nbsp;cancel(com.threerings.presents.data.ClientObject&nbsp;caller,
int&nbsp;inviteId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#cancel-com.threerings.presents.data.ClientObject-int-com.threerings.presents.client.InvocationService.InvocationListener-">ParlorProvider</a></code></span></div>
<div class="block">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-"><code>ParlorService.cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#cancel-com.threerings.presents.data.ClientObject-int-com.threerings.presents.client.InvocationService.InvocationListener-">cancel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a></code></dd>
</dl>
</li>
</ul>
<a name="startSolitaire-com.threerings.presents.data.ClientObject-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startSolitaire</h4>
<pre>public&nbsp;void&nbsp;startSolitaire(com.threerings.presents.data.ClientObject&nbsp;caller,
<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)
throws com.threerings.presents.server.InvocationException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#startSolitaire-com.threerings.presents.data.ClientObject-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">ParlorProvider</a></code></span></div>
<div class="block">Handles a <a href="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>ParlorService.startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> request.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html#startSolitaire-com.threerings.presents.data.ClientObject-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">startSolitaire</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server">ParlorProvider</a></code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.threerings.presents.server.InvocationException</code></dd>
</dl>
</li>
</ul>
<a name="invite-com.threerings.crowd.data.BodyObject-com.threerings.crowd.data.BodyObject-com.threerings.parlor.game.data.GameConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invite</h4>
<pre>public&nbsp;int&nbsp;invite(com.threerings.crowd.data.BodyObject&nbsp;inviter,
com.threerings.crowd.data.BodyObject&nbsp;invitee,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config)
throws com.threerings.presents.server.InvocationException</pre>
<div class="block">Issues an invitation from the <code>inviter</code> to the <code>invitee</code> for a game as
described by the supplied config object.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>inviter</code> - the player initiating the invitation.</dd>
<dd><code>invitee</code> - the player being invited.</dd>
<dd><code>config</code> - the configuration of the game being proposed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the invitation identifier for the newly created invitation record.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>com.threerings.presents.server.InvocationException</code> - thrown if the invitation was not able to be processed for
some reason (like the invited player has requested not to be disturbed). The explanation
will be provided in the message data of the exception.</dd>
</dl>
</li>
</ul>
<a name="respondToInvite-com.threerings.crowd.data.BodyObject-int-int-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>respondToInvite</h4>
<pre>public&nbsp;void&nbsp;respondToInvite(com.threerings.crowd.data.BodyObject&nbsp;source,
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)</pre>
<div class="block">Effects a response to an invitation (accept, refuse or counter), made by the specified
source user with the specified arguments.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the body object of the user that is issuing this response.</dd>
<dd><code>inviteId</code> - the identifier of the invitation to which we are responding.</dd>
<dd><code>code</code> - the response code (either <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_ACCEPTED"><code>ParlorCodes.INVITATION_ACCEPTED</code></a>, <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_REFUSED"><code>ParlorCodes.INVITATION_REFUSED</code></a> or <a href="../../../../com/threerings/parlor/data/ParlorCodes.html#INVITATION_COUNTERED"><code>ParlorCodes.INVITATION_COUNTERED</code></a>).</dd>
<dd><code>arg</code> - the argument that goes along with the response: an explanatory message in the
case of a refusal (the empty string, not null, if no message was provided) or the new game
configuration in the case of a counter-invitation.</dd>
</dl>
</li>
</ul>
<a name="cancelInvite-com.threerings.crowd.data.BodyObject-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>cancelInvite</h4>
<pre>public&nbsp;void&nbsp;cancelInvite(com.threerings.crowd.data.BodyObject&nbsp;source,
int&nbsp;inviteId)</pre>
<div class="block">Requests that an outstanding invitation be cancelled.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the body object of the user that is making the request.</dd>
<dd><code>inviteId</code> - the unique id of the invitation to be cancelled.</dd>
</dl>
</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/ParlorManager.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>Prev&nbsp;Class</li>
<li><a href="../../../../com/threerings/parlor/server/ParlorProvider.html" title="interface in com.threerings.parlor.server"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/server/ParlorManager.html" target="_top">Frames</a></li>
<li><a href="ParlorManager.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>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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