Class User

Inheritance
System.Object
User
Implements
System.IDisposable
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ActiveGuard.Plugins.OSS.Models
Assembly: ActiveGuard.Plugins.OSS.dll
Syntax
public class User : IDisposable

Properties

AccessCameras

Declaration
public List<string> AccessCameras { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

List of camera that this user can access. If not set, this user can access all cameras.

Mandatory : No

Value range :

Sample:

AllowFaceWatchlist

Declaration
public bool AllowFaceWatchlist { get; set; }
Property Value
Type Description
System.Boolean

User can use face watchlist as search filter

  • True : User can add/edit/delete face watchlist.
  • False : User can not add/edit/delete face watchlist.

    Mandatory : Yes

    Value range : True|False

    Sample: True

AllowPeopleWatchlist

Declaration
public bool AllowPeopleWatchlist { get; set; }
Property Value
Type Description
System.Boolean

User can use people watchlist as search filter

  • True : User can add/edit/delete people watchlist.
  • False : User can not add/edit/delete people watchlist.

    Mandatory : Yes

    Value range : True|False

    Sample: True

AllowPlugin

Declaration
public bool AllowPlugin { get; set; }
Property Value
Type Description
System.Boolean

If [False] is set, the user cannot search from all cameras at all.

  • True : User can use this plug-in.
  • False : User can not use this plug-in.

    Mandatory : Yes

    Value range : True|False

    Sample: True

IsAdmin

Declaration
public bool IsAdmin { get; set; }
Property Value
Type Description
System.Boolean

To check this user is administrator or not.
Some information such IP address of camera will be shown only for Administrator.

  • True : User is administrator.
  • False : User isn't administrator.

    Mandatory : Yes

    Value range : True|False

    Sample: False

StartPlaybackTime

Declaration
public int StartPlaybackTime { get; set; }
Property Value
Type Description
System.Int32

Configuration for the current user.

  • This value will be affected to parameter "PlayDate" in "GetMediaInfo",
    so that playback video will start specified seconds before the event. If omitted, default value 5 will be used.

    Mandatory : No

    Value range : 0 - 59

    Sample: 15

UserName

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

User Name VMS user who will access to plugin

Mandatory : Yes

Value range : 256 characters at the maximum

Sample: Admin

Methods

Dispose()

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

Implements

System.IDisposable