Skip to main content
Version: v1

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

Signature​

export interface ShareLinkInfoType

Properties​

Property Modifiers Type Description
createLink optional { type?: ShareLinkTypes; link?: string; error?: any; } We create a new file in ODSP with the /snapshot api call. Applications then call separate apis to create a sharing link for that file. To reduce the number of api 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. createLink object below saves the data corresponding to this feature.
sharingLinkToRedeem 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 call separate apis to create a sharing link for that file. To reduce the number of api 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. createLink object below saves the data corresponding to this feature.

createLink?: {
        type?: ShareLinkTypes;
        link?: string;
        error?: any;
    };

Type: { type?: ShareLinkTypes; link?: string; error?: any; }

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.

Signature​

sharingLinkToRedeem?: string;

Type: string