TElDropboxDataStorage.GetPreviewLink method

TElDropboxDataStorage.GetPreviewLink

Retrieves the web link to the preview page of a file.

Declaration

[C#]
string GetPreviewLink(string Path, bool Short);
string GetPreviewLink(TElDropboxDataStorageObject Obj, bool Short);

[VB.NET]
Function GetPreviewLink(ByVal Path As String, ByVal Short As Boolean) As String
Function GetPreviewLink(ByVal Obj As TElDropboxDataStorageObject, ByVal Short As Boolean) As String

[Pascal]
function GetPreviewLink(const Path : string; Short : boolean) : string;
function GetPreviewLink(Obj : TElDropboxDataStorageObject; Short : boolean) : string;

[C++]
    void GetPreviewLink(const std::string &Path, bool Short, std::string &OutResult);
    void GetPreviewLink(TElDropboxDataStorageObject &Obj, bool Short, std::string &OutResult);
    void GetPreviewLink(TElDropboxDataStorageObject *Obj, bool Short, std::string &OutResult);

[PHP]
string GetPreviewLink(string $Path, bool $Short)
string GetPreviewLink(TElDropboxDataStorageObject $Obj, bool $Short)

[Java]
String getPreviewLink(String Path, boolean Short);
String getPreviewLink(TElDropboxDataStorageObject Obj, boolean Short);

Parameters

Obj - the file for which the preview link is requested.
Path - the path to the file for which the preview link is requested.
Short - if True (default), the URL will be shortened using Dropbox URL shortener. If False, the URL will link directly to the file's preview page.

Return value

Returns the URL of the file's preview page.

Description

Use this method to fetch the link to the file's preview page.