Skip to main content

ShareLinkInfoType Interface

Sharing link data created for the ODSP item. Contains information about either sharing link created while creating a new file or a redeemable share link created when loading an existing file

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 ShareLinkInfoType

Properties​

Property Alerts Modifiers Type Description
createLink Alpha optional { link?: ISharingLink; error?: any; shareId?: string; } We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature where we can create a share link along with creating a file by passing a query parameter called createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information from the /snapshot api response.
sharingLinkToRedeem Alpha optional string This is used to save the network calls while doing trees/latest call as if the client does not have permission then this link can be redeemed for the permissions in the same network call.

Property Details​

We create a new file in ODSP with the /snapshot api call. Applications then need to make a separate apis call to create a sharing link for that file. To reduce the number of network calls, ODSP now provides a feature where we can create a share link along with creating a file by passing a query parameter called createShareLink (deprecated) or createLinkScope and createLinkRole. createLink object below saves the information from the /snapshot api response.

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.

createLink?: {
        link?: ISharingLink;
        error?: any;
        shareId?: string;
    };

Type: { link?: ISharingLink; error?: any; shareId?: string; }

sharingLinkToRedeem​

This is used to save the network calls while doing trees/latest call as if the client does not have permission then this link can be redeemed for the permissions in the same network call.

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​

sharingLinkToRedeem?: string;

Type: string