Skip to main content

SearchResult

type SearchResult =
| {
channelColor?: number | null;
channelId?: string | null;
channelName?: string | null;
closed?: boolean | null;
commentId?: string | null;
id: string;
snippet: string;
snippetCreatorId: number;
snippetLastUpdated: Date;
threadId: string;
title?: string | null;
type: "thread";
}
| {
channelColor?: number | null;
channelId?: string | null;
channelName?: string | null;
closed?: boolean | null;
conversationId: string;
id: string;
messageId?: string | null;
snippet: string;
snippetCreatorId: number;
snippetLastUpdated: Date;
title?: string | null;
type: "conversation";
};

Union Members

Type Literal

{
channelColor?: number | null;
channelId?: string | null;
channelName?: string | null;
closed?: boolean | null;
commentId?: string | null;
id: string;
snippet: string;
snippetCreatorId: number;
snippetLastUpdated: Date;
threadId: string;
title?: string | null;
type: "thread";
}
NameTypeDescription
channelColor?number | null-
channelId?string | null-
channelName?string | null-
closed?boolean | null-
commentId?string | nullThe matched comment id, set when the match is a comment.
idstringOpaque search-result key in the form thread_<threadId> or conversation_<conversationId>. Unique per result; not a Comms object id — use threadId, conversationId, commentId, or messageId to reference objects.
snippetstring-
snippetCreatorIdnumber-
snippetLastUpdatedDate-
threadIdstringThe owning thread id.
title?string | null-
type"thread"-

Type Literal

{
channelColor?: number | null;
channelId?: string | null;
channelName?: string | null;
closed?: boolean | null;
conversationId: string;
id: string;
messageId?: string | null;
snippet: string;
snippetCreatorId: number;
snippetLastUpdated: Date;
title?: string | null;
type: "conversation";
}
NameTypeDescription
channelColor?number | null-
channelId?string | null-
channelName?string | null-
closed?boolean | null-
conversationIdstringThe owning conversation id.
idstringOpaque search-result key in the form thread_<threadId> or conversation_<conversationId>. Unique per result; not a Comms object id — use threadId, conversationId, commentId, or messageId to reference objects.
messageId?string | nullThe matched message id.
snippetstring-
snippetCreatorIdnumber-
snippetLastUpdatedDate-
title?string | null-
type"conversation"-