socketstream/socketstream

View on GitHub
docs/partials/api/ss.publish.publish.html

Summary

Maintainability
Test Coverage
<a href="https://github.com/socketstream/socketstream/edit/master/lib/publish/index.js" class="improve-docs"><i class="icon-edit"> </i>Improve this doc</a><a href="https://github.com/socketstream/socketstream/blob/3f3f67a/lib/publish/index.js#L21" class="view-source"><i class="icon-eye-open"> </i>View source</a><h1><code ng:non-bindable="">publish</code>
<div><span class="hint">service in module <code ng:non-bindable="">ss</code>
</span>
</div>
</h1>
<div><h2 id="description">Description</h2>
<div class="description"><div class="ss-publish-page ss-publish-publish-page"><p>Extend the internal API with a publish object you can call from your own server-side code</p>
</div></div>
<div class="member method"><h2 id="methods">Methods</h2>
<ul class="methods"><li><a href="https://github.com/socketstream/socketstream/blob/3f3f67a/lib/publish/index.js#L33" class="view-source icon-eye-open"> </a><h3 id="methods_all">all(name, first)</h3>
<div class="all"><div class="ss-publish-all-page"><p>Publish event to all active client browsers</p>
</div><h5 id="methods_all_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>name</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ss-publish-all-page"><p>Name of the event</p>
</div></td></tr><tr><td>first</td><td><a href="" class="label type-hint type-hint-any">any</a></td><td><div class="ss-publish-all-page"><p>First parameter (open ended)</p>
</div></td></tr></tbody></table></div>
</li>
<li><a href="https://github.com/socketstream/socketstream/blob/3f3f67a/lib/publish/index.js#L83" class="view-source icon-eye-open"> </a><h3 id="methods_channel">channel(channel, event, first)</h3>
<div class="channel"><div class="ss-publish-channel-page"><p>Publish event to all active client browsers in given channel</p>
</div><h5 id="methods_channel_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>channel</td><td><a href="" class="label type-hint type-hint-string">string</a><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="ss-publish-channel-page"><p>Name of the channel(s)</p>
</div></td></tr><tr><td>event</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="ss-publish-channel-page"><p>Name of the event</p>
</div></td></tr><tr><td>first</td><td><a href="" class="label type-hint type-hint-any">any</a></td><td><div class="ss-publish-channel-page"><p>First parameter (open ended)</p>
</div></td></tr></tbody></table></div>
</li>
</ul>
</div>
</div>