Package net.deechael.dynamichat.api
Interface Channel
- All Known Subinterfaces:
TemporaryChannel
public interface Channel
Chat channel
-
Method Summary
Modifier and TypeMethodDescriptionvoidbroadcast the message to all users who have access to this channelGet the display name of the channel@Nullable StringGet the chat format of the channel@NotNull StringgetName()Get the name of the channelGet the formats of whom has different permissionsgetUsers()Get all the users who have access to the channelbooleanisGlobal()Is this channel the global channelvoidsetAvailableForAll(boolean available) Make the channel available for all users
-
Method Details
-
broadcast
broadcast the message to all users who have access to this channel- Parameters:
message- the message to be broadcast
-
getUsers
Get all the users who have access to the channel- Returns:
- the users who have access to the channel
-
getName
Get the name of the channel- Returns:
- the name of the channel
-
getDisplayName
String getDisplayName()Get the display name of the channel- Returns:
- the display name of the channel
-
getFormat
Get the chat format of the channel- Returns:
- the format of the channel
-
getPermissionFormats
Get the formats of whom has different permissions- Returns:
- (permission, format, priority)
-
isGlobal
boolean isGlobal()Is this channel the global channel- Returns:
- the result
-
setAvailableForAll
void setAvailableForAll(boolean available) Make the channel available for all users- Parameters:
available- status
-