SocialService

SocialService
Not creatableThis class cannot be instantiated. ServiceThis class is a service. Not replicatedThis class is not replicated.
Icon
Added in	370 (January 2019)
Memory category	Instances
Inheritance
Object Instance SocialService

The SocialService class, removed on March 16, 2017, and added again on January 28, 2019, inherits from Instance. It allows users to invite their friends in-game via an invite menu.

Methods

CanSendCallInviteAsync(player: Instance): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
player	Instance

• Thread safety: unsafe

CanSendGameInviteAsync(player: Instance, recipientId: int64 = 0): bool

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
player	Instance
recipientId	int64	0

Returns whether or not the targeted player can send invites (their privacy settings allow it).

• Thread safety: unsafe

GetEventRsvpStatusAsync(eventId: string): RsvpStatus

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
eventId	string

• Thread safety: unsafe

GetExperienceEventAsync(eventId: string): Dictionary?

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
eventId	string

• Thread safety: unsafe

GetPartyAsync(partyId: string): Array

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
partyId	string

• Thread safety: unsafe

GetPlayersByPartyId(partyId: string): Instances

Parameters

Name	Type
partyId	string

• Thread safety: unsafe

GetUpcomingExperienceEventsAsync(): Array

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:SocialService/GetUpcomingExperienceEventsAsync.

• Thread safety: unsafe

HideSelfView(): null

This class member is missing documentation. Create or add to its subpage at Class:SocialService/HideSelfView.

• Thread safety: unsafe

InvokeGameInvitePromptClosed(player: Instance, recipientIds: Array): null

Parameters

Name	Type
player	Instance
recipientIds	Array

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

InvokeIrisInvite(player: Instance, tag: string, irisParticipants: Array): null

Parameters

Name	Type
player	Instance
tag	string
irisParticipants	Array

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

InvokeIrisInvitePromptClosed(player: Instance): null

Parameters

Name	Type
player	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

InvokeShareSheetClosed(): null

This class member is missing documentation. Create or add to its subpage at Class:SocialService/InvokeShareSheetClosed.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptFeedbackSubmissionAsync(): null

• YieldsThis function can yield the script it is used in.

This class member is missing documentation. Create or add to its subpage at Class:SocialService/PromptFeedbackSubmissionAsync.

• Thread safety: unsafe

PromptGameInvite(player: Instance, experienceInviteOptions: Instance = nil): null

Parameters

Name	Type	Default
player	Instance
experienceInviteOptions	Instance	nil

• Thread safety: unsafe

PromptLinkSharing(player: Player, options: Dictionary = nil): Tuple

• YieldsThis function can yield the script it is used in.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type	Default
player	Player
options	Dictionary	nil

• Thread safety: unsafe

PromptLinkSharingAsync(player: Player, options: Dictionary = nil): Tuple

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type	Default
player	Player
options	Dictionary	nil

• Thread safety: unsafe

PromptPhoneBook(player: Instance, tag: string): null

Parameters

Name	Type
player	Instance
tag	string

• Thread safety: unsafe

PromptRsvpToEventAsync(eventId: string): RsvpStatus

• YieldsThis function can yield the script it is used in.

Parameters

Name	Type
eventId	string

• Thread safety: unsafe

PromptRsvpToEventCompleted(eventId: string, success: bool, rsvpStatus: RsvpStatus, previousRsvpStatus: RsvpStatus = None): null

Parameters

Name	Type	Default
eventId	string
success	bool
rsvpStatus	RsvpStatus
previousRsvpStatus	RsvpStatus	None

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ShowSelfView(selfViewPosition: SelfViewPosition = LastPosition): null

Parameters

Name	Type	Default
selfViewPosition	SelfViewPosition	LastPosition

• Thread safety: unsafe

SignalFeedbackSubmissionCompleted(feedback: string): null

Parameters

Name	Type
feedback	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SignalFeedbackSubmissionPermissionDenied(): null

This class member is missing documentation. Create or add to its subpage at Class:SocialService/SignalFeedbackSubmissionPermissionDenied.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

UpdatePlayerPartyData(partyId: string): null

Parameters

Name	Type
partyId	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Events

CallInviteStateChanged(player: Instance, inviteState: InviteState)

Parameters

Name	Type
player	Instance
inviteState	InviteState

• Thread safety: unsafe

GameInvitePromptClosed(player: Instance, recipientIds: Array)

Parameters

Name	Type
player	Instance
recipientIds	Array

• Thread safety: unsafe

OpenShareSheetWithLink(link: string)

Parameters

Name	Type
link	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PhoneBookPromptClosed(player: Instance)

Parameters

Name	Type
player	Instance

• Thread safety: unsafe

PlayerPartyDataChanged(partyId: string)

Parameters

Name	Type
partyId	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptInviteRequested(player: Instance, experienceInviteOptions: Instance)

Parameters

Name	Type
player	Instance
experienceInviteOptions	Instance

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

PromptIrisInviteRequested(player: Instance, tag: string)

Parameters

Name	Type
player	Instance
tag	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SelfViewHidden()

This class member is missing documentation. Create or add to its subpage at Class:SocialService/SelfViewHidden.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

SelfViewVisible(selfViewPosition: SelfViewPosition)

Parameters

Name	Type
selfViewPosition	SelfViewPosition

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ShareSheetClosed(player: Player)

Parameters

Name	Type
player	Player

• Thread safety: unsafe

ShowPromptFeedbackSubmission()

This class member is missing documentation. Create or add to its subpage at Class:SocialService/ShowPromptFeedbackSubmission.

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ShowPromptFeedbackUnavailable(reason: string)

Parameters

Name	Type
reason	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

ShowPromptRsvpToEvent(eventId: string)

Parameters

Name	Type
eventId	string

• Security: RobloxScriptSecurity.
• Thread safety: unsafe

Callbacks

OnCallInviteInvoked(tag: string, callParticipantIds: Array): Instance

Parameters

Name	Type
tag	string
callParticipantIds	Array

• Thread safety: unsafe

Removed members

Methods

• CanSendIrisInviteAsync
• PromptIrisInvite

Events

• IrisInvitePromptClosed

Callbacks

• OnIrisInviteInvoked

External links

• SocialService in the Roblox API Reference