facebookwebapphelper.html

来自「A Facebook API client implemented in Jav」· HTML 代码 · 共 873 行 · 第 1/3 页

<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getSecret()"><!-- --></A><H3>
getSecret</H3>
<PRE>
public java.lang.String <B>getSecret</B>()</PRE>
<DL>
<DD>Returns the secret key used to initialize this object.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getApiKey()"><!-- --></A><H3>
getApiKey</H3>
<PRE>
public java.lang.String <B>getApiKey</B>()</PRE>
<DL>
<DD>Returns the api key used to initialize this object.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="doGetSession(java.lang.String)"><!-- --></A><H3>
doGetSession</H3>
<PRE>
public java.lang.String <B>doGetSession</B>(java.lang.String&nbsp;authToken)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="inFrame()"><!-- --></A><H3>
inFrame</H3>
<PRE>
public boolean <B>inFrame</B>()</PRE>
<DL>
<DD>Returns true if the application is in a frame or a canvas.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="inFbCanvas()"><!-- --></A><H3>
inFbCanvas</H3>
<PRE>
public boolean <B>inFbCanvas</B>()</PRE>
<DL>
<DD>Returns true if the application is in a canvas.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isAdded()"><!-- --></A><H3>
isAdded</H3>
<PRE>
public boolean <B>isAdded</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isLogin()"><!-- --></A><H3>
isLogin</H3>
<PRE>
public boolean <B>isLogin</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="get_loggedin_user()"><!-- --></A><H3>
get_loggedin_user</H3>
<PRE>
public java.lang.Long <B>get_loggedin_user</B>()</PRE>
<DL>
<DD>Synonym for <A HREF="../../../../com/google/code/facebookapi/FacebookWebappHelper.html#getUser()"><CODE>getUser()</CODE></A>
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getUser()"><!-- --></A><H3>
getUser</H3>
<PRE>
public java.lang.Long <B>getUser</B>()</PRE>
<DL>
<DD>Returns the user id of the logged in user associated with this object
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="requireLogin(java.lang.String)"><!-- --></A><H3>
requireLogin</H3>
<PRE>
public boolean <B>requireLogin</B>(java.lang.String&nbsp;next)</PRE>
<DL>
<DD>Forces the user to log in to this application. If the user hasn't logged in yet, this method issues a url redirect.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>next</CODE> - the value for the 'next' request paramater that is appended to facebook's login screen.
<DT><B>Returns:</B><DD>true if the user hasn't logged in yet and a redirect was issued.</DL>
</DD>
</DL>
<HR>

<A NAME="requireAdd(java.lang.String)"><!-- --></A><H3>
requireAdd</H3>
<PRE>
<FONT SIZE="-1">@Deprecated
</FONT>public boolean <B>requireAdd</B>(java.lang.String&nbsp;next)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;
<P>
<DD>Forces the user to add this application. If the user hasn't added it yet, this method issues a url redirect.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>next</CODE> - the value for the 'next' request paramater that is appended to facebook's add screen.
<DT><B>Returns:</B><DD>true if the user hasn't added the application yet and a redirect was issued.</DL>
</DD>
</DL>
<HR>

<A NAME="requireFrame(java.lang.String)"><!-- --></A><H3>
requireFrame</H3>
<PRE>
public boolean <B>requireFrame</B>(java.lang.String&nbsp;next)</PRE>
<DL>
<DD>Forces the application to be in a frame. If it is not in a frame, this method issues a url redirect.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>next</CODE> - the value for the 'next' request paramater that is appended to facebook's login screen.
<DT><B>Returns:</B><DD>true if a redirect was issued, false otherwise.</DL>
</DD>
</DL>
<HR>

<A NAME="getLoginUrl(java.lang.String, boolean)"><!-- --></A><H3>
getLoginUrl</H3>
<PRE>
public java.lang.String <B>getLoginUrl</B>(java.lang.String&nbsp;next,
                                    boolean&nbsp;canvas)</PRE>
<DL>
<DD>Returns the url that facebook uses to prompt the user to login to this application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>next</CODE> - indicates the page to which facebook should redirect the user has logged in.</DL>
</DD>
</DL>
<HR>

<A NAME="getAddUrl(java.lang.String)"><!-- --></A><H3>
getAddUrl</H3>
<PRE>
public java.lang.String <B>getAddUrl</B>(java.lang.String&nbsp;next)</PRE>
<DL>
<DD>Returns the url that facebook uses to prompt the user to add this application.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>next</CODE> - indicates the page to which facebook should redirect the user after the application is added.</DL>
</DD>
</DL>
<HR>

<A NAME="getFacebookUrl(java.lang.String)"><!-- --></A><H3>
getFacebookUrl</H3>
<PRE>
public static java.lang.String <B>getFacebookUrl</B>(java.lang.String&nbsp;subDomain)</PRE>
<DL>
<DD>Returns a url to a facebook sub-domain
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>subDomain</CODE> - </DL>
</DD>
</DL>
<HR>

<A NAME="generateSig(java.util.Map, java.lang.String)"><!-- --></A><H3>
generateSig</H3>
<PRE>
public static java.lang.String <B>generateSig</B>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
                                           java.lang.String&nbsp;secret)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="verifySignature(java.util.Map, java.lang.String)"><!-- --></A><H3>
verifySignature</H3>
<PRE>
public boolean <B>verifySignature</B>(java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;params,
                               java.lang.String&nbsp;expected_sig)</PRE>
<DL>
<DD>Verifies that the signature of the parameters is valid
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - a map of the parameters. Typically these are the request parameters that start with "fb_sig"<DD><CODE>expected_sig</CODE> - the expected signature</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="../../../../com/google/code/facebookapi/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="class-use/FacebookWebappHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&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>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../com/google/code/facebookapi/FacebookSignatureUtil.html" title="class in com.google.code.facebookapi"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../com/google/code/facebookapi/FacebookWebRequest.html" title="class in com.google.code.facebookapi"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?com/google/code/facebookapi/FacebookWebappHelper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="FacebookWebappHelper.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;<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;<A HREF="#field_detail">FIELD</A>&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>
Copyright &#169; 2008. All Rights Reserved.
</BODY>
</HTML>