mirror of
https://github.com/psforever/PSF-LoginServer.git
synced 2026-02-26 10:03:41 +00:00
51 lines
66 KiB
HTML
51 lines
66 KiB
HTML
<!DOCTYPE html ><html><head><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport"/><title>PSF-LoginServer - master - net.psforever.services.teamwork.SquadSubscriptionEntity</title><meta content="PSF - LoginServer - master - net.psforever.services.teamwork.SquadSubscriptionEntity" name="description"/><meta content="PSF LoginServer master net.psforever.services.teamwork.SquadSubscriptionEntity" name="keywords"/><meta http-equiv="content-type" content="text/html; charset=UTF-8"/><link href="../../../../lib/index.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/template.css" media="screen" type="text/css" rel="stylesheet"/><link href="../../../../lib/print.css" media="print" type="text/css" rel="stylesheet"/><link href="../../../../lib/diagrams.css" media="screen" type="text/css" rel="stylesheet" id="diagrams-css"/><script type="text/javascript" src="../../../../lib/jquery.min.js"></script><script type="text/javascript" src="../../../../lib/index.js"></script><script type="text/javascript" src="../../../../index.js"></script><script type="text/javascript" src="../../../../lib/scheduler.js"></script><script type="text/javascript" src="../../../../lib/template.js"></script><script type="text/javascript">/* this variable can be used by the JS to determine the path to the root document */
|
|
var toRoot = '../../../../';</script></head><body><div id="search"><span id="doc-title">PSF-LoginServer - <span id="doc-version">master</span></span> <span class="close-results"><span class="left"><</span> Back</span><div id="textfilter"><span class="input"><input autocapitalize="none" placeholder="Search" id="index-input" type="text" accesskey="/"/><i class="clear material-icons"></i><i id="search-icon" class="material-icons"></i></span></div></div><div id="search-results"><div id="search-progress"><div id="progress-fill"></div></div><div id="results-content"><div id="entity-results"></div><div id="member-results"></div></div></div><div id="content-scroll-container" style="-webkit-overflow-scrolling: touch;"><div id="content-container" style="-webkit-overflow-scrolling: touch;"><div id="subpackage-spacer"><div id="packages"><h1>Packages</h1><ul><li class="indented0 " name="_root_.root" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="_root_"></a><a id="root:_root_"></a> <span class="permalink"><a href="../../../../index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../../index.html" title=""><span class="name">root</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented1 " name="_root_.net" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="net"></a><a id="net:net"></a> <span class="permalink"><a href="../../../../net/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../../index.html" title=""><span class="name">net</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../../index.html" name="_root_" id="_root_" class="extype">root</a></dd></dl></div></li><li class="indented2 " name="net.psforever" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="psforever"></a><a id="psforever:psforever"></a> <span class="permalink"><a href="../../../../net/psforever/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../../index.html" title=""><span class="name">psforever</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../../index.html" name="net" id="net" class="extype">net</a></dd></dl></div></li><li class="indented3 " name="net.psforever.services" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="services"></a><a id="services:services"></a> <span class="permalink"><a href="../../../../net/psforever/services/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="../index.html" title=""><span class="name">services</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a></dd></dl></div></li><li class="indented4 " name="net.psforever.services.teamwork" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="teamwork"></a><a id="teamwork:teamwork"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/index.html" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">package</span></span> <span class="symbol"><a href="index.html" title=""><span class="name">teamwork</span></a></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd><a href="../index.html" name="net.psforever.services" id="net.psforever.services" class="extype">services</a></dd></dl></div></li><li class="current-entities indented4"><span class="separator"></span> <a href="SquadAction$.html" title="" class="object"></a><a href="SquadAction$.html" title="">SquadAction</a></li><li class="current-entities indented4"><a href="SquadInvitationManager$.html" title="" class="object"></a> <a href="SquadInvitationManager.html" title="" class="class"></a><a href="SquadInvitationManager.html" title="">SquadInvitationManager</a></li><li class="current-entities indented4"><span class="separator"></span> <a href="SquadResponse$.html" title="" class="object"></a><a href="SquadResponse$.html" title="">SquadResponse</a></li><li class="current-entities indented4"><a href="SquadService$.html" title="" class="object"></a> <a href="SquadService.html" title="" class="class"></a><a href="SquadService.html" title="">SquadService</a></li><li class="current-entities indented4"><a href="SquadServiceMessage$.html" title="" class="object"></a> <a href="SquadServiceMessage.html" title="" class="class"></a><a href="SquadServiceMessage.html" title="">SquadServiceMessage</a></li><li class="current-entities indented4"><a href="SquadServiceResponse$.html" title="" class="object"></a> <a href="SquadServiceResponse.html" title="" class="class"></a><a href="SquadServiceResponse.html" title="">SquadServiceResponse</a></li><li class="current-entities indented4"><a href="SquadSubscriptionEntity$.html" title="" class="object"></a> <a href="" title="" class="class"></a><a href="" title="">SquadSubscriptionEntity</a></li><li class="current-entities indented4"><a href="SquadSwitchboard$.html" title="" class="object"></a> <a href="SquadSwitchboard.html" title="The dedicated messaging switchboard for members and observers of a given squad." class="class"></a><a href="SquadSwitchboard.html" title="The dedicated messaging switchboard for members and observers of a given squad.">SquadSwitchboard</a></li></ul></div></div><div id="content"><body class="class type"><div id="definition"><a href="SquadSubscriptionEntity$.html" title="See companion object"><div class="big-circle class-companion-object">c</div></a><p id="owner"><a href="../../../index.html" name="net" id="net" class="extype">net</a>.<a href="../../index.html" name="net.psforever" id="net.psforever" class="extype">psforever</a>.<a href="../index.html" name="net.psforever.services" id="net.psforever.services" class="extype">services</a>.<a href="index.html" name="net.psforever.services.teamwork" id="net.psforever.services.teamwork" class="extype">teamwork</a></p><h1><a href="SquadSubscriptionEntity$.html" title="See companion object">SquadSubscriptionEntity</a><span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html" title="Permalink"><i class="material-icons"></i></a></span></h1><h3><span class="morelinks"><div>Companion <a href="SquadSubscriptionEntity$.html" title="See companion object">object SquadSubscriptionEntity</a></div></span></h3></div><h4 id="signature" class="signature"><span class="modifier_kind"><span class="modifier"></span> <span class="kind">class</span></span> <span class="symbol"><span class="name">SquadSubscriptionEntity</span><span class="result"> extends <span name="scala.AnyRef" class="extype">AnyRef</span></span></span></h4><div id="comment" class="fullcommenttop"><dl class="attributes block"><dt>Source</dt><dd><a href="https://github.com/psforever/PSF-LoginServer/blob/master//home/runner/work/PSF-LoginServer/PSF-LoginServer/src/main/scala/net/psforever/services/teamwork/SquadSubscriptionEntity.scala" target="_blank">SquadSubscriptionEntity.scala</a></dd></dl><div class="toggleContainer"><div class="toggle block"><span>Linear Supertypes</span><div class="superTypes hiddenContent"><span name="scala.AnyRef" class="extype">AnyRef</span>, <span name="scala.Any" class="extype">Any</span></div></div></div></div><div id="mbrsel"><div class="toggle"></div><div id="memberfilter"><i class="material-icons arrow"></i><span class="input"><input placeholder="Filter all members" id="mbrsel-input" type="text" accesskey="/"/></span><i class="clear material-icons"></i></div><div id="filterby"><div id="order"><span class="filtertype">Ordering</span><ol><li class="alpha in"><span>Alphabetic</span></li><li class="inherit out"><span>By Inheritance</span></li></ol></div><div class="ancestors"><span class="filtertype">Inherited<br/></span><ol id="linearization"><li class="in" name="net.psforever.services.teamwork.SquadSubscriptionEntity"><span>SquadSubscriptionEntity</span></li><li class="in" name="scala.AnyRef"><span>AnyRef</span></li><li class="in" name="scala.Any"><span>Any</span></li></ol></div><div class="ancestors"><span class="filtertype"></span><ol><li class="hideall out"><span>Hide All</span></li><li class="showall in"><span>Show All</span></li></ol></div><div id="visbl"><span class="filtertype">Visibility</span><ol><li class="public in"><span>Public</span></li><li class="protected out"><span>Protected</span></li></ol></div></div></div><div id="template"><div id="allMembers"><div id="constructors" class="members"><h3>Instance Constructors</h3><ol><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#<init>" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="<init>():net.psforever.services.teamwork.SquadSubscriptionEntity"></a><a id="<init>:SquadSubscriptionEntity"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#<init>():net.psforever.services.teamwork.SquadSubscriptionEntity" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">new</span></span> <span class="symbol"><span class="name">SquadSubscriptionEntity</span><span class="params">()</span></span></li></ol></div><div class="values members"><h3>Value Members</h3><ol><li class="indented0 " name="scala.AnyRef#!=" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="!=(x$1:Any):Boolean"></a><a id="!=(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#!=(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $bang$eq">!=</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef###" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="##:Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html###:Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $hash$hash">##</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#==" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="==(x$1:Any):Boolean"></a><a id="==(Any):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#==(x$1:Any):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name" title="gt4s: $eq$eq">==</span><span class="params">(<span name="arg0">arg0: <span name="scala.Any" class="extype">Any</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#InitSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],squad:net.psforever.objects.teamwork.Squad):Unit"></a><a id="InitSquadDetail(PlanetSideGUID,Iterable[Long],Squad):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#InitSquadDetail(guid:net.psforever.types.PlanetSideGUID,to:Iterable[Long],squad:net.psforever.objects.teamwork.Squad):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">InitSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="to">to: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <span name="squad">squad: <a href="../../objects/teamwork/Squad.html" name="net.psforever.objects.teamwork.Squad" id="net.psforever.objects.teamwork.Squad" class="extype">Squad</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch an intial message entailing the strategic information and the composition of this squad.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch an intial message entailing the strategic information and the composition of this squad.
|
|
The details of the squad will be updated in full and be sent to all indicated observers.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier to be used when composing the details for this message</p></dd><dt class="param">to</dt><dd class="cmt"><p>the unique character identifier numbers of the players who will receive this message</p></dd><dt class="param">squad</dt><dd class="cmt"><p>the squad from which the squad details shall be composed</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadService.PublishFullDetails</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#InitSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="InitSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit"></a><a id="InitSquadDetail(SquadFeatures):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#InitSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">InitSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Dispatch a message entailing the composition of this squad.</p><div class="fullcomment"><div class="comment cmt"><p>Dispatch a message entailing the composition of this squad.
|
|
This is considered the first time this information will be dispatched to any relevant observers
|
|
so the details of the squad will be updated in full and be sent to all relevant observers,
|
|
namely, all the occupants of the squad.
|
|
External observers are ignored.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>InitSquadDetail(PlanetSideGUID, Iterable[Long], Squad)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#MonitorSquadDetails" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="MonitorSquadDetails:scala.collection.mutable.LongMap[net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry]"></a><a id="MonitorSquadDetails:LongMap[MonitorEntry]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#MonitorSquadDetails:scala.collection.mutable.LongMap[net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">MonitorSquadDetails</span><span class="result">: <span name="scala.collection.mutable.LongMap" class="extype">LongMap</span>[<span name="net.psforever.services.teamwork.SquadSubscriptionEntity.MonitorEntry" class="extype">MonitorEntry</span>]</span></span><p class="shortcomment cmt">Players who are interested in updated details regarding a certain squad
|
|
though they may not be a member of the squad.<br>
|
|
key - unique character identifier number; value - a squad identifier number
|
|
</p></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish[ANY>:Any](ANY,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="tparams">[<span name="ANY">ANY >: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadSubscriptionEntity.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
No message can be sent using this distinction.
|
|
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
|
|
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish[ANY>:Any](ANY,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish[ANY>:Any](to:ANY,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="tparams">[<span name="ANY">ANY >: <span name="scala.Any" class="extype">Any</span></span>]</span><span class="params">(<span name="to">to: <span name="net.psforever.services.teamwork.SquadSubscriptionEntity.Publish.ANY" class="extype">ANY</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
No message can be sent using this distinction.
|
|
Log a warning.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>something that was expected to be used as the channel for the message
|
|
but is not handled as such</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Long,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Long,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:Long,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Long" class="extype">Long</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>ActorRef</code> objects retained by the <code>UserEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a unique character identifier used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(String,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Strings come in three accepted patterns.
|
|
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
|
|
The second resolves into a squad's dedicated channel, a name that is formulaic.
|
|
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination, usually)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(String,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:String,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Strings come in three accepted patterns.
|
|
The first resolves into a faction name, as determined by <code>PlanetSideEmpire</code> when transformed into a string.
|
|
The second resolves into a squad's dedicated channel, a name that is formulaic.
|
|
The third resolves as a unique character identifier number.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a string used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(Type,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(Type,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:net.psforever.types.PlanetSideEmpire.Type,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <a href="../../types/PlanetSideEmpire$.html#Type=net.psforever.types.PlanetSideEmpire.Value" name="net.psforever.types.PlanetSideEmpire.Type" id="net.psforever.types.PlanetSideEmpire.Type" class="extmbr">Type</a></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
Always publishes on the <code>SquadEvents</code> object.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>a faction affiliation used as the channel for the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit"></a><a id="Publish(ActorRef,Response,Iterable[Long]):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response,excluded:Iterable[Long]):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>, <span name="excluded">excluded: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd><dt class="param">excluded</dt><dd class="cmt"><p>a group of character identifier numbers who should not receive the message
|
|
(resolved at destination)</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#Publish" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit"></a><a id="Publish(ActorRef,Response):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#Publish(to:akka.actor.ActorRef,msg:net.psforever.services.teamwork.SquadResponse.Response):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">Publish</span><span class="params">(<span name="to">to: <span name="akka.actor.ActorRef" class="extype">ActorRef</span></span>, <span name="msg">msg: <a href="SquadResponse$$Response.html" name="net.psforever.services.teamwork.SquadResponse.Response" id="net.psforever.services.teamwork.SquadResponse.Response" class="extype">Response</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Overloaded message-sending operation.</p><div class="fullcomment"><div class="comment cmt"><p>Overloaded message-sending operation.
|
|
The <code>Actor</code> version wraps around the expected <code>!</code> functionality.</p></div><dl class="paramcmts block"><dt class="param">to</dt><dd class="cmt"><p>an <code>ActorRef</code> which to send the message</p></dd><dt class="param">msg</dt><dd class="cmt"><p>a message that can be stored in a <code>SquadServiceResponse</code> object</p></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#PublishToMonitorTargets" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="PublishToMonitorTargets(guid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long]):Iterable[Long]"></a><a id="PublishToMonitorTargets(PlanetSideGUID,Iterable[Long]):Iterable[Long]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#PublishToMonitorTargets(guid:net.psforever.types.PlanetSideGUID,excluding:Iterable[Long]):Iterable[Long]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">PublishToMonitorTargets</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="excluding">excluding: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>)</span><span class="result">: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span></span><p class="shortcomment cmt">na</p><div class="fullcomment"><div class="comment cmt"><p>na</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dt class="param">excluding</dt><dd class="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>LongMap.subtractOne</code></p></span><span class="cmt"><p><code>SquadSubscriptionEntity.MonitorEntry</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#SquadEvents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="SquadEvents:net.psforever.services.GenericEventBus[net.psforever.services.teamwork.SquadServiceResponse]"></a><a id="SquadEvents:GenericEventBus[SquadServiceResponse]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#SquadEvents:net.psforever.services.GenericEventBus[net.psforever.services.teamwork.SquadServiceResponse]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">SquadEvents</span><span class="result">: <a href="../GenericEventBus.html" name="net.psforever.services.GenericEventBus" id="net.psforever.services.GenericEventBus" class="extype">GenericEventBus</a>[<a href="SquadServiceResponse.html" name="net.psforever.services.teamwork.SquadServiceResponse" id="net.psforever.services.teamwork.SquadServiceResponse" class="extype">SquadServiceResponse</a>]</span></span><p class="shortcomment cmt">This is a formal <code>ActorEventBus</code> object that is reserved for faction-wide messages and squad-specific messages.</p><div class="fullcomment"><div class="comment cmt"><p>This is a formal <code>ActorEventBus</code> object that is reserved for faction-wide messages and squad-specific messages.
|
|
When the user joins the <code>SquadService</code> with a <code>Service.Join</code> message
|
|
that includes a confirmed faction affiliation identifier,
|
|
the origin <code>ActorRef</code> is added as a subscription.
|
|
Squad channels are produced when a squad is created,
|
|
and are subscribed to as users join the squad,
|
|
and unsubscribed from as users leave the squad.<br>
|
|
key - a <code>PlanetSideEmpire</code> value; value - <code>ActorRef</code> reference<br>
|
|
key - a consistent squad channel name; value - <code>ActorRef</code> reference</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>CloseSquad</code></p></span><span class="cmt"><p><code>JoinSquad</code></p></span><span class="cmt"><p><code>LeaveSquad</code></p></span><span class="cmt"><p><code>Service.Join</code></p></span><span class="cmt"><p><code>Service.Leave</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toChannel:String,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(PlanetSideGUID,String,Iterable[Long],SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(guid:net.psforever.types.PlanetSideGUID,toChannel:String,excluding:Iterable[Long],details:net.psforever.packet.game.SquadDetail):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">UpdateSquadDetail</span><span class="params">(<span name="guid">guid: <a href="../../types/PlanetSideGUID.html" name="net.psforever.types.PlanetSideGUID" id="net.psforever.types.PlanetSideGUID" class="extype">PlanetSideGUID</a></span>, <span name="toChannel">toChannel: <span name="scala.Predef.String" class="extype">String</span></span>, <span name="excluding">excluding: <span name="scala.Iterable" class="extype">Iterable</span>[<span name="scala.Long" class="extype">Long</span>]</span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.
|
|
Also send the same information to any users who are watching the squad, potentially for want to join it.
|
|
The squad-specific message is contingent on finding the squad's features using the unique identifier number
|
|
and, from that, reporting to the specific squad's messaging channel.
|
|
Anyone watching the squad will always be updated the given details.</p></div><dl class="paramcmts block"><dt class="param">guid</dt><dd class="cmt"><p>the unique squad identifier number to be used for the squad detail message</p></dd><dt class="param">toChannel</dt><dd class="cmt"><p>the squad broadcast channel name</p></dd><dt class="param">excluding</dt><dd class="cmt"><p>the explicit unique character identifier numbers of individuals who should not receive the message</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>DisplaySquad</code></p></span><span class="cmt"><p><code>Publish</code></p></span><span class="cmt"><p><code>SquadDetail</code></p></span><span class="cmt"><p><code>SquadResponse.Detail</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures,details:net.psforever.packet.game.SquadDetail):Unit"></a><a id="UpdateSquadDetail(SquadFeatures,SquadDetail):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures,details:net.psforever.packet.game.SquadDetail):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">UpdateSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>, <span name="details">details: <a href="../../packet/game/SquadDetail.html" name="net.psforever.packet.game.SquadDetail" id="net.psforever.packet.game.SquadDetail" class="extype">SquadDetail</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing some of the strategic information and the composition to the existing members of the squad.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>information about the squad</p></dd><dt class="param">details</dt><dd class="cmt"><p>the squad details to be included in the message</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadResponse.Detail</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UpdateSquadDetail" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit"></a><a id="UpdateSquadDetail(SquadFeatures):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UpdateSquadDetail(features:net.psforever.objects.teamwork.SquadFeatures):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">UpdateSquadDetail</span><span class="params">(<span name="features">features: <a href="../../objects/teamwork/SquadFeatures.html" name="net.psforever.objects.teamwork.SquadFeatures" id="net.psforever.objects.teamwork.SquadFeatures" class="extype">SquadFeatures</a></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><p class="shortcomment cmt">Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</p><div class="fullcomment"><div class="comment cmt"><p>Send a message entailing the strategic information and the composition of the squad to the existing members of the squad.</p></div><dl class="paramcmts block"><dt class="param">features</dt><dd class="cmt"><p>the squad</p></dd></dl><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>SquadService.PublishFullDetails</code></p></span><span class="cmt"><p><code>UpdateSquadDetail(PlanetSideGUID, PlanetSideGUID, List[Long], SquadDetail)</code></p></span></dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#UserEvents" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="UserEvents:scala.collection.mutable.LongMap[akka.actor.ActorRef]"></a><a id="UserEvents:LongMap[ActorRef]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#UserEvents:scala.collection.mutable.LongMap[akka.actor.ActorRef]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">val</span></span> <span class="symbol"><span class="name">UserEvents</span><span class="result">: <span name="scala.collection.mutable.LongMap" class="extype">LongMap</span>[<span name="akka.actor.ActorRef" class="extype">ActorRef</span>]</span></span><p class="shortcomment cmt">This collection contains the message-sending contact reference for individuals.</p><div class="fullcomment"><div class="comment cmt"><p>This collection contains the message-sending contact reference for individuals.
|
|
When the user joins the <code>SquadService</code> with a <code>Service.Join</code> message
|
|
that includes their unique character identifier,
|
|
the origin <code>ActorRef</code> is added as a subscription.
|
|
It is maintained until they disconnect entirely.
|
|
The subscription is anticipated to belong to an instance of <code>SessionActor</code>.<br>
|
|
key - unique character identifier number; value - <code>ActorRef</code> reference for that character</p></div><dl class="attributes block"><dt>See also</dt><dd><span class="cmt"><p><code>Service.Join</code></p></span></dd></dl></div></li><li class="indented0 " name="scala.Any#asInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="asInstanceOf[T0]:T0"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#asInstanceOf[T0]:T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">asInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Any.asInstanceOf.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#clone" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="clone():Object"></a><a id="clone():AnyRef"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#clone():Object" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">clone</span><span class="params">()</span><span class="result">: <span name="scala.AnyRef" class="extype">AnyRef</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.CloneNotSupportedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#eq" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="eq(x$1:AnyRef):Boolean"></a><a id="eq(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#eq(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">eq</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#equals" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="equals(x$1:Object):Boolean"></a><a id="equals(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#equals(x$1:Object):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">equals</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#finalize" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="prt"><a id="finalize():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#finalize():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">finalize</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Attributes</dt><dd>protected[<span name="java.lang" class="extype">lang</span>] </dd><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="symbol">classOf[java.lang.Throwable]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#getClass" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="getClass():Class[_]"></a><a id="getClass():Class[_<:AnyRef]"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#getClass():Class[_]" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">getClass</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html#java.lang.Class" name="java.lang.Class" id="java.lang.Class" class="extype">Class</a>[_ <: <span name="scala.AnyRef" class="extype">AnyRef</span>]</span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#hashCode" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="hashCode():Int"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#hashCode():Int" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">hashCode</span><span class="params">()</span><span class="result">: <span name="scala.Int" class="extype">Int</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.Any#isInstanceOf" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="isInstanceOf[T0]:Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#isInstanceOf[T0]:Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">isInstanceOf</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#ne" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="ne(x$1:AnyRef):Boolean"></a><a id="ne(AnyRef):Boolean"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#ne(x$1:AnyRef):Boolean" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">ne</span><span class="params">(<span name="arg0">arg0: <span name="scala.AnyRef" class="extype">AnyRef</span></span>)</span><span class="result">: <span name="scala.Boolean" class="extype">Boolean</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notify" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notify():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#notify():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notify</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#notifyAll" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="notifyAll():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#notifyAll():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">notifyAll</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@native</span><span class="args">()</span> </dd></dl></div></li><li class="indented0 " name="net.psforever.services.teamwork.SquadSubscriptionEntity#postStop" group="Ungrouped" fullComment="no" data-isabs="false" visbl="pub"><a id="postStop():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#postStop():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">postStop</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span></li><li class="indented0 " name="scala.AnyRef#synchronized" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="synchronized[T0](x$1:=>T0):T0"></a><a id="synchronized[T0](=>T0):T0"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#synchronized[T0](x$1:=>T0):T0" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">synchronized</span><span class="tparams">[<span name="T0">T0</span>]</span><span class="params">(<span name="arg0">arg0: => <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span>)</span><span class="result">: <span name="java.lang.AnyRef.synchronized.T0" class="extype">T0</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#toString" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="toString():String"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#toString():String" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier"></span> <span class="kind">def</span></span> <span class="symbol"><span class="name">toString</span><span class="params">()</span><span class="result">: <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html#java.lang.String" name="java.lang.String" id="java.lang.String" class="extype">String</a></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef → Any</dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait():Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#wait():Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">()</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long,x$2:Int):Unit"></a><a id="wait(Long,Int):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#wait(x$1:Long,x$2:Int):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>, <span name="arg1">arg1: <span name="scala.Int" class="extype">Int</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> </dd></dl></div></li><li class="indented0 " name="scala.AnyRef#wait" group="Ungrouped" fullComment="yes" data-isabs="false" visbl="pub"><a id="wait(x$1:Long):Unit"></a><a id="wait(Long):Unit"></a> <span class="permalink"><a href="../../../../net/psforever/services/teamwork/SquadSubscriptionEntity.html#wait(x$1:Long):Unit" title="Permalink"><i class="material-icons"></i></a></span> <span class="modifier_kind"><span class="modifier">final </span> <span class="kind">def</span></span> <span class="symbol"><span class="name">wait</span><span class="params">(<span name="arg0">arg0: <span name="scala.Long" class="extype">Long</span></span>)</span><span class="result">: <span name="scala.Unit" class="extype">Unit</span></span></span><div class="fullcomment"><dl class="attributes block"><dt>Definition Classes</dt><dd>AnyRef</dd><dt>Annotations</dt><dd><span class="name">@throws</span><span class="args">(<span><span class="defval">classOf[java.lang.InterruptedException]</span></span>)</span> <span class="name">@native</span><span class="args">()</span> </dd></dl></div></li></ol></div></div><div id="inheritedMembers"><div name="scala.AnyRef" class="parent"><h3>Inherited from <span name="scala.AnyRef" class="extype">AnyRef</span></h3></div><div name="scala.Any" class="parent"><h3>Inherited from <span name="scala.Any" class="extype">Any</span></h3></div></div><div id="groupedMembers"><div name="Ungrouped" class="group"><h3>Ungrouped</h3></div></div></div><div id="tooltip"></div><div id="footer"></div></body></div></div></div></body></html>
|