SocialService

Methods

HideSelfView():void
Hides the calling player's self view.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):void
Prompts the given Player with the invite screen.
PromptPhoneBook(player : Instance,tag : string):void
Prompts the given Player with the phone book.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):void
Shows the calling player's self view.
CanSendCallInviteAsync(player : Instance):bool
Yields
Indicates whether the given Player can invite other players to a call.
CanSendGameInviteAsync(player : Instance,recipientId : number):bool
Yields
Indicates whether the given Player can invite other players.

Events

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Fires when a player's call invite state changes.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Fires when a player closes an invite prompt.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Fires when a player closes the phone book prompt.

Callbacks

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

Properties

Methods

HideSelfView

void

Hides the calling player's self view. If this method is called while the self view is already hidden, it does nothing.

Returns

void

PromptGameInvite

void

PromptGameInvite() displays an invite prompt to the local player through which they may invite their friends to the current experience. Before calling this method, you should use CanSendGameInviteAsync() to determine whether the player can send an invite, as this ability may vary depending on the platform or player.

See Player Invite Prompts for more details on implementing invite prompts, customizing prompts and notifications, and using launch data.

Parameters

player: Instance

The Player to prompt with the invite popup.

experienceInviteOptions: Instance

Optional ExperienceInviteOptions object for customizing the prompt.

Default Value: "nil"

Returns

void

Code Samples

Sending an Invite

local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- Function to check whether the player can send an invite
local function canSendGameInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendGameInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canInvite = canSendGameInvite(player)
if canInvite then
	SocialService:PromptGameInvite(player)
end

PromptPhoneBook

void

Prompts the given Player with the phone book. If the player chooses to call someone, the CallInviteStateChanged event fires. You should use CanSendCallInviteAsync() prior to calling PromptPhoneBook() since the ability to see the phone book may vary depending on the player.

If a player is not eligible to open the phone book, an error dialog is shown.

See Roblox Connect for a sample implementation of this method.

Parameters

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.

Returns

void

Code Samples

SocialService:PromptPhoneBook()

local Players = game:GetService("Players")
local SocialService = game:GetService("SocialService")

local player = Players.LocalPlayer
local button = script.Parent
button.Visible = false

-- Function to check whether the player can send a call invite
local function canSendCallingInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendCallInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canCall = canSendCallingInvite(player)
if canCall then
	button.Visible = true
	button.Activated:Connect(function()
		SocialService:PromptPhoneBook(player, "")
	end)
end

ShowSelfView

void

Shows the calling player's self view. If this method is called while the self view is already visible, it does nothing.

Parameters

selfViewPosition: Enum.SelfViewPosition

The position to place the self view .

Default Value: "LastPosition"

Returns

void

CanSendCallInviteAsync

Yields

Returns true if the given Player can send a call invite to a friend. You should always use the result of this method before calling PromptPhoneBook() since the ability to open the phone book may vary depending on the player.

See Roblox Connect for a sample implementation of this method.

Parameters

player: Instance

The Player instance of the player potentially sending a call invite.

Returns

Whether the specified player can send a call invite.

Code Samples

SocialService:PromptPhoneBook()

local Players = game:GetService("Players")
local SocialService = game:GetService("SocialService")

local player = Players.LocalPlayer
local button = script.Parent
button.Visible = false

-- Function to check whether the player can send a call invite
local function canSendCallingInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendCallInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canCall = canSendCallingInvite(player)
if canCall then
	button.Visible = true
	button.Activated:Connect(function()
		SocialService:PromptPhoneBook(player, "")
	end)
end

CanSendGameInviteAsync

Yields

CanSendGameInviteAsync() returns true if the given Player can invite other players to the current experience. You should always use the result of this method before calling PromptGameInvite() since the ability to invite players may vary depending on the platform or player.

See Player Invite Prompts for more details on implementing player invite prompts, customizing prompts and notifications, and using launch data.

Parameters

player: Instance

The Player instance of the player potentially sending an invite.

recipientId: number

Optional Player.UserId of the potential recipient, used to check whether the sender can invite that specific recipient.

Default Value: 0

Returns

Whether the specified player can send an invite.

Code Samples

Sending an Invite

local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")

local player = Players.LocalPlayer

-- Function to check whether the player can send an invite
local function canSendGameInvite(sendingPlayer)
	local success, canSend = pcall(function()
		return SocialService:CanSendGameInviteAsync(sendingPlayer)
	end)
	return success and canSend
end

local canInvite = canSendGameInvite(player)
if canInvite then
	SocialService:PromptGameInvite(player)
end

Events

CallInviteStateChanged

This event fires when a player's call invite state changes.

Parameters

player: Instance

The Player instance of the player who had a call invite state change.

inviteState: Enum.InviteState

The new call invite state.

Code Samples

SocialService.CallInviteStateChanged

local SocialService = game:GetService("SocialService")

local button = script.Parent
local isPhonebookOpen = false

SocialService.CallInviteStateChanged:Connect(function(_, inviteState)
	local isCalling = inviteState == Enum.InviteState.Placed

	if isCalling or isPhonebookOpen then
		button.Visible = false
	else
		button.Visible = true
	end
end)

GameInvitePromptClosed

This event fires when a player closes an invite prompt.

Parameters

player: Instance

The Player instance of the player who closed the prompt.

recipientIds: Array

No longer populated; an empty array.

PhoneBookPromptClosed

Fires when a player closes the phone book prompt.

Parameters

player: Instance

The Player instance of the player who closed the phone book.