Voxt Documentation

Appearance

Search data types ​

Fields below are declared serialized members. Base types contribute their own fields; related types link the payload graph. ? means nullable, and required marks a required C# initializer. These are schematic C# contract shapes, not compilable declarations or a separate JSON schema. Constructor members are repeated in the field list for easy scanning. Serialization attributes and implementation helpers are omitted; use the linked source for exact wire aliases and formatters.

ContactSearchQuery ​

Query parameters for searching contacts. Source

csharp
public partial record ContactSearchQuery
{
    SearchScope Scope;
    string Criteria;
    PlaceId? PlaceId;
    bool Own;
    int Skip;
    int Limit;
}

Related types: PlaceId, SearchScope.

EntrySearchQuery ​

Query parameters for searching chat entries. Source

csharp
public partial record EntrySearchQuery
{
    string Criteria;
    PlaceId? PlaceId;
    ChatId? ChatId;
    int Skip;
    int Limit;
    bool OwnEntriesOnly;
}

Related types: ChatId, PlaceId.

FoundChatEntry ​

Represents a chat entry match from a search query. Source

csharp
public sealed partial class FoundChatEntry(
    ChatEntryId entryId,
    SearchMatch match
) : IHasSearchMatch
{
    ChatEntryId EntryId;
    SearchMatch Match;
    ApiSet<string> HighlightedWords;
}

Related types: ChatEntryId, SearchMatch.

FoundContact ​

Represents a contact match from a search query. Source

csharp
public sealed partial class FoundContact(
    ContactId contactId,
    SearchMatch match
) : IHasSearchMatch
{
    ContactId ContactId;
    SearchMatch Match;
}

Related types: ContactId, SearchMatch.

SearchMatch ​

A search match: the matched Text, its Rank, and the highlight Parts — supplied explicitly (server results) or computed lazily from a SearchQuery (local results). Source

csharp
public sealed partial record SearchMatch
{
    string Text;
    double Rank;
    SearchMatchPart[] Parts;
}

Related types: SearchMatchPart.

SearchMatchPart ​

Represents a matched portion of text in a search result. Source

csharp
public record struct SearchMatchPart(Range<int> Range, double Rank)
{
    Range<int> Range;
    double Rank;
}

Related types: Range.

SearchResult ​

A paginated collection of search results. Source

csharp
public partial class SearchResult<TItem> where TItem : class, IHasSearchMatch
{
    TItem[] Items;
    int Offset;
}

SearchScope ​

Defines the type of entities to search for. Source

csharp
public enum SearchScope
{
    People = 0,
    Groups = 1,
    Places = 2,
    Messages = 3,
}