com.zion.jbuddy
Interface ISametimeClient

All Superinterfaces:

IClient

public interface ISametimeClient
extends IClient

Provides access to features specific to the SAMETIME protocol.

An IClient can be casted to an ISametimeClient if the specified protocol is SAMETIME.

// creates an ISametimeClient IClient client = IClientFactory.factory(gateway, IClient.SAMETIME, username, password); ISametimeClient sametimeClient = (ISametimeClient)client;

Field Summary

Fields inherited from interface com.zion.jbuddy.IClient

AIM, CONNECTION_CLOSED_REASON, DISCONNECT_REASON, FAILED_LOGIN_REASON, ICQ, JABBER, JSC, LCS, MSN, NETWORK_ERROR_REASON, PLAIN_TEXT, RICH_TEXT, SAMETIME, SERVICE_TEMPORARILY_UNAVAILABLE_REASON, UNKNOWN_REASON, USER_BOOTED_REASON, YIM

Method Summary

boolean	addPublicGroup(String name) Adds a Public Group to this client's Buddy List.
void	endConversation(String username) Ends a conversation with a user.
boolean	isPublicGroup(String groupName) Returns true if the specified Buddy Group is a Public Group.
IBuddy[]	resolveBuddies(String partialName) Resolves a partial name to matching users from Sametime's user directory.
String[]	resolveNickName(String partialName) Deprecated. As of 2.4, use resolveBuddies(String).

Methods inherited from interface com.zion.jbuddy.IClient

addBuddy, addBuddyToList, addDeny, addFileSessionInvitationListener, addGateway, addPermit, connect, connect, createFileSession, disconnect, getBuddyList, getConferenceService, getCustomAwayMessage, getDenyList, getIdleTimeStamp, getName, getNickName, getPassword, getPermitList, getPermitMode, getPlainTextMode, getProtocol, getProtocolName, getSignOnTimeStamp, getStatus, getStatusAsString, getStatusTimeStamp, isOnline, isSecure, numberOfMessagesReceived, numberOfMessagesSent, removeBuddy, removeBuddyFromList, removeDeny, removeFileSessionInvitationListener, removeGateway, removePermit, sendConfigToServer, sendIM, sendMessage, setKeepAliveInterval, setNickName, setPermitMode, setPlainTextMode, setSecure, setStatus

Method Detail

endConversation

void endConversation(String username)

Ends a conversation with a user.

A connection is automatically opened with a user when sending or receiving messages. This closes that connection. Use this when the connection is no longer needed (such as when closing a UI message window).

addPublicGroup

boolean addPublicGroup(String name)
                       throws IOException

Adds a Public Group to this client's Buddy List. Public Groups are visible to multiple Sametime accounts, and cannot be modified, as opposed to Private Groups.

If this call is successful, the Public Group (and its users) will be added to the Buddy List as a Buddy Group.

Parameters:

name - the Public Group's name

Returns:

true if the operation was successful, false otherwise (if the group could not be created, or already exists)

Throws:

IOException - if there is a problem communicating with the server

Since:

2.4

isPublicGroup

boolean isPublicGroup(String groupName)

Returns true if the specified Buddy Group is a Public Group. Public Groups are visible to multiple Sametime accounts, and cannot be modified, as opposed to Private Groups.

Returns:

true if the specified Buddy Group is a Public Group

Since:

2.4

resolveBuddies

IBuddy[] resolveBuddies(String partialName)
                        throws IOException

Resolves a partial name to matching users from Sametime's user directory.

Use this method to retrieve information about users (like their username or nickname).

Parameters:

partialName - part of a user's name (like their first or last name)

Returns:

the resolved buddies, or an empty array if there are no matches

Throws:

IOException - if there is a problem communicating with the directory service

Since:

2.4

resolveNickName

String[] resolveNickName(String partialName)
                         throws IOException

Deprecated. As of 2.4, use resolveBuddies(String).

Resolves a partial name to matching users from Sametime's user directory.

Parameters:

partialName - part of a user's name (like their first or last name)

Returns:

the resolved buddies' usernames, or an empty array if there are no matches

Throws:

IOException - if there is a problem communicating with the directory service