You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/reference/engine/classes/SocialService.yaml
+35-10Lines changed: 35 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -247,17 +247,27 @@ methods:
247
247
capabilities: []
248
248
writeCapabilities: []
249
249
- 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
253
260
parameters:
254
261
- name: eventId
255
262
type: string
256
263
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).
258
267
returns:
259
268
- 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`.
261
271
tags:
262
272
- Yields
263
273
deprecation_message: ''
@@ -344,17 +354,32 @@ methods:
344
354
capabilities: []
345
355
writeCapabilities: []
346
356
- 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
350
370
parameters:
351
371
- name: eventId
352
372
type: string
353
373
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).
355
377
returns:
356
378
- 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.
0 commit comments