Class AutotagLocalFileSystem

The driver for one Content Source Type (ContentSourceType.DriverClass).

Legacy autotagger drivers implement Autotag and SetContentItemsToProcess; pipeline drivers implement Discover and optionally Fetch (new pipeline-only drivers do not need to override the legacy methods).

Hierarchy (View Summary)

AutotagBase
- AutotagLocalFileSystem

Constructors

constructor

new AutotagLocalFileSystem(): AutotagLocalFileSystem
Returns AutotagLocalFileSystem
Overrides AutotagBase.constructor
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:27

Properties

`Protected` `Optional`_provider

_provider?: IMetadataProvider

Optional provider override; falls back to Metadata.Provider when not set.

`Protected`contentSourceTypeID

contentSourceTypeID: string

`Optional` `Readonly`IsPushOnly

IsPushOnly?: boolean

True when items are pushed into this source on demand (such as AutotagUpload) rather than pulled by walking an external listing. Discover and Sync skip push-only sources with a Skipped outcome and never mark their items as orphans.

`Readonly`SupportsExhaustiveWalk

SupportsExhaustiveWalk: true

True when a driver's walk with Since = null is guaranteed to visit every live top-level item in the source, so Discover in Mode: 'Sync' can safely mark unvisited items for deletion. Drivers backed by bounded/windowed feeds (like RSS) leave this unset or false.

`Static`_openAI

_openAI: OpenAI

Accessors

`Protected`ProviderToUse

get ProviderToUse(): IMetadataProvider
Returns the active provider — explicit override if set, otherwise the global default.

Returns IMetadataProvider
Inherited from AutotagBase.ProviderToUse
- Defined in ContentAutotagging/src/Core/generic/AutotagBase.ts:25

Methods

Autotag

Autotag(
    contextUser: UserInfo,
    onProgress?: AutotagProgressCallback,
    contentSourceIDs?: string[],
    provider?: IMetadataProvider,
): Promise<number>
Implemented abstract method from the AutotagBase class. that runs the entire autotagging process. This method is the entry point for the autotagging process. It initializes the connection, retrieves the content sources corresponding to the content source type, sets the content items that we want to process, extracts and processes the text, and sets the results in the database.
Parameters
- contextUser: UserInfo
- OptionalonProgress: AutotagProgressCallback
- OptionalcontentSourceIDs: string[]
- Optionalprovider: IMetadataProvider
Returns Promise<number>
Overrides AutotagBase.Autotag
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:46

Discover

Discover(request: DiscoverRequest): AsyncIterable<DiscoveredItem>
Walk the directory for the pipeline, skipping files older than request.Since when provided.
Parameters
- request: DiscoverRequest
Returns AsyncIterable<DiscoveredItem>
Overrides AutotagBase.Discover
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:151

Fetch

Fetch(request: LocatorFetchRequest): Promise<LocatorFetchResponse>
Read a walked file. Confined to the source root: a locator is a row anyone with edit rights can change.
Parameters
- request: LocatorFetchRequest
Returns Promise<LocatorFetchResponse>
Overrides AutotagBase.Fetch
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:173

getContextUser

getContextUser(): UserInfo
Returns UserInfo
Deprecated
Use GetContextUser.
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:37

GetContextUser

GetContextUser(): UserInfo
Returns UserInfo
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:32

setAddedContentItem

setAddedContentItem(
filePath: string,
contentSourceParams: ContentSourceParams,
): Promise<MJContentItemEntity>
Parameters
- filePath: string
- contentSourceParams: ContentSourceParams
Returns Promise<MJContentItemEntity>
Deprecated
Use SetAddedContentItem.
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:245

SetAddedContentItem

SetAddedContentItem(
filePath: string,
contentSourceParams: ContentSourceParams,
): Promise<MJContentItemEntity>
Parameters
- filePath: string
- contentSourceParams: ContentSourceParams
Returns Promise<MJContentItemEntity>
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:221

SetContentItemsToProcess

