Class TeamsKlaxon

Index

Constructors

Methods

makeCard cardIsValid postCard

Constructors

constructor

new TeamsKlaxon(webhook: string): TeamsKlaxon
Create a new TeamsKlaxon instance with your Teams Workflow webhook URL.

Note: This library uses the attachments format which works with most Teams Workflows.
Parameters
- webhook: string
  A Teams Workflow webhook URL
Returns TeamsKlaxon
Example
```
const klaxon = new TeamsKlaxon('https://prod.workflows.office.com/webhook/...');
```

Methods

makeCard

makeCard(contentItems: ContentItem[]): void
Make an adaptive card.
Parameters
- contentItems: ContentItem[]
  Card contents
Returns void
Example
```
klaxon.makeCard([
  Elements.TextBlock('Hello _world_!'),
]);
```

cardIsValid

cardIsValid(): boolean

Verify a card is valid.

Returns boolean

Example

klaxon.makeCard([
  Elements.TextBlock('Hello _world_!'),
]);

klaxon.cardIsValid();
// true

postCard

postCard(): Promise<AxiosResponse<any, any, {}> | undefined>
Post your card to Teams.

Returns Promise<AxiosResponse<any, any, {}> | undefined>
Example
```
klaxon.makeCard([
  Elements.TextBlock('Hello _world_!'),
]);

const response = await klaxon.postCard();

response.status
// 202
```