Show / Hide Table of Contents

Class NSTemporaryKeyInfo

The fields returned when checking a temporary key.

Syntax

Constructors

NSTemporaryKeyInfo()

Initializes a new instance of the NSTemporaryKeyInfo class.

Declaration
NSTemporaryKeyInfo

Methods

GetDomain()

The fields returned when checking a temporary key.

Declaration
Integer GetDomain()
Returns
Type Description
Integer

The domain for this key. Unknown if key is not valid. See TemporaryKeyDomain.

Examples
NSTemporaryKeyInfo thing;
Integer domain = thing.GetDomain();

GetIsExpired()

The fields returned when checking a temporary key.

Declaration
Bool GetIsExpired()
Returns
Type Description
Bool

Whether the key is expired or not.

Examples
NSTemporaryKeyInfo thing;
Bool isExpired = thing.GetIsExpired();

GetPersonId()

The fields returned when checking a temporary key.

Declaration
Integer GetPersonId()
Returns
Type Description
Integer

The person ID this key is related to. May be null.

Examples
NSTemporaryKeyInfo thing;
Integer personId = thing.GetPersonId();

GetTargetId()

The fields returned when checking a temporary key.

Declaration
Integer GetTargetId()
Returns
Type Description
Integer

The primary key of the entity this temporary key is for, dependent of domain.

Examples
NSTemporaryKeyInfo thing;
Integer targetId = thing.GetTargetId();

SetDomain(Integer)

The fields returned when checking a temporary key.

Declaration
Void SetDomain(Integer domain)
Parameters
Type Name Description
Integer domain

The domain for this key. Unknown if key is not valid. See TemporaryKeyDomain.

Returns
Type Description
Void
Examples
NSTemporaryKeyInfo thing;
Integer domain;
thing.SetDomain(domain);

SetIsExpired(Bool)

The fields returned when checking a temporary key.

Declaration
Void SetIsExpired(Bool isExpired)
Parameters
Type Name Description
Bool isExpired

Whether the key is expired or not.

Returns
Type Description
Void
Examples
NSTemporaryKeyInfo thing;
Bool isExpired;
thing.SetIsExpired(isExpired);

SetPersonId(Integer)

The fields returned when checking a temporary key.

Declaration
Void SetPersonId(Integer personId)
Parameters
Type Name Description
Integer personId

The person ID this key is related to. May be null.

Returns
Type Description
Void
Examples
NSTemporaryKeyInfo thing;
Integer personId;
thing.SetPersonId(personId);

SetTargetId(Integer)

The fields returned when checking a temporary key.

Declaration
Void SetTargetId(Integer targetId)
Parameters
Type Name Description
Integer targetId

The primary key of the entity this temporary key is for, dependent of domain.

Returns
Type Description
Void
Examples
NSTemporaryKeyInfo thing;
Integer targetId;
thing.SetTargetId(targetId);
In This Article
  • Constructors
    • NSTemporaryKeyInfo()
  • Methods
    • GetDomain()
    • GetIsExpired()
    • GetPersonId()
    • GetTargetId()
    • SetDomain(Integer)
    • SetIsExpired(Bool)
    • SetPersonId(Integer)
    • SetTargetId(Integer)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top