Interface IChatMessage

Represents a message that appears in the chat.

Inherited Members

Namespace: TehGM.Wolfringo.Messages

Assembly: Wolfringo.Core.dll

Syntax

[ResponseType(typeof(ChatResponse))]
public interface IChatMessage : IWolfMessage, IRawDataMessage

Properties

| Improve this Doc View Source

FlightID

WOLF protocol internal flight ID.

Declaration

[JsonProperty("flightId", NullValueHandling = NullValueHandling.Ignore)]
string FlightID { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

ID

Unique ID of the message.

Declaration

[JsonProperty("id", NullValueHandling = NullValueHandling.Ignore)]
[Obsolete("WOLF protocol now prefers to use Timestamp as a message ID.")]
Guid? ID { get; }

Property Value

Type	Description
Nullable<Guid>

Remarks

WOLF seems to prefer using Timestamp as message identifier now. Please use this to identify the message.

| Improve this Doc View Source

IsGroupMessage

Is it a group message?

Declaration

[JsonProperty("isGroup")]
bool IsGroupMessage { get; }

Property Value

Type	Description
Boolean

| Improve this Doc View Source

MimeType

Type of the message.

Declaration

[JsonProperty("mimeType")]
string MimeType { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

RecipientID

User or group that received the message.

Declaration

[JsonProperty("recipient")]
[JsonConverter(typeof(EntityIdConverter))]
uint RecipientID { get; }

Property Value

Type	Description
UInt32

| Improve this Doc View Source

SenderID

User that sent the message.

Declaration

[JsonProperty("originator", NullValueHandling = NullValueHandling.Ignore)]
[JsonConverter(typeof(EntityIdConverter))]
uint? SenderID { get; }

Property Value

Type	Description
Nullable<UInt32>

Remarks

When creating a new chat message, this value will be null.

For received messages, this value will be populated normally.

| Improve this Doc View Source

Timestamp

Message's timestamp.

Declaration

[JsonProperty("timestamp", NullValueHandling = NullValueHandling.Ignore)]
WolfTimestamp? Timestamp { get; }

Property Value

Type	Description
Nullable<WolfTimestamp>

Remarks

When creating a new chat message, this value will be null. Once WOLF server acknowledges the message, it'll respond with timestamp value. Default WolfClient implementation will automatically populate this value once this happens, so message will have timestamp populated after SendAsync<TResponse>(IWolfMessage, CancellationToken) returns.

For received messages, this value will be populated normally.

Extension Methods

SerializationHelper.SerializeJsonPayload<T>(T, JsonSerializer)