@inweb/client
Version:
JavaScript REST API client for the Open Cloud Server
37 lines (36 loc) • 1.23 kB
TypeScript
/**
* 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;
}