> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSTaskListItem

## Constructors

### NSTaskListItem()

```crmscript theme={null}
NSTaskListItem
```

Initializes a new instance of the NSTaskListItem class.

## Methods

## GetColorIndex()

```crmscript theme={null}
Integer GetColorIndex()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - JAP. See \<xref href="CRMScript.NetServer.ColorIndex" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer colorIndex = thing.GetColorIndex();
```

## GetDefaultVideomeetingStatus()

```crmscript theme={null}
Integer GetDefaultVideomeetingStatus()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Default video-meeting status for meetings created in SuperOffice CRM. See \<xref href="CRMScript.NetServer.VideoMeetingStatus" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer defaultVideomeetingStatus = thing.GetDefaultVideomeetingStatus();
```

## GetDeleted()

```crmscript theme={null}
Bool GetDeleted()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - If true, the Task list item is deleted.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool deleted = thing.GetDeleted();
```

## GetDirection()

```crmscript theme={null}
Integer GetDirection()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - 1 = incoming, 2 = outgoing. See \<xref href="CRMScript.NetServer.TaskDirection" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer direction = thing.GetDirection();
```

## GetIntentId()

```crmscript theme={null}
Integer GetIntentId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Link to the intention of this kind of task (used by SAINT).

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer intentId = thing.GetIntentId();
```

## GetIsDefaultAlldayEvent()

```crmscript theme={null}
Bool GetIsDefaultAlldayEvent()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if all day event.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultAlldayEvent = thing.GetIsDefaultAlldayEvent();
```

## GetIsDefaultFree()

```crmscript theme={null}
Bool GetIsDefaultFree()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - True if free, false if busy.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultFree = thing.GetIsDefaultFree();
```

## GetIsDefaultPublished()

```crmscript theme={null}
Bool GetIsDefaultPublished()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Published to external persons.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultPublished = thing.GetIsDefaultPublished();
```

## GetRank()

```crmscript theme={null}
Integer GetRank()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Rank order.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer rank = thing.GetRank();
```

## GetTaskListItemId()

```crmscript theme={null}
Integer GetTaskListItemId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Primary key.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer taskListItemId = thing.GetTaskListItemId();
```

## GetTooltip()

```crmscript theme={null}
String GetTooltip()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Tooltip or other description.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
String tooltip = thing.GetTooltip();
```

## GetType()

```crmscript theme={null}
Integer GetType()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - 1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo; See \<xref href="CRMScript.NetServer.TaskType" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer type = thing.GetType();
```

## GetValue()

```crmscript theme={null}
String GetValue()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The list item.

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
String value = thing.GetValue();
```

## SetColorIndex(Integer)

```crmscript theme={null}
Void SetColorIndex(Integer colorIndex)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer colorIndex;
thing.SetColorIndex(colorIndex);
```

## SetDefaultVideomeetingStatus(Integer)

```crmscript theme={null}
Void SetDefaultVideomeetingStatus(Integer defaultVideomeetingStatus)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer defaultVideomeetingStatus;
thing.SetDefaultVideomeetingStatus(defaultVideomeetingStatus);
```

## SetDeleted(Bool)

```crmscript theme={null}
Void SetDeleted(Bool deleted)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool deleted;
thing.SetDeleted(deleted);
```

## SetDirection(Integer)

```crmscript theme={null}
Void SetDirection(Integer direction)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer direction;
thing.SetDirection(direction);
```

## SetIntentId(Integer)

```crmscript theme={null}
Void SetIntentId(Integer intentId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer intentId;
thing.SetIntentId(intentId);
```

## SetIsDefaultAlldayEvent(Bool)

```crmscript theme={null}
Void SetIsDefaultAlldayEvent(Bool isDefaultAlldayEvent)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultAlldayEvent;
thing.SetIsDefaultAlldayEvent(isDefaultAlldayEvent);
```

## SetIsDefaultFree(Bool)

```crmscript theme={null}
Void SetIsDefaultFree(Bool isDefaultFree)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultFree;
thing.SetIsDefaultFree(isDefaultFree);
```

## SetIsDefaultPublished(Bool)

```crmscript theme={null}
Void SetIsDefaultPublished(Bool isDefaultPublished)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Bool isDefaultPublished;
thing.SetIsDefaultPublished(isDefaultPublished);
```

## SetRank(Integer)

```crmscript theme={null}
Void SetRank(Integer rank)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer rank;
thing.SetRank(rank);
```

## SetTaskListItemId(Integer)

```crmscript theme={null}
Void SetTaskListItemId(Integer taskListItemId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer taskListItemId;
thing.SetTaskListItemId(taskListItemId);
```

## SetTooltip(String)

```crmscript theme={null}
Void SetTooltip(String tooltip)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
String tooltip;
thing.SetTooltip(tooltip);
```

## SetType(Integer)

```crmscript theme={null}
Void SetType(Integer type)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
Integer type;
thing.SetType(type);
```

## SetValue(String)

```crmscript theme={null}
Void SetValue(String value)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSTaskListItem thing;
String value;
thing.SetValue(value);
```


## Related topics

- [NSAppointmentAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentAgent.md)
- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md)
- [NSAppointmentEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSAppointmentEntity.md)
- [Plan an outgoing call](/en/automation/crmscript/howto/diary/plan-outgoing-call.md)
- [Get Task List Item](/en/api/reference/restful/rest/list_task/get-task-list-item.md)
- [Post Task List Item](/en/api/reference/restful/rest/list_task/post-task-list-item.md)