Show / Hide Table of Contents

Class NSConsentSource

Carrier object for ConsentSource.

Syntax

Constructors

NSConsentSource()

Initializes a new instance of the NSConsentSource class.

Declaration
NSConsentSource

Methods

GetConsentSourceId()

Carrier object for ConsentSource.

Declaration
Integer GetConsentSourceId()
Returns
Type Description
Integer

Primary key.

Examples
NSConsentSource thing;
Integer consentSourceId = thing.GetConsentSourceId();

GetDeleted()

Carrier object for ConsentSource.

Declaration
Bool GetDeleted()
Returns
Type Description
Bool

true if the NSConsentSource is deleted.

Examples
NSConsentSource thing;
Bool deleted = thing.GetDeleted();

GetKey()

Carrier object for ConsentSource.

Declaration
String GetKey()
Returns
Type Description
String

The key used to uniquely identify this consent source.

Examples
NSConsentSource thing;
String key = thing.GetKey();

GetMailTemplateId()

Carrier object for ConsentSource.

Declaration
Integer GetMailTemplateId()
Returns
Type Description
Integer

The mail template to use when automatically sending emails to new persons created with this consent source.

Examples
NSConsentSource thing;
Integer mailTemplateId = thing.GetMailTemplateId();

GetName()

Carrier object for ConsentSource.

Declaration
String GetName()
Returns
Type Description
String

Name of consent source.

Examples
NSConsentSource thing;
String name = thing.GetName();

GetRank()

Carrier object for ConsentSource.

Declaration
Integer GetRank()
Returns
Type Description
Integer

Rank of this consent source.

Examples
NSConsentSource thing;
Integer rank = thing.GetRank();

GetTooltip()

Carrier object for ConsentSource.

Declaration
String GetTooltip()
Returns
Type Description
String

Tooltip for this consent source.

Examples
NSConsentSource thing;
String tooltip = thing.GetTooltip();

SetConsentSourceId(Integer)

Carrier object for ConsentSource.

Declaration
Void SetConsentSourceId(Integer consentSourceId)
Parameters
Type Name Description
Integer consentSourceId

Primary key.

Returns
Type Description
Void
Examples
NSConsentSource thing;
Integer consentSourceId;
thing.SetConsentSourceId(consentSourceId);

SetDeleted(Bool)

Carrier object for ConsentSource.

Declaration
Void SetDeleted(Bool deleted)
Parameters
Type Name Description
Bool deleted

true if the NSConsentSource is deleted.

Returns
Type Description
Void
Examples
NSConsentSource thing;
Bool deleted;
thing.SetDeleted(deleted);

SetKey(String)

Carrier object for ConsentSource.

Declaration
Void SetKey(String key)
Parameters
Type Name Description
String key

The key used to uniquely identify this consent source.

Returns
Type Description
Void
Examples
NSConsentSource thing;
String key;
thing.SetKey(key);

SetMailTemplateId(Integer)

Carrier object for ConsentSource.

Declaration
Void SetMailTemplateId(Integer mailTemplateId)
Parameters
Type Name Description
Integer mailTemplateId

The mail template to use when automatically sending emails to new persons created with this consent source.

Returns
Type Description
Void
Examples
NSConsentSource thing;
Integer mailTemplateId;
thing.SetMailTemplateId(mailTemplateId);

SetName(String)

Carrier object for ConsentSource.

Declaration
Void SetName(String name)
Parameters
Type Name Description
String name

Name of consent source.

Returns
Type Description
Void
Examples
NSConsentSource thing;
String name;
thing.SetName(name);

SetRank(Integer)

Carrier object for ConsentSource.

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank

Rank of this consent source.

Returns
Type Description
Void
Examples
NSConsentSource thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

Carrier object for ConsentSource.

Declaration
Void SetTooltip(String tooltip)
Parameters
Type Name Description
String tooltip

Tooltip for this consent source.

Returns
Type Description
Void
Examples
NSConsentSource thing;
String tooltip;
thing.SetTooltip(tooltip);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top