Class NSProjectEventEntity

The ProjectEvent Service. The service implements all services working with the ProjectEvent object

Constructors

NSProjectEventEntity()

Initializes a new instance of the NSProjectEventEntity class.

Declaration

NSProjectEventEntity

Methods

GetCreatedBy()

Declaration

NSAssociate GetCreatedBy()

Examples

NSProjectEventEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

Returns

Type Description
NSAssociate The person that created the project event.

GetCreatedDate()

Declaration

DateTime GetCreatedDate()

Examples

NSProjectEventEntity thing;
DateTime createdDate = thing.GetCreatedDate();

Returns

Type Description
DateTime Registered when.

GetEnabled()

Declaration

Bool GetEnabled()

Examples

NSProjectEventEntity thing;
Bool enabled = thing.GetEnabled();

Returns

Type Description
Bool Is the event enabled.

GetEventDate()

Declaration

DateTime GetEventDate()

Examples

NSProjectEventEntity thing;
DateTime eventDate = thing.GetEventDate();

Returns

Type Description
DateTime Date of the event; publishing/visibility dates are in Publish, and restrictions are in AudienceVisibility.

GetId()

Declaration

Integer GetId()

Examples

NSProjectEventEntity thing;
Integer id = thing.GetId();

Returns

Type Description
Integer ID of the external event.

GetIsPublished()

Declaration

Bool GetIsPublished()

Examples

NSProjectEventEntity thing;
Bool isPublished = thing.GetIsPublished();

Returns

Type Description
Bool Publish to external users? When true, the event/project information is visible to external users through the Audience portal. You can control the publish duration using the PublishFrom/PublishTo properties.

GetIsVisibleForCategories()

Declaration

Bool GetIsVisibleForCategories()

Examples

NSProjectEventEntity thing;
Bool isVisibleForCategories = thing.GetIsVisibleForCategories();

Returns

Type Description
Bool

GetIsVisibleForMembers()

Declaration

Bool GetIsVisibleForMembers()

Examples

NSProjectEventEntity thing;
Bool isVisibleForMembers = thing.GetIsVisibleForMembers();

Returns

Type Description
Bool

GetIsVisibleForPersonInterests()

Declaration

Bool GetIsVisibleForPersonInterests()

Examples

NSProjectEventEntity thing;
Bool isVisibleForPersonInterests = thing.GetIsVisibleForPersonInterests();

Returns

Type Description
Bool

GetProjectEventId()

Declaration

Integer GetProjectEventId()

Examples

NSProjectEventEntity thing;
Integer projectEventId = thing.GetProjectEventId();

Returns

Type Description
Integer Primary key.

GetProjectId()

Declaration

Integer GetProjectId()

Examples

NSProjectEventEntity thing;
Integer projectId = thing.GetProjectId();

Returns

Type Description
Integer The projectId for the project this projectEvent belongs to.

GetPublishFrom()

Declaration

DateTime GetPublishFrom()

Examples

NSProjectEventEntity thing;
DateTime publishFrom = thing.GetPublishFrom();

Returns

Type Description
DateTime Publication valid from (inclusive).

GetPublishTo()

Declaration

DateTime GetPublishTo()

Examples

NSProjectEventEntity thing;
DateTime publishTo = thing.GetPublishTo();

Returns

Type Description
DateTime Publication valid to (inclusive).

GetPublishType()

Declaration

Integer GetPublishType()

Examples

NSProjectEventEntity thing;
Integer publishType = thing.GetPublishType();

Returns

Type Description
Integer Type of publishing action. See <xref href="CRMScript.NetServer.PublishType" data-throw-if-not-resolved="false"></xref>

GetSignOff()

Declaration

Bool GetSignOff()

Examples

NSProjectEventEntity thing;
Bool signOff = thing.GetSignOff();

Returns

Type Description
Bool Is Sign Off functionality enabled?

GetSignOffConfirmationText()

Declaration

String GetSignOffConfirmationText()

Examples

NSProjectEventEntity thing;
String signOffConfirmationText = thing.GetSignOffConfirmationText();

Returns

Type Description
String Text shown as confirmation text before accepting sign off.

GetSignOffTaskEnable()

Declaration

Bool GetSignOffTaskEnable()

Examples

NSProjectEventEntity thing;
Bool signOffTaskEnable = thing.GetSignOffTaskEnable();

Returns

Type Description
Bool If not 0, a task should be created when the external user Signs Off an event.

GetSignOffTaskId()

Declaration

Integer GetSignOffTaskId()

Examples

NSProjectEventEntity thing;
Integer signOffTaskId = thing.GetSignOffTaskId();

