# This file is automatically generated. Please don't edit it manually.
# To submit a bug report on the content, see
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72

name: ExperienceInviteOptions
type: class
memory_category: Instances
summary: |
  Used to customize a player invite prompt.
description: |
  Used to customize a
  [player invite prompt](../../../production/promotion/invite-prompts.md), such
  as to customize the prompt message, target a specific connection, or include
  launch data in the invite.
code_samples: []
inherits:
  - Instance
descendants: []
tags:
  - NotReplicated
deprecation_message: ''
properties:
  - name: ExperienceInviteOptions.InviteMessageId
    summary: |
      Asset ID that maps to a **Notification** asset type.
    description: |
      Asset ID that maps to a **Notification** asset type. This asset is used to
      store/localize a custom string for the invite notification that
      connections receive. See
      [Setting Notification Options](../../../production/promotion/invite-prompts.md#setting-notification-options)
      for details.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Social
  - name: ExperienceInviteOptions.InviteUser
    summary: |
      Roblox `Class.Player.UserId|UserId` of the specific connection to invite.
    description: |
      Roblox `Class.Player.UserId|UserId` of the specific connection to invite;
      if not provided, the player will be prompted to pick from a list of
      connections.
    code_samples: []
    type: int64
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Social
  - name: ExperienceInviteOptions.LaunchData
    summary: |
      Used to set a parameter in `Class.Player:GetJoinData()` when a connection
      joins from the invite notification.
    description: |
      Used to set a parameter in `Class.Player:GetJoinData()` when a connection
      joins from the invite notification; maximum of 200 characters. See
      [Include launch data](../../../production/promotion/invite-prompts.md#include-launch-data)
      for a usage example.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Social
  - name: ExperienceInviteOptions.PromptMessage
    summary: |
      Custom text shown on the invite prompt for the sending player.
    description: |
      Custom text shown on the invite prompt for the sending player, for example
      "Ask your connections to join the adventure!" for a multi-connection
      invite prompt, or "Invite this connection to join the adventure!" for a
      specific connection invite prompt.
    code_samples: []
    type: string
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Social
methods: []
events: []
callbacks: []