addLink

📘

This function is only available on context of types singleConversation, multiConversations and messageComposer

function addLink(externalUrl: string, name?: string, cancelToken?: CancelToken): Promise<Link>;

Front deduplicates Link by their type and URL. If a link already exists, the selected conversations will be added to the existing one.

Parameters

ParameterTypeDescription
externalUrlStringURL of the link
nameString (optional)Human readable name
cancelTokenCancelToken (optional)Token to cancel the request

Return value

The function returns a promise that resolves with the Link added.

Errors

MessageDescription
The draft's conversation is not selected.This error applies to composer plugins. It occurs when the messageComposer context for composer plugins does not have access to the conversation. To avoid this error, disable the functionality of this method whenever the conversation property does not exist in the messageComposer context. Learn more in the Context topic.