This log was last generated on Thu, 08 Sep 2022 17:11:49 GMT and should not be manually modified.
Thu, 08 Sep 2022 17:11:49 GMT
- Added support for audio-driven avatars to the
video
API, and the ability to upload personalized video effects to the private folder - Added
Search
capability to use global search box in the current app in Outlook - Added
timestamp
toVideoFrame
, sent thetimestamp
back to Teams client after the video frame has been processed.
- Fixed an issue with the v1 versions of
register*Handler
functions. Previously if the v2 version of the API's capability was not supported, attempts to call the v1 version would throw an exception, breaking backwards compatibility. - Updated documentation for many properties on
Context
interface. - Updated comments on items marked with the
@internal
tag to make it clear they are intended for Microsoft use only and removed some@internal
items from dev documentation. RemovedinitializePrivateApis
from the privateAPIs file, an unexported and hidden no-op function. - Added missing
HostClientType
values so correctRuntime
is generated forteams.fullTrust.joinedTeams
andwebStorage
capabilities. - Renamed
filePath
field towebkitRelativePath
. Removed two validation checks fordestinationFolder
fields. Added an optional fieldprovider
in callback ofaddCloudStorageProvider
API.
Wed, 03 Aug 2022 19:21:51 GMT
- Added an optional error object to
ISpeakingState
interface to alignregisterSpeakingStateChangeHandler
API with other API error handling. - Added
ActionInfo
object to theContext
interface. This is used to pass information about an action that was taken on content from the host to the application. - Split single
CloudStorageProviderFile
action API into 3 action APIs
- Added clarifying comment to
dialog.submit
to indicate the dialog is closed whensubmit
is called. - Updated reference documentation links for deprecated global
Context
interface to work with typedoc system. - Added
FrameContexts.task
toopenChat
andopenGroupChat
in chat.ts - Added
@beta
tags to new content action-related interfaces. - Exported publicly documented global interfaces to enable use outside the SDK.
Fri, 22 Jul 2022 16:36:44 GMT
- Added
webStorage
capability with APIs to allows apps to discover if web storage is supported by the host client - Added 3P cloud storage provider API support to files.ts
- Added
isSupported
tostageView
- Added
profile.showProfile
API and unit tests - Added
meeting.registerMeetingReactionReceivedHandler
- Added
scanBarCode
to barCode.ts from media.ts along with permission APIshasPermission
andrequestPermission
- Added a new capability
geoLocation
that split the location capability into new set of functions and subcapabilities. Added permission-related APIshasPermission
andrequestPermission
.
- Fixed broken SDK reference documentation links and added SDK reference documentation validation to build step.
- Ensured
submitHandler
exists before calling it indialog.open
,dialog.bot.open
andtasks.startTask
APIs. - Added frameless unit tests for
authentication.notifySuccess
andauthentication.notifyFailure
- Added beta tag to
barCode
capability to accurately reflect level of support offered - Added
meeting.registerRaiseHandStateChangedHandler
- Updated reference documentation for global deprecated
Context
interface. Each deprecatedContext
property now links to respective mapped property inapp.Context
interface. - Enabled
FrameContexts.task
forstartCall
API in call.ts - Fixed formatting of reference documentation for
call.StartCallParams
interface. - Removing unnecessary
/
inappInstallDialog.openAppInstallDialog()
- Renamed
IRaiseHandStateChangedEvent
interface toIRaiseHandStateChangedEventData
and changed the error so it can be assigned undefined rather than null
Fri, 13 May 2022 22:32:13 GMT
The change log comments for v2.0.0 are a consolidated summary of the comments for each beta release to describe the changes made since v1. Detailed change log comments for each beta release follow after 2.0.0.
-
Promote 2.0.0 beta changes to stable. TeamsJS can be used to write applications with support in multiple Microsoft 365 hosts, including Teams, Outlook, and Office.
-
The Teams JavaScript client SDK repo has been converted to a monorepo
- Utilized Yarn Workspaces to turn our repo into a monorepo.
- The files specific to the Teams client SDK have been moved to an inner directory with the name
teams-js
- A new TeamsJS Test App for validating the Teams client SDK has been added in the /apps/teams-test-app location.
-
Reverted
registerEnterSettingsHandler
back to its original nameregisterChangeSettingsHandler
-
Removed deprecated
stageView.open
function that took a callback as a parameter -
Modified
enablePrintCapability
to correctly require the library be initialized before using it -
Removed
bot
namespace and APIs -
Added
hostName
property toContext
interface which contains the name of the host in which the app is running. -
The
Context
interface has been updated to group similar properties for better scalability in a multi-host environment. -
The
FrameContext
interface has been renamedFrameInfo
. -
Capabilities organization introduced
-
Each capability has an
isSupported
function that is used to determine if a capability is supported in the host in which the application is running. All APIs call this function and will throw anSdkError
withErrorCode.NOT_SUPPORTED_ON_PLATFORM
if it returns false. -
Added App capability
- The following APIs have been moved from
publicAPIs
to newapp
namespace:initialize
getContext
registerOnThemeChangeHandler
executeDeepLink
has been renamedopenLink
- The following APIs have been moved from
appInitialization
toapp
namespace:notifyAppLoaded
notifySuccess
notifyFailure
notifyExpectedFailure
- The following APIs have been added to
app
namespace:isInitialized
getFrameContext
- The following APIs have been moved from
-
Added a Pages capability and reorganized several APIs under it:
- The following APIs have been moved to the new
pages
namespace:registerFullScreenHandler
moved frompublicAPIs
initializeWithFrameContext
moved frompublicAPIs
navigateCrossDomain
moved fromnavigation
namespacereturnFocus
moved fromnavigation
namespaceregisterFocusEnterHandler
moved frompublicAPIs
shareDeepLink
moved frompublicAPIs
DeepLinkParameters
has been renamed toShareDeepLinkParameters
setFrameContext
has been moved frompublicAPIs
and renamedpages.setCurrentFrame
settings.getSettings
has been renamedpages.getConfig
- Added
pages.navigateToApp
that navigates to the given application ID and page ID, with optional parameters for a WebURL (if the application cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab), and sub-page ID (for navigating to specific content within the page). - The following APIs have been been renamed and moved from
publicAPIs
to a new Pages.AppButton sub-capability in the newpages.appButton
namespace:registerAppButtonClickHandler
has renamed and moved topages.appButton.onClick
registerAppButtonHoverEnterHandler
has renamed and moved topages.appButton.onHoverEnter
regsiterAppButtonHoverLeaveHandler
has renamed and moved topages.appButton.onHoverLeave
- The following APIs have been moved to a new Pages.BackStack sub-capability in the new
pages.backStack
namespace:registerBackButtonHandler
moved frompublicAPIs
navigateBack
moved fromnavigation
namespace
- The following APIs have been renamed and moved into the Pages.Config sub-capability in the
pages.config
namespace (formerly thesettings
namespace):registerEnterSettingsHandler
has renamed and moved topages.config.registerChangeConfigHandler
registerOnSaveHandler
registerOnRemoveHandler
setSettings
has been renamedpages.config.setConfig
setValidityState
- The following APIs have been been moved from
privateAPIs
to a new Pages.FullTrust sub-capability in the newpages.fullTrust
namespace:enterFullscreen
exitFullscreen
- The following APIs have been been moved to a new Pages.Tabs sub-capability in the new
pages.tabs
namespace:getTabInstances
moved frompublicAPIs
getMruTabInstances
moved frompublicAPIs
navigateToTab
moved fromnavigation
namespace
- The following APIs have been moved to the new
-
Tasks APIs renamed and reorganized under new Dialog capability:
- Added
dialog
capability, which has support for HTML-based dialogs, and adialog.bot
sub-capability has been added for bot-based dialogs. At this time,dialog
does not support adaptive card-based dialogs.- The following APIs have been renamed:
startTask
has been renameddialog.open
. It takes- a
UrlDialogInfo
parameter instead ofDialogInfo
to enforce only HTML based dialogs, - an optional
DialogSubmitHandler
callback that takes a single object parameter containing both error and result, - an optional
PostMessageChannel
parameter which is triggered if dialog sends a message to the app
- a
dialog.bot.open
has the same function signature except it takesBotUrlDialogInfo
instead ofUrlDialogInfo
submitTasks
has been renameddialog.submit
TaskInfo
interface has been renamedDialogInfo
TaskModuleDimension
enum has been renamedDialogDimension
- Added
sendMessageToDialog
function which can be used to send messages to the dialog.
- The following APIs have been renamed:
- Added
dialog.update
sub-capability and renamedupdateTask
todialog.update.resize
, which now takes aDialogSize
parameter.
- Added
-
Added TeamsCore capability
- The following APIs have been moved from
publicAPIs
to newteamsCore
namespace:enablePrintCapability
print
registerOnLoadHandler
registerBeforeUnloadHandler
- The following APIs have been moved from
-
Added AppInstallDialog capability
openAppInstallDialog
is added to newappInstallDialog
namespace
-
Added Calendar capability
- The following APIs have been added to new
calendar
namespace:openCalendarItem
is addedcomposeMeeting
is added
- The following APIs have been added to new
-
Added Call capability
startCall
is added to newcall
namespace
-
Added Mail capability
- The following APIs have been added to the new
mail
namespace:openMailItem
is addedcomposeMail
is added
- The following APIs have been added to the new
-
Added Chat capability to new
chat
namespace to represent public chat functionality- Added
openChat
andopenGroupChat
to open Teams chats with one or more users
- Added
-
Converted existing
conversations
namespace into the Conversations capability to represent private chat functionalitygetChatMembers
has been moved fromprivateAPIs
toconversations
namespace
-
Added
fullTrust
andfullTrust.joinedTeams
sub-capabilities to existingteams
namespace- The following API has been moved from
privateAPIs
to a newteams.fullTrust
namespace:getConfigSetting
- The following API has been moved from
privateAPIs
to a newteams.fullTrust.joinedTeams
namespace:getUserJoinedTeams
- The following API has been moved from
-
Added Notifications capability
showNotification
has moved fromprivateAPIs
tonotifications
namespace
-
Converted existing namespaces into the following new capabilites
- Location
- Menus
- Monetization
- People
- Sharing
- Video
- Logs
- MeetingRoom
- RemoteCamera
- Teams
-
Added Runtime capability
- Added
applyRuntimeConfig
- Added
-
-
Promises introduced
- The following APIs that took in a callback function as a parameter now instead return a
Promise
.- app APIs:
app.initialize
app.getContext
- authentication APIs:
authentication.authenticate
authentication.getAuthToken
authentication.getUser
- conversations APIs:
conversations.getChatMembers
conversations.openConversation
- location APIs:
location.getLocation
location.showLocation
- meetingRoom APIs:
meetingRoom.getPairedMeetingRoomInfo
meetingRoom.sendCommandToPairedMeetingRoom
- pages APIs:
pages.navigateCrossDomain
pages.tabs.navigateToTab
pages.tabs.getTabInstances
pages.tabs.getMruTabInstances
pages.getConfig
pages.config.setConfig
pages.backStack.navigateBack
- people APIs:
people.selectPeople
- teams APIs:
teams.fulltrust.getConfigSetting
teams.fulltrust.getUserJoinedTeams
- others:
ChildAppWindow.postMessage
ParentAppWindow.postMessage
appInstallDialog.openAppInstallDialog
- app APIs:
- The following APIs that took in a callback function as a parameter now instead return a
-
Changed TypeScript to output ES6 modules instead of CommonJS
- Updated
app.initialize
to automatically listen for messages that an application is sending to a dialog. ModifiedregisterOnMessageFromParent
in DialogAPI.tsx for the Teams Test App to account for this new functionality. - Copied
ParentAppWindow
functionality intodialog
capability. Indialog
,ParentAppWindow.postMessage
was renamed todialog.sendMessageToParent(message: any): void
.ParentAppWindow.addEventListener
was renamed todialog.registerOnMessageFromParent
. - Added
runtime.isLegacy
handler for the following deep link capabilities:appInstallDialog
calendar
call
- Changed topic parameter name to
topicName
forexecuteDeepLink
call in chat.ts - When the application host will not understand standard chat requests, added logic to send them as deep links.
- Added a link to information about the updated
Context
in the reference documentation comments - Updated all
@deprecated
tags to reference version 2.0.0 - Added directory field to repository info in package.json
- Added missing reference documentation comments to interfaces, functions, and enums in app.ts and appInitialization.ts
- Added missing reference documentation comments to the
pages
capability - Added missing reference documentation comments to the
authentication
capability - Updated reference documentation comments to rationalize 'Teams' vs 'host' occurrences and other minor edits
- Updated
dialog.open
anddialog.bot.open
to sendDialogInfo
type over to the host instead ofUrlDialogInfo
orBotUrlDialogInfo
types - Added
minRuntimeConfig
touninitialize
for various capabilities - Updated README.md to reflect branch rename
- In adaptive card based task modules, if the height is not provided in
taskInfo
, it will not be set to a default small size. Instead the card content will be set to fit on a Task Module. - Added office365 Outlook to domain allowlist
- Updated comment for
initializePrivateApis
explaining that this function needs to stay for backwards compatibility purposes - In appWindow.ts file, converted
ChildAppWindow
andParentAppWindow
back to synchronous calls because the promise was never being resolved. - Fixed
teamsRuntimeConfig
(default backwards compatible host client runtime config) to not containlocation
orpeople
capabilities since those are not guaranteed to be supported. Added new function to dynamically generate backwards compatible host client runtime config during initialization. - Added
ensureInitialized
call toregisterOnMessageFromParent
function in dialog.ts andaddEventListener
function in appWindow.ts - Removed the duplicate property of
StageLayoutControls
type inmeetingRoom
capability null
runtimeConfig is no longer allowed during initialization. This will now throw a "Received runtime config is invalid" error.- Update TSDoc
@deprecated comments
to include links to replaced APIs. - Update webpack-dev-server types to match webpack 5 versions and stop generating module wrappers in MicrosoftTeams.d.ts.
- Fix warnings produced during documentation generation, including exporting additional existing interfaces.
- Update integrity hash to valid value in README file.
Thu, 12 May 2022 21:34:49 GMT
- Moved sub-capabilities and APIs within
legacy
namespace toteams
namespace - Reverted
registerEnterSettingsHandler
back to its original nameregisterChangeSettingsHandler
- Removed deprecated
stageView.open
function that took a callback as a parameter
- Added missing reference documentation comments to the
pages
capability - Added a link to information about the updated
Context
in the reference documentation comments - Updated all
@deprecated
tags to reference version 2.0.0 - Added missing reference documentation comments to interfaces, functions, and enums in app.ts and appInitialization.ts
- Added directory field to repository info in package.json
- Added missing reference documentation comments to the
authentication
capability - Updated reference documentation comments to rationalize 'Teams' vs 'host' occurrences and other minor edits
Thu, 28 Apr 2022 18:25:41 GMT
- Updated
files
namespace to work as it did in v1 along with necessary changes to unit tests and teams-test-app - Updated
media
namespace to work as it did in v1 along with necessary changes to unit tests and teams-test-app - Updated
meeting
namespace to work as it did in v1 along with necessary changes to unit tests and teams-test-app - Integrated changes from v1, week of 4/18/2022
IMeetingDetails
has been renamed toIMeetingDetailsResponse
andIDetails
has been replaced withIMeetingOrCallDetailsBase<T>
. As such,meeting.getMeetingDetails()
now takes in a callback which takes inIMeetingDetailsResponse
rather thanIMeetingDetails
.pages.returnFocus()
now works in anyFrameContext
rather than just withFrameContext.content
.- Added
HostClientType.ipados
.
- Added
isSupported
checks to all functions in the following capabilities:appEntity
dialog
legacy
logs
menus
meetingRoom
monetization
notifications
(along with additional unit test cases)pages
people
remoteCamera
sharing
(along with additional unit test case)teams
teamsCore
video
- Modified
enablePrintCapability
to correctly require the library be initialized before using it
- Added
dialog.initialize
function.dialog.initialize
is called during app intialization.- Modified
registerOnMessageFromParent
in DialogAPI.tsx for the Teams Test App to account for this new functionality.
- Updated
dialog.open
anddialog.bot.open
to sendDialogInfo
type over to the host instead ofUrlDialogInfo
orBotUrlDialogInfo
types - Added
minRuntimeConfig
touninitialize
for various capabilities - Updated README.md to reflect branch rename
- In adaptive card based task modules, if the height is not provided in
taskInfo
, it will not be set to a default small size. Instead the card content will be set to fit on a Task Module. - Removed
@deprecated
tags from meeting.ts and media.ts - Removed
@alpha
tags as they are not supported in the SDK reference doc generation system
Tue, 19 Apr 2022 16:08:56 GMT
- Removed
PostMessageChannel
returned fromdialog.open
, added separate functionsendMessageToDialog
to make up for missing functionality - Change DeepLinkParameters not to use subEntity* anymore
- Added
isSupported
checks to all functions and unit test cases in the following capabilities:chat
conversations
files
location
- Added
runtime.isLegacy
handler for the following deep link capabilities:appInstallDialog
calendar
call
- Changed topic parameter name to
topicName
forexecuteDeepLink
call in chat.ts
- Moved
conversations
sub-capability out ofchat
capability and into its own top level capability in runtime.ts - Added
isSupported
tolegacy
capability
Wed, 13 Apr 2022 21:40:51 GMT
legacy.fullTrust.getUserJoinedTeams()
has been moved into its own sub-capability calledjoinedTeams
and is nowlegacy.fullTrust.joinedTeams.getUserJoinedTeams()
.- The type
PostMessageChannel
andsendMessageToParentFromDialog
function indialog
capability have been updated to no longer take callback parameters. - Split
chat
capability into a private (conversation
) and a public (chat
) partition - Updated
dialog
capability as follows:- The top-level
dialog
capability supports HTML-based dialogs and adialog.bot
sub-capability has been added for bot-based dialogs. At this time,dialog
does not support adaptive card-based dialogs, dialog.open
takes aUrlDialogInfo
parameter instead ofDialogInfo
to enforce only HTML based dialogs,submitHandler
callback takes a single object parameter containing both error and result,dialog.open
takes one more optional parameter namedmessageFromChildHandler
which is triggered if dialog sends a message to the app,dialog.open
returns a function that can be used to send messages to the dialog instead of returning aChildAppWindow
,dialog.bot.open
has the same function signature except it takesBotUrlDialogInfo
instead ofUrlDialogInfo
- The top-level
- Moved
chat.openConversation
andchat.closeConversation
intochat.conversation
sub-capability. Added new APIschat.openChat
andchat.openGroupChat
as a replacement to open Teams chats with one or more user - Moved
dialog.resize()
function to a newupdate
sub-capability and is nowdialog.update.resize()
. The parameter has been changed toDialogSize
type - Removed
bot
namespace and APIs.
- Integrated changes from v1, week of 4/7/2022
- Added
surfaceHub
toHostClientType
interface - Added
ISpeakingState
interface andregisterSpeakingStateChangeHandler
function to meeting.ts and added appropriate unit tests to meeting.spec.ts
- Added
- Integrated changes from v1, week of 4/9/2022
- Removed private tag for
sharing
- Moved
menu
APIs from private to public directories - Added new
files
APIsFileDownloadStatus
enumIFileItem
interfacegetFileDownloads
andopenDownloadFolder
functions
- Removed private tag for
- Copied
ParentAppWindow
functionality intodialog
capability. Indialog
,ParentAppWindow.postMessage
was renamed todialog.sendMessageToParent(message: any): void
.ParentAppWindow.addEventListener
was renamed todialog.registerOnMessageFromParent
. - Renamed
conversation
namespace toconversations
for consistency - Integrated changes from v1, week of 3/29/2022
- The following APIs in meeting.ts will now work in the
FrameContext.meetingStage
context:shareAppContentToStage
getAppContentStageSharingCapabilities
stopSharingAppContentToStage
getAppContentStageSharingState
- The following APIs in meeting.ts will now work in the
- When the application host will not understand standard chat requests, added logic to send them as deep links.
- Integrated changes from v1, week of 2/28/2022
- Added
stageView
implementation - Modified
dialog.resize
anddialog.submit
to work in the followingFrameContexts
in addition toFrameContexts.task
:sidePanel
content
meetingStage
- Added
- Added office365 Outlook to domain allowlist
- Updated comment for
initializePrivateApis
explaining that this function needs to stay for backwards compatibility purposes - In appWindow.ts file, converted
ChildAppWindow
andParentAppWindow
back to synchronous calls because the promise was never being resolved. - Deprecated
stageView.open
function signature that takes a callback parameter in favor ofstageView.open
function signature that returns aPromise
- Validated
media
architecture - Fixed
teamsRuntimeConfig
(default backwards compatible host client runtime config) to not containlocation
orpeople
capabilities since those are not guaranteed to be supported. Added new function to dynamically generate backwards compatible host client runtime config during initialization. - Added
ensureInitialized
call toregisterOnMessageFromParent
function in dialog.ts andaddEventListener
function in appWindow.ts - Removed the duplicate property of
StageLayoutControls
type inmeetingRoom
capability - Deprecated
files.getFileDownloads
function signature that takes a callback parameter in favor orfiles.getFileDownloads
function signature that returns aPromise
Tue, 01 Mar 2022 19:50:49 GMT
- Moved
registerFocusEnterHandler
fromteamsCore
namespace topages
core.shareDeepLink
has been moved topages.shareDeepLink
core.executeDeepLink
has been renamed and moved toapp.openLink
pages.config.getConfig
has been moved topages.getConfig
- Added
pages.navigateToApp
that navigates to the given application ID and page ID, with optional parameters for a WebURL (if the application cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab), and sub-page ID (for navigating to specific content within the page).
- Change the
VideoControllerCallback
constructor function to make theonRecordingStarted
callback mandatory and makeonRecordingStopped
an optional property that can be passed to the constructor. This is because without theonRecordingStopped
, theVideoController
doesn't do anything.
- Functions will now throw errors instead of throwing strings across the repo.
null
runtimeConfig is no longer allowed during initialization. This will now throw a "Received runtime config is invalid" error.
- Update TSDoc
@deprecated comments
to include links to replaced APIs. - Update webpack-dev-server types to match webpack 5 versions and stop generating module wrappers in MicrosoftTeams.d.ts.
- Fix warnings produced during documentation generation, including exporting additional existing interfaces.
- Update repository URLs to reference
2.0-preview
branch.
- Update integrity hash to valid value in README file.
-
The Teams JavaScript client SDK repo is now a monorepo
- We utilized Yarn Workspaces to turn our repo into a monorepo.
The files specific to the Teams client SDK have been moved to an inner directory with the nameteams-js
- A new TeamsJS Test App for validating the Teams client SDK has been added in the /apps/teams-test-app location.
- We utilized Yarn Workspaces to turn our repo into a monorepo.
-
Several API functions have been moved and renamed.
Organized top-level library functions under a core namespace. For example,shareDeepLink
has been moved undercore
namespace.
Usingimport * as ... from ...
will now fail. Importing now follows the following convention:import { core } from '@microsoft/teams-js';
For more detailed API organization, please refer to the Capabilities organization introduced section below.
-
Support for
hostName
added to Context interface
The name of the host the app is running in is now part of the application context in thehostName
property. -
Several meeting APIs changes
meeting.requestStartLiveStreaming
andmeeting.requestStopLiveStreaming
no longer take in the parameter liveStreamState. -
Context interface changes
- The Context interface has been updated to group similar properties for better scalability in a multi-host environment.
- Context's
user.tenant.sku
has been renamed touser.tenant.teamsSku
to reflect that it is used by Teams for a different purpose than from the Graph API's user.tenant.sku's.
-
FrameContext changes
TheFrameContext
interface has been renamedFrameInfo
. -
appEntity.selectAppEntity now takes in an additional parameter and the callback has reversed parameters with one one of them becoming optional.
selectAppEntity( threadId: string, categories: string[], callback: (appEntity: AppEntity, sdkError?: SdkError) => void, ): void
is now:
selectAppEntity( threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void, ): void
-
threadId parameter removed from callback passed into teams.refreshSiteUrl()
refreshSiteUrl(threadId: string, callback: (threadId: string, error: SdkError) => void): void
is now:
refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void
-
Capabilities organization introduced
-
Added App capability
- The following APIs have been moved from
publicAPIs
to newapp
namespace:initialize
getContext
registerOnThemeChangeHandler
- The following APIs have been moved from
appInitialization
toapp
namespace:notifyAppLoaded
notifySuccess
notifyFailure
notifyExpectedFailure
- The following APIs have been added to
app
namespace:isInitialized
getFrameContext
- The following APIs have been moved from
-
Added Core capability
- The following APIs have been moved from
publicAPIs
to newcore
namespace:shareDeepLink
executeDeepLink
- The following APIs have been moved from
-
Several APIs reorganized under new Pages capability:
- The following APIs have been moved to the new
pages
namespace:registerFullScreenHandler
initializeWithFrameContext
navigateCrossDomain
returnFocus
setFrameContext
has been renamedpages.setCurrentFrame
- The following APIs have been been renamed and moved from
publicAPIs
to a new Pages.AppButton sub-capability in the newpages.appButton
namespace:registerAppButtonClickHandler
has renamed and moved topages.appButton.onClick
registerAppButtonHoverEnterHandler
has renamed and moved topages.appButton.onHoverEnter
regsiterAppButtonHoverLeaveHandler
has renamed and moved topages.appButton.onHoverLeave
- The following APIs have been moved to a new Pages.BackStack sub-capability in the new
pages.backStack
namespace:registerBackButtonHandler
navigateBack
- The following APIs have been renamed and moved into the Pages.Config sub-capability in the
pages.config
namespace (formerly thesettings
namespace):registerEnterSettingsHandler
has renamed and moved topages.config.registerChangeConfigHandler
getSettings
has been renamedpages.config.getConfig
setSettings
has been renamedpages.config.setConfig
- The following APIs have been been moved from
privateAPIs
to a new Pages.FullTrust sub-capability in the newpages.fullTrust
namespace:enterFullscreen
exitFullscreen
- The following APIs have been been moved to a new Pages.Tabs sub-capability in the new
pages.tabs
namespace:getTabInstances
getMruTabInstances
navigateToTab
- The following APIs have been moved to the new
-
Added Dialog capability, renamed
tasks
namespace todialog
, and renamed APIs- The following APIs have been renamed:
startTask
has been renameddialog.open
submitTasks
has been renameddialog.submit
updateTask
has been renameddialog.resize
TaskInfo
interface has been renamedDialogInfo
TaskModuleDimension
enum has been renamedDialogDimension
- The following APIs have been renamed:
-
Added TeamsCore capability
- The following APIs have been moved from
publicAPIs
to newteamsCore
namespace:enablePrintCapability
print
registerOnLoadHandler
registerBeforeUnloadHandler
registerFocusEnterHandler
- The following APIs have been moved from
-
Added AppInstallDialog capability
openAppInstallDialog
is added to newappInstallDialog
namespace
-
Added Calendar capability
- The following APIs have been added to new
calendar
namespace:openCalendarItem
is addedcomposeMeeting
is added
- The following APIs have been added to new
-
Added Call capability
startCall
is added to newcall
namespace
-
Added Mail capability
- The following APIs have been added to the new
mail
namespace:openMailItem
is addedcomposeMail
is added
- The following APIs have been added to the new
-
Added Chat capability and renamed
conversations
namespace tochat
openConversation
andcloseConversation
have been moved tochat
namespacegetChatMembers
has been moved tochat
namespace
-
Added Files capability
openFilePreview
has moved fromprivateAPIs
tofiles
namespace
-
Added Legacy capability
- The following APIs have been moved from
privateAPIs
to a newlegacy.fullTrust
namespace:getUserJoinedTeams
getConfigSetting
- The following APIs have been moved from
-
Added Notifications capability
showNotification
has moved fromprivateAPIs
tonotifications
namespace
-
Converted existing namespaces into the following new capabilites
- Location
- Media
- Meeting
- Monetization
- People
- Sharing
- Video
- Bot
- Logs
- MeetingRoom
- Menus
- RemoteCamera
-
Added Runtime capability
applyRuntimeConfig
is added
-
-
Promises introduced
- The following APIs that took in a callback function as a parameter now instead return a
Promise
.- app APIs:
app.initialize
app.getContext
- authentication APIs:
authentication.authenticate
authentication.getAuthToken
authentication.getUser
- calendar APIs:
calendar.openCalendarItem
calendar.composeMeeting
- chat APIs:
chat.getChatMembers
chat.openConversation
- files APIs:
files.addCloudStorageFolder
files.deleteCloudStorageFolder
files.getCloudStorageFolderContents
files.getCloudStorageFolders
- legacy APIs:
legacy.fulltrust.getConfigSetting
legacy.fulltrust.getUserJoinedTeams
- location APIs:
location.getLocation
location.showLocation
- mail APIs:
mail.openMailItem
mail.composeMail
- media APIs:
media.captureImage
media.selectMedia
media.viewImages
media.scanBarCode
- meeting APIs:
meeting.getAppContentStageSharingState
meeting.getAppContentStageSharingCapabilities
meeting.getAuthenticationTokenForAnonymousUser
meeting.getIncomingClientAudioState
meeting.getLiveStreamState
meeting.getMeetingDetails
meeting.requestStartLiveStreaming
meeting.requestStopLiveStreaming
meeting.shareAppContentToStage
meeting.stopSharingAppContentToStage
meeting.toggleIncomingClientAudio
- meetingRoom APIs:
meetingRoom.getPairedMeetingRoomInfo
meetingRoom.sendCommandToPairedMeetingRoom
- pages APIs:
pages.navigateCrossDomain
pages.tabs.navigateToTab
pages.tabs.getTabInstances
pages.tabs.getMruTabInstances
pages.config.getConfig
pages.config.setConfig
pages.backStack.navigateBack
- people APIs:
people.selectPeople
- others:
ChildAppWindow.postMessage
ParentAppWindow.postMessage
core.executeDeepLink
appInstallDialog.openAppInstallDialog
call.startCall
- app APIs:
- The following APIs that took in a callback function as a parameter now instead return a
-
Changed TypeScript to output ES6 modules instead of CommonJS