Support

Room

Summary
Constructor Attributes Constructor Name and Description
 

Room()
Field Summary
Field Attributes Field Name and Description
 
AFFILIATION_ADMIN
Reference to a user who is affiliated with the room as an admin.
 
AFFILIATION_MEMBER
Reference to a user who is affiliated with the room as an member.
 
AFFILIATION_NONE
Reference to a user who is not affiliated with the room.
 
AFFILIATION_OUTCAST
Reference to a user who has been banned from the room.
 
AFFILIATION_OWNER
Reference to a user who is affiliated with the room as the room's owner
 
nickName
The local user's nickName for the room we're managing.
 
ROLE_MODERATOR
Reference to a Moderator role.
 
ROLE_NONE
Reference to a none role.
 
ROLE_PARTICIPANT
Reference to a particpant role.
 
ROLE_VISITOR
Reference to a visitor role.
 
roomId
Unique id of the room we're managing.
Method Summary
Method Attributes Method Name and Description
 
approveRegistrationRequest(userId)
REQUIRES MODERATOR PRIVILEGES Approve a registration request for a user who wants an affiliation as a member with the room.
 
approveVoiceRequest(userId)
REQUIRES MODERATOR PRIVILEGES Approving a voice request from a room participant.
 
ban(userId, reason)
REQUIRES MODERATOR PRIVILEGES Ban a user from the room.
 
getAffiliation(nickName)
REQUIRES ADMINISTRATOR PRIVILEGES Retrieve the affiliation of a particular room occupant.
 
getAffiliations()
REQUIRES ADMINISTRATOR PRIVILEGES Returns an array of all users with any affiliation of the room.
 
getDescription()
Get the room subject.
 
getInitialOccupantCount()
Retrieve the numberic value for the count of occupants on initial load.
 
getMemberList()
REQUIRES ADMINISTRATOR PRIVILEGES Returns the list of members of the room.
 
getMessages()
Get room message history
 
getModeratorList()
REQUIRES ADMINISTRATOR PRIVILEGES Invokes retreiving a list of moderators for this room.
 
getOccupant(nickName)
Returns a single room occupant
 
getOccupants()
Retrieve an array of RoomOccupants for everyone currently in the room.
 
getOutcastList()
REQUIRES ADMINISTRATOR PRIVILEGES Returns the list of members of the room.
 
getRole(nickName)
REQUIRES ADMINISTRATOR PRIVILEGES Retrieve the role of a particular room occupant.
 
getRoomName()
REQUIRES MODERATOR PRIVILEGES Get the room subject.
 
getSubject()
Get the room subject.
 
grantMembership(userId, defaultNick, reason)
REQUIRES MODERATOR PRIVILEGES Grant membership to a specific user who has requested access to the room.
 
grantModerator(nickName)
REQUIRES ADMINISTRATOR PRIVILEGES Set a RoomOccupant as a moderator.
 
grantVoice(userId)
REQUIRES MODERATOR PRIVILEGES Grant voice to a visitor
 
inviteUser(userId, message)
Invite another user to join the room you are currently in.
 
isActive()
Check to see if we already in the room or if its still joining.
 
isNonAnonymous()
Check if the room is only accessible to non-anonymous users
 
isOpen()
Check if the room is joinable and has not reached its max capacity
 
isPersistent()
Check if the room is persistent.
 
isPublic()
Check if the room is a publicly accessible room
 
isUnmoderated()
Check if the room is only accessible to non-anonymous users
 
isUnsecured()
Check if the room is secured (password protected)
 
join(nickName)
Join the room.
 
kick(userId, reason)
REQUIRES MODERATOR PRIVILEGES Kick an occupant from the room.
 
leave()
Leave the room.
 
revokeMembership(userId)
REQUIRES MODERATOR PRIVILEGES Revoke membership from an existing member of the room.
 
revokeModerator(userId)
REQUIRES ADMINISTRATOR PRIVILEGES Revoke a RoomOccupant as a moderator.
 
revokeVoice(userId)
REQUIRES MODERATOR PRIVILEGES Revoke voice from an occupant ( squelching for the whole room ).
 
send(message)
 
sendPrivateMessage(nickName, message)
Send a private message to a given occupant.
 
setBanList(banList)
Update the ban list with an array of updates to bulk update with.
 
setMemberList(memberList)
REQUIRES ADMINISTRATOR PRIVILEGES Revoke membership from an existing member of the room.
 
setModeratorList(moderatorList)
REQUIRES ADMINISTRATOR PRIVILEGES A list of userIds to use use for a bulk update of the mdoerator list.
 
setPresence(show, status, custom)
Sets the users presence information in the room
 
setSubject(subject)
REQUIRES MODERATOR PRIVILEGES Set the room subject.
 
setVoiceList(voiceList)
REQUIRES ADMINISTRATOR PRIVILEGES Retrieve an array of RoomOccupants for everyone currently in the room.
 
