Class RosterPrincipal

This is intended to allow returning RosterPrincipal.Empty instead of null.

Inheritance

object

RosterPrincipal

Implements

IRosterPrincipal

IRosterIdentity

IVerifiable

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Microsoft.GNS.Roster.Internal

Assembly: Microsoft.GNS.Roster.Internal.dll

Syntax

public class RosterPrincipal : IRosterPrincipal, IRosterIdentity, IVerifiable

Fields

Empty

Represents an empty or unset version of this object.

Declaration

public static readonly RosterPrincipal Empty

Field Value

Type	Description
RosterPrincipal

Properties

Container

Gets or sets the object container. Container names are case sensitive.

Declaration

public string Container { get; set; }

Property Value

Type	Description
string

DisplayName

Gets or sets the display name.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
string

Id

Gets the object Id.

Declaration

public Guid Id { get; }

Property Value

Type	Description
Guid

Name

Gets or sets the object name. Names are case sensitive.

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

PrincipalName

Gets the unique Id for the principal.

Declaration

public string PrincipalName { get; }

Property Value

Type	Description
string

Scope

Gets information about the scope of the object.

Declaration

public Scope Scope { get; }

Property Value

Type	Description
Scope

Methods

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

object.Equals(object)

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

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.

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

IRosterPrincipal

IRosterIdentity

IVerifiable