iqregisterinfo.html

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

<PRE>
static final int <B>NAME</B></PRE>
<DL>
<DD>The user's full name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FIRST_NAME"><!-- --></A><H3>
FIRST_NAME</H3>
<PRE>
static final int <B>FIRST_NAME</B></PRE>
<DL>
<DD>The user's first name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.FIRST_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="LAST_NAME"><!-- --></A><H3>
LAST_NAME</H3>
<PRE>
static final int <B>LAST_NAME</B></PRE>
<DL>
<DD>The user's last name
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.LAST_NAME">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ADDRESS"><!-- --></A><H3>
ADDRESS</H3>
<PRE>
static final int <B>ADDRESS</B></PRE>
<DL>
<DD>The user's address
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.ADDRESS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="CITY"><!-- --></A><H3>
CITY</H3>
<PRE>
static final int <B>CITY</B></PRE>
<DL>
<DD>The user's city
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.CITY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="STATE"><!-- --></A><H3>
STATE</H3>
<PRE>
static final int <B>STATE</B></PRE>
<DL>
<DD>The user's state
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.STATE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ZIP"><!-- --></A><H3>
ZIP</H3>
<PRE>
static final int <B>ZIP</B></PRE>
<DL>
<DD>The user's zip code
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.ZIP">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="PHONE"><!-- --></A><H3>
PHONE</H3>
<PRE>
static final int <B>PHONE</B></PRE>
<DL>
<DD>The user's phone
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.PHONE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="URL"><!-- --></A><H3>
URL</H3>
<PRE>
static final int <B>URL</B></PRE>
<DL>
<DD>The user's url
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.URL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DATE"><!-- --></A><H3>
DATE</H3>
<PRE>
static final int <B>DATE</B></PRE>
<DL>
<DD>The date of registration
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.DATE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="MISC"><!-- --></A><H3>
MISC</H3>
<PRE>
static final int <B>MISC</B></PRE>
<DL>
<DD>Misc data to associate with the account
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.MISC">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="TEXT"><!-- --></A><H3>
TEXT</H3>
<PRE>
static final int <B>TEXT</B></PRE>
<DL>
<DD>Misc text to associate with the account
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.TEXT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FIELD_NAMES"><!-- --></A><H3>
FIELD_NAMES</H3>
<PRE>
static final <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>FIELD_NAMES</B></PRE>
<DL>
<DD>Element names of the fields, array index matches type
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="FIELD_IN_USER_PROPS"><!-- --></A><H3>
FIELD_IN_USER_PROPS</H3>
<PRE>
static final int <B>FIELD_IN_USER_PROPS</B></PRE>
<DL>
<DD>Fields should be stored in user properties
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.FIELD_IN_USER_PROPS">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="FIELD_IN_VCARD"><!-- --></A><H3>
FIELD_IN_VCARD</H3>
<PRE>
static final int <B>FIELD_IN_VCARD</B></PRE>
<DL>
<DD>Fields should be stored in vCard
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.jivesoftware.openfire.handler.IQRegisterInfo.FIELD_IN_VCARD">Constant Field Values</A></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="getFieldStoreLocation()"><!-- --></A><H3>
getFieldStoreLocation</H3>
<PRE>
int <B>getFieldStoreLocation</B>()</PRE>
<DL>
<DD>Determines where field information is stored.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the location type.</DL>
</DD>
</DL>
<HR>

<A NAME="setFieldStoreLocation(int)"><!-- --></A><H3>
setFieldStoreLocation</H3>
<PRE>
void <B>setFieldStoreLocation</B>(int&nbsp;location)
                           throws <A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD>Sets the location for storing field information.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>location</CODE> - The location type
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE> - If you don't have permission to adjust this setting</DL>
</DD>
</DL>
<HR>

<A NAME="isOpenRegistrationSupported()"><!-- --></A><H3>
isOpenRegistrationSupported</H3>
<PRE>
boolean <B>isOpenRegistrationSupported</B>()</PRE>
<DL>
<DD>Determines if users can automatically register user accounts
 without system administrator intervention.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>True if open registration is supported</DL>
</DD>
</DL>
<HR>

<A NAME="setOpenRegistrationSupported(boolean)"><!-- --></A><H3>
setOpenRegistrationSupported</H3>
<PRE>
void <B>setOpenRegistrationSupported</B>(boolean&nbsp;isSupported)
                                  throws <A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD>Tells the server whether to support open registration or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>isSupported</CODE> - True if open registration is supported
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE> - If you don't have permission to change this setting</DL>
</DD>
</DL>
<HR>

<A NAME="isFieldRequired(int)"><!-- --></A><H3>
isFieldRequired</H3>
<PRE>
boolean <B>isFieldRequired</B>(int&nbsp;fieldType)</PRE>
<DL>
<DD>Determines if a given field is required for registration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldType</CODE> - The field to check
<DT><B>Returns:</B><DD>True if the field is required</DL>
</DD>
</DL>
<HR>

<A NAME="setFieldRequired(int, boolean)"><!-- --></A><H3>
setFieldRequired</H3>
<PRE>
void <B>setFieldRequired</B>(int&nbsp;fieldType,
                      boolean&nbsp;isRequired)
                      throws <A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD>Tells the server whether to require a registration field or not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldType</CODE> - The field to require.<DD><CODE>isRequired</CODE> - True if the field should be required
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE> - If you don't have permission to change this setting</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldType(java.lang.String)"><!-- --></A><H3>
getFieldType</H3>
<PRE>
int <B>getFieldType</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;fieldElementName)</PRE>
<DL>
<DD>Get the setting type from a field's element name. This is a convenience
 for looking up the correct field type from an element name.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldElementName</CODE> - The known element name
<DT><B>Returns:</B><DD>The field type, one of the static int types defined in this class</DL>
</DD>
</DL>
<HR>

<A NAME="getFieldElementName(int)"><!-- --></A><H3>
getFieldElementName</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>getFieldElementName</B>(int&nbsp;fieldType)</PRE>
<DL>
<DD>Obtain the element name from a field type. This is a convience for
 looking up the correct field element name from it's field type.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fieldType</CODE> - The known field type
<DT><B>Returns:</B><DD>The field element name</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/handler/IQRegisterHandler.html" title="class in org.jivesoftware.openfire.handler"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/jivesoftware/openfire/handler/IQRosterHandler.html" title="class in org.jivesoftware.openfire.handler"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/jivesoftware/openfire/handler/IQRegisterInfo.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="IQRegisterInfo.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;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&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>