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

556 lines
32 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>ParlorMarshaller (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="ParlorMarshaller (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":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/ParlorMarshaller.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/data/ParlorCodes.html" title="interface in com.threerings.parlor.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/data/ParlorMarshaller.html" target="_top">Frames</a></li>
<li><a href="ParlorMarshaller.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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.data</div>
<h2 title="Class ParlorMarshaller" class="title">Class ParlorMarshaller</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.presents.data.InvocationMarshaller</li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.data.ParlorMarshaller</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.io.Streamable, <a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a>, com.threerings.presents.client.InvocationService</dd>
</dl>
<hr>
<br>
<pre>@Generated(value="com.threerings.presents.tools.GenServiceTask",
comments="Derived from ParlorService.java.")
public class <span class="typeNameLabel">ParlorMarshaller</span>
extends com.threerings.presents.data.InvocationMarshaller
implements <a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></pre>
<div class="block">Provides the implementation of the <a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client"><code>ParlorService</code></a> interface
that marshalls the arguments and delivers the request to the provider
on the server. Also provides an implementation of the response listener
interfaces that marshall the response arguments and deliver them back
to the requesting client.</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">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html" title="class in com.threerings.parlor.data">ParlorMarshaller.InviteMarshaller</a></span></code>
<div class="block">Marshalls results to implementations of <code>ParlorService.InviteListener</code>.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.presents.data.InvocationMarshaller">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.threerings.presents.data.InvocationMarshaller</h3>
<code>com.threerings.presents.data.InvocationMarshaller.ConfirmMarshaller, com.threerings.presents.data.InvocationMarshaller.ListenerMarshaller, com.threerings.presents.data.InvocationMarshaller.ResultMarshaller</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.parlor.client.ParlorService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.parlor.client.<a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></h3>
<code><a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a></code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.io.Streamable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.io.Streamable</h3>
<code>com.threerings.io.Streamable.Closure</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#CANCEL">CANCEL</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-"><code>cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#INVITE">INVITE</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.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>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#RESPOND">RESPOND</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-"><code>respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> requests.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#START_SOLITAIRE">START_SOLITAIRE</a></span></code>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
</td>
</tr>
</table>
</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/data/ParlorMarshaller.html#ParlorMarshaller--">ParlorMarshaller</a></span>()</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/data/ParlorMarshaller.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">cancel</a></span>(int&nbsp;arg1,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;arg2)</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/data/ParlorMarshaller.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;arg1,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;arg2,
<a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a>&nbsp;arg3)</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/data/ParlorMarshaller.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">respond</a></span>(int&nbsp;arg1,
int&nbsp;arg2,
<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;arg3,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;arg4)</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/data/ParlorMarshaller.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;arg1,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg2)</code>
<div class="block">Requests to start a single player game with the specified game configuration.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.presents.data.InvocationMarshaller">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.presents.data.InvocationMarshaller</h3>
<code>getInvocationCode, init, readObject, setInvocationOid, setNoResponse, toString</code></li>
</ul>
<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#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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="CANCEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANCEL</h4>
<pre>public static final&nbsp;int CANCEL</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-"><code>cancel(int, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.data.ParlorMarshaller.CANCEL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="INVITE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>INVITE</h4>
<pre>public static final&nbsp;int INVITE</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.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>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.data.ParlorMarshaller.INVITE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RESPOND">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RESPOND</h4>
<pre>public static final&nbsp;int RESPOND</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-"><code>respond(int, int, java.lang.Object, com.threerings.presents.client.InvocationService.InvocationListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.data.ParlorMarshaller.RESPOND">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="START_SOLITAIRE">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>START_SOLITAIRE</h4>
<pre>public static final&nbsp;int START_SOLITAIRE</pre>
<div class="block">The method id used to dispatch <a href="../../../../com/threerings/parlor/data/ParlorMarshaller.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-"><code>startSolitaire(com.threerings.parlor.game.data.GameConfig, com.threerings.presents.client.InvocationService.ConfirmListener)</code></a> requests.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.threerings.parlor.data.ParlorMarshaller.START_SOLITAIRE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ParlorMarshaller--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ParlorMarshaller</h4>
<pre>public&nbsp;ParlorMarshaller()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cancel</h4>
<pre>public&nbsp;void&nbsp;cancel(int&nbsp;arg1,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;arg2)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">ParlorService</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/client/ParlorService.html#cancel-int-com.threerings.presents.client.InvocationService.InvocationListener-">cancel</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the unique id previously assigned by the server to this invitation.</dd>
<dd><code>arg2</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<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>public&nbsp;void&nbsp;invite(com.threerings.util.Name&nbsp;arg1,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;arg2,
<a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a>&nbsp;arg3)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><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-">ParlorService</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><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></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the username of the user to be invited.</dd>
<dd><code>arg2</code> - a game config object detailing the type and configuration of the game to be
created.</dd>
<dd><code>arg3</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>public&nbsp;void&nbsp;respond(int&nbsp;arg1,
int&nbsp;arg2,
<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;arg3,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;arg4)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">ParlorService</a></code></span></div>
<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="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/client/ParlorService.html#respond-int-int-java.lang.Object-com.threerings.presents.client.InvocationService.InvocationListener-">respond</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>arg1</code> - the unique id previously assigned by the server to this invitation.</dd>
<dd><code>arg2</code> - the response code to use in responding to the invitation.</dd>
<dd><code>arg3</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>arg4</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>public&nbsp;void&nbsp;startSolitaire(<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;arg1,
com.threerings.presents.client.InvocationService.ConfirmListener&nbsp;arg2)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ConfirmListener-">ParlorService</a></code></span></div>
<div class="block">Requests to start a single player game with the specified game configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../com/threerings/parlor/client/ParlorService.html#startSolitaire-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/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></code></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/ParlorMarshaller.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/data/ParlorCodes.html" title="interface in com.threerings.parlor.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/threerings/parlor/data/ParlorMarshaller.InviteMarshaller.html" title="class in com.threerings.parlor.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/data/ParlorMarshaller.html" target="_top">Frames</a></li>
<li><a href="ParlorMarshaller.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><a href="#field.summary">Field</a>&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><a href="#field.detail">Field</a>&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