Class NSChatSummaryItem

Chat session summary: id, title, created date. Carrier object for ChatSummaryItem.

Syntax

Constructors

NSChatSummaryItem()

Initializes a new instance of the NSChatSummaryItem class.

Introduced or updated in version: 8.5R08

Declaration

NSChatSummaryItem

Methods

GetChatSessionId()

Introduced or updated in version: 8.5R08

Declaration

Integer GetChatSessionId()

Returns

Type	Description
Integer	The primary key (auto-incremented).

Examples

NSChatSummaryItem thing;
Integer chatSessionId = thing.GetChatSessionId();

GetCompanyName()

Introduced or updated in version: 8.5R08

Declaration

String GetCompanyName()

Returns

Type	Description
String	The name of the customers company, if provided.

Examples

NSChatSummaryItem thing;
String companyName = thing.GetCompanyName();

GetFirstMessage()

Introduced or updated in version: 8.5R08

Declaration

String GetFirstMessage()

Returns

Type	Description
String	A copy of the first message in the chat session.

Examples

NSChatSummaryItem thing;
String firstMessage = thing.GetFirstMessage();

GetLastMessage()

Introduced or updated in version: 8.5R08

Declaration

String GetLastMessage()

Returns

Type	Description
String	A copy of the last message in the chat session.

Examples

NSChatSummaryItem thing;
String lastMessage = thing.GetLastMessage();

GetName()

Introduced or updated in version: 8.5R08

Declaration

String GetName()

Returns

Type	Description
String	The name of customer, if provided.

Examples

NSChatSummaryItem thing;
String name = thing.GetName();

GetWhenEnded()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetWhenEnded()

Returns

Type	Description
DateTime	When the session was ended.

Examples

NSChatSummaryItem thing;
DateTime whenEnded = thing.GetWhenEnded();

GetWhenRequested()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetWhenRequested()

Returns

Type	Description
DateTime	When the session was requested by the customer.

Examples

NSChatSummaryItem thing;
DateTime whenRequested = thing.GetWhenRequested();

SetChatSessionId(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetChatSessionId(Integer chatSessionId)

Parameters

Type	Name	Description
Integer	chatSessionId	The primary key (auto-incremented).

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
Integer chatSessionId;
thing.SetChatSessionId(chatSessionId);

SetCompanyName(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetCompanyName(String companyName)

Parameters

Type	Name	Description
String	companyName	The name of the customers company, if provided.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
String companyName;
thing.SetCompanyName(companyName);

SetFirstMessage(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetFirstMessage(String firstMessage)

Parameters

Type	Name	Description
String	firstMessage	A copy of the first message in the chat session.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
String firstMessage;
thing.SetFirstMessage(firstMessage);

SetLastMessage(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetLastMessage(String lastMessage)

Parameters

Type	Name	Description
String	lastMessage	A copy of the last message in the chat session.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
String lastMessage;
thing.SetLastMessage(lastMessage);

SetName(String)

Introduced or updated in version: 8.5R08

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of customer, if provided.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
String name;
thing.SetName(name);

SetWhenEnded(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetWhenEnded(DateTime whenEnded)

Parameters

Type	Name	Description
DateTime	whenEnded	When the session was ended.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
DateTime whenEnded;
thing.SetWhenEnded(whenEnded);

SetWhenRequested(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetWhenRequested(DateTime whenRequested)

Parameters

Type	Name	Description
DateTime	whenRequested	When the session was requested by the customer.

Returns

Type	Description
Void

Examples

NSChatSummaryItem thing;
DateTime whenRequested;
thing.SetWhenRequested(whenRequested);