API Reference
Class
TestimoXDocumentationIntentResolver
Resolves reusable documentation output and replay-storage intents for thin hosts.
Inheritance
- Object
- TestimoXDocumentationIntentResolver
Methods
public static DocumentationStorageIntent[] ResolveDefaultReplayStorageIntents(IEnumerable<DocumentationStorageIntent> storedStorage, String jsonSnapshotDirectory, String sqlitePath, String sqlServerTarget, String outputPath, Boolean hasExplicitJson, Boolean hasExplicitSqlite, Boolean hasExplicitSqlServer, String defaultSnapshotFolderName, String defaultSqliteFileName) #Returns:
DocumentationStorageIntent[]Resolves replay storage intents for one-off documentation runs that default to JSON and SQLite.
Parameters
- storedStorage System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationStorageIntent}
- Storage intents supplied by an invoke-time definition block.
- jsonSnapshotDirectory System.String
- Optional JSON snapshot directory.
- sqlitePath System.String
- Optional SQLite replay database path.
- sqlServerTarget System.String
- Optional SQL Server connection string.
- outputPath System.String
- Output path used to derive default replay storage paths.
- hasExplicitJson System.Boolean
- Whether the JSON snapshot path was explicitly supplied.
- hasExplicitSqlite System.Boolean
- Whether the SQLite path was explicitly supplied.
- hasExplicitSqlServer System.Boolean
- Whether the SQL Server target was explicitly supplied.
- defaultSnapshotFolderName System.String
- Default snapshot folder name.
- defaultSqliteFileName System.String
- Default SQLite database file name.
Returns
Resolved replay storage intents.
public static DocumentationStorageIntent[] ResolveMergedStorageIntents(IEnumerable<DocumentationStorageIntent> storedStorage, IEnumerable<DocumentationStorageIntent> overrideStorage, String jsonSnapshotDirectory, String sqlitePath, String sqlServerTarget) #Returns:
DocumentationStorageIntent[]Merges stored report storage, save-time storage, and explicit replay storage parameters.
Parameters
- storedStorage System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationStorageIntent}
- Storage intents stored on the report.
- overrideStorage System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationStorageIntent}
- Storage intents supplied by a save-time definition block.
- jsonSnapshotDirectory System.String
- Optional JSON snapshot directory.
- sqlitePath System.String
- Optional SQLite replay database path.
- sqlServerTarget System.String
- Optional SQL Server connection string.
Returns
Resolved replay storage intents.
ResolveOutputIntents 4 overloads
public static DocumentationOutputIntent[] ResolveOutputIntents(IEnumerable<DocumentationOutputIntent> storedOutputs, IEnumerable<DocumentationOutputIntent> overrideOutputs, Boolean hasExplicitOutput, IReadOnlyList<DocumentationOutputFormat> requestedOutputs, String path, String theme, String defaultWordFileName) #Returns:
DocumentationOutputIntent[]Resolves output intents from stored report definitions, save-time overrides, or explicit format parameters.
Parameters
- storedOutputs System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationOutputIntent}
- Output intents stored on the report or invoke definition.
- overrideOutputs System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationOutputIntent}
- Output intents supplied by a save-time or invoke-time definition block.
- hasExplicitOutput System.Boolean
- Whether the caller explicitly supplied output path, format, or theme parameters.
- requestedOutputs System.Collections.Generic.IReadOnlyList{TestimoX.Documentation.DocumentationOutputFormat}
- Requested output formats.
- path System.String
- Output file or directory path.
- theme System.String
- Optional Word theme name.
- defaultWordFileName System.String
- Default Word file name used when path is a directory.
Returns
Resolved output intents.
public static DocumentationOutputIntent[] ResolveOutputIntents(IEnumerable<DocumentationOutputIntent> storedOutputs, IEnumerable<DocumentationOutputIntent> overrideOutputs, Boolean hasExplicitOutput, IReadOnlyList<DocumentationOutputFormat> requestedOutputs, String path, String theme, DocumentationWorkbookProfileKind excelProfile, DocumentationSlideDeckProfileKind powerPointProfile, String defaultWordFileName) #Returns:
DocumentationOutputIntent[]Resolves output intents from stored report definitions, save-time overrides, or explicit format parameters.
Parameters
- storedOutputs System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationOutputIntent}
- Output intents stored on the report or invoke definition.
- overrideOutputs System.Collections.Generic.IEnumerable{TestimoX.Documentation.DocumentationOutputIntent}
- Output intents supplied by a save-time or invoke-time definition block.
- hasExplicitOutput System.Boolean
- Whether the caller explicitly supplied output path, format, or theme parameters.
- requestedOutputs System.Collections.Generic.IReadOnlyList{TestimoX.Documentation.DocumentationOutputFormat}
- Requested output formats.
- path System.String
- Output file or directory path.
- theme System.String
- Optional Word theme name.
- excelProfile TestimoX.Documentation.DocumentationWorkbookProfileKind
- Workbook profile used when resolving Excel output intents.
- powerPointProfile TestimoX.Documentation.DocumentationSlideDeckProfileKind
- Slide-deck profile used when resolving PowerPoint output intents.
- defaultWordFileName System.String
- Default Word file name used when path is a directory.
Returns
Resolved output intents.
public static DocumentationOutputIntent[] ResolveOutputIntents(IReadOnlyList<DocumentationOutputFormat> requestedOutputs, String path, String theme, String defaultWordFileName) #Returns:
DocumentationOutputIntent[]Resolves output intents from explicit output formats and a single output path.
Parameters
- requestedOutputs System.Collections.Generic.IReadOnlyList{TestimoX.Documentation.DocumentationOutputFormat}
- Requested output formats.
- path System.String
- Output file or directory path.
- theme System.String
- Optional Word theme name.
- defaultWordFileName System.String
- Default Word file name used when path is a directory.
Returns
Resolved output intents.
public static DocumentationOutputIntent[] ResolveOutputIntents(IReadOnlyList<DocumentationOutputFormat> requestedOutputs, String path, String theme, DocumentationWorkbookProfileKind excelProfile, DocumentationSlideDeckProfileKind powerPointProfile, String defaultWordFileName) #Returns:
DocumentationOutputIntent[]Resolves output intents from explicit output formats and a single output path.
Parameters
- requestedOutputs System.Collections.Generic.IReadOnlyList{TestimoX.Documentation.DocumentationOutputFormat}
- Requested output formats.
- path System.String
- Output file or directory path.
- theme System.String
- Optional Word theme name.
- excelProfile TestimoX.Documentation.DocumentationWorkbookProfileKind
- Workbook profile used when resolving Excel output intents.
- powerPointProfile TestimoX.Documentation.DocumentationSlideDeckProfileKind
- Slide-deck profile used when resolving PowerPoint output intents.
- defaultWordFileName System.String
- Default Word file name used when path is a directory.
Returns
Resolved output intents.
public static String ResolveSnapshotDirectory(String snapshotDirectory, String outputPath, String defaultSnapshotFolderName) #Returns:
StringResolves the default JSON snapshot directory from an explicit directory or output path.
Parameters
- snapshotDirectory System.String
- Optional JSON snapshot directory.
- outputPath System.String
- Output path used to derive the default snapshot directory.
- defaultSnapshotFolderName System.String
- Default snapshot folder name.
Returns
Resolved snapshot directory.
public static String ResolveSqlitePath(String sqlitePath, String snapshotDirectory, String defaultSqliteFileName) #Returns:
StringResolves a SQLite replay database path from an explicit path or snapshot directory.
Parameters
- sqlitePath System.String
- Optional SQLite path.
- snapshotDirectory System.String
- Resolved snapshot directory.
- defaultSqliteFileName System.String
- Default SQLite database file name.
Returns
Resolved SQLite path.
public static String ResolveWordOutputPath(String path, String defaultWordFileName) #Returns:
StringResolves a Word output path from a file or directory path.
Parameters
- path System.String
- Output file or directory path.
- defaultWordFileName System.String
- Default Word file name used when path is a directory.
Returns
Resolved Word path.