Interface: SteamFriends

SteamWorksNamespace.SteamFriends

Table of contents

Properties

• ActivateGameOverlay
• ActivateGameOverlayInviteDialog
• ActivateGameOverlayInviteDialogConnectString
• ActivateGameOverlayRemotePlayTogetherInviteDialog
• ActivateGameOverlayToStore
• ActivateGameOverlayToUser
• ActivateGameOverlayToWebPage
• BHasEquippedProfileItem
• ClearRichPresence
• CloseClanChatWindowInSteam
• DownloadClanActivityCounts
• EnumerateFollowingList
• GetChatMemberByIndex
• GetClanActivityCounts
• GetClanByIndex
• GetClanChatMemberCount
• GetClanChatMessage
• GetClanCount
• GetClanName
• GetClanOfficerByIndex
• GetClanOfficerCount
• GetClanOwner
• GetClanTag
• GetCoplayFriend
• GetCoplayFriendCount
• GetFollowerCount
• GetFriendByIndex
• GetFriendCoplayGame
• GetFriendCoplayTime
• GetFriendCount
• GetFriendCountFromSource
• GetFriendFromSourceByIndex
• GetFriendGamePlayed
• GetFriendMessage
• GetFriendPersonaName
• GetFriendPersonaNameHistory
• GetFriendPersonaState
• GetFriendRelationship
• GetFriendRichPresence
• GetFriendRichPresenceKeyByIndex
• GetFriendRichPresenceKeyCount
• GetFriendSteamLevel
• GetFriendsGroupCount
• GetFriendsGroupIDByIndex
• GetFriendsGroupMembersCount
• GetFriendsGroupMembersList
• GetFriendsGroupName
• GetLargeFriendAvatar
• GetMediumFriendAvatar
• GetNumChatsWithUnreadPriorityMessages
• GetPersonaName
• GetPersonaState
• GetPlayerNickname
• GetProfileItemPropertyString
• GetProfileItemPropertyUint
• GetSmallFriendAvatar
• GetUserRestrictions
• HasFriend
• InviteUserToGame
• IsClanChatAdmin
• IsClanChatWindowOpenInSteam
• IsClanOfficialGameGroup
• IsClanPublic
• IsFollowing
• IsUserInSource
• JoinClanChatRoom
• LeaveClanChatRoom
• OpenClanChatWindowInSteam
• RegisterProtocolInOverlayBrowser
• ReplyToFriendMessage
• RequestClanOfficerList
• RequestEquippedProfileItems
• RequestFriendRichPresence
• RequestUserInformation
• SendClanChatMessage
• SetInGameVoiceSpeaking
• SetListenForFriendsMessages
• SetPersonaName
• SetPlayedWith
• SetRichPresence

Properties

ActivateGameOverlay

• ActivateGameOverlay: (pchDialog: string) => undefined

Type declaration

▸ (pchDialog): undefined

Parameters

Name	Type
pchDialog	string

Returns

undefined

Defined in

index.d.ts:2202

---

ActivateGameOverlayInviteDialog

• ActivateGameOverlayInviteDialog: (steamIDLobby: CSteamID) => undefined

Type declaration

▸ (steamIDLobby): undefined

Parameters

Name	Type
steamIDLobby	CSteamID

Returns

undefined

Defined in

index.d.ts:2207

---

ActivateGameOverlayInviteDialogConnectString

• ActivateGameOverlayInviteDialogConnectString: (pchConnectString: string) => undefined

Type declaration

▸ (pchConnectString): undefined

Parameters

Name	Type
pchConnectString	string

Returns

undefined

Defined in

index.d.ts:2249

---

ActivateGameOverlayRemotePlayTogetherInviteDialog

• ActivateGameOverlayRemotePlayTogetherInviteDialog: (steamIDLobby: CSteamID) => undefined

Type declaration

▸ (steamIDLobby): undefined

Parameters

Name	Type
steamIDLobby	CSteamID

Returns

undefined

Defined in

