Partager via

NotificationOptions interface

  • Reference
Package:
@microsoft/teamsfx

Options to initialize NotificationBot.

Properties

botAppId

An optional input of bot app Id.
storage

An optional storage to persist bot notification target references.
store

An optional store to persist bot notification target references.

Property Details

botAppId

An optional input of bot app Id.

botAppId?: string

Property Value

string

Remarks

If botAppId is not provided, process.env.BOT_ID will be used by default.

storage

Warning

This API is now deprecated.

Use store to customize the way to persist bot notification target references instead.

An optional storage to persist bot notification target references.

storage?: NotificationTargetStorage

Property Value

NotificationTargetStorage

Remarks

If storage is not provided, a default local file storage will be used, which stores notification target references into:

  • .notification.localstore.json if running locally
  • ${process.env.TEMP}/.notification.localstore.json if process.env.RUNNING_ON_AZURE is set to "1"

It's recommended to use your own shared storage for production environment.

store

An optional store to persist bot notification target references.

store?: ConversationReferenceStore

Property Value

ConversationReferenceStore

Remarks

If store is not provided, a default conversation reference store will be used, which stores notification target references into:

  • .notification.localstore.json if running locally
  • ${process.env.TEMP}/.notification.localstore.json if process.env.RUNNING_ON_AZURE is set to "1"

It's recommended to use your own store for production environment.