me.ryandw11.ultrachat.api.channels

Class ChatChannel

java.lang.Object

me.ryandw11.ultrachat.api.channels.ChatChannel

public class ChatChannel
extends java.lang.Object

This class is used the manage channels.

Note: All set methods automatically call the update() method.

Constructor Summary

Constructors

Constructor and Description
ChatChannel(ChannelBuilder cb) For internal use only.

Method Summary

Modifier and Type	Method and Description
void	delete() Deprecated. It is not recommended to use this.
java.lang.String	getFormat() Get the format of the channel.
java.util.List<java.lang.String>	getJson() Get the json of the channel
java.lang.String	getName()
java.lang.String	getPermission() Get the permission for the channel.
java.lang.String	getPrefix() Get the prefix of the channel.
boolean	isAlwaysAppear() If the channel always appears.
void	setAlwaysAppear(boolean alwaysAppear) Set if the channel will always appear in chat.
void	setFormat(java.lang.String format) Set the format of the channel.
void	setJson(java.util.List<java.lang.String> json) Set the json for the channel.
void	setName(java.lang.String name) Set the name of the channel.
void	setPermission(java.lang.String permission) Set the permission for the channel.
void	setPrefix(java.lang.String prefix) Set the prefix of the channel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChatChannel

public ChatChannel(ChannelBuilder cb)

For internal use only. Always use the channel builder.

Parameters:

cb - The builder that was used to build the channel.

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

Set the name of the channel.

Note: If this channel is the default channel then you will need to change the default channel name manually

Parameters:

name - The name of the channel.

getPrefix

public java.lang.String getPrefix()

Get the prefix of the channel.

Returns:

The prefix of the channel.

setPrefix

public void setPrefix(java.lang.String prefix)

Set the prefix of the channel.

Parameters:

prefix - The prefix of the channel.

getPermission

public java.lang.String getPermission()

Get the permission for the channel.

Returns:

The permission for the channel.

setPermission

public void setPermission(java.lang.String permission)

Set the permission for the channel.

Parameters:

permission - The permission for the channel.

isAlwaysAppear

public boolean isAlwaysAppear()

If the channel always appears.

Returns:

If the channel always appears.

setAlwaysAppear

public void setAlwaysAppear(boolean alwaysAppear)

Set if the channel will always appear in chat.

Parameters:

alwaysAppear - If the channel will always appear.

getJson

public java.util.List<java.lang.String> getJson()

Get the json of the channel

Returns:

The json.

setJson

public void setJson(java.util.List<java.lang.String> json)

Set the json for the channel.

Parameters:

json - The json.

delete

public void delete()

Deprecated. It is not recommended to use this.

Delete the channel

getFormat

public java.lang.String getFormat()

Get the format of the channel.

Returns:

The format

setFormat

public void setFormat(java.lang.String format)

Set the format of the channel.

Parameters:

format - The format.