ISteamFriends - adambiser/agk-steam-plugin GitHub Wiki

ActivateGameOverlay

ActivateGameOverlay(dialogName as string)

dialogName - The dialog to open. Valid options are: "friends", "community", "players", "settings", "officialgamegroup", "stats", "achievements".

Activates the Steam Overlay to a specific dialog.

Reference:
ISteamFriends#ActivateGameOverlay

ActivateGameOverlayInviteDialog

ActivateGameOverlayInviteDialog(hLobbySteamID as integer)

hLobbySteamID - The Steam ID handle of the lobby that selected users will be invited to.

Activates the Steam Overlay to open the invite dialog. Invitations sent from this dialog will be for the provided lobby.

Reference:
ISteamFriends#ActivateGameOverlayInviteDialog

ActivateGameOverlayToStore

ActivateGameOverlayToStore(appID as integer, flag as integer)

appID - The app ID to show the store page of or 0 for the front page of the Steam store.

flag - Flags to modify the behavior when the page opens.

Activates the Steam Overlay to the Steam store page for the provided app.

Reference:
ISteamFriends#ActivateGameOverlayToStore

ActivateGameOverlayToUser

ActivateGameOverlayToUser(dialogName as string, hSteamID as integer)

dialogName - The dialog to open. Valid options are: "steamid", "chat", "jointrade", "stats", "achievements", "friendadd", "friendremove", "friendrequestaccept", "friendrequestignore".

hSteamID - The Steam ID handle of the context to open this dialog to.

Activates Steam Overlay to a specific dialog.

Reference:
ISteamFriends#ActivateGameOverlayToUser

ActivateGameOverlayToWebPage

ActivateGameOverlayToWebPage(url as string)

url - The webpage to open. (A fully qualified address with the protocol is required.)

Activates Steam Overlay web browser directly to the specified URL.

Reference:
ISteamFriends#ActivateGameOverlayToWebPage

ActivateGameOverlayToWebPageModal

ActivateGameOverlayToWebPageModal(url as string)

url - The webpage to open. (A fully qualified address with the protocol is required.)

Activates Steam Overlay web browser directly to the specified URL. The browser will be opened in a special overlay configuration which hides all other windows that the user has open in the overlay.

Reference:
ISteamFriends#ActivateGameOverlayToWebPage

ClearRichPresence

ClearRichPresence()

Clears all of the current user's Rich Presence key/values.

Reference:
ISteamFriends#ClearRichPresence

CloseClanChatWindowInSteam

CloseClanChatWindowInSteam(hSteamIDClanChat as integer) as integer

hSteamIDClanChat - The Steam ID handlle of the Steam group chat room to close.

Closes the specified Steam group chat room in the Steam UI.

Returns: 1 if the user successfully left the Steam group chat room; 0 if the user is not in the provided Steam group chat room.

Reference:
ISteamFriends#CloseClanChatWindowInSteam

AddDownloadClanActivityClan

AddDownloadClanActivityClan(hSteamIDClan as integer)

hSteamIDClan - The clan's Steam ID handle.

Adds a clan to be refreshed in the next DownloadClanActivityCounts call.

Reference:
ISteamFriends#DownloadClanActivityCounts

DownloadClanActivityCounts

DownloadClanActivityCounts() as integer

Refresh the Steam Group activity data or get the data from groups other than one that the current user is a member.

Add clans to refresh using AddDownloadClanActivityClan.

Use GetCallResultCode to determine when this call succeeds and whether it was successful.

Returns: A call result handle on success; otherwise 0.

Reference:
ISteamFriends#DownloadClanActivityCounts
ISteamFriends#DownloadClanActivityCountsResult_t

EnumerateFollowingList

EnumerateFollowingList(startIndex as integer) as integer

startIndex - The index to start receiving followers from. This should be 0 on the initial call.

Gets the list of users that the current user is following.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetEnumerateFollowingListResultsReturned
GetEnumerateFollowingListTotalResultCount
GetEnumerateFollowingListSteamID

Reference:
ISteamFriends#DownloadClanActivityCounts
ISteamFriends#DownloadClanActivityCountsResult_t

GetEnumerateFollowingListResultsReturned

GetEnumerateFollowingListResultsReturned(hCallResult as integer) as integer

hCallResult - An EnumerateFollowingList call result handle.

Gets the number of results returned by the EnumerateFollowingList call result.

This method should only be used when the call result returned by EnumerateFollowingList has reported a GetCallResultCode of 1.

Returns: The number of results returned.

Reference:
ISteamFriends#DownloadClanActivityCounts
ISteamFriends#DownloadClanActivityCountsResult_t

GetEnumerateFollowingListTotalResultCount

GetEnumerateFollowingListTotalResultCount(hCallResult as integer) as integer

hCallResult - An EnumerateFollowingList call result handle.

Gets the total number of people the user is following for the EnumerateFollowingList call result.

If this value is greater than the start index for the call + GetEnumerateFollowingListResultsReturned, call EnumerateFollowingList with start index + GetEnumerateFollowingListResultsReturned as the new start index.

This method should only be used when the call result returned by EnumerateFollowingList has reported a GetCallResultCode of 1.

Returns: The total number of people we are following.

Reference:
ISteamFriends#DownloadClanActivityCounts
ISteamFriends#DownloadClanActivityCountsResult_t

GetEnumerateFollowingListSteamID

GetEnumerateFollowingListSteamID(hCallResult as integer, index as integer) as integer

hCallResult - An EnumerateFollowingList call result handle.

index - The index of the followed user to retrieve.

Gets a user from the EnumerateFollowingList call result.

This method should only be used when the call result returned by EnumerateFollowingList has reported a GetCallResultCode of 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#DownloadClanActivityCounts
ISteamFriends#DownloadClanActivityCountsResult_t

GetChatMemberByIndex

GetChatMemberByIndex(hSteamIDClan as integer, index as integer) as integer

hSteamIDClan - This MUST be the same source used in the previous call to GetClanChatMemberCount!

