Edit

Share via

PartyInvitationConfiguration

  • Article

Invitation configuration data.

Syntax

struct PartyInvitationConfiguration {  
    PartyString identifier;  
    PartyInvitationRevocability revocability;  
    uint32_t entityIdCount;  
    const PartyString* entityIds;  
}

Members

identifier   PartyString
may be nullptr

The identifier of the invitation.

This value may only be nullptr when used as input to PartyManager::CreateNewNetwork() or PartyNetwork::CreateInvitation().

The length of this string must be less than or equal to c_maxInvitationIdentifierStringLength.

revocability   PartyInvitationRevocability

The revocability of the invitation.

entityIdCount   uint32_t

The number of PlayFab Entity IDs that the invitation allows to authenticate into the network.

If this value is 0, all users are allowed to authenticate using the invitation's identifier.

This value must be less than or equal to c_maxInvitationEntityIdCount.

entityIds   const PartyString*
array of size entityIdCount

The list of PlayFab Entity IDs that the invitation allows to authenticate into the network.

If this list is empty, all users are allowed to authenticate using the invitation's identifier.

Requirements

Header: Party.h

See also

Party members
PartyInvitation
PartyInvitationRevocability
PartyManager::CreateNewNetwork
PartyNetwork::CreateInvitation
PartyInvitation::GetInvitationConfiguration