Share via

SaveEvent interface

  • Reference
Package:
@microsoft/teams-js

Describes the results of the settings.save event. Includes result, notifySuccess, and notifyFailure to indicate the return object (result) and the status of whether the settings.save call succeeded or not and why.

Properties

result

Object containing properties passed as arguments to the settings.save event.

Methods

notifyFailure(string)

Indicates that creation of the underlying resource failed and that the config cannot be saved.
notifySuccess()

Indicates that the underlying resource has been created and the config can be saved.

Property Details

result

Object containing properties passed as arguments to the settings.save event.

result: SaveParameters

Property Value

SaveParameters

Method Details

notifyFailure(string)

Indicates that creation of the underlying resource failed and that the config cannot be saved.

function notifyFailure(reason?: string)

Parameters

reason

string

Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.

notifySuccess()

Indicates that the underlying resource has been created and the config can be saved.

function notifySuccess()