Skip to content

Commit df0ee9e

Browse files
update Open Source Docs from Roblox internal teams
1 parent 26e2e4c commit df0ee9e

File tree

1 file changed

+35
-10
lines changed

1 file changed

+35
-10
lines changed

content/en-us/reference/engine/classes/SocialService.yaml

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -247,17 +247,27 @@ methods:
247247
capabilities: []
248248
writeCapabilities: []
249249
- name: SocialService:GetEventRsvpStatusAsync
250-
summary: ''
251-
description: ''
252-
code_samples: []
250+
summary: |
251+
Returns the local player's RSVP status for the given event.
252+
description: |
253+
Returns the local player's RSVP status for the given event. Events must be in the current experience and
254+
must not have already started. If the event has already started, this method will return an error.
255+
256+
Note that you can use `Class.SocialService:PromptRsvpToEventAsync()|PromptRsvpToEventAsync()` to
257+
prompt the player to change their RSVP status for the event.
258+
code_samples:
259+
- SocialService-PromptRsvpToEventAsync
253260
parameters:
254261
- name: eventId
255262
type: string
256263
default: ''
257-
summary: ''
264+
summary: |
265+
The event ID of the event to prompt the player to change their RSVP status for. This must be a valid
266+
event ID that exists in the current experience, represented as a string (not a number).
258267
returns:
259268
- type: RsvpStatus
260-
summary: ''
269+
summary: |
270+
Returns an `Enum.RsvpStatus` indicating the player's current RSVP status for the event. If the player has not RSVP'd to the event, this will return `Enum.RsvpStatus.None`.
261271
tags:
262272
- Yields
263273
deprecation_message: ''
@@ -344,17 +354,32 @@ methods:
344354
capabilities: []
345355
writeCapabilities: []
346356
- name: SocialService:PromptRsvpToEventAsync
347-
summary: ''
348-
description: ''
349-
code_samples: []
357+
summary: |
358+
Prompts the local `Class.Player` with a prompt to change their RSVP status to the given event.
359+
description: |
360+
`PromptRsvpToEventAsync()` displays a prompt to the local player through which they may change
361+
their RSVP status to the given event.
362+
363+
Events must be in the current experience and must not have already started. If the event has already
364+
started, this method will return an error.
365+
366+
Note that you can use `Class.SocialService:GetEventRsvpStatusAsync()|GetEventRsvpStatusAsync()`
367+
to check the player's current RSVP status before calling this method.
368+
code_samples:
369+
- SocialService-PromptRsvpToEventAsync
350370
parameters:
351371
- name: eventId
352372
type: string
353373
default: ''
354-
summary: ''
374+
summary: |
375+
The event ID of the event to prompt the player to change their RSVP status for. This must be a valid
376+
event ID that exists in the current experience, represented as a string (not a number).
355377
returns:
356378
- type: RsvpStatus
357-
summary: ''
379+
summary: |
380+
Returns a `Enum.RsvpStatus` indicating the player's new RSVP status after the prompt is closed. If the
381+
player closes the prompt without changing their RSVP status, this will return `Enum.RsvpStatus.None`
382+
or their old `Enum.RsvpStatus` if they had already selected a status.
358383
tags:
359384
- Yields
360385
deprecation_message: ''

0 commit comments

Comments
 (0)