Presentation
Defined in: types/presentation.ts:9
A presentation in the user’s Mobile Locker library.
Mirrors the iOS GRDBPresentation Swift model’s toJSON(files:) output.
Viewer capabilities (e.g. showSearchButton, canBeAnnotated) and download
state flags are not serialized by the server — derive them from settings
(a JSON string) and status at runtime.
Properties
Section titled “Properties”id: number;Defined in: types/presentation.ts:10
name: string;Defined in: types/presentation.ts:11
slug: string;Defined in: types/presentation.ts:12
code: string | null;Defined in: types/presentation.ts:14
Short unique code used in share links.
url: string | null;Defined in: types/presentation.ts:16
External URL, set when the presentation opens a remote URL.
external_id
Section titled “external_id”external_id: string | null;Defined in: types/presentation.ts:18
External CRM identifier (e.g. a Salesforce ID).
open_url
Section titled “open_url”open_url: string;Defined in: types/presentation.ts:20
Web URL that opens this presentation in the platform web app.
team_id
Section titled “team_id”team_id: number | null;Defined in: types/presentation.ts:21
description
Section titled “description”description: string | null;Defined in: types/presentation.ts:22
type: string | null;Defined in: types/presentation.ts:24
Presentation format type (e.g. 'html', 'pdf', 'video').
main_path
Section titled “main_path”main_path: string | null;Defined in: types/presentation.ts:26
Relative path to the main entry file (e.g. 'index.html').
status
Section titled “status”status: string | null;Defined in: types/presentation.ts:28
Download/availability status (e.g. 'Installed', 'Available').
installed
Section titled “installed”installed: boolean;Defined in: types/presentation.ts:29
thumbnail_url
Section titled “thumbnail_url”thumbnail_url: string | null;Defined in: types/presentation.ts:30
thumbnail_hash
Section titled “thumbnail_hash”thumbnail_hash: string | null;Defined in: types/presentation.ts:31
files_hash
Section titled “files_hash”files_hash: string | null;Defined in: types/presentation.ts:32
show_in_main_list
Section titled “show_in_main_list”show_in_main_list: boolean;Defined in: types/presentation.ts:33
is_rateable
Section titled “is_rateable”is_rateable: boolean;Defined in: types/presentation.ts:34
is_bookmarked
Section titled “is_bookmarked”is_bookmarked: boolean;Defined in: types/presentation.ts:35
is_featured
Section titled “is_featured”is_featured: boolean;Defined in: types/presentation.ts:36
is_internal_use_only
Section titled “is_internal_use_only”is_internal_use_only: boolean;Defined in: types/presentation.ts:37
can_be_printed_by_user
Section titled “can_be_printed_by_user”can_be_printed_by_user: boolean;Defined in: types/presentation.ts:38
can_be_exported
Section titled “can_be_exported”can_be_exported: boolean;Defined in: types/presentation.ts:39
can_be_shared_via_email
Section titled “can_be_shared_via_email”can_be_shared_via_email: boolean;Defined in: types/presentation.ts:40
can_be_shared_via_link
Section titled “can_be_shared_via_link”can_be_shared_via_link: boolean;Defined in: types/presentation.ts:41
can_be_shared_via_text
Section titled “can_be_shared_via_text”can_be_shared_via_text: boolean;Defined in: types/presentation.ts:42
can_be_shared
Section titled “can_be_shared”can_be_shared: boolean;Defined in: types/presentation.ts:44
Legacy alias for can_be_shared_via_email.
cah_be_shared_link
Section titled “cah_be_shared_link”cah_be_shared_link: boolean;Defined in: types/presentation.ts:46
Legacy alias for can_be_shared_via_link (intentional typo kept for compatibility).
brand_id
Section titled “brand_id”brand_id: number;Defined in: types/presentation.ts:47
new_until_at
Section titled “new_until_at”new_until_at: string | null;Defined in: types/presentation.ts:49
ISO 8601 timestamp until which the presentation is flagged as new.
expires_at
Section titled “expires_at”expires_at: string | null;Defined in: types/presentation.ts:51
ISO 8601 expiry timestamp, or null if the presentation does not expire.
share_template_id
Section titled “share_template_id”share_template_id: number;Defined in: types/presentation.ts:52
locale
Section titled “locale”locale: string;Defined in: types/presentation.ts:53
is_pdf_form
Section titled “is_pdf_form”is_pdf_form: boolean;Defined in: types/presentation.ts:54
is_ceros_experience
Section titled “is_ceros_experience”is_ceros_experience: boolean;Defined in: types/presentation.ts:55
is_ispring
Section titled “is_ispring”is_ispring: boolean;Defined in: types/presentation.ts:56
can_be_used_in_haystack
Section titled “can_be_used_in_haystack”can_be_used_in_haystack: boolean;Defined in: types/presentation.ts:57
has_transcript
Section titled “has_transcript”has_transcript: boolean;Defined in: types/presentation.ts:58
comment_count
Section titled “comment_count”comment_count: number;Defined in: types/presentation.ts:59
subscriber_count
Section titled “subscriber_count”subscriber_count: number;Defined in: types/presentation.ts:60
settings
Section titled “settings”settings: string;Defined in: types/presentation.ts:62
Raw JSON settings string — parse to read viewer capability flags.
is_slide_deck
Section titled “is_slide_deck”is_slide_deck: boolean;Defined in: types/presentation.ts:63
owner_id
Section titled “owner_id”owner_id: number;Defined in: types/presentation.ts:64
created_at
Section titled “created_at”created_at: string;Defined in: types/presentation.ts:65
updated_at
Section titled “updated_at”updated_at: string;Defined in: types/presentation.ts:66
content_updated_at
Section titled “content_updated_at”content_updated_at: string;Defined in: types/presentation.ts:67
files: PresentationFile[];Defined in: types/presentation.ts:68