javasteam/in.dragonbra.javasteam.steam.handlers.steamfriends/SteamFriends

SteamFriends

class SteamFriends : ClientMsgHandler

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

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun addFriend(steamID: SteamID)
fun addFriend(accountNameOrEmail: String)

Sends a friend request to a user.

Link copied to clipboard
fun banChatMember(steamIdChat: SteamID, steamIdMember: SteamID)

Bans the specified chat member from the given chat room.

Link copied to clipboard
fun getCachedClans(): List<Clan>

Gets a list of all cached clans.

Link copied to clipboard
fun getCachedUsers(): List<User>

Gets a list of all caches users.

Link copied to clipboard
fun getClanAvatar(steamID: SteamID): ByteArray?

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

Link copied to clipboard
fun getClanByIndex(index: Int): SteamID

Gets a clan SteamID by index.

Link copied to clipboard
fun getClanCount(): Int

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

Link copied to clipboard
fun getClanName(steamID: SteamID): String?

Gets the name of a clan.

Link copied to clipboard
fun getClanRelationship(steamID: SteamID): EClanRelationship

Gets the relationship of a clan.

Link copied to clipboard
fun getClanSteamID(steamID: SteamID): SteamID

Gets the steam ID from the cached clans account.

Link copied to clipboard
fun getFriendAvatar(steamID: SteamID): ByteArray?

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

Link copied to clipboard
fun getFriendByIndex(index: Int): SteamID

Gets a friend by index.

Link copied to clipboard
fun getFriendCount(): Int

Gets the friend count of the local user.

Link copied to clipboard
fun getFriendGameAppId(steamID: SteamID): Int

Gets the game app id of a friend.

Link copied to clipboard
fun getFriendGamePlayed(steamID: SteamID): GameID

Gets the GameID of a friend playing a game.

Link copied to clipboard
fun getFriendGamePlayedName(steamID: SteamID): String?

Gets the game name of a friend playing a game.

Link copied to clipboard
fun getFriendPersonaName(steamID: SteamID): String?

Gets the persona name of a friend.

Link copied to clipboard
fun getFriendPersonaState(steamID: SteamID): EPersonaState

Gets the persona state of a friend.

Link copied to clipboard
fun getFriendPersonaStateFlags(steamID: SteamID): EnumSet<EPersonaStateFlag>?

Gets the PersonaState Flags of a friend.

Link copied to clipboard
fun getFriendRelationship(steamID: SteamID): EFriendRelationship?

Gets the relationship of a friend.

Link copied to clipboard
fun getFriendSteamID(steamID: SteamID): SteamID

Gets the steam ID from the cached account.

Link copied to clipboard
fun getPersonaAvatar(): ByteArray?

Gets the local user's persona avatar hash. Will be null before user initialization.

Link copied to clipboard
fun getPersonaName(): String?

Gets the local user's persona name. Will be null before user initialization. User initialization is performed prior to AccountInfoCallback callback.

Link copied to clipboard
fun getPersonaState(): EPersonaState

Gets the local user's persona state.

Link copied to clipboard
open override fun handleMsg(packetMsg: IPacketMsg)

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

Link copied to clipboard
@JvmOverloads
fun ignoreFriend(steamID: SteamID, setIgnore: Boolean = true): AsyncJobSingle<IgnoreFriendCallback>

Ignores or un-ignores a friend on Steam. Results are returned in a IgnoreFriendCallback.

Link copied to clipboard
fun inviteUserToChat(steamIdUser: SteamID, steamIdChat: SteamID)

Invites a user to a chat room. The results of this action will be available through the ChatActionResultCallback callback.

Link copied to clipboard
@JvmOverloads
fun isLocalUser(steamID: SteamID? = null): Boolean

Gets result if the given steam ID is the local user or not.

Link copied to clipboard
fun joinChat(steamID: SteamID)

Attempts to join a chat room.

Link copied to clipboard
fun kickChatMember(steamIdChat: SteamID, steamIdMember: SteamID)

Kicks the specified chat member from the given chat room.

Link copied to clipboard
fun leaveChat(steamID: SteamID)

Attempts to leave a chat room.

Link copied to clipboard
fun removeFriend(steamID: SteamID)

Removes a friend from your friends list.

Link copied to clipboard
fun requestAliasHistory(steamID: SteamID): JobID

Request the alias history of the account of the given steam id. The result is returned in a AliasHistoryCallback.

fun requestAliasHistory(steamIDs: List<SteamID>): JobID

Request the alias history of the accounts of the given steam ids. The result is returned in a AliasHistoryCallback.

Link copied to clipboard
@JvmOverloads
fun requestFriendInfo(steamID: SteamID, requestedInfo: Int = 0)

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

@JvmOverloads
fun requestFriendInfo(steamIdList: List<SteamID>, requestedInfo: Int = 0)

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

Link copied to clipboard
fun requestMessageHistory(steamID: SteamID)

Requests the last few chat messages with a friend. Results are returned in a FriendMsgHistoryCallback

Link copied to clipboard
fun requestOfflineMessages()

Requests all offline messages. This also marks them as read server side. Results are returned in a FriendMsgHistoryCallback.

Link copied to clipboard
fun requestProfileInfo(steamID: SteamID): AsyncJobSingle<ProfileInfoCallback>

Requests profile information for the given SteamID Results are returned in a ProfileInfoCallback

Link copied to clipboard
fun resetPersonaStateFlag()

JavaSteam addition: Sets the local user's persona state flag back to normal desktop mode.

Link copied to clipboard
fun sendChatMessage(target: SteamID, type: EChatEntryType, message: String)

Sends a chat message to a friend.

Link copied to clipboard
fun sendChatRoomMessage(steamIdChat: SteamID, type: EChatEntryType, message: String)

Sends a message to a chat room.

Link copied to clipboard
fun setFriendNickname(friendID: SteamID, nickname: String): JobID

Set the nickname of a friend. The result is returned in a NicknameCallback.

Link copied to clipboard
fun setPersonaName(name: String)

Sets the local user's persona name and broadcasts it over the network. Results are returned in a PersonaChangeCallback callback.

Link copied to clipboard
fun setPersonaState(state: EPersonaState)

Sets the local user's persona state and broadcasts it over the network. Results are returned in aPersonaChangeCallback callback.

Link copied to clipboard
fun setPersonaStateFlag(flag: EPersonaStateFlag)

JavaSteam addition: Sets the local user's persona state flag to a valid ClientType

Link copied to clipboard
fun setup(client: SteamClient)
Link copied to clipboard
fun unbanChatMember(steamIdChat: SteamID, steamIdMember: SteamID)

Unbans the specified chat member from the given chat room.