unban(userId)
REQUIRES MODERATOR PRIVILEGES un-ban a user from the room.
Event Summary
Event Attributes Event Name and Description
 
RoomBanEvent()
 
RoomInviteEvent()
 
RoomKickEvent()
 
RoomPresenceEvent()
 
RoomStatusEvent()
 
RoomSubjectEvent()
Detail
Room()
Field Detail
AFFILIATION_ADMIN
Reference to a user who is affiliated with the room as an admin.
AFFILIATION_MEMBER
Reference to a user who is affiliated with the room as an member.
AFFILIATION_NONE
Reference to a user who is not affiliated with the room.
AFFILIATION_OUTCAST
Reference to a user who has been banned from the room.
AFFILIATION_OWNER
Reference to a user who is affiliated with the room as the room's owner
nickName
The local user's nickName for the room we're managing.
ROLE_MODERATOR
Reference to a Moderator role.
ROLE_NONE
Reference to a none role.
ROLE_PARTICIPANT
Reference to a particpant role.
ROLE_VISITOR
Reference to a visitor role.
roomId
Unique id of the room we're managing.
Methods

approveRegistrationRequest(userId):Room

Not yet implemented.

REQUIRES MODERATOR PRIVILEGES Approve a registration request for a user who wants an affiliation as a member with the room.

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

approveVoiceRequest(userId):Room

Not yet implemented.

REQUIRES MODERATOR PRIVILEGES Approving a voice request from a room participant.

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

ban(userId, reason):Room

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES Ban a user from the room.

Params
{String} userId - unique user identifier {String} reason - reason for the ban, this will be delivered to the user as a message.
Returns
{Room} Returns a room manager to control an individual room.

getAffiliation(nickName):String

version: 1.2.5

REQUIRES ADMINISTRATOR PRIVILEGES Retrieve the affiliation of a particular room occupant.

Params
{String} nickName - unique user identifier
Returns
{String} Returns a room occupant's affiliation with the room.

getAffiliations():RoomOccupant[]

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES Returns an array of all users with any affiliation of the room. This includes users who are not currently online/in the room.

Params
Returns
{RoomOccupant[]} Returns an array of room occupants.

getDescription():String

version: 1.2.6

Get the room subject.

Params
Returns
{String} Returns the description of the room.

getInitialOccupantCount():Numeric

version: 1.2.6

Retrieve the numberic value for the count of occupants on initial load.

Params
Returns
{Numeric}

getMemberList():UPArrayCollection

version: 1.2.5

REQUIRES ADMINISTRATOR PRIVILEGES Returns the list of members of the room.

Params
Returns
{UPArrayCollection} memberList - Array of userId's

getMessages():RoomMessageVO[]

version: 1.2.0

Get room message history

Params
Returns
{RoomMessageVO[]} Returns an {ArrayCollection} of room messages for the room.

getModeratorList():ArrayCollection

version: 1.2.6

REQUIRES ADMINISTRATOR PRIVILEGES Invokes retreiving a list of moderators for this room.

Params
Returns
{ArrayCollection} Returns an ArrayCollection containing a list of userId's who have moderator privileges

getOccupant(nickName):RoomOccupant[]

version: 1.2.5 param {String} nickName - unique user nickname

Returns a single room occupant

Params
nickName
Returns
{RoomOccupant[]} Returns a single room occupant

getOccupants():Room

version: 1.2.3

Retrieve an array of RoomOccupants for everyone currently in the room.

Params
Returns
{Room} Returns a room manager to control an individual room.

getOutcastList():UPArrayCollection

version: 1.2.5

REQUIRES ADMINISTRATOR PRIVILEGES Returns the list of members of the room.

Params
Returns
{UPArrayCollection} memberList - Array of userId's

getRole(nickName):String

version: 1.2.5

REQUIRES ADMINISTRATOR PRIVILEGES Retrieve the role of a particular room occupant.

Params
{String} nickName - the user's unique nickname in this room
Returns
{String} Returns a room occupant's role with the room. Optional. If no nickName is passed the local user's role will be returned.

getRoomName():String

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES Get the room subject.

Params
Returns
{String} Returns the subject of the room.

getSubject():String

version: 1.2.5

Get the room subject.

Params
Returns
{String} Returns the subject of the room.

grantMembership(userId, defaultNick, reason):Room

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES Grant membership to a specific user who has requested access to the room.

Params
{String} userId - unique user identifier {String} defaultNick - default nick name for the user to use in this room. {String} reason - reason for granting membership
Returns
{Room} Returns a room manager to control an individual room.

grantModerator(nickName):Room

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES Set a RoomOccupant as a moderator.

Params
{String} nickName - The nickname of the room occupant to promote to moderator status.
Returns
{Room} Returns a room manager to control an individual room.

grantVoice(userId):Room

