@microsoft/teams-js 2.31.0-beta.1 → 2.31.0-beta.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (187) hide show
  1. package/dist/esm/_virtual/_polyfill-node.os.js +1 -1
  2. package/dist/esm/_virtual/_polyfill-node.process.js +1 -1
  3. package/dist/esm/_virtual/_polyfill-node.util.js +1 -1
  4. package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts +11 -1
  5. package/dist/esm/packages/teams-js/dts/internal/appIdValidation.d.ts +10 -0
  6. package/dist/esm/packages/teams-js/dts/internal/handlers.d.ts +11 -1
  7. package/dist/esm/packages/teams-js/dts/internal/hostToAppTelemetry.d.ts +51 -0
  8. package/dist/esm/packages/teams-js/dts/internal/interfaces.d.ts +11 -0
  9. package/dist/esm/packages/teams-js/dts/internal/messageObjects.d.ts +5 -0
  10. package/dist/esm/packages/teams-js/dts/internal/pagesHelpers.d.ts +24 -0
  11. package/dist/esm/packages/teams-js/dts/internal/profileUtil.d.ts +23 -1
  12. package/dist/esm/packages/teams-js/dts/internal/uint8array-extras/uint8array-extras.d.ts +6 -0
  13. package/dist/esm/packages/teams-js/dts/internal/utils.d.ts +20 -1
  14. package/dist/esm/packages/teams-js/dts/internal/videoEffectsUtils.d.ts +2 -2
  15. package/dist/esm/packages/teams-js/dts/internal/visualMediaHelpers.d.ts +14 -0
  16. package/dist/esm/packages/teams-js/dts/internal/webStorageHelpers.d.ts +4 -0
  17. package/dist/esm/packages/teams-js/dts/private/appEntity.d.ts +61 -61
  18. package/dist/esm/packages/teams-js/dts/private/conversations.d.ts +48 -48
  19. package/dist/esm/packages/teams-js/dts/private/copilot/copilot.d.ts +2 -0
  20. package/dist/esm/packages/teams-js/dts/private/copilot/eligibility.d.ts +29 -0
  21. package/dist/esm/packages/teams-js/dts/private/externalAppAuthentication.d.ts +355 -349
  22. package/dist/esm/packages/teams-js/dts/private/externalAppAuthenticationForCEA.d.ts +70 -68
  23. package/dist/esm/packages/teams-js/dts/private/externalAppCardActions.d.ts +104 -105
  24. package/dist/esm/packages/teams-js/dts/private/externalAppCardActionsForCEA.d.ts +41 -42
  25. package/dist/esm/packages/teams-js/dts/private/externalAppCommands.d.ts +113 -114
  26. package/dist/esm/packages/teams-js/dts/private/files.d.ts +590 -582
  27. package/dist/esm/packages/teams-js/dts/private/hostEntity/hostEntity.d.ts +42 -0
  28. package/dist/esm/packages/teams-js/dts/private/hostEntity/tab.d.ts +134 -0
  29. package/dist/esm/packages/teams-js/dts/private/index.d.ts +19 -18
  30. package/dist/esm/packages/teams-js/dts/private/logs.d.ts +31 -25
  31. package/dist/esm/packages/teams-js/dts/private/meetingRoom.d.ts +147 -142
  32. package/dist/esm/packages/teams-js/dts/private/messageChannels/dataLayer.d.ts +39 -0
  33. package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts +28 -0
  34. package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts +39 -0
  35. package/dist/esm/packages/teams-js/dts/private/notifications.d.ts +31 -25
  36. package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts +69 -70
  37. package/dist/esm/packages/teams-js/dts/private/remoteCamera.d.ts +219 -214
  38. package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/fullTrust.d.ts +31 -0
  39. package/dist/esm/packages/teams-js/dts/private/teams/fullTrust/joinedTeams.d.ts +30 -0
  40. package/dist/esm/packages/teams-js/dts/private/teams/teams.d.ts +63 -0
  41. package/dist/esm/packages/teams-js/dts/private/videoEffectsEx.d.ts +192 -186
  42. package/dist/esm/packages/teams-js/dts/public/app/app.d.ts +21 -2
  43. package/dist/esm/packages/teams-js/dts/public/app/lifecycle.d.ts +3 -2
  44. package/dist/esm/packages/teams-js/dts/public/appInitialization.d.ts +1 -1
  45. package/dist/esm/packages/teams-js/dts/public/authentication.d.ts +6 -0
  46. package/dist/esm/packages/teams-js/dts/public/barCode.d.ts +2 -1
  47. package/dist/esm/packages/teams-js/dts/public/calendar.d.ts +1 -0
  48. package/dist/esm/packages/teams-js/dts/public/call.d.ts +1 -0
  49. package/dist/esm/packages/teams-js/dts/public/chat.d.ts +4 -0
  50. package/dist/esm/packages/teams-js/dts/public/clipboard.d.ts +1 -0
  51. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/adaptiveCard.d.ts +0 -4
  52. package/dist/esm/packages/teams-js/dts/public/dialog/adaptiveCard/bot.d.ts +3 -2
  53. package/dist/esm/packages/teams-js/dts/public/dialog/dialog.d.ts +0 -13
  54. package/dist/esm/packages/teams-js/dts/public/dialog/update.d.ts +2 -1
  55. package/dist/esm/packages/teams-js/dts/public/dialog/url/bot.d.ts +3 -2
  56. package/dist/esm/packages/teams-js/dts/public/dialog/url/parentCommunication.d.ts +2 -1
  57. package/dist/esm/packages/teams-js/dts/public/geoLocation/geoLocation.d.ts +3 -2
  58. package/dist/esm/packages/teams-js/dts/public/geoLocation/map.d.ts +6 -0
  59. package/dist/esm/packages/teams-js/dts/public/index.d.ts +9 -9
  60. package/dist/esm/packages/teams-js/dts/public/interfaces.d.ts +11 -0
  61. package/dist/esm/packages/teams-js/dts/public/liveShareHost.d.ts +1 -0
  62. package/dist/esm/packages/teams-js/dts/public/location.d.ts +4 -3
  63. package/dist/esm/packages/teams-js/dts/public/mail.d.ts +1 -0
  64. package/dist/esm/packages/teams-js/dts/public/marketplace.d.ts +1 -0
  65. package/dist/esm/packages/teams-js/dts/public/media.d.ts +0 -3
  66. package/dist/esm/packages/teams-js/dts/public/meeting/appShareButton.d.ts +51 -0
  67. package/dist/esm/packages/teams-js/dts/public/meeting/meeting.d.ts +854 -0
  68. package/dist/esm/packages/teams-js/dts/public/menus.d.ts +1 -0
  69. package/dist/esm/packages/teams-js/dts/public/monetization.d.ts +8 -0
  70. package/dist/esm/packages/teams-js/dts/public/navigation.d.ts +2 -1
  71. package/dist/esm/packages/teams-js/dts/public/nestedAppAuth.d.ts +1 -0
  72. package/dist/esm/packages/teams-js/dts/public/pages/appButton.d.ts +30 -0
  73. package/dist/esm/packages/teams-js/dts/public/pages/backStack.d.ts +44 -0
  74. package/dist/esm/packages/teams-js/dts/public/pages/config.d.ts +123 -0
  75. package/dist/esm/packages/teams-js/dts/public/pages/currentApp.d.ts +46 -0
  76. package/dist/esm/packages/teams-js/dts/public/pages/fullTrust.d.ts +33 -0
  77. package/dist/esm/packages/teams-js/dts/public/pages/pages.d.ts +253 -0
  78. package/dist/esm/packages/teams-js/dts/public/pages/tabs.d.ts +32 -0
  79. package/dist/esm/packages/teams-js/dts/public/profile.d.ts +81 -103
  80. package/dist/esm/packages/teams-js/dts/public/runtime.d.ts +3 -0
  81. package/dist/esm/packages/teams-js/dts/public/search.d.ts +9 -0
  82. package/dist/esm/packages/teams-js/dts/public/secondaryBrowser.d.ts +1 -0
  83. package/dist/esm/packages/teams-js/dts/public/settings.d.ts +4 -3
  84. package/dist/esm/packages/teams-js/dts/public/sharing/history.d.ts +47 -0
  85. package/dist/esm/packages/teams-js/dts/public/sharing/sharing.d.ts +76 -0
  86. package/dist/esm/packages/teams-js/dts/public/stageView/self.d.ts +23 -0
  87. package/dist/esm/packages/teams-js/dts/public/stageView/stageView.d.ts +81 -0
  88. package/dist/esm/packages/teams-js/dts/public/tasks.d.ts +0 -8
  89. package/dist/esm/packages/teams-js/dts/public/teamsAPIs.d.ts +4 -0
  90. package/dist/esm/packages/teams-js/dts/public/thirdPartyCloudStorage.d.ts +2 -1
  91. package/dist/esm/packages/teams-js/dts/public/videoEffects.d.ts +209 -210
  92. package/dist/esm/packages/teams-js/dts/public/visualMedia/image.d.ts +64 -0
  93. package/dist/esm/packages/teams-js/dts/public/visualMedia/visualMedia.d.ts +116 -0
  94. package/dist/esm/packages/teams-js/dts/public/webStorage.d.ts +20 -22
  95. package/dist/esm/packages/teams-js/src/index.js +1 -1
  96. package/dist/esm/packages/teams-js/src/internal/appHelpers.js +1 -1
  97. package/dist/esm/packages/teams-js/src/internal/appIdValidation.js +1 -1
  98. package/dist/esm/packages/teams-js/src/internal/communication.js +1 -1
  99. package/dist/esm/packages/teams-js/src/internal/handlers.js +1 -1
  100. package/dist/esm/packages/teams-js/src/internal/hostToAppTelemetry.js +1 -0
  101. package/dist/esm/packages/teams-js/src/internal/marketplaceUtils.js +1 -1
  102. package/dist/esm/packages/teams-js/src/internal/messageObjects.js +1 -1
  103. package/dist/esm/packages/teams-js/src/internal/pagesHelpers.js +1 -0
  104. package/dist/esm/packages/teams-js/src/internal/uint8array-extras/uint8array-extras.js +1 -0
  105. package/dist/esm/packages/teams-js/src/internal/utils.js +1 -1
  106. package/dist/esm/packages/teams-js/src/internal/validOrigins.js +1 -1
  107. package/dist/esm/packages/teams-js/src/internal/videoEffectsUtils.js +1 -1
  108. package/dist/esm/packages/teams-js/src/internal/visualMediaHelpers.js +1 -0
  109. package/dist/esm/packages/teams-js/src/internal/webStorageHelpers.js +1 -0
  110. package/dist/esm/packages/teams-js/src/private/appEntity.js +1 -1
  111. package/dist/esm/packages/teams-js/src/private/conversations.js +1 -1
  112. package/dist/esm/packages/teams-js/src/private/copilot/copilot.js +1 -0
  113. package/dist/esm/packages/teams-js/src/private/copilot/eligibility.js +1 -0
  114. package/dist/esm/packages/teams-js/src/private/externalAppAuthentication.js +1 -1
  115. package/dist/esm/packages/teams-js/src/private/externalAppAuthenticationForCEA.js +1 -1
  116. package/dist/esm/packages/teams-js/src/private/externalAppCardActions.js +1 -1
  117. package/dist/esm/packages/teams-js/src/private/externalAppCardActionsForCEA.js +1 -1
  118. package/dist/esm/packages/teams-js/src/private/externalAppCommands.js +1 -1
  119. package/dist/esm/packages/teams-js/src/private/files.js +1 -1
  120. package/dist/esm/packages/teams-js/src/private/hostEntity/hostEntity.js +1 -0
  121. package/dist/esm/packages/teams-js/src/private/hostEntity/tab.js +1 -0
  122. package/dist/esm/packages/teams-js/src/private/logs.js +1 -1
  123. package/dist/esm/packages/teams-js/src/private/meetingRoom.js +1 -1
  124. package/dist/esm/packages/teams-js/src/private/messageChannels/dataLayer.js +1 -0
  125. package/dist/esm/packages/teams-js/src/private/messageChannels/messageChannels.js +1 -0
  126. package/dist/esm/packages/teams-js/src/private/messageChannels/telemetry.js +1 -0
  127. package/dist/esm/packages/teams-js/src/private/notifications.js +1 -1
  128. package/dist/esm/packages/teams-js/src/private/otherAppStateChange.js +1 -1
  129. package/dist/esm/packages/teams-js/src/private/remoteCamera.js +1 -1
  130. package/dist/esm/packages/teams-js/src/private/teams/fullTrust/fullTrust.js +1 -0
  131. package/dist/esm/packages/teams-js/src/private/teams/fullTrust/joinedTeams.js +1 -0
  132. package/dist/esm/packages/teams-js/src/private/teams/teams.js +1 -0
  133. package/dist/esm/packages/teams-js/src/private/videoEffectsEx.js +1 -1
  134. package/dist/esm/packages/teams-js/src/public/app/app.js +1 -1
  135. package/dist/esm/packages/teams-js/src/public/appInitialization.js +1 -1
  136. package/dist/esm/packages/teams-js/src/public/clipboard.js +1 -1
  137. package/dist/esm/packages/teams-js/src/public/meeting/appShareButton.js +1 -0
  138. package/dist/esm/packages/teams-js/src/public/meeting/meeting.js +1 -0
  139. package/dist/esm/packages/teams-js/src/public/navigation.js +1 -1
  140. package/dist/esm/packages/teams-js/src/public/pages/appButton.js +1 -0
  141. package/dist/esm/packages/teams-js/src/public/pages/backStack.js +1 -0
  142. package/dist/esm/packages/teams-js/src/public/pages/config.js +1 -0
  143. package/dist/esm/packages/teams-js/src/public/pages/currentApp.js +1 -0
  144. package/dist/esm/packages/teams-js/src/public/pages/fullTrust.js +1 -0
  145. package/dist/esm/packages/teams-js/src/public/pages/pages.js +1 -0
  146. package/dist/esm/packages/teams-js/src/public/pages/tabs.js +1 -0
  147. package/dist/esm/packages/teams-js/src/public/profile.js +1 -1
  148. package/dist/esm/packages/teams-js/src/public/publicAPIs.js +1 -1
  149. package/dist/esm/packages/teams-js/src/public/runtime.js +1 -1
  150. package/dist/esm/packages/teams-js/src/public/settings.js +1 -1
  151. package/dist/esm/packages/teams-js/src/public/sharing/history.js +1 -0
  152. package/dist/esm/packages/teams-js/src/public/sharing/sharing.js +1 -0
  153. package/dist/esm/packages/teams-js/src/public/stageView/self.js +1 -0
  154. package/dist/esm/packages/teams-js/src/public/stageView/stageView.js +1 -0
  155. package/dist/esm/packages/teams-js/src/public/tasks.js +1 -1
  156. package/dist/esm/packages/teams-js/src/public/version.js +1 -1
  157. package/dist/esm/packages/teams-js/src/public/videoEffects.js +1 -1
  158. package/dist/esm/packages/teams-js/src/public/visualMedia/image.js +1 -0
  159. package/dist/esm/packages/teams-js/src/public/visualMedia/visualMedia.js +1 -0
  160. package/dist/esm/packages/teams-js/src/public/webStorage.js +1 -1
  161. package/dist/umd/MicrosoftTeams.js +6259 -6439
  162. package/dist/umd/MicrosoftTeams.js.map +1 -1
  163. package/dist/umd/MicrosoftTeams.min.js +1 -1
  164. package/dist/umd/MicrosoftTeams.min.js.map +1 -1
  165. package/package.json +1 -1
  166. package/dist/esm/_virtual/_polyfill-node.buffer.js +0 -1
  167. package/dist/esm/_virtual/_polyfill-node.global.js +0 -1
  168. package/dist/esm/packages/teams-js/dts/private/copilot.d.ts +0 -39
  169. package/dist/esm/packages/teams-js/dts/private/hostEntity.d.ts +0 -176
  170. package/dist/esm/packages/teams-js/dts/private/messageChannels.d.ts +0 -107
  171. package/dist/esm/packages/teams-js/dts/private/teams.d.ts +0 -116
  172. package/dist/esm/packages/teams-js/dts/public/meeting.d.ts +0 -906
  173. package/dist/esm/packages/teams-js/dts/public/pages.d.ts +0 -574
  174. package/dist/esm/packages/teams-js/dts/public/sharing.d.ts +0 -124
  175. package/dist/esm/packages/teams-js/dts/public/stageView.d.ts +0 -104
  176. package/dist/esm/packages/teams-js/dts/public/visualMedia.d.ts +0 -192
  177. package/dist/esm/packages/teams-js/src/private/copilot.js +0 -1
  178. package/dist/esm/packages/teams-js/src/private/hostEntity.js +0 -1
  179. package/dist/esm/packages/teams-js/src/private/messageChannels.js +0 -1
  180. package/dist/esm/packages/teams-js/src/private/teams.js +0 -1
  181. package/dist/esm/packages/teams-js/src/public/meeting.js +0 -1
  182. package/dist/esm/packages/teams-js/src/public/pages.js +0 -1
  183. package/dist/esm/packages/teams-js/src/public/sharing.js +0 -1
  184. package/dist/esm/packages/teams-js/src/public/stageView.js +0 -1
  185. package/dist/esm/packages/teams-js/src/public/visualMedia.js +0 -1
  186. package/dist/umd/MicrosoftTeams.d.ts +0 -11263
  187. /package/dist/esm/node_modules/.pnpm/{@rollup_plugin-typescript@11.1.6_rollup@4.24.0_tslib@2.6.3_typescript@4.9.5 → @rollup_plugin-typescript@11.1.6_rollup@4.24.4_tslib@2.6.3_typescript@4.9.5}/node_modules/tslib/tslib.es6.js +0 -0