Returns

Type Description
Integer If not 0, sign off should cause an Activity of this type to be registered.

GetSignOffText()

Declaration

String GetSignOffText()

Examples

NSProjectEventEntity thing;
String signOffText = thing.GetSignOffText();

Returns

Type Description
String Default text for the activity created when signing off.

GetSignOffTriggersAssign()

Declaration

Bool GetSignOffTriggersAssign()

Examples

NSProjectEventEntity thing;
Bool signOffTriggersAssign = thing.GetSignOffTriggersAssign();

Returns

Type Description
Bool If 1, the SignOff task should be created as an Assigned task, triggering the invitation dialog.

GetSignOn()

Declaration

Bool GetSignOn()

Examples

NSProjectEventEntity thing;
Bool signOn = thing.GetSignOn();

Returns

Type Description
Bool Is Sign On functionality enabled.

GetSignOnConfirmationText()

Declaration

String GetSignOnConfirmationText()

Examples

NSProjectEventEntity thing;
String signOnConfirmationText = thing.GetSignOnConfirmationText();

Returns

Type Description
String Text shown as confirmation text before accepting sign on.

GetSignOnTaskEnable()

Declaration

Bool GetSignOnTaskEnable()

Examples

NSProjectEventEntity thing;
Bool signOnTaskEnable = thing.GetSignOnTaskEnable();

Returns

Type Description
Bool If not 0, a task should be created when the external user Signs On to an event.

GetSignOnTaskId()

Declaration

Integer GetSignOnTaskId()

Examples

NSProjectEventEntity thing;
Integer signOnTaskId = thing.GetSignOnTaskId();

Returns

Type Description
Integer If not 0, sign on should cause an Activity of this type to be registered.

GetSignOnText()

Declaration

String GetSignOnText()

Examples

NSProjectEventEntity thing;
String signOnText = thing.GetSignOnText();

Returns

Type Description
String Default text for the activity created when signing on.

GetSignOnTriggersAssign()

Declaration

Bool GetSignOnTriggersAssign()

Examples

NSProjectEventEntity thing;
Bool signOnTriggersAssign = thing.GetSignOnTriggersAssign();

Returns

Type Description
Bool If 1, the SignOn task should be created as an Assigned task, triggering the invitation dialog.

GetUpdatedBy()

Declaration

NSAssociate GetUpdatedBy()

Examples

NSProjectEventEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

Returns

Type Description
NSAssociate The person that last updated the project event.

GetUpdatedDate()

Declaration

DateTime GetUpdatedDate()

Examples

NSProjectEventEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

Returns

Type Description
DateTime Last updated when.

GetVisibleForCategories()

Declaration

NSMDOListItem[] GetVisibleForCategories()

Examples

NSProjectEventEntity thing;
NSMDOListItem[] visibleForCategories = thing.GetVisibleForCategories();

Returns

Type Description
NSMDOListItem[] Array of categories that the event is visible for. MDO Table category.

GetVisibleForPersonInterests()

Declaration

NSMDOListItem[] GetVisibleForPersonInterests()

Examples

NSProjectEventEntity thing;
NSMDOListItem[] visibleForPersonInterests = thing.GetVisibleForPersonInterests();

Returns

Type Description
NSMDOListItem[] Array of person interests (MDO table persint) that this event is visible for.

SetCreatedBy(NSAssociate)

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Examples

NSProjectEventEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

Parameters

Type Name Description
NSAssociate createdBy The person that created the project event.

Returns

Type Description
Void

SetCreatedDate(DateTime)

Declaration

Void SetCreatedDate(DateTime createdDate)

Examples

NSProjectEventEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

Parameters

Type Name Description
DateTime createdDate Registered when.

Returns

Type Description
Void

SetEnabled(Bool)

Declaration

Void SetEnabled(Bool enabled)

Examples

NSProjectEventEntity thing;
Bool enabled;
thing.SetEnabled(enabled);

Parameters

Type Name Description
Bool enabled Is the event enabled.

Returns

Type Description
Void

SetEventDate(DateTime)

Declaration

Void SetEventDate(DateTime eventDate)

Examples

NSProjectEventEntity thing;
DateTime eventDate;
thing.SetEventDate(eventDate);

Parameters

Type Name Description
DateTime eventDate Date of the event; publishing/visibility dates are in Publish, and restrictions are in AudienceVisibility.

Returns

Type Description
Void

SetId(Integer)

Declaration

Void SetId(Integer id)

Examples

NSProjectEventEntity thing;
Integer id;
thing.SetId(id);

Parameters

