Class NSChatSummaryItem

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

Syntax

Constructors

NSChatSummaryItem()

Initializes a new instance of the NSChatSummaryItem class.

Declaration

NSChatSummaryItem

Methods

GetChatSessionId()

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

Declaration

Integer GetChatSessionId()

Returns

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

Examples

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

GetCompanyName()

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

Declaration

String GetCompanyName()

Returns

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

Examples

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

GetFirstMessage()

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

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()

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

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()

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

Declaration

String GetName()

Returns

Type	Description
String	The name of customer, if provided.

Examples

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

GetWhenEnded()

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

Declaration

DateTime GetWhenEnded()

Returns

Type	Description
DateTime	When the session was ended.

Examples

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

GetWhenRequested()

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

Declaration

DateTime GetWhenRequested()

Returns

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

Examples

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

SetChatSessionId(Integer)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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)

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

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);