SharedLibraryResourcePayload

Result of resolving a public share link: the shared resource plus access and sharer metadata, or a graceful error for a dead/expired link.

type SharedLibraryResourcePayload {
  allowedAccess: String
  id: String
  isCustomerCachedPdfFallbackEnabled: Boolean
  isResourceDownloadEnabled: Boolean
  libraryResourceVersion: SharedLibraryResourceType
  sharedAt: Datetime
  sharedByProfile: SharedByProfile
  videoUrl: String
  success: Boolean
  error: String
}

Fields

SharedLibraryResourcePayload.allowedAccess ● String scalar

Access level granted by the share, e.g. view vs. download.

SharedLibraryResourcePayload.id ● String scalar

Id of the shared library resource.

SharedLibraryResourcePayload.isCustomerCachedPdfFallbackEnabled ● Boolean scalar

Whether external viewers may fall back to the cached PDF, per workspace preference.

SharedLibraryResourcePayload.isResourceDownloadEnabled ● Boolean scalar

Whether external viewers may download the resource, per workspace preference.

SharedLibraryResourcePayload.libraryResourceVersion ● SharedLibraryResourceType object

The shared resource's latest version content.

SharedLibraryResourcePayload.sharedAt ● Datetime scalar

When the share link was created.

SharedLibraryResourcePayload.sharedByProfile ● SharedByProfile object

Public profile of the person who shared the resource.

SharedLibraryResourcePayload.videoUrl ● String scalar

Transcoded video URL when the resource is a video, otherwise null.

SharedLibraryResourcePayload.success ● Boolean scalar

True when the resource resolved successfully.

SharedLibraryResourcePayload.error ● String scalar

Reason the link could not be resolved (e.g. "not found", "access expired").

Returned By

sharedLibraryResource query