@microsoft/teams-js 2.30.0 → 2.31.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/_virtual/__polyfill-node.os.js +1 -0
- package/dist/esm/_virtual/_polyfill-node.os.js +1 -0
- package/dist/esm/node_modules/.pnpm/debug@4.3.5/node_modules/debug/src/node.js +1 -1
- package/dist/esm/node_modules/.pnpm/has-flag@4.0.0/node_modules/has-flag/index.js +1 -0
- package/dist/esm/node_modules/.pnpm/supports-color@7.2.0/node_modules/supports-color/index.js +1 -0
- package/dist/esm/packages/teams-js/dts/index.d.ts +2 -0
- package/dist/esm/packages/teams-js/dts/internal/VideoFrameTypes.d.ts +78 -0
- package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +8 -0
- package/dist/esm/packages/teams-js/dts/internal/appIdValidation.d.ts +16 -0
- package/dist/esm/packages/teams-js/dts/internal/communication.d.ts +162 -0
- package/dist/esm/packages/teams-js/dts/internal/constants.d.ts +146 -0
- package/dist/esm/packages/teams-js/dts/internal/deepLinkConstants.d.ts +26 -0
- package/dist/esm/packages/teams-js/dts/internal/deepLinkUtilities.d.ts +4 -0
- package/dist/esm/packages/teams-js/dts/internal/emailAddressValidation.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/internal/globalVars.d.ts +12 -0
- package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +80 -0
- package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +47 -0
- package/dist/esm/packages/teams-js/dts/internal/internalAPIs.d.ts +61 -0
- package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts +94 -0
- package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts +95 -0
- package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +73 -0
- package/dist/esm/packages/teams-js/dts/internal/nestedAppAuthUtils.d.ts +105 -0
- package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +11 -0
- package/dist/esm/packages/teams-js/dts/internal/responseHandler.d.ts +30 -0
- package/dist/esm/packages/teams-js/dts/internal/telemetry.d.ts +344 -0
- package/dist/esm/packages/teams-js/dts/internal/typeCheckUtilities.d.ts +1 -0
- package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +200 -0
- package/dist/esm/packages/teams-js/dts/internal/uuidObject.d.ts +11 -0
- package/dist/esm/packages/teams-js/dts/internal/validOrigins.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +31 -0
- package/dist/esm/packages/teams-js/dts/internal/videoFrameTick.d.ts +10 -0
- package/dist/esm/packages/teams-js/dts/internal/videoPerformanceMonitor.d.ts +54 -0
- package/dist/esm/packages/teams-js/dts/internal/videoPerformanceStatistics.d.ts +49 -0
- package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +89 -0
- package/dist/esm/packages/teams-js/dts/private/constants.d.ts +9 -0
- package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +152 -0
- package/dist/esm/packages/teams-js/dts/private/copilot.d.ts +39 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +378 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +75 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +112 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +49 -0
- package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +123 -0
- package/dist/esm/packages/teams-js/dts/private/files.d.ts +758 -0
- package/dist/esm/packages/teams-js/dts/private/hostEntity.d.ts +176 -0
- package/dist/esm/packages/teams-js/dts/private/index.d.ts +20 -0
- package/dist/esm/packages/teams-js/dts/private/interfaces.d.ts +250 -0
- package/dist/esm/packages/teams-js/dts/private/logs.d.ts +25 -0
- package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +203 -0
- package/dist/esm/packages/teams-js/dts/private/messageChannels.d.ts +107 -0
- package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +26 -0
- package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +81 -0
- package/dist/esm/packages/teams-js/dts/private/privateAPIs.d.ts +60 -0
- package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +298 -0
- package/dist/esm/packages/teams-js/dts/private/teams.d.ts +116 -0
- package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +244 -0
- package/dist/esm/packages/teams-js/dts/public/adaptiveCards.d.ts +6 -0
- package/dist/esm/packages/teams-js/dts/public/app.d.ts +592 -0
- package/dist/esm/packages/teams-js/dts/public/appId.d.ts +33 -0
- package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +57 -0
- package/dist/esm/packages/teams-js/dts/public/appInstallDialog.d.ts +18 -0
- package/dist/esm/packages/teams-js/dts/public/appWindow.d.ts +66 -0
- package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +409 -0
- package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +53 -0
- package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +40 -0
- package/dist/esm/packages/teams-js/dts/public/call.d.ts +53 -0
- package/dist/esm/packages/teams-js/dts/public/chat.d.ts +66 -0
- package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +34 -0
- package/dist/esm/packages/teams-js/dts/public/constants.d.ts +179 -0
- package/dist/esm/packages/teams-js/dts/public/dialog.d.ts +286 -0
- package/dist/esm/packages/teams-js/dts/public/emailAddress.d.ts +12 -0
- package/dist/esm/packages/teams-js/dts/public/geoLocation.d.ts +100 -0
- package/dist/esm/packages/teams-js/dts/public/index.d.ts +44 -0
- package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +1133 -0
- package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +221 -0
- package/dist/esm/packages/teams-js/dts/public/location.d.ts +86 -0
- package/dist/esm/packages/teams-js/dts/public/mail.d.ts +95 -0
- package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +321 -0
- package/dist/esm/packages/teams-js/dts/public/media.d.ts +440 -0
- package/dist/esm/packages/teams-js/dts/public/meeting.d.ts +906 -0
- package/dist/esm/packages/teams-js/dts/public/menus.d.ts +188 -0
- package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +58 -0
- package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +45 -0
- package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +15 -0
- package/dist/esm/packages/teams-js/dts/public/pages.d.ts +574 -0
- package/dist/esm/packages/teams-js/dts/public/people.d.ts +75 -0
- package/dist/esm/packages/teams-js/dts/public/profile.d.ts +127 -0
- package/dist/esm/packages/teams-js/dts/public/publicAPIs.d.ts +218 -0
- package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +207 -0
- package/dist/esm/packages/teams-js/dts/public/search.d.ts +91 -0
- package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +32 -0
- package/dist/esm/packages/teams-js/dts/public/serializable.interface.d.ts +17 -0
- package/dist/esm/packages/teams-js/dts/public/settings.d.ts +101 -0
- package/dist/esm/packages/teams-js/dts/public/sharing.d.ts +124 -0
- package/dist/esm/packages/teams-js/dts/public/stageView.d.ts +104 -0
- package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +62 -0
- package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +77 -0
- package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +119 -0
- package/dist/esm/packages/teams-js/dts/public/version.d.ts +5 -0
- package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +213 -0
- package/dist/esm/packages/teams-js/dts/public/visualMedia.d.ts +192 -0
- package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +27 -0
- package/dist/esm/packages/teams-js/src/index.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -0
- package/dist/esm/packages/teams-js/src/internal/communication.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/deepLinkUtilities.js +1 -1
- package/dist/esm/packages/teams-js/src/internal/responseHandler.js +1 -0
- package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
- package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -1
- package/dist/esm/packages/teams-js/src/private/hostEntity.js +1 -1
- package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -1
- package/dist/esm/packages/teams-js/src/public/app.js +1 -1
- package/dist/esm/packages/teams-js/src/public/appId.js +1 -1
- package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
- package/dist/esm/packages/teams-js/src/public/appInstallDialog.js +1 -1
- package/dist/esm/packages/teams-js/src/public/authentication.js +1 -1
- package/dist/esm/packages/teams-js/src/public/barCode.js +1 -1
- package/dist/esm/packages/teams-js/src/public/calendar.js +1 -1
- package/dist/esm/packages/teams-js/src/public/call.js +1 -1
- package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
- package/dist/esm/packages/teams-js/src/public/constants.js +1 -1
- package/dist/esm/packages/teams-js/src/public/pages.js +1 -1
- package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
- package/dist/esm/packages/teams-js/src/public/serializable.interface.js +1 -0
- package/dist/esm/packages/teams-js/src/public/settings.js +1 -1
- package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
- package/dist/esm/packages/teams-js/src/public/version.js +1 -1
- package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
- package/dist/umd/MicrosoftTeams.d.ts +10740 -10768
- package/dist/umd/MicrosoftTeams.js +1571 -1359
- package/dist/umd/MicrosoftTeams.js.map +1 -1
- package/dist/umd/MicrosoftTeams.min.js +1 -1
- package/dist/umd/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -51
- package/dist/esm/node_modules/.pnpm/supports-color@8.1.1/node_modules/supports-color/browser.js +0 -1
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import*as o from"./_polyfill-node.os.js";import{getAugmentedNamespace as r}from"./_commonjsHelpers.js";var s=r(o);export{s as default};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import n from"./_polyfill-node.global.js";var r;function t(){if(void 0===r){var n=new ArrayBuffer(2),t=new Uint8Array(n),e=new Uint16Array(n);if(t[0]=1,t[1]=2,258===e[0])r="BE";else{if(513!==e[0])throw new Error("unable to figure out endianess");r="LE"}}return r}function e(){return void 0!==n.location?n.location.hostname:""}function o(){return[]}function u(){return 0}function i(){return Number.MAX_VALUE}function a(){return Number.MAX_VALUE}function f(){return[]}function c(){return"Browser"}function s(){return void 0!==n.navigator?n.navigator.appVersion:""}function m(){return{}}function l(){return{}}function p(){return"javascript"}function v(){return"browser"}function d(){return"/tmp"}var w=d,A="\n";function E(){return"$HOME"}var g={homedir:E,EOL:"\n",arch:p,platform:v,tmpdir:w,tmpDir:d,networkInterfaces:m,getNetworkInterfaces:l,release:s,type:c,cpus:f,totalmem:a,freemem:i,uptime:u,loadavg:o,hostname:e,endianness:t};export{A as EOL,p as arch,f as cpus,g as default,t as endianness,i as freemem,l as getNetworkInterfaces,E as homedir,e as hostname,o as loadavg,m as networkInterfaces,v as platform,s as release,d as tmpDir,w as tmpdir,a as totalmem,c as type,u as uptime};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{__module as t}from"../../../../../../_virtual/node.js";import e from"../../../../../../_virtual/__polyfill-node.tty.js";import s from"../../../../../../_virtual/__polyfill-node.util.js";import{__require as o}from"../../../../supports-color@
|
|
1
|
+
import{__module as t}from"../../../../../../_virtual/node.js";import e from"../../../../../../_virtual/__polyfill-node.tty.js";import s from"../../../../../../_virtual/__polyfill-node.util.js";import{__require as o}from"../../../../supports-color@7.2.0/node_modules/supports-color/index.js";import{__require as r}from"./common.js";var n;function i(){return n||(n=1,function(t,n){const i=e,p=s;n.init=function(t){t.inspectOpts={};const e=Object.keys(n.inspectOpts);for(let s=0;s<e.length;s++)t.inspectOpts[e[s]]=n.inspectOpts[e[s]]},n.log=function(...t){return process.stderr.write(p.formatWithOptions(n.inspectOpts,...t)+"\n")},n.formatArgs=function(e){const{namespace:s,useColors:o}=this;if(o){const o=this.color,r="[3"+(o<8?o:"8;5;"+o),n=` ${r};1m${s} [0m`;e[0]=n+e[0].split("\n").join("\n"+n),e.push(r+"m+"+t.exports.humanize(this.diff)+"[0m")}else e[0]=function(){if(n.inspectOpts.hideDate)return"";return(new Date).toISOString()+" "}()+s+" "+e[0]},n.save=function(t){t?process.env.DEBUG=t:delete process.env.DEBUG},n.load=function(){return process.env.DEBUG},n.useColors=function(){return"colors"in n.inspectOpts?Boolean(n.inspectOpts.colors):i.isatty(process.stderr.fd)},n.destroy=p.deprecate((()=>{}),"Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`."),n.colors=[6,2,3,4,5,1];try{const t=o();t&&(t.stderr||t).level>=2&&(n.colors=[20,21,26,27,32,33,38,39,40,41,42,43,44,45,56,57,62,63,68,69,74,75,76,77,78,79,80,81,92,93,98,99,112,113,128,129,134,135,148,149,160,161,162,163,164,165,166,167,168,169,170,171,172,173,178,179,184,185,196,197,198,199,200,201,202,203,204,205,206,207,208,209,214,215,220,221])}catch(t){}n.inspectOpts=Object.keys(process.env).filter((t=>/^debug_/i.test(t))).reduce(((t,e)=>{const s=e.substring(6).toLowerCase().replace(/_([a-z])/g,((t,e)=>e.toUpperCase()));let o=process.env[e];return o=!!/^(yes|on|true|enabled)$/i.test(o)||!/^(no|off|false|disabled)$/i.test(o)&&("null"===o?null:Number(o)),t[s]=o,t}),{}),t.exports=r()(n);const{formatters:c}=t.exports;c.o=function(t){return this.inspectOpts.colors=this.useColors,p.inspect(t,this.inspectOpts).split("\n").map((t=>t.trim())).join(" ")},c.O=function(t){return this.inspectOpts.colors=this.useColors,p.inspect(t,this.inspectOpts)}}(t,t.exports)),t.exports}export{i as __require};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
var r,e;function t(){return e?r:(e=1,r=(r,e=process.argv)=>{const t=r.startsWith("-")?"":1===r.length?"-":"--",n=e.indexOf(t+r),s=e.indexOf("--");return-1!==n&&(-1===s||n<s)})}export{t as __require};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
import r from"../../../../../_virtual/__polyfill-node.os.js";import o from"../../../../../_virtual/__polyfill-node.tty.js";import{__require as e}from"../../../has-flag@4.0.0/node_modules/has-flag/index.js";var t,n;function i(){if(n)return t;n=1;const i=r,s=o,l=e(),{env:u}=process;let c;function R(r){return 0!==r&&{level:r,hasBasic:!0,has256:r>=2,has16m:r>=3}}function a(r,o){if(0===c)return 0;if(l("color=16m")||l("color=full")||l("color=truecolor"))return 3;if(l("color=256"))return 2;if(r&&!o&&void 0===c)return 0;const e=c||0;if("dumb"===u.TERM)return e;if("win32"===process.platform){const r=i.release().split(".");return Number(r[0])>=10&&Number(r[2])>=10586?Number(r[2])>=14931?3:2:1}if("CI"in u)return["TRAVIS","CIRCLECI","APPVEYOR","GITLAB_CI","GITHUB_ACTIONS","BUILDKITE"].some((r=>r in u))||"codeship"===u.CI_NAME?1:e;if("TEAMCITY_VERSION"in u)return/^(9\.(0*[1-9]\d*)\.|\d{2,}\.)/.test(u.TEAMCITY_VERSION)?1:0;if("truecolor"===u.COLORTERM)return 3;if("TERM_PROGRAM"in u){const r=parseInt((u.TERM_PROGRAM_VERSION||"").split(".")[0],10);switch(u.TERM_PROGRAM){case"iTerm.app":return r>=3?3:2;case"Apple_Terminal":return 2}}return/-256(color)?$/i.test(u.TERM)?2:/^screen|^xterm|^vt100|^vt220|^rxvt|color|ansi|cygwin|linux/i.test(u.TERM)||"COLORTERM"in u?1:e}return l("no-color")||l("no-colors")||l("color=false")||l("color=never")?c=0:(l("color")||l("colors")||l("color=true")||l("color=always"))&&(c=1),"FORCE_COLOR"in u&&(c="true"===u.FORCE_COLOR?1:"false"===u.FORCE_COLOR?0:0===u.FORCE_COLOR.length?1:Math.min(parseInt(u.FORCE_COLOR,10),3)),t={supportsColor:function(r){return R(a(r,r&&r.isTTY))},stdout:R(a(!0,s.isatty(1))),stderr:R(a(!0,s.isatty(2)))}}export{i as __require};
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @beta
|
|
3
|
+
* @hidden
|
|
4
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
5
|
+
*/
|
|
6
|
+
export type VideoPixelFormat = 'BGRA' | 'BGRX' | 'I420' | 'I420A' | 'I422' | 'I444' | 'NV12' | 'RGBA' | 'RGBX';
|
|
7
|
+
/**
|
|
8
|
+
* @beta
|
|
9
|
+
* @hidden
|
|
10
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
11
|
+
*/
|
|
12
|
+
export type AllowSharedBufferSource = ArrayBuffer | ArrayBufferView;
|
|
13
|
+
/**
|
|
14
|
+
* @beta
|
|
15
|
+
* @hidden
|
|
16
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
17
|
+
*/
|
|
18
|
+
export type AlphaOption = 'discard' | 'keep';
|
|
19
|
+
/**
|
|
20
|
+
* @beta
|
|
21
|
+
* @hidden
|
|
22
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
23
|
+
*/
|
|
24
|
+
export interface PlaneLayout {
|
|
25
|
+
/**
|
|
26
|
+
* The offset in bytes where the given plane begins within a BufferSource.
|
|
27
|
+
*/
|
|
28
|
+
offset: number;
|
|
29
|
+
/**
|
|
30
|
+
* The number of bytes, including padding, used by each row of the plane within a BufferSource.
|
|
31
|
+
*/
|
|
32
|
+
stride: number;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* @beta
|
|
36
|
+
* @hidden
|
|
37
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
38
|
+
*/
|
|
39
|
+
export interface VideoFrameCopyToOptions {
|
|
40
|
+
/**
|
|
41
|
+
* The PlaneLayout for each plane in VideoFrame
|
|
42
|
+
*/
|
|
43
|
+
layout?: PlaneLayout[] | undefined;
|
|
44
|
+
/**
|
|
45
|
+
* A DOMRectInit describing the rectangle of pixels to copy from the VideoFrame
|
|
46
|
+
*/
|
|
47
|
+
rect?: DOMRectInit | undefined;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* @beta
|
|
51
|
+
* @hidden
|
|
52
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
53
|
+
*/
|
|
54
|
+
export interface VideoFrameInit {
|
|
55
|
+
alpha?: AlphaOption | undefined;
|
|
56
|
+
displayHeight?: number | undefined;
|
|
57
|
+
displayWidth?: number | undefined;
|
|
58
|
+
duration?: number | undefined;
|
|
59
|
+
timestamp?: number | undefined;
|
|
60
|
+
visibleRect?: DOMRectInit | undefined;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* @beta
|
|
64
|
+
* @hidden
|
|
65
|
+
* Align with the W3C spec: https://www.w3.org/TR/webcodecs/
|
|
66
|
+
*/
|
|
67
|
+
export interface VideoFrameBufferInit {
|
|
68
|
+
codedHeight: number;
|
|
69
|
+
codedWidth: number;
|
|
70
|
+
colorSpace?: VideoColorSpaceInit | undefined;
|
|
71
|
+
displayHeight?: number | undefined;
|
|
72
|
+
displayWidth?: number | undefined;
|
|
73
|
+
duration?: number | undefined;
|
|
74
|
+
format: VideoPixelFormat;
|
|
75
|
+
layout?: PlaneLayout[] | undefined;
|
|
76
|
+
timestamp: number;
|
|
77
|
+
visibleRect?: DOMRectInit | undefined;
|
|
78
|
+
}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import * as app from '../public/app';
|
|
2
|
+
export declare function appInitializeHelper(apiVersionTag: string, validMessageOrigins?: string[]): Promise<void>;
|
|
3
|
+
export declare function notifyAppLoadedHelper(apiVersionTag: string): void;
|
|
4
|
+
export declare function notifyExpectedFailureHelper(apiVersionTag: string, expectedFailureRequest: app.IExpectedFailureRequest): void;
|
|
5
|
+
export declare function notifyFailureHelper(apiVersiontag: string, appInitializationFailedRequest: app.IFailedRequest): void;
|
|
6
|
+
export declare function notifySuccessHelper(apiVersionTag: string): void;
|
|
7
|
+
export declare function registerOnThemeChangeHandlerHelper(apiVersionTag: string, handler: app.themeHandler): void;
|
|
8
|
+
export declare function openLinkHelper(apiVersionTag: string, deepLink: string): Promise<void>;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This function can be used to validate if a string is a "valid" app id.
|
|
3
|
+
* Valid is a relative term, in this case. Truly valid app ids are UUIDs as documented in the schema:
|
|
4
|
+
* https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema#id
|
|
5
|
+
* However, there are some older internal/hard-coded apps which violate this schema and use names like com.microsoft.teamspace.tab.youtube.
|
|
6
|
+
* For compatibility with these legacy apps, we unfortunately cannot securely and completely validate app ids as UUIDs. Based
|
|
7
|
+
* on this, the validation is limited to checking for script tags, length, and non-printable characters.
|
|
8
|
+
*
|
|
9
|
+
* @param potentialAppId A string to check if it's a "valid" app id
|
|
10
|
+
* @throws Error with a message describing the exact validation violation
|
|
11
|
+
*/
|
|
12
|
+
export declare function validateStringAsAppId(potentialAppId: string): void;
|
|
13
|
+
export declare const minimumValidAppIdLength = 4;
|
|
14
|
+
export declare const maximumValidAppIdLength = 256;
|
|
15
|
+
export declare function isStringWithinAppIdLengthLimits(potentialAppId: string): boolean;
|
|
16
|
+
export declare function doesStringContainNonPrintableCharacters(str: string): boolean;
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
import { FrameContexts } from '../public/constants';
|
|
2
|
+
import { ISerializable } from '../public/serializable.interface';
|
|
3
|
+
import { NestedAppAuthRequest } from './nestedAppAuthUtils';
|
|
4
|
+
import { ResponseHandler, SimpleType } from './responseHandler';
|
|
5
|
+
/**
|
|
6
|
+
* @internal
|
|
7
|
+
* Limited to Microsoft-internal use
|
|
8
|
+
*/
|
|
9
|
+
export declare class Communication {
|
|
10
|
+
static currentWindow: Window | any;
|
|
11
|
+
static parentOrigin: string | null;
|
|
12
|
+
static parentWindow: Window | any;
|
|
13
|
+
static childWindow: Window | null;
|
|
14
|
+
static childOrigin: string | null;
|
|
15
|
+
static topWindow: Window | any;
|
|
16
|
+
static topOrigin: string | null;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
* Limited to Microsoft-internal use
|
|
21
|
+
*/
|
|
22
|
+
interface InitializeResponse {
|
|
23
|
+
context: FrameContexts;
|
|
24
|
+
clientType: string;
|
|
25
|
+
runtimeConfig: string;
|
|
26
|
+
clientSupportedSDKVersion: string;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* @internal
|
|
30
|
+
* Limited to Microsoft-internal use
|
|
31
|
+
*/
|
|
32
|
+
export declare function initializeCommunication(validMessageOrigins: string[] | undefined, apiVersionTag: string): Promise<InitializeResponse>;
|
|
33
|
+
/**
|
|
34
|
+
* @internal
|
|
35
|
+
* Limited to Microsoft-internal use
|
|
36
|
+
*/
|
|
37
|
+
export declare function uninitializeCommunication(): void;
|
|
38
|
+
/**
|
|
39
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
40
|
+
* @hidden
|
|
41
|
+
* Send a message to parent and then unwrap result. Uses nativeInterface on mobile to communicate with parent context
|
|
42
|
+
* Additional apiVersionTag parameter is added, which provides the ability to send api version number to parent
|
|
43
|
+
* for telemetry work.
|
|
44
|
+
*
|
|
45
|
+
* @internal
|
|
46
|
+
* Limited to Microsoft-internal use
|
|
47
|
+
*/
|
|
48
|
+
export declare function sendAndUnwrap<T>(apiVersionTag: string, actionName: string, ...args: any[]): Promise<T>;
|
|
49
|
+
/**
|
|
50
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
51
|
+
* @hidden
|
|
52
|
+
* Send a message to parent and then handle status and reason. Uses nativeInterface on mobile to communicate with parent context
|
|
53
|
+
* Additional apiVersionTag parameter is added, which provides the ability to send api version number to parent
|
|
54
|
+
* for telemetry work.
|
|
55
|
+
*/
|
|
56
|
+
export declare function sendAndHandleStatusAndReason(apiVersionTag: string, actionName: string, ...args: any[]): Promise<void>;
|
|
57
|
+
/**
|
|
58
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
59
|
+
* @hidden
|
|
60
|
+
* Send a message to parent and then handle status and reason with default error. Uses nativeInterface on mobile to communicate with parent context
|
|
61
|
+
* Additional apiVersionTag parameter is added, which provides the ability to send api version number to parent
|
|
62
|
+
* for telemetry work.
|
|
63
|
+
*
|
|
64
|
+
* @internal
|
|
65
|
+
* Limited to Microsoft-internal use
|
|
66
|
+
*/
|
|
67
|
+
export declare function sendAndHandleStatusAndReasonWithDefaultError(apiVersionTag: string, actionName: string, defaultError: string, ...args: any[]): Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
70
|
+
* @hidden
|
|
71
|
+
* Send a message to parent and then handle SDK error. Uses nativeInterface on mobile to communicate with parent context
|
|
72
|
+
* Additional apiVersionTag parameter is added, which provides the ability to send api version number to parent
|
|
73
|
+
* for telemetry work.
|
|
74
|
+
*
|
|
75
|
+
* @internal
|
|
76
|
+
* Limited to Microsoft-internal use
|
|
77
|
+
*/
|
|
78
|
+
export declare function sendAndHandleSdkError<T>(apiVersionTag: string, actionName: string, ...args: any[]): Promise<T>;
|
|
79
|
+
/**
|
|
80
|
+
* @deprecated This function will no longer be exported in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
81
|
+
* @hidden
|
|
82
|
+
* Send a message to parent asynchronously. Uses nativeInterface on mobile to communicate with parent context
|
|
83
|
+
* Additional apiVersionTag parameter is added, which provides the ability to send api version number to parent
|
|
84
|
+
* for telemetry work.
|
|
85
|
+
*
|
|
86
|
+
* @internal
|
|
87
|
+
* Limited to Microsoft-internal use
|
|
88
|
+
*/
|
|
89
|
+
export declare function sendMessageToParentAsync<T>(apiVersionTag: string, actionName: string, args?: any[] | undefined): Promise<T>;
|
|
90
|
+
/**
|
|
91
|
+
* Call a function in the host and receive a response. If the host returns an {@link SdkError} instead of a normal response, this function will throw a new Error containing the SdkError's information
|
|
92
|
+
*
|
|
93
|
+
* @param functionName The function name to call in the host.
|
|
94
|
+
* @param args A collection of data to pass to the host. This data must be an array of either simple types or objects that implement {@link ISerializable}.
|
|
95
|
+
* @param responseHandler When the host responds, this handler will validate and deserialize the response.
|
|
96
|
+
* @param apiVersionTag A unique tag used to identify the API version for telemetry purposes. This should be set using {@link getApiVersionTag}, which should be passed a unique string identifying the function being called by the app developer as well as a version number that is incremented whenever meaningful changes are made to that function.
|
|
97
|
+
* @param isResponseAReportableError This optional property can be used to override the default ErrorChecking this function uses to decide whether to throw the host response as a new Error. Specify this if your function needs to do any logic verifying that the object received is an error that goes beyond the logic found in {@link isSdkError}.
|
|
98
|
+
*
|
|
99
|
+
* @returns The response received from the host after deserialization.
|
|
100
|
+
*
|
|
101
|
+
* @throws An Error containing the SdkError information ({@link SdkError.errorCode} and {@link SdkError.message}) if the host returns an SdkError, or an Error if the response from the host is an unexpected format.
|
|
102
|
+
*/
|
|
103
|
+
export declare function callFunctionInHostAndHandleResponse<SerializedReturnValueFromHost, DeserializedReturnValueFromHost>(functionName: string, args: (SimpleType | ISerializable)[], responseHandler: ResponseHandler<SerializedReturnValueFromHost, DeserializedReturnValueFromHost>, apiVersionTag: string, isResponseAReportableError?: (response: unknown) => response is {
|
|
104
|
+
errorCode: number | string;
|
|
105
|
+
message?: string;
|
|
106
|
+
}): Promise<DeserializedReturnValueFromHost>;
|
|
107
|
+
/**
|
|
108
|
+
* Call a function in the host that receives either an {@link SdkError} or undefined as a response. If the host returns an {@link SdkError} this function will throw a new Error containing the SdkError's information.
|
|
109
|
+
*
|
|
110
|
+
* @param functionName The function name to call in the host.
|
|
111
|
+
* @param args A collection of data to pass to the host. This data must be an array of either simple types or objects that implement {@link ISerializable}.
|
|
112
|
+
* @param apiVersionTag A unique tag used to identify the API version for telemetry purposes. This should be set using {@link getApiVersionTag}, which should be passed a unique string identifying the function being called by the app developer as well as a version number that is incremented whenever meaningful changes are made to that function.
|
|
113
|
+
* @param isResponseAReportableError This optional property can be used to override the default ErrorChecking this function uses to decide whether to throw the host response as a new Error. Specify this is your function needs to do any logic verifying that the object received is an error that goes beyond the logic found in {@link isSdkError}.
|
|
114
|
+
*
|
|
115
|
+
* @throws An Error containing the SdkError information ({@link SdkError.errorCode} and {@link SdkError.message}) if the host returns an SdkError, or an Error if the response from the host is an unexpected format.
|
|
116
|
+
*/
|
|
117
|
+
export declare function callFunctionInHost(functionName: string, args: (SimpleType | ISerializable)[], apiVersionTag: string, isResponseAReportableError?: (response: unknown) => response is {
|
|
118
|
+
errorCode: number | string;
|
|
119
|
+
message?: string;
|
|
120
|
+
}): Promise<void>;
|
|
121
|
+
/**
|
|
122
|
+
* @hidden
|
|
123
|
+
* Send a message to parent requesting a MessageChannel Port.
|
|
124
|
+
* @internal
|
|
125
|
+
* Limited to Microsoft-internal use
|
|
126
|
+
*/
|
|
127
|
+
export declare function requestPortFromParentWithVersion(apiVersionTag: string, actionName: string, args?: any[] | undefined): Promise<MessagePort>;
|
|
128
|
+
/**
|
|
129
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
130
|
+
* @internal
|
|
131
|
+
* Limited to Microsoft-internal use
|
|
132
|
+
*/
|
|
133
|
+
export declare function sendMessageToParent(apiVersionTag: string, actionName: string, callback?: Function): void;
|
|
134
|
+
/**
|
|
135
|
+
* @deprecated This function is deprecated and will be removed in a future release. Please use {@link callFunctionInHostAndHandleResponse} or {@link callFunctionInHost} instead.
|
|
136
|
+
* @hidden
|
|
137
|
+
* Send a message to parent. Uses nativeInterface on mobile to communicate with parent context
|
|
138
|
+
*
|
|
139
|
+
* @internal
|
|
140
|
+
* Limited to Microsoft-internal use
|
|
141
|
+
*/
|
|
142
|
+
export declare function sendMessageToParent(apiVersionTag: string, actionName: string, args: any[] | undefined, callback?: Function): void;
|
|
143
|
+
/**
|
|
144
|
+
* @internal
|
|
145
|
+
* Limited to Microsoft-internal use
|
|
146
|
+
*/
|
|
147
|
+
export declare function sendNestedAuthRequestToTopWindow(message: string): NestedAppAuthRequest;
|
|
148
|
+
/**
|
|
149
|
+
* @internal
|
|
150
|
+
* Limited to Microsoft-internal use
|
|
151
|
+
*/
|
|
152
|
+
export declare function waitForMessageQueue(targetWindow: Window, callback: () => void): void;
|
|
153
|
+
/**
|
|
154
|
+
* @hidden
|
|
155
|
+
* Send a custom message object that can be sent to child window,
|
|
156
|
+
* instead of a response message to a child
|
|
157
|
+
*
|
|
158
|
+
* @internal
|
|
159
|
+
* Limited to Microsoft-internal use
|
|
160
|
+
*/
|
|
161
|
+
export declare function sendMessageEventToChild(actionName: string, args?: any[]): void;
|
|
162
|
+
export {};
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
* The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
|
|
4
|
+
* Modified to 2.0.1 which is hightest till now so that if any client doesn't pass version in initialize function, it will be set to highest.
|
|
5
|
+
* Mobile clients are passing versions, hence will be applicable to web and desktop clients only.
|
|
6
|
+
*
|
|
7
|
+
* @internal
|
|
8
|
+
* Limited to Microsoft-internal use
|
|
9
|
+
*/
|
|
10
|
+
export declare const defaultSDKVersionForCompatCheck = "2.0.1";
|
|
11
|
+
/**
|
|
12
|
+
* @hidden
|
|
13
|
+
* This is the client version when selectMedia API - VideoAndImage is supported on mobile.
|
|
14
|
+
*
|
|
15
|
+
* @internal
|
|
16
|
+
* Limited to Microsoft-internal use
|
|
17
|
+
*/
|
|
18
|
+
export declare const videoAndImageMediaAPISupportVersion = "2.0.2";
|
|
19
|
+
/**
|
|
20
|
+
* @hidden
|
|
21
|
+
* This is the client version when selectMedia API - Video with non-full screen mode is supported on mobile.
|
|
22
|
+
*
|
|
23
|
+
* @internal
|
|
24
|
+
* Limited to Microsoft-internal use
|
|
25
|
+
*/
|
|
26
|
+
export declare const nonFullScreenVideoModeAPISupportVersion = "2.0.3";
|
|
27
|
+
/**
|
|
28
|
+
* @hidden
|
|
29
|
+
* This is the client version when selectMedia API - ImageOutputFormats is supported on mobile.
|
|
30
|
+
*
|
|
31
|
+
* @internal
|
|
32
|
+
* Limited to Microsoft-internal use
|
|
33
|
+
*/
|
|
34
|
+
export declare const imageOutputFormatsAPISupportVersion = "2.0.4";
|
|
35
|
+
/**
|
|
36
|
+
* @hidden
|
|
37
|
+
* Minimum required client supported version for {@link getUserJoinedTeams} to be supported on {@link HostClientType.android}
|
|
38
|
+
*
|
|
39
|
+
* @internal
|
|
40
|
+
* Limited to Microsoft-internal use
|
|
41
|
+
*/
|
|
42
|
+
export declare const getUserJoinedTeamsSupportedAndroidClientVersion = "2.0.1";
|
|
43
|
+
/**
|
|
44
|
+
* @hidden
|
|
45
|
+
* This is the client version when location APIs (getLocation and showLocation) are supported.
|
|
46
|
+
*
|
|
47
|
+
* @internal
|
|
48
|
+
* Limited to Microsoft-internal use
|
|
49
|
+
*/
|
|
50
|
+
export declare const locationAPIsRequiredVersion = "1.9.0";
|
|
51
|
+
/**
|
|
52
|
+
* @hidden
|
|
53
|
+
* This is the client version when permisisons are supported
|
|
54
|
+
*
|
|
55
|
+
* @internal
|
|
56
|
+
* Limited to Microsoft-internal use
|
|
57
|
+
*/
|
|
58
|
+
export declare const permissionsAPIsRequiredVersion = "2.0.1";
|
|
59
|
+
/**
|
|
60
|
+
* @hidden
|
|
61
|
+
* This is the client version when people picker API is supported on mobile.
|
|
62
|
+
*
|
|
63
|
+
* @internal
|
|
64
|
+
* Limited to Microsoft-internal use
|
|
65
|
+
*/
|
|
66
|
+
export declare const peoplePickerRequiredVersion = "2.0.0";
|
|
67
|
+
/**
|
|
68
|
+
* @hidden
|
|
69
|
+
* This is the client version when captureImage API is supported on mobile.
|
|
70
|
+
*
|
|
71
|
+
* @internal
|
|
72
|
+
* Limited to Microsoft-internal use
|
|
73
|
+
*/
|
|
74
|
+
export declare const captureImageMobileSupportVersion = "1.7.0";
|
|
75
|
+
/**
|
|
76
|
+
* @hidden
|
|
77
|
+
* This is the client version when media APIs are supported on all three platforms ios, android and web.
|
|
78
|
+
*
|
|
79
|
+
* @internal
|
|
80
|
+
* Limited to Microsoft-internal use
|
|
81
|
+
*/
|
|
82
|
+
export declare const mediaAPISupportVersion = "1.8.0";
|
|
83
|
+
/**
|
|
84
|
+
* @hidden
|
|
85
|
+
* This is the client version when getMedia API is supported via Callbacks on all three platforms ios, android and web.
|
|
86
|
+
*
|
|
87
|
+
* @internal
|
|
88
|
+
* Limited to Microsoft-internal use
|
|
89
|
+
*/
|
|
90
|
+
export declare const getMediaCallbackSupportVersion = "2.0.0";
|
|
91
|
+
/**
|
|
92
|
+
* @hidden
|
|
93
|
+
* This is the client version when scanBarCode API is supported on mobile.
|
|
94
|
+
*
|
|
95
|
+
* @internal
|
|
96
|
+
* Limited to Microsoft-internal use
|
|
97
|
+
*/
|
|
98
|
+
export declare const scanBarCodeAPIMobileSupportVersion = "1.9.0";
|
|
99
|
+
/**
|
|
100
|
+
* @hidden
|
|
101
|
+
* Fallback list of valid origins
|
|
102
|
+
*
|
|
103
|
+
* @internal
|
|
104
|
+
* Limited to Microsoft-internal use
|
|
105
|
+
*/
|
|
106
|
+
export declare const validOriginsFallback: string[];
|
|
107
|
+
/**
|
|
108
|
+
* @hidden
|
|
109
|
+
* CDN endpoint of the list of valid origins
|
|
110
|
+
*
|
|
111
|
+
* @internal
|
|
112
|
+
* Limited to Microsoft-internal use
|
|
113
|
+
*/
|
|
114
|
+
export declare const validOriginsCdnEndpoint: URL;
|
|
115
|
+
/**
|
|
116
|
+
* @hidden
|
|
117
|
+
* USer specified message origins should satisfy this test
|
|
118
|
+
*
|
|
119
|
+
* @internal
|
|
120
|
+
* Limited to Microsoft-internal use
|
|
121
|
+
*/
|
|
122
|
+
export declare const userOriginUrlValidationRegExp: RegExp;
|
|
123
|
+
/**
|
|
124
|
+
* @hidden
|
|
125
|
+
* The protocol used for deep links into Teams
|
|
126
|
+
*
|
|
127
|
+
* @internal
|
|
128
|
+
* Limited to Microsoft-internal use
|
|
129
|
+
*/
|
|
130
|
+
export declare const teamsDeepLinkProtocol = "https";
|
|
131
|
+
/**
|
|
132
|
+
* @hidden
|
|
133
|
+
* The host used for deep links into Teams
|
|
134
|
+
*
|
|
135
|
+
* @internal
|
|
136
|
+
* Limited to Microsoft-internal use
|
|
137
|
+
*/
|
|
138
|
+
export declare const teamsDeepLinkHost = "teams.microsoft.com";
|
|
139
|
+
/** @hidden */
|
|
140
|
+
export declare const errorLibraryNotInitialized = "The library has not yet been initialized";
|
|
141
|
+
/** @hidden */
|
|
142
|
+
export declare const errorRuntimeNotInitialized = "The runtime has not yet been initialized";
|
|
143
|
+
/** @hidden */
|
|
144
|
+
export declare const errorRuntimeNotSupported = "The runtime version is not supported";
|
|
145
|
+
/** @hidden */
|
|
146
|
+
export declare const errorCallNotStarted = "The call was not properly started";
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* App install dialog constants
|
|
3
|
+
*/
|
|
4
|
+
export declare const teamsDeepLinkUrlPathForAppInstall = "/l/app/";
|
|
5
|
+
/**
|
|
6
|
+
* Calendar constants
|
|
7
|
+
*/
|
|
8
|
+
export declare const teamsDeepLinkUrlPathForCalendar = "/l/meeting/new";
|
|
9
|
+
export declare const teamsDeepLinkAttendeesUrlParameterName = "attendees";
|
|
10
|
+
export declare const teamsDeepLinkStartTimeUrlParameterName = "startTime";
|
|
11
|
+
export declare const teamsDeepLinkEndTimeUrlParameterName = "endTime";
|
|
12
|
+
export declare const teamsDeepLinkSubjectUrlParameterName = "subject";
|
|
13
|
+
export declare const teamsDeepLinkContentUrlParameterName = "content";
|
|
14
|
+
/**
|
|
15
|
+
* Call constants
|
|
16
|
+
*/
|
|
17
|
+
export declare const teamsDeepLinkUrlPathForCall = "/l/call/0/0";
|
|
18
|
+
export declare const teamsDeepLinkSourceUrlParameterName = "source";
|
|
19
|
+
export declare const teamsDeepLinkWithVideoUrlParameterName = "withVideo";
|
|
20
|
+
/**
|
|
21
|
+
* Chat constants
|
|
22
|
+
*/
|
|
23
|
+
export declare const teamsDeepLinkUrlPathForChat = "/l/chat/0/0";
|
|
24
|
+
export declare const teamsDeepLinkUsersUrlParameterName = "users";
|
|
25
|
+
export declare const teamsDeepLinkTopicUrlParameterName = "topicName";
|
|
26
|
+
export declare const teamsDeepLinkMessageUrlParameterName = "message";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare function createTeamsDeepLinkForChat(users: string[], topic?: string, message?: string): string;
|
|
2
|
+
export declare function createTeamsDeepLinkForCall(targets: string[], withVideo?: boolean, source?: string): string;
|
|
3
|
+
export declare function createTeamsDeepLinkForCalendar(attendees?: string[], startTime?: string, endTime?: string, subject?: string, content?: string): string;
|
|
4
|
+
export declare function createTeamsDeepLinkForAppInstallDialog(appId: string): string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function validateEmailAddress(emailString: string | null | undefined): void;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { FrameContexts } from '../public/constants';
|
|
2
|
+
export declare class GlobalVars {
|
|
3
|
+
static initializeCalled: boolean;
|
|
4
|
+
static initializeCompleted: boolean;
|
|
5
|
+
static additionalValidOrigins: string[];
|
|
6
|
+
static initializePromise: Promise<void> | undefined;
|
|
7
|
+
static isFramelessWindow: boolean;
|
|
8
|
+
static frameContext: FrameContexts | undefined;
|
|
9
|
+
static hostClientType: string | undefined;
|
|
10
|
+
static clientSupportedSDKVersion: string;
|
|
11
|
+
static printCapabilityEnabled: boolean;
|
|
12
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { FrameContexts } from '../public/constants';
|
|
2
|
+
import { LoadContext, ResumeContext } from '../public/interfaces';
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
* Limited to Microsoft-internal use
|
|
6
|
+
*/
|
|
7
|
+
export declare function initializeHandlers(): void;
|
|
8
|
+
/**
|
|
9
|
+
* @internal
|
|
10
|
+
* Limited to Microsoft-internal use
|
|
11
|
+
*/
|
|
12
|
+
export declare function uninitializeHandlers(): void;
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
* Limited to Microsoft-internal use
|
|
16
|
+
*/
|
|
17
|
+
export declare function callHandler(name: string, args?: unknown[]): [true, unknown] | [false, undefined];
|
|
18
|
+
/**
|
|
19
|
+
* @internal
|
|
20
|
+
* Limited to Microsoft-internal use
|
|
21
|
+
*/
|
|
22
|
+
export declare function registerHandler(apiVersionTag: string, name: string, handler: Function, sendMessage?: boolean, args?: unknown[]): void;
|
|
23
|
+
/**
|
|
24
|
+
* @internal
|
|
25
|
+
* Limited to Microsoft-internal use
|
|
26
|
+
*/
|
|
27
|
+
export declare function removeHandler(name: string): void;
|
|
28
|
+
/**
|
|
29
|
+
* @internal
|
|
30
|
+
* Limited to Microsoft-internal use
|
|
31
|
+
*/
|
|
32
|
+
export declare function doesHandlerExist(name: string): boolean;
|
|
33
|
+
/**
|
|
34
|
+
* @hidden
|
|
35
|
+
* Undocumented helper function with shared code between deprecated version and current version of register*Handler APIs
|
|
36
|
+
*
|
|
37
|
+
* @internal
|
|
38
|
+
* Limited to Microsoft-internal use
|
|
39
|
+
*
|
|
40
|
+
* @param apiVersionTag - The tag of the api version and name
|
|
41
|
+
* @param name - The name of the handler to register.
|
|
42
|
+
* @param handler - The handler to invoke.
|
|
43
|
+
* @param contexts - The context within which it is valid to register this handler.
|
|
44
|
+
* @param registrationHelper - The helper function containing logic pertaining to a specific version of the API.
|
|
45
|
+
*/
|
|
46
|
+
export declare function registerHandlerHelper(apiVersionTag: string, name: string, handler: Function, contexts: FrameContexts[], registrationHelper?: () => void): void;
|
|
47
|
+
/**
|
|
48
|
+
* @internal
|
|
49
|
+
* Limited to Microsoft-internal use
|
|
50
|
+
*/
|
|
51
|
+
export declare function registerOnThemeChangeHandler(apiVersionTag: string, handler: (theme: string) => void): void;
|
|
52
|
+
/**
|
|
53
|
+
* @internal
|
|
54
|
+
* Limited to Microsoft-internal use
|
|
55
|
+
*/
|
|
56
|
+
export declare function handleThemeChange(theme: string): void;
|
|
57
|
+
/**
|
|
58
|
+
* @internal
|
|
59
|
+
* Limited to Microsoft-internal use
|
|
60
|
+
*
|
|
61
|
+
* @deprecated
|
|
62
|
+
*/
|
|
63
|
+
export declare function registerOnLoadHandler(apiVersionTag: string, handler: (context: LoadContext) => void): void;
|
|
64
|
+
/**
|
|
65
|
+
* @internal
|
|
66
|
+
* Limited to Microsoft-internal use
|
|
67
|
+
*
|
|
68
|
+
* @deprecated
|
|
69
|
+
*/
|
|
70
|
+
export declare function registerBeforeUnloadHandler(apiVersionTag: string, handler: (readyToUnload: () => void) => boolean): void;
|
|
71
|
+
/**
|
|
72
|
+
* @internal
|
|
73
|
+
* Limited to Microsoft-internal use
|
|
74
|
+
*/
|
|
75
|
+
export declare function registerBeforeSuspendOrTerminateHandler(handler: () => Promise<void>): void;
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
* Limited to Microsoft-internal use
|
|
79
|
+
*/
|
|
80
|
+
export declare function registerOnResumeHandler(handler: (context: ResumeContext) => void): void;
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @hidden
|
|
3
|
+
* Hide from docs
|
|
4
|
+
* Shim in definitions used for browser-compat
|
|
5
|
+
*
|
|
6
|
+
* @internal
|
|
7
|
+
* Limited to Microsoft-internal use
|
|
8
|
+
*/
|
|
9
|
+
export interface DOMMessageEvent {
|
|
10
|
+
origin?: any;
|
|
11
|
+
source?: any;
|
|
12
|
+
data?: any;
|
|
13
|
+
ports?: any;
|
|
14
|
+
originalEvent: DOMMessageEvent;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @hidden
|
|
18
|
+
* Hide from docs
|
|
19
|
+
*
|
|
20
|
+
* @internal
|
|
21
|
+
* Limited to Microsoft-internal use
|
|
22
|
+
*/
|
|
23
|
+
export interface TeamsNativeClient {
|
|
24
|
+
framelessPostMessage(msg: string): void;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* @hidden
|
|
28
|
+
* Hide from docs
|
|
29
|
+
*
|
|
30
|
+
* @internal
|
|
31
|
+
* Limited to Microsoft-internal use
|
|
32
|
+
*/
|
|
33
|
+
export interface ExtendedWindow extends Window {
|
|
34
|
+
nativeInterface: TeamsNativeClient;
|
|
35
|
+
onNativeMessage(evt: DOMMessageEvent): void;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @hidden
|
|
39
|
+
* Meant for Message objects that are sent to children without id
|
|
40
|
+
*
|
|
41
|
+
* @internal
|
|
42
|
+
* Limited to Microsoft-internal use
|
|
43
|
+
*/
|
|
44
|
+
export interface DOMMessageEvent {
|
|
45
|
+
func: string;
|
|
46
|
+
args?: any[];
|
|
47
|
+
}
|