Class NSMailMergeTask

Properties describing a task to create on recipients of a mail merge.

Syntax

Constructors

NSMailMergeTask()

Initializes a new instance of the NSMailMergeTask class.

Introduced or updated in version: 7

Declaration

NSMailMergeTask

Methods

GetCompleted()

Introduced or updated in version: 7

Declaration

Integer GetCompleted()

Returns

Type	Description
Integer	Completed status for task.

Examples

NSMailMergeTask thing;
Integer completed = thing.GetCompleted();

GetDescription()

Introduced or updated in version: 7

Declaration

String GetDescription()

Returns

Type	Description
String	Text describing task.

Examples

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

GetDuration()

Introduced or updated in version: 7

Declaration

Integer GetDuration()

Returns

Type	Description
Integer	Duration of task.

Examples

NSMailMergeTask thing;
Integer duration = thing.GetDuration();

GetOwnerAssociateId()

Introduced or updated in version: 7

Declaration

Integer GetOwnerAssociateId()

Returns

Type	Description
Integer	Associate identity of who should be set as owner of the task.

Remarks

If value is 0, the recipient owner(our contact) will be used.

Examples

NSMailMergeTask thing;
Integer ownerAssociateId = thing.GetOwnerAssociateId();

GetPriorityId()

Introduced or updated in version: 7

Declaration

Integer GetPriorityId()

Returns

Type	Description
Integer	Priority of task.

Examples

NSMailMergeTask thing;
Integer priorityId = thing.GetPriorityId();

GetProjectId()

Introduced or updated in version: 7

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	Project identity to set on task.

Examples

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

GetSaleId()

Introduced or updated in version: 7

Declaration

Integer GetSaleId()

Returns

Type	Description
Integer	Sale identity to set on task.

Examples

NSMailMergeTask thing;
Integer saleId = thing.GetSaleId();

GetSingleEntryOnEachCompany()

Introduced or updated in version: 7

Declaration

Bool GetSingleEntryOnEachCompany()

Returns

Type	Description
Bool	Should we only create one task on each company? If false, separate tasks will be created for all persons from the same company.

Examples

NSMailMergeTask thing;
Bool singleEntryOnEachCompany = thing.GetSingleEntryOnEachCompany();

GetStartDate()

Introduced or updated in version: 7

Declaration

DateTime GetStartDate()

Returns

Type	Description
DateTime	When the task should start.

Examples

NSMailMergeTask thing;
DateTime startDate = thing.GetStartDate();

GetTypeId()

Introduced or updated in version: 7

Declaration

Integer GetTypeId()

Returns

Type	Description
Integer	Type identity to set on task.

Examples

NSMailMergeTask thing;
Integer typeId = thing.GetTypeId();

GetVisibleFor()

Introduced or updated in version: 7

Declaration

NSVisibleFor GetVisibleFor()

Returns

Type	Description
NSVisibleFor	Who the task should be visible for.

Examples

NSMailMergeTask thing;
NSVisibleFor visibleFor = thing.GetVisibleFor();

SetCompleted(Integer)

Introduced or updated in version: 7

Declaration

Void SetCompleted(Integer completed)

Parameters

Type	Name	Description
Integer	completed	Completed status for task.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Integer completed;
thing.SetCompleted(completed);

SetDescription(String)

Introduced or updated in version: 7

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Text describing task.

Returns

Type	Description
Void

Examples

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

SetDuration(Integer)

Introduced or updated in version: 7

Declaration

Void SetDuration(Integer duration)

Parameters

Type	Name	Description
Integer	duration	Duration of task.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Integer duration;
thing.SetDuration(duration);

SetOwnerAssociateId(Integer)

Introduced or updated in version: 7

Declaration

Void SetOwnerAssociateId(Integer ownerAssociateId)

Parameters

Type	Name	Description
Integer	ownerAssociateId	Associate identity of who should be set as owner of the task.

Returns

Type	Description
Void

Remarks

If value is 0, the recipient owner(our contact) will be used.

Examples

NSMailMergeTask thing;
Integer ownerAssociateId;
thing.SetOwnerAssociateId(ownerAssociateId);

SetPriorityId(Integer)

Introduced or updated in version: 7

Declaration

Void SetPriorityId(Integer priorityId)

Parameters

Type	Name	Description
Integer	priorityId	Priority of task.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Integer priorityId;
thing.SetPriorityId(priorityId);

SetProjectId(Integer)

Introduced or updated in version: 7

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	Project identity to set on task.

Returns

Type	Description
Void

Examples

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

SetSaleId(Integer)

Introduced or updated in version: 7

Declaration

Void SetSaleId(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId	Sale identity to set on task.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Integer saleId;
thing.SetSaleId(saleId);

SetSingleEntryOnEachCompany(Bool)

Introduced or updated in version: 7

Declaration

Void SetSingleEntryOnEachCompany(Bool singleEntryOnEachCompany)

Parameters

Type	Name	Description
Bool	singleEntryOnEachCompany	Should we only create one task on each company? If false, separate tasks will be created for all persons from the same company.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Bool singleEntryOnEachCompany;
thing.SetSingleEntryOnEachCompany(singleEntryOnEachCompany);

SetStartDate(DateTime)

Introduced or updated in version: 7

Declaration

Void SetStartDate(DateTime startDate)

Parameters

Type	Name	Description
DateTime	startDate	When the task should start.

Examples

NSMailMergeTask thing;
DateTime startDate;
thing.SetStartDate(startDate);

SetTypeId(Integer)

Introduced or updated in version: 7

Declaration

Void SetTypeId(Integer typeId)

Parameters

Type	Name	Description
Integer	typeId	Type identity to set on task.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
Integer typeId;
thing.SetTypeId(typeId);

SetVisibleFor(NSVisibleFor)

Introduced or updated in version: 7

Declaration

Void SetVisibleFor(NSVisibleFor visibleFor)

Parameters

Type	Name	Description
NSVisibleFor	visibleFor	Who the task should be visible for.

Returns

Type	Description
Void

Examples

NSMailMergeTask thing;
NSVisibleFor visibleFor;
thing.SetVisibleFor(visibleFor);