teamsNotifyUser does not accept messages returned from MessageFactory.

[eoinobrien]

Github issues should be used for bugs and feature requests. Use Stack Overflow for general "how-to" questions.

Versions

What package version of the SDK are you using: 1.15.0
What nodejs version are you using: 16.11.0
What browser version are you using: n/a, this is a typescript compiler error
What os are you using: Win 11, 22H2, 22567.200

Describe the bug

When using teamsNotifyUser in a typescript application the example provided by the docs on how to notify someone does not work.
Instead, the following error is returned:

Argument of type 'Partial<Activity>' is not assignable to parameter of type 'Activity'.
  Property 'type' is optional in type 'Partial<Activity>' but required in type 'Activity'.ts(2345)

This is because MessageFactory.text('Message'); returns a Partial<Activity> while teamsNotifyUser() requires a straight Activity.

To Reproduce

1. In Teams Toolkit, create a new app. Selecting only Bot as a capability and Typescript as the language.
2. In bot/teamsBot.ts replace

case "welcome": {
    const card = AdaptiveCards.declareWithoutData(rawWelcomeCard).render();
    await context.sendActivity({ attachments: [CardFactory.adaptiveCard(card)] });
    break;
}

with

case "welcome": {
    let message = MessageFactory.text("You'll get a notification, if you've turned them on.");
    teamsNotifyUser(message);
    await context.sendActivity(message);
}

3. From ./bot run npm run build
4. See the following build error:

teamsBot.ts:39:27 - error TS2345: Argument of type 'Partial<Activity>' is not assignable to parameter of type 'Activity'.
  Property 'type' is optional in type 'Partial<Activity>' but required in type 'Activity'.

39           teamsNotifyUser(message);

Expected behavior

To be able to call teamsNotifyUser() with the value returned from the MessageFactory.

Screenshots

Additional context

I debated creating a bug against the SDK or the docs but felt it made more sense to create it here.

[breakingram]

Hey @eoinobrien, have you tried using type assertion to bypass the error?

example:

teamsNotifyUser(message as Activity);

Let me know if this worked. Thanks.

[eoinobrien]

Hi @ramfattah,

Good catch that does solve the problem thanks for suggesting.

Should I create a bug against the Docs to fix the issue here: https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/conversations/conversation-messages?tabs=typescript#notifications-to-your-message or is that something you can do?

[ceciliaavila]

@mrivera-ms in progress