Class LoginOptions

The options used to control Login behaviour - like enabling Text to Speech, setting a display name, or loading a blocked user list

Inheritance

object

LoginOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Unity.Services.Vivox

Assembly: solution.dll

Syntax

public sealed class LoginOptions

Properties

Name	Description
BlockedUserList	A list of Account identifiers to be blocked immediately upon login.
DisplayName	The DisplayName used by the LoginSession. This is not intended to be the unique ID of a user.
EnableTTS	Whether or not to enable Text-to-Speech for this account - disabling it will prevent Text-to-Speech messages from being sent or received.
ParticipantUpdateFrequency	How frequently you would like to receieve participant updates events for all channels.
PlayerId	An override for a player's unique identifier that is only applied when the Authentication SDK is not in use. By default, the local user is signed into Vivox using either a generated GUID or the Authentication service's PlayerId if that SDK is being used in a project. Only a generated GUID can be overridden when using this property.