Class: Card

Card

Abstract base for news feed cards. Use subclasses ab.ClassicCard, ab.CaptionedImage, ab.Banner, and ab.ControlCard.

<abstract> new Card()

Methods

removeAllSubscriptions()

Remove all event subscriptions from this message.

removeSubscription(subscriptionGuid)

Remove an event subscription that you previously subscribed to.

Parameters:
Name Type Description
subscriptionGuid string

The identifier of the subscription you wish to remove, returned by the method you initially used to create it.

subscribeToClickedEvent(subscriber) → {string}

Subscribe to receive click events. The subscriber callback will be called whenever this card is clicked by the user.

Parameters:
Name Type Description
subscriber function

The callback function to receive click events. This function will be invoked with no arguments when this card records a click.

Returns:

The identifier of the subscription created. This can be passed to removeSubscription to cancel the subscription.

Type
string

subscribeToDismissedEvent(subscriber) → {string}

Subscribe to receive dismissed events. The subscriber callback will be called whenever this card is dismissed by the user.

Parameters:
Name Type Description
subscriber function

The callback function to receive dismissed events. This function will be invoked with no arguments when this card records a dismissal.

Returns:

The identifier of the subscription created. This can be passed to removeSubscription to cancel the subscription.

Type
string