Type Name Description
Integer id ID of the external event.

Returns

Type Description
Void

SetIsPublished(Bool)

Declaration

Void SetIsPublished(Bool isPublished)

Examples

NSProjectEventEntity thing;
Bool isPublished;
thing.SetIsPublished(isPublished);

Parameters

Type Name Description
Bool isPublished Publish to external users? When true, the event/project information is visible to external users through the Audience portal. You can control the publish duration using the PublishFrom/PublishTo properties.

Returns

Type Description
Void

SetIsVisibleForCategories(Bool)

Declaration

Void SetIsVisibleForCategories(Bool isVisibleForCategories)

Examples

NSProjectEventEntity thing;
Bool isVisibleForCategories;
thing.SetIsVisibleForCategories(isVisibleForCategories);

Parameters

Type Name Description
Bool isVisibleForCategories

Returns

Type Description
Void

SetIsVisibleForMembers(Bool)

Declaration

Void SetIsVisibleForMembers(Bool isVisibleForMembers)

Examples

NSProjectEventEntity thing;
Bool isVisibleForMembers;
thing.SetIsVisibleForMembers(isVisibleForMembers);

Parameters

Type Name Description
Bool isVisibleForMembers

Returns

Type Description
Void

SetIsVisibleForPersonInterests(Bool)

Declaration

Void SetIsVisibleForPersonInterests(Bool isVisibleForPersonInterests)

Examples

NSProjectEventEntity thing;
Bool isVisibleForPersonInterests;
thing.SetIsVisibleForPersonInterests(isVisibleForPersonInterests);

Parameters

Type Name Description
Bool isVisibleForPersonInterests

Returns

Type Description
Void

SetProjectEventId(Integer)

Declaration

Void SetProjectEventId(Integer projectEventId)

Examples

NSProjectEventEntity thing;
Integer projectEventId;
thing.SetProjectEventId(projectEventId);

Parameters

Type Name Description
Integer projectEventId Primary key.

Returns

Type Description
Void

SetProjectId(Integer)

Declaration

Void SetProjectId(Integer projectId)

Examples

NSProjectEventEntity thing;
Integer projectId;
thing.SetProjectId(projectId);

Parameters

Type Name Description
Integer projectId The projectId for the project this projectEvent belongs to.

Returns

Type Description
Void

SetPublishFrom(DateTime)

Declaration

Void SetPublishFrom(DateTime publishFrom)

Examples

NSProjectEventEntity thing;
DateTime publishFrom;
thing.SetPublishFrom(publishFrom);

Parameters

Type Name Description
DateTime publishFrom Publication valid from (inclusive).

Returns

Type Description
Void

SetPublishTo(DateTime)

Declaration

Void SetPublishTo(DateTime publishTo)

Examples

NSProjectEventEntity thing;
DateTime publishTo;
thing.SetPublishTo(publishTo);

Parameters

Type Name Description
DateTime publishTo Publication valid to (inclusive).

Returns

Type Description
Void

SetPublishType(Integer)

Declaration

Void SetPublishType(Integer publishType)

Examples

NSProjectEventEntity thing;
Integer publishType;
thing.SetPublishType(publishType);

Parameters

Type Name Description
Integer publishType Type of publishing action. See <xref href="CRMScript.NetServer.PublishType" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetSignOff(Bool)

Declaration

Void SetSignOff(Bool signOff)

Examples

NSProjectEventEntity thing;
Bool signOff;
thing.SetSignOff(signOff);

Parameters

Type Name Description
Bool signOff Is Sign Off functionality enabled?

Returns

Type Description
Void

SetSignOffConfirmationText(String)

Declaration

Void SetSignOffConfirmationText(String signOffConfirmationText)

Examples

NSProjectEventEntity thing;
String signOffConfirmationText;
thing.SetSignOffConfirmationText(signOffConfirmationText);

Parameters

Type Name Description
String signOffConfirmationText Text shown as confirmation text before accepting sign off.

Returns

Type Description
Void

SetSignOffTaskEnable(Bool)

Declaration

Void SetSignOffTaskEnable(Bool signOffTaskEnable)

Examples

NSProjectEventEntity thing;
Bool signOffTaskEnable;
thing.SetSignOffTaskEnable(signOffTaskEnable);

Parameters

Type Name Description
Bool signOffTaskEnable If not 0, a task should be created when the external user Signs Off an event

Returns

Type Description
Void

SetSignOffTaskId(Integer)

Declaration

Void SetSignOffTaskId(Integer signOffTaskId)

Examples

NSProjectEventEntity thing;
Integer signOffTaskId;
thing.SetSignOffTaskId(signOffTaskId);

