Package rocks.xmpp.extensions.muc.model
Class RoomConfiguration.Builder
- java.lang.Object
-
- rocks.xmpp.extensions.data.model.DataForm.Builder<RoomConfiguration.Builder>
-
- rocks.xmpp.extensions.muc.model.RoomConfiguration.Builder
-
- Enclosing class:
- RoomConfiguration
public static final class RoomConfiguration.Builder extends DataForm.Builder<RoomConfiguration.Builder>
A builder to build a room configuration. The form is of typeDataForm.Type.SUBMITby default.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoomConfiguration.Builderadministrators(Collection<Jid> admins)Full list of room admins.RoomConfigurationbuild()Builds the room configuration.RoomConfiguration.BuilderchangeSubjectAllowed(boolean changeSubjectAllowed)Whether to allow occupants to change subject.RoomConfiguration.Builderdescription(String description)Short description of room.RoomConfiguration.BuilderinvitesAllowed(boolean invitesAllowed)Whether to allow occupants to invite othersRoomConfiguration.Builderlanguage(Locale language)Natural language for room discussions.RoomConfiguration.BuilderloggingEnabled(boolean loggingEnabled)Whether to enable public logging of room conversations.RoomConfiguration.BuildermaxHistoryMessages(int maxHistoryMessages)Sets the maximum number of history messages returned by the room.RoomConfiguration.BuildermaxUsers(Integer maxUsers)Maximum number of room occupants.RoomConfiguration.BuildermembersOnly(boolean membersOnly)Whether to make room members-only.RoomConfiguration.Buildermoderated(boolean moderated)Whether to make room moderated.RoomConfiguration.Buildername(String name)Natural-language room name.RoomConfiguration.Builderowners(Collection<Jid> owners)Full list of room owners.RoomConfiguration.Builderpassword(String password)The room password.RoomConfiguration.BuilderpasswordProtected(boolean passwordProtected)Whether a password is required to enter.RoomConfiguration.Builderpersistent(boolean persistent)Whether to make room persistent.RoomConfiguration.BuilderpublicRoom(boolean publicRoom)Whether to allow public searching for room.RoomConfiguration.BuilderpubSubNode(URI pubsubNode)XMPP URI of associated publish-subcribe node.RoomConfiguration.BuilderrolesForWhichPresenceIsBroadcast(Collection<Role> roles)Roles for which presence is broadcast.RoomConfiguration.BuilderrolesThatMayDiscoverRealJids(Collection<Role> roles)Roles that may discover real JIDs of occupants.RoomConfiguration.BuilderrolesThatMayRetrieveMemberList(Collection<Role> rolesThatMayRetrieveMemberList)Roles that may retrieve member list.RoomConfiguration.BuilderrolesThatMaySendPrivateMessages(Collection<Role> rolesThatMaySendPrivateMessages)Roles that may send private messages.-
Methods inherited from class rocks.xmpp.extensions.data.model.DataForm.Builder
fields, formType, instructions, items, pages, reportedFields, title, type
-
-
-
-
Method Detail
-
maxHistoryMessages
public RoomConfiguration.Builder maxHistoryMessages(int maxHistoryMessages)
Sets the maximum number of history messages returned by the room.- Parameters:
maxHistoryMessages- The maximum number of history messages returned by the room.- Returns:
- The builder.
-
rolesThatMaySendPrivateMessages
public RoomConfiguration.Builder rolesThatMaySendPrivateMessages(Collection<Role> rolesThatMaySendPrivateMessages)
Roles that may send private messages.- Parameters:
rolesThatMaySendPrivateMessages- The roles.- Returns:
- The builder.
-
invitesAllowed
public RoomConfiguration.Builder invitesAllowed(boolean invitesAllowed)
Whether to allow occupants to invite others- Parameters:
invitesAllowed- Whether to allow occupants to invite others- Returns:
- The builder.
-
changeSubjectAllowed
public RoomConfiguration.Builder changeSubjectAllowed(boolean changeSubjectAllowed)
Whether to allow occupants to change subject.- Parameters:
changeSubjectAllowed- Whether to allow occupants to change subject.- Returns:
- The builder.
-
loggingEnabled
public RoomConfiguration.Builder loggingEnabled(boolean loggingEnabled)
Whether to enable public logging of room conversations.- Parameters:
loggingEnabled- Whether to enable public logging of room conversations.- Returns:
- The builder.
-
rolesThatMayRetrieveMemberList
public RoomConfiguration.Builder rolesThatMayRetrieveMemberList(Collection<Role> rolesThatMayRetrieveMemberList)
Roles that may retrieve member list.- Parameters:
rolesThatMayRetrieveMemberList- Roles that may retrieve member list.- Returns:
- The builder.
-
language
public RoomConfiguration.Builder language(Locale language)
Natural language for room discussions.- Parameters:
language- The language.- Returns:
- The builder.
-
pubSubNode
public RoomConfiguration.Builder pubSubNode(URI pubsubNode)
XMPP URI of associated publish-subcribe node.- Parameters:
pubsubNode- The URI.- Returns:
- The builder.
-
maxUsers
public RoomConfiguration.Builder maxUsers(Integer maxUsers)
Maximum number of room occupants.- Parameters:
maxUsers- The max users.- Returns:
- The builder.
-
membersOnly
public RoomConfiguration.Builder membersOnly(boolean membersOnly)
Whether to make room members-only.- Parameters:
membersOnly- Whether to make room members-only.- Returns:
- The builder.
-
moderated
public RoomConfiguration.Builder moderated(boolean moderated)
Whether to make room moderated.- Parameters:
moderated- Whether to make room moderated.- Returns:
- The builder.
-
passwordProtected
public RoomConfiguration.Builder passwordProtected(boolean passwordProtected)
Whether a password is required to enter.- Parameters:
passwordProtected- Whether a password is required to enter.- Returns:
- The builder.
-
persistent
public RoomConfiguration.Builder persistent(boolean persistent)
Whether to make room persistent.- Parameters:
persistent- Whether to maker room persistent.- Returns:
- The builder.
-
rolesForWhichPresenceIsBroadcast
public RoomConfiguration.Builder rolesForWhichPresenceIsBroadcast(Collection<Role> roles)
Roles for which presence is broadcast.- Parameters:
roles- Roles for which presence is broadcast.- Returns:
- The builder.
-
publicRoom
public RoomConfiguration.Builder publicRoom(boolean publicRoom)
Whether to allow public searching for room.- Parameters:
publicRoom- Whether to allow public searching for room.- Returns:
- The builder.
-
administrators
public RoomConfiguration.Builder administrators(Collection<Jid> admins)
Full list of room admins.- Parameters:
admins- The admins.- Returns:
- The builder.
-
description
public RoomConfiguration.Builder description(String description)
Short description of room.- Parameters:
description- The description.- Returns:
- The builder.
-
name
public RoomConfiguration.Builder name(String name)
Natural-language room name.- Parameters:
name- The name.- Returns:
- The builder.
-
owners
public RoomConfiguration.Builder owners(Collection<Jid> owners)
Full list of room owners.- Parameters:
owners- Full list of room owners.- Returns:
- The builder.
-
password
public RoomConfiguration.Builder password(String password)
The room password.- Parameters:
password- The password.- Returns:
- The builder.
-
rolesThatMayDiscoverRealJids
public RoomConfiguration.Builder rolesThatMayDiscoverRealJids(Collection<Role> roles)
Roles that may discover real JIDs of occupants.- Parameters:
roles- Roles that may discover real JIDs of occupants.- Returns:
- The builder.
-
build
public RoomConfiguration build()
Builds the room configuration.- Returns:
- The room configuration.
-
-