Function MockDocument

Parameters

• Optionaloverrides: {
      airshipItemUrl?: string;
      assetCreated?: string;
      assetErrorMessage?: null | string;
      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?: null | number;
          willSync?: boolean;
      };
      downloadUrl?: string;
      draftParentSlug?: string;
      drafts?: (undefined | {
          slug?: string;
      })[];
      dynamicDataTemplateUrl?: string;
      fileType?: string;
      filename?: string;
      filesize?: string;
      format?: {
          docType?: FormatDocumentType;
          height?: number;
          manifestUrl?: string;
          mediaHash?: string;
          mimeType?: string;
          url?: string;
          videoUrl?: string;
          width?: number;
      };
      formats?: (undefined | {
          docType?: FormatDocumentType;
          height?: number;
          manifestUrl?: string;
          mediaHash?: string;
          mimeType?: string;
          url?: string;
          videoUrl?: string;
          width?: number;
      })[];
      hasBrandingViolations?: boolean;
      hasSpeakerNotes?: boolean;
      hasStoryboard?: boolean;
      hierarchy?: (undefined | {
          autoStart?: boolean;
          id?: string;
          launchpadId?: string;
          name?: string;
      })[];
      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?: null | string;
      loadUrlInApps?: boolean;
      mediaType?: "Document";
      metadata?: {};
      mirrorSourceId?: string;
      mmpm?: {
          mediaHash?: string;
          pages?: (undefined | {
              url?: string;
          })[];
      };
      modified?: string;
      notes?: (undefined | {
          page?: number;
          text?: string;
          title?: string;
      })[];
      pageList?: (undefined | {
          assemblyUpdate?: {
              sourceItemId?: string;
              sourceItemName?: null | string;
              type?: "Deleted" | "Updated";
          };
          brandingViolations?: (undefined | {
              problem?: (...) | (...);
              solution?: (...) | (...);
          })[];
          isHidden?: boolean;
          pageId?: null | string;
          pageNumber?: number;
          pageTitle?: null | string;
      })[];
      pages?: number;
      pdf?: {
          docType?: FormatDocumentType;
          height?: number;
          manifestUrl?: string;
          mediaHash?: string;
          mimeType?: string;
          url?: string;
          videoUrl?: string;
          width?: number;
      };
      processingStates?: (undefined | {
          containerType?: string;
          state?: string;
      })[];
      replacementTokens?: (undefined | {
          name?: string;
          pageIndex?: number;
          type?: string;
      })[];
      resourceUrl?: string;
      settings?: {
          documentControls?: null | {
              hideFullscreen?: boolean;
              hideNavigationArrows?: boolean;
              hidePagePicker?: boolean;
              hideZoomAndFit?: boolean;
          };
          isFixedPageOrder?: boolean;
          isLesson?: boolean;
          isMirrorItem?: boolean;
          isPromoted?: boolean;
          isSearchFolder?: boolean;
          isTemplate?: boolean;
          term?: null | string;
      };
      skipPostActions?: boolean;
      slug?: string;
      sources?: (undefined | {
          itemSlug?: string;
          page?: number;
      })[];
      storyMaps?: (undefined | {
          groupSlug?: string;
          heightRatio?: number;
          leftRatio?: number;
          metadata?: {
              playPause?: boolean;
          };
          page?: number;
          screenTip?: null | string;
          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;
      })[];
      thumbnailFilename?: string;
      thumbnailUrl?: string;
      title?: string;
      type?: "Document" | "Episode";
      versionHash?: string;
      viewed?: string;
      watermark?: null | {
          align?: null | WatermarkAlign;
          backgroundAlpha?: null | number;
          backgroundColor?: null | string;
          backgroundRGBAColor?: null | string;
          id?: string;
          signature?: string;
          size?: null | number;
          text?: null | string;
          textAlpha?: null | number;
          textColor?: null | string;
          textRGBAColor?: null | string;
          watermarkAlign?: null | string;
      };
      zoomToFit?: boolean;
  }

  • OptionalairshipItemUrl?: string

  • OptionalassetCreated?: string

  • OptionalassetErrorMessage?: null | string

  • 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;
    }

    • OptionalhideFullscreen?: boolean

    • OptionalhideNavigationArrows?: boolean

    • OptionalhidePagePicker?: boolean

    • OptionalhideZoomAndFit?: boolean

  • OptionaldownloadStatus?: {
        canSync?: boolean;
        completed?: number;
        currentStatus?: string;
        isSynced?: boolean;
        lastModified?: number;
        total?: null | number;
        willSync?: boolean;
    }

    • OptionalcanSync?: boolean

    • Optionalcompleted?: number

    • OptionalcurrentStatus?: string

    • OptionalisSynced?: boolean

    • OptionallastModified?: number

    • Optionaltotal?: null | number

    • OptionalwillSync?: boolean

  • OptionaldownloadUrl?: string

  • OptionaldraftParentSlug?: string

  • Optionaldrafts?: (undefined | {
        slug?: string;
    })[]

  • 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).

  • OptionalfileType?: string

  • Optionalfilename?: string

  • Optionalfilesize?: string

  • Optionalformat?: {
        docType?: FormatDocumentType;
        height?: number;
        manifestUrl?: string;
        mediaHash?: string;
        mimeType?: string;
        url?: string;
        videoUrl?: string;
        width?: number;
    }

    • OptionaldocType?: FormatDocumentType

    • Optionalheight?: number

    • OptionalmanifestUrl?: string

    • OptionalmediaHash?: string

    • OptionalmimeType?: string

    • Optionalurl?: string

    • OptionalvideoUrl?: string

    • Optionalwidth?: number

  • Optionalformats?: (undefined | {
        docType?: FormatDocumentType;
        height?: number;
        manifestUrl?: string;
        mediaHash?: string;
        mimeType?: string;
        url?: string;
        videoUrl?: string;
        width?: number;
    })[]

  • OptionalhasBrandingViolations?: boolean

  • OptionalhasSpeakerNotes?: boolean

  • OptionalhasStoryboard?: boolean

  • Optionalhierarchy?: (undefined | {
        autoStart?: boolean;
        id?: string;
        launchpadId?: string;
        name?: string;
    })[]

  • 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?: null | string

  • OptionalloadUrlInApps?: boolean

  • OptionalmediaType?: "Document"

  • Optionalmetadata?: {}

  • OptionalmirrorSourceId?: string

  • Optionalmmpm?: {
        mediaHash?: string;
        pages?: (undefined | {
            url?: string;
        })[];
    }

    • OptionalmediaHash?: string

    • Optionalpages?: (undefined | {
          url?: string;
      })[]

  • Optionalmodified?: string

  • Optionalnotes?: (undefined | {
        page?: number;
        text?: string;
        title?: string;
    })[]

  • OptionalpageList?: (undefined | {
        assemblyUpdate?: {
            sourceItemId?: string;
            sourceItemName?: null | string;
            type?: "Deleted" | "Updated";
        };
        brandingViolations?: (undefined | {
            problem?: (...) | (...);
            solution?: (...) | (...);
        })[];
        isHidden?: boolean;
        pageId?: null | string;
        pageNumber?: number;
        pageTitle?: null | string;
    })[]

  • Optionalpages?: number

  • Optionalpdf?: {
        docType?: FormatDocumentType;
        height?: number;
        manifestUrl?: string;
        mediaHash?: string;
        mimeType?: string;
        url?: string;
        videoUrl?: string;
        width?: number;
    }

    • OptionaldocType?: FormatDocumentType

    • Optionalheight?: number

    • OptionalmanifestUrl?: string

    • OptionalmediaHash?: string

    • OptionalmimeType?: string

    • Optionalurl?: string

    • OptionalvideoUrl?: string

    • Optionalwidth?: number

  • OptionalprocessingStates?: (undefined | {
        containerType?: string;
        state?: string;
    })[]

  • OptionalreplacementTokens?: (undefined | {
        name?: string;
        pageIndex?: number;
        type?: string;
    })[]

  • OptionalresourceUrl?: string

  • Optionalsettings?: {
        documentControls?: null | {
            hideFullscreen?: boolean;
            hideNavigationArrows?: boolean;
            hidePagePicker?: boolean;
            hideZoomAndFit?: boolean;
        };
        isFixedPageOrder?: boolean;
        isLesson?: boolean;
        isMirrorItem?: boolean;
        isPromoted?: boolean;
        isSearchFolder?: boolean;
        isTemplate?: boolean;
        term?: null | string;
    }

    • OptionaldocumentControls?: null | {
          hideFullscreen?: boolean;
          hideNavigationArrows?: boolean;
          hidePagePicker?: boolean;
          hideZoomAndFit?: boolean;
      }

    • OptionalisFixedPageOrder?: boolean

    • OptionalisLesson?: boolean

    • OptionalisMirrorItem?: boolean

    • OptionalisPromoted?: boolean

    • OptionalisSearchFolder?: boolean

    • OptionalisTemplate?: boolean

    • Optionalterm?: null | string

  • OptionalskipPostActions?: boolean

  • Optionalslug?: string

  • Optionalsources?: (undefined | {
        itemSlug?: string;
        page?: number;
    })[]

  • OptionalstoryMaps?: (undefined | {
        groupSlug?: string;
        heightRatio?: number;
        leftRatio?: number;
        metadata?: {
            playPause?: boolean;
        };
        page?: number;
        screenTip?: null | string;
        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;
    })[]

  • OptionalthumbnailFilename?: string

  • OptionalthumbnailUrl?: string

  • Optionaltitle?: string

  • Optionaltype?: "Document" | "Episode"

  • OptionalversionHash?: string

  • Optionalviewed?: string

  • Optionalwatermark?: null | {
        align?: null | WatermarkAlign;
        backgroundAlpha?: null | number;
        backgroundColor?: null | string;
        backgroundRGBAColor?: null | string;
        id?: string;
        signature?: string;
        size?: null | number;
        text?: null | string;
        textAlpha?: null | number;
        textColor?: null | string;
        textRGBAColor?: null | string;
        watermarkAlign?: null | string;
    }

  • OptionalzoomToFit?: boolean