Class NSProjectEvent

A project that is also an event. Used by Audience.

Syntax

Constructors

NSProjectEvent()

Initializes a new instance of the NSProjectEvent class.

Introduced or updated in version: 7

Declaration

NSProjectEvent

Methods

GetAssociateFullName()

Introduced or updated in version: 7

Declaration

String GetAssociateFullName()

Returns

Type	Description
String	Name of the person that ows the event (project).

Examples

NSProjectEvent thing;
String associateFullName = thing.GetAssociateFullName();

GetAssociateId()

Introduced or updated in version: 7

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	ID of the person that ows the event (project).

Examples

NSProjectEvent thing;
Integer associateId = thing.GetAssociateId();

GetDescription()

Introduced or updated in version: 7

Declaration

String GetDescription()

Returns

Type	Description
String	The event description (the project text).

Examples

NSProjectEvent thing;
String description = thing.GetDescription();

GetEnabled()

Introduced or updated in version: 7

Declaration

Bool GetEnabled()

Returns

Type	Description
Bool	If true the event is enabled (visible).

Examples

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

GetEventDate()

Introduced or updated in version: 7

Declaration

DateTime GetEventDate()

Returns

Type	Description
DateTime	Date of the event. Event is not visible after this date.

Examples

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

GetEventName()

Introduced or updated in version: 7

Declaration

String GetEventName()

Returns

Type	Description
String	The name of the event (the project name).

Examples

NSProjectEvent thing;
String eventName = thing.GetEventName();

GetIsSignedOn()

Introduced or updated in version: 7

Declaration

Bool GetIsSignedOn()

Returns

Type	Description
Bool	True if the current user is signed on to the event (is project member).

Examples

NSProjectEvent thing;
Bool isSignedOn = thing.GetIsSignedOn();

GetProjectId()

Introduced or updated in version: 7

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	ID of the project that represents the event.

Examples

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

GetSignOff()

Introduced or updated in version: 7

Declaration

Bool GetSignOff()

Returns

Type	Description
Bool	If true, it is possible to sign off the event.

Examples

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

GetSignOffConfirmationText()

Introduced or updated in version: 7

Declaration

String GetSignOffConfirmationText()

Returns

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

Examples

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

GetSignOffPersonId()

Introduced or updated in version: 7

Declaration

Integer GetSignOffPersonId()

Returns

Type	Description
Integer	If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity.

Examples

NSProjectEvent thing;
Integer signOffPersonId = thing.GetSignOffPersonId();

GetSignOffTaskEnable()

Introduced or updated in version: 7

Declaration

Bool GetSignOffTaskEnable()

Returns

Type	Description
Bool	If true, a task should be created when the external user signs off an event.

Examples

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

GetSignOffTaskId()

Introduced or updated in version: 7

Declaration

Integer GetSignOffTaskId()

Returns

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

Examples

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

GetSignOffText()

Introduced or updated in version: 7

Declaration

String GetSignOffText()

Returns

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

Examples

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

GetSignOffTriggersAssign()

Introduced or updated in version: 7

Declaration

Bool GetSignOffTriggersAssign()

Returns

Type	Description
Bool	If true, the sign off task should be created as an Assigned task, triggering the invitation dialog.

Examples

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

GetSignOn()

Introduced or updated in version: 7

Declaration

Bool GetSignOn()

Returns

Type	Description
Bool	If true, it is possible to sign on the event.

Examples

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

GetSignOnConfirmationText()

Introduced or updated in version: 7

Declaration

String GetSignOnConfirmationText()

Returns

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

Examples

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

GetSignOnPersonId()

Introduced or updated in version: 7

Declaration

Integer GetSignOnPersonId()

Returns

Type	Description
Integer	If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity.

Examples

NSProjectEvent thing;
Integer signOnPersonId = thing.GetSignOnPersonId();

GetSignOnTaskEnable()

Introduced or updated in version: 7

Declaration

Bool GetSignOnTaskEnable()

Returns

Type	Description
Bool	If true, a task should be created when the external user signs on an event.

Examples

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

GetSignOnTaskId()

Introduced or updated in version: 7

Declaration

Integer GetSignOnTaskId()

Returns

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

Examples

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

GetSignOnText()

Introduced or updated in version: 7

Declaration

String GetSignOnText()

Returns

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

Examples

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

GetSignOnTriggersAssign()

Introduced or updated in version: 7

Declaration

Bool GetSignOnTriggersAssign()

Returns

Type	Description
Bool	If true, the sign on task should be created as an Assigned task, triggering the invitation dialog.

Examples

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

SetAssociateFullName(String)

Introduced or updated in version: 7

Declaration

Void SetAssociateFullName(String associateFullName)

Parameters

