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.

Inheritance

object

VivoxMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Vivox

Assembly: Unity.Services.Vivox.dll

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
bool

IsRead

Denotes if this message has been read/seen or not.

Declaration

public bool IsRead { get; }

Property Value

Type	Description
bool

IsTranscribedMessage

Denotes if this message was created as a result of a Speech-to-Text transcription.

Declaration

public bool IsTranscribedMessage { get; }

Property Value

Type	Description
bool

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

RecipientPlayerId

The PlayerId of the recipient of the message. This will only be populated in VivoxMessages provided by a GetDirectTextMessageHistoryAsync(string, int, ChatHistoryQueryOptions)

Declaration

public string RecipientPlayerId { get; }

Property Value

Type	Description
string

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

Declaration

public Task SetMessageAsReadAsync(DateTime? seenAt = null)

Parameters

Type	Name	Description
DateTime?	seenAt

Returns

Type	Description
Task