privacyitem.html

开源项目smack的API文件

</TABLE>

<A NAME="PrivacyItem(java.lang.String, boolean, int)"><!-- --></A><H3>
PrivacyItem</H3>
<PRE>
public <B>PrivacyItem</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;type,
                   boolean&nbsp;allow,
                   int&nbsp;order)</PRE>
<DL>
<DD>Creates a new privacy item.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="isAllow()"><!-- --></A><H3>
isAllow</H3>
<PRE>
public boolean <B>isAllow</B>()</PRE>
<DL>
<DD>Returns the action associated with the item, it MUST be filled and will allow or deny
 the communication.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the allow communication status.</DL>
</DD>
</DL>
<HR>

<A NAME="isFilterIQ()"><!-- --></A><H3>
isFilterIQ</H3>
<PRE>
public boolean <B>isFilterIQ</B>()</PRE>
<DL>
<DD>Returns whether the receiver allow or deny incoming IQ stanzas or not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the iq filtering status.</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterIQ(boolean)"><!-- --></A><H3>
setFilterIQ</H3>
<PRE>
public void <B>setFilterIQ</B>(boolean&nbsp;filterIQ)</PRE>
<DL>
<DD>Sets whether the receiver allows or denies incoming IQ stanzas or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterIQ</CODE> - indicates if the receiver allows or denies incoming IQ stanzas.</DL>
</DD>
</DL>
<HR>

<A NAME="isFilterMessage()"><!-- --></A><H3>
isFilterMessage</H3>
<PRE>
public boolean <B>isFilterMessage</B>()</PRE>
<DL>
<DD>Returns whether the receiver allows or denies incoming messages or not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the message filtering status.</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterMessage(boolean)"><!-- --></A><H3>
setFilterMessage</H3>
<PRE>
public void <B>setFilterMessage</B>(boolean&nbsp;filterMessage)</PRE>
<DL>
<DD>Sets wheather the receiver allows or denies incoming messages or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterMessage</CODE> - indicates if the receiver allows or denies incoming messages or not.</DL>
</DD>
</DL>
<HR>

<A NAME="isFilterPresence_in()"><!-- --></A><H3>
isFilterPresence_in</H3>
<PRE>
public boolean <B>isFilterPresence_in</B>()</PRE>
<DL>
<DD>Returns whether the receiver allows or denies incoming presence or not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the iq filtering incoming presence status.</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterPresence_in(boolean)"><!-- --></A><H3>
setFilterPresence_in</H3>
<PRE>
public void <B>setFilterPresence_in</B>(boolean&nbsp;filterPresence_in)</PRE>
<DL>
<DD>Sets whether the receiver allows or denies incoming presence or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterPresence_in</CODE> - indicates if the receiver allows or denies filtering incoming presence.</DL>
</DD>
</DL>
<HR>

<A NAME="isFilterPresence_out()"><!-- --></A><H3>
isFilterPresence_out</H3>
<PRE>
public boolean <B>isFilterPresence_out</B>()</PRE>
<DL>
<DD>Returns whether the receiver allows or denies incoming presence or not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the iq filtering incoming presence status.</DL>
</DD>
</DL>
<HR>

<A NAME="setFilterPresence_out(boolean)"><!-- --></A><H3>
setFilterPresence_out</H3>
<PRE>
public void <B>setFilterPresence_out</B>(boolean&nbsp;filterPresence_out)</PRE>
<DL>
<DD>Sets whether the receiver allows or denies outgoing presence or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>filterPresence_out</CODE> - indicates if the receiver allows or denies filtering outgoing presence</DL>
</DD>
</DL>
<HR>

<A NAME="getOrder()"><!-- --></A><H3>
getOrder</H3>
<PRE>
public int <B>getOrder</B>()</PRE>
<DL>
<DD>Returns the order where the receiver is processed. List items are processed in
 ascending order.

 The order MUST be filled and its value MUST be a non-negative integer
 that is unique among all items in the list.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the order number.</DL>
</DD>
</DL>
<HR>

<A NAME="setValue(java.lang.String)"><!-- --></A><H3>
setValue</H3>
<PRE>
public void <B>setValue</B>(<A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;value)</PRE>
<DL>
<DD>Sets the element identifier to apply the action.

 If the type is "jid", then the 'value' attribute MUST contain a valid Jabber ID.
 If the type is "group", then the 'value' attribute SHOULD contain the name of a group
 in the user's roster.
 If the type is "subscription", then the 'value' attribute MUST be one of "both", "to",
 "from", or "none".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - is the identifier to apply the action.</DL>
</DD>
</DL>
<HR>

<A NAME="getType()"><!-- --></A><H3>
getType</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/smack/packet/PrivacyItem.Type.html" title="enum in org.jivesoftware.smack.packet">PrivacyItem.Type</A> <B>getType</B>()</PRE>
<DL>
<DD>Returns the type hold the kind of communication it will allow or block.
 It MUST be filled with one of these values: jid, group or subscription.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the type of communication it represent.</DL>
</DD>
</DL>
<HR>

<A NAME="getValue()"><!-- --></A><H3>
getValue</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getValue</B>()</PRE>
<DL>
<DD>Returns the element identifier to apply the action.

 If the type is "jid", then the 'value' attribute MUST contain a valid Jabber ID.
 If the type is "group", then the 'value' attribute SHOULD contain the name of a group
 in the user's roster.
 If the type is "subscription", then the 'value' attribute MUST be one of "both", "to",
 "from", or "none".
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the identifier to apply the action.</DL>
</DD>
</DL>
<HR>

<A NAME="isFilterEverything()"><!-- --></A><H3>
isFilterEverything</H3>
<PRE>
public boolean <B>isFilterEverything</B>()</PRE>
<DL>
<DD>Returns whether the receiver allows or denies every kind of communication.

 When filterIQ, filterMessage, filterPresence_in and filterPresence_out are not set
 the receiver will block all communications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the all communications status.</DL>
</DD>
</DL>
<HR>

<A NAME="toXML()"><!-- --></A><H3>
toXML</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.3/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>toXML</B>()</PRE>
<DL>
<DD>Answer an xml representation of the receiver according to the RFC 3921.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the text xml representation.</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>Smack</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/jivesoftware/smack/packet/Privacy.html" title="class in org.jivesoftware.smack.packet"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/smack/packet/PrivacyItem.PrivacyRule.html" title="class in org.jivesoftware.smack.packet"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/smack/packet/PrivacyItem.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PrivacyItem.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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-2007 Jive Software. </i>
</BODY>
</HTML>