Class DataObject

Custom data property for a lobby.

Inheritance

object

DataObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Lobbies.Models

Assembly: Unity.Services.Lobbies.dll

Syntax

[Preserve]
[DataContract(Name = "DataObject")]
public class DataObject

Constructors

DataObject(VisibilityOptions, string, IndexOptions)

Custom data property for a lobby.

Declaration

[Preserve]
public DataObject(DataObject.VisibilityOptions visibility, string value = null, DataObject.IndexOptions index = (DataObject.IndexOptions)0)

Parameters

Type	Name	Description
DataObject.VisibilityOptions	visibility	Indicates for whom the property should be visible. If public, the property will be visible to everyone and will be included in query results. If member, the data will only be visible to users who are members of the lobby (i.e. those who have successfully joined). If private, the metadata will only be visible to the host.
string	value	The value of the custom property. This property can be set to null or an empty string. If this property is indexed (by setting the index field) then the length of the value must be less than 128 bytes.
DataObject.IndexOptions	index	The name of the column to index this property value under, either S# for strings or N# for numeric values. If an index is specified on a property, then you can use that index name in a QueryFilter to filter results by that property. You will not be prevented from indexing multiple objects having properties with different names but the same index, but you will likely receive unexpected results from a query.

Properties

Index

The name of the column to index this property value under, either S# for strings or N# for numeric values. If an index is specified on a property, then you can use that index name in a QueryFilter to filter results by that property. You will not be prevented from indexing multiple objects having properties with different names but the same index, but you will likely receive unexpected results from a query.

Declaration

[Preserve]
[JsonConverter(typeof(StringEnumConverter))]
[DataMember(Name = "index", EmitDefaultValue = false)]
public DataObject.IndexOptions Index { get; }

Property Value

Type	Description
DataObject.IndexOptions

Value

The value of the custom property. This property can be set to null or an empty string. If this property is indexed (by setting the index field) then the length of the value must be less than 128 bytes.

Declaration

[Preserve]
[DataMember(Name = "value", EmitDefaultValue = false)]
public string Value { get; }

Property Value

Type	Description
string

Visibility

Indicates for whom the property should be visible. If public, the property will be visible to everyone and will be included in query results. If member, the data will only be visible to users who are members of the lobby (i.e. those who have successfully joined). If private, the metadata will only be visible to the host.

Declaration

[Preserve]
[JsonConverter(typeof(StringEnumConverter))]
[DataMember(Name = "visibility", IsRequired = true, EmitDefaultValue = true)]
public DataObject.VisibilityOptions Visibility { get; }

Property Value

Type	Description
DataObject.VisibilityOptions