@@ -1,758 +1,766 @@
1
+ /**
2
+ * @hidden
3
+ *
4
+ * Module to interact with the files specific part of the SDK.
5
+ *
6
+ * @internal
7
+ * Limited to Microsoft-internal use
8
+ *
9
+ * @module
10
+ */
1
11
  import { FileOpenPreference, SdkError } from '../public/interfaces';
2
- export declare namespace files {
3
- /**
4
- * @hidden
5
- *
6
- * Cloud storage providers registered with Microsoft Teams
7
- *
8
- * @internal
9
- * Limited to Microsoft-internal use
10
- */
11
- export enum CloudStorageProvider {
12
- Dropbox = "DROPBOX",
13
- Box = "BOX",
14
- Sharefile = "SHAREFILE",
15
- GoogleDrive = "GOOGLEDRIVE",
16
- Egnyte = "EGNYTE",
17
- SharePoint = "SharePoint"
18
- }
19
- interface IWopiThumbnail {
20
- size: number;
21
- url: string;
22
- }
23
- interface IWopiService {
24
- name: string;
25
- description: string;
26
- thumbnails: IWopiThumbnail[];
27
- }
28
- /**
29
- * @hidden
30
- *
31
- * External third-party cloud storages providers interface
32
- *
33
- * @internal
34
- * Limited to Microsoft-internal use
35
- */
36
- export interface IExternalProvider extends IWopiService {
37
- providerType: CloudStorageProviderType;
38
- providerCode: CloudStorageProvider;
39
- }
40
- /**
41
- * @hidden
42
- *
43
- * Cloud storage provider type enums
44
- *
45
- * @internal
46
- * Limited to Microsoft-internal use
47
- */
48
- export enum CloudStorageProviderType {
49
- Sharepoint = 0,
50
- WopiIntegration = 1,
51
- Google = 2,
52
- OneDrive = 3,
53
- Recent = 4,
54
- Aggregate = 5,
55
- FileSystem = 6,
56
- Search = 7,
57
- AllFiles = 8,
58
- SharedWithMe = 9
59
- }
60
- /**
61
- * @hidden
62
- *
63
- * Cloud storage folder interface
64
- *
65
- * @internal
66
- * Limited to Microsoft-internal use
67
- */
68
- export interface CloudStorageFolder {
69
- /**
70
- * @hidden
71
- * ID of the cloud storage folder
72
- *
73
- * @internal
74
- * Limited to Microsoft-internal use
75
- */
76
- id: string;
77
- /**
78
- * @hidden
79
- * Display Name/Title of the cloud storage folder
80
- *
81
- * @internal
82
- * Limited to Microsoft-internal use
83
- */
84
- title: string;
85
- /**
86
- * @hidden
87
- * ID of the cloud storage folder in the provider
88
- *
89
- * @internal
90
- * Limited to Microsoft-internal use
91
- */
92
- folderId: string;
93
- /**
94
- * @hidden
95
- * Type of the cloud storage folder provider integration
96
- *
97
- * @internal
98
- * Limited to Microsoft-internal use
99
- */
100
- providerType: CloudStorageProviderType;
101
- /**
102
- * @hidden
103
- * Code of the supported cloud storage folder provider
104
- *
105
- * @internal
106
- * Limited to Microsoft-internal use
107
- */
108
- providerCode: CloudStorageProvider;
109
- /**
110
- * @hidden
111
- * Display name of the owner of the cloud storage folder provider
112
- *
113
- * @internal
114
- * Limited to Microsoft-internal use
115
- */
116
- ownerDisplayName: string;
117
- /**
118
- * @hidden
119
- * Sharepoint specific siteURL of the folder
120
- *
121
- * @internal
122
- * Limited to Microsoft-internal use
123
- */
124
- siteUrl?: string;
125
- /**
126
- * @hidden
127
- * Sharepoint specific serverRelativeUrl of the folder
128
- *
129
- * @internal
130
- * Limited to Microsoft-internal use
131
- */
132
- serverRelativeUrl?: string;
133
- /**
134
- * @hidden
135
- * Sharepoint specific libraryType of the folder
136
- *
137
- * @internal
138
- * Limited to Microsoft-internal use
139
- */
140
- libraryType?: string;
141
- /**
142
- * @hidden
143
- * Sharepoint specific accessType of the folder
144
- *
145
- * @internal
146
- * Limited to Microsoft-internal use
147
- */
148
- accessType?: string;
149
- }
150
- /**
151
- * @hidden
152
- *
153
- * Cloud storage item interface
154
- *
155
- * @internal
156
- * Limited to Microsoft-internal use
157
- */
158
- export interface CloudStorageFolderItem {
159
- /**
160
- * @hidden
161
- * ID of the item in the provider
162
- *
163
- * @internal
164
- * Limited to Microsoft-internal use
165
- */
166
- id: string;
167
- /**
168
- * @hidden
169
- * Display name/title
170
- *
171
- * @internal
172
- * Limited to Microsoft-internal use
173
- */
174
- title: string;
175
- /**
176
- * @hidden
177
- * Key to differentiate files and subdirectory
178
- *
179
- * @internal
180
- * Limited to Microsoft-internal use
181
- */
182
- isSubdirectory: boolean;
183
- /**
184
- * @hidden
185
- * File extension
186
- *
187
- * @internal
188
- * Limited to Microsoft-internal use
189
- */
190
- type: string;
191
- /**
192
- * @hidden
193
- * Last modifed time of the item
194
- *
195
- * @internal
196
- * Limited to Microsoft-internal use
197
- */
198
- lastModifiedTime: string;
199
- /**
200
- * @hidden
201
- * Display size of the items in bytes
202
- *
203
- * @internal
204
- * Limited to Microsoft-internal use
205
- */
206
- size: number;
207
- /**
208
- * @hidden
209
- * URL of the file
210
- *
211
- * @internal
212
- * Limited to Microsoft-internal use
213
- */
214
- objectUrl: string;
215
- /**
216
- * @hidden
217
- * Temporary access token for the item
218
- *
219
- * @internal
220
- * Limited to Microsoft-internal use
221
- */
222
- accessToken?: string;
223
- }
224
- /**
225
- * @hidden
226
- *
227
- * Files entity user interface
228
- *
229
- * @internal
230
- * Limited to Microsoft-internal use
231
- */
232
- export interface IFilesEntityUser {
233
- /**
234
- * @hidden
235
- * User name.
236
- *
237
- * @internal
238
- * Limited to Microsoft-internal use
239
- */
240
- displayName: string;
241
- /**
242
- * @hidden
243
- * User email.
244
- *
245
- * @internal
246
- * Limited to Microsoft-internal use
247
- */
248
- email: string;
249
- /**
250
- * @hidden
251
- * User MRI.
252
- *
253
- * @internal
254
- * Limited to Microsoft-internal use
255
- */
256
- mri: string;
257
- }
12
+ /**
13
+ * @hidden
14
+ *
15
+ * Cloud storage providers registered with Microsoft Teams
16
+ *
17
+ * @internal
18
+ * Limited to Microsoft-internal use
19
+ */
20
+ export declare enum CloudStorageProvider {
21
+ Dropbox = "DROPBOX",
22
+ Box = "BOX",
23
+ Sharefile = "SHAREFILE",
24
+ GoogleDrive = "GOOGLEDRIVE",
25
+ Egnyte = "EGNYTE",
26
+ SharePoint = "SharePoint"
27
+ }
28
+ interface IWopiThumbnail {
29
+ size: number;
30
+ url: string;
31
+ }
32
+ interface IWopiService {
33
+ name: string;
34
+ description: string;
35
+ thumbnails: IWopiThumbnail[];
36
+ }
37
+ /**
38
+ * @hidden
39
+ *
40
+ * External third-party cloud storages providers interface
41
+ *
42
+ * @internal
43
+ * Limited to Microsoft-internal use
44
+ */
45
+ export interface IExternalProvider extends IWopiService {
46
+ providerType: CloudStorageProviderType;
47
+ providerCode: CloudStorageProvider;
48
+ }
49
+ /**
50
+ * @hidden
51
+ *
52
+ * Cloud storage provider type enums
53
+ *
54
+ * @internal
55
+ * Limited to Microsoft-internal use
56
+ */
57
+ export declare enum CloudStorageProviderType {
58
+ Sharepoint = 0,
59
+ WopiIntegration = 1,
60
+ Google = 2,
61
+ OneDrive = 3,
62
+ Recent = 4,
63
+ Aggregate = 5,
64
+ FileSystem = 6,
65
+ Search = 7,
66
+ AllFiles = 8,
67
+ SharedWithMe = 9
68
+ }
69
+ /**
70
+ * @hidden
71
+ *
72
+ * Cloud storage folder interface
73
+ *
74
+ * @internal
75
+ * Limited to Microsoft-internal use
76
+ */
77
+ export interface CloudStorageFolder {
258
78
  /**
259
79
  * @hidden
260
- *
261
- * Special Document Library enum
80
+ * ID of the cloud storage folder
262
81
  *
263
82
  * @internal
264
83
  * Limited to Microsoft-internal use
265
84
  */
266
- export enum SpecialDocumentLibraryType {
267
- ClassMaterials = "classMaterials"
268
- }
85
+ id: string;
269
86
  /**
270
87
  * @hidden
271
- *
272
- * Document Library Access enum
88
+ * Display Name/Title of the cloud storage folder
273
89
  *
274
90
  * @internal
275
91
  * Limited to Microsoft-internal use
276
92
  */
277
- export enum DocumentLibraryAccessType {
278
- Readonly = "readonly"
279
- }
93
+ title: string;
280
94
  /**
281
95
  * @hidden
282
- *
283
- * SharePoint file interface
96
+ * ID of the cloud storage folder in the provider
284
97
  *
285
98
  * @internal
286
99
  * Limited to Microsoft-internal use
287
100
  */
288
- export interface ISharePointFile {
289
- siteId?: string;
290
- siteUrl: string;
291
- objectId: string;
292
- objectUrl: string;
293
- openInWindowFileUrl: string;
294
- title: string;
295
- isFolder: boolean;
296
- serverRelativeUrl: string;
297
- lastModifiedByUser: IFilesEntityUser;
298
- lastModifiedTime: string;
299
- sentByUser: IFilesEntityUser;
300
- createdByUser: IFilesEntityUser;
301
- createdTime: string;
302
- size: number;
303
- type: string;
304
- spItemUrl?: string;
305
- libraryType?: SpecialDocumentLibraryType;
306
- accessType?: DocumentLibraryAccessType;
307
- etag?: string;
308
- remoteItem?: string;
309
- listUrl?: string;
310
- }
101
+ folderId: string;
311
102
  /**
312
103
  * @hidden
313
- *
314
- * Download status enum
104
+ * Type of the cloud storage folder provider integration
315
105
  *
316
106
  * @internal
317
107
  * Limited to Microsoft-internal use
318
108
  */
319
- export enum FileDownloadStatus {
320
- Downloaded = "Downloaded",
321
- Downloading = "Downloading",
322
- Failed = "Failed"
323
- }
109
+ providerType: CloudStorageProviderType;
324
110
  /**
325
111
  * @hidden
326
- *
327
- * Download Files interface
112
+ * Code of the supported cloud storage folder provider
328
113
  *
329
114
  * @internal
330
115
  * Limited to Microsoft-internal use
331
116
  */
332
- export interface IFileItem {
333
- /**
334
- * @hidden
335
- * ID of the file metadata
336
- *
337
- * @internal
338
- * Limited to Microsoft-internal use
339
- */
340
- objectId?: string;
341
- /**
342
- * @hidden
343
- * Path of the file
344
- *
345
- * @internal
346
- * Limited to Microsoft-internal use
347
- */
348
- path?: string;
349
- /**
350
- * @hidden
351
- * Size of the file in bytes
352
- *
353
- * @internal
354
- * Limited to Microsoft-internal use
355
- */
356
- sizeInBytes?: number;
357
- /**
358
- * @hidden
359
- * Download status
360
- *
361
- * @internal
362
- * Limited to Microsoft-internal use
363
- */
364
- status?: FileDownloadStatus;
365
- /**
366
- * @hidden
367
- * Download timestamp
368
- *
369
- * @internal
370
- * Limited to Microsoft-internal use
371
- */
372
- timestamp: Date;
373
- /**
374
- * @hidden
375
- * File name
376
- *
377
- * @internal
378
- * Limited to Microsoft-internal use
379
- */
380
- title: string;
381
- /**
382
- * @hidden
383
- * Type of file i.e. the file extension.
384
- *
385
- * @internal
386
- * Limited to Microsoft-internal use
387
- */
388
- extension: string;
389
- }
117
+ providerCode: CloudStorageProvider;
390
118
  /**
391
119
  * @hidden
392
- * Object used to represent a file
393
- * @beta
120
+ * Display name of the owner of the cloud storage folder provider
394
121
  *
395
122
  * @internal
396
123
  * Limited to Microsoft-internal use
397
124
  */
398
- export interface File extends Blob {
399
- /**
400
- * A number that represents the number of milliseconds since the Unix epoch
401
- */
402
- lastModified: number;
403
- /**
404
- * Name of the file
405
- */
406
- name: string;
407
- /**
408
- * A string containing the path of the file relative to the ancestor directory the user selected
409
- */
410
- webkitRelativePath?: string;
411
- }
125
+ ownerDisplayName: string;
412
126
  /**
413
127
  * @hidden
414
- * Hide from docs
415
- *
416
- * Actions specific to 3P cloud storage provider file and / or account
128
+ * Sharepoint specific siteURL of the folder
417
129
  *
418
130
  * @internal
419
131
  * Limited to Microsoft-internal use
420
132
  */
421
- export enum CloudStorageProviderFileAction {
422
- Download = "DOWNLOAD",
423
- Upload = "UPLOAD",
424
- Delete = "DELETE"
425
- }
133
+ siteUrl?: string;
426
134
  /**
427
135
  * @hidden
428
- * Hide from docs
429
- *
430
- * Interface for 3P cloud storage provider request content type
136
+ * Sharepoint specific serverRelativeUrl of the folder
431
137
  *
432
138
  * @internal
433
139
  * Limited to Microsoft-internal use
434
140
  */
435
- export interface CloudStorageProviderRequest<T> {
436
- content: T;
437
- }
141
+ serverRelativeUrl?: string;
438
142
  /**
439
143
  * @hidden
440
- * Hide from docs
441
- *
442
- * Base interface for 3P cloud storage provider action request content
144
+ * Sharepoint specific libraryType of the folder
443
145
  *
444
146
  * @internal
445
147
  * Limited to Microsoft-internal use
446
148
  */
447
- export interface CloudStorageProviderContent {
448
- providerCode: CloudStorageProvider;
449
- }
149
+ libraryType?: string;
450
150
  /**
451
151
  * @hidden
452
- * Hide from docs
453
- *
454
- * Interface representing 3P cloud storage provider add new file action.
455
- * The file extension represents type of file e.g. docx, pptx etc. and need not be prefixed with dot(.)
152
+ * Sharepoint specific accessType of the folder
456
153
  *
457
154
  * @internal
458
155
  * Limited to Microsoft-internal use
459
156
  */
460
- export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
461
- newFileName: string;
462
- newFileExtension: string;
463
- destinationFolder: CloudStorageFolderItem | ISharePointFile;
464
- }
465
- /**
466
- * @hidden
467
- * Hide from docs
468
- *
469
- * Interface representing 3P cloud storage provider rename existing file action
470
- *
471
- * @internal
472
- * Limited to Microsoft-internal use
473
- */
474
- export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
475
- existingFile: CloudStorageFolderItem | ISharePointFile;
476
- newFile: CloudStorageFolderItem | ISharePointFile;
477
- }
157
+ accessType?: string;
158
+ }
159
+ /**
160
+ * @hidden
161
+ *
162
+ * Cloud storage item interface
163
+ *
164
+ * @internal
165
+ * Limited to Microsoft-internal use
166
+ */
167
+ export interface CloudStorageFolderItem {
478
168
  /**
479
169
  * @hidden
480
- * Hide from docs
481
- *
482
- * Interface representing 3P cloud storage provider delete existing file(s) action
170
+ * ID of the item in the provider
483
171
  *
484
172
  * @internal
485
173
  * Limited to Microsoft-internal use
486
174
  */
487
- export interface CloudStorageProviderDeleteFileContent extends CloudStorageProviderContent {
488
- itemList: CloudStorageFolderItem[] | ISharePointFile[];
489
- }
175
+ id: string;
490
176
  /**
491
177
  * @hidden
492
- * Hide from docs
493
- *
494
- * Interface representing 3P cloud storage provider download existing file(s) action
178
+ * Display name/title
495
179
  *
496
180
  * @internal
497
181
  * Limited to Microsoft-internal use
498
182
  */
499
- export interface CloudStorageProviderDownloadFileContent extends CloudStorageProviderContent {
500
- itemList: CloudStorageFolderItem[] | ISharePointFile[];
501
- }
183
+ title: string;
502
184
  /**
503
185
  * @hidden
504
- * Hide from docs
505
- * @beta
506
- *
507
- * Interface representing 3P cloud storage provider upload existing file(s) action
186
+ * Key to differentiate files and subdirectory
508
187
  *
509
188
  * @internal
510
189
  * Limited to Microsoft-internal use
511
190
  */
512
- export interface CloudStorageProviderUploadFileContent extends CloudStorageProviderContent {
513
- itemList: File[];
514
- destinationFolder: CloudStorageFolderItem | ISharePointFile;
515
- }
191
+ isSubdirectory: boolean;
516
192
  /**
517
193
  * @hidden
518
- * Hide from docs
519
- *
520
- * Gets a list of cloud storage folders added to the channel. This function will not timeout;
521
- * the callback will only return when the host responds with a list of folders or error.
522
- *
523
- * @param channelId - ID of the channel whose cloud storage folders should be retrieved
524
- * @param callback - Callback that will be triggered post folders load
194
+ * File extension
525
195
  *
526
196
  * @internal
527
197
  * Limited to Microsoft-internal use
528
198
  */
529
- export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
199
+ type: string;
530
200
  /**
531
201
  * @hidden
532
- * Hide from docs
533
- * ------
534
- * Initiates the add cloud storage folder flow
535
- *
536
- * @param channelId - ID of the channel to add cloud storage folder
537
- * @param callback - Callback that will be triggered post add folder flow is compelete
202
+ * Last modifed time of the item
538
203
  *
539
204
  * @internal
540
205
  * Limited to Microsoft-internal use
541
206
  */
542
- export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
207
+ lastModifiedTime: string;
543
208
  /**
544
209
  * @hidden
545
- * Hide from docs
546
- * ------
547
- *
548
- * Deletes a cloud storage folder from channel
549
- *
550
- * @param channelId - ID of the channel where folder is to be deleted
551
- * @param folderToDelete - cloud storage folder to be deleted
552
- * @param callback - Callback that will be triggered post delete
210
+ * Display size of the items in bytes
553
211
  *
554
212
  * @internal
555
213
  * Limited to Microsoft-internal use
556
214
  */
557
- export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
215
+ size: number;
558
216
  /**
559
217
  * @hidden
560
- * Hide from docs
561
- * ------
562
- *
563
- * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
564
- *
565
- * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
566
- * @param providerCode - Code of the cloud storage folder provider
567
- * @param callback - Callback that will be triggered post contents are loaded
218
+ * URL of the file
568
219
  *
569
220
  * @internal
570
221
  * Limited to Microsoft-internal use
571
222
  */
572
- export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
223
+ objectUrl: string;
573
224
  /**
574
225
  * @hidden
575
- * Hide from docs
576
- * ------
577
- *
578
- * Open a cloud storage file in Teams
579
- *
580
- * @param file - cloud storage file that should be opened
581
- * @param providerCode - Code of the cloud storage folder provider
582
- * @param fileOpenPreference - Whether file should be opened in web/inline
226
+ * Temporary access token for the item
583
227
  *
584
228
  * @internal
585
229
  * Limited to Microsoft-internal use
586
230
  */
587
- export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
231
+ accessToken?: string;
232
+ }
233
+ /**
234
+ * @hidden
235
+ *
236
+ * Files entity user interface
237
+ *
238
+ * @internal
239
+ * Limited to Microsoft-internal use
240
+ */
241
+ export interface IFilesEntityUser {
588
242
  /**
589
243
  * @hidden
590
- * Allow 1st party apps to call this function to get the external
591
- * third party cloud storage accounts that the tenant supports
592
- * @param excludeAddedProviders: return a list of support third party
593
- * cloud storages that hasn't been added yet.
244
+ * User name.
594
245
  *
595
246
  * @internal
596
247
  * Limited to Microsoft-internal use
597
248
  */
598
- export function getExternalProviders(excludeAddedProviders: boolean | undefined, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
249
+ displayName: string;
599
250
  /**
600
251
  * @hidden
601
- * Allow 1st party apps to call this function to move files
602
- * among SharePoint and third party cloud storages.
252
+ * User email.
603
253
  *
604
254
  * @internal
605
255
  * Limited to Microsoft-internal use
606
256
  */
607
- export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean | undefined, callback: (error?: SdkError) => void): void;
257
+ email: string;
608
258
  /**
609
259
  * @hidden
610
- * Hide from docs
611
- * ------
612
- *
613
- * Gets list of downloads for current user
614
- * @param callback Callback that will be triggered post downloads load
260
+ * User MRI.
615
261
  *
616
262
  * @internal
617
263
  * Limited to Microsoft-internal use
618
264
  */
619
- export function getFileDownloads(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
265
+ mri: string;
266
+ }
267
+ /**
268
+ * @hidden
269
+ *
270
+ * Special Document Library enum
271
+ *
272
+ * @internal
273
+ * Limited to Microsoft-internal use
274
+ */
275
+ export declare enum SpecialDocumentLibraryType {
276
+ ClassMaterials = "classMaterials"
277
+ }
278
+ /**
279
+ * @hidden
280
+ *
281
+ * Document Library Access enum
282
+ *
283
+ * @internal
284
+ * Limited to Microsoft-internal use
285
+ */
286
+ export declare enum DocumentLibraryAccessType {
287
+ Readonly = "readonly"
288
+ }
289
+ /**
290
+ * @hidden
291
+ *
292
+ * SharePoint file interface
293
+ *
294
+ * @internal
295
+ * Limited to Microsoft-internal use
296
+ */
297
+ export interface ISharePointFile {
298
+ siteId?: string;
299
+ siteUrl: string;
300
+ objectId: string;
301
+ objectUrl: string;
302
+ openInWindowFileUrl: string;
303
+ title: string;
304
+ isFolder: boolean;
305
+ serverRelativeUrl: string;
306
+ lastModifiedByUser: IFilesEntityUser;
307
+ lastModifiedTime: string;
308
+ sentByUser: IFilesEntityUser;
309
+ createdByUser: IFilesEntityUser;
310
+ createdTime: string;
311
+ size: number;
312
+ type: string;
313
+ spItemUrl?: string;
314
+ libraryType?: SpecialDocumentLibraryType;
315
+ accessType?: DocumentLibraryAccessType;
316
+ etag?: string;
317
+ remoteItem?: string;
318
+ listUrl?: string;
319
+ }
320
+ /**
321
+ * @hidden
322
+ *
323
+ * Download status enum
324
+ *
325
+ * @internal
326
+ * Limited to Microsoft-internal use
327
+ */
328
+ export declare enum FileDownloadStatus {
329
+ Downloaded = "Downloaded",
330
+ Downloading = "Downloading",
331
+ Failed = "Failed"
332
+ }
333
+ /**
334
+ * @hidden
335
+ *
336
+ * Download Files interface
337
+ *
338
+ * @internal
339
+ * Limited to Microsoft-internal use
340
+ */
341
+ export interface IFileItem {
620
342
  /**
621
343
  * @hidden
622
- * Hide from docs
623
- *
624
- * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
625
- * @param fileObjectId - Id of the file whose containing folder should be opened
626
- * @param callback Callback that will be triggered post open download folder/path
344
+ * ID of the file metadata
627
345
  *
628
346
  * @internal
629
347
  * Limited to Microsoft-internal use
630
348
  */
631
- export function openDownloadFolder(fileObjectId: string | undefined, callback: (error?: SdkError) => void): void;
349
+ objectId?: string;
632
350
  /**
633
351
  * @hidden
634
- * Hide from docs
635
- *
636
- * Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
637
- * 3P provider from the configured policy supported 3P provider list, following which user authentication
638
- * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
639
- * @beta
640
- *
641
- * @param callback Callback that will be triggered post add 3P cloud storage provider action.
642
- * If the error is encountered (and hence passed back), no provider value is sent back.
643
- * For success scenarios, error value will be passed as null and a valid provider value is sent.
352
+ * Path of the file
644
353
  *
645
354
  * @internal
646
355
  * Limited to Microsoft-internal use
647
356
  */
648
- export function addCloudStorageProvider(callback: (error?: SdkError, provider?: CloudStorageProvider) => void): void;
357
+ path?: string;
649
358
  /**
650
359
  * @hidden
651
- * Hide from docs
652
- *
653
- * Initiates signout of 3P cloud storage provider flow, which will remove the selected
654
- * 3P cloud storage provider from the list of added providers. No other user input and / or action
655
- * is required except the 3P cloud storage provider to signout from
656
- *
657
- * @param logoutRequest 3P cloud storage provider remove action request content
658
- * @param callback Callback that will be triggered post signout of 3P cloud storage provider action
360
+ * Size of the file in bytes
659
361
  *
660
362
  * @internal
661
363
  * Limited to Microsoft-internal use
662
364
  */
663
- export function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
365
+ sizeInBytes?: number;
664
366
  /**
665
367
  * @hidden
666
- * Hide from docs
667
- *
668
- * Initiates the add 3P cloud storage file flow, which will add a new file for the given 3P provider
669
- *
670
- * @param addNewFileRequest 3P cloud storage provider add action request content
671
- * @param callback Callback that will be triggered post adding a new file flow is finished
368
+ * Download status
672
369
  *
673
370
  * @internal
674
371
  * Limited to Microsoft-internal use
675
372
  */
676
- export function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
373
+ status?: FileDownloadStatus;
677
374
  /**
678
375
  * @hidden
679
- * Hide from docs
680
- *
681
- * Initiates the rename 3P cloud storage file flow, which will rename an existing file in the given 3P provider
682
- *
683
- * @param renameFileRequest 3P cloud storage provider rename action request content
684
- * @param callback Callback that will be triggered post renaming an existing file flow is finished
376
+ * Download timestamp
685
377
  *
686
378
  * @internal
687
379
  * Limited to Microsoft-internal use
688
380
  */
689
- export function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
381
+ timestamp: Date;
690
382
  /**
691
383
  * @hidden
692
- * Hide from docs
693
- *
694
- * Initiates the delete 3P cloud storage file(s) / folder (folder has to be empty) flow,
695
- * which will delete existing file(s) / folder from the given 3P provider
696
- *
697
- * @param deleteFileRequest 3P cloud storage provider delete action request content
698
- * @param callback Callback that will be triggered post deleting existing file(s) flow is finished
384
+ * File name
699
385
  *
700
386
  * @internal
701
387
  * Limited to Microsoft-internal use
702
388
  */
703
- export function deleteCloudStorageProviderFile(deleteFileRequest: CloudStorageProviderRequest<CloudStorageProviderDeleteFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
389
+ title: string;
704
390
  /**
705
391
  * @hidden
706
- * Hide from docs
707
- *
708
- * Initiates the download 3P cloud storage file(s) flow,
709
- * which will download existing file(s) from the given 3P provider in the teams client side without sharing any file info in the callback
710
- *
711
- * @param downloadFileRequest 3P cloud storage provider download file(s) action request content
712
- * @param callback Callback that will be triggered post downloading existing file(s) flow is finished
392
+ * Type of file i.e. the file extension.
713
393
  *
714
394
  * @internal
715
395
  * Limited to Microsoft-internal use
716
396
  */
717
- export function downloadCloudStorageProviderFile(downloadFileRequest: CloudStorageProviderRequest<CloudStorageProviderDownloadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
397
+ extension: string;
398
+ }
399
+ /**
400
+ * @hidden
401
+ * Object used to represent a file
402
+ * @beta
403
+ *
404
+ * @internal
405
+ * Limited to Microsoft-internal use
406
+ */
407
+ export interface File extends Blob {
718
408
  /**
719
- * @hidden
720
- * Hide from docs
721
- *
722
- * Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
723
- * @beta
724
- *
725
- * @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
726
- * @param callback Callback that will be triggered post uploading file(s) flow is finished
727
- *
728
- * @internal
729
- * Limited to Microsoft-internal use
409
+ * A number that represents the number of milliseconds since the Unix epoch
730
410
  */
731
- export function uploadCloudStorageProviderFile(uploadFileRequest: CloudStorageProviderRequest<CloudStorageProviderUploadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
411
+ lastModified: number;
732
412
  /**
733
- * @hidden
734
- * Hide from docs
735
- *
736
- * Register a handler to be called when a user's 3P cloud storage provider list changes i.e.
737
- * post adding / removing a 3P provider, list is updated
738
- *
739
- * @param handler - When 3P cloud storage provider list is updated this handler is called
740
- *
741
- * @internal Limited to Microsoft-internal use
413
+ * Name of the file
742
414
  */
743
- export function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
415
+ name: string;
744
416
  /**
745
- * @hidden
746
- * Hide from docs
747
- *
748
- * Register a handler to be called when a user's 3P cloud storage provider content changes i.e.
749
- * when file(s) is/are added / renamed / deleted / uploaded, the list of files is updated
750
- *
751
- * @param handler - When 3P cloud storage provider content is updated this handler is called
752
- *
753
- * @internal
754
- * Limited to Microsoft-internal use
417
+ * A string containing the path of the file relative to the ancestor directory the user selected
755
418
  */
756
- export function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
757
- export {};
419
+ webkitRelativePath?: string;
420
+ }
421
+ /**
422
+ * @hidden
423
+ * Hide from docs
424
+ *
425
+ * Actions specific to 3P cloud storage provider file and / or account
426
+ *
427
+ * @internal
428
+ * Limited to Microsoft-internal use
429
+ */
430
+ export declare enum CloudStorageProviderFileAction {
431
+ Download = "DOWNLOAD",
432
+ Upload = "UPLOAD",
433
+ Delete = "DELETE"
434
+ }
435
+ /**
436
+ * @hidden
437
+ * Hide from docs
438
+ *
439
+ * Interface for 3P cloud storage provider request content type
440
+ *
441
+ * @internal
442
+ * Limited to Microsoft-internal use
443
+ */
444
+ export interface CloudStorageProviderRequest<T> {
445
+ content: T;
446
+ }
447
+ /**
448
+ * @hidden
449
+ * Hide from docs
450
+ *
451
+ * Base interface for 3P cloud storage provider action request content
452
+ *
453
+ * @internal
454
+ * Limited to Microsoft-internal use
455
+ */
456
+ export interface CloudStorageProviderContent {
457
+ providerCode: CloudStorageProvider;
458
+ }
459
+ /**
460
+ * @hidden
461
+ * Hide from docs
462
+ *
463
+ * Interface representing 3P cloud storage provider add new file action.
464
+ * The file extension represents type of file e.g. docx, pptx etc. and need not be prefixed with dot(.)
465
+ *
466
+ * @internal
467
+ * Limited to Microsoft-internal use
468
+ */
469
+ export interface CloudStorageProviderNewFileContent extends CloudStorageProviderContent {
470
+ newFileName: string;
471
+ newFileExtension: string;
472
+ destinationFolder: CloudStorageFolderItem | ISharePointFile;
473
+ }
474
+ /**
475
+ * @hidden
476
+ * Hide from docs
477
+ *
478
+ * Interface representing 3P cloud storage provider rename existing file action
479
+ *
480
+ * @internal
481
+ * Limited to Microsoft-internal use
482
+ */
483
+ export interface CloudStorageProviderRenameFileContent extends CloudStorageProviderContent {
484
+ existingFile: CloudStorageFolderItem | ISharePointFile;
485
+ newFile: CloudStorageFolderItem | ISharePointFile;
486
+ }
487
+ /**
488
+ * @hidden
489
+ * Hide from docs
490
+ *
491
+ * Interface representing 3P cloud storage provider delete existing file(s) action
492
+ *
493
+ * @internal
494
+ * Limited to Microsoft-internal use
495
+ */
496
+ export interface CloudStorageProviderDeleteFileContent extends CloudStorageProviderContent {
497
+ itemList: CloudStorageFolderItem[] | ISharePointFile[];
498
+ }
499
+ /**
500
+ * @hidden
501
+ * Hide from docs
502
+ *
503
+ * Interface representing 3P cloud storage provider download existing file(s) action
504
+ *
505
+ * @internal
506
+ * Limited to Microsoft-internal use
507
+ */
508
+ export interface CloudStorageProviderDownloadFileContent extends CloudStorageProviderContent {
509
+ itemList: CloudStorageFolderItem[] | ISharePointFile[];
510
+ }
511
+ /**
512
+ * @hidden
513
+ * Hide from docs
514
+ * @beta
515
+ *
516
+ * Interface representing 3P cloud storage provider upload existing file(s) action
517
+ *
518
+ * @internal
519
+ * Limited to Microsoft-internal use
520
+ */
521
+ export interface CloudStorageProviderUploadFileContent extends CloudStorageProviderContent {
522
+ itemList: File[];
523
+ destinationFolder: CloudStorageFolderItem | ISharePointFile;
758
524
  }
525
+ /**
526
+ * @hidden
527
+ * Hide from docs
528
+ *
529
+ * Gets a list of cloud storage folders added to the channel. This function will not timeout;
530
+ * the callback will only return when the host responds with a list of folders or error.
531
+ *
532
+ * @param channelId - ID of the channel whose cloud storage folders should be retrieved
533
+ * @param callback - Callback that will be triggered post folders load
534
+ *
535
+ * @internal
536
+ * Limited to Microsoft-internal use
537
+ */
538
+ export declare function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
539
+ /**
540
+ * @hidden
541
+ * Hide from docs
542
+ * ------
543
+ * Initiates the add cloud storage folder flow
544
+ *
545
+ * @param channelId - ID of the channel to add cloud storage folder
546
+ * @param callback - Callback that will be triggered post add folder flow is compelete
547
+ *
548
+ * @internal
549
+ * Limited to Microsoft-internal use
550
+ */
551
+ export declare function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
552
+ /**
553
+ * @hidden
554
+ * Hide from docs
555
+ * ------
556
+ *
557
+ * Deletes a cloud storage folder from channel
558
+ *
559
+ * @param channelId - ID of the channel where folder is to be deleted
560
+ * @param folderToDelete - cloud storage folder to be deleted
561
+ * @param callback - Callback that will be triggered post delete
562
+ *
563
+ * @internal
564
+ * Limited to Microsoft-internal use
565
+ */
566
+ export declare function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
567
+ /**
568
+ * @hidden
569
+ * Hide from docs
570
+ * ------
571
+ *
572
+ * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
573
+ *
574
+ * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
575
+ * @param providerCode - Code of the cloud storage folder provider
576
+ * @param callback - Callback that will be triggered post contents are loaded
577
+ *
578
+ * @internal
579
+ * Limited to Microsoft-internal use
580
+ */
581
+ export declare function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
582
+ /**
583
+ * @hidden
584
+ * Hide from docs
585
+ * ------
586
+ *
587
+ * Open a cloud storage file in Teams
588
+ *
589
+ * @param file - cloud storage file that should be opened
590
+ * @param providerCode - Code of the cloud storage folder provider
591
+ * @param fileOpenPreference - Whether file should be opened in web/inline
592
+ *
593
+ * @internal
594
+ * Limited to Microsoft-internal use
595
+ */
596
+ export declare function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
597
+ /**
598
+ * @hidden
599
+ * Allow 1st party apps to call this function to get the external
600
+ * third party cloud storage accounts that the tenant supports
601
+ * @param excludeAddedProviders: return a list of support third party
602
+ * cloud storages that hasn't been added yet.
603
+ *
604
+ * @internal
605
+ * Limited to Microsoft-internal use
606
+ */
607
+ export declare function getExternalProviders(excludeAddedProviders: boolean | undefined, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
608
+ /**
609
+ * @hidden
610
+ * Allow 1st party apps to call this function to move files
611
+ * among SharePoint and third party cloud storages.
612
+ *
613
+ * @internal
614
+ * Limited to Microsoft-internal use
615
+ */
616
+ export declare function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean | undefined, callback: (error?: SdkError) => void): void;
617
+ /**
618
+ * @hidden
619
+ * Hide from docs
620
+ * ------
621
+ *
622
+ * Gets list of downloads for current user
623
+ * @param callback Callback that will be triggered post downloads load
624
+ *
625
+ * @internal
626
+ * Limited to Microsoft-internal use
627
+ */
628
+ export declare function getFileDownloads(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
629
+ /**
630
+ * @hidden
631
+ * Hide from docs
632
+ *
633
+ * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
634
+ * @param fileObjectId - Id of the file whose containing folder should be opened
635
+ * @param callback Callback that will be triggered post open download folder/path
636
+ *
637
+ * @internal
638
+ * Limited to Microsoft-internal use
639
+ */
640
+ export declare function openDownloadFolder(fileObjectId: string | undefined, callback: (error?: SdkError) => void): void;
641
+ /**
642
+ * @hidden
643
+ * Hide from docs
644
+ *
645
+ * Initiates add 3P cloud storage provider flow, where a pop up window opens for user to select required
646
+ * 3P provider from the configured policy supported 3P provider list, following which user authentication
647
+ * for selected 3P provider is performed on success of which the selected 3P provider support is added for user
648
+ * @beta
649
+ *
650
+ * @param callback Callback that will be triggered post add 3P cloud storage provider action.
651
+ * If the error is encountered (and hence passed back), no provider value is sent back.
652
+ * For success scenarios, error value will be passed as null and a valid provider value is sent.
653
+ *
654
+ * @internal
655
+ * Limited to Microsoft-internal use
656
+ */
657
+ export declare function addCloudStorageProvider(callback: (error?: SdkError, provider?: CloudStorageProvider) => void): void;
658
+ /**
659
+ * @hidden
660
+ * Hide from docs
661
+ *
662
+ * Initiates signout of 3P cloud storage provider flow, which will remove the selected
663
+ * 3P cloud storage provider from the list of added providers. No other user input and / or action
664
+ * is required except the 3P cloud storage provider to signout from
665
+ *
666
+ * @param logoutRequest 3P cloud storage provider remove action request content
667
+ * @param callback Callback that will be triggered post signout of 3P cloud storage provider action
668
+ *
669
+ * @internal
670
+ * Limited to Microsoft-internal use
671
+ */
672
+ export declare function removeCloudStorageProvider(logoutRequest: CloudStorageProviderRequest<CloudStorageProviderContent>, callback: (error?: SdkError) => void): void;
673
+ /**
674
+ * @hidden
675
+ * Hide from docs
676
+ *
677
+ * Initiates the add 3P cloud storage file flow, which will add a new file for the given 3P provider
678
+ *
679
+ * @param addNewFileRequest 3P cloud storage provider add action request content
680
+ * @param callback Callback that will be triggered post adding a new file flow is finished
681
+ *
682
+ * @internal
683
+ * Limited to Microsoft-internal use
684
+ */
685
+ export declare function addCloudStorageProviderFile(addNewFileRequest: CloudStorageProviderRequest<CloudStorageProviderNewFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
686
+ /**
687
+ * @hidden
688
+ * Hide from docs
689
+ *
690
+ * Initiates the rename 3P cloud storage file flow, which will rename an existing file in the given 3P provider
691
+ *
692
+ * @param renameFileRequest 3P cloud storage provider rename action request content
693
+ * @param callback Callback that will be triggered post renaming an existing file flow is finished
694
+ *
695
+ * @internal
696
+ * Limited to Microsoft-internal use
697
+ */
698
+ export declare function renameCloudStorageProviderFile(renameFileRequest: CloudStorageProviderRequest<CloudStorageProviderRenameFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
699
+ /**
700
+ * @hidden
701
+ * Hide from docs
702
+ *
703
+ * Initiates the delete 3P cloud storage file(s) / folder (folder has to be empty) flow,
704
+ * which will delete existing file(s) / folder from the given 3P provider
705
+ *
706
+ * @param deleteFileRequest 3P cloud storage provider delete action request content
707
+ * @param callback Callback that will be triggered post deleting existing file(s) flow is finished
708
+ *
709
+ * @internal
710
+ * Limited to Microsoft-internal use
711
+ */
712
+ export declare function deleteCloudStorageProviderFile(deleteFileRequest: CloudStorageProviderRequest<CloudStorageProviderDeleteFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
713
+ /**
714
+ * @hidden
715
+ * Hide from docs
716
+ *
717
+ * Initiates the download 3P cloud storage file(s) flow,
718
+ * which will download existing file(s) from the given 3P provider in the teams client side without sharing any file info in the callback
719
+ *
720
+ * @param downloadFileRequest 3P cloud storage provider download file(s) action request content
721
+ * @param callback Callback that will be triggered post downloading existing file(s) flow is finished
722
+ *
723
+ * @internal
724
+ * Limited to Microsoft-internal use
725
+ */
726
+ export declare function downloadCloudStorageProviderFile(downloadFileRequest: CloudStorageProviderRequest<CloudStorageProviderDownloadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
727
+ /**
728
+ * @hidden
729
+ * Hide from docs
730
+ *
731
+ * Initiates the upload 3P cloud storage file(s) flow, which will upload file(s) to the given 3P provider
732
+ * @beta
733
+ *
734
+ * @param uploadFileRequest 3P cloud storage provider upload file(s) action request content
735
+ * @param callback Callback that will be triggered post uploading file(s) flow is finished
736
+ *
737
+ * @internal
738
+ * Limited to Microsoft-internal use
739
+ */
740
+ export declare function uploadCloudStorageProviderFile(uploadFileRequest: CloudStorageProviderRequest<CloudStorageProviderUploadFileContent>, callback: (error?: SdkError, actionStatus?: boolean) => void): void;
741
+ /**
742
+ * @hidden
743
+ * Hide from docs
744
+ *
745
+ * Register a handler to be called when a user's 3P cloud storage provider list changes i.e.
746
+ * post adding / removing a 3P provider, list is updated
747
+ *
748
+ * @param handler - When 3P cloud storage provider list is updated this handler is called
749
+ *
750
+ * @internal Limited to Microsoft-internal use
751
+ */
752
+ export declare function registerCloudStorageProviderListChangeHandler(handler: () => void): void;
753
+ /**
754
+ * @hidden
755
+ * Hide from docs
756
+ *
757
+ * Register a handler to be called when a user's 3P cloud storage provider content changes i.e.
758
+ * when file(s) is/are added / renamed / deleted / uploaded, the list of files is updated
759
+ *
760
+ * @param handler - When 3P cloud storage provider content is updated this handler is called
761
+ *
762
+ * @internal
763
+ * Limited to Microsoft-internal use
764
+ */
765
+ export declare function registerCloudStorageProviderContentChangeHandler(handler: () => void): void;
766
+ export {};