SetContentItemsToProcess(
contentSources: MJContentSourceEntity[],
): Promise<MJContentItemEntity[]>
Implemented abstract method from the AutotagBase class. Given a list of content sources, this method should return a list of content source items that have been modified or added after the most recent process run for that content source.
Parameters
- contentSources: MJContentSourceEntity[]
  An array of content sources to check for modified or added content source items
Returns Promise<MJContentItemEntity[]>
- An array of content source items that have been modified or added after the most recent process run for that content source
Overrides AutotagBase.SetContentItemsToProcess
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:62

setContentSourceParams

setContentSourceParams(
contentSource: MJContentSourceEntity,
): Promise<ContentSourceParams>
Parameters
- contentSource: MJContentSourceEntity
Returns Promise<ContentSourceParams>
Deprecated
Use SetContentSourceParams.
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:118

SetContentSourceParams

SetContentSourceParams(
contentSource: MJContentSourceEntity,
): Promise<ContentSourceParams>
Parameters
- contentSource: MJContentSourceEntity
Returns Promise<ContentSourceParams>
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:93

setModifiedContentItem

setModifiedContentItem(
filePath: string,
contentSourceParams: ContentSourceParams,
): Promise<MJContentItemEntity>
Parameters
- filePath: string
- contentSourceParams: ContentSourceParams
Returns Promise<MJContentItemEntity>
Deprecated
Use SetModifiedContentItem.
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:267

SetModifiedContentItem

SetModifiedContentItem(
filePath: string,
contentSourceParams: ContentSourceParams,
): Promise<MJContentItemEntity>
Parameters
- filePath: string
- contentSourceParams: ContentSourceParams
Returns Promise<MJContentItemEntity>
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:249

SetNewAndModifiedContentItems

SetNewAndModifiedContentItems(
    contentSourceParams: ContentSourceParams,
    lastRunDate: Date,
    contextUser: UserInfo,
): Promise<MJContentItemEntity[]>
Given a content source and last run date, recursively traverse through the directory and return a list of content source items that have been modified or added after the last run date.
Parameters
- contentSourceParams: ContentSourceParams
- lastRunDate: Date
- contextUser: UserInfo
Returns Promise<MJContentItemEntity[]>
- Defined in ContentAutotagging/src/LocalFileSystem/generic/AutotagLocalFileSystem.ts:130

Class AutotagLocalFileSystem

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AutotagLocalFileSystem

Properties

Protected Optional_provider

ProtectedcontentSourceTypeID

Optional ReadonlyIsPushOnly

ReadonlySupportsExhaustiveWalk

Static_openAI

Accessors

ProtectedProviderToUse

Returns IMetadataProvider

Methods

Autotag

Parameters

Returns Promise<number>

Discover

Parameters

Returns AsyncIterable<DiscoveredItem>

Fetch

Parameters

Returns Promise<LocatorFetchResponse>

getContextUser

Returns UserInfo

Deprecated

GetContextUser

Returns UserInfo

setAddedContentItem

Parameters

Returns Promise<MJContentItemEntity>

Deprecated

SetAddedContentItem

Parameters

Returns Promise<MJContentItemEntity>

SetContentItemsToProcess

Parameters

Returns Promise<MJContentItemEntity[]>

setContentSourceParams

Parameters

Returns Promise<ContentSourceParams>

Deprecated

SetContentSourceParams

Parameters

Returns Promise<ContentSourceParams>

setModifiedContentItem

Parameters

Returns Promise<MJContentItemEntity>

Deprecated

SetModifiedContentItem

Parameters

Returns Promise<MJContentItemEntity>

SetNewAndModifiedContentItems

Parameters

Returns Promise<MJContentItemEntity[]>

Settings

On This Page

`Protected` `Optional`_provider

`Protected`contentSourceTypeID

`Optional` `Readonly`IsPushOnly

`Readonly`SupportsExhaustiveWalk

`Static`_openAI

`Protected`ProviderToUse