Parameters

Type Name Description
Integer signOffTaskId If not 0, sign off should cause an Activity of this type to be registered.

Returns

Type Description
Void

SetSignOffText(String)

Declaration

Void SetSignOffText(String signOffText)

Examples

NSProjectEventEntity thing;
String signOffText;
thing.SetSignOffText(signOffText);

Parameters

Type Name Description
String signOffText Default text for the activity created when signing off.

Returns

Type Description
Void

SetSignOffTriggersAssign(Bool)

Declaration

Void SetSignOffTriggersAssign(Bool signOffTriggersAssign)

Examples

NSProjectEventEntity thing;
Bool signOffTriggersAssign;
thing.SetSignOffTriggersAssign(signOffTriggersAssign);

Parameters

Type Name Description
Bool signOffTriggersAssign If 1, the SignOff task should be created as an Assigned task, triggering the invitation dialog.

Returns

Type Description
Void

SetSignOn(Bool)

Declaration

Void SetSignOn(Bool signOn)

Examples

NSProjectEventEntity thing;
Bool signOn;
thing.SetSignOn(signOn);

Parameters

Type Name Description
Bool signOn Is Sign On functionality enabled.

Returns

Type Description
Void

SetSignOnConfirmationText(String)

Declaration

Void SetSignOnConfirmationText(String signOnConfirmationText)

Examples

NSProjectEventEntity thing;
String signOnConfirmationText;
thing.SetSignOnConfirmationText(signOnConfirmationText);

Parameters

Type Name Description
String signOnConfirmationText Text shown as confirmation text before accepting sign on.

Returns

Type Description
Void

SetSignOnTaskEnable(Bool)

Declaration

Void SetSignOnTaskEnable(Bool signOnTaskEnable)

Examples

NSProjectEventEntity thing;
Bool signOnTaskEnable;
thing.SetSignOnTaskEnable(signOnTaskEnable);

Parameters

Type Name Description
Bool signOnTaskEnable If not 0, a task should be created when the external user Signs On to an event.

Returns

Type Description
Void

SetSignOnTaskId(Integer)

Declaration

Void SetSignOnTaskId(Integer signOnTaskId)

Examples

NSProjectEventEntity thing;
Integer signOnTaskId;
thing.SetSignOnTaskId(signOnTaskId);

Parameters

Type Name Description
Integer signOnTaskId If not 0, sign on should cause an Activity of this type to be registered.

Returns

Type Description
Void

SetSignOnText(String)

Declaration

Void SetSignOnText(String signOnText)

Examples

NSProjectEventEntity thing;
String signOnText;
thing.SetSignOnText(signOnText);

Parameters

Type Name Description
String signOnText Default text for the activity created when signing on.

Returns

Type Description
Void

SetSignOnTriggersAssign(Bool)

Declaration

Void SetSignOnTriggersAssign(Bool signOnTriggersAssign)

Examples

NSProjectEventEntity thing;
Bool signOnTriggersAssign;
thing.SetSignOnTriggersAssign(signOnTriggersAssign);

Parameters

Type Name Description
Bool signOnTriggersAssign If 1, the SignOn task should be created as an Assigned task, triggering the invitation dialog.

Returns

Type Description
Void

SetUpdatedBy(NSAssociate)

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Examples

NSProjectEventEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

Parameters

Type Name Description
NSAssociate The person that last updated the project event.

Returns

Type Description
Void

SetUpdatedDate(DateTime)

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Examples

NSProjectEventEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);

Parameters

Type Name Description
DateTime Last updated when.

Returns

Type Description
Void

SetVisibleForCategories(NSMDOListItem[])

Declaration

Void SetVisibleForCategories(NSMDOListItem[] visibleForCategories)

Examples

NSProjectEventEntity thing;
NSMDOListItem[] visibleForCategories;
thing.SetVisibleForCategories(visibleForCategories);

Parameters

Type Name Description
NSMDOListItem[] visibleForCategories Array of categories that the event is visible for. MDO Table category.

Returns

Type Description
Void

SetVisibleForPersonInterests(NSMDOListItem[])

Declaration

Void SetVisibleForPersonInterests(NSMDOListItem[] visibleForPersonInterests)

Examples

NSProjectEventEntity thing;
NSMDOListItem[] visibleForPersonInterests;
thing.SetVisibleForPersonInterests(visibleForPersonInterests);

Parameters

Type Name Description
NSMDOListItem[] visibleForPersonInterests Array of person interests (MDO table persint) that this event is visible for.

Returns

Type Description
Void