index.d.ts:2247

---

ActivateGameOverlayToStore

• ActivateGameOverlayToStore: (nAppID: number, eFlag: EOverlayToStoreFlag) => undefined

Type declaration

▸ (nAppID, eFlag): undefined

Parameters

Name	Type
nAppID	number
eFlag	EOverlayToStoreFlag

Returns

undefined

Defined in

index.d.ts:2205

---

ActivateGameOverlayToUser

• ActivateGameOverlayToUser: (pchDialog: string, steamID: CSteamID) => undefined

Type declaration

▸ (pchDialog, steamID): undefined

Parameters

Name	Type
pchDialog	string
steamID	CSteamID

Returns

undefined

Defined in

index.d.ts:2203

---

ActivateGameOverlayToWebPage

• ActivateGameOverlayToWebPage: (pchURL: string, eMode: EActivateGameOverlayToWebPageMode) => undefined

Type declaration

▸ (pchURL, eMode): undefined

Parameters

Name	Type
pchURL	string
eMode	EActivateGameOverlayToWebPageMode

Returns

undefined

Defined in

index.d.ts:2204

---

BHasEquippedProfileItem

• BHasEquippedProfileItem: (steamID: CSteamID, itemType: ECommunityProfileItemType) => boolean

Type declaration

▸ (steamID, itemType): boolean

Parameters

Name	Type
steamID	CSteamID
itemType	ECommunityProfileItemType

Returns

boolean

Defined in

index.d.ts:2251

---

ClearRichPresence

• ClearRichPresence: () => undefined

Type declaration

▸ (): undefined

Returns

undefined

Defined in

index.d.ts:2218

---

CloseClanChatWindowInSteam

• CloseClanChatWindowInSteam: (steamIDClanChat: CSteamID) => boolean

Type declaration

▸ (steamIDClanChat): boolean

Parameters

Name	Type
steamIDClanChat	CSteamID

Returns

boolean

Defined in

index.d.ts:2237

---

DownloadClanActivityCounts

• DownloadClanActivityCounts: (psteamIDClans: unknown, cClansToRequest: number) => Promise<{ m_bSuccess: boolean }>

Type declaration

▸ (psteamIDClans, cClansToRequest): Promise<{ m_bSuccess: boolean }>

Parameters

Name	Type
psteamIDClans	unknown
cClansToRequest	number

Returns

Promise<{ m_bSuccess: boolean }>

Defined in

index.d.ts:2197

---

EnumerateFollowingList

• EnumerateFollowingList: (unStartIndex: number) => Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgSteamID: unknown }>

Type declaration

▸ (unStartIndex): Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgSteamID: unknown }>

Parameters

Name	Type
unStartIndex	number

Returns

Promise<{ m_eResult: EResult ; m_nResultsReturned: number ; m_nTotalResultCount: number ; m_rgSteamID: unknown }>

Defined in

index.d.ts:2243

---

GetChatMemberByIndex

• GetChatMemberByIndex: (steamIDClan: CSteamID, iUser: number) => CSteamID

Type declaration

▸ (steamIDClan, iUser): CSteamID

Parameters

Name	Type
steamIDClan	CSteamID
iUser	number

Returns

CSteamID

Defined in

index.d.ts:2231

---

GetClanActivityCounts

• GetClanActivityCounts: (steamIDClan: CSteamID, pnOnline: number, pnInGame: number, pnChatting: number) => boolean

Type declaration

▸ (steamIDClan, pnOnline, pnInGame, pnChatting): boolean

Parameters

Name	Type
steamIDClan	CSteamID
pnOnline	number
pnInGame	number
pnChatting	number

Returns

boolean

Defined in

index.d.ts:2196

---

GetClanByIndex

• GetClanByIndex: (iClan: number) => CSteamID

Type declaration

▸ (iClan): CSteamID

Parameters

Name	Type
iClan	number

Returns

CSteamID

Defined in

index.d.ts:2193

---

GetClanChatMemberCount

