Class AccountId

The unique identifier for a player that accesses a Vivox instance.

Inheritance

object

AccountId

Account

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VivoxUnity

Assembly: VivoxUnity.dll

Syntax

public class AccountId

Constructors

AccountId(string, string)

Create an AccountId from a URI - Internal Use Only.

Declaration

public AccountId(string uri, string displayname = null)

Parameters

Type	Name	Description
string	uri	The URI of the account.
string	displayname	Optional: The display name for an account. This string must not exceed a 63 byte length when encoded in UTF-8.

AccountId(string, string, string, string, string[], string)

Constructor

Declaration

public AccountId(string issuer, string name, string domain, string displayname = null, string[] spokenLanguages = null, string environmentId = null)

Parameters

Type	Name	Description
string	issuer	The issuer that is responsible for authenticating this account.
string	name	The name you assign to the player.
string	domain	The Vivox domain that provides service for this account. For example: vfd.vivox.com.
string	displayname	Optional: The display name for an account. This string must not exceed a 63 byte length when encoded in UTF-8.
string[]	spokenLanguages	An optional array of languages used as hints for audio transcription. The default is an empty array, which implies "en".
string	environmentId

Remarks

You can specify up to three spoken languages in order of preference to inform transcription of all users in transcribed channels. IETF language tag strings are not validated, but are expected to conform to BCP 47. The total length of '.{issuer}.{name}.' must be less than 63 characters, and can only use the letters a-z, the numbers 0-9, and the special characters: =+-_.!~()%

Fields

_accountNameMaxLength

Declaration

public const int _accountNameMaxLength = 127

Field Value

Type	Description
int

Properties

DisplayName

The name you assign to the player for display purposes. If a name is not set, then Name is returned.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

Domain

This is a value that your developer support representative provides. It is subject to change if a different server-determined destination is provided during client connector creation.

Declaration

public string Domain { get; }

Property Value

Type	Description
string

IsEmpty

This is true if the Name, Domain, and Issuer are empty.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
bool

Issuer

The issuer assigned to your game.

Declaration

public string Issuer { get; }

Property Value

Type	Description
string

Name

The name you assign to the player.

Declaration

public string Name { get; }

Property Value

Type	Description
string

SpokenLanguages

An optional array of languages used as hints for audio transcription. The default is an empty array, which implies "en". You can specify up to three spoken languages in order of preference to inform transcription of all users in transcribed channels. IETF language tag strings are not validated, but are expected to conform to BCP 47.

Declaration

public string[] SpokenLanguages { get; }

Property Value

Type	Description
string[]

Methods

Equals(object)

Determine if two objects are equal.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The other object.

Returns

Type	Description
bool	True if the objects are of equal value.

Overrides

object.Equals(object)

GetHashCode()

A hash function for AccountId.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

IsNullOrEmpty(AccountId)

A test for an empty AccountId.

Declaration

public static bool IsNullOrEmpty(AccountId id)

Parameters

Type	Name	Description
AccountId	id	The account ID.

Returns

Type	Description
bool	True if the ID is null or empty.

ToString()

The network representation of the account ID.

Declaration

public override string ToString()

Returns

Type	Description
string	A URI for this account.

Overrides

object.ToString()

Remarks

Note: This will be refactored in the future so the internal network representation of the AccountId is hidden.