Not yet implemented.

REQUIRES MODERATOR PRIVILEGES Grant voice to a visitor

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

inviteUser(userId, message):Room

version: 1.2.5

Invite another user to join the room you are currently in. Thiis is restricted to user's in your roster and only works if you have instant messaging enabled.

Params
{String} userId - unique user identifier {String} message - Invitation message for the invite.
Returns
{Room} Returns a room manager to control an individual room.

isActive():Boolean

version: 1.2.0

Check to see if we already in the room or if its still joining.

Params
Returns
{Boolean} Boolean for whether the room is active or not.

isNonAnonymous():Boolean

version: 1.2.6

Check if the room is only accessible to non-anonymous users

Params
Returns
{Boolean}

isOpen():Boolean

version: 1.2.6

Check if the room is joinable and has not reached its max capacity

Params
Returns
{Boolean}

isPersistent():Boolean

version: 1.2.6

Check if the room is persistent.

Params
Returns
{Boolean}

isPublic():Boolean

version: 1.2.6

Check if the room is a publicly accessible room

Params
Returns
{Boolean}

isUnmoderated():Boolean

version: 1.2.6

Check if the room is only accessible to non-anonymous users

Params
Returns
{Boolean}

isUnsecured():Boolean

version: 1.2.6

Check if the room is secured (password protected)

Params
Returns
{Boolean}

join(nickName):Room

version: 1.2.0

Join the room. This must be called after retrieving the room from the {ConferenceAPI} before the room is available. Duplicate calls to this method will be ignored.

Params
nickName
Returns
{Room} Returns a room manager to control an individual room.

kick(userId, reason):Room

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES Kick an occupant from the room.

Params
{String} userId - unique user identifier {String} reason - reason for the kick, this will be delivered to the user as a message.
Returns
{Room} Returns a room manager to control an individual room.

leave():Room

version: 1.2.0

Leave the room. The room object will remain in memory as will all of its bindings. This means you can rejoin the room at anytime if you so decide.

Params
Returns
{Room} Returns a room manager to control an individual room.

revokeMembership(userId):Room

Not yet implemented.

REQUIRES MODERATOR PRIVILEGES Revoke membership from an existing member of the room.

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

revokeModerator(userId):Room

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES Revoke a RoomOccupant as a moderator.

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

revokeVoice(userId):Room

Not yet implemented.

REQUIRES MODERATOR PRIVILEGES Revoke voice from an occupant ( squelching for the whole room ).

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.

send(message):Room

version: 1.2.0

Params
{String} message - the message to be sent to the room
Returns
{Room} Returns a room manager to control an individual room.

sendPrivateMessage(nickName, message):Room

Not yet implemented.

Send a private message to a given occupant.

Params
{String} nickName - unique user identifier {String} message - the message to be sent to the room occupant.
Returns
{Room} Returns a room manager to control an individual room.

setBanList(banList):Room

version: 1.2.5

Update the ban list with an array of updates to bulk update with.

Params
{Array} banList - An array of userIds to set the ban list to. This is a sync operation so the existing ban list will be replaced.
Returns
{Room} Returns a room manager to control an individual room.

setMemberList(memberList):Room

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES Revoke membership from an existing member of the room.

Params
{RoomMember[]} memberList - Array of userId's to set as the new memberList
Returns
{Room} Returns a room manager to control an individual room.

setModeratorList(moderatorList):Room

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES A list of userIds to use use for a bulk update of the mdoerator list.

Params
{String[]} moderatorList - An array of userIds to set as moderators.
Returns
{Room} Returns a room manager to control an individual room.

setPresence(show, status, custom):Rooom

version: 1.2.5

Sets the users presence information in the room

Params
show status custom
Returns
{Rooom} Returns a room manager

setSubject(subject):Room

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES Set the room subject.

Params
{String} subject - String value for the subject of the room.
Returns
{Room} Returns a room manager to control an individual room.

setVoiceList(voiceList):Room

Not yet implemented.

REQUIRES ADMINISTRATOR PRIVILEGES Retrieve an array of RoomOccupants for everyone currently in the room.

Params
{Array} voiceList - An array containing objects with a userId and role property for room to do a bulk update of voice.
Returns
{Room} Returns a room manager to control an individual room.

unban(userId):Room

version: 1.2.5

REQUIRES MODERATOR PRIVILEGES un-ban a user from the room.

Params
{String} userId - unique user identifier
Returns
{Room} Returns a room manager to control an individual room.
Event Detail
RoomBanEvent()
See:
RoomBanEvent
RoomInviteEvent()
See:
RoomInviteEvent
RoomKickEvent()
See:
RoomKickEvent
RoomPresenceEvent()
See:
RoomPresenceEvent
RoomStatusEvent()
See:
RoomStatusEvent
RoomSubjectEvent()
See:
RoomSubjectEvent