BroadcastChannel (colab-api 0.1 API)

java.lang.Object
- ch.colabproject.colab.api.ws.channel.model.BroadcastChannel

All Implemented Interfaces:

WebsocketChannel, ch.colabproject.colab.generator.model.interfaces.WithJsonDiscriminator, Serializable
```
public class BroadcastChannel
extends Object
implements WebsocketChannel
```
The channel to be used to transmit data to all online users.

Usage:

Subscription : as soon as possible on client side + on current user reload
Unsubscription : none

Author:

maxence

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

BroadcastChannel()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static BroadcastChannel`	`build()`	get the broadcast channel
`boolean`	`equals(Object obj)`	Channel equals if they both refer to the same user
`String`	`getUrn()`	Get uniform resource name
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.colabproject.colab.generator.model.interfaces.WithJsonDiscriminator
getJsonDiscriminator

- Constructor Detail
  - BroadcastChannel
```
public BroadcastChannel()
```
- Method Detail
  - getUrn
```
public String getUrn()
```
    Description copied from interface: WebsocketChannel
    
    Get uniform resource name
    
    Specified by:
    
    getUrn in interface WebsocketChannel
    
    Returns:
    
    uniform resource name
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Channel equals if they both refer to the same user
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - other channel
    
    Returns:
    
    true if both refer to the same user
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - build
```
public static BroadcastChannel build()
```
    get the broadcast channel
    
    Returns:
    
    the broadcast channel