Class Index | File Index

Classes


Class HS.Classes.Channel

Represents a Channel
Defined in: controller.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a new channel
Field Summary
Field Attributes Field Name and Description
 
Channel name
 
Is this channel a user created channel or a sub channel
 
What character is used to parse the channel string into
 
Sub-Channels published to when publishing to this channel
 
What character is used to parse the channel string into sections used to create the sub-channels.
Method Summary
Method Attributes Method Name and Description
<static>  
HS.Classes.Channel.changeChannel(channel)
Clear current subscriptions for the channel
<static>  
HS.Classes.Channel.clearSubs()
Clear current subscriptions for the channel
<static>  
HS.Classes.Channel.deleteChannel()
Delete the channel and ensure all the references to it's data are deleted
<static>  
HS.Classes.Channel.parseTopics()
parse the topics within the channels name such that even the partial subs will recieve the channel's messages as expected.
Class Detail
HS.Classes.Channel()
Creates a new channel
Requires:
Class
Field Detail
{String} channel
Channel name

{Boolean} original
Is this channel a user created channel or a sub channel

{String} splitter
What character is used to parse the channel string into

{String[]} subChannels
Sub-Channels published to when publishing to this channel

{String} subscribers
What character is used to parse the channel string into sections used to create the sub-channels.
Method Detail
<static> {Void} HS.Classes.Channel.changeChannel(channel)
Clear current subscriptions for the channel
Parameters:
channel
Returns:
{Void}

<static> {Void} HS.Classes.Channel.clearSubs()
Clear current subscriptions for the channel
Returns:
{Void}

<static> {Boolean} HS.Classes.Channel.deleteChannel()
Delete the channel and ensure all the references to it's data are deleted
Returns:
{Boolean} returns true to show that everything has been deleted

<static> {Void} HS.Classes.Channel.parseTopics()
parse the topics within the channels name such that even the partial subs will recieve the channel's messages as expected.
Returns:
{Void}

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 26 2013 15:55:31 GMT-0500 (EST)