Class NSCheckoutInfo
Information about the checked-out state of one document, describing whether it is checked out, and to whom.
Constructors
NSCheckoutInfo()
Initializes a new instance of the NSCheckoutInfo class.
Declaration
NSCheckoutInfoMethods
GetAssociateId()
Declaration
Integer GetAssociateId()Examples
NSCheckoutInfo thing;
Integer associateId = thing.GetAssociateId();Returns
| Type | Description |
| Integer | 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. |
GetName()
Declaration
String GetName()Examples
NSCheckoutInfo thing;
String name = thing.GetName();Returns
| Type | Description |
| String | Name of person who has currently checked out the document; blank if it is not checked out. |
GetState()
Declaration
Integer GetState()Examples
NSCheckoutInfo thing;
Integer state = thing.GetState();Returns
| Type | Description |
| Integer | The checkout state. See <xref href="CRMScript.NetServer.CheckoutState" data-throw-if-not-resolved="false"></xref> |
SetAssociateId(Integer)
Declaration
Void SetAssociateId(Integer associateId)Examples
NSCheckoutInfo thing;
Integer associateId;
thing.SetAssociateId(associateId);Parameters
| Type | Name | Description |
| Integer | 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. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSCheckoutInfo thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | Name of person who has currently checked out the document; blank if it is not checked out. |
Returns
| Type | Description |
| Void |
SetState(Integer)
Declaration
Void SetState(Integer state)Examples
NSCheckoutInfo thing;
Integer state;
thing.SetState(state);Parameters
| Type | Name | Description |
| Integer | state | Checkout state. See <xref href="CRMScript.NetServer.CheckoutState" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |