Skip to main content

​
Class CheckoutInfo

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll Carrier object for CheckoutInfo. Information about the checked-out state of one document, describing whether it is checked out, and to whom.

​
Inheritance

object ← CheckoutInfo

​
Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

​
Constructors

​
CheckoutInfo()

Default constructor - defaults any enum props to 0.

​
Properties

​
AssociateId

Id of associate who has currently checked out the document; 0 if it is not checked out, or is checked out by someone who is not a SuperOffice user

​
Property Value

int

​
Name

Name of person who has currently checked out the document; blank if it is not checked out. This property may also be blank if the AssociateId is nonzero; NetServer will retrieve the associates’ name as needed.

​
Property Value

string

​
State

Checkout state NULL if unknown enum value.

​
Property Value

CheckoutState?

​
See Also

CheckoutInfo.State_String

​
State_String

Checkout state Raw string enum value.

​
Property Value

string

​
See Also

CheckoutInfo.State

​
See Also

DocumentAgent

Related topics

WebAPI changes in SuperOffice 12.0WebAPI changes in SuperOffice 12.1WebAPI changes in SuperOffice 12.2SuperOffice WebApiHow to use SuperOffice.WebApiHow to create a user-defined field using the web services APIHow to update a user-defined field using the web services API