uk.co.thomasc.steamkit.steam3.handlers.steamfriends

Class SteamFriends

java.lang.Object

uk.co.thomasc.steamkit.steam3.handlers.ClientMsgHandler

uk.co.thomasc.steamkit.steam3.handlers.steamfriends.SteamFriends

public final class SteamFriends
extends ClientMsgHandler

This handler handles all interaction with other users on the Steam3 network.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) AccountCache	cache
private List<SteamID>	clanList
(package private) int	defaultInfoRequest
private List<SteamID>	friendList
private Object	listLock

Constructor Summary

Constructors

Constructor and Description
SteamFriends()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFriend(SteamID steamId) Sends a friend request to a user.
void	addFriend(String accountNameOrEmail) Sends a friend request to a user.
void	banChatMember(SteamID steamIdChat, SteamID steamIdMember) Bans the specified chat member from the given chat room.
byte[]	getClanAvatar(SteamID steamId) Gets a SHA-1 hash representing the clan's avatar.
SteamID	getClanByIndex(int index) Gets a clan SteamID by index.
int	getClanCount() Gets the count of clans the local user is a member of.
String	getClanName(SteamID steamId) Gets the name of a clan.
EClanRelationship	getClanRelationship(SteamID steamId) Gets the relationship of a clan.
byte[]	getFriendAvatar(SteamID steamId) Gets a SHA-1 hash representing the friend's avatar.
SteamID	getFriendByIndex(int index) Gets a friend by index.
int	getFriendCount() Gets the friend count of the local user.
GameID	getFriendGamePlayed(SteamID steamId) Gets the GameID of a friend playing a game.
String	getFriendGamePlayedName(SteamID steamId) Gets the game name of a friend playing a game.
String	getFriendPersonaName(SteamID steamId) Gets the persona name of a friend.
EPersonaState	getFriendPersonaState(SteamID steamId) Gets the persona state of a friend.
EFriendRelationship	getFriendRelationship(SteamID steamId) Gets the relationship of a friend.
String	getPersonaName() Gets the local user's persona name.
EPersonaState	getPersonaState() Gets the local user's persona state.
(package private) void	handleAccountInfo(IPacketMsg packetMsg)
(package private) void	handleChatActionResult(IPacketMsg packetMsg)
(package private) void	handleChatEnter(IPacketMsg packetMsg)
(package private) void	handleChatInvite(IPacketMsg packetMsg)
(package private) void	handleChatMemberInfo(IPacketMsg packetMsg)
(package private) void	handleChatMsg(IPacketMsg packetMsg)
(package private) void	handleFriendMsg(IPacketMsg packetMsg)
(package private) void	handleFriendResponse(IPacketMsg packetMsg)
(package private) void	handleFriendsList(IPacketMsg packetMsg)
(package private) void	handleIgnoreFriendResponse(IPacketMsg packetMsg)
void	handleMsg(IPacketMsg packetMsg) Handles a client message.
(package private) void	handlePersonaState(IPacketMsg packetMsg)
JobID	ignoreFriend(SteamID steamId)
JobID	ignoreFriend(SteamID steamId, boolean setIgnore) Ignores or unignores a friend on Steam.
void	joinChat(SteamID steamId) Attempts to join a chat room.
void	kickChatMember(SteamID steamIdChat, SteamID steamIdMember) Kicks the specified chat member from the given chat room.
void	leaveChat(SteamID steamId) Attempts to leave a chat room.
void	removeFriend(SteamID steamId) Removes a friend from your friends list.
void	requestFriendInfo(Collection<SteamID> steamIdList)
void	requestFriendInfo(Collection<SteamID> steamIdList, EClientPersonaStateFlag requestedInfo)
void	requestFriendInfo(Collection<SteamID> steamIdList, int requestedInfo) Requests persona state for a list of specified SteamID.
void	requestFriendInfo(SteamID steamId)
void	requestFriendInfo(SteamID steamId, EClientPersonaStateFlag requestedInfo)
void	requestFriendInfo(SteamID steamId, int requestedInfo) Requests persona state for a specified SteamID.
void	sendChatMessage(SteamID target, EChatEntryType type, String message) Sends a chat message to a friend.
void	sendChatRoomMessage(SteamID steamIdChat, EChatEntryType type, String message) Sends a message to a chat room.
void	setPersonaName(String name) Sets the local user's persona name and broadcasts it over the network.
void	setPersonaState(EPersonaState state) Sets the local user's persona state and broadcasts it over the network.

