@microsoft/teams-js 2.0.0-beta.3-dev.0 → 2.0.0-beta.3-dev.4
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/MicrosoftTeams.d.ts
CHANGED
|
@@ -548,23 +548,51 @@ export namespace files {
|
|
|
548
548
|
* ------
|
|
549
549
|
* Cloud storage providers registered with Microsoft Teams
|
|
550
550
|
*/
|
|
551
|
-
enum CloudStorageProvider {
|
|
551
|
+
export enum CloudStorageProvider {
|
|
552
552
|
Dropbox = "DROPBOX",
|
|
553
553
|
Box = "BOX",
|
|
554
554
|
Sharefile = "SHAREFILE",
|
|
555
555
|
GoogleDrive = "GOOGLEDRIVE",
|
|
556
|
-
Egnyte = "EGNYTE"
|
|
556
|
+
Egnyte = "EGNYTE",
|
|
557
|
+
SharePoint = "SharePoint"
|
|
558
|
+
}
|
|
559
|
+
interface IWopiThumbnail {
|
|
560
|
+
size: number;
|
|
561
|
+
url: string;
|
|
562
|
+
}
|
|
563
|
+
interface IWopiService {
|
|
564
|
+
name: string;
|
|
565
|
+
description: string;
|
|
566
|
+
thumbnails: IWopiThumbnail[];
|
|
557
567
|
}
|
|
558
568
|
/**
|
|
559
569
|
* @hidden
|
|
560
570
|
* Hide from docs
|
|
561
571
|
* ------
|
|
562
|
-
*
|
|
572
|
+
*
|
|
573
|
+
* External third-party cloud storages providers interface
|
|
563
574
|
*/
|
|
564
|
-
|
|
575
|
+
export interface IExternalProvider extends IWopiService {
|
|
576
|
+
providerType: CloudStorageProviderType;
|
|
577
|
+
providerCode: CloudStorageProvider;
|
|
578
|
+
}
|
|
579
|
+
/**
|
|
580
|
+
* @hidden
|
|
581
|
+
* Hide from docs
|
|
582
|
+
*
|
|
583
|
+
* Cloud storage provider type enums
|
|
584
|
+
*/
|
|
585
|
+
export enum CloudStorageProviderType {
|
|
565
586
|
Sharepoint = 0,
|
|
566
587
|
WopiIntegration = 1,
|
|
567
|
-
Google = 2
|
|
588
|
+
Google = 2,
|
|
589
|
+
OneDrive = 3,
|
|
590
|
+
Recent = 4,
|
|
591
|
+
Aggregate = 5,
|
|
592
|
+
FileSystem = 6,
|
|
593
|
+
Search = 7,
|
|
594
|
+
AllFiles = 8,
|
|
595
|
+
SharedWithMe = 9
|
|
568
596
|
}
|
|
569
597
|
/**
|
|
570
598
|
* @hidden
|
|
@@ -572,7 +600,7 @@ export namespace files {
|
|
|
572
600
|
* ------
|
|
573
601
|
* Cloud storage folder interface
|
|
574
602
|
*/
|
|
575
|
-
interface CloudStorageFolder {
|
|
603
|
+
export interface CloudStorageFolder {
|
|
576
604
|
/**
|
|
577
605
|
* @hidden
|
|
578
606
|
* ID of the cloud storage folder
|
|
@@ -630,7 +658,7 @@ export namespace files {
|
|
|
630
658
|
* ------
|
|
631
659
|
* Cloud storage item interface
|
|
632
660
|
*/
|
|
633
|
-
interface CloudStorageFolderItem {
|
|
661
|
+
export interface CloudStorageFolderItem {
|
|
634
662
|
/**
|
|
635
663
|
* @hidden
|
|
636
664
|
* ID of the item in the provider
|
|
@@ -672,6 +700,73 @@ export namespace files {
|
|
|
672
700
|
*/
|
|
673
701
|
accessToken?: string;
|
|
674
702
|
}
|
|
703
|
+
/**
|
|
704
|
+
* @hidden
|
|
705
|
+
* Hide from docs
|
|
706
|
+
*
|
|
707
|
+
* Files entity user interface
|
|
708
|
+
*/
|
|
709
|
+
export interface IFilesEntityUser {
|
|
710
|
+
/**
|
|
711
|
+
* User name.
|
|
712
|
+
*/
|
|
713
|
+
displayName: string;
|
|
714
|
+
/**
|
|
715
|
+
* User email.
|
|
716
|
+
*/
|
|
717
|
+
email: string;
|
|
718
|
+
/**
|
|
719
|
+
* User MRI.
|
|
720
|
+
*/
|
|
721
|
+
mri: string;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* @hidden
|
|
725
|
+
* Hide from docs
|
|
726
|
+
*
|
|
727
|
+
* Special Document Library enum
|
|
728
|
+
*/
|
|
729
|
+
export enum SpecialDocumentLibraryType {
|
|
730
|
+
ClassMaterials = "classMaterials"
|
|
731
|
+
}
|
|
732
|
+
/**
|
|
733
|
+
* @hidden
|
|
734
|
+
* Hide from docs
|
|
735
|
+
*
|
|
736
|
+
* Document Library Access enum
|
|
737
|
+
*/
|
|
738
|
+
export enum DocumentLibraryAccessType {
|
|
739
|
+
Readonly = "readonly"
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* @hidden
|
|
743
|
+
* Hide from docs
|
|
744
|
+
*
|
|
745
|
+
* SharePoint file interface
|
|
746
|
+
*/
|
|
747
|
+
export interface ISharePointFile {
|
|
748
|
+
siteId?: string;
|
|
749
|
+
siteUrl: string;
|
|
750
|
+
objectId: string;
|
|
751
|
+
objectUrl: string;
|
|
752
|
+
openInWindowFileUrl: string;
|
|
753
|
+
title: string;
|
|
754
|
+
isFolder: boolean;
|
|
755
|
+
serverRelativeUrl: string;
|
|
756
|
+
lastModifiedByUser: IFilesEntityUser;
|
|
757
|
+
lastModifiedTime: string;
|
|
758
|
+
sentByUser: IFilesEntityUser;
|
|
759
|
+
createdByUser: IFilesEntityUser;
|
|
760
|
+
createdTime: string;
|
|
761
|
+
size: number;
|
|
762
|
+
type: string;
|
|
763
|
+
spItemUrl?: string;
|
|
764
|
+
libraryType?: SpecialDocumentLibraryType;
|
|
765
|
+
accessType?: DocumentLibraryAccessType;
|
|
766
|
+
etag?: string;
|
|
767
|
+
remoteItem?: string;
|
|
768
|
+
listUrl?: string;
|
|
769
|
+
}
|
|
675
770
|
/**
|
|
676
771
|
* @hidden
|
|
677
772
|
* Hide from docs
|
|
@@ -680,7 +775,7 @@ export namespace files {
|
|
|
680
775
|
*
|
|
681
776
|
* @param channelId - ID of the channel whose cloud storage folders should be retrieved
|
|
682
777
|
*/
|
|
683
|
-
function getCloudStorageFolders(channelId: string): Promise<CloudStorageFolder[]>;
|
|
778
|
+
export function getCloudStorageFolders(channelId: string): Promise<CloudStorageFolder[]>;
|
|
684
779
|
/**
|
|
685
780
|
* @hidden
|
|
686
781
|
* Hide from docs
|
|
@@ -688,7 +783,7 @@ export namespace files {
|
|
|
688
783
|
* Initiates the add cloud storage folder flow
|
|
689
784
|
* @param channelId - ID of the channel to add cloud storage folder
|
|
690
785
|
*/
|
|
691
|
-
function addCloudStorageFolder(channelId: string): Promise<[boolean, CloudStorageFolder[]]>;
|
|
786
|
+
export function addCloudStorageFolder(channelId: string): Promise<[boolean, CloudStorageFolder[]]>;
|
|
692
787
|
/**
|
|
693
788
|
* @hidden
|
|
694
789
|
* Hide from docs
|
|
@@ -698,7 +793,7 @@ export namespace files {
|
|
|
698
793
|
* @param channelId - ID of the channel where folder is to be deleted
|
|
699
794
|
* @param folderToDelete - cloud storage folder to be deleted
|
|
700
795
|
*/
|
|
701
|
-
function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder): Promise<boolean>;
|
|
796
|
+
export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder): Promise<boolean>;
|
|
702
797
|
/**
|
|
703
798
|
* @hidden
|
|
704
799
|
* Hide from docs
|
|
@@ -709,7 +804,7 @@ export namespace files {
|
|
|
709
804
|
* @param providerCode - Code of the cloud storage folder provider
|
|
710
805
|
* @param callback - Callback that will be triggered post contents are loaded
|
|
711
806
|
*/
|
|
712
|
-
function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
|
|
807
|
+
export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
|
|
713
808
|
/**
|
|
714
809
|
* @hidden
|
|
715
810
|
* Hide from docs
|
|
@@ -720,7 +815,7 @@ export namespace files {
|
|
|
720
815
|
* @param providerCode - Code of the cloud storage folder provider
|
|
721
816
|
* @param fileOpenPreference - Whether file should be opened in web/inline
|
|
722
817
|
*/
|
|
723
|
-
function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
|
|
818
|
+
export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
|
|
724
819
|
/**
|
|
725
820
|
* @hidden
|
|
726
821
|
* Hide from docs.
|
|
@@ -729,8 +824,23 @@ export namespace files {
|
|
|
729
824
|
*
|
|
730
825
|
* @param file - The file to preview.
|
|
731
826
|
*/
|
|
732
|
-
function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
|
|
733
|
-
|
|
827
|
+
export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
|
|
828
|
+
/**
|
|
829
|
+
* @hidden
|
|
830
|
+
* Allow 1st party apps to call this function to get the external
|
|
831
|
+
* third party cloud storage accounts that the tenant supports
|
|
832
|
+
* @param excludeAddedProviders: return a list of support third party
|
|
833
|
+
* cloud storages that hasn't been added yet.
|
|
834
|
+
*/
|
|
835
|
+
export function getExternalProviders(excludeAddedProviders?: boolean): Promise<IExternalProvider[]>;
|
|
836
|
+
/**
|
|
837
|
+
* @hidden
|
|
838
|
+
* Allow 1st party apps to call this function to move files
|
|
839
|
+
* among SharePoint and third party cloud storages.
|
|
840
|
+
*/
|
|
841
|
+
export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove?: boolean): Promise<void>;
|
|
842
|
+
export function isSupported(): boolean;
|
|
843
|
+
export {};
|
|
734
844
|
}
|
|
735
845
|
|
|
736
846
|
/**
|
package/dist/MicrosoftTeams.js
CHANGED
|
@@ -395,7 +395,7 @@ __webpack_require__.d(__webpack_exports__, {
|
|
|
395
395
|
});
|
|
396
396
|
|
|
397
397
|
;// CONCATENATED MODULE: ./src/internal/constants.ts
|
|
398
|
-
var version = '2.0.0-beta.3-dev.
|
|
398
|
+
var version = '2.0.0-beta.3-dev.4';
|
|
399
399
|
/**
|
|
400
400
|
* @hidden
|
|
401
401
|
* The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
|
|
@@ -5381,19 +5381,47 @@ var files;
|
|
|
5381
5381
|
CloudStorageProvider["Sharefile"] = "SHAREFILE";
|
|
5382
5382
|
CloudStorageProvider["GoogleDrive"] = "GOOGLEDRIVE";
|
|
5383
5383
|
CloudStorageProvider["Egnyte"] = "EGNYTE";
|
|
5384
|
+
CloudStorageProvider["SharePoint"] = "SharePoint";
|
|
5384
5385
|
})(CloudStorageProvider = files.CloudStorageProvider || (files.CloudStorageProvider = {}));
|
|
5385
5386
|
/**
|
|
5386
5387
|
* @hidden
|
|
5387
5388
|
* Hide from docs
|
|
5388
|
-
*
|
|
5389
|
-
* Cloud storage provider
|
|
5389
|
+
*
|
|
5390
|
+
* Cloud storage provider type enums
|
|
5390
5391
|
*/
|
|
5391
5392
|
var CloudStorageProviderType;
|
|
5392
5393
|
(function (CloudStorageProviderType) {
|
|
5393
5394
|
CloudStorageProviderType[CloudStorageProviderType["Sharepoint"] = 0] = "Sharepoint";
|
|
5394
5395
|
CloudStorageProviderType[CloudStorageProviderType["WopiIntegration"] = 1] = "WopiIntegration";
|
|
5395
5396
|
CloudStorageProviderType[CloudStorageProviderType["Google"] = 2] = "Google";
|
|
5397
|
+
CloudStorageProviderType[CloudStorageProviderType["OneDrive"] = 3] = "OneDrive";
|
|
5398
|
+
CloudStorageProviderType[CloudStorageProviderType["Recent"] = 4] = "Recent";
|
|
5399
|
+
CloudStorageProviderType[CloudStorageProviderType["Aggregate"] = 5] = "Aggregate";
|
|
5400
|
+
CloudStorageProviderType[CloudStorageProviderType["FileSystem"] = 6] = "FileSystem";
|
|
5401
|
+
CloudStorageProviderType[CloudStorageProviderType["Search"] = 7] = "Search";
|
|
5402
|
+
CloudStorageProviderType[CloudStorageProviderType["AllFiles"] = 8] = "AllFiles";
|
|
5403
|
+
CloudStorageProviderType[CloudStorageProviderType["SharedWithMe"] = 9] = "SharedWithMe";
|
|
5396
5404
|
})(CloudStorageProviderType = files.CloudStorageProviderType || (files.CloudStorageProviderType = {}));
|
|
5405
|
+
/**
|
|
5406
|
+
* @hidden
|
|
5407
|
+
* Hide from docs
|
|
5408
|
+
*
|
|
5409
|
+
* Special Document Library enum
|
|
5410
|
+
*/
|
|
5411
|
+
var SpecialDocumentLibraryType;
|
|
5412
|
+
(function (SpecialDocumentLibraryType) {
|
|
5413
|
+
SpecialDocumentLibraryType["ClassMaterials"] = "classMaterials";
|
|
5414
|
+
})(SpecialDocumentLibraryType = files.SpecialDocumentLibraryType || (files.SpecialDocumentLibraryType = {}));
|
|
5415
|
+
/**
|
|
5416
|
+
* @hidden
|
|
5417
|
+
* Hide from docs
|
|
5418
|
+
*
|
|
5419
|
+
* Document Library Access enum
|
|
5420
|
+
*/
|
|
5421
|
+
var DocumentLibraryAccessType;
|
|
5422
|
+
(function (DocumentLibraryAccessType) {
|
|
5423
|
+
DocumentLibraryAccessType["Readonly"] = "readonly";
|
|
5424
|
+
})(DocumentLibraryAccessType = files.DocumentLibraryAccessType || (files.DocumentLibraryAccessType = {}));
|
|
5397
5425
|
/**
|
|
5398
5426
|
* @hidden
|
|
5399
5427
|
* Hide from docs
|
|
@@ -5405,7 +5433,7 @@ var files;
|
|
|
5405
5433
|
function getCloudStorageFolders(channelId) {
|
|
5406
5434
|
return new Promise(function (resolve) {
|
|
5407
5435
|
ensureInitialized(FrameContexts.content);
|
|
5408
|
-
if (!channelId || channelId.length
|
|
5436
|
+
if (!channelId || channelId.length === 0) {
|
|
5409
5437
|
throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
|
|
5410
5438
|
}
|
|
5411
5439
|
resolve(sendAndHandleSdkError('files.getCloudStorageFolders', channelId));
|
|
@@ -5422,7 +5450,7 @@ var files;
|
|
|
5422
5450
|
function addCloudStorageFolder(channelId) {
|
|
5423
5451
|
return new Promise(function (resolve) {
|
|
5424
5452
|
ensureInitialized(FrameContexts.content);
|
|
5425
|
-
if (!channelId || channelId.length
|
|
5453
|
+
if (!channelId || channelId.length === 0) {
|
|
5426
5454
|
throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
|
|
5427
5455
|
}
|
|
5428
5456
|
resolve(sendMessageToParentAsync('files.addCloudStorageFolder', [channelId]));
|
|
@@ -5531,6 +5559,46 @@ var files;
|
|
|
5531
5559
|
sendMessageToParent('openFilePreview', params);
|
|
5532
5560
|
}
|
|
5533
5561
|
files.openFilePreview = openFilePreview;
|
|
5562
|
+
/**
|
|
5563
|
+
* @hidden
|
|
5564
|
+
* Allow 1st party apps to call this function to get the external
|
|
5565
|
+
* third party cloud storage accounts that the tenant supports
|
|
5566
|
+
* @param excludeAddedProviders: return a list of support third party
|
|
5567
|
+
* cloud storages that hasn't been added yet.
|
|
5568
|
+
*/
|
|
5569
|
+
function getExternalProviders(excludeAddedProviders) {
|
|
5570
|
+
if (excludeAddedProviders === void 0) { excludeAddedProviders = false; }
|
|
5571
|
+
return new Promise(function (resolve) {
|
|
5572
|
+
ensureInitialized(FrameContexts.content);
|
|
5573
|
+
resolve(sendAndHandleSdkError('files.getExternalProviders', excludeAddedProviders));
|
|
5574
|
+
});
|
|
5575
|
+
}
|
|
5576
|
+
files.getExternalProviders = getExternalProviders;
|
|
5577
|
+
/**
|
|
5578
|
+
* @hidden
|
|
5579
|
+
* Allow 1st party apps to call this function to move files
|
|
5580
|
+
* among SharePoint and third party cloud storages.
|
|
5581
|
+
*/
|
|
5582
|
+
function copyMoveFiles(selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove) {
|
|
5583
|
+
if (isMove === void 0) { isMove = false; }
|
|
5584
|
+
return new Promise(function (resolve) {
|
|
5585
|
+
ensureInitialized(FrameContexts.content);
|
|
5586
|
+
if (!selectedFiles || selectedFiles.length === 0) {
|
|
5587
|
+
throw new Error('[files.copyMoveFiles] selectedFiles cannot be null or empty');
|
|
5588
|
+
}
|
|
5589
|
+
if (!providerCode) {
|
|
5590
|
+
throw new Error('[files.copyMoveFiles] providerCode cannot be null or empty');
|
|
5591
|
+
}
|
|
5592
|
+
if (!destinationFolder) {
|
|
5593
|
+
throw new Error('[files.copyMoveFiles] destinationFolder cannot be null or empty');
|
|
5594
|
+
}
|
|
5595
|
+
if (!destinationProviderCode) {
|
|
5596
|
+
throw new Error('[files.copyMoveFiles] destinationProviderCode cannot be null or empty');
|
|
5597
|
+
}
|
|
5598
|
+
resolve(sendAndHandleSdkError('files.copyMoveFiles', selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove));
|
|
5599
|
+
});
|
|
5600
|
+
}
|
|
5601
|
+
files.copyMoveFiles = copyMoveFiles;
|
|
5534
5602
|
function isSupported() {
|
|
5535
5603
|
return runtime.supports.files ? true : false;
|
|
5536
5604
|
}
|