v16.0.1
2020.3+
Class VivoxMessage
A Message for Vivox Text - either sent in a channel or directed, and either sent while this login was active, or requested from the Session or Account archives.
Namespace: Unity.Services.Vivox
Syntax
public sealed class VivoxMessage
Properties
ChannelName
The ChannelName of the channel the message was sent in. IMPORTANT: null if the message was a DirectedMessage.
Declaration
public string ChannelName { get; }
Property Value
Type | Description |
---|---|
String |
FromSelf
Whether or not the message was sent from the user to the channel.
Declaration
public bool FromSelf { get; }
Property Value
Type | Description |
---|---|
Boolean |
IsRead
Denotes if this message has been read/seen or not.
Declaration
public bool IsRead { get; }
Property Value
Type | Description |
---|---|
Boolean |
Language
The language preference of the user that sent the message.
Declaration
public string Language { get; }
Property Value
Type | Description |
---|---|
String |
MessageId
Unique message id of the text message.
Declaration
public string MessageId { get; }
Property Value
Type | Description |
---|---|
String |
MessageText
The text body of the message that was sent
Declaration
public string MessageText { get; }
Property Value
Type | Description |
---|---|
String |
ReceivedTime
At what time the message was received.
Declaration
public DateTime ReceivedTime { get; }
Property Value
Type | Description |
---|---|
DateTime |
SenderDisplayName
The DisplayName of the sender of the message.
Declaration
public string SenderDisplayName { get; }
Property Value
Type | Description |
---|---|
String |
SenderPlayerId
The PlayerId of the sender of the message.
Declaration
public string SenderPlayerId { get; }
Property Value
Type | Description |
---|---|
String |
Methods
SetMessageAsReadAsync(Nullable<DateTime>)
Declaration
public async Task SetMessageAsReadAsync(DateTime? seenAt = null)
Parameters
Type | Name | Description |
---|---|---|
Nullable<DateTime> | seenAt |
Returns
Type | Description |
---|---|
Task |