Class TeamsKlaxon

Hierarchy

  • TeamsKlaxon

Constructors

constructor

Properties

_webhook _card?

Methods

makeCard _formatMessage cardIsValid postCard

Constructors

constructor

  • Example

    const klaxon = new TeamsKlaxon('https://trten.webhook.office.com/...');

    Parameters

    Returns TeamsKlaxon

Properties

Private _webhook

_webhook: string

Optional Private _card

_card?: AdaptiveCardContent

Methods

makeCard

  • Make an adaptive card.

    Example

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

    Parameters

    Returns void

Private _formatMessage

  • _formatMessage(): undefined | Message
  • Private

    Returns undefined | Message

cardIsValid

  • Verify a card is valid.

    Example

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

    klaxon.cardIsValid();
    // true

    Returns

    Returns boolean

postCard

  • Post your card to Teams.

    Example

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

    const response = await klaxon.postCard();

    response.status
    // 200

    Returns Promise<undefined | AxiosResponse<any, any>>

Settings

Member Visibility

Theme

Generated using TypeDoc