templatizedaction.html

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

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#getTitleParams()">getTitleParams</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the title params as a JSON-formatted string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#getTitleTemplate()">getTitleTemplate</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#removePicture(int)">removePicture</A></B>(int&nbsp;index)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Remove a picture from the list, this can be used to revise the list/free up space for alternate pictures.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setBodyGeneral(java.lang.String)">setBodyGeneral</A></B>(java.lang.String&nbsp;bodyGeneral)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the general body content for this feed entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setBodyTemplate(java.lang.String)">setBodyTemplate</A></B>(java.lang.String&nbsp;bodyTemplate)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the body template for this feed entry.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setPageActorId(java.lang.Long)">setPageActorId</A></B>(java.lang.Long&nbsp;pageActorId)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setPictures(java.util.List)">setPictures</A></B>(java.util.List&lt;? extends <A HREF="../../../../com/google/code/facebookapi/IPair.html" title="interface in com.google.code.facebookapi">IPair</A>&lt;java.lang.Object,java.net.URL&gt;&gt;&nbsp;pics)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pictures to display all at once, if you feel like building the Collection<Pair<URL, URL>> on your own.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setTargetIds(java.util.Collection)">setTargetIds</A></B>(java.util.Collection&lt;java.lang.Object&gt;&nbsp;facebookIds)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the target ids of friends who are associated with this action.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setTargetIds(java.lang.String)">setTargetIds</A></B>(java.lang.String&nbsp;targetIds)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the target ids of friends who are associated with this action.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../com/google/code/facebookapi/TemplatizedAction.html#setTitleTemplate(java.lang.String)">setTitleTemplate</A></B>(java.lang.String&nbsp;titleTemplate)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the title template for this feed entry.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_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>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="log"><!-- --></A><H3>
log</H3>
<PRE>
protected static org.apache.commons.logging.Log <B>log</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="UID_TOKEN"><!-- --></A><H3>
UID_TOKEN</H3>
<PRE>
public static final java.lang.String <B>UID_TOKEN</B></PRE>
<DL>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#com.google.code.facebookapi.TemplatizedAction.UID_TOKEN">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_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>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="TemplatizedAction(java.lang.String)"><!-- --></A><H3>
TemplatizedAction</H3>
<PRE>
public <B>TemplatizedAction</B>(java.lang.String&nbsp;titleTemplate)</PRE>
<DL>
<DD>Constructor
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>titleTemplate</CODE> - the title-template to set.</DL>
</DL>
<HR>

<A NAME="TemplatizedAction(java.lang.String, java.lang.String)"><!-- --></A><H3>
TemplatizedAction</H3>
<PRE>
public <B>TemplatizedAction</B>(java.lang.String&nbsp;titleTemplate,
                         java.lang.String&nbsp;bodyTemplate)</PRE>
<DL>
<DD>Constructor
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>titleTemplate</CODE> - the title template to use<DD><CODE>bodyTemplate</CODE> - the body template to use</DL>
</DL>
<HR>

<A NAME="TemplatizedAction(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
TemplatizedAction</H3>
<PRE>
public <B>TemplatizedAction</B>(java.lang.String&nbsp;titleTemplate,
                         java.lang.String&nbsp;bodyTemplate,
                         java.lang.String&nbsp;bodyGeneral)</PRE>
<DL>
<DD>Constructor
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>titleTemplate</CODE> - the title template to use<DD><CODE>bodyTemplate</CODE> - the body template to use<DD><CODE>bodyGeneral</CODE> - the non-templatized body content to use</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="removePicture(int)"><!-- --></A><H3>
removePicture</H3>
<PRE>
public void <B>removePicture</B>(int&nbsp;index)</PRE>
<DL>
<DD>Remove a picture from the list, this can be used to revise the list/free up space for alternate pictures.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to remove from.</DL>
</DD>
</DL>
<HR>

<A NAME="addPicture(java.lang.Long, java.lang.String)"><!-- --></A><H3>
addPicture</H3>
<PRE>
public void <B>addPicture</B>(java.lang.Long&nbsp;imageUid,
                       java.lang.String&nbsp;linkHref)</PRE>
<DL>
<DD>Add a picture to be associated with this feed entry, along with a link to be associated with the picture (clicking on the picture in the feed will go to the
 specified link).<br />
 <br />
 Note that only 4 pictures may be present at any given time. Any pictures beyond this are ignored. Use removePicture if you need to change something after 4
 pictures have been added.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageUid</CODE> - the id of the image to display. This can be a picture id or a Facebook user-id.<DD><CODE>linkHref</CODE> - the URL of the link to go to when the image is clicked.</DL>
</DD>
</DL>
<HR>

<A NAME="addPicture(java.lang.String, java.lang.String)"><!-- --></A><H3>
addPicture</H3>
<PRE>
public void <B>addPicture</B>(java.lang.String&nbsp;imageHref,
                       java.lang.String&nbsp;linkHref)</PRE>
<DL>
<DD>Add a picture to be associated with this feed entry, along with a link to be associated with the picture (clicking on the picture in the feed will go to the
 specified link).<br />
 <br />
 Note that only 4 pictures may be present at any given time. Any pictures beyond this are ignored. Use removePicture if you need to change something after 4
 pictures have been added.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageHref</CODE> - the URL of the image to display in the feed.<DD><CODE>linkHref</CODE> - the URL of the link to go to when the image is clicked.</DL>
</DD>
</DL>
<HR>

<A NAME="addPicture(java.lang.String)"><!-- --></A><H3>
addPicture</H3>
<PRE>
public void <B>addPicture</B>(java.lang.String&nbsp;imageHref)</PRE>
<DL>
<DD>Add a picture to be associated with this feed entry, the picture will not have an associated link.
 
 Note that only 4 pictures may be present at any given time. Any pictures beyond this are ignored. Use removePicture if you need to change something after 4
 pictures have been added.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>imageHref</CODE> - the URL of the image to display in the feed.</DL>
</DD>
</DL>
<HR>

<A NAME="setPictures(java.util.List)"><!-- --></A><H3>
setPictures</H3>
<PRE>
public void <B>setPictures</B>(java.util.List&lt;? extends <A HREF="../../../../com/google/code/facebookapi/IPair.html" title="interface in com.google.code.facebookapi">IPair</A>&lt;java.lang.Object,java.net.URL&gt;&gt;&nbsp;pics)</PRE>
<DL>
<DD>Set the pictures to display all at once, if you feel like building the Collection<Pair<URL, URL>> on your own. Otherwise use the more convenient addPic() method
 instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pics</CODE> - the pictures to set.</DL>
</DD>
</DL>
<HR>

<A NAME="getPictures()"><!-- --></A><H3>
getPictures</H3>
<PRE>
public java.util.Collection&lt;<A HREF="../../../../com/google/code/facebookapi/IPair.html" title="interface in com.google.code.facebookapi">IPair</A>&lt;java.lang.Object,java.net.URL&gt;&gt; <B>getPictures</B>()</PRE>
<DL>
<DD>Get the list of pictures.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the list of pictures.</DL>
</DD>
</DL>
<HR>

<A NAME="addTitleParam(java.lang.String, java.lang.String)"><!-- --></A><H3>
addTitleParam</H3>
<PRE>
public void <B>addTitleParam</B>(java.lang.String&nbsp;key,
                          java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Add a parameter value for the title template. It will be used to replace the corresponding token when the feed entry is rendered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the name of the parameter/token.<DD><CODE>value</CODE> - the value to set it to.</DL>