index - The index.

Gets the Steam ID at the given index in a Steam group chat.

NOTE: You must call GetClanChatMemberCount before calling this.

Returns: A Steam ID handle. Invalid indices return 0.

Reference:
ISteamFriends#GetChatMemberByIndex

GetClanActivityCountsOnline

GetClanActivityCountsOnline(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the count for.

Returns the number of members that are online in a Steam group.

Returns: The number of members or -1 if there's a problem.

Reference:
ISteamFriends#GetClanActivityCounts

GetClanActivityCountsInGame

GetClanActivityCountsInGame(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the count for.

Returns the number of members that are in game in a Steam group.

Returns: The number of members or -1 if there's a problem.

Reference:
ISteamFriends#GetClanActivityCounts

GetClanActivityCountsChatting

GetClanActivityCountsChatting(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the count for.

Returns the number of members that are chatting in a Steam group.

Returns: The number of members or -1 if there's a problem.

Reference:
ISteamFriends#GetClanActivityCounts

GetClanByIndex

GetClanByIndex(index as integer) as integer

index - The index.

Gets the Steam group's Steam ID at the given index.

NOTE: You must call GetClanCount before calling this.

Returns: A Steam ID handle. Invalid indices return 0.

Reference:
ISteamFriends#GetClanByIndex

GetClanChatMemberCount

GetClanChatMemberCount(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the user count of.

Gets the number of users in a Steam group chat.

NOTE: Large steam groups cannot be iterated by the local user.

Returns: An integer.

Reference:
ISteamFriends#GetClanChatMemberCount

GetClanChatMemberListJSON

GetClanChatMemberListJSON(hSteamIDClan as integer) as string

hSteamIDClan - The Steam ID handle of the group to get the users of.

Gets the users in a Steam group chat.

NOTE: Large steam groups cannot be iterated by the local user.

Returns: A JSON array of Steam ID handles.

Reference:
ISteamFriends#GetChatMemberByIndex
ISteamFriends#GetClanChatMemberCount

GetClanCount

GetClanCount() as integer

Gets the number of Steam groups that the current user is a member of.

Returns: An integer.

Reference:
ISteamFriends#GetClanCount

GetClanListJSON

GetClanListJSON() as string

Gets A JSON array of Steam ID group handles that the current user is a member of.

Returns: A JSON array of Steam ID handles.

Reference:
ISteamFriends#GetClanCount
ISteamFriends#GetClanByIndex

GetClanName

GetClanName(hSteamIDClan as integer) as string

hSteamIDClan - The Steam ID handle of the group to get the name for.

Gets the display name for the specified Steam group; if the local client knows about it.

Returns: The display name for the group or an empty string.

Reference:
ISteamFriends#GetClanName

GetClanOfficerByIndex

GetClanOfficerByIndex(hSteamIDClan as integer, index as integer) as integer

hSteamIDClan - This must be the same steam group used in the previous call to GetClanOfficerCount!

index - The index.

Gets the Steam ID handle of the officer at the given index in a Steam group.

NOTE: You must call GetClanOfficerCount before calling this.

Returns: A Steam ID handle. 0 if the call is invalid.

Reference:
ISteamFriends#GetClanOfficerByIndex
ISteamFriends#GetClanOfficerCount

GetClanOfficerCount

GetClanOfficerCount(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the officer count for.

Gets the number of officers (administrators and moderators) in a specified Steam group.

NOTE: You must call RequestClanOfficerList before this to get the required data!

Returns: An integer.

Reference:
ISteamFriends#GetClanOfficerCount
ISteamFriends#RequestClanOfficerList

GetClanOfficerListJSON

GetClanOfficerListJSON(hSteamIDClan as integer) as string

hSteamIDClan - The Steam ID handle of the group to get the officers for.

Gets the Steam ID handles of the officers (administrators and moderators) in a specified Steam group.

NOTE: You must call RequestClanOfficerList before this to get the required data!

Returns: A JSON array of Steam ID handles.

Reference:
ISteamFriends#GetClanOfficerCount
ISteamFriends#GetClanOfficerByIndex
ISteamFriends#RequestClanOfficerList

GetClanOwner

GetClanOwner(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID handle of the group to get the owner for.

Gets the owner of a Steam Group.

NOTE: You must call RequestClanOfficerList before this to get the required data!

Returns: A Steam ID handle.

Reference:
ISteamFriends#GetClanOwner
ISteamFriends#RequestClanOfficerList

GetClanTag

GetClanTag(hSteamIDClan as integer) as string

hSteamIDClan - The Steam ID handle of the group to get the tag for.

Gets the unique tag (abbreviation) for the specified Steam group; If the local client knows about it.

Returns: The tag or an empty string if the user doesn't know about the group.

Reference:
ISteamFriends#GetClanTag

GetCoplayFriend

GetCoplayFriend(index as integer) as integer

index - The index.

Gets the Steam ID of the recently played with user at the given index.

Returns: A Steam ID Handle. Invalid indices return 0.

Reference:
ISteamFriends#GetCoplayFriend

GetCoplayFriendCount

GetCoplayFriendCount() as integer

Gets the number of players that the current users has recently played with, across all games.

Returns: The number of users that the current user has recently played with.

Reference:
ISteamFriends#GetCoplayFriendCount

GetCoplayFriendListJSON

GetCoplayFriendListJSON() as string

Returns a JSON array of Steam ID handles of the players that the current users has recently played with, across all games.

Returns: A JSON array of Steam ID handles.

Reference:
ISteamFriends#GetCoplayFriendCount

GetFollowerCount

GetFollowerCount(hSteamID as integer) as integer

hSteamID - The user's Steam ID handle.

Gets the number of users following the specified user. Use GetFollowerCountValue to get the value once the call result completes.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetFollowerCountValue
GetFollowerCountSteamID

Reference:
ISteamFriends#GetFollowerCount
ISteamFriends#FriendsGetFollowerCount_t

GetFollowerCountValue

GetFollowerCountValue(hCallResult as integer) as integer

hCallResult - A GetFollowerCount call result handle.

Gets the number of users following the user for the GetFollowerCount call result.

This method should only be used when the call result returned by GetFollowerCount has reported a GetCallResultCode of 1.

Returns: An integer.

Reference:
ISteamFriends#GetFollowerCount
ISteamFriends#FriendsGetFollowerCount_t

GetFollowerCountSteamID

GetFollowerCountSteamID(hCallResult as integer) as integer

hCallResult - A GetFollowerCount call result handle.

Gets the user's Steam ID handle for the GetFollowerCount call result.

This method should only be used when the call result returned by GetFollowerCount has reported a GetCallResultCode of 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GetFollowerCount
ISteamFriends#FriendsGetFollowerCount_t

GetFriendByIndex

GetFriendByIndex(index as integer, friendFlags as integer) as integer

index - The index.

friendFlags - A combined union (binary "or") of EFriendFlags. This must be the same value as used in the previous call to GetFriendCount.

Gets the Steam ID of the user at the given index.

NOTE: You must call GetFriendCount before calling this.

Returns: A Steam ID handle. Invalid indices return 0.

Reference:
ISteamFriends#GetFriendByIndex

GetFriendCoplayGame

GetFriendCoplayGame(hSteamID as integer) as integer

hSteamID - The Steam ID handle of the user on the recently-played-with list to get the game played.

Gets the app ID of the game that user played with someone on their recently-played-with list.

Returns: A game App ID. 0 if not on the recently-played-with-list.

Reference:
ISteamFriends#GetFriendCoplayGame

GetFriendCoplayTime

GetFriendCoplayTime(hSteamID as integer) as integer

hSteamID - The Steam ID handle of the user on the recently-played-with list to get the timestamp for.

Gets the timestamp of when the user played with someone on their recently-played-with list.

Returns: The time in Unix epoch format. 0 if not on the recently-played-with-list.

Reference:
ISteamFriends#GetFriendCoplayTime

GetFriendCount

GetFriendCount(friendFlags as integer) as integer

friendFlags - A combined union (binary "or") of one or more EFriendFlags.

Gets the number of users the client knows about who meet a specified criteria.

Returns: The number of friends matching the given criteria.

Reference:
ISteamFriends#GetFriendCount

GetFriendListJSON

GetFriendListJSON(friendFlags as integer) as string

friendFlags - A combined union (binary "or") of EFriendFlags.

Returns an integer array as JSON that combines the GetFriendCount and GetFriendByIndex calls.

Returns: An integer array of Steam ID handles as a JSON string.

Reference:
ISteamFriends#GetFriendCount
ISteamFriends#GetFriendByIndex

GetFriendCountFromSource

GetFriendCountFromSource(hSteamIDSource as integer) as integer

hSteamIDSource - The Steam group, chat room, lobby or game server to get the user count of.

Get the number of users in a source (Steam group, chat room, lobby, or game server).

NOTE: Large Steam groups cannot be iterated by the local user.

Returns: An integer.

Reference:
ISteamFriends#GetFriendCountFromSource

GetFriendFromSourceByIndex

GetFriendFromSourceByIndex(hSteamIDSource as integer, index as integer) as integer

hSteamIDSource - The Steam group, chat room, lobby or game server to get the user count of.

index - The index.

Gets the Steam ID handle at the given index from a source (Steam group, chat room, lobby, or game server).

NOTE: You must call GetFriendCountFromSource before calling this.

Returns: A Steam ID handle. Invalid indices return 0.

Reference:
ISteamFriends#GetFriendFromSourceByIndex

GetFriendFromSourceListJSON

GetFriendFromSourceListJSON(hSteamIDSource as integer) as string

hSteamIDSource - The Steam group, chat room, lobby or game server to get the user count of.

Get a JSON array of Steam ID handles of the users in a source (Steam group, chat room, lobby, or game server).

NOTE: Large Steam groups cannot be iterated by the local user.

Returns: A JSON array of Steam ID handles.

Reference:
ISteamFriends#GetFriendCountFromSource
ISteamFriends#GetFriendFromSourceByIndex

GetFriendGamePlayedGameAppID

GetFriendGamePlayedGameAppID(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Returns the game App ID that the friend is playing.

Returns: The game App ID if the friend is playing a game; otherwise 0.

Reference:
ISteamFriends#GetFriendGamePlayed
ISteamFriends#FriendGameInfo_t

GetFriendGamePlayedIP

GetFriendGamePlayedIP(hSteamIDUser as integer) as string

hSteamIDUser - A user Steam ID handle.

Returns the IP of the server the friend is playing on.

Returns: The IP address if the friend is playing a game; otherwise an empty string.

Reference:
ISteamFriends#GetFriendGamePlayed
ISteamFriends#FriendGameInfo_t

GetFriendGamePlayedConnectionPort

GetFriendGamePlayedConnectionPort(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Returns the game port of the server the friend is playing on.

Returns: The game port if the friend is playing a game; otherwise 0.

Reference:
ISteamFriends#GetFriendGamePlayed
ISteamFriends#FriendGameInfo_t

GetFriendGamePlayedQueryPort

GetFriendGamePlayedQueryPort(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Returns the query port of the server the friend is playing on.

Returns: The query port if the friend is playing a game; otherwise 0.

Reference:
ISteamFriends#GetFriendGamePlayed
ISteamFriends#FriendGameInfo_t

GetFriendGamePlayedLobby

GetFriendGamePlayedLobby(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Returns the Steam ID handle of lobby the friend is in.

Returns: A Steam ID lobby handle if the friend is in a lobby; otherwise 0.

Reference:
ISteamFriends#GetFriendGamePlayed
ISteamFriends#FriendGameInfo_t

GetFriendPersonaName

GetFriendPersonaName(hSteamIDUser as integer) as string

hSteamIDUser - A user Steam ID handle.

Gets the specified user's persona (display) name.

Returns: the user's name.

Reference:
ISteamFriends#GetFriendPersonaName

GetFriendPersonaNameHistory

GetFriendPersonaNameHistory(hSteamIDFriend as integer, index as integer) as string

hSteamIDFriend - The Steam ID handle of the other user.

index - The index of the history to receive. 0 is their current persona name, 1 is their most recent before they changed it, etc.

Gets one of the previous display names for the specified user.

This only works for display names that the current user has seen on the local computer.

Returns: The players old persona name at the given index. Returns an empty string when there are no further items in the history.

Reference:
ISteamFriends#GetFriendPersonaNameHistory

GetFriendPersonaNameHistoryJSON

GetFriendPersonaNameHistoryJSON(hSteamIDFriend as integer) as string

hSteamIDFriend - The Steam ID handle of the other user.

Gets a JSON array of the previous display names for the specified user.

This only works for display names that the current user has seen on the local computer.

Returns: A JSON array of strings.

Reference:
ISteamFriends#GetFriendPersonaNameHistory

GetFriendPersonaState

GetFriendPersonaState(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets the current status of the specified user.

Returns: An EPersonaState value.

Reference:
ISteamFriends#GetFriendPersonaState

GetFriendRelationship

GetFriendRelationship(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets a relationship to a specified user.

Returns: An EFriendRelationship value.

Reference:
ISteamFriends#GetFriendRelationship

GetFriendRichPresence

GetFriendRichPresence(hSteamIDFriend as integer, key as string) as string

hSteamIDFriend - The friend to get the Rich Presence value for.

key - The Rich Presence key to request.

Get a Rich Presence value from a specified friend.

Returns: The value. An empty string if the specified key is not set.

Reference:
ISteamFriends#GetFriendRichPresence

GetFriendRichPresenceKeyByIndex

GetFriendRichPresenceKeyByIndex(hSteamIDFriend as integer, index as integer) as string

hSteamIDFriend - This should be the same user provided to the previous call to GetFriendRichPresenceKeyCount!

index - The index

Gets the Rich Presence key at the given index from a specified friend.

NOTE: GetFriendRichPresenceKeyCount must ba called before this can be used.

This is typically only ever used for debugging purposes.

Returns: A key name. An empty string if the index is invalid.

Reference:
ISteamFriends#GetFriendRichPresenceKeyByIndex

GetFriendRichPresenceKeyCount

GetFriendRichPresenceKeyCount(hSteamIDFriend as integer) as integer

hSteamIDFriend - The Steam ID of the user to get the Rich Presence Key Count of.

Gets the number of Rich Presence keys that are set on the specified user.

This is typically only ever used for debugging purposes.

Returns: An integer.

Reference:
ISteamFriends#GetFriendRichPresenceKeyCount

GetFriendRichPresenceKeyListJSON

GetFriendRichPresenceKeyListJSON(hSteamIDFriend as integer) as string

hSteamIDFriend - The Steam ID of the user to get the Rich Presence Keys for.

Gets a JSON array of the Rich Presence keys that are set on the specified user.

This is typically only ever used for debugging purposes.

Returns: A JSON array of strings.

Reference:
ISteamFriends#GetFriendRichPresenceKeyCount
ISteamFriends#GetFriendRichPresenceKeyByIndex

GetFriendsGroupCount

GetFriendsGroupCount() as integer

Gets the number of friends groups (tags) the user has created.

Returns: The number of friends groups for the current user.

Reference:
ISteamFriends#GetFriendsGroupCount

GetFriendsGroupIDByIndex

GetFriendsGroupIDByIndex(index as integer) as integer

index - An index between 0 and GetFriendsGroupCount.

Gets the friends group ID for the given index.

Returns: The friends group Steam ID handle.

Reference:
ISteamFriends#GetFriendsGroupIDByIndex

GetFriendsGroupMembersCount

GetFriendsGroupMembersCount(hFriendsGroupID as integer) as integer

hFriendsGroupID - The friends group ID handle to get the number of friends in.

Gets the number of friends in a given friends group.

Returns: The number of friends in a friends group.

Reference:
ISteamFriends#GetFriendsGroupMembersCount

GetFriendsGroupMembersListJSON

GetFriendsGroupMembersListJSON(hFriendsGroupID as integer) as string

hFriendsGroupID - The friends group ID handle to get the members list of.

Gets a JSON integer array of SteamID handles of the list of members in a group.

Returns: An integer array of Steam ID handles as a JSON string.

Reference:
ISteamFriends#GetFriendsGroupMembersCount
ISteamFriends#GetFriendsGroupMembersList

GetFriendsGroupName

GetFriendsGroupName(hFriendsGroupID as integer) as string

hFriendsGroupID - The friends group ID handle to get the name of.

Gets the name for the given friends group.

Returns: The name of the friends group.

Reference:
ISteamFriends#GetFriendsGroupName

GetFriendSteamLevel

GetFriendSteamLevel(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets the Steam level of the specified user.

This will return 0 unless the level has been cached by the API. Despite how it appears that it should behave, the Steam API does not seem to fire the PersonaStateChange_t callback when Steam levels cache.

Returns: the user's Steam level or 0 if not loaded.

Reference:
ISteamFriends#GetFriendSteamLevel

GetFriendAvatar

GetFriendAvatar(hSteamIDUser as integer, size as integer) as integer

hSteamIDUser - A user Steam ID handle.

size - The size of the avatar to load.

Gets the avatar image handle for the given steam id and avatar size. Avatars come in three sizes. The Steam API has a command for each size, but this plugin combines them into a single command for simplicity.

If the avatar has not been cached, the returned image handle will be -1. HasAvatarImageLoaded will report when a user's avatar has loaded and GetFriendAvatar can be called again to retrieve it.

According to the Steamworks documentation:

This only works for users that the local user knows about. They will automatically know about their friends, people on leaderboards they've requested, or people in the same source as them (Steam group, chat room, lobby, or game server). If they don't know about them then you must call RequestUserInformation to cache the avatar locally.

Values for the size parameter:

#constant AVATAR_SMALL	0 // 32x32
#constant AVATAR_MEDIUM	1 // 64x64
#constant AVATAR_LARGE	2 // 128x128

Returns: 0 when no avatar is set, -1 when the image needs to be loaded, and a positive number is an image handle. Use LoadImageFromHandle to load the image from the handle.

Reference:
ISteamFriends#GetSmallFriendAvatar
ISteamFriends#GetMediumFriendAvatar
ISteamFriends#GetLargeFriendAvatar

GetLargeFriendAvatar

GetLargeFriendAvatar(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets a handle to the large (128*128px) avatar for the specified user.

Returns: 0 when no avatar is set, -1 when the image needs to be loaded, and a positive number is an image handle. Use LoadImageFromHandle to load the image from the handle.

Reference:
ISteamFriends#GetLargeFriendAvatar

GetMediumFriendAvatar

GetMediumFriendAvatar(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets a handle to the medium (64*64px) avatar for the specified user.

Returns: 0 when no avatar is set, -1 when the image needs to be loaded, and a positive number is an image handle. Use LoadImageFromHandle to load the image from the handle.

Reference:
ISteamFriends#GetMediumFriendAvatar

GetPersonaName

GetPersonaName() as string

Gets the current users persona (display) name.

Returns: the name

Reference:
ISteamFriends#GetPersonaName

GetPersonaState

GetPersonaState() as integer

Gets the friend status of the current user.

To get the state of other users use GetFriendPersonaState.

Returns: The status of the current user.

Reference:
ISteamFriends#GetPersonaState

GetPlayerNickname

GetPlayerNickname(hSteamIDUser as integer) as string

hSteamIDUser - A user Steam ID handle.

Gets the nickname that the current user has set for the specified user.

Returns: The player's nickname.

Reference:
ISteamFriends#GetPlayerNickname

GetSmallFriendAvatar

GetSmallFriendAvatar(hSteamIDUser as integer) as integer

hSteamIDUser - A user Steam ID handle.

Gets a handle to the small (32*32px) avatar for the specified user.

Returns: 0 when no avatar is set, -1 when the image needs to be loaded, and a positive number is an image handle. Use LoadImageFromHandle to load the image from the handle.

Reference:
ISteamFriends#GetMediumFriendAvatar

GetUserRestrictions

GetUserRestrictions() as integer

Checks if current user is chat restricted.

Returns: Restriction flags.

Reference:
ISteamFriends#GetUserRestrictions

HasFriend

HasFriend(hSteamIDUser as integer, friendFlags as integer) as integer

hSteamIDUser - A user Steam ID handle.

friendFlags - A combined union (binary "or") of one or more EFriendFlags.

Checks if the user meets the specified criteria.

Returns: 1 when true, 0 when false.

Reference:
ISteamFriends#HasFriend

InviteUserToGame

InviteUserToGame(hSteamIDFriend as integer, connectString as string) as integer

hSteamIDFriend - The Steam ID of the friend to invite.

connectString - A string that lets the friend know how to join the game (I.E. the game server IP). This can not be longer than specified in k_cchMaxRichPresenceValueLength.

Invites a friend or clan member to the current game using a special invite string.

Returns: 1 if the invite was successfully sent; otherwise 0.

Reference:
ISteamFriends#InviteUserToGame

IsClanChatAdmin

IsClanChatAdmin(hSteamIDClanChat as integer, hSteamIDUser as integer) as integer

hSteamIDClanChat - The Steam ID of the Steam group chat room.

hSteamIDUser - The Steam ID of the user to check the admin status of.

Checks if a user in the Steam group chat room is an admin.

Returns: 1 if the specified user is an admin; otherwise 0.

Reference:
ISteamFriends#IsClanChatAdmin

IsClanPublic

IsClanPublic(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID of the Steam group chat room.

Checks if the Steam group is public.

Returns: 1 if the specified group is public; otherwise 0.

Reference:
ISteamFriends#IsClanPublic

IsClanOfficialGameGroup

IsClanOfficialGameGroup(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID of the Steam group.

Checks if the Steam group is an official game group/community hub.

Returns: 1 if the specified group is an official game group/community hub; otherwise 0.

Reference:
ISteamFriends#IsClanOfficialGameGroup

IsClanChatWindowOpenInSteam

IsClanChatWindowOpenInSteam(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID of the Steam group chat room to check.

Checks if the Steam Group chat room is open in the Steam UI.

Returns: 1 if the specified Steam group chat room is opened; otherwise 0.

Reference:
ISteamFriends#IsClanChatWindowOpenInSteam

IsFollowing

IsFollowing(hSteamID as integer) as integer

hSteamID - The Steam ID of the check if we are following.

Checks if the current user is following the specified user.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetIsFollowingSteamID
GetIsFollowingResult

Reference:
ISteamFriends#IsFollowing
ISteamFriends#FriendsIsFollowing_t

GetIsFollowingSteamID

GetIsFollowingSteamID(hCallResult as integer) as integer

hCallResult - An IsFollowing call result handle.

Gets the Steam ID that was checked for the IsFollowing call result.

This method should only be used when the call result returned by IsFollowing has reported a GetCallResultCode of 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#IsFollowing
ISteamFriends#FriendsIsFollowing_t

GetIsFollowingResult

GetIsFollowingResult(hCallResult as integer) as integer

hCallResult - An IsFollowing call result handle.

Gets the 'is following' result for the IsFollowing call result.

This method should only be used when the call result returned by IsFollowing has reported a GetCallResultCode of 1.

Returns: 1 if following; otherwise 0.

Reference:
ISteamFriends#IsFollowing
ISteamFriends#FriendsIsFollowing_t

IsUserInSource

IsUserInSource(hSteamIDUser as integer, hSteamIDSource as integer) as integer

hSteamIDUser - The user to check if they are in the source.

hSteamIDSource - The source to check for the user.

Checks if a specified user is in a source (Steam group, chat room, lobby, or game serve

Returns: 1 if the local user can see that steamIDUser is a member or in steamIDSource; otherwise, 0.

Reference:
ISteamFriends#IsUserInSource

JoinClanChatRoom

JoinClanChatRoom(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID of the Steam group to join.

Allows the user to join Steam group (clan) chats right within the game.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetJoinClanChatRoomEnterResponse
GetJoinClanChatRoomSteamID

Reference:
ISteamFriends#JoinClanChatRoom
ISteamFriends#JoinClanChatRoomCompletionResult_t

GetJoinClanChatRoomEnterResponse

GetJoinClanChatRoomEnterResponse(hCallResult as integer) as integer

hCallResult - A JoinClanChatRoom call result handle.

Returns the result of the JoinClanChatRoom call result. Provides more detail that GetCallResultCode.

This method should only be used when the call result returned by JoinClanChatRoom has reported a GetCallResultCode of 1.

Returns: An EChatRoomEnterResponse value.

Reference:
ISteamFriends#JoinClanChatRoom
ISteamFriends#JoinClanChatRoomCompletionResult_t

GetJoinClanChatRoomSteamID

GetJoinClanChatRoomSteamID(hCallResult as integer) as integer

hCallResult - A JoinClanChatRoom call result handle.

The Steam ID of the chat that the user has joined for the given JoinClanChatRoom

This method should only be used when the call result returned by JoinClanChatRoom has reported a GetCallResultCode of 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#JoinClanChatRoom
ISteamFriends#JoinClanChatRoomCompletionResult_t

LeaveClanChatRoom

LeaveClanChatRoom(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam ID of the Steam group chat to leave.

Leaves a Steam group chat that the user has previously entered with JoinClanChatRoom.

Triggers a GameConnectedChatLeave_t callback for the other members in the group chat.

Returns: 1 if user is in the specified chat room, otherwise 0.

Reference:
ISteamFriends#LeaveClanChatRoom

OpenClanChatWindowInSteam

OpenClanChatWindowInSteam(hSteamIDClanChat as integer) as integer

hSteamIDClanChat - The Steam ID of the Steam group chat room to open.

Opens the specified Steam group chat room in the Steam UI.

Returns: 1 if the user successfully entered the Steam group chat room; otherwise, 0.

Reference:
ISteamFriends#OpenClanChatWindowInSteam

ReplyToFriendMessage

ReplyToFriendMessage(hSteamIDFriend as integer, message as string) as integer

hSteamIDFriend - The Steam ID of the friend to send the message to.

message - The UTF-8 formatted message to send.

Sends a message to a Steam friend.

Returns: 1 if the message was successfully sent. 0 if the current user is rate limited or chat restricted.

Reference:
ISteamFriends#ReplyToFriendMessage

RequestClanOfficerList

RequestClanOfficerList(hSteamIDClan as integer) as integer

hSteamIDClan - The Steam group to get the officers list for.

Requests information about a Steam group officers (administrators and moderators).

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetRequestClanOfficerListOfficerCount
GetRequestClanOfficerListClan

Reference:
ISteamFriends#RequestClanOfficerList
ISteamFriends#ClanOfficerListResponse_t

GetRequestClanOfficerListOfficerCount

GetRequestClanOfficerListOfficerCount(hCallResult as integer) as integer

hCallResult - An RequestClanOfficerList call result handle.

Gets the number of officers in the group from the call result response. This is the same as GetClanOfficerCount.

This method should only be used when the call result returned by RequestClanOfficerList has reported a GetCallResultCode of 1.

Returns: An integer.

Reference:
ISteamFriends#RequestClanOfficerList
ISteamFriends#ClanOfficerListResponse_t

GetRequestClanOfficerListClan

GetRequestClanOfficerListClan(hCallResult as integer) as integer

hCallResult - An RequestClanOfficerList call result handle.

Gets the Steam group that the call result just got the officer list for.

This method should only be used when the call result returned by RequestClanOfficerList has reported a GetCallResultCode of 1.

Returns: A Steam ID handle. 0 if there was a problem.

Reference:
ISteamFriends#RequestClanOfficerList
ISteamFriends#ClanOfficerListResponse_t

RequestFriendRichPresence

RequestFriendRichPresence(hSteamIDFriend as integer)

hSteamIDFriend - The Steam ID of the user to request the rich presence of.

Requests Rich Presence data from a specific user.

Triggers a FriendRichPresenceUpdate_t callback.

Reference:
ISteamFriends#RequestFriendRichPresence

RequestUserInformation

RequestUserInformation(hSteamIDUser as integer, requireNameOnly as integer) as integer

hSteamIDUser - A user Steam ID handle.

requireNameOnly - When 0 the avatar for the user is also loaded; otherwise only the name is loaded.

Requests the persona name and optionally the avatar of a specified user (when requireNameOnly is 0).

Returns: 1 when the user data needs to be loaded and will be reported by the PersonaStateChange_t callback. 0 when the user data is already loaded.

Reference:
ISteamFriends#RequestUserInformation

SendClanChatMessage

SendClanChatMessage(hSteamIDClanChat as integer, text as string) as integer

hSteamIDClanChat - The Steam ID of the group chat to send the message to.

text - The UTF-8 formatted message to send. This can be up to 2048 characters long.

Sends a message to a Steam group chat room.

Returns: 1 if the message was successfully sent; otherwise 0.

Reference:
ISteamFriends#SendClanChatMessage

SetInGameVoiceSpeaking

SetInGameVoiceSpeaking(speaking as integer)

speaking - Did the user start speaking in game (1) or stopped speaking in game (0)?

Let Steam know that the user is currently using voice chat in game.

This will suppress the microphone for all voice communication in the Steam UI.

Reference:
ISteamFriends#SetInGameVoiceSpeaking

SetListenForFriendsMessages

SetListenForFriendsMessages(interceptEnabled as integer)

interceptEnabled - Turn friends message interception on (1) or off (0)?

Listens for Steam friends chat messages.

Reference:
ISteamFriends#SetListenForFriendsMessages

SetPersonaName

SetPersonaName(personaName as string) as integer

personaName - The users new persona name. Can not be longer than k_cchPersonaNameMax bytes.

Sets the current users persona name, stores it on the server and publishes the changes to all friends who are online.

Returns: A call result handle on success; otherwise 0.

Associated Methods:
GetSetPersonaNameSuccess
GetSetPersonaNameLocalSuccess

Reference:
ISteamFriends#SetPersonaName
ISteamFriends#SetPersonaNameResponse_t

GetSetPersonaNameSuccess

GetSetPersonaNameSuccess(hCallResult as integer) as integer

hCallResult - A SetPersonaName call result handle.

Returns whether the name change completed successfully.

This method should only be used when the call result returned by SetPersonaName has reported a GetCallResultCode of 1.

Returns: 1 if name change completed successfully.

Reference:
ISteamFriends#SetPersonaName
ISteamFriends#SetPersonaNameResponse_t

GetSetPersonaNameLocalSuccess

GetSetPersonaNameLocalSuccess(hCallResult as integer) as integer

hCallResult - A SetPersonaName call result handle.

Returns whether the name change was retained locally.

This method should only be used when the call result returned by SetPersonaName has reported a GetCallResultCode of 1.

Returns: 1 if name change was retained locally. We might not have been able to communicate with Steam.

Reference:
ISteamFriends#SetPersonaName
ISteamFriends#SetPersonaNameResponse_t

SetPlayedWith

SetPlayedWith(hSteamIDUserPlayedWith as integer)

hSteamIDUserPlayedWith - The other user that we have played with.

Mark a target user as 'played with'.

Reference:
ISteamFriends#SetPlayedWith

SetRichPresence

SetRichPresence(key as string, value as string) as integer

key - The rich presence 'key' to set. This can not be longer than specified in k_cchMaxRichPresenceKeyLength.

value - The rich presence 'value' to associate with pchKey. This can not be longer than specified in k_cchMaxRichPresenceValueLength. If this is set to an empty string ("") or NULL then the key is removed if it's set.

Sets a Rich Presence key/value for the current user that is automatically shared to all friends playing the same game.

Returns: 1 if the rich presence was set successfully; otherwise 0.

Reference:
ISteamFriends#SetRichPresence

HasAvatarImageLoadedResponse

HasAvatarImageLoadedResponse() as integer

Triggered when an avatar is loaded if you have tried requesting it when it was unavailable.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetAvatarImageLoadedUser

Reference:
ISteamFriends#AvatarImageLoaded_t

GetAvatarImageLoadedUser

GetAvatarImageLoadedUser() as integer

Returns the Steam ID handle for current AvatarImageLoaded_t callback response. Call GetFriendAvatar with the returned user handle to get the image handle

This method should only be used when HasAvatarImageLoadedResponse has returned 1.

Returns: The SteamID handle of the user whose avatar loaded.

Reference:
ISteamFriends#AvatarImageLoaded_t

HasFriendRichPresenceUpdateResponse

HasFriendRichPresenceUpdateResponse() as integer

Called when Rich Presence data has been updated for a user, this can happen automatically when friends in the same game update their rich presence, or after a call to RequestFriendRichPresence.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetFriendRichPresenceUpdateUser

Reference:
ISteamFriends#FriendRichPresenceUpdate_t

GetFriendRichPresenceUpdateUser

GetFriendRichPresenceUpdateUser() as integer

Returns the Steam ID handle for current FriendRichPresenceUpdate_t callback response.

This method should only be used when HasFriendRichPresenceUpdateResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#FriendRichPresenceUpdate_t

HasGameConnectedChatJoinResponse

HasGameConnectedChatJoinResponse() as integer

Called when a user has joined a Steam group chat that the we are in.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameConnectedChatJoinClan
GetGameConnectedChatJoinUser

Reference:
ISteamFriends#GameConnectedChatJoin_t

GetGameConnectedChatJoinClan

GetGameConnectedChatJoinClan() as integer

Returns the Steam ID of the chat that a user has joined..

This method should only be used when HasGameConnectedChatJoinResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedChatJoin_t

GetGameConnectedChatJoinUser

GetGameConnectedChatJoinUser() as integer

Returns the Steam ID of the user that has joined the chat.

This method should only be used when HasGameConnectedChatJoinResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedChatJoin_t

HasGameConnectedChatLeaveResponse

HasGameConnectedChatLeaveResponse() as integer

Called when a user has left a Steam group chat that the we are in.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameConnectedChatLeaveClan
GetGameConnectedChatLeaveUser
GetGameConnectedChatLeaveDropped
GetGameConnectedChatLeaveKicked

Reference:
ISteamFriends#GameConnectedChatLeave_t

GetGameConnectedChatLeaveClan

GetGameConnectedChatLeaveClan() as integer

Returns the Steam ID of the chat that a user has left.

This method should only be used when HasGameConnectedChatLeaveResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedChatLeave_t

GetGameConnectedChatLeaveUser

GetGameConnectedChatLeaveUser() as integer

Returns the Steam ID of the user that has left the chat.

This method should only be used when HasGameConnectedChatLeaveResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedChatLeave_t

GetGameConnectedChatLeaveDropped

GetGameConnectedChatLeaveDropped() as integer

Returns whether the user's connection to Steam dropped or they left via other means.

This method should only be used when HasGameConnectedChatLeaveResponse has returned 1.

Returns: 1 if dropped; otherwise 0.

Reference:
ISteamFriends#GameConnectedChatLeave_t

GetGameConnectedChatLeaveKicked

GetGameConnectedChatLeaveKicked() as integer

Returns whether or not the user was kicked by an officer.

This method should only be used when HasGameConnectedChatLeaveResponse has returned 1.

Returns: 1 if kicked; otherwise 0.

Reference:
ISteamFriends#GameConnectedChatLeave_t

HasGameConnectedClanChatMessageResponse

HasGameConnectedClanChatMessageResponse() as integer

Called when a chat message has been received in a Steam group chat that we are in.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameConnectedClanChatMessageEntryType
GetGameConnectedClanChatMessageClan
GetGameConnectedClanChatMessageUser
GetGameConnectedClanChatMessageText

Reference:
ISteamFriends#GameConnectedClanChatMsg_t

GetGameConnectedClanChatMessageEntryType

GetGameConnectedClanChatMessageEntryType() as integer

Returns the type of chat entry that was received.

This method should only be used when HasGameConnectedClanChatMessageResponse has returned 1.

Returns: An EChatEntryType value.

Reference:
ISteamFriends#GameConnectedClanChatMsg_t

GetGameConnectedClanChatMessageClan

GetGameConnectedClanChatMessageClan() as integer

Returns the Steam ID of the chat that the message was received in.

This method should only be used when HasGameConnectedClanChatMessageResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedClanChatMsg_t

GetGameConnectedClanChatMessageUser

GetGameConnectedClanChatMessageUser() as integer

Returns the Steam ID of the user that sent the message.

This method should only be used when HasGameConnectedClanChatMessageResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedClanChatMsg_t

GetGameConnectedClanChatMessageText

GetGameConnectedClanChatMessageText() as string

Returns the chat message that was sent.

This method should only be used when HasGameConnectedClanChatMessageResponse has returned 1.

Returns: A string.

Reference:
ISteamFriends#GameConnectedClanChatMsg_t

HasGameConnectedFriendChatMessageResponse

HasGameConnectedFriendChatMessageResponse() as integer

Called when chat message has been received from a friend.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameConnectedFriendChatMessageEntryType
GetGameConnectedFriendChatMessageUser
GetGameConnectedFriendChatMessageText

Reference:
ISteamFriends#GameConnectedFriendChatMsg_t

GetGameConnectedFriendChatMessageEntryType

GetGameConnectedFriendChatMessageEntryType() as integer

Returns the type of chat entry that was received.

This method should only be used when HasGameConnectedFriendChatMessageResponse has returned 1.

Returns: An EChatEntryType value.

Reference:
ISteamFriends#GameConnectedFriendChatMsg_t

GetGameConnectedFriendChatMessageUser

GetGameConnectedFriendChatMessageUser() as integer

Returns the Steam ID of the friend that sent the message.

This method should only be used when HasGameConnectedFriendChatMessageResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameConnectedFriendChatMsg_t

GetGameConnectedFriendChatMessageText

GetGameConnectedFriendChatMessageText() as string

Returns the chat message that was sent.

This method should only be used when HasGameConnectedFriendChatMessageResponse has returned 1.

Returns: A string.

Reference:
ISteamFriends#GameConnectedFriendChatMsg_t

HasGameLobbyJoinRequestedResponse

HasGameLobbyJoinRequestedResponse() as integer

Triggered when the user tries to join a lobby from their friends list or from an invite. The game client should attempt to connect to specified lobby when this is received. If the game isn't running yet then the game will be automatically launched with the command line parameter +connect_lobby <64-bit lobby Steam ID> instead.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameLobbyJoinRequestedLobby
GetGameLobbyJoinRequestedFriend

Reference:
ISteamFriends#GameLobbyJoinRequested_t

GetGameLobbyJoinRequestedLobby

GetGameLobbyJoinRequestedLobby() as integer

Gets the lobby to which the user was invited.

This method should only be used when HasGameLobbyJoinRequestedResponse has returned 1.

Returns: A Steam ID handle or 0.

Reference:
ISteamFriends#GameLobbyJoinRequested_t

GetGameLobbyJoinRequestedFriend

GetGameLobbyJoinRequestedFriend() as integer

Returns the friend they joined through. This will be invalid if not directly via a friend.

This method should only be used when HasGameLobbyJoinRequestedResponse has returned 1.

Returns: A Steam ID handle or 0.

Reference:
ISteamFriends#GameLobbyJoinRequested_t

IsGameOverlayActive

IsGameOverlayActive() as integer

Gets whether the Steam Overlay has been activated or deactivated.

Returns: 1 when the Steam overlay is active and 0 when it is not.

Reference:
ISteamFriends#GameOverlayActivated_t

HasGameRichPresenceJoinRequestedResponse

HasGameRichPresenceJoinRequestedResponse() as integer

Called when the user tries to join a game from their friends list or after a user accepts an invite by a friend with InviteUserToGame.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameRichPresenceJoinRequestedConnect
GetGameRichPresenceJoinRequestedFriend

Reference:
ISteamFriends#GameRichPresenceJoinRequested_t

GetGameRichPresenceJoinRequestedConnect

GetGameRichPresenceJoinRequestedConnect() as string

The value associated with the "connect" Rich Presence key.

This method should only be used when HasGameRichPresenceJoinRequestedResponse has returned 1.

Returns: A string.

Reference:
ISteamFriends#GameRichPresenceJoinRequested_t

GetGameRichPresenceJoinRequestedFriend

GetGameRichPresenceJoinRequestedFriend() as integer

The friend they joined through. This will be invalid if not directly via a friend.

This method should only be used when HasGameRichPresenceJoinRequestedResponse has returned 1.

Returns: A Steam ID handle.

Reference:
ISteamFriends#GameRichPresenceJoinRequested_t

HasGameServerChangeRequestedResponse

HasGameServerChangeRequestedResponse() as integer

Called when the user tries to join a different game server from their friends list. The game client should attempt to connect to specified server when this is received.

Returns: 1 when the callback has more responses to process; otherwise 0.

Associated Methods:
GetGameServerChangeRequestedPassword
GetGameServerChangeRequestedServer

Reference:
ISteamFriends#GameServerChangeRequested_t