Class NSProjectEvent
A project that is also an event. Used by Audience.
Constructors
NSProjectEvent()
Initializes a new instance of the NSProjectEvent class.
Declaration
NSProjectEvent Methods
GetAssociateFullName()
Declaration
String GetAssociateFullName() Examples
NSProjectEvent thing;
String associateFullName = thing.GetAssociateFullName();
Returns
| Type | Description |
| String | Name of the person that ows the event (project). |
GetAssociateId()
Declaration
Integer GetAssociateId() Examples
NSProjectEvent thing;
Integer associateId = thing.GetAssociateId();
Returns
| Type | Description |
| Integer | ID of the person that ows the event (project). |
GetDescription()
Declaration
String GetDescription() Examples
NSProjectEvent thing;
String description = thing.GetDescription();
Returns
| Type | Description |
| String | The event description (the project text). |
GetEnabled()
Declaration
Bool GetEnabled() Examples
NSProjectEvent thing;
Bool enabled = thing.GetEnabled();
Returns
| Type | Description |
| Bool | If true the event is enabled (visible). |
GetEventDate()
Declaration
DateTime GetEventDate() Examples
NSProjectEvent thing;
DateTime eventDate = thing.GetEventDate();
Returns
| Type | Description |
| DateTime | Date of the event. Event is not visible after this date. |
GetEventName()
Declaration
String GetEventName() Examples
NSProjectEvent thing;
String eventName = thing.GetEventName();
Returns
| Type | Description |
| String | The name of the event (the project name). |
GetIsSignedOn()
Declaration
Bool GetIsSignedOn() Examples
NSProjectEvent thing;
Bool isSignedOn = thing.GetIsSignedOn();
Returns
| Type | Description |
| Bool | True if the current user is signed on to the event (is project member). |
GetProjectId()
Declaration
Integer GetProjectId() Examples
NSProjectEvent thing;
Integer projectId = thing.GetProjectId();
Returns
| Type | Description |
| Integer | ID of the project that represents the event. |
GetSignOff()
Declaration
Bool GetSignOff() Examples
NSProjectEvent thing;
Bool signOff = thing.GetSignOff();
Returns
| Type | Description |
| Bool | If true, it is possible to sign off the event. |
GetSignOffConfirmationText()
Declaration
String GetSignOffConfirmationText() Examples
NSProjectEvent thing;
String signOffConfirmationText = thing.GetSignOffConfirmationText();
Returns
| Type | Description |
| String | Text shown as confirmation text before accepting sign off. |
GetSignOffPersonId()
Declaration
Integer GetSignOffPersonId() Examples
NSProjectEvent thing;
Integer signOffPersonId = thing.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. |
GetSignOffTaskEnable()
Declaration
Bool GetSignOffTaskEnable() Examples
NSProjectEvent thing;
Bool signOffTaskEnable = thing.GetSignOffTaskEnable();
Returns
| Type | Description |
| Bool | If true, a task should be created when the external user signs off an event. |
GetSignOffTaskId()
Declaration
Integer GetSignOffTaskId() Examples
NSProjectEvent 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
NSProjectEvent thing;
String signOffText = thing.GetSignOffText();
Returns
| Type | Description |
| String | Default text for the activity created when signing off. |
GetSignOffTriggersAssign()
Declaration
Bool GetSignOffTriggersAssign() Examples
NSProjectEvent thing;
Bool signOffTriggersAssign = thing.GetSignOffTriggersAssign();
Returns
| Type | Description |
| Bool | If true, the sign off task should be created as an Assigned task, triggering the invitation dialog. |
GetSignOn()
Declaration
Bool GetSignOn() Examples
NSProjectEvent thing;
Bool signOn = thing.GetSignOn();
Returns
| Type | Description |
| Bool | If true, it is possible to sign on the event. |
GetSignOnConfirmationText()
Declaration
String GetSignOnConfirmationText() Examples
NSProjectEvent thing;
String signOnConfirmationText = thing.GetSignOnConfirmationText();
Returns
| Type | Description |
| String | Text shown as confirmation text before accepting sign on. |
GetSignOnPersonId()
Declaration
Integer GetSignOnPersonId() Examples
NSProjectEvent thing;
Integer signOnPersonId = thing.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. |
GetSignOnTaskEnable()
Declaration
Bool GetSignOnTaskEnable() Examples
NSProjectEvent thing;
Bool signOnTaskEnable = thing.GetSignOnTaskEnable();
Returns
| Type | Description |
| Bool | If true, a task should be created when the external user signs on an event. |
GetSignOnTaskId()
Declaration
Integer GetSignOnTaskId() Examples
NSProjectEvent 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
NSProjectEvent thing;
String signOnText = thing.GetSignOnText();
Returns
| Type | Description |
| String | Default text for the activity created when signing on. |
GetSignOnTriggersAssign()
Declaration
Bool GetSignOnTriggersAssign() Examples
NSProjectEvent thing;
Bool signOnTriggersAssign = thing.GetSignOnTriggersAssign();
Returns
| Type | Description |
| Bool | If true, the sign on task should be created as an Assigned task, triggering the invitation dialog. |
SetAssociateFullName(String)
Declaration
Void SetAssociateFullName(String associateFullName) Examples
NSProjectEvent thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);
Parameters
| Type | Name | Description |
| String | associateFullName | Name of the person that ows the event (project). |
Returns
| Type | Description |
| Void |
SetAssociateId(Integer)
Declaration
Void SetAssociateId(Integer associateId) Examples
NSProjectEvent thing;
Integer associateId;
thing.SetAssociateId(associateId);
Parameters
| Type | Name | Description |
| Integer | associateId | ID of the person that ows the event (project). |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description) Examples
NSProjectEvent thing;
String description;
thing.SetDescription(description);
Parameters
| Type | Name | Description |
| String | description | The event description (the project text). |
Returns
| Type | Description |
| Void |
SetEnabled(Bool)
Declaration
Void SetEnabled(Bool enabled) Examples
NSProjectEvent thing;
Bool enabled;
thing.SetEnabled(enabled);
Parameters
| Type | Name | Description |
| Bool | enabled | If true the event is enabled (visible). |
Returns
| Type | Description |
| Void |
SetEventDate(DateTime)
Declaration
Void SetEventDate(DateTime eventDate) Examples
NSProjectEvent thing;
DateTime eventDate;
thing.SetEventDate(eventDate);
Parameters
| Type | Name | Description |
| DateTime | eventDate | Date of the event. Event is not visible after this date. |
Returns
| Type | Description |
| Void |
SetEventName(String)
Declaration
Void SetEventName(String eventName) Examples
NSProjectEvent thing;
String eventName;
thing.SetEventName(eventName);
Parameters
| Type | Name | Description |
| String | eventName | The name of the event (the project name). |
Returns
| Type | Description |
| Void |
SetIsSignedOn(Bool)
Declaration
Void SetIsSignedOn(Bool isSignedOn) Examples
NSProjectEvent thing;
Bool isSignedOn;
thing.SetIsSignedOn(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 |
SetProjectId(Integer)
Declaration
Void SetProjectId(Integer projectId) Examples
NSProjectEvent thing;
Integer projectId;
thing.SetProjectId(projectId);
Parameters
| Type | Name | Description |
| Integer | projectId | ID of the project that represents the event. |
Returns
| Type | Description |
| Void |
SetSignOff(Bool)
Declaration
Void SetSignOff(Bool signOff) Examples
NSProjectEvent thing;
Bool signOff;
thing.SetSignOff(signOff);
Parameters
| Type | Name | Description |
| Bool | signOff | If true, it is possible to sign off the event. |
Returns
| Type | Description |
| Void |
SetSignOffConfirmationText(String)
Declaration
Void SetSignOffConfirmationText(String signOffConfirmationText) Examples
NSProjectEvent 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 |
SetSignOffPersonId(Integer)
Declaration
Void SetSignOffPersonId(Integer signOffPersonId) Examples
NSProjectEvent thing;
Integer signOffPersonId;
thing.SetSignOffPersonId(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 |
SetSignOffTaskEnable(Bool)
Declaration
Void SetSignOffTaskEnable(Bool signOffTaskEnable) Examples
NSProjectEvent thing;
Bool signOffTaskEnable;
thing.SetSignOffTaskEnable(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 |
SetSignOffTaskId(Integer)
Declaration
Void SetSignOffTaskId(Integer signOffTaskId) Examples
NSProjectEvent 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
NSProjectEvent 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
NSProjectEvent thing;
Bool signOffTriggersAssign;
thing.SetSignOffTriggersAssign(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 |
SetSignOn(Bool)
Declaration
Void SetSignOn(Bool signOn) Examples
NSProjectEvent thing;
Bool signOn;
thing.SetSignOn(signOn);
Parameters
| Type | Name | Description |
| Bool | signOn | If true, it is possible to sign on the event. |
Returns
| Type | Description |
| Void |
SetSignOnConfirmationText(String)
Declaration
Void SetSignOnConfirmationText(String signOnConfirmationText) Examples
NSProjectEvent 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 |
SetSignOnPersonId(Integer)
Declaration
Void SetSignOnPersonId(Integer signOnPersonId) Examples
NSProjectEvent thing;
Integer signOnPersonId;
thing.SetSignOnPersonId(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 |
SetSignOnTaskEnable(Bool)
Declaration
Void SetSignOnTaskEnable(Bool signOnTaskEnable) Examples
NSProjectEvent thing;
Bool signOnTaskEnable;
thing.SetSignOnTaskEnable(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 |
SetSignOnTaskId(Integer)
Declaration
Void SetSignOnTaskId(Integer signOnTaskId) Examples
NSProjectEvent 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
NSProjectEvent 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
NSProjectEvent thing;
Bool signOnTriggersAssign;
thing.SetSignOnTriggersAssign(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 |