Skip to content
Roblox API Reference

SocialService

Facilitates social functions that impact relationships made on the Roblox platform.
  • Not creatable
  • Not replicated
  • Service
Memory category
Instances
Own members
38
Inherited members
75
Subclasses
0
Siblings
608

Properties23

Inherited fromObject2

Property categoryData

Inherited fromInstance21

Property categoryBehavior

Property categoryData

Property categoryPermissions

Methods65

Inherited fromObject3
  • Object:GetPropertyChangedSignal(property: string): RBXScriptSignal
    Get an event that fires when a given property of the object changes.
    Parameters
    ParameterDescription
    property: string
    The property to connect to.
    Returns
    TypeDescription
    RBXScriptSignal
    A signal that fires whenever the property changes.
  • Object:IsA(className: string): boolean
    Returns true if an object's class matches or inherits from a given class.
    • Custom Lua state
    • Thread safe
    Parameters
    ParameterDescription
    className: string
    The class against which the Object's class will be checked. Case-sensitive.
    Returns
    TypeDescription
    boolean
    Describes whether the Object's class matched or is a subclass of the given class.
  • Object:isA(className: string): boolean
    Deprecated: This deprecated function is a variant of Object:IsA() which should be used instead.
    • Deprecated
    • Custom Lua state
    Parameters
    Parameter
    className: string
    Returns
    Type
    boolean

    Use IsA instead.

