@mediafly/frontend-api - v20.4.1
    Preparing search index...

    Function MockDocument

    • By default, MockDocument returns a PDF.

      Parameters

      • Optionaloverrides: {
            airshipItemUrl?: string;
            assetCreated?: string;
            assetErrorMessage?: string | null;
            assetState?: AssetState;
            canAccessAssetOffline?: boolean;
            canBeUsedForAssembly?: boolean;
            canBroadcast?: boolean;
            canCopy?: boolean;
            canDelete?: boolean;
            canDownloadAsset?: boolean;
            canEdit?: boolean;
            canEditAssets?: boolean;
            canEditMetadata?: boolean;
            canEditThumbnail?: boolean;
            canEditWatermarks?: boolean;
            canShare?: boolean;
            channelName?: string;
            channelSlug?: string;
            created?: string;
            description?: string;
            docType?: DocumentType;
            documentControls?: {
                hideFullscreen?: boolean;
                hideNavigationArrows?: boolean;
                hidePagePicker?: boolean;
                hideZoomAndFit?: boolean;
            };
            downloadStatus?: {
                canSync?: boolean;
                completed?: number;
                currentStatus?: string;
                isSynced?: boolean;
                lastModified?: number;
                total?: number
                | null;
                willSync?: boolean;
            };
            downloadUrl?: string;
            draftParentSlug?: string;
            drafts?: ({ slug?: string } | undefined)[];
            dynamicDataTemplateUrl?: string;
            filename?: string;
            filesize?: string;
            fileType?: string;
            format?: {
                docType?: FormatDocumentType;
                height?: number;
                manifestUrl?: string;
                mediaHash?: string;
                mimeType?: string;
                url?: string;
                videoUrl?: string;
                width?: number;
            };
            formats?: (
                | {
                    docType?: FormatDocumentType;
                    height?: number;
                    manifestUrl?: string;
                    mediaHash?: string;
                    mimeType?: string;
                    url?: string;
                    videoUrl?: string;
                    width?: number;
                }
                | undefined
            )[];
            hasSpeakerNotes?: boolean;
            hasStoryboard?: boolean;
            hierarchy?: (
                | {
                    autoStart?: boolean;
                    id?: string;
                    launchpadId?: string;
                    name?: string;
                }
                | undefined
            )[];
            iconType?: string;
            imageHeight?: number;
            imageUrl?: string;
            imageVersionHash?: string;
            imageWidth?: number;
            interactiveDownloadUrl?: string;
            isDraft?: boolean;
            isFavorite?: boolean;
            isImage?: boolean;
            isLesson?: boolean;
            isMyItem?: boolean;
            isNew?: boolean;
            isSharedMyItem?: boolean;
            isSortOrderLocked?: boolean;
            isTemplate?: boolean;
            isUpdated?: boolean;
            lastViewed?: string;
            launchpadId?: string;
            link?: string;
            linkHref?: string;
            linkTarget?: string
            | null;
            loadUrlInApps?: boolean;
            mediaType?: "Document";
            metadata?: { [key: string]: any };
            mirrorSourceId?: string;
            mmpm?: { mediaHash?: string; pages?: ({ url?: string } | undefined)[] };
            modified?: string;
            notes?: ({ page?: number; text?: string; title?: string } | undefined)[];
            pageList?: (
                | {
                    assemblyUpdate?: {
                        sourceItemId?: string;
                        sourceItemName?: string
                        | null;
                        type?: "Deleted" | "Updated";
                    };
                    isHidden?: boolean;
                    pageId?: string
                    | null;
                    pageNumber?: number;
                    pageTitle?: string | null;
                }
                | undefined
            )[];
            pages?: number;
            pdf?: {
                docType?: FormatDocumentType;
                height?: number;
                manifestUrl?: string;
                mediaHash?: string;
                mimeType?: string;
                url?: string;
                videoUrl?: string;
                width?: number;
            };
            processingStates?: ({ containerType?: string; state?: string } | undefined)[];
            replacementTokens?: (
                { name?: string; pageIndex?: number; type?: string }
                | undefined
            )[];
            resourceUrl?: string;
            settings?: {
                documentControls?:
                    | {
                        hideFullscreen?: boolean;
                        hideNavigationArrows?: boolean;
                        hidePagePicker?: boolean;
                        hideZoomAndFit?: boolean;
                    }
                    | null;
                isFixedPageOrder?: boolean;
                isLesson?: boolean;
                isMirrorItem?: boolean;
                isPromoted?: boolean;
                isSearchFolder?: boolean;
                isTemplate?: boolean;
                term?: string
                | null;
            };
            skipPostActions?: boolean;
            slug?: string;
            sources?: ({ itemSlug?: string; page?: number } | undefined)[];
            storyMaps?: (
                | {
                    groupSlug?: string;
                    heightRatio?: number;
                    leftRatio?: number;
                    metadata?: { playPause?: boolean };
                    page?: number;
                    screenTip?: string | null;
                    slug?: string;
                    source?: "file" | "user";
                    targetAction?: "close";
                    targetLink?: string;
                    targetPage?: number;
                    targetSlug?: string;
                    targetType?: StoryMapTargetType;
                    targetWorkspacePageSlug?: string;
                    targetWorkspaceSlug?: string;
                    topRatio?: number;
                    unsynced?: boolean;
                    widthRatio?: number;
                }
                | undefined
            )[];
            thumbnailFilename?: string;
            thumbnailState?: AssetState;
            thumbnailUrl?: string;
            title?: string;
            type?: "Document"
            | "Episode";
            versionHash?: string;
            viewed?: string;
            watermark?:
                | {
                    align?: WatermarkAlign
                    | null;
                    backgroundAlpha?: number | null;
                    backgroundColor?: string | null;
                    backgroundRGBAColor?: string | null;
                    id?: string;
                    signature?: string;
                    size?: number | null;
                    text?: string | null;
                    textAlpha?: number | null;
                    textColor?: string | null;
                    textRGBAColor?: string | null;
                    watermarkAlign?: string | null;
                }
                | null;
            zoomToFit?: boolean;
        }
        • OptionalairshipItemUrl?: string
        • OptionalassetCreated?: string
        • OptionalassetErrorMessage?: string | null
        • OptionalassetState?: AssetState
        • OptionalcanAccessAssetOffline?: boolean
        • OptionalcanBeUsedForAssembly?: boolean
        • OptionalcanBroadcast?: boolean
        • OptionalcanCopy?: boolean
        • OptionalcanDelete?: boolean
        • OptionalcanDownloadAsset?: boolean
        • OptionalcanEdit?: boolean
        • OptionalcanEditAssets?: boolean
        • OptionalcanEditMetadata?: boolean
        • OptionalcanEditThumbnail?: boolean
        • OptionalcanEditWatermarks?: boolean
        • OptionalcanShare?: boolean
        • OptionalchannelName?: string
        • OptionalchannelSlug?: string
        • Optionalcreated?: string
        • Optionaldescription?: string
        • OptionaldocType?: DocumentType
        • OptionaldocumentControls?: {
              hideFullscreen?: boolean;
              hideNavigationArrows?: boolean;
              hidePagePicker?: boolean;
              hideZoomAndFit?: boolean;
          }
        • OptionaldownloadStatus?: {
              canSync?: boolean;
              completed?: number;
              currentStatus?: string;
              isSynced?: boolean;
              lastModified?: number;
              total?: number | null;
              willSync?: boolean;
          }
        • OptionaldownloadUrl?: string
        • OptionaldraftParentSlug?: string
        • Optionaldrafts?: ({ slug?: string } | undefined)[]
        • OptionaldynamicDataTemplateUrl?: string

          This download url points to a version of the file before substitution (in other words, raw tokens are still present in the document).

        • Optionalfilename?: string
        • Optionalfilesize?: string
        • OptionalfileType?: string
        • Optionalformat?: {
              docType?: FormatDocumentType;
              height?: number;
              manifestUrl?: string;
              mediaHash?: string;
              mimeType?: string;
              url?: string;
              videoUrl?: string;
              width?: number;
          }
        • Optionalformats?: (
              | {
                  docType?: FormatDocumentType;
                  height?: number;
                  manifestUrl?: string;
                  mediaHash?: string;
                  mimeType?: string;
                  url?: string;
                  videoUrl?: string;
                  width?: number;
              }
              | undefined
          )[]
        • OptionalhasSpeakerNotes?: boolean
        • OptionalhasStoryboard?: boolean
        • Optionalhierarchy?: (
              | {
                  autoStart?: boolean;
                  id?: string;
                  launchpadId?: string;
                  name?: string;
              }
              | undefined
          )[]
        • OptionaliconType?: string
        • OptionalimageHeight?: number
        • OptionalimageUrl?: string
        • OptionalimageVersionHash?: string
        • OptionalimageWidth?: number
        • OptionalinteractiveDownloadUrl?: string
        • OptionalisDraft?: boolean
        • OptionalisFavorite?: boolean
        • OptionalisImage?: boolean
        • OptionalisLesson?: boolean
        • OptionalisMyItem?: boolean
        • OptionalisNew?: boolean
        • OptionalisSharedMyItem?: boolean
        • OptionalisSortOrderLocked?: boolean
        • OptionalisTemplate?: boolean
        • OptionalisUpdated?: boolean
        • OptionallastViewed?: string
        • OptionallaunchpadId?: string
        • Optionallink?: string
        • OptionallinkHref?: string
        • OptionallinkTarget?: string | null
        • OptionalloadUrlInApps?: boolean
        • OptionalmediaType?: "Document"
        • Optionalmetadata?: { [key: string]: any }
        • OptionalmirrorSourceId?: string
        • Optionalmmpm?: { mediaHash?: string; pages?: ({ url?: string } | undefined)[] }
        • Optionalmodified?: string
        • Optionalnotes?: ({ page?: number; text?: string; title?: string } | undefined)[]
        • OptionalpageList?: (
              | {
                  assemblyUpdate?: {
                      sourceItemId?: string;
                      sourceItemName?: string
                      | null;
                      type?: "Deleted" | "Updated";
                  };
                  isHidden?: boolean;
                  pageId?: string
                  | null;
                  pageNumber?: number;
                  pageTitle?: string | null;
              }
              | undefined
          )[]
        • Optionalpages?: number
        • Optionalpdf?: {
              docType?: FormatDocumentType;
              height?: number;
              manifestUrl?: string;
              mediaHash?: string;
              mimeType?: string;
              url?: string;
              videoUrl?: string;
              width?: number;
          }
        • OptionalprocessingStates?: ({ containerType?: string; state?: string } | undefined)[]
        • OptionalreplacementTokens?: ({ name?: string; pageIndex?: number; type?: string } | undefined)[]
        • OptionalresourceUrl?: string
        • Optionalsettings?: {
              documentControls?:
                  | {
                      hideFullscreen?: boolean;
                      hideNavigationArrows?: boolean;
                      hidePagePicker?: boolean;
                      hideZoomAndFit?: boolean;
                  }
                  | null;
              isFixedPageOrder?: boolean;
              isLesson?: boolean;
              isMirrorItem?: boolean;
              isPromoted?: boolean;
              isSearchFolder?: boolean;
              isTemplate?: boolean;
              term?: string
              | null;
          }
        • OptionalskipPostActions?: boolean
        • Optionalslug?: string
        • Optionalsources?: ({ itemSlug?: string; page?: number } | undefined)[]
        • OptionalstoryMaps?: (
              | {
                  groupSlug?: string;
                  heightRatio?: number;
                  leftRatio?: number;
                  metadata?: { playPause?: boolean };
                  page?: number;
                  screenTip?: string | null;
                  slug?: string;
                  source?: "file" | "user";
                  targetAction?: "close";
                  targetLink?: string;
                  targetPage?: number;
                  targetSlug?: string;
                  targetType?: StoryMapTargetType;
                  targetWorkspacePageSlug?: string;
                  targetWorkspaceSlug?: string;
                  topRatio?: number;
                  unsynced?: boolean;
                  widthRatio?: number;
              }
              | undefined
          )[]
        • OptionalthumbnailFilename?: string
        • OptionalthumbnailState?: AssetState
        • OptionalthumbnailUrl?: string
        • Optionaltitle?: string
        • Optionaltype?: "Document" | "Episode"
        • OptionalversionHash?: string
        • Optionalviewed?: string
        • Optionalwatermark?:
              | {
                  align?: WatermarkAlign
                  | null;
                  backgroundAlpha?: number | null;
                  backgroundColor?: string | null;
                  backgroundRGBAColor?: string | null;
                  id?: string;
                  signature?: string;
                  size?: number | null;
                  text?: string | null;
                  textAlpha?: number | null;
                  textColor?: string | null;
                  textRGBAColor?: string | null;
                  watermarkAlign?: string | null;
              }
              | null
        • OptionalzoomToFit?: boolean

      Returns Document