Class NSChatSummaryItem

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

Constructors

NSChatSummaryItem()

Initializes a new instance of the NSChatSummaryItem class.

Declaration

NSChatSummaryItem

Methods

GetChatSessionId()

Declaration

Integer GetChatSessionId()

Examples

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

Returns

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

GetCompanyName()

Declaration

String GetCompanyName()

Examples

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

Returns

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

GetFirstMessage()

Declaration

String GetFirstMessage()

Examples

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

Returns

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

GetLastMessage()

Declaration

String GetLastMessage()

Examples

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

Returns

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

GetName()

Declaration

String GetName()

Examples

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

Returns

Type Description
String The name of customer, if provided.

GetWhenEnded()

Declaration

DateTime GetWhenEnded()

Examples

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

Returns

Type Description
DateTime When the session was ended.

GetWhenRequested()

Declaration

DateTime GetWhenRequested()

Examples

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

Returns

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

SetChatSessionId(Integer)

Declaration

Void SetChatSessionId(Integer chatSessionId)

Examples

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

Parameters

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

Returns

Type Description
Void

SetCompanyName(String)

Declaration

Void SetCompanyName(String companyName)

Examples

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

Parameters

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

Returns

Type Description
Void

SetFirstMessage(String)

Declaration

Void SetFirstMessage(String firstMessage)

Examples

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

Parameters

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

Returns

Type Description
Void

SetLastMessage(String)

Declaration

Void SetLastMessage(String lastMessage)

Examples

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

Parameters

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

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

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

Returns

Type Description
Void

SetWhenEnded(DateTime)

Declaration

Void SetWhenEnded(DateTime whenEnded)

Examples

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

Parameters

Type Name Description
DateTime whenEnded When the session was ended.

Returns

Type Description
Void

SetWhenRequested(DateTime)

Declaration

Void SetWhenRequested(DateTime whenRequested)

Examples

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

Parameters

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

Returns

Type Description
Void