Example for Teams link unfurling

[yukun-dong]

Describe your user scenario

I want to use this SDK to build a link unfurling app. I see you already provide APIs for queryLink and anonymousQueryLink but I don't know how to use them. In specific, I don't know what should be passed into commandId since link unfurling doesn't have a commandId in manifest. Therefore, It would be great if you can provide a sample of this.
MessageExtensions.ts L260
MessageExtensions.ts L39

Describe the solution you'd like

Provide a js sample for link unfurling.

Describe alternatives you've considered

Provide documents on how to use queryLink and anonymousQueryLink.

[corinagum]

Hi @yukun-dong,

1. First, may I ask if you have seen this documentation on Link unfurling? There is some setup in the dev portal that you may or may not already be aware of. The documentation includes how to:
   • Enable message extensions on your bot when manual unfurling is not necessary
   • Update app manifest composeExtensions
   • See invoke invoke handler documentation
2. Similar to the search extension sample you'll set up your queryLink payload to return the card you want to unfurl based off of the query link

app.messageExtensions.queryLink('unfurlCmd', async (context, state): MessageExtensionActionResponse => {
   // get url from activity (or possibly parse url from text)
   const queryLink = context.activity.value 
   // TODO: validate queryLink is valid URL
   // TODO: potentially do API call with valid URL to get details (e.g. image url, title, etc) e.g.:
   const response = await axios.get(queryLink.ApiCall());

   const card = AdaptiveCardPayload;    // AdaptiveCardPayload can be a pre-formatted Adaptive Card json file. 
   card.imageUrl = response.image.imgUrl;
   card.subtitle = response.image.altText;
   return card;
});

// result: new activity with Adaptive Card attachment is sent

Since there's plenty of documentation already in existence, I think that a sample will be unnecessary. :)

[yukun-dong]

Hi @corinagum , thanks for the reply.
Actually I want to figure out what's the first parameter that should be passed to app.messageExtensions.queryLink(), because link unfurling is different to action and search, it doesn't have a commandId.

[corinagum]

@yukun-dong The command id can be whatever you (the developer) wants it to be. The first parameter is the string or RegExp pattern you will use to call it within the bot, as needed. Since the code for this sends the activity, you will want to call it explicitly.

    /**
     * Registers a handler that implements a Link Unfurling based Message Extension.
     * @param commandId ID of the command(s) to register the handler for.
     * @param handler Function to call when the command is received.
     * @param handler.context Context for the current turn of conversation with the user.
     * @param handler.state Current state of the turn.
     * @param handler.url The URL that should be unfurled.
     * @returns The application for chaining purposes.
     */
    public queryLink(