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";
userIds?: number[];
};
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";
}
| Name | Type | Description |
|---|---|---|
channelColor? | number | null | - |
channelId? | string | null | - |
channelName? | string | null | - |
closed? | boolean | null | - |
commentId? | string | null | The matched comment id, set when the match is a comment. |
id | string | Opaque 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. |
snippet | string | Text of the match. The API can send null for a result with no snippet text; that arrives here as an empty string, so one such result doesn't fail the page. |
snippetCreatorId | number | - |
snippetLastUpdated | Date | - |
threadId | string | The 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";
userIds?: number[];
}
| Name | Type | Description |
|---|---|---|
channelColor? | number | null | - |
channelId? | string | null | - |
channelName? | string | null | - |
closed? | boolean | null | - |
conversationId | string | The owning conversation id. |
id | string | Opaque 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 | null | The matched message id. Absent when the match is the conversation's title. |
snippet | string | Text of the match. The API can send null for a result with no snippet text; that arrives here as an empty string, so one such result doesn't fail the page. |
snippetCreatorId | number | - |
snippetLastUpdated | Date | - |
title? | string | null | - |
type | "conversation" | - |
userIds? | number[] | The conversation's members. |