Class CheckOutObject

Namespace

Dynamicweb.Content.Versioning

Assembly

Dynamicweb.dll

The CheckOutObject class provides information about an object to checkout and the user requesting the checkout

public class CheckOutObject

Inheritance

object

CheckOutObject

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CheckOutObject(Type, string, string)

Initializes a new instance of the CheckOutObject class with a default maximum check out time of 30 minutes

public CheckOutObject(Type type, string objectId, string userId)

Parameters

type Type

The type of object to checkout

objectId string

The unique id of the object to checkout

userId string

The id of the user who is requesting the checkout

Exceptions

ArgumentException

ArgumentNullException

a

CheckOutObject(Type, string, string, int)

Initializes a new instance of the CheckOutObject class

public CheckOutObject(Type type, string objectId, string userId, int maxCheckOutTimeInMinutes)

Parameters

type Type

The type of object to checkout

objectId string

The unique id of the object to checkout

userId string

The id of the user who is requesting the checkout

maxCheckOutTimeInMinutes int

The maximum number of minutes the object will be checked out

Exceptions

ArgumentException

ArgumentNullException

a

Properties

CheckOutTime

Gets the date and time the object was checked out

public DateTime CheckOutTime { get; }

Property Value

DateTime

HasCheckOutExpired

Gets a value indicating if the lock on the object has expired

public bool HasCheckOutExpired { get; }

Property Value

bool

True if the lock has expired, otherwise false

Key

Gets a unique Key for this object based on the checked out objects type and id

public string Key { get; }

Property Value

string

LockedByUsername

Gets the username of the user who is requesting the check out

public string LockedByUsername { get; }

Property Value

string

MaxCheckOutTimeInMinutes

Gets the max number of minutes the object will be checked out, the default is 30 minutes

public int MaxCheckOutTimeInMinutes { get; }

Property Value

int

An integer indicating how many minutes the object at most will be checked out

ObjectId

Gets the identifier of the object to check out

public string ObjectId { get; }

Property Value

string

ObjectType

Gets the type of object to checkout

public Type ObjectType { get; }

Property Value

Type

UserId

Gets the id of the user who is requesting the check out

public string UserId { get; }

Property Value

string