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.
Tags: [NotCreatable, Service]

Member index 4

HistoryMember
462GetPlatformFriends(): Array
462FriendsUpdated(friendData: Array)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 10

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 41

Members 4

FriendsUpdated

Parameters (1)
friendDataArray

History 2

GetPlatformFriends

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

History 4

Tags: [Yields]

Removed members 10

FriendsEvent

Parameters (2)
eventInfoDictionary
friendDataArray

History 6

GetAreUsersFriends

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

History 2

Tags: [Yields]

SetBreakFriendUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetCreateFriendRequestUrl

Parameters (1)
urlstring
Returns (1)
void

History 4

SetDeleteFriendRequestUrl

Parameters (1)
urlstring
Returns (1)
void

History 4

SetEnabled

Parameters (1)
enablebool
Returns (1)
void

History 4

SetFriendsOnlineUrl

Parameters (1)
urlstring
Returns (1)
void

History 4

SetGetFriendsUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

SetMakeFriendUrl

Parameters (1)
urlstring
Returns (1)
void

History 2

StartReceivingPlatformFriendsEvents

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

History 2

Settings