Methods inherited from class uk.co.thomasc.steamkit.steam3.handlers.ClientMsgHandler

setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listLock

private final Object listLock

friendList

private final List<SteamID> friendList

clanList

private final List<SteamID> clanList

cache

AccountCache cache

defaultInfoRequest

final int defaultInfoRequest

Constructor Detail

SteamFriends

public SteamFriends()

Method Detail

getPersonaName

public String getPersonaName()

Gets the local user's persona name.

Returns:

The name.

setPersonaName

public void setPersonaName(String name)

Sets the local user's persona name and broadcasts it over the network.

Parameters:

name - The name.

getPersonaState

public EPersonaState getPersonaState()

Gets the local user's persona state.

Returns:

The persona state.

setPersonaState

public void setPersonaState(EPersonaState state)

Sets the local user's persona state and broadcasts it over the network.

Parameters:

state - The state.

getFriendCount

public int getFriendCount()

Gets the friend count of the local user.

Returns:

The number of friends.

getFriendByIndex

public SteamID getFriendByIndex(int index)

Gets a friend by index.

Parameters:

index - The index.

Returns:

A valid steamid of a friend if the index is in range; otherwise a steamid representing 0.

getFriendPersonaName

public String getFriendPersonaName(SteamID steamId)

Gets the persona name of a friend.

Parameters:

steamId - The steam id.

Returns:

The name.

getFriendPersonaState

public EPersonaState getFriendPersonaState(SteamID steamId)

Gets the persona state of a friend.

Parameters:

steamId - The steam id.

Returns:

The persona state.

getFriendRelationship

public EFriendRelationship getFriendRelationship(SteamID steamId)

Gets the relationship of a friend.

Parameters:

steamId - The steam id.

Returns:

The relationship of the friend to the local user.

getFriendGamePlayedName

public String getFriendGamePlayedName(SteamID steamId)

Gets the game name of a friend playing a game.

Parameters:

steamId - The steam id.

Returns:

The game name of a friend playing a game, or null if they haven't been cached yet.

getFriendGamePlayed

public GameID getFriendGamePlayed(SteamID steamId)

Gets the GameID of a friend playing a game.

Parameters:

steamId - The steam id.

Returns:

The gameid of a friend playing a game, or 0 if they haven't been cached yet.

getFriendAvatar

public byte[] getFriendAvatar(SteamID steamId)

Gets a SHA-1 hash representing the friend's avatar.

Parameters:

steamId - The SteamID of the friend to get the avatar of.

Returns:

A byte array representing a SHA-1 hash of the friend's avatar.

getClanCount

public int getClanCount()

Gets the count of clans the local user is a member of.

Returns:

The number of clans this user is a member of.

getClanByIndex

public SteamID getClanByIndex(int index)

Gets a clan SteamID by index.

Parameters:

index - The index.

Returns:

A valid steamid of a clan if the index is in range; otherwise a steamid representing 0.

getClanName

public String getClanName(SteamID steamId)

Gets the name of a clan.

Parameters:

steamId - The clan SteamID.

Returns:

The name.

getClanRelationship

public EClanRelationship getClanRelationship(SteamID steamId)

Gets the relationship of a clan.

Parameters:

steamId - The clan steamid.

Returns:

The relationship of the clan to the local user.

getClanAvatar

public byte[] getClanAvatar(SteamID steamId)

Gets a SHA-1 hash representing the clan's avatar.

Parameters:

steamId - The SteamID of the clan to get the avatar of.

Returns:

A byte array representing a SHA-1 hash of the clan's avatar, or null if the clan could not be found.

sendChatMessage

public void sendChatMessage(SteamID target,
                   EChatEntryType type,
                   String message)

Sends a chat message to a friend.

Parameters:

target - The target to send to.

type - The type of message to send.

message - The message to send.

addFriend

public void addFriend(String accountNameOrEmail)

