Show / Hide Table of Contents

Class RosterPrincipal

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

Inheritance
System.Object
RosterPrincipal
Implements
IRosterPrincipal
IRosterIdentity
IVerifiable
Namespace: Microsoft.GNS.Roster.Internal
Assembly: Microsoft.GNS.Roster.Internal.dll
Syntax
public class RosterPrincipal : object, IRosterPrincipal, IRosterIdentity, IVerifiable

Fields

View Source

Empty

Represents an empty or unset version of this object.

Declaration
public static readonly RosterPrincipal Empty
Field Value
Type Description
RosterPrincipal

Properties

View Source

Container

Declaration
public string Container { get; set; }
Property Value
Type Description
System.String
View Source

DisplayName

Gets or sets the display name.

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String
View Source

Id

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

Name

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String
View Source

PrincipalName

Gets the unique Id for the principal.

Declaration
public string PrincipalName { get; }
Property Value
Type Description
System.String
View Source

Scope

Gets information about the scope of the object.

Declaration
public Scope Scope { get; }
Property Value
Type Description
Scope

Methods

View Source

Equals(Nullable<Object>)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
System.Nullable<System.Object> obj
Returns
Type Description
System.Boolean
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
View Source

IsEmpty()

Declaration
public virtual bool IsEmpty()
Returns
Type Description
System.Boolean
View Source

IsValid()

Declaration
public virtual bool IsValid()
Returns
Type Description
System.Boolean

Implements

IRosterPrincipal
IRosterIdentity
IVerifiable
  • View Source
In This Article
Back to top Generated by DocFX