InstanceConfig interface

Package:

@microsoft/teams-js

Defines the configuration of the current or desired instance

Properties

contentUrl	Sets the URL to use for the content of this instance.
entityId	The developer-defined unique ID for the entity to which this content points.
removeUrl	Sets the URL for the removal configuration experience.
suggestedDisplayName	A suggested display name for the new content. In the settings for an existing instance being updated, this call has no effect.
websiteUrl	Sets the URL to use for the external link to view the underlying resource in a browser.

Property Details

contentUrl

Sets the URL to use for the content of this instance.

contentUrl: string

Property Value

string

entityId

The developer-defined unique ID for the entity to which this content points.

entityId?: string

Property Value

string

removeUrl

Sets the URL for the removal configuration experience.

removeUrl?: string

Property Value

string

suggestedDisplayName

A suggested display name for the new content. In the settings for an existing instance being updated, this call has no effect.

suggestedDisplayName?: string

Property Value

string

websiteUrl

Sets the URL to use for the external link to view the underlying resource in a browser.

websiteUrl?: string

Property Value

string