Class SharedLink

Provides properties and methods for obtaining information about a file shared link.

Hierarchy (View Summary)

Constructors

constructor

Properties

headers path

Accessors

createdAt data permissions token url

Methods

checkout delete save update

Constructors

constructor

Properties

headers

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path

path: string

Endpoint API path relative to the REST API server URL.

Accessors

createdAt

  • get createdAt(): string

  • Shared link creation time (UTC) in the format specified in ISO 8601.

    Returns string

data

permissions

token

  • get token(): string

  • Unique shared link token.

    Returns string

url

  • get url(): string

  • URL to open shared file in the viewer.

    Returns string

Methods

checkout

  • checkout(): Promise<SharedLink>

  • Reloads shared link data from the server.

    Returns Promise<SharedLink>

delete

  • delete(): Promise<any>

  • Deletes a shared link from the server.

    Returns Promise<any>

    Returns the raw data of a deleted shared link. For more information, see Open Cloud SharedLinks API.

save

  • save(): Promise<SharedLink>

  • Saves shared link properties changes to the server. Call this method to update shared link data on the server after any property changes.

    Returns Promise<SharedLink>

update

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods