SocialService¶
Supported Class NotCreatable NotReplicated Service
Facilitates social functions that impact relationships made on the Roblox platform.
7 Nova members · 37 modern Roblox members not implemented yet
Description¶
SocialService facilitates social functions that impact relationships made on the Roblox platform. Its primary usage is to show invite prompts and the phone book to players, allowing them to send invitation requests to their friends through PromptGameInvite() and PromptPhoneBook() respectively. You may leverage signals when such requests are made.
Inheritance¶
Object → Instance → SocialService
Nova inheritance: Instance → SocialService
Methods¶
SetBestFriendUrl Supported Function
No description available.
Security:
LocalUserSecuritySetFriendUrl Supported Function
No description available.
Security:
LocalUserSecuritySetGroupRankUrl Supported Function
No description available.
Security:
LocalUserSecuritySetGroupRoleUrl Supported Function
No description available.
Security:
LocalUserSecuritySetGroupUrl Supported Function
No description available.
Security:
LocalUserSecuritySetPackageContentsUrl Supported Function
No description available.
Security:
LocalUserSecuritySetStuffUrl Supported Function
No description available.
Security:
LocalUserSecurityInherited members¶
Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.
37 modern Roblox member(s) are not implemented yet — expand to inspect
Members declared by Roblox's SocialService class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.
Methods¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
CanSendCallInviteAsync |
SocialService:CanSendCallInviteAsync(player: Instance): bool |
Not yet | Indicates whether the given Player can invite other players to a call. | Yields |
CanSendGameInviteAsync |
SocialService:CanSendGameInviteAsync(player: Instance, recipientId: User = U1.AQAAAAAAAAAAAAAAAAAAAAA): bool |
Not yet | Indicates whether the given Player can invite other players. | Yields |
GetEventRsvpStatusAsync |
SocialService:GetEventRsvpStatusAsync(eventId: string): RsvpStatus |
Not yet | Returns the local player's RSVP status for the given event. | Yields |
GetExperienceEventAsync |
SocialService:GetExperienceEventAsync(eventId: string): Dictionary? |
Not yet | Returns details for the specified experience event or nil if it is unavailable. |
Yields |
GetPartyAsync |
SocialService:GetPartyAsync(partyId: string): Array |
Not yet | Returns an array of dictionaries containing data for all members of the specified party who are currently in the experience. | Yields |
GetPlayersByPartyId |
SocialService:GetPlayersByPartyId(partyId: string): Instances |
Not yet | Returns a table of all presently connected Player objects whose Player.PartyId property matches the passed partyId. |
— |
GetUpcomingExperienceEventsAsync |
SocialService:GetUpcomingExperienceEventsAsync(): Array |
Not yet | Returns active and upcoming experience events for the current experience. | Yields |
HideSelfView |
SocialService:HideSelfView(): null |
Not yet | Hides the calling player's self view. | — |
InvokeGameInvitePromptClosed |
SocialService:InvokeGameInvitePromptClosed(player: Instance, recipientIds: Array): null |
Not yet | — | RobloxScriptSecurity |
InvokeIrisInvite |
SocialService:InvokeIrisInvite(player: Instance, tag: string, irisParticipants: Array): null |
Not yet | — | RobloxScriptSecurity |
InvokeIrisInvitePromptClosed |
SocialService:InvokeIrisInvitePromptClosed(player: Instance): null |
Not yet | — | RobloxScriptSecurity |
InvokeShareSheetClosed |
SocialService:InvokeShareSheetClosed(): null |
Not yet | — | RobloxScriptSecurity |
PromptFeedbackSubmissionAsync |
SocialService:PromptFeedbackSubmissionAsync(options: Dictionary?): null |
Not yet | Prompts the player to submit feedback or a player support ticket about the current experience. | Yields |
PromptGameInvite |
SocialService:PromptGameInvite(player: Instance, experienceInviteOptions: Instance = nil): null |
Not yet | Prompts the given Player with the invite screen. | — |
PromptLinkSharing |
SocialService:PromptLinkSharing(player: Player, options: Dictionary = nil): Tuple |
Not yet | — | Yields, PreferredDescriptorName, ThreadSafety, PreferredDes… |
PromptLinkSharingAsync |
SocialService:PromptLinkSharingAsync(player: Player, options: Dictionary = nil): Tuple |
Not yet | Generates an expiring share link and prompts the given Player with the platform share sheet. | Yields |
PromptPhoneBook |
SocialService:PromptPhoneBook(player: Instance, tag: string): null |
Not yet | Prompts the given Player with the phone book. | — |
PromptRsvpToEventAsync |
SocialService:PromptRsvpToEventAsync(eventId: string): RsvpStatus |
Not yet | Prompts the local Player with a prompt to change their RSVP status to the given event. | Yields |
PromptRsvpToEventCompleted |
SocialService:PromptRsvpToEventCompleted(eventId: string, success: bool, rsvpStatus: RsvpStatus, previousRsvpStatus: RsvpStatus = None): null |
Not yet | — | RobloxScriptSecurity |
ShowSelfView |
SocialService:ShowSelfView(selfViewPosition: SelfViewPosition = LastPosition): null |
Not yet | Shows the calling player's self view. | — |
SignalFeedbackSubmissionCompleted |
SocialService:SignalFeedbackSubmissionCompleted(feedback: string, options: Dictionary?): null |
Not yet | — | RobloxScriptSecurity |
SignalFeedbackSubmissionPermissionDenied |
SocialService:SignalFeedbackSubmissionPermissionDenied(): null |
Not yet | — | RobloxScriptSecurity |
UpdatePlayerPartyData |
SocialService:UpdatePlayerPartyData(partyId: string): null |
Not yet | — | RobloxScriptSecurity |
Events¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
CallInviteStateChanged |
CallInviteStateChanged(player: Instance, inviteState: InviteState) |
Not yet | Fires when a player's call invite state changes. | — |
GameInvitePromptClosed |
GameInvitePromptClosed(player: Instance, recipientIds: Array) |
Not yet | Fires when a player closes an invite prompt. | — |
OpenShareSheetWithLink |
OpenShareSheetWithLink(link: string) |
Not yet | — | RobloxScriptSecurity |
PhoneBookPromptClosed |
PhoneBookPromptClosed(player: Instance) |
Not yet | Fires when a player closes the phone book prompt. | — |
PlayerPartyDataChanged |
PlayerPartyDataChanged(partyId: string) |
Not yet | — | RobloxScriptSecurity |
PromptInviteRequested |
PromptInviteRequested(player: Instance, experienceInviteOptions: Instance) |
Not yet | — | RobloxScriptSecurity |
PromptIrisInviteRequested |
PromptIrisInviteRequested(player: Instance, tag: string) |
Not yet | — | RobloxScriptSecurity |
SelfViewHidden |
SelfViewHidden() |
Not yet | — | RobloxScriptSecurity |
SelfViewVisible |
SelfViewVisible(selfViewPosition: SelfViewPosition) |
Not yet | — | RobloxScriptSecurity |
ShareSheetClosed |
ShareSheetClosed(player: Player) |
Not yet | Fires when the player closes the share sheet opened by PromptLinkSharingAsync(). | — |
ShowPromptFeedbackSubmission |
ShowPromptFeedbackSubmission(feedbackType: FeedbackType) |
Not yet | — | RobloxScriptSecurity |
ShowPromptFeedbackUnavailable |
ShowPromptFeedbackUnavailable(reason: string, feedbackType: FeedbackType) |
Not yet | — | RobloxScriptSecurity |
ShowPromptRsvpToEvent |
ShowPromptRsvpToEvent(eventId: string) |
Not yet | — | RobloxScriptSecurity |
Callbacks¶
| Member | Signature | Status | Notes | Flags |
|---|---|---|---|---|
OnCallInviteInvoked |
OnCallInviteInvoked(tag: string, callParticipantIds: Array) -> Instance |
Not yet | Callback for when a call is placed from the phone book. | — |
Roblox reference: SocialService
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.