Skip to main content

ISharingLinkKind Interface

Defines the permissions scope for a share link requested to be created during the creation the file in ODSP. Providing these properties to the /snapshot api will also create and return the requested kind of sharing link.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface ISharingLinkKind

Properties

Property Alerts Modifiers Type Description
role Alpha optional SharingLinkRole
scope Alpha SharingLinkScope

Property Details

role

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

role?: SharingLinkRole;

Type: SharingLinkRole

scope

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

scope: SharingLinkScope;

Type: SharingLinkScope