Socket
Socket
Sign inDemoInstall

@microsoft/teams-js

Package Overview
Dependencies
Maintainers
3
Versions
488
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@microsoft/teams-js - npm Package Compare versions

Comparing version 1.4.0-beta.3.4 to 1.4.0-beta.3.5

2107

dist/MicrosoftTeams.js

@@ -95,26 +95,3 @@ /******/ (function(modules) { // webpackBootstrap

__webpack_require__.r(MicrosoftTeams_namespaceObject);
__webpack_require__.d(MicrosoftTeams_namespaceObject, "menus", function() { return menus; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "initialize", function() { return initialize; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "_uninitialize", function() { return _uninitialize; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "enablePrintCapability", function() { return enablePrintCapability; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "print", function() { return print; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "getContext", function() { return getContext; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "registerOnThemeChangeHandler", function() { return registerOnThemeChangeHandler; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "registerFullScreenHandler", function() { return registerFullScreenHandler; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "registerBackButtonHandler", function() { return registerBackButtonHandler; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "navigateBack", function() { return navigateBack; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "navigateCrossDomain", function() { return navigateCrossDomain; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "getTabInstances", function() { return getTabInstances; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "getUserJoinedTeams", function() { return getUserJoinedTeams; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "getMruTabInstances", function() { return getMruTabInstances; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "shareDeepLink", function() { return shareDeepLink; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "openFilePreview", function() { return openFilePreview; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "showNotification", function() { return showNotification; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "uploadCustomApp", function() { return uploadCustomApp; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "navigateToTab", function() { return navigateToTab; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "settings", function() { return settings; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "authentication", function() { return authentication; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "sendCustomMessage", function() { return sendCustomMessage; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "tasks", function() { return tasks; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "getChatMembers", function() { return getChatMembers; });
__webpack_require__.d(MicrosoftTeams_namespaceObject, "microsoftTeams", function() { return microsoftTeams; });

@@ -127,1154 +104,1180 @@ // CONCATENATED MODULE: ./src/MicrosoftTeams.ts

}
"use strict";
var version = "1.3.6";
var validOrigins = [
"https://teams.microsoft.com",
"https://teams.microsoft.us",
"https://int.teams.microsoft.com",
"https://devspaces.skype.com",
"https://ssauth.skype.com",
"http://dev.local",
"https://msft.spoppe.com",
"https://*.sharepoint.com",
"https://*.sharepoint-df.com",
"https://*.sharepointonline.com",
"https://outlook.office.com",
"https://outlook-sdf.office.com"
];
// This will return a reg expression a given url
function generateRegExpFromUrl(url) {
var urlRegExpPart = "^";
var urlParts = url.split(".");
for (var j = 0; j < urlParts.length; j++) {
urlRegExpPart +=
(j > 0 ? "[.]" : "") + urlParts[j].replace("*", "[^/^.]+");
/**
* This is the root namespace for the JavaScript SDK.
*/
var microsoftTeams;
(function (microsoftTeams) {
"use strict";
var version = "1.3.6";
var validOrigins = [
"https://teams.microsoft.com",
"https://teams.microsoft.us",
"https://int.teams.microsoft.com",
"https://devspaces.skype.com",
"https://ssauth.skype.com",
"http://dev.local",
"https://msft.spoppe.com",
"https://*.sharepoint.com",
"https://*.sharepoint-df.com",
"https://*.sharepointonline.com",
"https://outlook.office.com",
"https://outlook-sdf.office.com"
];
// This will return a reg expression a given url
function generateRegExpFromUrl(url) {
var urlRegExpPart = "^";
var urlParts = url.split(".");
for (var j = 0; j < urlParts.length; j++) {
urlRegExpPart +=
(j > 0 ? "[.]" : "") + urlParts[j].replace("*", "[^/^.]+");
}
urlRegExpPart += "$";
return urlRegExpPart;
}
urlRegExpPart += "$";
return urlRegExpPart;
}
// This will return a reg expression for list of url
function generateRegExpFromUrls(urls) {
var urlRegExp = "";
for (var i = 0; i < urls.length; i++) {
urlRegExp += (i === 0 ? "" : "|") + generateRegExpFromUrl(urls[i]);
// This will return a reg expression for list of url
function generateRegExpFromUrls(urls) {
var urlRegExp = "";
for (var i = 0; i < urls.length; i++) {
urlRegExp += (i === 0 ? "" : "|") + generateRegExpFromUrl(urls[i]);
}
return new RegExp(urlRegExp);
}
return new RegExp(urlRegExp);
}
var validOriginRegExp = generateRegExpFromUrls(validOrigins);
var handlers = {};
// Ensure these declarations stay in sync with the framework.
var frameContexts = {
settings: "settings",
content: "content",
authentication: "authentication",
remove: "remove",
task: "task"
};
/**
* Namespace to interact with the menu-specific part of the SDK.
* This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
*
* @private
* Hide from docs until feature is complete
*/
var menus;
(function (menus) {
var validOriginRegExp = generateRegExpFromUrls(validOrigins);
var handlers = {};
// Ensure these declarations stay in sync with the framework.
var frameContexts = {
settings: "settings",
content: "content",
authentication: "authentication",
remove: "remove",
task: "task"
};
/**
* Represents information about menu item for Action Menu and Navigation Bar Menu.
* Namespace to interact with the menu-specific part of the SDK.
* This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
*
* @private
* Hide from docs until feature is complete
*/
var MenuItem = /** @class */ (function () {
function MenuItem() {
/**
* State of the menu item
*/
this.enabled = true;
var menus;
(function (menus) {
/**
* Represents information about menu item for Action Menu and Navigation Bar Menu.
*/
var MenuItem = /** @class */ (function () {
function MenuItem() {
/**
* State of the menu item
*/
this.enabled = true;
}
return MenuItem;
}());
menus.MenuItem = MenuItem;
/**
* Represents information about type of list to display in Navigation Bar Menu.
*/
var MenuListType;
(function (MenuListType) {
MenuListType["dropDown"] = "dropDown";
MenuListType["popOver"] = "popOver";
})(MenuListType = menus.MenuListType || (menus.MenuListType = {}));
var navBarMenuItemPressHandler;
handlers["navBarMenuItemPress"] = handleNavBarMenuItemPress;
var actionMenuItemPressHandler;
handlers["actionMenuItemPress"] = handleActionMenuItemPress;
var viewConfigItemPressHandler;
handlers["setModuleView"] = handleViewConfigItemPress;
/**
* Registers list of view configurations and it's handler.
* Handler is responsible for listening selection of View Configuration.
* @param viewConfig List of view configurations. Minimum 1 value is required.
* @param handler The handler to invoke when the user selects view configuration.
*/
function setUpViews(viewConfig, handler) {
ensureInitialized();
viewConfigItemPressHandler = handler;
sendMessageRequest(parentWindow, "setUpViews", [viewConfig]);
}
return MenuItem;
}());
menus.MenuItem = MenuItem;
menus.setUpViews = setUpViews;
function handleViewConfigItemPress(id) {
if (!viewConfigItemPressHandler || !viewConfigItemPressHandler(id)) {
ensureInitialized();
sendMessageRequest(parentWindow, "viewConfigItemPress", [id]);
}
}
/**
* Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
* @param items List of MenuItems for Navigation Bar Menu.
* @param handler The handler to invoke when the user selects menu item.
*/
function setNavBarMenu(items, handler) {
ensureInitialized();
navBarMenuItemPressHandler = handler;
sendMessageRequest(parentWindow, "setNavBarMenu", [items]);
}
menus.setNavBarMenu = setNavBarMenu;
function handleNavBarMenuItemPress(id) {
if (!navBarMenuItemPressHandler || !navBarMenuItemPressHandler(id)) {
ensureInitialized();
sendMessageRequest(parentWindow, "handleNavBarMenuItemPress", [id]);
}
}
/**
* Used to show Action Menu.
* @param params Parameters for Menu Parameters
* @param handler The handler to invoke when the user selects menu item.
*/
function showActionMenu(params, handler) {
ensureInitialized();
actionMenuItemPressHandler = handler;
sendMessageRequest(parentWindow, "showActionMenu", [params]);
}
menus.showActionMenu = showActionMenu;
function handleActionMenuItemPress(id) {
if (!actionMenuItemPressHandler || !actionMenuItemPressHandler(id)) {
ensureInitialized();
sendMessageRequest(parentWindow, "handleActionMenuItemPress", [id]);
}
}
})(menus = microsoftTeams.menus || (microsoftTeams.menus = {}));
// This indicates whether initialize was called (started).
// It does not indicate whether initialization is complete. That can be inferred by whether parentOrigin is set.
var initializeCalled = false;
var isFramelessWindow = false;
var currentWindow;
var parentWindow;
var parentOrigin;
var parentMessageQueue = [];
var childWindow;
var childOrigin;
var childMessageQueue = [];
var nextMessageId = 0;
var callbacks = {};
var frameContext;
var hostClientType;
var printCapabilityEnabled = false;
var themeChangeHandler;
handlers["themeChange"] = handleThemeChange;
var fullScreenChangeHandler;
handlers["fullScreenChange"] = handleFullScreenChange;
var backButtonPressHandler;
handlers["backButtonPress"] = handleBackButtonPress;
/**
* Represents information about type of list to display in Navigation Bar Menu.
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
var MenuListType;
(function (MenuListType) {
MenuListType["dropDown"] = "dropDown";
MenuListType["popOver"] = "popOver";
})(MenuListType = menus.MenuListType || (menus.MenuListType = {}));
var navBarMenuItemPressHandler;
handlers["navBarMenuItemPress"] = handleNavBarMenuItemPress;
var actionMenuItemPressHandler;
handlers["actionMenuItemPress"] = handleActionMenuItemPress;
var viewConfigItemPressHandler;
handlers["setModuleView"] = handleViewConfigItemPress;
function initialize(hostWindow) {
if (hostWindow === void 0) { hostWindow = window; }
if (initializeCalled) {
// Independent components might not know whether the SDK is initialized so might call it to be safe.
// Just no-op if that happens to make it easier to use.
return;
}
initializeCalled = true;
// Undocumented field used to mock the window for unit tests
currentWindow = hostWindow;
// Listen for messages post to our window
var messageListener = function (evt) { return processMessage(evt); };
// If we are in an iframe, our parent window is the one hosting us (i.e., window.parent); otherwise,
// it's the window that opened us (i.e., window.opener)
parentWindow =
currentWindow.parent !== currentWindow.self
? currentWindow.parent
: currentWindow.opener;
if (!parentWindow) {
isFramelessWindow = true;
window.onNativeMessage = handleParentMessage;
}
else {
// For iFrame scenario, add listener to listen 'message'
currentWindow.addEventListener("message", messageListener, false);
}
try {
// Send the initialized message to any origin, because at this point we most likely don't know the origin
// of the parent window, and this message contains no data that could pose a security risk.
parentOrigin = "*";
var messageId = sendMessageRequest(parentWindow, "initialize", [version]);
callbacks[messageId] = function (context, clientType) {
frameContext = context;
hostClientType = clientType;
};
}
finally {
parentOrigin = null;
}
// Undocumented function used to clear state between unit tests
this._uninitialize = function () {
if (frameContext) {
registerOnThemeChangeHandler(null);
registerFullScreenHandler(null);
registerBackButtonHandler(null);
}
if (frameContext === frameContexts.settings) {
settings.registerOnSaveHandler(null);
}
if (frameContext === frameContexts.remove) {
settings.registerOnRemoveHandler(null);
}
if (!isFramelessWindow) {
currentWindow.removeEventListener("message", messageListener, false);
}
initializeCalled = false;
parentWindow = null;
parentOrigin = null;
parentMessageQueue = [];
childWindow = null;
childOrigin = null;
childMessageQueue = [];
nextMessageId = 0;
callbacks = {};
frameContext = null;
hostClientType = null;
isFramelessWindow = false;
};
}
microsoftTeams.initialize = initialize;
/**
* Registers list of view configurations and it's handler.
* Handler is responsible for listening selection of View Configuration.
* @param viewConfig List of view configurations. Minimum 1 value is required.
* @param handler The handler to invoke when the user selects view configuration.
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
function setUpViews(viewConfig, handler) {
ensureInitialized();
viewConfigItemPressHandler = handler;
sendMessageRequest(parentWindow, "setUpViews", [viewConfig]);
}
menus.setUpViews = setUpViews;
function handleViewConfigItemPress(id) {
if (!viewConfigItemPressHandler || !viewConfigItemPressHandler(id)) {
function _uninitialize() { }
microsoftTeams._uninitialize = _uninitialize;
/**
* Enable print capability to support printing page using Ctrl+P and cmd+P
*/
function enablePrintCapability() {
if (!printCapabilityEnabled) {
printCapabilityEnabled = true;
ensureInitialized();
sendMessageRequest(parentWindow, "viewConfigItemPress", [id]);
// adding ctrl+P and cmd+P handler
document.addEventListener("keydown", function (event) {
if ((event.ctrlKey || event.metaKey) && event.keyCode === 80) {
microsoftTeams.print();
event.cancelBubble = true;
event.preventDefault();
event.stopImmediatePropagation();
}
});
}
}
microsoftTeams.enablePrintCapability = enablePrintCapability;
/**
* Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
* @param items List of MenuItems for Navigation Bar Menu.
* @param handler The handler to invoke when the user selects menu item.
* default print handler
*/
function setNavBarMenu(items, handler) {
function print() {
window.print();
}
microsoftTeams.print = print;
/**
* Retrieves the current context the frame is running in.
* @param callback The callback to invoke when the {@link Context} object is retrieved.
*/
function getContext(callback) {
ensureInitialized();
navBarMenuItemPressHandler = handler;
sendMessageRequest(parentWindow, "setNavBarMenu", [items]);
var messageId = sendMessageRequest(parentWindow, "getContext");
callbacks[messageId] = callback;
}
menus.setNavBarMenu = setNavBarMenu;
function handleNavBarMenuItemPress(id) {
if (!navBarMenuItemPressHandler || !navBarMenuItemPressHandler(id)) {
ensureInitialized();
sendMessageRequest(parentWindow, "handleNavBarMenuItemPress", [id]);
microsoftTeams.getContext = getContext;
/**
* Registers a handler for theme changes.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user changes their theme.
*/
function registerOnThemeChangeHandler(handler) {
ensureInitialized();
themeChangeHandler = handler;
}
microsoftTeams.registerOnThemeChangeHandler = registerOnThemeChangeHandler;
function handleThemeChange(theme) {
if (themeChangeHandler) {
themeChangeHandler(theme);
}
if (childWindow) {
sendMessageRequest(childWindow, "themeChange", [theme]);
}
}
/**
* Used to show Action Menu.
* @param params Parameters for Menu Parameters
* @param handler The handler to invoke when the user selects menu item.
* Registers a handler for changes from or to full-screen view for a tab.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user toggles full-screen view for a tab.
*/
function showActionMenu(params, handler) {
function registerFullScreenHandler(handler) {
ensureInitialized();
actionMenuItemPressHandler = handler;
sendMessageRequest(parentWindow, "showActionMenu", [params]);
fullScreenChangeHandler = handler;
}
menus.showActionMenu = showActionMenu;
function handleActionMenuItemPress(id) {
if (!actionMenuItemPressHandler || !actionMenuItemPressHandler(id)) {
ensureInitialized();
sendMessageRequest(parentWindow, "handleActionMenuItemPress", [id]);
microsoftTeams.registerFullScreenHandler = registerFullScreenHandler;
function handleFullScreenChange(isFullScreen) {
if (fullScreenChangeHandler) {
fullScreenChangeHandler(isFullScreen);
}
}
})(menus || (menus = {}));
// This indicates whether initialize was called (started).
// It does not indicate whether initialization is complete. That can be inferred by whether parentOrigin is set.
var initializeCalled = false;
var isFramelessWindow = false;
var currentWindow;
var parentWindow;
var parentOrigin;
var parentMessageQueue = [];
var childWindow;
var childOrigin;
var childMessageQueue = [];
var nextMessageId = 0;
var callbacks = {};
var frameContext;
var hostClientType;
var printCapabilityEnabled = false;
var themeChangeHandler;
handlers["themeChange"] = handleThemeChange;
var fullScreenChangeHandler;
handlers["fullScreenChange"] = handleFullScreenChange;
var backButtonPressHandler;
handlers["backButtonPress"] = handleBackButtonPress;
/**
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
function initialize(hostWindow) {
if (hostWindow === void 0) { hostWindow = window; }
if (initializeCalled) {
// Independent components might not know whether the SDK is initialized so might call it to be safe.
// Just no-op if that happens to make it easier to use.
return;
/**
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
* that after running its back button handler it cannot handle the event it should call the navigateBack
* method to ask the Teams client to handle it instead.
* @param handler The handler to invoke when the user presses their Team client's back button.
*/
function registerBackButtonHandler(handler) {
ensureInitialized();
backButtonPressHandler = handler;
}
initializeCalled = true;
// Undocumented field used to mock the window for unit tests
currentWindow = hostWindow;
// Listen for messages post to our window
var messageListener = function (evt) { return processMessage(evt); };
// If we are in an iframe, our parent window is the one hosting us (i.e., window.parent); otherwise,
// it's the window that opened us (i.e., window.opener)
parentWindow =
currentWindow.parent !== currentWindow.self
? currentWindow.parent
: currentWindow.opener;
if (!parentWindow) {
isFramelessWindow = true;
window.onNativeMessage = handleParentMessage;
microsoftTeams.registerBackButtonHandler = registerBackButtonHandler;
function handleBackButtonPress() {
if (!backButtonPressHandler || !backButtonPressHandler()) {
navigateBack();
}
}
else {
// For iFrame scenario, add listener to listen 'message'
currentWindow.addEventListener("message", messageListener, false);
}
try {
// Send the initialized message to any origin, because at this point we most likely don't know the origin
// of the parent window, and this message contains no data that could pose a security risk.
parentOrigin = "*";
var messageId = sendMessageRequest(parentWindow, "initialize", [version]);
callbacks[messageId] = function (context, clientType) {
frameContext = context;
hostClientType = clientType;
};
}
finally {
parentOrigin = null;
}
// Undocumented function used to clear state between unit tests
this._uninitialize = function () {
if (frameContext) {
registerOnThemeChangeHandler(null);
registerFullScreenHandler(null);
registerBackButtonHandler(null);
}
if (frameContext === frameContexts.settings) {
settings.registerOnSaveHandler(null);
}
if (frameContext === frameContexts.remove) {
settings.registerOnRemoveHandler(null);
}
if (!isFramelessWindow) {
currentWindow.removeEventListener("message", messageListener, false);
}
initializeCalled = false;
parentWindow = null;
parentOrigin = null;
parentMessageQueue = [];
childWindow = null;
childOrigin = null;
childMessageQueue = [];
nextMessageId = 0;
callbacks = {};
frameContext = null;
hostClientType = null;
isFramelessWindow = false;
};
}
/**
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
function _uninitialize() { }
/**
* Enable print capability to support printing page using Ctrl+P and cmd+P
*/
function enablePrintCapability() {
if (!printCapabilityEnabled) {
printCapabilityEnabled = true;
/**
* Navigates back in the Teams client. See registerBackButtonHandler for more information on when
* it's appropriate to use this method.
*/
function navigateBack() {
ensureInitialized();
// adding ctrl+P and cmd+P handler
document.addEventListener("keydown", function (event) {
if ((event.ctrlKey || event.metaKey) && event.keyCode === 80) {
print();
event.cancelBubble = true;
event.preventDefault();
event.stopImmediatePropagation();
var messageId = sendMessageRequest(parentWindow, "navigateBack", []);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Back navigation is not supported in the current client or context.");
}
});
};
}
}
/**
* default print handler
*/
function print() {
window.print();
}
/**
* Retrieves the current context the frame is running in.
* @param callback The callback to invoke when the {@link Context} object is retrieved.
*/
function getContext(callback) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getContext");
callbacks[messageId] = callback;
}
/**
* Registers a handler for theme changes.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user changes their theme.
*/
function registerOnThemeChangeHandler(handler) {
ensureInitialized();
themeChangeHandler = handler;
}
function handleThemeChange(theme) {
if (themeChangeHandler) {
themeChangeHandler(theme);
}
if (childWindow) {
sendMessageRequest(childWindow, "themeChange", [theme]);
}
}
/**
* Registers a handler for changes from or to full-screen view for a tab.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user toggles full-screen view for a tab.
*/
function registerFullScreenHandler(handler) {
ensureInitialized();
fullScreenChangeHandler = handler;
}
function handleFullScreenChange(isFullScreen) {
if (fullScreenChangeHandler) {
fullScreenChangeHandler(isFullScreen);
}
}
/**
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
* that after running its back button handler it cannot handle the event it should call the navigateBack
* method to ask the Teams client to handle it instead.
* @param handler The handler to invoke when the user presses their Team client's back button.
*/
function registerBackButtonHandler(handler) {
ensureInitialized();
backButtonPressHandler = handler;
}
function handleBackButtonPress() {
if (!backButtonPressHandler || !backButtonPressHandler()) {
navigateBack();
}
}
/**
* Navigates back in the Teams client. See registerBackButtonHandler for more information on when
* it's appropriate to use this method.
*/
function navigateBack() {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "navigateBack", []);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Back navigation is not supported in the current client or context.");
}
};
}
/**
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
* than the current one in a way that keeps the app informed of the change and allows the SDK to
* continue working.
* @param url The URL to navigate the frame to.
*/
function navigateCrossDomain(url) {
ensureInitialized(frameContexts.content, frameContexts.settings, frameContexts.remove, frameContexts.task);
var messageId = sendMessageRequest(parentWindow, "navigateCrossDomain", [
url
]);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Cross-origin navigation is only supported for URLs matching the pattern registered in the manifest.");
}
};
}
/**
* Allows an app to retrieve for this user tabs that are owned by this app.
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
* @param callback The callback to invoke when the {@link TabInstanceParameters} object is retrieved.
* @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
*/
function getTabInstances(callback, tabInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getTabInstances", [
tabInstanceParameters
]);
callbacks[messageId] = callback;
}
/**
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all user joined teams
* @param callback The callback to invoke when the {@link TeamInstanceParameters} object is retrieved.
* @param teamInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams
*/
function getUserJoinedTeams(callback, teamInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getUserJoinedTeams", [
teamInstanceParameters
]);
callbacks[messageId] = callback;
}
/**
* Allows an app to retrieve the most recently used tabs for this user.
* @param callback The callback to invoke when the {@link TabInformation} object is retrieved.
* @param tabInstanceParameters OPTIONAL Ignored, kept for future use
*/
function getMruTabInstances(callback, tabInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getMruTabInstances", [
tabInstanceParameters
]);
callbacks[messageId] = callback;
}
/**
* Shares a deep link that a user can use to navigate back to a specific state in this page.
* @param deepLinkParameters ID and label for the link and fallback URL.
*/
function shareDeepLink(deepLinkParameters) {
ensureInitialized(frameContexts.content);
sendMessageRequest(parentWindow, "shareDeepLink", [
deepLinkParameters.subEntityId,
deepLinkParameters.subEntityLabel,
deepLinkParameters.subEntityWebUrl
]);
}
/**
* @private
* Hide from docs.
* ------
* Opens a client-friendly preview of the specified file.
* @param file The file to preview.
*/
function openFilePreview(filePreviewParameters) {
ensureInitialized(frameContexts.content);
var params = [
filePreviewParameters.entityId,
filePreviewParameters.title,
filePreviewParameters.description,
filePreviewParameters.type,
filePreviewParameters.objectUrl,
filePreviewParameters.downloadUrl,
filePreviewParameters.webPreviewUrl,
filePreviewParameters.webEditUrl,
filePreviewParameters.baseUrl,
filePreviewParameters.editFile,
filePreviewParameters.subEntityId
];
sendMessageRequest(parentWindow, "openFilePreview", params);
}
/**
* @private
* Hide from docs.
* ------
* download file.
* @param file The file to download.
*/
function showNotification(showNotificationParameters) {
ensureInitialized(frameContexts.content);
var params = [
showNotificationParameters.message,
showNotificationParameters.isDownloadComplete
];
sendMessageRequest(parentWindow, "showNotification", params);
}
/**
* @private
* Hide from docs.
* ------
* Upload a custom App manifest directly to both team and personal scopes.
* This method works just for the first party Apps.
*/
function uploadCustomApp(manifestBlob) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "uploadCustomApp", [
manifestBlob
]);
callbacks[messageId] = function (success, result) {
if (!success) {
throw new Error(result);
}
};
}
/**
* Navigates the Microsoft Teams app to the specified tab instance.
* @param tabInstance The tab instance to navigate to.
*/
function navigateToTab(tabInstance) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "navigateToTab", [
tabInstance
]);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Invalid internalTabInstanceId and/or channelId were/was provided");
}
};
}
/**
* Namespace to interact with the settings-specific part of the SDK.
* This object is usable only on the settings frame.
*/
var settings;
(function (settings) {
var saveHandler;
var removeHandler;
handlers["settings.save"] = handleSave;
handlers["settings.remove"] = handleRemove;
microsoftTeams.navigateBack = navigateBack;
/**
* Sets the validity state for the settings.
* The initial value is false, so the user cannot save the settings until this is called with true.
* @param validityState Indicates whether the save or remove button is enabled for the user.
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
* than the current one in a way that keeps the app informed of the change and allows the SDK to
* continue working.
* @param url The URL to navigate the frame to.
*/
function setValidityState(validityState) {
ensureInitialized(frameContexts.settings, frameContexts.remove);
sendMessageRequest(parentWindow, "settings.setValidityState", [
validityState
function navigateCrossDomain(url) {
ensureInitialized(frameContexts.content, frameContexts.settings, frameContexts.remove, frameContexts.task);
var messageId = sendMessageRequest(parentWindow, "navigateCrossDomain", [
url
]);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Cross-origin navigation is only supported for URLs matching the pattern registered in the manifest.");
}
};
}
settings.setValidityState = setValidityState;
microsoftTeams.navigateCrossDomain = navigateCrossDomain;
/**
* Gets the settings for the current instance.
* @param callback The callback to invoke when the {@link Settings} object is retrieved.
* Allows an app to retrieve for this user tabs that are owned by this app.
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
* @param callback The callback to invoke when the {@link TabInstanceParameters} object is retrieved.
* @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
*/
function getSettings(callback) {
ensureInitialized(frameContexts.settings, frameContexts.remove);
var messageId = sendMessageRequest(parentWindow, "settings.getSettings");
function getTabInstances(callback, tabInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getTabInstances", [
tabInstanceParameters
]);
callbacks[messageId] = callback;
}
settings.getSettings = getSettings;
microsoftTeams.getTabInstances = getTabInstances;
/**
* Sets the settings for the current instance.
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
* @param settings The desired settings for this instance.
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all user joined teams
* @param callback The callback to invoke when the {@link TeamInstanceParameters} object is retrieved.
* @param teamInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams
*/
function setSettings(instanceSettings) {
ensureInitialized(frameContexts.settings);
sendMessageRequest(parentWindow, "settings.setSettings", [
instanceSettings
function getUserJoinedTeams(callback, teamInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getUserJoinedTeams", [
teamInstanceParameters
]);
callbacks[messageId] = callback;
}
settings.setSettings = setSettings;
microsoftTeams.getUserJoinedTeams = getUserJoinedTeams;
/**
* Registers a handler for when the user attempts to save the settings. This handler should be used
* to create or update the underlying resource powering the content.
* The object passed to the handler must be used to notify whether to proceed with the save.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user selects the save button.
* Allows an app to retrieve the most recently used tabs for this user.
* @param callback The callback to invoke when the {@link TabInformation} object is retrieved.
* @param tabInstanceParameters OPTIONAL Ignored, kept for future use
*/
function registerOnSaveHandler(handler) {
ensureInitialized(frameContexts.settings);
saveHandler = handler;
function getMruTabInstances(callback, tabInstanceParameters) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getMruTabInstances", [
tabInstanceParameters
]);
callbacks[messageId] = callback;
}
settings.registerOnSaveHandler = registerOnSaveHandler;
microsoftTeams.getMruTabInstances = getMruTabInstances;
/**
* Registers a handler for user attempts to remove content. This handler should be used
* to remove the underlying resource powering the content.
* The object passed to the handler must be used to indicate whether to proceed with the removal.
* Only one handler may be registered at a time. Subsequent registrations will override the first.
* @param handler The handler to invoke when the user selects the remove button.
* Shares a deep link that a user can use to navigate back to a specific state in this page.
* @param deepLinkParameters ID and label for the link and fallback URL.
*/
function registerOnRemoveHandler(handler) {
ensureInitialized(frameContexts.remove);
removeHandler = handler;
function shareDeepLink(deepLinkParameters) {
ensureInitialized(frameContexts.content);
sendMessageRequest(parentWindow, "shareDeepLink", [
deepLinkParameters.subEntityId,
deepLinkParameters.subEntityLabel,
deepLinkParameters.subEntityWebUrl
]);
}
settings.registerOnRemoveHandler = registerOnRemoveHandler;
function handleSave(result) {
var saveEvent = new SaveEventImpl(result);
if (saveHandler) {
saveHandler(saveEvent);
}
else {
// If no handler is registered, we assume success.
saveEvent.notifySuccess();
}
}
microsoftTeams.shareDeepLink = shareDeepLink;
/**
* @private
* Hide from docs, since this class is not directly used.
* Hide from docs.
* ------
* Opens a client-friendly preview of the specified file.
* @param file The file to preview.
*/
var SaveEventImpl = /** @class */ (function () {
function SaveEventImpl(result) {
this.notified = false;
this.result = result ? result : {};
}
SaveEventImpl.prototype.notifySuccess = function () {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.save.success");
this.notified = true;
};
SaveEventImpl.prototype.notifyFailure = function (reason) {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.save.failure", [reason]);
this.notified = true;
};
SaveEventImpl.prototype.ensureNotNotified = function () {
if (this.notified) {
throw new Error("The SaveEvent may only notify success or failure once.");
}
};
return SaveEventImpl;
}());
function handleRemove() {
var removeEvent = new RemoveEventImpl();
if (removeHandler) {
removeHandler(removeEvent);
}
else {
// If no handler is registered, we assume success.
removeEvent.notifySuccess();
}
function openFilePreview(filePreviewParameters) {
ensureInitialized(frameContexts.content);
var params = [
filePreviewParameters.entityId,
filePreviewParameters.title,
filePreviewParameters.description,
filePreviewParameters.type,
filePreviewParameters.objectUrl,
filePreviewParameters.downloadUrl,
filePreviewParameters.webPreviewUrl,
filePreviewParameters.webEditUrl,
filePreviewParameters.baseUrl,
filePreviewParameters.editFile,
filePreviewParameters.subEntityId
];
sendMessageRequest(parentWindow, "openFilePreview", params);
}
microsoftTeams.openFilePreview = openFilePreview;
/**
* @private
* Hide from docs, since this class is not directly used.
* Hide from docs.
* ------
* download file.
* @param file The file to download.
*/
var RemoveEventImpl = /** @class */ (function () {
function RemoveEventImpl() {
this.notified = false;
}
RemoveEventImpl.prototype.notifySuccess = function () {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.remove.success");
this.notified = true;
};
RemoveEventImpl.prototype.notifyFailure = function (reason) {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.remove.failure", [reason]);
this.notified = true;
};
RemoveEventImpl.prototype.ensureNotNotified = function () {
if (this.notified) {
throw new Error("The removeEvent may only notify success or failure once.");
}
};
return RemoveEventImpl;
}());
})(settings || (settings = {}));
/**
* Namespace to interact with the authentication-specific part of the SDK.
* This object is used for starting or completing authentication flows.
*/
var authentication;
(function (authentication) {
var authParams;
var authWindowMonitor;
handlers["authentication.authenticate.success"] = handleSuccess;
handlers["authentication.authenticate.failure"] = handleFailure;
/**
* Registers the authentication handlers
* @param authenticateParameters A set of values that configure the authentication pop-up.
*/
function registerAuthenticationHandlers(authenticateParameters) {
authParams = authenticateParameters;
function showNotification(showNotificationParameters) {
ensureInitialized(frameContexts.content);
var params = [
showNotificationParameters.message,
showNotificationParameters.isDownloadComplete
];
sendMessageRequest(parentWindow, "showNotification", params);
}
authentication.registerAuthenticationHandlers = registerAuthenticationHandlers;
microsoftTeams.showNotification = showNotification;
/**
* Initiates an authentication request, which opens a new window with the specified settings.
*/
function authenticate(authenticateParameters) {
var authenticateParams = authenticateParameters !== undefined
? authenticateParameters
: authParams;
ensureInitialized(frameContexts.content, frameContexts.settings, frameContexts.remove, frameContexts.task);
if (hostClientType === "desktop" /* desktop */) {
// Convert any relative URLs into absolute URLs before sending them over to the parent window.
var link = document.createElement("a");
link.href = authenticateParams.url;
// Ask the parent window to open an authentication window with the parameters provided by the caller.
var messageId = sendMessageRequest(parentWindow, "authentication.authenticate", [link.href, authenticateParams.width, authenticateParams.height]);
callbacks[messageId] = function (success, response) {
if (success) {
authenticateParams.successCallback(response);
}
else {
authenticateParams.failureCallback(response);
}
};
}
else {
// Open an authentication window with the parameters provided by the caller.
openAuthenticationWindow(authenticateParams);
}
}
authentication.authenticate = authenticate;
/**
* @private
* Hide from docs.
* ------
* Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
* if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
* @param authTokenRequest A set of values that configure the token request.
* Upload a custom App manifest directly to both team and personal scopes.
* This method works just for the first party Apps.
*/
function getAuthToken(authTokenRequest) {
function uploadCustomApp(manifestBlob) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "authentication.getAuthToken", [authTokenRequest.resources]);
var messageId = sendMessageRequest(parentWindow, "uploadCustomApp", [
manifestBlob
]);
callbacks[messageId] = function (success, result) {
if (success) {
authTokenRequest.successCallback(result);
if (!success) {
throw new Error(result);
}
else {
authTokenRequest.failureCallback(result);
}
};
}
authentication.getAuthToken = getAuthToken;
microsoftTeams.uploadCustomApp = uploadCustomApp;
/**
* @private
* Hide from docs.
* ------
* Requests the decoded Azure AD user identity on behalf of the app.
* Navigates the Microsoft Teams app to the specified tab instance.
* @param tabInstance The tab instance to navigate to.
*/
function getUser(userRequest) {
function navigateToTab(tabInstance) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "authentication.getUser");
callbacks[messageId] = function (success, result) {
if (success) {
userRequest.successCallback(result);
var messageId = sendMessageRequest(parentWindow, "navigateToTab", [
tabInstance
]);
callbacks[messageId] = function (success) {
if (!success) {
throw new Error("Invalid internalTabInstanceId and/or channelId were/was provided");
}
else {
userRequest.failureCallback(result);
}
};
}
authentication.getUser = getUser;
function closeAuthenticationWindow() {
// Stop monitoring the authentication window
stopAuthenticationWindowMonitor();
// Try to close the authentication window and clear all properties associated with it
try {
if (childWindow) {
childWindow.close();
}
microsoftTeams.navigateToTab = navigateToTab;
/**
* Namespace to interact with the settings-specific part of the SDK.
* This object is usable only on the settings frame.
*/
var settings;
(function (settings) {
var saveHandler;
var removeHandler;
handlers["settings.save"] = handleSave;
handlers["settings.remove"] = handleRemove;
/**
* Sets the validity state for the settings.
* The initial value is false, so the user cannot save the settings until this is called with true.
* @param validityState Indicates whether the save or remove button is enabled for the user.
*/
function setValidityState(validityState) {
ensureInitialized(frameContexts.settings, frameContexts.remove);
sendMessageRequest(parentWindow, "settings.setValidityState", [
validityState
]);
}
finally {
childWindow = null;
childOrigin = null;
settings.setValidityState = setValidityState;
/**
* Gets the settings for the current instance.
* @param callback The callback to invoke when the {@link Settings} object is retrieved.
*/
function getSettings(callback) {
ensureInitialized(frameContexts.settings, frameContexts.remove);
var messageId = sendMessageRequest(parentWindow, "settings.getSettings");
callbacks[messageId] = callback;
}
}
function openAuthenticationWindow(authenticateParameters) {
authParams = authenticateParameters;
// Close the previously opened window if we have one
closeAuthenticationWindow();
// Start with a sensible default size
var width = authParams.width || 600;
var height = authParams.height || 400;
// Ensure that the new window is always smaller than our app's window so that it never fully covers up our app
width = Math.min(width, currentWindow.outerWidth - 400);
height = Math.min(height, currentWindow.outerHeight - 200);
// Convert any relative URLs into absolute URLs before sending them over to the parent window
var link = document.createElement("a");
link.href = authParams.url;
// We are running in the browser, so we need to center the new window ourselves
var left = typeof currentWindow.screenLeft !== "undefined"
? currentWindow.screenLeft
: currentWindow.screenX;
var top = typeof currentWindow.screenTop !== "undefined"
? currentWindow.screenTop
: currentWindow.screenY;
left += currentWindow.outerWidth / 2 - width / 2;
top += currentWindow.outerHeight / 2 - height / 2;
// Open a child window with a desired set of standard browser features
childWindow = currentWindow.open(link.href, "_blank", "toolbar=no, location=yes, status=no, menubar=no, scrollbars=yes, top=" +
top +
", left=" +
left +
", width=" +
width +
", height=" +
height);
if (childWindow) {
// Start monitoring the authentication window so that we can detect if it gets closed before the flow completes
startAuthenticationWindowMonitor();
settings.getSettings = getSettings;
/**
* Sets the settings for the current instance.
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
* @param settings The desired settings for this instance.
*/
function setSettings(instanceSettings) {
ensureInitialized(frameContexts.settings);
sendMessageRequest(parentWindow, "settings.setSettings", [
instanceSettings
]);
}
else {
// If we failed to open the window, fail the authentication flow
handleFailure("FailedToOpenWindow");
settings.setSettings = setSettings;
/**
* Registers a handler for when the user attempts to save the settings. This handler should be used
* to create or update the underlying resource powering the content.
* The object passed to the handler must be used to notify whether to proceed with the save.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user selects the save button.
*/
function registerOnSaveHandler(handler) {
ensureInitialized(frameContexts.settings);
saveHandler = handler;
}
}
function stopAuthenticationWindowMonitor() {
if (authWindowMonitor) {
clearInterval(authWindowMonitor);
authWindowMonitor = 0;
settings.registerOnSaveHandler = registerOnSaveHandler;
/**
* Registers a handler for user attempts to remove content. This handler should be used
* to remove the underlying resource powering the content.
* The object passed to the handler must be used to indicate whether to proceed with the removal.
* Only one handler may be registered at a time. Subsequent registrations will override the first.
* @param handler The handler to invoke when the user selects the remove button.
*/
function registerOnRemoveHandler(handler) {
ensureInitialized(frameContexts.remove);
removeHandler = handler;
}
delete handlers["initialize"];
delete handlers["navigateCrossDomain"];
}
function startAuthenticationWindowMonitor() {
// Stop the previous window monitor if one is running
stopAuthenticationWindowMonitor();
// Create an interval loop that
// - Notifies the caller of failure if it detects that the authentication window is closed
// - Keeps pinging the authentication window while it is open to re-establish
// contact with any pages along the authentication flow that need to communicate
// with us
authWindowMonitor = currentWindow.setInterval(function () {
if (!childWindow || childWindow.closed) {
handleFailure("CancelledByUser");
settings.registerOnRemoveHandler = registerOnRemoveHandler;
function handleSave(result) {
var saveEvent = new SaveEventImpl(result);
if (saveHandler) {
saveHandler(saveEvent);
}
else {
var savedChildOrigin = childOrigin;
try {
childOrigin = "*";
sendMessageRequest(childWindow, "ping");
// If no handler is registered, we assume success.
saveEvent.notifySuccess();
}
}
/**
* @private
* Hide from docs, since this class is not directly used.
*/
var SaveEventImpl = /** @class */ (function () {
function SaveEventImpl(result) {
this.notified = false;
this.result = result ? result : {};
}
SaveEventImpl.prototype.notifySuccess = function () {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.save.success");
this.notified = true;
};
SaveEventImpl.prototype.notifyFailure = function (reason) {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.save.failure", [reason]);
this.notified = true;
};
SaveEventImpl.prototype.ensureNotNotified = function () {
if (this.notified) {
throw new Error("The SaveEvent may only notify success or failure once.");
}
finally {
childOrigin = savedChildOrigin;
};
return SaveEventImpl;
}());
function handleRemove() {
var removeEvent = new RemoveEventImpl();
if (removeHandler) {
removeHandler(removeEvent);
}
else {
// If no handler is registered, we assume success.
removeEvent.notifySuccess();
}
}
/**
* @private
* Hide from docs, since this class is not directly used.
*/
var RemoveEventImpl = /** @class */ (function () {
function RemoveEventImpl() {
this.notified = false;
}
RemoveEventImpl.prototype.notifySuccess = function () {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.remove.success");
this.notified = true;
};
RemoveEventImpl.prototype.notifyFailure = function (reason) {
this.ensureNotNotified();
sendMessageRequest(parentWindow, "settings.remove.failure", [reason]);
this.notified = true;
};
RemoveEventImpl.prototype.ensureNotNotified = function () {
if (this.notified) {
throw new Error("The removeEvent may only notify success or failure once.");
}
}
}, 100);
// Set up an initialize-message handler that gives the authentication window its frame context
handlers["initialize"] = function () {
return [frameContexts.authentication, hostClientType];
};
// Set up a navigateCrossDomain message handler that blocks cross-domain re-navigation attempts
// in the authentication window. We could at some point choose to implement this method via a call to
// authenticationWindow.location.href = url; however, we would first need to figure out how to
// validate the URL against the tab's list of valid domains.
handlers["navigateCrossDomain"] = function (url) {
return false;
};
}
};
return RemoveEventImpl;
}());
})(settings = microsoftTeams.settings || (microsoftTeams.settings = {}));
/**
* Notifies the frame that initiated this authentication request that the request was successful.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
* Namespace to interact with the authentication-specific part of the SDK.
* This object is used for starting or completing authentication flows.
*/
function notifySuccess(result, callbackUrl) {
redirectIfWin32Outlook(callbackUrl, "result", result);
ensureInitialized(frameContexts.authentication);
sendMessageRequest(parentWindow, "authentication.authenticate.success", [
result
]);
// Wait for the message to be sent before closing the window
waitForMessageQueue(parentWindow, function () {
return setTimeout(function () { return currentWindow.close(); }, 200);
});
}
authentication.notifySuccess = notifySuccess;
/**
* Notifies the frame that initiated this authentication request that the request failed.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
function notifyFailure(reason, callbackUrl) {
redirectIfWin32Outlook(callbackUrl, "reason", reason);
ensureInitialized(frameContexts.authentication);
sendMessageRequest(parentWindow, "authentication.authenticate.failure", [
reason
]);
// Wait for the message to be sent before closing the window
waitForMessageQueue(parentWindow, function () {
return setTimeout(function () { return currentWindow.close(); }, 200);
});
}
authentication.notifyFailure = notifyFailure;
function handleSuccess(result) {
try {
if (authParams && authParams.successCallback) {
authParams.successCallback(result);
var authentication;
(function (authentication) {
var authParams;
var authWindowMonitor;
handlers["authentication.authenticate.success"] = handleSuccess;
handlers["authentication.authenticate.failure"] = handleFailure;
/**
* Registers the authentication handlers
* @param authenticateParameters A set of values that configure the authentication pop-up.
*/
function registerAuthenticationHandlers(authenticateParameters) {
authParams = authenticateParameters;
}
authentication.registerAuthenticationHandlers = registerAuthenticationHandlers;
/**
* Initiates an authentication request, which opens a new window with the specified settings.
*/
function authenticate(authenticateParameters) {
var authenticateParams = authenticateParameters !== undefined
? authenticateParameters
: authParams;
ensureInitialized(frameContexts.content, frameContexts.settings, frameContexts.remove, frameContexts.task);
if (hostClientType === "desktop" /* desktop */) {
// Convert any relative URLs into absolute URLs before sending them over to the parent window.
var link = document.createElement("a");
link.href = authenticateParams.url;
// Ask the parent window to open an authentication window with the parameters provided by the caller.
var messageId = sendMessageRequest(parentWindow, "authentication.authenticate", [link.href, authenticateParams.width, authenticateParams.height]);
callbacks[messageId] = function (success, response) {
if (success) {
authenticateParams.successCallback(response);
}
else {
authenticateParams.failureCallback(response);
}
};
}
else {
// Open an authentication window with the parameters provided by the caller.
openAuthenticationWindow(authenticateParams);
}
}
finally {
authParams = null;
closeAuthenticationWindow();
authentication.authenticate = authenticate;
/**
* @private
* Hide from docs.
* ------
* Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
* if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
* @param authTokenRequest A set of values that configure the token request.
*/
function getAuthToken(authTokenRequest) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "authentication.getAuthToken", [authTokenRequest.resources]);
callbacks[messageId] = function (success, result) {
if (success) {
authTokenRequest.successCallback(result);
}
else {
authTokenRequest.failureCallback(result);
}
};
}
}
function handleFailure(reason) {
try {
if (authParams && authParams.failureCallback) {
authParams.failureCallback(reason);
authentication.getAuthToken = getAuthToken;
/**
* @private
* Hide from docs.
* ------
* Requests the decoded Azure AD user identity on behalf of the app.
*/
function getUser(userRequest) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "authentication.getUser");
callbacks[messageId] = function (success, result) {
if (success) {
userRequest.successCallback(result);
}
else {
userRequest.failureCallback(result);
}
};
}
authentication.getUser = getUser;
function closeAuthenticationWindow() {
// Stop monitoring the authentication window
stopAuthenticationWindowMonitor();
// Try to close the authentication window and clear all properties associated with it
try {
if (childWindow) {
childWindow.close();
}
}
finally {
childWindow = null;
childOrigin = null;
}
}
finally {
authParams = null;
function openAuthenticationWindow(authenticateParameters) {
authParams = authenticateParameters;
// Close the previously opened window if we have one
closeAuthenticationWindow();
// Start with a sensible default size
var width = authParams.width || 600;
var height = authParams.height || 400;
// Ensure that the new window is always smaller than our app's window so that it never fully covers up our app
width = Math.min(width, currentWindow.outerWidth - 400);
height = Math.min(height, currentWindow.outerHeight - 200);
// Convert any relative URLs into absolute URLs before sending them over to the parent window
var link = document.createElement("a");
link.href = authParams.url;
// We are running in the browser, so we need to center the new window ourselves
var left = typeof currentWindow.screenLeft !== "undefined"
? currentWindow.screenLeft
: currentWindow.screenX;
var top = typeof currentWindow.screenTop !== "undefined"
? currentWindow.screenTop
: currentWindow.screenY;
left += currentWindow.outerWidth / 2 - width / 2;
top += currentWindow.outerHeight / 2 - height / 2;
// Open a child window with a desired set of standard browser features
childWindow = currentWindow.open(link.href, "_blank", "toolbar=no, location=yes, status=no, menubar=no, scrollbars=yes, top=" +
top +
", left=" +
left +
", width=" +
width +
", height=" +
height);
if (childWindow) {
// Start monitoring the authentication window so that we can detect if it gets closed before the flow completes
startAuthenticationWindowMonitor();
}
else {
// If we failed to open the window, fail the authentication flow
handleFailure("FailedToOpenWindow");
}
}
}
/**
* Validates that the callbackUrl param is a valid connector url, appends the result/reason and authSuccess/authFailure as URL fragments and redirects the window
* @param callbackUrl - the connectors url to redirect to
* @param key - "result" in case of success and "reason" in case of failure
* @param value - the value of the passed result/reason parameter
*/
function redirectIfWin32Outlook(callbackUrl, key, value) {
if (callbackUrl) {
var link = document.createElement("a");
link.href = decodeURIComponent(callbackUrl);
if (link.host &&
link.host !== window.location.host &&
link.host === "outlook.office.com" &&
link.search.indexOf("client_type=Win32_Outlook") > -1) {
if (key && key === "result") {
if (value) {
link.href = updateUrlParameter(link.href, "result", value);
function stopAuthenticationWindowMonitor() {
if (authWindowMonitor) {
clearInterval(authWindowMonitor);
authWindowMonitor = 0;
}
delete handlers["initialize"];
delete handlers["navigateCrossDomain"];
}
function startAuthenticationWindowMonitor() {
// Stop the previous window monitor if one is running
stopAuthenticationWindowMonitor();
// Create an interval loop that
// - Notifies the caller of failure if it detects that the authentication window is closed
// - Keeps pinging the authentication window while it is open to re-establish
// contact with any pages along the authentication flow that need to communicate
// with us
authWindowMonitor = currentWindow.setInterval(function () {
if (!childWindow || childWindow.closed) {
handleFailure("CancelledByUser");
}
else {
var savedChildOrigin = childOrigin;
try {
childOrigin = "*";
sendMessageRequest(childWindow, "ping");
}
currentWindow.location.assign(updateUrlParameter(link.href, "authSuccess", ""));
finally {
childOrigin = savedChildOrigin;
}
}
if (key && key === "reason") {
if (value) {
link.href = updateUrlParameter(link.href, "reason", value);
}, 100);
// Set up an initialize-message handler that gives the authentication window its frame context
handlers["initialize"] = function () {
return [frameContexts.authentication, hostClientType];
};
// Set up a navigateCrossDomain message handler that blocks cross-domain re-navigation attempts
// in the authentication window. We could at some point choose to implement this method via a call to
// authenticationWindow.location.href = url; however, we would first need to figure out how to
// validate the URL against the tab's list of valid domains.
handlers["navigateCrossDomain"] = function (url) {
return false;
};
}
/**
* Notifies the frame that initiated this authentication request that the request was successful.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
function notifySuccess(result, callbackUrl) {
redirectIfWin32Outlook(callbackUrl, "result", result);
ensureInitialized(frameContexts.authentication);
sendMessageRequest(parentWindow, "authentication.authenticate.success", [
result
]);
// Wait for the message to be sent before closing the window
waitForMessageQueue(parentWindow, function () {
return setTimeout(function () { return currentWindow.close(); }, 200);
});
}
authentication.notifySuccess = notifySuccess;
/**
* Notifies the frame that initiated this authentication request that the request failed.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
function notifyFailure(reason, callbackUrl) {
redirectIfWin32Outlook(callbackUrl, "reason", reason);
ensureInitialized(frameContexts.authentication);
sendMessageRequest(parentWindow, "authentication.authenticate.failure", [
reason
]);
// Wait for the message to be sent before closing the window
waitForMessageQueue(parentWindow, function () {
return setTimeout(function () { return currentWindow.close(); }, 200);
});
}
authentication.notifyFailure = notifyFailure;
function handleSuccess(result) {
try {
if (authParams && authParams.successCallback) {
authParams.successCallback(result);
}
}
finally {
authParams = null;
closeAuthenticationWindow();
}
}
function handleFailure(reason) {
try {
if (authParams && authParams.failureCallback) {
authParams.failureCallback(reason);
}
}
finally {
authParams = null;
closeAuthenticationWindow();
}
}
/**
* Validates that the callbackUrl param is a valid connector url, appends the result/reason and authSuccess/authFailure as URL fragments and redirects the window
* @param callbackUrl - the connectors url to redirect to
* @param key - "result" in case of success and "reason" in case of failure
* @param value - the value of the passed result/reason parameter
*/
function redirectIfWin32Outlook(callbackUrl, key, value) {
if (callbackUrl) {
var link = document.createElement("a");
link.href = decodeURIComponent(callbackUrl);
if (link.host &&
link.host !== window.location.host &&
link.host === "outlook.office.com" &&
link.search.indexOf("client_type=Win32_Outlook") > -1) {
if (key && key === "result") {
if (value) {
link.href = updateUrlParameter(link.href, "result", value);
}
currentWindow.location.assign(updateUrlParameter(link.href, "authSuccess", ""));
}
currentWindow.location.assign(updateUrlParameter(link.href, "authFailure", ""));
if (key && key === "reason") {
if (value) {
link.href = updateUrlParameter(link.href, "reason", value);
}
currentWindow.location.assign(updateUrlParameter(link.href, "authFailure", ""));
}
}
}
}
/**
* Appends either result or reason as a fragment to the 'callbackUrl'
* @param uri - the url to modify
* @param key - the fragment key
* @param value - the fragment value
*/
function updateUrlParameter(uri, key, value) {
var i = uri.indexOf("#");
var hash = i === -1 ? "#" : uri.substr(i);
hash = hash + "&" + key + (value !== "" ? "=" + value : "");
uri = i === -1 ? uri : uri.substr(0, i);
return uri + hash;
}
})(authentication = microsoftTeams.authentication || (microsoftTeams.authentication = {}));
function ensureInitialized() {
var expectedFrameContexts = [];
for (var _i = 0; _i < arguments.length; _i++) {
expectedFrameContexts[_i] = arguments[_i];
}
if (!initializeCalled) {
throw new Error("The library has not yet been initialized");
}
if (frameContext &&
expectedFrameContexts &&
expectedFrameContexts.length > 0) {
var found = false;
for (var i = 0; i < expectedFrameContexts.length; i++) {
if (expectedFrameContexts[i] === frameContext) {
found = true;
break;
}
}
if (!found) {
throw new Error("This call is not allowed in the '" + frameContext + "' context");
}
}
}
/**
* Appends either result or reason as a fragment to the 'callbackUrl'
* @param uri - the url to modify
* @param key - the fragment key
* @param value - the fragment value
*/
function updateUrlParameter(uri, key, value) {
var i = uri.indexOf("#");
var hash = i === -1 ? "#" : uri.substr(i);
hash = hash + "&" + key + (value !== "" ? "=" + value : "");
uri = i === -1 ? uri : uri.substr(0, i);
return uri + hash;
function processMessage(evt) {
// Process only if we received a valid message
if (!evt || !evt.data || typeof evt.data !== "object") {
return;
}
// Process only if the message is coming from a different window and a valid origin
var messageSource = evt.source || evt.originalEvent.source;
var messageOrigin = evt.origin || evt.originalEvent.origin;
if (messageSource === currentWindow ||
(messageOrigin !== currentWindow.location.origin &&
!validOriginRegExp.test(messageOrigin.toLowerCase()))) {
return;
}
// Update our parent and child relationships based on this message
updateRelationships(messageSource, messageOrigin);
// Handle the message
if (messageSource === parentWindow) {
handleParentMessage(evt);
}
else if (messageSource === childWindow) {
handleChildMessage(evt);
}
}
})(authentication || (authentication = {}));
function ensureInitialized() {
var expectedFrameContexts = [];
for (var _i = 0; _i < arguments.length; _i++) {
expectedFrameContexts[_i] = arguments[_i];
function updateRelationships(messageSource, messageOrigin) {
// Determine whether the source of the message is our parent or child and update our
// window and origin pointer accordingly
if (!parentWindow || messageSource === parentWindow) {
parentWindow = messageSource;
parentOrigin = messageOrigin;
}
else if (!childWindow || messageSource === childWindow) {
childWindow = messageSource;
childOrigin = messageOrigin;
}
// Clean up pointers to closed parent and child windows
if (parentWindow && parentWindow.closed) {
parentWindow = null;
parentOrigin = null;
}
if (childWindow && childWindow.closed) {
childWindow = null;
childOrigin = null;
}
// If we have any messages in our queue, send them now
flushMessageQueue(parentWindow);
flushMessageQueue(childWindow);
}
if (!initializeCalled) {
throw new Error("The library has not yet been initialized");
}
if (frameContext &&
expectedFrameContexts &&
expectedFrameContexts.length > 0) {
var found = false;
for (var i = 0; i < expectedFrameContexts.length; i++) {
if (expectedFrameContexts[i] === frameContext) {
found = true;
break;
function handleParentMessage(evt) {
if ("id" in evt.data) {
// Call any associated callbacks
var message = evt.data;
var callback = callbacks[message.id];
if (callback) {
callback.apply(null, message.args);
// Remove the callback to ensure that the callback is called only once and to free up memory.
delete callbacks[message.id];
}
}
if (!found) {
throw new Error("This call is not allowed in the '" + frameContext + "' context");
else if ("func" in evt.data) {
// Delegate the request to the proper handler
var message = evt.data;
var handler = handlers[message.func];
if (handler) {
// We don't expect any handler to respond at this point
handler.apply(this, message.args);
}
}
}
}
function processMessage(evt) {
// Process only if we received a valid message
if (!evt || !evt.data || typeof evt.data !== "object") {
return;
function handleChildMessage(evt) {
if ("id" in evt.data && "func" in evt.data) {
// Try to delegate the request to the proper handler
var message_1 = evt.data;
var handler = handlers[message_1.func];
if (handler) {
var result = handler.apply(this, message_1.args);
if (result) {
sendMessageResponse(childWindow, message_1.id, Array.isArray(result) ? result : [result]);
}
}
else {
// Proxy to parent
var messageId = sendMessageRequest(parentWindow, message_1.func, message_1.args);
// tslint:disable-next-line:no-any
callbacks[messageId] = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
if (childWindow) {
sendMessageResponse(childWindow, message_1.id, args);
}
};
}
}
}
// Process only if the message is coming from a different window and a valid origin
var messageSource = evt.source || evt.originalEvent.source;
var messageOrigin = evt.origin || evt.originalEvent.origin;
if (messageSource === currentWindow ||
(messageOrigin !== currentWindow.location.origin &&
!validOriginRegExp.test(messageOrigin.toLowerCase()))) {
return;
function getTargetMessageQueue(targetWindow) {
return targetWindow === parentWindow
? parentMessageQueue
: targetWindow === childWindow
? childMessageQueue
: [];
}
// Update our parent and child relationships based on this message
updateRelationships(messageSource, messageOrigin);
// Handle the message
if (messageSource === parentWindow) {
handleParentMessage(evt);
function getTargetOrigin(targetWindow) {
return targetWindow === parentWindow
? parentOrigin
: targetWindow === childWindow
? childOrigin
: null;
}
else if (messageSource === childWindow) {
handleChildMessage(evt);
}
}
function updateRelationships(messageSource, messageOrigin) {
// Determine whether the source of the message is our parent or child and update our
// window and origin pointer accordingly
if (!parentWindow || messageSource === parentWindow) {
parentWindow = messageSource;
parentOrigin = messageOrigin;
}
else if (!childWindow || messageSource === childWindow) {
childWindow = messageSource;
childOrigin = messageOrigin;
}
// Clean up pointers to closed parent and child windows
if (parentWindow && parentWindow.closed) {
parentWindow = null;
parentOrigin = null;
}
if (childWindow && childWindow.closed) {
childWindow = null;
childOrigin = null;
}
// If we have any messages in our queue, send them now
flushMessageQueue(parentWindow);
flushMessageQueue(childWindow);
}
function handleParentMessage(evt) {
if ("id" in evt.data) {
// Call any associated callbacks
var message = evt.data;
var callback = callbacks[message.id];
if (callback) {
callback.apply(null, message.args);
// Remove the callback to ensure that the callback is called only once and to free up memory.
delete callbacks[message.id];
function flushMessageQueue(targetWindow) {
var targetOrigin = getTargetOrigin(targetWindow);
var targetMessageQueue = getTargetMessageQueue(targetWindow);
while (targetWindow && targetOrigin && targetMessageQueue.length > 0) {
targetWindow.postMessage(targetMessageQueue.shift(), targetOrigin);
}
}
else if ("func" in evt.data) {
// Delegate the request to the proper handler
var message = evt.data;
var handler = handlers[message.func];
if (handler) {
// We don't expect any handler to respond at this point
handler.apply(this, message.args);
}
function waitForMessageQueue(targetWindow, callback) {
var messageQueueMonitor = currentWindow.setInterval(function () {
if (getTargetMessageQueue(targetWindow).length === 0) {
clearInterval(messageQueueMonitor);
callback();
}
}, 100);
}
}
function handleChildMessage(evt) {
if ("id" in evt.data && "func" in evt.data) {
// Try to delegate the request to the proper handler
var message_1 = evt.data;
var handler = handlers[message_1.func];
if (handler) {
var result = handler.apply(this, message_1.args);
if (result) {
sendMessageResponse(childWindow, message_1.id, Array.isArray(result) ? result : [result]);
function sendMessageRequest(targetWindow, actionName,
// tslint:disable-next-line: no-any
args) {
var request = createMessageRequest(actionName, args);
if (isFramelessWindow) {
if (currentWindow && currentWindow.nativeInterface) {
currentWindow.nativeInterface.framelessPostMessage(JSON.stringify(request));
}
}
else {
// Proxy to parent
var messageId = sendMessageRequest(parentWindow, message_1.func, message_1.args);
// tslint:disable-next-line:no-any
callbacks[messageId] = function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i] = arguments[_i];
}
if (childWindow) {
sendMessageResponse(childWindow, message_1.id, args);
}
};
var targetOrigin = getTargetOrigin(targetWindow);
// If the target window isn't closed and we already know its origin, send the message right away; otherwise,
// queue the message and send it after the origin is established
if (targetWindow && targetOrigin) {
targetWindow.postMessage(request, targetOrigin);
}
else {
getTargetMessageQueue(targetWindow).push(request);
}
}
return request.id;
}
}
function getTargetMessageQueue(targetWindow) {
return targetWindow === parentWindow
? parentMessageQueue
: targetWindow === childWindow
? childMessageQueue
: [];
}
function getTargetOrigin(targetWindow) {
return targetWindow === parentWindow
? parentOrigin
: targetWindow === childWindow
? childOrigin
: null;
}
function flushMessageQueue(targetWindow) {
var targetOrigin = getTargetOrigin(targetWindow);
var targetMessageQueue = getTargetMessageQueue(targetWindow);
while (targetWindow && targetOrigin && targetMessageQueue.length > 0) {
targetWindow.postMessage(targetMessageQueue.shift(), targetOrigin);
/**
* @private
* Internal use only
* Sends a custom action message to Teams.
* @param actionName Specifies name of the custom action to be sent
* @param args Specifies additional arguments passed to the action
* @returns id of sent message
*/
function sendCustomMessage(actionName,
// tslint:disable-next-line:no-any
args) {
ensureInitialized();
return sendMessageRequest(parentWindow, actionName, args);
}
}
function waitForMessageQueue(targetWindow, callback) {
var messageQueueMonitor = currentWindow.setInterval(function () {
if (getTargetMessageQueue(targetWindow).length === 0) {
clearInterval(messageQueueMonitor);
callback();
}
}, 100);
}
function sendMessageRequest(targetWindow, actionName,
// tslint:disable-next-line: no-any
args) {
var request = createMessageRequest(actionName, args);
if (isFramelessWindow) {
if (currentWindow && currentWindow.nativeInterface) {
currentWindow.nativeInterface.framelessPostMessage(JSON.stringify(request));
}
}
else {
microsoftTeams.sendCustomMessage = sendCustomMessage;
function sendMessageResponse(targetWindow, id,
// tslint:disable-next-line:no-any
args) {
var response = createMessageResponse(id, args);
var targetOrigin = getTargetOrigin(targetWindow);
// If the target window isn't closed and we already know its origin, send the message right away; otherwise,
// queue the message and send it after the origin is established
if (targetWindow && targetOrigin) {
targetWindow.postMessage(request, targetOrigin);
targetWindow.postMessage(response, targetOrigin);
}
else {
getTargetMessageQueue(targetWindow).push(request);
}
}
return request.id;
}
/**
* @private
* Internal use only
* Sends a custom action message to Teams.
* @param actionName Specifies name of the custom action to be sent
* @param args Specifies additional arguments passed to the action
* @returns id of sent message
*/
function sendCustomMessage(actionName,
// tslint:disable-next-line:no-any
args) {
ensureInitialized();
return sendMessageRequest(parentWindow, actionName, args);
}
function sendMessageResponse(targetWindow, id,
// tslint:disable-next-line:no-any
args) {
var response = createMessageResponse(id, args);
var targetOrigin = getTargetOrigin(targetWindow);
if (targetWindow && targetOrigin) {
targetWindow.postMessage(response, targetOrigin);
// tslint:disable-next-line:no-any
function createMessageRequest(func, args) {
return {
id: nextMessageId++,
func: func,
args: args || []
};
}
}
// tslint:disable-next-line:no-any
function createMessageRequest(func, args) {
return {
id: nextMessageId++,
func: func,
args: args || []
};
}
// tslint:disable-next-line:no-any
function createMessageResponse(id, args) {
return {
id: id,
args: args || []
};
}
/**
* Namespace to interact with the task module-specific part of the SDK.
* This object is usable only on the content frame.
*/
var tasks;
(function (tasks) {
// tslint:disable-next-line:no-any
function createMessageResponse(id, args) {
return {
id: id,
args: args || []
};
}
/**
* Allows an app to open the task module.
* @param taskInfo An object containing the parameters of the task module
* @param submitHandler Handler to call when the task module is completed
* Namespace to interact with the task module-specific part of the SDK.
* This object is usable only on the content frame.
*/
function startTask(taskInfo, submitHandler) {
ensureInitialized(frameContexts.content);
var messageId = sendMessageRequest(parentWindow, "tasks.startTask", [
taskInfo
]);
callbacks[messageId] = submitHandler;
}
tasks.startTask = startTask;
var tasks;
(function (tasks) {
/**
* Allows an app to open the task module.
* @param taskInfo An object containing the parameters of the task module
* @param submitHandler Handler to call when the task module is completed
*/
function startTask(taskInfo, submitHandler) {
ensureInitialized(frameContexts.content);
var messageId = sendMessageRequest(parentWindow, "tasks.startTask", [
taskInfo
]);
callbacks[messageId] = submitHandler;
}
tasks.startTask = startTask;
/**
* Submit the task module.
* @param result Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
* @param appIds Helps to validate that the call originates from the same appId as the one that invoked the task module
*/
function submitTask(result, appIds) {
ensureInitialized(frameContexts.content, frameContexts.task);
// Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
sendMessageRequest(parentWindow, "tasks.completeTask", [
result,
Array.isArray(appIds) ? appIds : [appIds]
]);
}
tasks.submitTask = submitTask;
})(tasks = microsoftTeams.tasks || (microsoftTeams.tasks = {}));
/**
* Submit the task module.
* @param result Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
* @param appIds Helps to validate that the call originates from the same appId as the one that invoked the task module
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all chat members
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the members are and never as proof of membership.
* @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
*/
function submitTask(result, appIds) {
ensureInitialized(frameContexts.content, frameContexts.task);
// Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
sendMessageRequest(parentWindow, "tasks.completeTask", [
result,
Array.isArray(appIds) ? appIds : [appIds]
]);
function getChatMembers(callback) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getChatMembers");
callbacks[messageId] = callback;
}
tasks.submitTask = submitTask;
})(tasks || (tasks = {}));
/**
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all chat members
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the members are and never as proof of membership.
* @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
*/
function getChatMembers(callback) {
ensureInitialized();
var messageId = sendMessageRequest(parentWindow, "getChatMembers");
callbacks[messageId] = callback;
}
microsoftTeams.getChatMembers = getChatMembers;
})(microsoftTeams || (microsoftTeams = {}));

@@ -1281,0 +1284,0 @@ // CONCATENATED MODULE: ./index.ts

1517

dist/src/MicrosoftTeams.d.ts

@@ -1,587 +0,797 @@

export declare const enum HostClientType {
desktop = "desktop",
web = "web",
android = "android",
ios = "ios"
}
/**
* Namespace to interact with the menu-specific part of the SDK.
* This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
*
* @private
* Hide from docs until feature is complete
* This is the root namespace for the JavaScript SDK.
*/
export declare namespace menus {
export declare module microsoftTeams {
const enum HostClientType {
desktop = "desktop",
web = "web",
android = "android",
ios = "ios"
}
/**
* Represents information about item in View Configuration.
* Namespace to interact with the menu-specific part of the SDK.
* This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
*
* @private
* Hide from docs until feature is complete
*/
interface ViewConfiguration {
namespace menus {
/**
* Unique identifier of view.
* Represents information about item in View Configuration.
*/
id: string;
interface ViewConfiguration {
/**
* Unique identifier of view.
*/
id: string;
/**
* Display title of the view.
*/
title: string;
/**
* Additional information for accessibility.
*/
contentDescription?: string;
}
/**
* Display title of the view.
* Represents information about menu item for Action Menu and Navigation Bar Menu.
*/
title: string;
class MenuItem {
/**
* Unique identifier for the menu item.
*/
id: string;
/**
* Display title of the menu item.
*/
title: string;
/**
* Display icon of the menu item. The icon value must be a string having SVG icon content.
*/
icon?: string;
/**
* Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
*/
iconSelected?: string;
/**
* Additional information for accessibility.
*/
contentDescription?: string;
/**
* State of the menu item
*/
enabled: boolean;
/**
* Interface to show list of items on selection of menu item.
*/
viewData: ViewData;
}
/**
* Additional information for accessibility.
* Represents information about view to show on Navigation Bar Menu item selection
*/
contentDescription?: string;
interface ViewData {
/**
* Display header title of the item list.
*/
listTitle?: string;
/**
* Type of the menu item.
*/
listType: MenuListType;
/**
* Array of MenuItem. Icon value will be required for all items in the list.
*/
listItems: MenuItem[];
}
/**
* Represents information about type of list to display in Navigation Bar Menu.
*/
enum MenuListType {
dropDown = "dropDown",
popOver = "popOver"
}
/**
* Registers list of view configurations and it's handler.
* Handler is responsible for listening selection of View Configuration.
* @param viewConfig List of view configurations. Minimum 1 value is required.
* @param handler The handler to invoke when the user selects view configuration.
*/
function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
/**
* Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
* @param items List of MenuItems for Navigation Bar Menu.
* @param handler The handler to invoke when the user selects menu item.
*/
function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
interface ActionMenuParameters {
/**
* Display title for Action Menu
*/
title: string;
/**
* List of MenuItems for Action Menu
*/
items: MenuItem[];
}
/**
* Used to show Action Menu.
* @param params Parameters for Menu Parameters
* @param handler The handler to invoke when the user selects menu item.
*/
function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
}
/**
* Represents information about menu item for Action Menu and Navigation Bar Menu.
* Represents information about tabs for an app
*/
class MenuItem {
interface TabInformation {
teamTabs: TabInstance[];
}
/**
* Represents information about a tab instance
*/
interface TabInstance {
/**
* Unique identifier for the menu item.
* The name of the tab
*/
id: string;
tabName: string;
/**
* Display title of the menu item.
* Internal: do not use
* @protected
*/
title: string;
internalTabInstanceId?: string;
/**
* Display icon of the menu item. The icon value must be a string having SVG icon content.
* Last viewed time of this tab. null means unknown
*/
icon?: string;
lastViewUnixEpochTime?: string;
/**
* Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
* The developer-defined unique ID for the entity this content points to.
*/
iconSelected?: string;
entityId?: string;
/**
* Additional information for accessibility.
* The Microsoft Teams ID for the channel with which the content is associated.
*/
contentDescription?: string;
channelId?: string;
/**
* State of the menu item
* The name for the channel with which the content is associated.
*/
enabled: boolean;
channelName?: string;
/**
* Interface to show list of items on selection of menu item.
* Is this tab in a favorite channel?
*/
viewData: ViewData;
}
/**
* Represents information about view to show on Navigation Bar Menu item selection
*/
interface ViewData {
channelIsFavorite?: boolean;
/**
* Display header title of the item list.
* The Microsoft Teams ID for the team with which the content is associated.
*/
listTitle?: string;
teamId?: string;
/**
* Type of the menu item.
* The name for the team with which the content is associated.
*/
listType: MenuListType;
teamName?: string;
/**
* Array of MenuItem. Icon value will be required for all items in the list.
* Is this tab in a favorite team?
*/
listItems: MenuItem[];
teamIsFavorite?: boolean;
/**
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
*/
groupId?: string;
/**
* Content URL of this tab
*/
url?: string;
/**
* Website URL of this tab
*/
websiteUrl?: string;
}
/**
* Represents information about type of list to display in Navigation Bar Menu.
* Indicates the team type, currently used to distinguish between different team
* types in Office 365 for Education (team types 1, 2, 3, and 4).
*/
enum MenuListType {
dropDown = "dropDown",
popOver = "popOver"
const enum TeamType {
Standard = 0,
Edu = 1,
Class = 2,
Plc = 3,
Staff = 4
}
/**
* Registers list of view configurations and it's handler.
* Handler is responsible for listening selection of View Configuration.
* @param viewConfig List of view configurations. Minimum 1 value is required.
* @param handler The handler to invoke when the user selects view configuration.
* Indicates the various types of roles of a user in a team.
*/
function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
const enum UserTeamRole {
Admin = 0,
User = 1,
Guest = 2
}
/**
* Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
* @param items List of MenuItems for Navigation Bar Menu.
* @param handler The handler to invoke when the user selects menu item.
* Indicates information about the tab instance for filtering purposes.
*/
function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
interface ActionMenuParameters {
interface TabInstanceParameters {
/**
* Display title for Action Menu
* Flag allowing to select favorite channels only
*/
title: string;
favoriteChannelsOnly?: boolean;
/**
* List of MenuItems for Action Menu
* Flag allowing to select favorite teams only
*/
items: MenuItem[];
favoriteTeamsOnly?: boolean;
}
/**
* Used to show Action Menu.
* @param params Parameters for Menu Parameters
* @param handler The handler to invoke when the user selects menu item.
* @private
* Hide from docs
* --------
* Query parameters used when fetching team information
*/
function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
}
/**
* Represents information about tabs for an app
*/
export interface TabInformation {
teamTabs: TabInstance[];
}
/**
* Represents information about a tab instance
*/
export interface TabInstance {
interface TeamInstanceParameters {
/**
* Flag allowing to select favorite teams only
*/
favoriteTeamsOnly?: boolean;
}
/**
* The name of the tab
* @private
* Hide from docs
* --------
* Information on userJoined Teams
*/
tabName: string;
interface UserJoinedTeamsInformation {
/**
* List of team information
*/
userJoinedTeams: TeamInformation[];
}
/**
* Internal: do not use
* @protected
* Represends Team Information
*/
internalTabInstanceId?: string;
interface TeamInformation {
/**
* Id of the team
*/
teamId: string;
/**
* Team display name
*/
teamName: string;
/**
* Team description
*/
teamDescription?: string;
/**
* Thumbnail Uri
*/
thumbnailUri?: string;
/**
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
*/
groupId?: string;
/**
* Role of current user in the team
*/
userTeamRole?: UserTeamRole;
}
const enum TaskModuleDimension {
Large = "large",
Medium = "medium",
Small = "small"
}
/**
* Last viewed time of this tab. null means unknown
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
lastViewUnixEpochTime?: string;
function initialize(hostWindow?: any): void;
/**
* The developer-defined unique ID for the entity this content points to.
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
entityId?: string;
function _uninitialize(): void;
/**
* The Microsoft Teams ID for the channel with which the content is associated.
* Enable print capability to support printing page using Ctrl+P and cmd+P
*/
channelId?: string;
function enablePrintCapability(): void;
/**
* The name for the channel with which the content is associated.
* default print handler
*/
channelName?: string;
function print(): void;
/**
* Is this tab in a favorite channel?
* Retrieves the current context the frame is running in.
* @param callback The callback to invoke when the {@link Context} object is retrieved.
*/
channelIsFavorite?: boolean;
function getContext(callback: (context: Context) => void): void;
/**
* The Microsoft Teams ID for the team with which the content is associated.
* Registers a handler for theme changes.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user changes their theme.
*/
teamId?: string;
function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
/**
* The name for the team with which the content is associated.
* Registers a handler for changes from or to full-screen view for a tab.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user toggles full-screen view for a tab.
*/
teamName?: string;
function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
/**
* Is this tab in a favorite team?
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
* that after running its back button handler it cannot handle the event it should call the navigateBack
* method to ask the Teams client to handle it instead.
* @param handler The handler to invoke when the user presses their Team client's back button.
*/
teamIsFavorite?: boolean;
function registerBackButtonHandler(handler: () => boolean): void;
/**
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
* Navigates back in the Teams client. See registerBackButtonHandler for more information on when
* it's appropriate to use this method.
*/
groupId?: string;
function navigateBack(): void;
/**
* Content URL of this tab
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
* than the current one in a way that keeps the app informed of the change and allows the SDK to
* continue working.
* @param url The URL to navigate the frame to.
*/
url?: string;
function navigateCrossDomain(url: string): void;
/**
* Website URL of this tab
* Allows an app to retrieve for this user tabs that are owned by this app.
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
* @param callback The callback to invoke when the {@link TabInstanceParameters} object is retrieved.
* @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
*/
websiteUrl?: string;
}
/**
* Indicates the team type, currently used to distinguish between different team
* types in Office 365 for Education (team types 1, 2, 3, and 4).
*/
export declare const enum TeamType {
Standard = 0,
Edu = 1,
Class = 2,
Plc = 3,
Staff = 4
}
/**
* Indicates the various types of roles of a user in a team.
*/
export declare const enum UserTeamRole {
Admin = 0,
User = 1,
Guest = 2
}
/**
* Indicates information about the tab instance for filtering purposes.
*/
export interface TabInstanceParameters {
function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
/**
* Flag allowing to select favorite channels only
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all user joined teams
* @param callback The callback to invoke when the {@link TeamInstanceParameters} object is retrieved.
* @param teamInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams
*/
favoriteChannelsOnly?: boolean;
function getUserJoinedTeams(callback: (userJoinedTeamsInformation: UserJoinedTeamsInformation) => void, teamInstanceParameters?: TeamInstanceParameters): void;
/**
* Flag allowing to select favorite teams only
* Allows an app to retrieve the most recently used tabs for this user.
* @param callback The callback to invoke when the {@link TabInformation} object is retrieved.
* @param tabInstanceParameters OPTIONAL Ignored, kept for future use
*/
favoriteTeamsOnly?: boolean;
}
/**
* @private
* Hide from docs
* --------
* Query parameters used when fetching team information
*/
export interface TeamInstanceParameters {
function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
/**
* Flag allowing to select favorite teams only
* Shares a deep link that a user can use to navigate back to a specific state in this page.
* @param deepLinkParameters ID and label for the link and fallback URL.
*/
favoriteTeamsOnly?: boolean;
}
/**
* @private
* Hide from docs
* --------
* Information on userJoined Teams
*/
export interface UserJoinedTeamsInformation {
function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
/**
* List of team information
* @private
* Hide from docs.
* ------
* Opens a client-friendly preview of the specified file.
* @param file The file to preview.
*/
userJoinedTeams: TeamInformation[];
}
/**
* Represends Team Information
*/
export interface TeamInformation {
function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
interface ShowNotificationParameters {
message: string;
isDownloadComplete: boolean;
}
/**
* Id of the team
* @private
* Hide from docs.
* ------
* download file.
* @param file The file to download.
*/
teamId: string;
function showNotification(showNotificationParameters: ShowNotificationParameters): void;
/**
* Team display name
* @private
* Hide from docs.
* ------
* Upload a custom App manifest directly to both team and personal scopes.
* This method works just for the first party Apps.
*/
teamName: string;
function uploadCustomApp(manifestBlob: Blob): void;
/**
* Team description
* Navigates the Microsoft Teams app to the specified tab instance.
* @param tabInstance The tab instance to navigate to.
*/
teamDescription?: string;
function navigateToTab(tabInstance: TabInstance): void;
/**
* Thumbnail Uri
* Namespace to interact with the settings-specific part of the SDK.
* This object is usable only on the settings frame.
*/
thumbnailUri?: string;
namespace settings {
/**
* Sets the validity state for the settings.
* The initial value is false, so the user cannot save the settings until this is called with true.
* @param validityState Indicates whether the save or remove button is enabled for the user.
*/
function setValidityState(validityState: boolean): void;
/**
* Gets the settings for the current instance.
* @param callback The callback to invoke when the {@link Settings} object is retrieved.
*/
function getSettings(callback: (instanceSettings: Settings) => void): void;
/**
* Sets the settings for the current instance.
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
* @param settings The desired settings for this instance.
*/
function setSettings(instanceSettings: Settings): void;
/**
* Registers a handler for when the user attempts to save the settings. This handler should be used
* to create or update the underlying resource powering the content.
* The object passed to the handler must be used to notify whether to proceed with the save.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user selects the save button.
*/
function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
/**
* Registers a handler for user attempts to remove content. This handler should be used
* to remove the underlying resource powering the content.
* The object passed to the handler must be used to indicate whether to proceed with the removal.
* Only one handler may be registered at a time. Subsequent registrations will override the first.
* @param handler The handler to invoke when the user selects the remove button.
*/
function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
interface Settings {
/**
* A suggested display name for the new content.
* In the settings for an existing instance being updated, this call has no effect.
*/
suggestedDisplayName?: string;
/**
* Sets the URL to use for the content of this instance.
*/
contentUrl: string;
/**
* Sets the URL for the removal configuration experience.
*/
removeUrl?: string;
/**
* Sets the URL to use for the external link to view the underlying resource in a browser.
*/
websiteUrl?: string;
/**
* The developer-defined unique ID for the entity to which this content points.
*/
entityId: string;
}
interface SaveEvent {
/**
* Object containing properties passed as arguments to the settings.save event.
*/
result: SaveParameters;
/**
* Indicates that the underlying resource has been created and the settings can be saved.
*/
notifySuccess(): void;
/**
* Indicates that creation of the underlying resource failed and that the settings cannot be saved.
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
*/
notifyFailure(reason?: string): void;
}
interface RemoveEvent {
/**
* Indicates that the underlying resource has been removed and the content can be removed.
*/
notifySuccess(): void;
/**
* Indicates that removal of the underlying resource failed and that the content cannot be removed.
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
*/
notifyFailure(reason?: string): void;
}
interface SaveParameters {
/**
* Connector's webhook Url returned as arguments to settings.save event as part of user clicking on Save
*/
webhookUrl?: string;
}
}
/**
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
* Namespace to interact with the authentication-specific part of the SDK.
* This object is used for starting or completing authentication flows.
*/
groupId?: string;
/**
* Role of current user in the team
*/
userTeamRole?: UserTeamRole;
}
export declare const enum TaskModuleDimension {
Large = "large",
Medium = "medium",
Small = "small"
}
/**
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
export declare function initialize(hostWindow?: any): void;
/**
* Initializes the library. This must be called before any other SDK calls
* but after the frame is loaded successfully.
*/
export declare function _uninitialize(): void;
/**
* Enable print capability to support printing page using Ctrl+P and cmd+P
*/
export declare function enablePrintCapability(): void;
/**
* default print handler
*/
export declare function print(): void;
/**
* Retrieves the current context the frame is running in.
* @param callback The callback to invoke when the {@link Context} object is retrieved.
*/
export declare function getContext(callback: (context: Context) => void): void;
/**
* Registers a handler for theme changes.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user changes their theme.
*/
export declare function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
/**
* Registers a handler for changes from or to full-screen view for a tab.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user toggles full-screen view for a tab.
*/
export declare function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
/**
* Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
* navigation stack should use this handler to navigate the user back within their frame. If an app finds
* that after running its back button handler it cannot handle the event it should call the navigateBack
* method to ask the Teams client to handle it instead.
* @param handler The handler to invoke when the user presses their Team client's back button.
*/
export declare function registerBackButtonHandler(handler: () => boolean): void;
/**
* Navigates back in the Teams client. See registerBackButtonHandler for more information on when
* it's appropriate to use this method.
*/
export declare function navigateBack(): void;
/**
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
* than the current one in a way that keeps the app informed of the change and allows the SDK to
* continue working.
* @param url The URL to navigate the frame to.
*/
export declare function navigateCrossDomain(url: string): void;
/**
* Allows an app to retrieve for this user tabs that are owned by this app.
* If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
* @param callback The callback to invoke when the {@link TabInstanceParameters} object is retrieved.
* @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
*/
export declare function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
/**
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all user joined teams
* @param callback The callback to invoke when the {@link TeamInstanceParameters} object is retrieved.
* @param teamInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams
*/
export declare function getUserJoinedTeams(callback: (userJoinedTeamsInformation: UserJoinedTeamsInformation) => void, teamInstanceParameters?: TeamInstanceParameters): void;
/**
* Allows an app to retrieve the most recently used tabs for this user.
* @param callback The callback to invoke when the {@link TabInformation} object is retrieved.
* @param tabInstanceParameters OPTIONAL Ignored, kept for future use
*/
export declare function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
/**
* Shares a deep link that a user can use to navigate back to a specific state in this page.
* @param deepLinkParameters ID and label for the link and fallback URL.
*/
export declare function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
/**
* @private
* Hide from docs.
* ------
* Opens a client-friendly preview of the specified file.
* @param file The file to preview.
*/
export declare function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
export interface ShowNotificationParameters {
message: string;
isDownloadComplete: boolean;
}
/**
* @private
* Hide from docs.
* ------
* download file.
* @param file The file to download.
*/
export declare function showNotification(showNotificationParameters: ShowNotificationParameters): void;
/**
* @private
* Hide from docs.
* ------
* Upload a custom App manifest directly to both team and personal scopes.
* This method works just for the first party Apps.
*/
export declare function uploadCustomApp(manifestBlob: Blob): void;
/**
* Navigates the Microsoft Teams app to the specified tab instance.
* @param tabInstance The tab instance to navigate to.
*/
export declare function navigateToTab(tabInstance: TabInstance): void;
/**
* Namespace to interact with the settings-specific part of the SDK.
* This object is usable only on the settings frame.
*/
export declare namespace settings {
/**
* Sets the validity state for the settings.
* The initial value is false, so the user cannot save the settings until this is called with true.
* @param validityState Indicates whether the save or remove button is enabled for the user.
*/
function setValidityState(validityState: boolean): void;
/**
* Gets the settings for the current instance.
* @param callback The callback to invoke when the {@link Settings} object is retrieved.
*/
function getSettings(callback: (instanceSettings: Settings) => void): void;
/**
* Sets the settings for the current instance.
* This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
* @param settings The desired settings for this instance.
*/
function setSettings(instanceSettings: Settings): void;
/**
* Registers a handler for when the user attempts to save the settings. This handler should be used
* to create or update the underlying resource powering the content.
* The object passed to the handler must be used to notify whether to proceed with the save.
* Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
* @param handler The handler to invoke when the user selects the save button.
*/
function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
/**
* Registers a handler for user attempts to remove content. This handler should be used
* to remove the underlying resource powering the content.
* The object passed to the handler must be used to indicate whether to proceed with the removal.
* Only one handler may be registered at a time. Subsequent registrations will override the first.
* @param handler The handler to invoke when the user selects the remove button.
*/
function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
interface Settings {
namespace authentication {
/**
* A suggested display name for the new content.
* In the settings for an existing instance being updated, this call has no effect.
* Registers the authentication handlers
* @param authenticateParameters A set of values that configure the authentication pop-up.
*/
suggestedDisplayName?: string;
function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
/**
* Sets the URL to use for the content of this instance.
* Initiates an authentication request, which opens a new window with the specified settings.
*/
contentUrl: string;
function authenticate(authenticateParameters?: AuthenticateParameters): void;
/**
* Sets the URL for the removal configuration experience.
* @private
* Hide from docs.
* ------
* Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
* if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
* @param authTokenRequest A set of values that configure the token request.
*/
removeUrl?: string;
function getAuthToken(authTokenRequest: AuthTokenRequest): void;
/**
* Sets the URL to use for the external link to view the underlying resource in a browser.
* @private
* Hide from docs.
* ------
* Requests the decoded Azure AD user identity on behalf of the app.
*/
websiteUrl?: string;
function getUser(userRequest: UserRequest): void;
/**
* The developer-defined unique ID for the entity to which this content points.
* Notifies the frame that initiated this authentication request that the request was successful.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
entityId: string;
}
interface SaveEvent {
function notifySuccess(result?: string, callbackUrl?: string): void;
/**
* Object containing properties passed as arguments to the settings.save event.
* Notifies the frame that initiated this authentication request that the request failed.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
result: SaveParameters;
function notifyFailure(reason?: string, callbackUrl?: string): void;
interface AuthenticateParameters {
/**
* The URL for the authentication pop-up.
*/
url: string;
/**
* The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
*/
width?: number;
/**
* The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
*/
height?: number;
/**
* A function that is called if the authentication succeeds, with the result returned from the authentication pop-up.
*/
successCallback?: (result?: string) => void;
/**
* A function that is called if the authentication fails, with the reason for the failure returned from the authentication pop-up.
*/
failureCallback?: (reason?: string) => void;
}
/**
* Indicates that the underlying resource has been created and the settings can be saved.
* @private
* Hide from docs.
* ------
*/
notifySuccess(): void;
interface AuthTokenRequest {
/**
* An array of resource URIs identifying the target resources for which the token should be requested.
*/
resources: string[];
/**
* A function that is called if the token request succeeds, with the resulting token.
*/
successCallback?: (token: string) => void;
/**
* A function that is called if the token request fails, with the reason for the failure.
*/
failureCallback?: (reason: string) => void;
}
/**
* Indicates that creation of the underlying resource failed and that the settings cannot be saved.
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
* @private
* Hide from docs.
* ------
*/
notifyFailure(reason?: string): void;
interface UserRequest {
/**
* A function that is called if the token request succeeds, with the resulting token.
*/
successCallback?: (user: UserProfile) => void;
/**
* A function that is called if the token request fails, with the reason for the failure.
*/
failureCallback?: (reason: string) => void;
}
/**
* @private
* Hide from docs.
* ------
*/
interface UserProfile {
/**
* The intended recipient of the token. The application that receives the token must verify that the audience
* value is correct and reject any tokens intended for a different audience.
*/
aud: string;
/**
* Identifies how the subject of the token was authenticated.
*/
amr: string[];
/**
* Stores the time at which the token was issued. It is often used to measure token freshness.
*/
iat: number;
/**
* Identifies the security token service (STS) that constructs and returns the token. In the tokens that Azure AD
* returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Azure AD
* directory. The tenant ID is an immutable and reliable identifier of the directory.
*/
iss: string;
/**
* Provides the last name, surname, or family name of the user as defined in the Azure AD user object.
*/
family_name: string;
/**
* Provides the first or "given" name of the user, as set on the Azure AD user object.
*/
given_name: string;
/**
* Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
* be unique within a tenant and is designed to be used only for display purposes.
*/
unique_name: string;
/**
* Contains a unique identifier of an object in Azure AD. This value is immutable and cannot be reassigned or
* reused. Use the object ID to identify an object in queries to Azure AD.
*/
oid: string;
/**
* Identifies the principal about which the token asserts information, such as the user of an application.
* This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
* checks safely. Because the subject is always present in the tokens the Azure AD issues, we recommended
* using this value in a general-purpose authorization system.
*/
sub: string;
/**
* An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
* use this value to access tenant-specific directory resources in a multitenant application. For example,
* you can use this value to identify the tenant in a call to the Graph API.
*/
tid: string;
/**
* Defines the time interval within which a token is valid. The service that validates the token should verify
* that the current date is within the token lifetime; otherwise it should reject the token. The service might
* allow for up to five minutes beyond the token lifetime to account for any differences in clock time ("time
* skew") between Azure AD and the service.
*/
exp: number;
nbf: number;
/**
* Stores the user name of the user principal.
*/
upn: string;
/**
* Stores the version number of the token.
*/
ver: string;
}
}
interface RemoveEvent {
interface Context {
/**
* Indicates that the underlying resource has been removed and the content can be removed.
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
*/
notifySuccess(): void;
groupId?: string;
/**
* Indicates that removal of the underlying resource failed and that the content cannot be removed.
* @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
* The Microsoft Teams ID for the team with which the content is associated.
*/
notifyFailure(reason?: string): void;
}
interface SaveParameters {
teamId?: string;
/**
* Connector's webhook Url returned as arguments to settings.save event as part of user clicking on Save
* The name for the team with which the content is associated.
*/
webhookUrl?: string;
}
}
/**
* Namespace to interact with the authentication-specific part of the SDK.
* This object is used for starting or completing authentication flows.
*/
export declare namespace authentication {
/**
* Registers the authentication handlers
* @param authenticateParameters A set of values that configure the authentication pop-up.
*/
function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
/**
* Initiates an authentication request, which opens a new window with the specified settings.
*/
function authenticate(authenticateParameters?: AuthenticateParameters): void;
/**
* @private
* Hide from docs.
* ------
* Requests an Azure AD token to be issued on behalf of the app. The token is acquired from the cache
* if it is not expired. Otherwise a request is sent to Azure AD to obtain a new token.
* @param authTokenRequest A set of values that configure the token request.
*/
function getAuthToken(authTokenRequest: AuthTokenRequest): void;
/**
* @private
* Hide from docs.
* ------
* Requests the decoded Azure AD user identity on behalf of the app.
*/
function getUser(userRequest: UserRequest): void;
/**
* Notifies the frame that initiated this authentication request that the request was successful.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
function notifySuccess(result?: string, callbackUrl?: string): void;
/**
* Notifies the frame that initiated this authentication request that the request failed.
* This function is usable only on the authentication window.
* This call causes the authentication window to be closed.
* @param result Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives this value in its callback.
* @param callbackUrl Specifies the url to redirect back to if the client is Win32 Outlook.
*/
function notifyFailure(reason?: string, callbackUrl?: string): void;
interface AuthenticateParameters {
teamName?: string;
/**
* The URL for the authentication pop-up.
* The Microsoft Teams ID for the channel with which the content is associated.
*/
url: string;
channelId?: string;
/**
* The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
* The name for the channel with which the content is associated.
*/
width?: number;
channelName?: string;
/**
* The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
* The developer-defined unique ID for the entity this content points to.
*/
height?: number;
entityId: string;
/**
* A function that is called if the authentication succeeds, with the result returned from the authentication pop-up.
* The developer-defined unique ID for the sub-entity this content points to.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
successCallback?: (result?: string) => void;
subEntityId?: string;
/**
* A function that is called if the authentication fails, with the reason for the failure returned from the authentication pop-up.
* The current locale that the user has configured for the app formatted as
* languageId-countryId (for example, en-us).
*/
failureCallback?: (reason?: string) => void;
}
/**
* @private
* Hide from docs.
* ------
*/
interface AuthTokenRequest {
locale: string;
/**
* An array of resource URIs identifying the target resources for which the token should be requested.
* @deprecated Use loginHint or userPrincipalName.
* The UPN of the current user.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
resources: string[];
upn?: string;
/**
* A function that is called if the token request succeeds, with the resulting token.
* The Azure AD tenant ID of the current user.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
successCallback?: (token: string) => void;
tid?: string;
/**
* A function that is called if the token request fails, with the reason for the failure.
* The current UI theme.
*/
failureCallback?: (reason: string) => void;
theme?: string;
/**
* Indication whether the tab is in full-screen mode.
*/
isFullScreen?: boolean;
/**
* The type of the team.
*/
teamType?: TeamType;
/**
* The root ShatePoint folder associated with the team.
*/
teamSiteUrl?: string;
/**
* The relative path to the SharePoint folder associated with the channel.
*/
channelRelativeUrl?: string;
/**
* Unique ID for the current Teams session for use in correlating telemetry data.
*/
sessionId?: string;
/**
* The user's role in the team.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to the user's role, and never as proof of her role.
*/
userTeamRole?: UserTeamRole;
/**
* The Microsoft Teams ID for the chat with which the content is associated.
*/
chatId?: string;
/**
* A value suitable for use as a login_hint when authenticating with Azure AD.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
loginHint?: string;
/**
* The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
userPrincipalName?: string;
/**
* The Azure AD object id of the current user.
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
userObjectId?: string;
/**
* Indicates wheather team is archived.
* Apps should use this as a signal to prevent any changes to content associated with archived teams.
*/
isTeamArchived?: boolean;
/**
* The type of the host client. Possible values are : android, ios, web, desktop
*/
hostClientType?: HostClientType;
}
/**
* @private
* Hide from docs.
* ------
*/
interface UserRequest {
interface DeepLinkParameters {
/**
* A function that is called if the token request succeeds, with the resulting token.
* The developer-defined unique ID for the sub-entity to which this deep link points in the current entity.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
successCallback?: (user: UserProfile) => void;
subEntityId: string;
/**
* A function that is called if the token request fails, with the reason for the failure.
* The label for the sub-entity that should be displayed when the deep link is rendered in a client.
*/
failureCallback?: (reason: string) => void;
subEntityLabel: string;
/**
* The fallback URL to which to navigate the user if the client cannot render the page.
* This URL should lead directly to the sub-entity.
*/
subEntityWebUrl?: string;
}

@@ -593,344 +803,139 @@ /**

*/
interface UserProfile {
interface FilePreviewParameters {
/**
* The intended recipient of the token. The application that receives the token must verify that the audience
* value is correct and reject any tokens intended for a different audience.
* The developer-defined unique ID for the file.
*/
aud: string;
entityId: string;
/**
* Identifies how the subject of the token was authenticated.
* The display name of the file.
*/
amr: string[];
title: string;
/**
* Stores the time at which the token was issued. It is often used to measure token freshness.
* An optional description of the file.
*/
iat: number;
description?: string;
/**
* Identifies the security token service (STS) that constructs and returns the token. In the tokens that Azure AD
* returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Azure AD
* directory. The tenant ID is an immutable and reliable identifier of the directory.
* The file extension; e.g. pptx, docx, etc.
*/
iss: string;
type: string;
/**
* Provides the last name, surname, or family name of the user as defined in the Azure AD user object.
* A url to the source of the file, used to open the content in the user's default browser
*/
family_name: string;
objectUrl: string;
/**
* Provides the first or "given" name of the user, as set on the Azure AD user object.
* Optional; an alternate self-authenticating url used to preview the file in Mobile clients and offer it for download by the user
*/
given_name: string;
downloadUrl?: string;
/**
* Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
* be unique within a tenant and is designed to be used only for display purposes.
* Optional; an alternate url optimized for previewing the file in Teams web and desktop clients
*/
unique_name: string;
webPreviewUrl?: string;
/**
* Contains a unique identifier of an object in Azure AD. This value is immutable and cannot be reassigned or
* reused. Use the object ID to identify an object in queries to Azure AD.
* Optional; an alternate url that allows editing of the file in Teams web and desktop clients
*/
oid: string;
webEditUrl?: string;
/**
* Identifies the principal about which the token asserts information, such as the user of an application.
* This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
* checks safely. Because the subject is always present in the tokens the Azure AD issues, we recommended
* using this value in a general-purpose authorization system.
* Optional; the base url of the site where the file is hosted
*/
sub: string;
baseUrl?: string;
/**
* An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
* use this value to access tenant-specific directory resources in a multitenant application. For example,
* you can use this value to identify the tenant in a call to the Graph API.
* Optional; indicates whether the file should be opened in edit mode
*/
tid: string;
editFile?: boolean;
/**
* Defines the time interval within which a token is valid. The service that validates the token should verify
* that the current date is within the token lifetime; otherwise it should reject the token. The service might
* allow for up to five minutes beyond the token lifetime to account for any differences in clock time ("time
* skew") between Azure AD and the service.
* Optional; the developer-defined unique ID for the sub-entity to return to when the file stage closes.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
exp: number;
nbf: number;
subEntityId?: string;
}
/**
* @private
* Internal use only
* Sends a custom action message to Teams.
* @param actionName Specifies name of the custom action to be sent
* @param args Specifies additional arguments passed to the action
* @returns id of sent message
*/
function sendCustomMessage(actionName: string, args?: any[]): number;
interface TaskInfo {
/**
* Stores the user name of the user principal.
* The url to be rendered in the webview/iframe.
*/
upn: string;
url?: string;
/**
* Stores the version number of the token.
* JSON defining an adaptive card.
*/
ver: string;
card?: string;
/**
* The requested height of the webview/iframe.
*/
height?: TaskModuleDimension | Number;
/**
* The requested width of the webview/iframe.
*/
width?: TaskModuleDimension | Number;
/**
* Title of the task module.
*/
title?: string;
/**
* If client doesnt support the URL, the URL that needs to be opened in the browser.
*/
fallbackUrl?: string;
/**
* Specifies a bot ID to send the result of the user's interaction with the task module.
* If specified, the bot will receive a task/complete invoke event with a JSON object
* in the event payload.
*/
completionBotId?: string;
}
}
export interface Context {
/**
* The Office 365 group ID for the team with which the content is associated.
* This field is available only when the identity permission is requested in the manifest.
* Namespace to interact with the task module-specific part of the SDK.
* This object is usable only on the content frame.
*/
groupId?: string;
namespace tasks {
/**
* Allows an app to open the task module.
* @param taskInfo An object containing the parameters of the task module
* @param submitHandler Handler to call when the task module is completed
*/
function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) => void): void;
/**
* Submit the task module.
* @param result Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
* @param appIds Helps to validate that the call originates from the same appId as the one that invoked the task module
*/
function submitTask(result?: string | object, appIds?: string | string[]): void;
}
/**
* The Microsoft Teams ID for the team with which the content is associated.
* @private
* Hide from docs
* --------
* Information about all members in a chat
*/
teamId?: string;
interface ChatMembersInformation {
members: ThreadMember[];
}
/**
* The name for the team with which the content is associated.
* @private
* Hide from docs
* --------
* Information about a chat member
*/
teamName?: string;
interface ThreadMember {
/**
* The member's user principal name in the current tenant.
*/
upn: string;
}
/**
* The Microsoft Teams ID for the channel with which the content is associated.
*/
channelId?: string;
/**
* The name for the channel with which the content is associated.
*/
channelName?: string;
/**
* The developer-defined unique ID for the entity this content points to.
*/
entityId: string;
/**
* The developer-defined unique ID for the sub-entity this content points to.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
subEntityId?: string;
/**
* The current locale that the user has configured for the app formatted as
* languageId-countryId (for example, en-us).
*/
locale: string;
/**
* @deprecated Use loginHint or userPrincipalName.
* The UPN of the current user.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
upn?: string;
/**
* The Azure AD tenant ID of the current user.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
tid?: string;
/**
* The current UI theme.
*/
theme?: string;
/**
* Indication whether the tab is in full-screen mode.
*/
isFullScreen?: boolean;
/**
* The type of the team.
*/
teamType?: TeamType;
/**
* The root ShatePoint folder associated with the team.
*/
teamSiteUrl?: string;
/**
* The relative path to the SharePoint folder associated with the channel.
*/
channelRelativeUrl?: string;
/**
* Unique ID for the current Teams session for use in correlating telemetry data.
*/
sessionId?: string;
/**
* The user's role in the team.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to the user's role, and never as proof of her role.
*/
userTeamRole?: UserTeamRole;
/**
* The Microsoft Teams ID for the chat with which the content is associated.
*/
chatId?: string;
/**
* A value suitable for use as a login_hint when authenticating with Azure AD.
* Because a malicious party can run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
loginHint?: string;
/**
* The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all chat members
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
* be used only as a hint as to who the members are and never as proof of membership.
* @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
*/
userPrincipalName?: string;
/**
* The Azure AD object id of the current user.
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the user is and never as proof of identity.
* This field is available only when the identity permission is requested in the manifest.
*/
userObjectId?: string;
/**
* Indicates wheather team is archived.
* Apps should use this as a signal to prevent any changes to content associated with archived teams.
*/
isTeamArchived?: boolean;
/**
* The type of the host client. Possible values are : android, ios, web, desktop
*/
hostClientType?: HostClientType;
function getChatMembers(callback: (chatMembersInformation: ChatMembersInformation) => void): void;
}
export interface DeepLinkParameters {
/**
* The developer-defined unique ID for the sub-entity to which this deep link points in the current entity.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
subEntityId: string;
/**
* The label for the sub-entity that should be displayed when the deep link is rendered in a client.
*/
subEntityLabel: string;
/**
* The fallback URL to which to navigate the user if the client cannot render the page.
* This URL should lead directly to the sub-entity.
*/
subEntityWebUrl?: string;
}
/**
* @private
* Hide from docs.
* ------
*/
export interface FilePreviewParameters {
/**
* The developer-defined unique ID for the file.
*/
entityId: string;
/**
* The display name of the file.
*/
title: string;
/**
* An optional description of the file.
*/
description?: string;
/**
* The file extension; e.g. pptx, docx, etc.
*/
type: string;
/**
* A url to the source of the file, used to open the content in the user's default browser
*/
objectUrl: string;
/**
* Optional; an alternate self-authenticating url used to preview the file in Mobile clients and offer it for download by the user
*/
downloadUrl?: string;
/**
* Optional; an alternate url optimized for previewing the file in Teams web and desktop clients
*/
webPreviewUrl?: string;
/**
* Optional; an alternate url that allows editing of the file in Teams web and desktop clients
*/
webEditUrl?: string;
/**
* Optional; the base url of the site where the file is hosted
*/
baseUrl?: string;
/**
* Optional; indicates whether the file should be opened in edit mode
*/
editFile?: boolean;
/**
* Optional; the developer-defined unique ID for the sub-entity to return to when the file stage closes.
* This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
*/
subEntityId?: string;
}
/**
* @private
* Internal use only
* Sends a custom action message to Teams.
* @param actionName Specifies name of the custom action to be sent
* @param args Specifies additional arguments passed to the action
* @returns id of sent message
*/
export declare function sendCustomMessage(actionName: string, args?: any[]): number;
export interface TaskInfo {
/**
* The url to be rendered in the webview/iframe.
*/
url?: string;
/**
* JSON defining an adaptive card.
*/
card?: string;
/**
* The requested height of the webview/iframe.
*/
height?: TaskModuleDimension | Number;
/**
* The requested width of the webview/iframe.
*/
width?: TaskModuleDimension | Number;
/**
* Title of the task module.
*/
title?: string;
/**
* If client doesnt support the URL, the URL that needs to be opened in the browser.
*/
fallbackUrl?: string;
/**
* Specifies a bot ID to send the result of the user's interaction with the task module.
* If specified, the bot will receive a task/complete invoke event with a JSON object
* in the event payload.
*/
completionBotId?: string;
}
/**
* Namespace to interact with the task module-specific part of the SDK.
* This object is usable only on the content frame.
*/
export declare namespace tasks {
/**
* Allows an app to open the task module.
* @param taskInfo An object containing the parameters of the task module
* @param submitHandler Handler to call when the task module is completed
*/
function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) => void): void;
/**
* Submit the task module.
* @param result Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
* @param appIds Helps to validate that the call originates from the same appId as the one that invoked the task module
*/
function submitTask(result?: string | object, appIds?: string | string[]): void;
}
/**
* @private
* Hide from docs
* --------
* Information about all members in a chat
*/
export interface ChatMembersInformation {
members: ThreadMember[];
}
/**
* @private
* Hide from docs
* --------
* Information about a chat member
*/
export interface ThreadMember {
/**
* The member's user principal name in the current tenant.
*/
upn: string;
}
/**
* @private
* Hide from docs
* ------
* Allows an app to retrieve information of all chat members
* Because a malicious party run your content in a browser, this value should
* be used only as a hint as to who the members are and never as proof of membership.
* @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
*/
export declare function getChatMembers(callback: (chatMembersInformation: ChatMembersInformation) => void): void;

2

package.json
{
"name": "@microsoft/teams-js",
"author": "Microsoft Teams",
"version": "1.4.0-beta.3.4",
"version": "1.4.0-beta.3.5",
"description": "Microsoft Client SDK for building app for Microsoft teams",

@@ -6,0 +6,0 @@ "main": "./dist/MicrosoftTeams.js",

dist/MicrosoftTeams.js.map

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc