Show / Hide Table of Contents

Class MetadataItem

A base implementation of the interface user objects must implement in order to work with the Roster client.

Inheritance
object
PropertyObject
MetadataItem
Implements
IMetadataItem
IPropertyObject
IVerifiable
Inherited Members
PropertyObject.RosterProperties
PropertyObject.GetList(string)
PropertyObject.GetString(string)
object.Equals(object, object)
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Microsoft.XboxStudios.SQTech.Roster
Assembly: Microsoft.XboxStudios.SQTech.Roster.Common.dll
Syntax
public class MetadataItem : PropertyObject, IMetadataItem, IPropertyObject, IVerifiable

Fields

View Source

Empty

Represents an empty or unset version of this object.

Declaration
public static readonly MetadataItem Empty
Field Value
Type Description
MetadataItem

Properties

View Source

MetadataContainer

Gets or sets the container name.

Declaration
public string MetadataContainer { get; set; }
Property Value
Type Description
string
View Source

MetadataDatabaseVersion

Gets the database version of the item.

Declaration
public Guid MetadataDatabaseVersion { get; }
Property Value
Type Description
Guid
View Source

MetadataItemContext

Gets the context of the data.

Declaration
public IMetadataItemContext MetadataItemContext { get; }
Property Value
Type Description
IMetadataItemContext
View Source

MetadataName

Gets or sets the name of the item.

Declaration
public string MetadataName { get; set; }
Property Value
Type Description
string
View Source

MetadataVersion

Gets or sets the version of the item.

Declaration
public string MetadataVersion { get; set; }
Property Value
Type Description
string

Methods

View Source

Equals(object?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.

Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.

Overrides
PropertyObject.Equals(object?)
View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.

Overrides
PropertyObject.GetHashCode()
View Source

IsEmpty()

Determines if the object is equal to its 'Empty' value.

Declaration
public virtual bool IsEmpty()
Returns
Type Description
bool

True if the object is equal to its 'Empty' value. Otherwise, false.

View Source

IsValid()

Determines if an object is in a valid state.

Declaration
public virtual bool IsValid()
Returns
Type Description
bool

True if the object is valid. Otherwise, false.

Implements

IMetadataItem
IPropertyObject
IVerifiable
  • View Source
In this article
Back to top Generated by DocFX