• GetClanChatMemberCount: (steamIDClan: CSteamID) => number

Type declaration

▸ (steamIDClan): number

Parameters

Name	Type
steamIDClan	CSteamID

Returns

number

Defined in

index.d.ts:2230

---

GetClanChatMessage

• GetClanChatMessage: (steamIDClanChat: CSteamID, iMessage: number, prgchText: unknown, cchTextMax: number, peChatEntryType: unknown, psteamidChatter: unknown) => number

Type declaration

▸ (steamIDClanChat, iMessage, prgchText, cchTextMax, peChatEntryType, psteamidChatter): number

Parameters

Name	Type
steamIDClanChat	CSteamID
iMessage	number
prgchText	unknown
cchTextMax	number
peChatEntryType	unknown
psteamidChatter	unknown

Returns

number

Defined in

index.d.ts:2233

---

GetClanCount

• GetClanCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2192

---

GetClanName

• GetClanName: (steamIDClan: CSteamID) => string

Type declaration

▸ (steamIDClan): string

Parameters

Name	Type
steamIDClan	CSteamID

Returns

string

Defined in

index.d.ts:2194

---

GetClanOfficerByIndex

• GetClanOfficerByIndex: (steamIDClan: CSteamID, iOfficer: number) => CSteamID

Type declaration

▸ (steamIDClan, iOfficer): CSteamID

Parameters

Name	Type
steamIDClan	CSteamID
iOfficer	number

Returns

CSteamID

Defined in

index.d.ts:2215

---

GetClanOfficerCount

• GetClanOfficerCount: (steamIDClan: CSteamID) => number

Type declaration

▸ (steamIDClan): number

Parameters

Name	Type
steamIDClan	CSteamID

Returns

number

Defined in

index.d.ts:2214

---

GetClanOwner

• GetClanOwner: (steamIDClan: CSteamID) => CSteamID

Type declaration

▸ (steamIDClan): CSteamID

Parameters

Name	Type
steamIDClan	CSteamID

Returns

CSteamID

Defined in

index.d.ts:2213

---

GetClanTag

• GetClanTag: (steamIDClan: CSteamID) => string

Type declaration

▸ (steamIDClan): string

Parameters

Name	Type
steamIDClan	CSteamID

Returns

string

Defined in

index.d.ts:2195

---

GetCoplayFriend

• GetCoplayFriend: (iCoplayFriend: number) => CSteamID

Type declaration

▸ (iCoplayFriend): CSteamID

Parameters

Name	Type
iCoplayFriend	number

Returns

CSteamID

Defined in

index.d.ts:2225

---

GetCoplayFriendCount

• GetCoplayFriendCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2224

---

GetFollowerCount

• GetFollowerCount: (steamID: CSteamID) => Promise<{ m_eResult: EResult ; m_nCount: number ; m_steamID: CSteamID }>

Type declaration

▸ (steamID): Promise<{ m_eResult: EResult ; m_nCount: number ; m_steamID: CSteamID }>

Parameters

Name	Type
steamID	CSteamID

Returns

Promise<{ m_eResult: EResult ; m_nCount: number ; m_steamID: CSteamID }>

Defined in

index.d.ts:2241

---

GetFriendByIndex

• GetFriendByIndex: (iFriend: number, iFriendFlags: number) => CSteamID

Type declaration

▸ (iFriend, iFriendFlags): CSteamID

Parameters

Name	Type
iFriend	number
iFriendFlags	number

Returns

CSteamID

Defined in

index.d.ts:2178

---

GetFriendCoplayGame

• GetFriendCoplayGame: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2227

---

GetFriendCoplayTime

• GetFriendCoplayTime: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2226

---

GetFriendCount

• GetFriendCount: (iFriendFlags: number) => number

Type declaration

▸ (iFriendFlags): number

Parameters

Name	Type
iFriendFlags	number

Returns

number

Defined in

index.d.ts:2177

---

GetFriendCountFromSource

• GetFriendCountFromSource: (steamIDSource: CSteamID) => number

