Class NSChatMessage

A message in a chat session. Carrier object for ChatMessage.

Syntax

Constructors

NSChatMessage()

Initializes a new instance of the NSChatMessage class.

Declaration

NSChatMessage

Methods

GetAuthor()

Declaration

String GetAuthor()

Returns

Type	Description
String	The author of the message.

Examples

NSChatMessage thing;
String author = thing.GetAuthor();

GetChatMessageId()

Declaration

Integer GetChatMessageId()

Returns

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

Examples

NSChatMessage thing;
Integer chatMessageId = thing.GetChatMessageId();

GetChatSessionId()

Declaration

Integer GetChatSessionId()

Returns

Type	Description
Integer	The reference to the associated chat session.

Examples

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

GetMessage()

Declaration

String GetMessage()

Returns

Type	Description
String	The message.

Examples

NSChatMessage thing;
String message = thing.GetMessage();

GetReadByCustomer()

Declaration

Integer GetReadByCustomer()

Returns

Type	Description
Integer	Whether the message has been read by the customer or not.

Examples

NSChatMessage thing;
Integer readByCustomer = thing.GetReadByCustomer();

GetSpecialParam()

Declaration

String GetSpecialParam()

Returns

Type	Description
String	Special parameter for the special_type.

Examples

NSChatMessage thing;
String specialParam = thing.GetSpecialParam();

GetSpecialType()

Declaration

Integer GetSpecialType()

Returns

Type	Description
Integer	Indicates if it is a special message, such as a URL redirection. See ChatMessageSpecialType

Examples

NSChatMessage thing;
Integer specialType = thing.GetSpecialType();

GetType()

Declaration

Integer GetType()

Returns

Type	Description
Integer	The type of the message. See ChatMessageType

Examples

NSChatMessage thing;
Integer type = thing.GetType();

GetWhenPosted()

Declaration

DateTime GetWhenPosted()

Returns

Type	Description
DateTime	When the message was posted (UTC timestamp).

Examples

NSChatMessage thing;
DateTime whenPosted = thing.GetWhenPosted();

SetAuthor(String)

Declaration

Void SetAuthor(String author)

Parameters

Type	Name	Description
String	author	The author of the message.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
String author;
thing.SetAuthor(author);

SetChatMessageId(Integer)

Declaration

Void SetChatMessageId(Integer chatMessageId)

Parameters

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

Returns

Type	Description
Void

Examples

NSChatMessage thing;
Integer chatMessageId;
thing.SetChatMessageId(chatMessageId);

SetChatSessionId(Integer)

Declaration

Void SetChatSessionId(Integer chatSessionId)

Parameters

Type	Name	Description
Integer	chatSessionId	The reference to the associated chat session.

Returns

Type	Description
Void

Examples

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

SetMessage(String)

Declaration

Void SetMessage(String message)

Parameters

Type	Name	Description
String	message	The message.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
String message;
thing.SetMessage(message);

SetReadByCustomer(Integer)

Declaration

Void SetReadByCustomer(Integer readByCustomer)

Parameters

Type	Name	Description
Integer	readByCustomer	Whether the message has been read by the customer or not.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
Integer readByCustomer;
thing.SetReadByCustomer(readByCustomer);

SetSpecialParam(String)

Declaration

Void SetSpecialParam(String specialParam)

Parameters

Type	Name	Description
String	specialParam	Special parameter for the special_type.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
String specialParam;
thing.SetSpecialParam(specialParam);

SetSpecialType(Integer)

Declaration

Void SetSpecialType(Integer specialType)

Parameters

Type	Name	Description
Integer	specialType	Indicates if it is a special message, such as a URL redirection. See ChatMessageSpecialType.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
Integer specialType;
thing.SetSpecialType(specialType);

SetType(Integer)

Declaration

Void SetType(Integer type)

Parameters

Type	Name	Description
Integer	type	The type of the message. See ChatMessageType.

Returns

Type	Description
Void

Examples

NSChatMessage thing;
Integer type;
thing.SetType(type);

SetWhenPosted(DateTime)

Declaration

Void SetWhenPosted(DateTime whenPosted)

Parameters

Type	Name	Description
DateTime	whenPosted	When the message was posted (UTC timestamp).

Returns

Type	Description
Void

Examples

NSChatMessage thing;
DateTime whenPosted;
thing.SetWhenPosted(whenPosted);