V2Alpha1.PlayerIdentityToken Class

Namespace: Improbable.SpatialOS.PlayerAuth

Inheritance

pb::IMessage<PlayerIdentityToken>


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.

DisplayNameFieldNumber
const int DisplayNameFieldNumber = 5

Field number for the "display_name" field.

MetadataFieldNumber
const int MetadataFieldNumber = 6

Field number for the "metadata" field.

IssuedAtTimeFieldNumber
const int IssuedAtTimeFieldNumber = 7

Field number for the "issued_at_time" field.

ExpiryTimeFieldNumber
const int ExpiryTimeFieldNumber = 8

Field number for the "expiry_time" field.


Static Properties

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


Descriptor
pbr::MessageDescriptor Descriptor { get; }


Properties

Provider
string Provider { get; set; }

The system that was used to authenticate the player with, for example Steam or Google.

Notes:
  • This corresponds to the prvdr claim in the JWT. This field is exposed to workers through the Player Connection Entity.

PlayerIdentifier
string PlayerIdentifier { get; set; }

The ID of the player.

Notes:
  • This should uniquely identify a user in the specified provider. This corresponds to the sub claim in the JWT. This field is exposed to workers through the Player Connection Entity.

ProjectName
string ProjectName { get; set; }

The project that the PIT is scoped to.

Notes:
  • This corresponds to the prj claim in the JWT.

DisplayName
string DisplayName { get; set; }

The player's display name.

Notes:
  • This corresponds to the dn claim in the JWT.

Metadata
pb::ByteString Metadata { get; set; }

Additional metadata that is stored within the PIT.

Notes:
  • This corresponds to the md claim in the JWT. This field is exposed to workers through the Player Connection Entity.

IssuedAtTime
global::Google.Protobuf.WellKnownTypes.Timestamp IssuedAtTime { get; set; }

Time at which the PIT was issued.

Notes:
  • This corresponds to the iat claim in the JWT.

ExpiryTime
global::Google.Protobuf.WellKnownTypes.Timestamp ExpiryTime { get; set; }

Time at which the PIT expires.

Notes:
  • This corresponds to the exp claim in the JWT.


Constructors

PlayerIdentityToken
PlayerIdentityToken()


PlayerIdentityToken
PlayerIdentityToken(PlayerIdentityToken other)

Parameters


Methods

Clone
PlayerIdentityToken Clone()


Equals
bool Equals(PlayerIdentityToken other)

Parameters

WriteTo
void WriteTo(pb::CodedOutputStream output)

Parameters
  • pb::CodedOutputStream output :

CalculateSize
int CalculateSize()


MergeFrom
void MergeFrom(PlayerIdentityToken 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()

Updated about a year ago


V2Alpha1.PlayerIdentityToken Class


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.