@inweb/client/src/Api/ISharedLink.ts

JavaScript REST API client for the Open Cloud Server

///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a
//   license agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

/**
 * Defines what actions are allowed to be performed on a file from shared link:
 *
 * - `read` - The ability to read file description, geometry data and properties.
 * - `readSourceFile` - The ability to download source file.
 * - `readViewpoint` - The ability to read file viewpoints.
 */
export type SharedLinkAction = "read" | "readSourceFile" | "readViewpoint";

/**
 * Defines the shared link permissions.
 */
export interface ISharedLinkPermissions {
  /**
   * Defines what actions are allowed to be performed on a file from shared link:
   *
   * - `read` - The ability to read file description, geometry data and properties.
   * - `readSourceFile` - The ability to download source file.
   * - `readViewpoint` - The ability to read file viewpoints.
   *
   * At least one action must be defined.
   */
  actions: SharedLinkAction[];

  /**
   * Password to get access to the file.
   */
  password?: string;

  /**
   * true if the shared link is password protected.
   */
  readonly passwordProtected?: boolean;

  /**
   * Link expiration time (UTC) in the format specified in
   * {@link https://www.wikipedia.org/wiki/ISO_8601 | ISO 8601}.
   */
  expiresAt?: string;
}