mucrole.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

<DT><B>Returns:</B><DD>The presence of the user in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="setPresence(org.xmpp.packet.Presence)"><!-- --></A><H3>
setPresence</H3>
<PRE>
void <B>setPresence</B>(<A HREF="../../../../org/xmpp/packet/Presence.html" title="class in org.xmpp.packet">Presence</A>&nbsp;presence)</PRE>
<DL>
<DD>Set the current presence status of a user in a chatroom.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>presence</CODE> - The presence of the user in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="setRole(org.jivesoftware.openfire.muc.MUCRole.Role)"><!-- --></A><H3>
setRole</H3>
<PRE>
void <B>setRole</B>(<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.Role.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Role</A>&nbsp;newRole)
             throws <A HREF="../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></PRE>
<DL>
<DD>Call this method to promote or demote a user's role in a chatroom.
 It is common for the chatroom or other chat room members to change
 the role of users (a moderator promoting another user to moderator
 status for example).<p>
 <p/>
 Owning ChatUsers should have their membership roles updated.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newRole</CODE> - The new role that the user will play.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></CODE> - Thrown if trying to change the moderator role to an owner or
                               administrator.</DL>
</DD>
</DL>
<HR>

<A NAME="getRole()"><!-- --></A><H3>
getRole</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.Role.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Role</A> <B>getRole</B>()</PRE>
<DL>
<DD>Obtain the role state of the user.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The role status of this user.</DL>
</DD>
</DL>
<HR>

<A NAME="setAffiliation(org.jivesoftware.openfire.muc.MUCRole.Affiliation)"><!-- --></A><H3>
setAffiliation</H3>
<PRE>
void <B>setAffiliation</B>(<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Affiliation</A>&nbsp;newAffiliation)
                    throws <A HREF="../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></PRE>
<DL>
<DD>Call this method to promote or demote a user's affiliation in a chatroom.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>newAffiliation</CODE> - the new affiliation that the user will play.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/muc/NotAllowedException.html" title="class in org.jivesoftware.openfire.muc">NotAllowedException</A></CODE> - thrown if trying to ban an owner or an administrator.</DL>
</DD>
</DL>
<HR>

<A NAME="getAffiliation()"><!-- --></A><H3>
getAffiliation</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc">MUCRole.Affiliation</A> <B>getAffiliation</B>()</PRE>
<DL>
<DD>Obtain the affiliation state of the user.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The affiliation status of this user.</DL>
</DD>
</DL>
<HR>

<A NAME="changeNickname(java.lang.String)"><!-- --></A><H3>
changeNickname</H3>
<PRE>
void <B>changeNickname</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;nickname)</PRE>
<DL>
<DD>Changes the nickname of the occupant within the room to the new nickname.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nickname</CODE> - the new nickname of the occupant in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="getNickname()"><!-- --></A><H3>
getNickname</H3>
<PRE>
<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getNickname</B>()</PRE>
<DL>
<DD>Obtain the nickname for the user in the chatroom.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The user's nickname in the room or null if invisible.</DL>
</DD>
</DL>
<HR>

<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
void <B>destroy</B>()</PRE>
<DL>
<DD>Destroys this role after the occupant left the room. This role will be
 removed from MUCUser.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isVoiceOnly()"><!-- --></A><H3>
isVoiceOnly</H3>
<PRE>
boolean <B>isVoiceOnly</B>()</PRE>
<DL>
<DD>Returns true if the room occupant does not want to get messages broadcasted to all
 room occupants. This type of users are called "deaf" occupants. Deaf occupants will still
 be able to get private messages, presences, IQ packets or room history.<p>

 To be a deaf occupant the initial presence sent to the room while joining the room has
 to include the following child element:
 <pre>
 &lt;x xmlns='http://jivesoftware.org/protocol/muc'&gt;
     &lt;deaf-occupant/&gt;
 &lt;/x&gt;
 </pre>

 Note that this is a custom extension to the MUC specification.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if the room occupant does not want to get messages broadcasted to all
         room occupants.</DL>
</DD>
</DL>
<HR>

<A NAME="getChatRoom()"><!-- --></A><H3>
getChatRoom</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRoom.html" title="interface in org.jivesoftware.openfire.muc">MUCRoom</A> <B>getChatRoom</B>()</PRE>
<DL>
<DD>Obtain the chat room that hosts this user's role.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The chatroom hosting this role.</DL>
</DD>
</DL>
<HR>

<A NAME="getRoleAddress()"><!-- --></A><H3>
getRoleAddress</H3>
<PRE>
<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getRoleAddress</B>()</PRE>
<DL>
<DD>Obtain the XMPPAddress representing this role in a room: room@server/nickname
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The Jabber ID that represents this role in the room.</DL>
</DD>
</DL>
<HR>

<A NAME="getUserAddress()"><!-- --></A><H3>
getUserAddress</H3>
<PRE>
<A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getUserAddress</B>()</PRE>
<DL>
<DD>Obtain the XMPPAddress of the user that joined the room. A <tt>null</tt> null value
 represents the room's role.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The address of the user that joined the room or null if this role belongs to the room itself.</DL>
</DD>
</DL>
<HR>

<A NAME="isLocal()"><!-- --></A><H3>
isLocal</H3>
<PRE>
boolean <B>isLocal</B>()</PRE>
<DL>
<DD>Returns true if this room occupant is hosted by this JVM.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if this room occupant is hosted by this JVM</DL>
</DD>
</DL>
<HR>

<A NAME="getNodeID()"><!-- --></A><H3>
getNodeID</H3>
<PRE>
<A HREF="../../../../org/jivesoftware/openfire/cluster/NodeID.html" title="class in org.jivesoftware.openfire.cluster">NodeID</A> <B>getNodeID</B>()</PRE>
<DL>
<DD>Returns the id of the node that is hosting the room occupant.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the id of the node that is hosting the room occupant.</DL>
</DD>
</DL>
<HR>

<A NAME="send(org.xmpp.packet.Packet)"><!-- --></A><H3>
send</H3>
<PRE>
void <B>send</B>(<A HREF="../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet)</PRE>
<DL>
<DD>Sends a packet to the user.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - The packet to send</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Openfire 3.6.0a Javadoc</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/muc/MUCEventListener.html" title="interface in org.jivesoftware.openfire.muc"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/muc/MUCRole.Affiliation.html" title="enum in org.jivesoftware.openfire.muc"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/muc/MUCRole.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="MUCRole.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<i>Copyright &copy; 2003-2008 Jive Software.</i>
</BODY>
</HTML>