Type declaration

▸ (steamIDSource): number

Parameters

Name	Type
steamIDSource	CSteamID

Returns

number

Defined in

index.d.ts:2198

---

GetFriendFromSourceByIndex

• GetFriendFromSourceByIndex: (steamIDSource: CSteamID, iFriend: number) => CSteamID

Type declaration

▸ (steamIDSource, iFriend): CSteamID

Parameters

Name	Type
steamIDSource	CSteamID
iFriend	number

Returns

CSteamID

Defined in

index.d.ts:2199

---

GetFriendGamePlayed

• GetFriendGamePlayed: (steamIDFriend: CSteamID, pFriendGameInfo: FriendGameInfo_t) => boolean

Type declaration

▸ (steamIDFriend, pFriendGameInfo): boolean

Parameters

Name	Type
steamIDFriend	CSteamID
pFriendGameInfo	FriendGameInfo_t

Returns

boolean

Defined in

index.d.ts:2182

---

GetFriendMessage

• GetFriendMessage: (steamIDFriend: CSteamID, iMessageID: number, pvData: unknown, cubData: number, peChatEntryType: unknown) => number

Type declaration

▸ (steamIDFriend, iMessageID, pvData, cubData, peChatEntryType): number

Parameters

Name	Type
steamIDFriend	CSteamID
iMessageID	number
pvData	unknown
cubData	number
peChatEntryType	unknown

Returns

number

Defined in

index.d.ts:2240

---

GetFriendPersonaName

• GetFriendPersonaName: (steamIDFriend: CSteamID) => string

Type declaration

▸ (steamIDFriend): string

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

string

Defined in

index.d.ts:2181

---

GetFriendPersonaNameHistory

• GetFriendPersonaNameHistory: (steamIDFriend: CSteamID, iPersonaName: number) => string

Type declaration

▸ (steamIDFriend, iPersonaName): string

Parameters

Name	Type
steamIDFriend	CSteamID
iPersonaName	number

Returns

string

Defined in

index.d.ts:2183

---

GetFriendPersonaState

• GetFriendPersonaState: (steamIDFriend: CSteamID) => EPersonaState

Type declaration

▸ (steamIDFriend): EPersonaState

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

EPersonaState

Defined in

index.d.ts:2180

---

GetFriendRelationship

• GetFriendRelationship: (steamIDFriend: CSteamID) => EFriendRelationship

Type declaration

▸ (steamIDFriend): EFriendRelationship

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

EFriendRelationship

Defined in

index.d.ts:2179

---

GetFriendRichPresence

• GetFriendRichPresence: (steamIDFriend: CSteamID, pchKey: string) => string

Type declaration

▸ (steamIDFriend, pchKey): string

Parameters

Name	Type
steamIDFriend	CSteamID
pchKey	string

Returns

string

Defined in

index.d.ts:2219

---

GetFriendRichPresenceKeyByIndex

• GetFriendRichPresenceKeyByIndex: (steamIDFriend: CSteamID, iKey: number) => string

Type declaration

▸ (steamIDFriend, iKey): string

Parameters

Name	Type
steamIDFriend	CSteamID
iKey	number

Returns

string

Defined in

index.d.ts:2221

---

GetFriendRichPresenceKeyCount

• GetFriendRichPresenceKeyCount: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2220

---

GetFriendSteamLevel

• GetFriendSteamLevel: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2184

---

GetFriendsGroupCount

• GetFriendsGroupCount: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2186

---

GetFriendsGroupIDByIndex

• GetFriendsGroupIDByIndex: (iFG: number) => number

Type declaration

▸ (iFG): number

Parameters

Name	Type
iFG	number

Returns

number

Defined in

index.d.ts:2187

---

GetFriendsGroupMembersCount

• GetFriendsGroupMembersCount: (friendsGroupID: number) => number

Type declaration

▸ (friendsGroupID): number

Parameters

Name	Type
friendsGroupID	number

Returns

number

Defined in

