Sites

Menu

CreatePlayerIdentityTokenRequest Class

Namespace: Improbable.SpatialOS.PlayerAuth.V2Alpha1

The following fields are mandatory:

Inheritance

pb::IMessage<CreatePlayerIdentityTokenRequest>

Notes

  • The remaining fields are optional:


Const Fields

ProviderFieldNumber
const int ProviderFieldNumber = 1

Field number for the "provider" field.
PlayerIdentifierFieldNumber
const int PlayerIdentifierFieldNumber = 2

Field number for the "player_identifier" field.
ProjectNameFieldNumber
const int ProjectNameFieldNumber = 3

Field number for the "project_name" field.
LifetimeDurationFieldNumber
const int LifetimeDurationFieldNumber = 4

Field number for the "lifetime_duration" field.
DisplayNameFieldNumber
const int DisplayNameFieldNumber = 5

Field number for the "display_name" field.
MetadataFieldNumber
const int MetadataFieldNumber = 6

Field number for the "metadata" field.


Static Properties

Parser
pb::MessageParser<CreatePlayerIdentityTokenRequest> Parser { get; }

Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

Provider
string Provider { get; set; }

The system used to authenticate the player with (for example) Steam or Google. This field must not be empty. The provider name cannot contain 'improbable' (case insensitive) as this is reserved for internal use.
PlayerIdentifier
string PlayerIdentifier { get; set; }

The ID of the player for whom who you are generating a PIT.

Notes:
  • This should uniquely identify a user in the specified provider. The maximum length is 64 characters.
ProjectName
string ProjectName { get; set; }

The project that the PIT is scoped to. This should be between 3 and 32 characters and made up of lower case letters, numbers and underscores only.
LifetimeDuration
global::Google.Protobuf.WellKnownTypes.Duration LifetimeDuration { get; set; }

The duration for which the issued PIT is valid.

Notes:
  • It must be set to less than or equal to 24 hours.
  • This field is optional. If unset or 0, it defaults to 24 hours.
DisplayName
string DisplayName { get; set; }

The player's display name. This field is optional.

Notes:
  • The display name is controlled by the caller and may contain personal information. It should not be stored or logged. The maximum length is 64 characters.
Metadata
pb::ByteString Metadata { get; set; }

Additional metadata that is stored within the PIT.

Notes:
  • You can use this to securely attach extra attributes on the PIT in a format you choose. For example: JSON payload: bytes("{ 'userType': 'PREMIUM', 'region': 'EU' }") It must use less than or equal to 256 bytes. Exceeding this limitation results in an error.
  • This field is optional.


Constructors

CreatePlayerIdentityTokenRequest
CreatePlayerIdentityTokenRequest()

CreatePlayerIdentityTokenRequest
CreatePlayerIdentityTokenRequest(CreatePlayerIdentityTokenRequest other)

Parameters


Methods

Clone
CreatePlayerIdentityTokenRequest Clone()

Equals
bool Equals(CreatePlayerIdentityTokenRequest other)

Parameters
WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :
CalculateSize
int CalculateSize()

MergeFrom
void MergeFrom(CreatePlayerIdentityTokenRequest other)

Parameters
MergeFrom
void MergeFrom(pb::CodedInputStream input)

Parameters
  • pb::CodedInputStream input :


Overrides

Equals
override bool Equals(object other)

Parameters
  • object other :
GetHashCode
override int GetHashCode()

ToString
override string ToString()

Search results

Was this page helpful?

Thanks for letting us know!

Thanks for your feedback

Need more help? Ask on the forums