• Parameters

    • Optionaloverrides: {
          airshipItemUrl?: string;
          autoStart?: boolean;
          canAddFiles?: boolean;
          canAddFolders?: boolean;
          canBroadcast?: boolean;
          canDelete?: boolean;
          canEdit?: boolean;
          canEditMetadata?: boolean;
          canEditThumbnail?: boolean;
          canEditWatermarks?: boolean;
          canShare?: boolean;
          channelCount?: number;
          containsNewItems?: boolean;
          containsUpdatedItems?: boolean;
          contentCount?: number;
          created?: string;
          description?: string;
          downloadStatus?: {
              canSync?: boolean;
              completed?: number;
              currentStatus?: string;
              isSynced?: boolean;
              lastModified?: number;
              total?: null | number;
              willSync?: boolean;
          };
          draftItems?: (undefined | {
              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;
              downloadStatus?: {
                  canSync?: boolean;
                  completed?: number;
                  currentStatus?: string;
                  isSynced?: boolean;
                  lastModified?: number;
                  total?: null | number;
                  willSync?: boolean;
              };
              downloadUrl?: string;
              draftParentSlug?: string;
              drafts?: (undefined | {
                  slug?: (...) | (...);
              })[];
              fileType?: string;
              filename?: string;
              filesize?: string;
              hasStoryboard?: boolean;
              hierarchy?: (undefined | {
                  autoStart?: (...) | (...) | (...);
                  id?: (...) | (...);
                  launchpadId?: (...) | (...);
                  name?: (...) | (...);
              })[];
              iconType?: string;
              imageHeight?: number;
              imageUrl?: string;
              imageVersionHash?: string;
              imageWidth?: number;
              interactiveDownloadUrl?: string;
              isDraft?: boolean;
              isFavorite?: boolean;
              isLesson?: boolean;
              isMyItem?: boolean;
              isNew?: boolean;
              isSharedMyItem?: boolean;
              isSortOrderLocked?: boolean;
              isUpdated?: boolean;
              lastViewed?: string;
              launchpadId?: string;
              link?: string;
              mediaType?: "Audio" | "Document" | "Video";
              metadata?: {};
              mirrorSourceId?: string;
              modified?: string;
              processingStates?: (undefined | {
                  containerType?: (...) | (...);
                  state?: (...) | (...);
              })[];
              resourceUrl?: string;
              settings?: {
                  documentControls?: null | {
                      hideFullscreen?: (...) | (...) | (...);
                      hideNavigationArrows?: (...) | (...) | (...);
                      hidePagePicker?: (...) | (...) | (...);
                      hideZoomAndFit?: (...) | (...) | (...);
                  };
                  isFixedPageOrder?: boolean;
                  isLesson?: boolean;
                  isMirrorItem?: boolean;
                  isPromoted?: boolean;
                  isSearchFolder?: boolean;
                  isTemplate?: boolean;
                  term?: null | string;
              };
              skipPostActions?: boolean;
              slug?: string;
              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;
              };
          })[];
          fileType?: string;
          hasStoryboard?: boolean;
          hierarchy?: (undefined | {
              autoStart?: boolean;
              id?: string;
              launchpadId?: string;
              name?: string;
          })[];
          iconType?: string;
          imageHeight?: number;
          imageUrl?: string;
          imageVersionHash?: string;
          imageWidth?: number;
          isFavorite?: boolean;
          isLesson?: boolean;
          isMyItem?: boolean;
          isRoot?: boolean;
          isSearchFolder?: boolean;
          isSharedMyItem?: boolean;
          isSortOrderLocked?: boolean;
          isSortable?: boolean;
          items?: (undefined | {
              airshipItemUrl?: string;
              canBroadcast?: boolean;
              canDelete?: boolean;
              canEdit?: boolean;
              canEditMetadata?: boolean;
              canEditThumbnail?: boolean;
              canEditWatermarks?: boolean;
              canShare?: boolean;
              created?: string;
              description?: string;
              downloadStatus?: {
                  canSync?: boolean;
                  completed?: number;
                  currentStatus?: string;
                  isSynced?: boolean;
                  lastModified?: number;
                  total?: null | number;
                  willSync?: boolean;
              };
              fileType?: string;
              hasStoryboard?: boolean;
              hierarchy?: (undefined | {
                  autoStart?: (...) | (...) | (...);
                  id?: (...) | (...);
                  launchpadId?: (...) | (...);
                  name?: (...) | (...);
              })[];
              iconType?: string;
              imageHeight?: number;
              imageUrl?: string;
              imageVersionHash?: string;
              imageWidth?: number;
              isFavorite?: boolean;
              isLesson?: boolean;
              isMyItem?: boolean;
              isSharedMyItem?: boolean;
              isSortOrderLocked?: boolean;
              lastViewed?: string;
              launchpadId?: string;
              link?: string;
              metadata?: {};
              mirrorSourceId?: string;
              modified?: string;
              settings?: {
                  documentControls?: null | {
                      hideFullscreen?: (...) | (...) | (...);
                      hideNavigationArrows?: (...) | (...) | (...);
                      hidePagePicker?: (...) | (...) | (...);
                      hideZoomAndFit?: (...) | (...) | (...);
                  };
                  isFixedPageOrder?: boolean;
                  isLesson?: boolean;
                  isMirrorItem?: boolean;
                  isPromoted?: boolean;
                  isSearchFolder?: boolean;
                  isTemplate?: boolean;
                  term?: null | string;
              };
              slug?: string;
              thumbnailFilename?: string;
              thumbnailUrl?: string;
              title?: string;
              type?: string;
              versionHash?: string;
          })[];
          lastViewed?: string;
          launchpadId?: string;
          link?: string;
          metadata?: {};
          mirrorSourceId?: string;
          modified?: string;
          newCount?: number;
          parentChannelName?: string;
          parentChannelSlug?: null | string;
          searchFolderTerm?: null | 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;
          };
          slug?: string;
          thumbnailFilename?: string;
          thumbnailUrl?: string;
          title?: string;
          totalCount?: number;
          type?: "Channel";
          updatedCount?: number;
          versionHash?: string;
      }
      • OptionalairshipItemUrl?: string
      • OptionalautoStart?: boolean
      • OptionalcanAddFiles?: boolean
      • OptionalcanAddFolders?: boolean
      • OptionalcanBroadcast?: boolean
      • OptionalcanDelete?: boolean
      • OptionalcanEdit?: boolean
      • OptionalcanEditMetadata?: boolean
      • OptionalcanEditThumbnail?: boolean
      • OptionalcanEditWatermarks?: boolean
      • OptionalcanShare?: boolean
      • OptionalchannelCount?: number
      • OptionalcontainsNewItems?: boolean
      • OptionalcontainsUpdatedItems?: boolean
      • OptionalcontentCount?: number
      • Optionalcreated?: string
      • Optionaldescription?: string
      • 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
      • OptionaldraftItems?: (undefined | {
            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;
            downloadStatus?: {
                canSync?: boolean;
                completed?: number;
                currentStatus?: string;
                isSynced?: boolean;
                lastModified?: number;
                total?: null | number;
                willSync?: boolean;
            };
            downloadUrl?: string;
            draftParentSlug?: string;
            drafts?: (undefined | {
                slug?: (...) | (...);
            })[];
            fileType?: string;
            filename?: string;
            filesize?: string;
            hasStoryboard?: boolean;
            hierarchy?: (undefined | {
                autoStart?: (...) | (...) | (...);
                id?: (...) | (...);
                launchpadId?: (...) | (...);
                name?: (...) | (...);
            })[];
            iconType?: string;
            imageHeight?: number;
            imageUrl?: string;
            imageVersionHash?: string;
            imageWidth?: number;
            interactiveDownloadUrl?: string;
            isDraft?: boolean;
            isFavorite?: boolean;
            isLesson?: boolean;
            isMyItem?: boolean;
            isNew?: boolean;
            isSharedMyItem?: boolean;
            isSortOrderLocked?: boolean;
            isUpdated?: boolean;
            lastViewed?: string;
            launchpadId?: string;
            link?: string;
            mediaType?: "Audio" | "Document" | "Video";
            metadata?: {};
            mirrorSourceId?: string;
            modified?: string;
            processingStates?: (undefined | {
                containerType?: (...) | (...);
                state?: (...) | (...);
            })[];
            resourceUrl?: string;
            settings?: {
                documentControls?: null | {
                    hideFullscreen?: (...) | (...) | (...);
                    hideNavigationArrows?: (...) | (...) | (...);
                    hidePagePicker?: (...) | (...) | (...);
                    hideZoomAndFit?: (...) | (...) | (...);
                };
                isFixedPageOrder?: boolean;
                isLesson?: boolean;
                isMirrorItem?: boolean;
                isPromoted?: boolean;
                isSearchFolder?: boolean;
                isTemplate?: boolean;
                term?: null | string;
            };
            skipPostActions?: boolean;
            slug?: string;
            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;
            };
        })[]
      • OptionalfileType?: string
      • OptionalhasStoryboard?: boolean
      • Optionalhierarchy?: (undefined | {
            autoStart?: boolean;
            id?: string;
            launchpadId?: string;
            name?: string;
        })[]
      • OptionaliconType?: string
      • OptionalimageHeight?: number
      • OptionalimageUrl?: string
      • OptionalimageVersionHash?: string
      • OptionalimageWidth?: number
      • OptionalisFavorite?: boolean
      • OptionalisLesson?: boolean
      • OptionalisMyItem?: boolean
      • OptionalisRoot?: boolean
      • OptionalisSearchFolder?: boolean
      • OptionalisSharedMyItem?: boolean
      • OptionalisSortOrderLocked?: boolean
      • OptionalisSortable?: boolean
      • Optionalitems?: (undefined | {
            airshipItemUrl?: string;
            canBroadcast?: boolean;
            canDelete?: boolean;
            canEdit?: boolean;
            canEditMetadata?: boolean;
            canEditThumbnail?: boolean;
            canEditWatermarks?: boolean;
            canShare?: boolean;
            created?: string;
            description?: string;
            downloadStatus?: {
                canSync?: boolean;
                completed?: number;
                currentStatus?: string;
                isSynced?: boolean;
                lastModified?: number;
                total?: null | number;
                willSync?: boolean;
            };
            fileType?: string;
            hasStoryboard?: boolean;
            hierarchy?: (undefined | {
                autoStart?: (...) | (...) | (...);
                id?: (...) | (...);
                launchpadId?: (...) | (...);
                name?: (...) | (...);
            })[];
            iconType?: string;
            imageHeight?: number;
            imageUrl?: string;
            imageVersionHash?: string;
            imageWidth?: number;
            isFavorite?: boolean;
            isLesson?: boolean;
            isMyItem?: boolean;
            isSharedMyItem?: boolean;
            isSortOrderLocked?: boolean;
            lastViewed?: string;
            launchpadId?: string;
            link?: string;
            metadata?: {};
            mirrorSourceId?: string;
            modified?: string;
            settings?: {
                documentControls?: null | {
                    hideFullscreen?: (...) | (...) | (...);
                    hideNavigationArrows?: (...) | (...) | (...);
                    hidePagePicker?: (...) | (...) | (...);
                    hideZoomAndFit?: (...) | (...) | (...);
                };
                isFixedPageOrder?: boolean;
                isLesson?: boolean;
                isMirrorItem?: boolean;
                isPromoted?: boolean;
                isSearchFolder?: boolean;
                isTemplate?: boolean;
                term?: null | string;
            };
            slug?: string;
            thumbnailFilename?: string;
            thumbnailUrl?: string;
            title?: string;
            type?: string;
            versionHash?: string;
        })[]
      • OptionallastViewed?: string
      • OptionallaunchpadId?: string
      • Optionallink?: string
      • Optionalmetadata?: {}
        • OptionalmirrorSourceId?: string
        • Optionalmodified?: string
        • OptionalnewCount?: number
        • OptionalparentChannelName?: string
        • OptionalparentChannelSlug?: null | string
        • OptionalsearchFolderTerm?: null | 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
        • Optionalslug?: string
        • OptionalthumbnailFilename?: string
        • OptionalthumbnailUrl?: string
        • Optionaltitle?: string
        • OptionaltotalCount?: number
        • Optionaltype?: "Channel"
        • OptionalupdatedCount?: number
        • OptionalversionHash?: string

      Returns Viewer.Folder