Reference API Roblox

Engine API

Website

Related

Reference API Roblox

FriendService

An internal service which is used to send, cancel, accept and decline friend requests in-game.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service]

Member index 2

HistoryMember
462GetPlatformFriends(): Array
462FriendsUpdated(friendData: Array)
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 12

HistoryMember
315GetAreUsersFriends(userId: int, otherUserId: int, allowOfflineUsers: bool = false): bool
310SetBreakFriendUrl(url: string): void
285SetCreateFriendRequestUrl(url: string): void
285SetDeleteFriendRequestUrl(url: string): void
285SetEnabled(enable: bool): void
285SetFriendsOnlineUrl(url: string): void
310SetGetFriendsUrl(url: string): void
310SetMakeFriendUrl(url: string): void
308StartReceivingPlatformFriendsEvents(): void
308FriendsEvent(eventInfo: Dictionary, friendData: Array)

Description

A service which is used to send, cancel, accept and decline friend requests in-game. It is primarily used by the PlayerListScript to send friend requests with the leaderboard.

History 43

Members 2

FriendsUpdated

Parameters (1)
friendDataArray
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 2

GetPlatformFriends

Parameters (0)
No parameters.
Returns (1)
Array
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 4

Tags: [Yields]

Removed members 12

FriendsEvent

Parameters (2)
eventInfoDictionary
friendDataArray
SecurityRobloxScriptSecurity

History 6

GetAreUsersFriends

Parameters (3)Default
userIdint
otherUserIdint
allowOfflineUsersboolfalse
Returns (1)
bool
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity

History 2

Tags: [Yields]

SetBreakFriendUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetCreateFriendRequestUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetDeleteFriendRequestUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetEnabled

Parameters (1)
enablebool
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetFriendsOnlineUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 4

SetGetFriendsUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 2

SetMakeFriendUrl

Parameters (1)
urlstring
Returns (1)
void
SecurityLocalUserSecurity

History 2

StartReceivingPlatformFriendsEvents

Parameters (0)
No parameters.
Returns (1)
void
SecurityRobloxScriptSecurity

History 2

Settings