Skip to main content

CommsURLInfo

type CommsURLInfo = {
  channelId: string | null;
  commentId: string | null;
  conversationId: string | null;
  isQuoteReference: boolean;
  messageId: string | null;
  threadId: string | null;
  type: CommsLinkType;
  workspaceId: string;
};

The entity a Comms URL points at.

Properties​

channelId​

channelId: string | null;

The ID of the channel, when the URL names one.

commentId​

commentId: string | null;

The ID of the comment, when the URL names one.

conversationId​

conversationId: string | null;

The ID of the conversation, when the URL names one.

isQuoteReference​

isQuoteReference: boolean;

Whether the URL points at a quoted reference rather than the entity itself.

messageId​

messageId: string | null;

The ID of the message, when the URL names one.

threadId​

threadId: string | null;

The ID of the thread, when the URL names one.

type​

type: CommsLinkType;

The kind of entity the URL points at.

workspaceId​

workspaceId: string;

The ID of the workspace the entity belongs to.