Type	Name	Description
String	associateFullName	Name of the person that ows the event (project).

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);

SetAssociateId(Integer)

Introduced or updated in version: 7

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	ID of the person that ows the event (project).

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetDescription(String)

Introduced or updated in version: 7

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The event description (the project text).

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
String description;
thing.SetDescription(description);

SetEnabled(Bool)

Introduced or updated in version: 7

Declaration

Void SetEnabled(Bool enabled)

Parameters

Type	Name	Description
Bool	enabled	If true the event is enabled (visible).

Returns

Type	Description
Void

Examples

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

SetEventDate(DateTime)

Introduced or updated in version: 7

Declaration

Void SetEventDate(DateTime eventDate)

Parameters

Type	Name	Description
DateTime	eventDate	Date of the event. Event is not visible after this date.

Returns

Type	Description
Void

Examples

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

SetEventName(String)

Introduced or updated in version: 7

Declaration

Void SetEventName(String eventName)

Parameters

Type	Name	Description
String	eventName	The name of the event (the project name).

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
String eventName;
thing.SetEventName(eventName);

SetIsSignedOn(Bool)

Introduced or updated in version: 7

Declaration

Void SetIsSignedOn(Bool isSignedOn)

Parameters

Type	Name	Description
Bool	isSignedOn	True if the current user is signed on to the event (is project member).

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
Bool isSignedOn;
thing.SetIsSignedOn(isSignedOn);

SetProjectId(Integer)

Introduced or updated in version: 7

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	ID of the project that represents the event.

Returns

Type	Description
Void

Examples

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

SetSignOff(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOff(Bool signOff)

Parameters

Type	Name	Description
Bool	signOff	If true, it is possible to sign off the event.

Returns

Type	Description
Void

Examples

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

SetSignOffConfirmationText(String)

Introduced or updated in version: 7

Declaration

Void SetSignOffConfirmationText(String signOffConfirmationText)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetSignOffPersonId(Integer)

Introduced or updated in version: 7

Declaration

Void SetSignOffPersonId(Integer signOffPersonId)

Parameters

Type	Name	Description
Integer	signOffPersonId	If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity.

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
Integer signOffPersonId;
thing.SetSignOffPersonId(signOffPersonId);

SetSignOffTaskEnable(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOffTaskEnable(Bool signOffTaskEnable)

Parameters

Type	Name	Description
Bool	signOffTaskEnable	If true, a task should be created when the external user signs off an event.

Returns

Type	Description
Void

Examples

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

SetSignOffTaskId(Integer)

Introduced or updated in version: 7

Declaration

Void SetSignOffTaskId(Integer 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

Examples

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

SetSignOffText(String)

Introduced or updated in version: 7

Declaration

Void SetSignOffText(String signOffText)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetSignOffTriggersAssign(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOffTriggersAssign(Bool signOffTriggersAssign)

Parameters

Type	Name	Description
Bool	signOffTriggersAssign	If true, the sign off task should be created as an Assigned task, triggering the invitation dialog.

Returns

Type	Description
Void

Examples

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

SetSignOn(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOn(Bool signOn)

Parameters

Type	Name	Description
Bool	signOn	If true, it is possible to sign on the event.

Returns

Type	Description
Void

Examples

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

SetSignOnConfirmationText(String)

Introduced or updated in version: 7

Declaration

Void SetSignOnConfirmationText(String signOnConfirmationText)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetSignOnPersonId(Integer)

Introduced or updated in version: 7

Declaration

Void SetSignOnPersonId(Integer signOnPersonId)

Parameters

Type	Name	Description
Integer	signOnPersonId	If 0, the signOn Activity should go into the persons Our Contact; if not 0, this is the Person whose diary should get the activity.

Returns

Type	Description
Void

Examples

NSProjectEvent thing;
Integer signOnPersonId;
thing.SetSignOnPersonId(signOnPersonId);

SetSignOnTaskEnable(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOnTaskEnable(Bool signOnTaskEnable)

Parameters

Type	Name	Description
Bool	signOnTaskEnable	If true, a task should be created when the external user signs on an event.

Returns

Type	Description
Void

Examples

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

SetSignOnTaskId(Integer)

Introduced or updated in version: 7

Declaration

Void SetSignOnTaskId(Integer 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

Examples

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

SetSignOnText(String)

Introduced or updated in version: 7

Declaration

Void SetSignOnText(String signOnText)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetSignOnTriggersAssign(Bool)

Introduced or updated in version: 7

Declaration

Void SetSignOnTriggersAssign(Bool signOnTriggersAssign)

Parameters

Type	Name	Description
Bool	signOnTriggersAssign	If true, the sign on task should be created as an Assigned task, triggering the invitation dialog.

Returns

Type	Description
Void

Examples

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