Inherited fromInstance39
Defined bySocialService23
  • SocialService:CanSendCallInviteAsync(player: Instance): boolean
    Indicates whether the given Player can invite other players to a call.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Instance
    The Player instance of the player potentially sending a call invite.
    Returns
    TypeDescription
    boolean
    Whether the specified player can send a call invite.
  • SocialService:CanSendGameInviteAsync(player: Instance,recipientId: User? = U1.AQAAAAAAAAAAAAAAAAAAAAA,): boolean
    Indicates whether the given Player can invite other players.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Instance
    The Player instance of the player potentially sending an invite.
    recipientId: User? = U1.AQAAAAAAAAAAAAAAAAAAAAA
    Optional Player.UserId of the potential recipient, used to check whether the sender can invite that specific recipient.
    Returns
    TypeDescription
    boolean
    Whether the specified player can send an invite.
  • SocialService:GetEventRsvpStatusAsync(eventId: string): Enum.RsvpStatus
    Returns the local player's RSVP status for the given event.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    eventId: string
    The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number).
    Returns
    TypeDescription
    Enum.RsvpStatus
    Returns an RsvpStatus indicating the player's current RSVP status for the event. If the player has not RSVP'd to the event, this will return RsvpStatus.None.
  • SocialService:GetExperienceEventAsync(eventId: string): { [string]: any }?
    Returns details for the specified experience event or nil if it is unavailable.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    eventId: string
    The string identifier of the event to retrieve. Must correspond to an event in the current experience.
    Returns
    TypeDescription
    { [string]: any }?
    A dictionary describing the event, or nil if the event does not exist, belongs to another experience, or is otherwise unavailable.
  • SocialService:GetPartyAsync(partyId: string): { any }
    Returns an array of dictionaries containing data for all members of the specified party who are currently in the experience.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    partyId: string
    The unique identifier of the party to retrieve member data for, corresponding to a Player.PartyId value.
    Returns
    TypeDescription
    { any }
    An array of dictionaries representing the members of the specified party who are currently in the experience.
  • SocialService:GetPlayersByPartyId(partyId: string): { Instance }
    Returns a table of all presently connected Player objects whose Player.PartyId property matches the passed partyId.
    • Capabilities: Social
    Parameters
    ParameterDescription
    partyId: string
    The unique identifier of the party to filter players by, corresponding to a Player.PartyId value.
    Returns
    TypeDescription
    { Instance }
    A table of Player objects whose Player.PartyId property matches the passed partyId.
  • SocialService:GetUpcomingExperienceEventsAsync(): { any }
    Returns active and upcoming experience events for the current experience.
    • Yields
    • Capabilities: Social
    Returns
    TypeDescription
    { any }
    An array of dictionaries describing each active or upcoming event in the current experience, ordered by soonest start time first.
  • SocialService:HideSelfView()
    Hides the calling player's self view.
    • Capabilities: Social
  • SocialService:InvokeGameInvitePromptClosed(player: Instance,recipientIds: { any },)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    player: Instance
    recipientIds: { any }
  • SocialService:InvokeIrisInvite(player: Instance,tag: string,irisParticipants: { any },)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    player: Instance
    tag: string
    irisParticipants: { any }
  • SocialService:InvokeIrisInvitePromptClosed(player: Instance)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    player: Instance
  • SocialService:InvokeShareSheetClosed()
    • Roblox script security
    • Capabilities: Social
  • SocialService:PromptFeedbackSubmissionAsync(options: { [string]: any }?)
    Prompts the player to submit feedback or a player support ticket about the current experience.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    options: { [string]: any }?
    Optional Dictionary configuring the prompt. Supported keys: - FeedbackType (FeedbackType). Selects which feedback flow to display. Defaults to FeedbackType.Feedback.
  • SocialService:PromptGameInvite(player: Instance,experienceInviteOptions: Instance? = nil,)
    Prompts the given Player with the invite screen.
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Instance
    The Player to prompt with the invite popup.
    experienceInviteOptions: Instance? = nil
    Optional ExperienceInviteOptions object for customizing the prompt.
  • SocialService:PromptLinkSharingAsync(player: Player,options: { [string]: any }? = nil,): ...any
    Generates an expiring share link and prompts the given Player with the platform share sheet.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Player
    Prompts the given Player with a Roblox platform-level share sheet with a generated share link.
    options: { [string]: any }? = nil
    Dictionary that specifies the configuration for the generated link. It includes the following optional key-value pairs:
    • FallbackLinkId (string). Determines how this share link will direct player to once expired. Default to experience join link.
    • ExpirationSeconds (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
    • PreviewTitle (string) Preview title of the share link.
    • PreviewDescription (string) Preview description of the share link.
    • PreviewAssetId (number) Image asset ID used for share link preview.
    • LaunchData (string). Used to set a parameter in Player:GetJoinData() when a player joined using the generated share link.
    Returns
    TypeDescription
    ...any
    A tuple containing an PromptLinkSharingResult indicating the result of the link sharing prompt.
  • SocialService:PromptPhoneBook(player: Instance, tag: string)
    Prompts the given Player with the phone book.
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Instance
    The player to prompt with the phone book.
    tag: string
    String to help differentiate between various phone book "entry points" or similar. For example, you can pass a string defining what region of an experience the calling player's character is currently in.
  • SocialService:PromptRsvpToEventAsync(eventId: string): Enum.RsvpStatus
    Prompts the local Player with a prompt to change their RSVP status to the given event.
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    eventId: string
    The event ID of the event to prompt the player to change their RSVP status for. This must be a valid event ID that exists in the current experience, represented as a string (not a number).
    Returns
    TypeDescription
    Enum.RsvpStatus
    Returns a RsvpStatus indicating the player's new RSVP status after the prompt is closed. If the player closes the prompt without changing their RSVP status, this will return RsvpStatus.None or their old RsvpStatus if they had already selected a status.
  • SocialService:PromptRsvpToEventCompleted(eventId: string,success: boolean,rsvpStatus: Enum.RsvpStatus,previousRsvpStatus: Enum.RsvpStatus? = Enum.RsvpStatus.None,)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    eventId: string
    success: boolean
    rsvpStatus: Enum.RsvpStatus
    previousRsvpStatus: Enum.RsvpStatus? = Enum.RsvpStatus.None
  • SocialService:ShowSelfView(selfViewPosition: Enum.SelfViewPosition? = Enum.SelfViewPosition.LastPosition)
    Shows the calling player's self view.
    • Capabilities: Social
    Parameters
    ParameterDescription
    selfViewPosition: Enum.SelfViewPosition? = Enum.SelfViewPosition.LastPosition
    The position to place the self view .
  • SocialService:SignalFeedbackSubmissionCompleted(feedback: string,options: { [string]: any }?,)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    feedback: string
    options: { [string]: any }?
  • SocialService:SignalFeedbackSubmissionPermissionDenied()
    • Roblox script security
    • Capabilities: Social
  • SocialService:UpdatePlayerPartyData(partyId: string)
    • Roblox script security
    • Capabilities: Social
    Parameters
    Parameter
    partyId: string
  • SocialService:PromptLinkSharing(player: Player,options: { [string]: any }? = nil,): ...any
    Deprecated: Use PromptLinkSharingAsync() instead.
    • Deprecated
    • Yields
    • Capabilities: Social
    Parameters
    ParameterDescription
    player: Player
    Prompts the given Player with a Roblox platform-level share sheet with a generated share link.
    options: { [string]: any }? = nil
    Dictionary that specifies the configuration for the generated link. It includes the following optional key-value pairs:
    • FallbackLinkId (string). Determines how this share link will direct player to once expired. Default to experience join link.
    • ExpirationSeconds (number). Determines time to expiration once the share link is created. Truncates to nearest integer. Defaults to 86,400.
    • PreviewTitle (string) Preview title of the share link.
    • PreviewDescription (string) Preview description of the share link.
    • PreviewAssetId (number) Image asset ID used for share link preview.
    • LaunchData (string). Used to set a parameter in Player:GetJoinData() when a player joined using the generated share link.
    Returns
    TypeDescription
    ...any
    A tuple containing an PromptLinkSharingResult indicating the result of the link sharing prompt.

    Use PromptLinkSharingAsync instead.

Events24

Inherited fromObject1
Inherited fromInstance9
Defined bySocialService14

Callbacks1

Defined bySocialService1
  • SocialService.OnCallInviteInvoked: (tag: string,callParticipantIds: { any },) -> Instance
    Callback for when a call is placed from the phone book.
    • Capabilities: Social
    Parameters
    ParameterDescription
    tag: string
    String to help differentiate between various phone book entry points.
    callParticipantIds: { any }
    Array containing all of the players involved in the call. The caller will always be the first player in the array.
    Returns
    TypeDescription
    Instance
    Table including the PlaceId and ReservedServerAccessCode keys whose values are the DataModel.PlaceId and the server access code returned by TeleportService:ReserveServerAsync(), respectively.