Class ChatHistoryQueryOptions

Options for ChatHistoryQuery requests. Allows for things like filtering based on specific text, timestamps, or PlayerIds

Inheritance
object
ChatHistoryQueryOptions
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
Namespace: Unity.Services.Vivox
Assembly: Unity.Services.Vivox.dll
Syntax
public sealed class ChatHistoryQueryOptions

Properties

PlayerId

If set only messages to or from the specified PlayerId are returned. Only used in channels queries and will have no affect on a Direct Message query. This is optional. The default setting is null.

Declaration
public string PlayerId { get; set; }
Property Value
Type Description
string

SearchText

The text to find in the query. Only messages that contain the specified text are returned. This is optional. The default setting is null.

Declaration
public string SearchText { get; set; }
Property Value
Type Description
string

TimeEnd

Exclude all messages after a specified DateTime from the query results. The query results include messages that immediately follow the specified message in the result set. This is optional. The default setting is null.

Declaration
public DateTime? TimeEnd { get; set; }
Property Value
Type Description
DateTime?

TimeStart

Exclude all messages before a specified DateTime from the query results. This is optional. The default setting is null.

Declaration
public DateTime? TimeStart { get; set; }
Property Value
Type Description
DateTime?