index.d.ts:2189

---

GetFriendsGroupMembersList

• GetFriendsGroupMembersList: (friendsGroupID: number, pOutSteamIDMembers: unknown, nMembersCount: number) => undefined

Type declaration

▸ (friendsGroupID, pOutSteamIDMembers, nMembersCount): undefined

Parameters

Name	Type
friendsGroupID	number
pOutSteamIDMembers	unknown
nMembersCount	number

Returns

undefined

Defined in

index.d.ts:2190

---

GetFriendsGroupName

• GetFriendsGroupName: (friendsGroupID: number) => string

Type declaration

▸ (friendsGroupID): string

Parameters

Name	Type
friendsGroupID	number

Returns

string

Defined in

index.d.ts:2188

---

GetLargeFriendAvatar

• GetLargeFriendAvatar: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2210

---

GetMediumFriendAvatar

• GetMediumFriendAvatar: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2209

---

GetNumChatsWithUnreadPriorityMessages

• GetNumChatsWithUnreadPriorityMessages: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2246

---

GetPersonaName

• GetPersonaName: () => string

Type declaration

▸ (): string

Returns

string

Defined in

index.d.ts:2174

---

GetPersonaState

• GetPersonaState: () => EPersonaState

Type declaration

▸ (): EPersonaState

Returns

EPersonaState

Defined in

index.d.ts:2176

---

GetPlayerNickname

• GetPlayerNickname: (steamIDPlayer: CSteamID) => string

Type declaration

▸ (steamIDPlayer): string

Parameters

Name	Type
steamIDPlayer	CSteamID

Returns

string

Defined in

index.d.ts:2185

---

GetProfileItemPropertyString

• GetProfileItemPropertyString: (steamID: CSteamID, itemType: ECommunityProfileItemType, prop: ECommunityProfileItemProperty) => string

Type declaration

▸ (steamID, itemType, prop): string

Parameters

Name	Type
steamID	CSteamID
itemType	ECommunityProfileItemType
prop	ECommunityProfileItemProperty

Returns

string

Defined in

index.d.ts:2252

---

GetProfileItemPropertyUint

• GetProfileItemPropertyUint: (steamID: CSteamID, itemType: ECommunityProfileItemType, prop: ECommunityProfileItemProperty) => number

Type declaration

▸ (steamID, itemType, prop): number

Parameters

Name	Type
steamID	CSteamID
itemType	ECommunityProfileItemType
prop	ECommunityProfileItemProperty

Returns

number

Defined in

index.d.ts:2253

---

GetSmallFriendAvatar

• GetSmallFriendAvatar: (steamIDFriend: CSteamID) => number

Type declaration

▸ (steamIDFriend): number

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

number

Defined in

index.d.ts:2208

---

GetUserRestrictions

• GetUserRestrictions: () => number

Type declaration

▸ (): number

Returns

number

Defined in

index.d.ts:2216

---

HasFriend

• HasFriend: (steamIDFriend: CSteamID, iFriendFlags: number) => boolean

Type declaration

▸ (steamIDFriend, iFriendFlags): boolean

Parameters

Name	Type
steamIDFriend	CSteamID
iFriendFlags	number

Returns

boolean

Defined in

index.d.ts:2191

---

InviteUserToGame

• InviteUserToGame: (steamIDFriend: CSteamID, pchConnectString: string) => boolean

Type declaration

▸ (steamIDFriend, pchConnectString): boolean

Parameters

Name	Type
steamIDFriend	CSteamID
pchConnectString	string

Returns

boolean

Defined in

index.d.ts:2223

---

IsClanChatAdmin

• IsClanChatAdmin: (steamIDClanChat: CSteamID, steamIDUser: CSteamID) => boolean

Type declaration

▸ (steamIDClanChat, steamIDUser): boolean

Parameters

Name	Type
steamIDClanChat	CSteamID
steamIDUser	CSteamID

Returns

boolean

Defined in

index.d.ts:2234

---

IsClanChatWindowOpenInSteam

