Google Git
Sign in
eclipse / gerrit / www.eclipse.org / ecf / 3e85b3d5b2b1eec06a4fc20ea9e7f9aa2e05081a / . / org.eclipse.ecf.docs / api / org / eclipse / ecf / presence / IPresenceSender.html
blob: eff7b172d4a4ec566f5754249e06f96b84ca1d54 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_02) on Sat Jul 09 23:08:08 PDT 2005 -->
<TITLE>
IPresenceSender
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.ecf.presence.IPresenceSender interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="IPresenceSender";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" 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_top_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="class-use/IPresenceSender.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-files/index-1.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="../../../../org/eclipse/ecf/presence/IPresenceListener.html" title="interface in org.eclipse.ecf.presence"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/eclipse/ecf/presence/IRosterEntry.html" title="interface in org.eclipse.ecf.presence"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/eclipse/ecf/presence/IPresenceSender.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IPresenceSender.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;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_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.eclipse.ecf.presence</FONT>
<BR>
Interface IPresenceSender</H2>
<HR>
<DL>
<DT><PRE>public interface <B>IPresenceSender</B></DL>
</PRE>
<P>
Send presence change events to remotes on buddy list
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</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="../../../../org/eclipse/ecf/presence/IPresenceSender.html#sendPresenceUpdate(org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.presence.IPresence)">sendPresenceUpdate</A></B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;toID,
<A HREF="../../../../org/eclipse/ecf/presence/IPresence.html" title="interface in org.eclipse.ecf.presence">IPresence</A>&nbsp;presence)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send a presence update to a remote target user</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="../../../../org/eclipse/ecf/presence/IPresenceSender.html#sendRosterAdd(org.eclipse.ecf.core.identity.ID, java.lang.String, java.lang.String, java.lang.String[])">sendRosterAdd</A></B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
java.lang.String&nbsp;user,
java.lang.String&nbsp;name,
java.lang.String[]&nbsp;groups)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send a roster add request (subscribe) to a remote</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="../../../../org/eclipse/ecf/presence/IPresenceSender.html#sendRosterRemove(org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.core.identity.ID)">sendRosterRemove</A></B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;userID)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Send roster remove request (unsubscribe) to a remote</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ 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="sendPresenceUpdate(org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.presence.IPresence)"><!-- --></A><H3>
sendPresenceUpdate</H3>
<PRE>
void <B>sendPresenceUpdate</B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;toID,
<A HREF="../../../../org/eclipse/ecf/presence/IPresence.html" title="interface in org.eclipse.ecf.presence">IPresence</A>&nbsp;presence)</PRE>
<DL>
<DD>Send a presence update to a remote target user
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromID</CODE> - the user the update is from<DD><CODE>toID</CODE> - the target user<DD><CODE>presence</CODE> - the presence information</DL>
</DD>
</DL>
<HR>
<A NAME="sendRosterAdd(org.eclipse.ecf.core.identity.ID, java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
sendRosterAdd</H3>
<PRE>
void <B>sendRosterAdd</B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
java.lang.String&nbsp;user,
java.lang.String&nbsp;name,
java.lang.String[]&nbsp;groups)</PRE>
<DL>
<DD>Send a roster add request (subscribe) to a remote
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromID</CODE> - the user the subscription request is from<DD><CODE>user</CODE> - the account name of the target user<DD><CODE>groups</CODE> - an array of group names that this use will belong to
on the roster entry</DL>
</DD>
</DL>
<HR>
<A NAME="sendRosterRemove(org.eclipse.ecf.core.identity.ID, org.eclipse.ecf.core.identity.ID)"><!-- --></A><H3>
sendRosterRemove</H3>
<PRE>
void <B>sendRosterRemove</B>(<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;fromID,
<A HREF="../../../../org/eclipse/ecf/core/identity/ID.html" title="interface in org.eclipse.ecf.core.identity">ID</A>&nbsp;userID)</PRE>
<DL>
<DD>Send roster remove request (unsubscribe) to a remote
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>fromID</CODE> - the user id the request is from<DD><CODE>userID</CODE> - the user id the request it intended for</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="class-use/IPresenceSender.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-files/index-1.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="../../../../org/eclipse/ecf/presence/IPresenceListener.html" title="interface in org.eclipse.ecf.presence"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/eclipse/ecf/presence/IRosterEntry.html" title="interface in org.eclipse.ecf.presence"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/eclipse/ecf/presence/IPresenceSender.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="IPresenceSender.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;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>
</BODY>
</HTML>