Sends a friend request to a user.

Parameters:

accountNameOrEmail - The account name or email of the user.

addFriend

public void addFriend(SteamID steamId)

Sends a friend request to a user.

Parameters:

steamId - The SteamID of the friend to add.

removeFriend

public void removeFriend(SteamID steamId)

Removes a friend from your friends list.

Parameters:

steamId - The SteamID of the friend to remove.

joinChat

public void joinChat(SteamID steamId)

Attempts to join a chat room.

Parameters:

steamId - The SteamID of the chat room.

leaveChat

public void leaveChat(SteamID steamId)

Attempts to leave a chat room.

Parameters:

steamId - The SteamID of the chat room.

sendChatRoomMessage

public void sendChatRoomMessage(SteamID steamIdChat,
                       EChatEntryType type,
                       String message)

Sends a message to a chat room.

Parameters:

steamIdChat - The SteamID of the chat room.

type - The message type.

message - The message.

kickChatMember

public void kickChatMember(SteamID steamIdChat,
                  SteamID steamIdMember)

Kicks the specified chat member from the given chat room.

Parameters:

steamIdChat - The SteamID of chat room to kick the member from.

steamIdMember - The SteamID of the member to kick from the chat.

banChatMember

public void banChatMember(SteamID steamIdChat,
                 SteamID steamIdMember)

Bans the specified chat member from the given chat room.

Parameters:

steamIdChat - The SteamID of chat room to ban the member from.

steamIdMember - The SteamID of the member to ban from the chat.

requestFriendInfo

public void requestFriendInfo(Collection<SteamID> steamIdList,
                     int requestedInfo)

Requests persona state for a list of specified SteamID. Results are returned in PersonaStateCallback.

Parameters:

steamIdList - A list of SteamIDs to request the info of.

requestedInfo - The requested info flags.

requestFriendInfo

public void requestFriendInfo(Collection<SteamID> steamIdList,
                     EClientPersonaStateFlag requestedInfo)

requestFriendInfo

public void requestFriendInfo(Collection<SteamID> steamIdList)

requestFriendInfo

public void requestFriendInfo(SteamID steamId,
                     int requestedInfo)

Requests persona state for a specified SteamID. Results are returned in PersonaStateCallback.

Parameters:

steamId - A SteamID to request the info of.

requestedInfo - The requested info flags.

requestFriendInfo

public void requestFriendInfo(SteamID steamId,
                     EClientPersonaStateFlag requestedInfo)

requestFriendInfo

public void requestFriendInfo(SteamID steamId)

ignoreFriend

public JobID ignoreFriend(SteamID steamId,
                 boolean setIgnore)

Ignores or unignores a friend on Steam. Results are returned in a IgnoreFriendCallback.

Parameters:

steamId - The SteamID of the friend to ignore or unignore.

setIgnore - if set to true, the friend will be ignored; otherwise, they will be unignored.

Returns:

The Job ID of the request. This can be used to find the appropriate JobCallback.

ignoreFriend

public JobID ignoreFriend(SteamID steamId)

handleMsg

public void handleMsg(IPacketMsg packetMsg)

Handles a client message. This should not be called directly.

Specified by:

handleMsg in class ClientMsgHandler

Parameters:

packetMsg - The packet message that contains the data.

handleAccountInfo

void handleAccountInfo(IPacketMsg packetMsg)

handleFriendMsg

void handleFriendMsg(IPacketMsg packetMsg)

handleFriendsList

void handleFriendsList(IPacketMsg packetMsg)

handlePersonaState

void handlePersonaState(IPacketMsg packetMsg)

handleFriendResponse

void handleFriendResponse(IPacketMsg packetMsg)

handleChatEnter

void handleChatEnter(IPacketMsg packetMsg)

handleChatMsg

void handleChatMsg(IPacketMsg packetMsg)

handleChatMemberInfo

void handleChatMemberInfo(IPacketMsg packetMsg)

handleChatActionResult

void handleChatActionResult(IPacketMsg packetMsg)

handleChatInvite

void handleChatInvite(IPacketMsg packetMsg)

handleIgnoreFriendResponse

void handleIgnoreFriendResponse(IPacketMsg packetMsg)