• IsClanChatWindowOpenInSteam: (steamIDClanChat: CSteamID) => boolean

Type declaration

▸ (steamIDClanChat): boolean

Parameters

Name	Type
steamIDClanChat	CSteamID

Returns

boolean

Defined in

index.d.ts:2235

---

IsClanOfficialGameGroup

• IsClanOfficialGameGroup: (steamIDClan: CSteamID) => boolean

Type declaration

▸ (steamIDClan): boolean

Parameters

Name	Type
steamIDClan	CSteamID

Returns

boolean

Defined in

index.d.ts:2245

---

IsClanPublic

• IsClanPublic: (steamIDClan: CSteamID) => boolean

Type declaration

▸ (steamIDClan): boolean

Parameters

Name	Type
steamIDClan	CSteamID

Returns

boolean

Defined in

index.d.ts:2244

---

IsFollowing

• IsFollowing: (steamID: CSteamID) => Promise<{ m_bIsFollowing: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Type declaration

▸ (steamID): Promise<{ m_bIsFollowing: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Parameters

Name	Type
steamID	CSteamID

Returns

Promise<{ m_bIsFollowing: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Defined in

index.d.ts:2242

---

IsUserInSource

• IsUserInSource: (steamIDUser: CSteamID, steamIDSource: CSteamID) => boolean

Type declaration

▸ (steamIDUser, steamIDSource): boolean

Parameters

Name	Type
steamIDUser	CSteamID
steamIDSource	CSteamID

Returns

boolean

Defined in

index.d.ts:2200

---

JoinClanChatRoom

• JoinClanChatRoom: (steamIDClan: CSteamID) => Promise<{ m_eChatRoomEnterResponse: EChatRoomEnterResponse ; m_steamIDClanChat: CSteamID }>

Type declaration

▸ (steamIDClan): Promise<{ m_eChatRoomEnterResponse: EChatRoomEnterResponse ; m_steamIDClanChat: CSteamID }>

Parameters

Name	Type
steamIDClan	CSteamID

Returns

Promise<{ m_eChatRoomEnterResponse: EChatRoomEnterResponse ; m_steamIDClanChat: CSteamID }>

Defined in

index.d.ts:2228

---

LeaveClanChatRoom

• LeaveClanChatRoom: (steamIDClan: CSteamID) => boolean

Type declaration

▸ (steamIDClan): boolean

Parameters

Name	Type
steamIDClan	CSteamID

Returns

boolean

Defined in

index.d.ts:2229

---

OpenClanChatWindowInSteam

• OpenClanChatWindowInSteam: (steamIDClanChat: CSteamID) => boolean

Type declaration

▸ (steamIDClanChat): boolean

Parameters

Name	Type
steamIDClanChat	CSteamID

Returns

boolean

Defined in

index.d.ts:2236

---

RegisterProtocolInOverlayBrowser

• RegisterProtocolInOverlayBrowser: (pchProtocol: string) => boolean

Type declaration

▸ (pchProtocol): boolean

Parameters

Name	Type
pchProtocol	string

Returns

boolean

Defined in

index.d.ts:2248

---

ReplyToFriendMessage

• ReplyToFriendMessage: (steamIDFriend: CSteamID, pchMsgToSend: string) => boolean

Type declaration

▸ (steamIDFriend, pchMsgToSend): boolean

Parameters

Name	Type
steamIDFriend	CSteamID
pchMsgToSend	string

Returns

boolean

Defined in

index.d.ts:2239

---

RequestClanOfficerList

• RequestClanOfficerList: (steamIDClan: CSteamID) => Promise<{ m_bSuccess: number ; m_cOfficers: number ; m_steamIDClan: CSteamID }>

Type declaration

▸ (steamIDClan): Promise<{ m_bSuccess: number ; m_cOfficers: number ; m_steamIDClan: CSteamID }>

Parameters

Name	Type
steamIDClan	CSteamID

Returns

Promise<{ m_bSuccess: number ; m_cOfficers: number ; m_steamIDClan: CSteamID }>

Defined in

index.d.ts:2212

---

RequestEquippedProfileItems

• RequestEquippedProfileItems: (steamID: CSteamID) => Promise<{ m_bHasAnimatedAvatar: boolean ; m_bHasAvatarFrame: boolean ; m_bHasMiniProfileBackground: boolean ; m_bHasProfileBackground: boolean ; m_bHasProfileModifier: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Type declaration

▸ (steamID): Promise<{ m_bHasAnimatedAvatar: boolean ; m_bHasAvatarFrame: boolean ; m_bHasMiniProfileBackground: boolean ; m_bHasProfileBackground: boolean ; m_bHasProfileModifier: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Parameters

Name	Type
steamID	CSteamID

Returns

Promise<{ m_bHasAnimatedAvatar: boolean ; m_bHasAvatarFrame: boolean ; m_bHasMiniProfileBackground: boolean ; m_bHasProfileBackground: boolean ; m_bHasProfileModifier: boolean ; m_eResult: EResult ; m_steamID: CSteamID }>

Defined in

index.d.ts:2250

---

RequestFriendRichPresence

• RequestFriendRichPresence: (steamIDFriend: CSteamID) => undefined

Type declaration

▸ (steamIDFriend): undefined

Parameters

Name	Type
steamIDFriend	CSteamID

Returns

undefined

Defined in

index.d.ts:2222

---

RequestUserInformation

• RequestUserInformation: (steamIDUser: CSteamID, bRequireNameOnly: boolean) => boolean

Type declaration

▸ (steamIDUser, bRequireNameOnly): boolean

Parameters

Name	Type
steamIDUser	CSteamID
bRequireNameOnly	boolean

Returns

boolean

Defined in

index.d.ts:2211

---

SendClanChatMessage

• SendClanChatMessage: (steamIDClanChat: CSteamID, pchText: string) => boolean

Type declaration

▸ (steamIDClanChat, pchText): boolean

Parameters

Name	Type
steamIDClanChat	CSteamID
pchText	string

Returns

boolean

Defined in

index.d.ts:2232

---

SetInGameVoiceSpeaking

• SetInGameVoiceSpeaking: (steamIDUser: CSteamID, bSpeaking: boolean) => undefined

Type declaration

▸ (steamIDUser, bSpeaking): undefined

Parameters

Name	Type
steamIDUser	CSteamID
bSpeaking	boolean

Returns

undefined

Defined in

index.d.ts:2201

---

SetListenForFriendsMessages

• SetListenForFriendsMessages: (bInterceptEnabled: boolean) => boolean

Type declaration

▸ (bInterceptEnabled): boolean

Parameters

Name	Type
bInterceptEnabled	boolean

Returns

boolean

Defined in

index.d.ts:2238

---

SetPersonaName

• SetPersonaName: (pchPersonaName: string) => Promise<{ m_bLocalSuccess: boolean ; m_bSuccess: boolean ; m_result: EResult }>

Type declaration

▸ (pchPersonaName): Promise<{ m_bLocalSuccess: boolean ; m_bSuccess: boolean ; m_result: EResult }>

Parameters

Name	Type
pchPersonaName	string

Returns

Promise<{ m_bLocalSuccess: boolean ; m_bSuccess: boolean ; m_result: EResult }>

Defined in

index.d.ts:2175

---

SetPlayedWith

• SetPlayedWith: (steamIDUserPlayedWith: CSteamID) => undefined

Type declaration

▸ (steamIDUserPlayedWith): undefined

Parameters

Name	Type
steamIDUserPlayedWith	CSteamID

Returns

undefined

Defined in

index.d.ts:2206

---

SetRichPresence

• SetRichPresence: (pchKey: string, pchValue: string) => boolean

Type declaration

▸ (pchKey, pchValue): boolean

Parameters

Name	Type
pchKey	string
pchValue	string

Returns

boolean

Defined in

index.d.ts:2217