UNPKG

1.16 kBTypeScriptView Raw
1import { ISharingEmailData, ISharingResult, SharingRole, ISharedFuncs } from "./types.js";
2declare module "../files/types" {
3 interface _File extends ISharedFuncs {
4 shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
5 }
6 interface IFile extends ISharedFuncs {
7 /**
8 * Shares this item with one or more users
9 *
10 * @param loginNames string or string[] of resolved login names to which this item will be shared
11 * @param role The role (View | Edit) applied to the share
12 * @param shareEverything Share everything in this folder, even items with unique permissions.
13 * @param requireSignin If true the user must signin to view link, otherwise anyone with the link can access the resource
14 * @param emailData Optional, if inlucded an email will be sent. Note subject currently has no effect.
15 */
16 shareWith(loginNames: string | string[], role?: SharingRole, requireSignin?: boolean, emailData?: ISharingEmailData): Promise<ISharingResult>;
17 }
18}
19//# sourceMappingURL=file.d.ts.map
\No newline at end of file