Class RosterDocumentOld

Represents a basic Azure document DB document.

Inheritance
System.Object
PropertyObject
RosterDocumentOld
Implements
Inherited Members
Namespace: Microsoft.GNS.Roster
Assembly: Microsoft.GNS.Roster.Common.dll
Syntax
public class RosterDocumentOld : PropertyObject, IRosterDocumentOld, IRosterIdentity, IPropertyObject, IVerifiable

Constructors

View Source

RosterDocumentOld()

Initializes a new instance of the RosterDocumentOld class.

Declaration
public RosterDocumentOld()

Fields

View Source

Empty

Represents an empty or unset version of this object.

Declaration
public static readonly RosterDocument Empty
Field Value
Type Description
RosterDocument

Properties

View Source

AccessLevel

Gets or sets the access level to the document.

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

Attachments

Gets or sets references to blobs in Document DB or plain blob storage.

Declaration
public string? Attachments { get; set; }
Property Value
Type Description
System.Nullable<System.String>
View Source

Container

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

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

Deleted

Gets a value indicating whether the item is deleted.

Declaration
public bool Deleted { get; }
Property Value
Type Description
System.Boolean
View Source

Description

Gets or sets the description of this role.

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

ETag

Gets an ETag of the resource required for optimistic concurrency control.

Declaration
public string? ETag { get; }
Property Value
Type Description
System.Nullable<System.String>
View Source

Id

Gets the object Id.

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

Metadata

Gets or sets the user data.

Declaration
public IMetadataItem Metadata { get; set; }
Property Value
Type Description
IMetadataItem
View Source

Name

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

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

Owner

Gets or sets the object owner.

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

Rid

Gets a system generated, unique and hierarchical identifier of the resource.

Declaration
public string? Rid { get; }
Property Value
Type Description
System.Nullable<System.String>
View Source

Scope

Gets information about the scope of the object.

Declaration
public Scope Scope { get; protected set; }
Property Value
Type Description
Scope
View Source

Self

Gets a unique addressable URI of the resource.

Declaration
public string? Self { get; }
Property Value
Type Description
System.Nullable<System.String>
View Source

Timestamp

Gets the last updated time stamp of the resource.

Declaration
public DateTime Timestamp { get; }
Property Value
Type Description
DateTime

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
Overrides
View Source

GetHashCode()

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

GetString(String)

Gets a property as a string.

Declaration
public override string GetString(string propertyName)
Parameters
Type Name Description
System.String propertyName

The name of the property to get.
Returns
Type Description
System.String

The property as a string.
Overrides
View Source

IsEmpty()

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

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

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
System.Boolean

True if the object is valid. Otherwise, false.

Implements