Show / Hide Table of Contents

    Class User

    Represents an application user that has access to Administration Console or Developer Portal.

    Inheritance
    Object
    DomainObjectBase
    User
    UserDefinition
    Implements
    IValidator
    IExtensibleDataObject
    IEquatable<User>
    IFolderEntity
    Inherited Members
    DomainObjectBase.IsValidElementName(String)
    DomainObjectBase.AreEqual(Nullable<DateTime>, Nullable<DateTime>)
    DomainObjectBase.Equals(DomainObjectBase)
    DomainObjectBase.Id
    DomainObjectBase.Key
    DomainObjectBase.Created
    DomainObjectBase.Updated
    DomainObjectBase.IsMajorObject
    DomainObjectBase.ErrorMessage
    DomainObjectBase.ExtensionData
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Entities
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public class User : DomainObjectBase, IValidator, IExtensibleDataObject, IEquatable<User>, IFolderEntity

    Constructors

    User()

    Instantiates and empty object.

    Declaration
    public User()

    Properties

    ConsumerId

    Gets or sets identifier of the Developer Portal consumer account that user belongs to. The property is set to NULL for Sentinet Console users. Once assigned this property cannot be updated.

    Declaration
    public int? ConsumerId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    ConsumerName

    Gets the name of the consumer account that user belongs to.

    Declaration
    public string ConsumerName { get; }
    Property Value
    Type Description
    String

    Description

    Gets or sets description of the user.

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

    Email

    Gets or sets user's e-mail address.

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

    FolderId

    Gets or sets identifier of user's root folder.

    Declaration
    public int? FolderId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    FriendlyName

    Gets or sets full name of the user.

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

    IsEnabled

    Gets or sets flag indicating that user is enabled.

    Declaration
    public bool IsEnabled { get; set; }
    Property Value
    Type Description
    Boolean

    ObjectType

    Gets object type identifier.

    Declaration
    public override EntityType ObjectType { get; }
    Property Value
    Type Description
    EntityType
    Overrides
    DomainObjectBase.ObjectType

    Permission

    Gets or sets value indicating user access level within Developer Portal consumer account. This property applies to consumer users only.

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

    SecurityRoleId

    Gets or sets the identifier of the security role that user is assigned to. This property applies to Sentinet administrative console and API only.

    Declaration
    public int? SecurityRoleId { get; set; }
    Property Value
    Type Description
    Nullable<Int32>

    SecurityRoleName

    Gets the name of the security role that user is assigned to. This property applies to Sentinet administrative console and API only.

    Declaration
    public string SecurityRoleName { get; }
    Property Value
    Type Description
    String

    Methods

    Equals(User)

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

    Declaration
    public bool Equals(User other)
    Parameters
    Type Name Description
    User other

    The user to compare with the current user.

    Returns
    Type Description
    Boolean

    True, if users are equal. False, if users are not equal.

    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
    Boolean

    True, if objects are equal. False, if objects are not equal.

    Overrides
    DomainObjectBase.Equals(Object)

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code of the current instance.

    Overrides
    DomainObjectBase.GetHashCode()

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string that represents the current object.

    Overrides
    DomainObjectBase.ToString()

    Validate()

    Evaluates the state of this object.

    Declaration
    public override bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    DomainObjectBase.Validate()

    Implements

    IValidator
    System.Runtime.Serialization.IExtensibleDataObject
    System.IEquatable<T>
    IFolderEntity
    Back to top Nevatech Sentinet 6.5 Online Documentation